Get subscription information
Get the subscription information for the organization.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Response
Successful Response
Response schema for subscription information.
The billing email address for invoices and billing alerts.
The billing interval of the subscription. None for free plans.
month, year The monthly credit allowance the subscription's own price grants.
The selected credit volume (e.g. 'team_tier_20k'). None for free plans.
The end of the current Stripe billing period. None for free plans — credit period truth lives on the credit balance.
The start of the current Stripe billing period. None for free plans — credit period truth lives on the credit balance.
What the subscription actually costs per billing_interval unit, in cents, read off its own Stripe price. None for free plans. Prefer this over recomputing from the catalog: it stays right for a grandfathered price or a volume the catalog has since retired.
Data retention period.
Credits granted each period (the period allowance).
Whether the product is currently limited due to usage or payment issues. When True, the organization cannot perform billable actions. This happens in two scenarios:
- The credit balance is exhausted.
- The subscription status is UNPAID (payment failed or cancelled).
Maximum number of integrations allowed. 0 means unlimited.
Maximum number of rows per table. 0 means unlimited.
Maximum number of tables allowed. 0 means unlimited.
The default payment card summary. None when no card is on file.
The product name for the subscription.
The product name for the subscription.
free_plan, team_plan, pro_plan, enterprise_plan Number of seats included. 0 means unlimited.
The subscription status.
- active: User has active product with no past due fees.
- Product remains active with full functionality.
- incomplete_payment: The first payment failed or is processing.
- Product remains active with full functionality.
- User action is required to activate. Otherwise the product will become UNPAID.
- past_due: The subscription fees aren't paid. Stripe will retry to collect the payment.
- Product remains active with full functionality.
- No user action is needed yet. However a user can proactively solve the issue.
- unpaid: The subscription fees aren't paid. Stripe will no longer try to collect the payment.
- Product is not functional anymore.
- Needs user action to activate.
active, incomplete_payment, past_due, unpaid The date when the subscription is scheduled to be canceled. If set, the subscription will be canceled at this time. None if the subscription is not scheduled for cancellation.