List all plans
GET / v1 / plans
Returns a list of your plans.
Parameters
- active boolean Only return plans that are active or inactive (e.g., pass
falseto list all inactive plans). - product string Only return plans for the given product.
More parameters
- created object
- ending _ before string
- limit integer
- starting _ after string
Returns
A dictionary with a data property that contains an array of up to limit plans, starting after plan starting_after. Each entry in the array is a separate plan object. If no more plans are available, the resulting array will be empty.
Response
{ "object": "list", "url": "/v1/plans", "has_more": false, "data": [ { "id": "plan_NjpIbv3g3ZibnD", "object": "plan", "active": true, "amount": 1200, "amount_decimal": "1200", "billing_scheme": "per_unit", "created": 1681851647, "currency": "usd", "interval": "month", "interval_count": 1, "livemode": false, "metadata": {}, "nickname": null, "product": "prod_NjpI7DbZx6AlWQ", "tiers_mode": null, "transform_usage": null, "trial_period_days": null, "usage_type": "licensed" } ]}
Delete a plan
DELETE / v1 / plans /:id
Deleting plans means new subscribers can’t be added. Existing subscribers aren’t affected.
Parameters
No parameters.
Returns
An object with the deleted plan’s ID and a deleted flag upon success. Otherwise, this call raises an error, such as if the plan has already been deleted.
Response
{ "id": "plan_NjpIbv3g3ZibnD", "object": "plan", "deleted": true}