List subscription plans
GET /subscriptions/plans| Scope | subscriptions:read |
| Customer session token | Not accepted: call from your server with an API key |
| Rate limit class | read (limits) |
| Idempotency key | Not used |
| MCP tool | charm_list_subscription_plans |
Every subscribe & save plan of the shop: products, delivery frequencies with their Shopify selling plan ids, discount, billing day, out-of-stock rule and whether the plan is published at Shopify. Plans are edited in the Charm admin.
Response 200
Section titled “Response 200”Returns SubscriptionPlanList.
| Field | Type | Description |
|---|---|---|
data | array of SubscriptionPlan | |
next_cursor | string or null | Pass as cursor to fetch the next page; null on the last page. (nullable) |
has_more | boolean | True when another page exists. |
{ "data": [ { "id": "id", "name": "Gold", "enabled": true, "products": [ { "product_id": null, "variant_ids": null } ], "frequencies": [ { "key": null, "unit": null, "count": null, "selling_plan_id": null } ], "discount": { "type": "none", "value": 1, "after_cycle": null }, "anchor": { "type": null, "day": null, "cutoff_day": null }, "inventory": { "on_out_of_stock": "retry", "retry_attempts": 1, "retry_days": 1, "stop_selling_when_sold_out": false }, "provisioning": { "status": "none", "error": "error", "selling_plan_group_id": "selling plan group id" }, "revision": 1, "created_at": "2026-10-01T09:30:00.000Z", "updated_at": "2026-10-01T09:30:00.000Z" } ], "next_cursor": null, "has_more": true}Example
Section titled “Example”curl -X GET "https://charm.appfleece.app/api/v1/subscriptions/plans" \ -H "Authorization: Bearer chrm_live_..."Errors
Section titled “Errors”unauthorized · invalid_token · insufficient_scope · access_required · validation_error · rate_limited
Every error body carries code, message, request_id and a doc_url pointing at the matching entry in the error catalog.