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_idstring—Stripe customer ID (cus_XXXX).
statusenumyesactive | trialing | in_trial | past_due | future | non_renewing | canceled | paused.
currencystring—ISO 4217 billing currency.
billing_intervalstring—monthly | annual.
mrrpennies—Monthly recurring revenue in pennies. Annual = yearly / 12.
current_period_startdatetime—Start of current billing period.
current_period_enddatetime—End of current billing period.
cancel_at_period_endboolean—True if cancelling at period end.
trial_startdatetime—Trial start.
trial_enddatetime—Trial end.
created_atdatetimeyesSubscription created.
expires_atdatetime—Hard 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)