PayOSOrg Structure
Subscription
Billing subscription for an organisation. Supports Stripe and Chargebee. MRR stored in pennies.
15 fields5 relationships
Fields
| Name | Type | Req | Description |
|---|---|---|---|
| org_id | uuid | yes | Owning organisation. |
| provider_type | enum | yes | stripe | chargebee | custom. |
| provider_id | string | yes | Provider-side subscription ID. |
| stripe_customer_id | string | no | Stripe customer ID (cus_XXXX). |
| status | enum | yes | active | trialing | in_trial | past_due | future | non_renewing | canceled | paused. |
| currency | string | no | ISO 4217 billing currency. |
| billing_interval | string | no | monthly | annual. |
| mrr | pennies | no | Monthly recurring revenue in pennies. Annual = yearly / 12. |
| current_period_start | datetime | no | Start of current billing period. |
| current_period_end | datetime | no | End of current billing period. |
| cancel_at_period_end | boolean | no | True if cancelling at period end. |
| trial_start | datetime | no | Trial start. |
| trial_end | datetime | no | Trial end. |
| created_at | datetime | yes | Subscription created. |
| expires_at | datetime | no | Hard expiry for non-renewing or custom subs. |
Relationships
Outbound (4)
Inbound (1)
- Organization[:HAS_SUBSCRIPTION]→Subscription
Related entities
OrganizationGraph AI Engine
Top-level organisation node. Supports franchise and group hierarchies via :PARENT_OF. Every piece of data in the platform is scoped to an organisation.InvoicePayOS
Billing invoice issued to an organisation. Amounts in pennies. Includes hosted invoice and PDF URLs for customer access.ProductPayOS
A billable product in the Stampede catalogue (feature tier or add-on).FeaturePayOS
Platform feature/add-on enabled at venue or org level. Global node — one per code.DiscountPayOS
Coupon or promotional discount on a subscription. Percentage or fixed.