Skip to main content
GET
Current Plan
Returns the workspace’s current plan, billing cycle and balances. Use it to show the next credit reset and the next payment separately. On a yearly plan these are different dates: credits reset every month, and payment is once a year.

Request

Headers

string
required
Bearer token (JWT or API key)

Response

string
Current plan slug, for example free, starter, creator or pro
string
monthly, yearly or free
boolean
true when the plan ends at the end of the current period
string | null
When plan credits next reset (ISO 8601). Monthly for yearly plans
string | null
When the next charge happens. null for free plans and cancelled plans
number | null
Amount of the next charge. For a yearly plan this is the yearly price. Returned only to the workspace owner
object
remaining_credits, granted_credits, remaining_usd, granted_usd and resets_at for the plan credits