Skip to main content
Required scope: billing:read

Get billing status

Returns the current subscription and usage summary. Response 200:
Plan values: free | developer | pro | enterprise Status values: active | past_due | canceled | trialing

Subscribe / upgrade plan

Initiates a Stripe checkout session to subscribe or upgrade. Use this to go from the free plan to a paid plan. Request body:
Response 201:
Redirect the user to url to complete payment.

Cancel subscription

Cancels the current paid subscription at the end of the current billing period (cancel_at_period_end = true in Stripe). The subscription remains active until the period ends. Response 204: No content.

Change plan

Immediately changes the active paid subscription to a different paid plan (e.g. Developer → Pro). This performs an inline Stripe subscription update without a new checkout session. To downgrade to the free plan, use DELETE /v1/billing/subscribe (cancel) instead. To upgrade from the free plan, use POST /v1/billing/subscribe (checkout) instead. Request body:
Response 204: No content.

Plan comparison

See Billing Tiers for full details.