Skip to main content
GET
Get subscription information

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

Successful Response

Response schema for subscription information.

billing_email
string<email> | null
required

The billing email address for invoices and billing alerts.

billing_interval
enum<string> | null
required

The billing interval of the subscription. None for free plans.

Available options:
month,
year
credit_quantity
integer
required

The monthly credit allowance the subscription's own price grants.

credit_tier_key
string | null
required

The selected credit volume (e.g. 'team_tier_20k'). None for free plans.

current_period_end
string<date-time> | null
required

The end of the current Stripe billing period. None for free plans — credit period truth lives on the credit balance.

current_period_start
string<date-time> | null
required

The start of the current Stripe billing period. None for free plans — credit period truth lives on the credit balance.

current_price_decimal
string | null
required

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
string<duration>
required

Data retention period.

included_credits
integer
required

Credits granted each period (the period allowance).

is_product_limited
boolean
required

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:

  1. The credit balance is exhausted.
  2. The subscription status is UNPAID (payment failed or cancelled).
max_integrations
integer
required

Maximum number of integrations allowed. 0 means unlimited.

max_rows_per_table
integer
required

Maximum number of rows per table. 0 means unlimited.

max_tables
integer
required

Maximum number of tables allowed. 0 means unlimited.

payment_method
PaymentMethodReadSchema · object | null
required

The default payment card summary. None when no card is on file.

product_name
string
required

The product name for the subscription.

product_type
enum<string>
required

The product name for the subscription.

Available options:
free_plan,
team_plan,
pro_plan,
enterprise_plan
seats
integer
required

Number of seats included. 0 means unlimited.

status
enum<string>
required

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.
Available options:
active,
incomplete_payment,
past_due,
unpaid
cancel_at
string<date-time> | null

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.