Schema
PayOSOrg Structure

Subscription

Billing subscription for an organisation. Supports Stripe and Chargebee. MRR stored in pennies.

15 fields5 relationships

Fields

NameTypeReqDescription
org_iduuidyesOwning organisation.
provider_typeenumyesstripe | chargebee | custom.
provider_idstringyesProvider-side subscription ID.
stripe_customer_idstringStripe customer ID (cus_XXXX).
statusenumyesactive | trialing | in_trial | past_due | future | non_renewing | canceled | paused.
currencystringISO 4217 billing currency.
billing_intervalstringmonthly | annual.
mrrpenniesMonthly recurring revenue in pennies. Annual = yearly / 12.
current_period_startdatetimeStart of current billing period.
current_period_enddatetimeEnd of current billing period.
cancel_at_period_endbooleanTrue if cancelling at period end.
trial_startdatetimeTrial start.
trial_enddatetimeTrial end.
created_atdatetimeyesSubscription created.
expires_atdatetimeHard expiry for non-renewing or custom subs.

Relationships

Outbound (4)
  • Subscription[:HAS_INVOICE]Invoice
  • Subscription[:SUBSCRIBES_TO]Productquantity, unit_amount (pennies)
  • Subscription[:HAS_ADDON]Featurequantity
  • Subscription[:HAS_DISCOUNT]Discount
Inbound (1)