Skip to main content

Get active subscription

GET 
/api/partner-gateway/v1/subscription

Returns the currently active subscription plan for your account. The response includes the plan code (e.g. monthly_pro, annual_business), the status (active for the subscription in force), the current billing period start and end dates, the next reset of the usage counters, whether the subscription has been canceled, and the next plan code if a plan change is scheduled. Use this endpoint to programmatically check your plan tier before making API calls that may be restricted by plan level, or to display subscription information in your own dashboard. The billing period dates define the current invoicing cycle, at the end of which the plan renews unless it has been canceled. The nextRenew date is the next reset of the usage counters: on an annual plan it comes every month, well before billingPeriodEnd. If canceled is true while status is still active, the plan remains usable until the end of the current billing period, after which it will not renew; nextPlan, when set, is the plan that takes over. Returns 401 if the API key is missing or invalid. Returns 404 if no active subscription exists for your account. Returns 502 if the upstream subscription service is temporarily unavailable.

Responses​

Active subscription retrieved successfully

Last updated on