Get Subscription
Billing
Get Subscription
Retrieve the active team’s subscription plan and credit balance.
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
The plan row.
null when the team has never had a subscription. See
List Plans for the full plan shape.Stripe subscription status. One of
trialing, active, past_due,
canceled, unpaid, incomplete, incomplete_expired, paused.true when the subscription will not auto-renew at
current_period_end.ISO-8601 timestamp of the next renewal. Also the date at which
monthly credits reset.
Monthly-plan credits left in the current period. Resets on renewal.
Purchased top-up credits. Non-expiring. Spent AFTER the monthly
balance depletes.
Promotional credits from claimed coupons. Non-expiring.
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