Skip to main content
GET
Get Subscription
Returns the team’s current subscription — plan details, Stripe status, and credit balances (monthly, purchased top-ups, coupon). Agents can call this to check whether a team is billable before enqueuing an expensive job. Resolves to the team selected by the authenticated caller’s session. API-key callers are scoped to the team that owns the key.

Response

200

Fields

object | null
The plan row. null when the team has never had a subscription. See List Plans for the full plan shape.
string | null
Stripe subscription status. One of trialing, active, past_due, canceled, unpaid, incomplete, incomplete_expired, paused.
boolean
true when the subscription will not auto-renew at current_period_end.
string | null
ISO-8601 timestamp of the next renewal. Also the date at which monthly credits reset.
integer
Monthly-plan credits left in the current period. Resets on renewal.
integer
Purchased top-up credits. Non-expiring. Spent AFTER the monthly balance depletes.
integer
Promotional credits from claimed coupons. Non-expiring.
boolean
Computed: true when status ∈ (active, trialing, past_due) AND current_period_end is in the future. Use this to decide whether a team can generate, not status alone.

Example

cURL