Skip to content

Get a subscription plan

GET /subscriptions/plans/{plan_id}
Scopesubscriptions:read
Customer session tokenNot accepted: call from your server with an API key
Rate limit classread (limits)
Idempotency keyNot used
MCP toolcharm_get_subscription_plan
NameInTypeDescription
plan_idpathstringThe plan’s id as GET /subscriptions/plans lists it.

Returns SubscriptionPlan.

FieldTypeDescription
idstringThe plan’s id, e.g. sub_wax-club_ab12cd.
namestring or nullShown in checkout and in the customer’s account. (nullable)
enabledbooleanWhether the product page offers the plan.
productsarray of object
frequenciesarray of object
discountobject
anchorobject or null(nullable)
inventoryobject
provisioningobject
revisioninteger
created_atstring or null(nullable)
updated_atstring or null(nullable)
{
"id": "id",
"name": "Gold",
"enabled": true,
"products": [
{
"product_id": "8123456789",
"variant_ids": [
"variant ids"
]
}
],
"frequencies": [
{
"key": "key",
"unit": "DAY",
"count": 1,
"selling_plan_id": "selling plan id"
}
],
"discount": {
"type": "none",
"value": 1,
"after_cycle": {
"value": 1,
"cycle": 1
}
},
"anchor": {
"type": "WEEKDAY",
"day": 1,
"cutoff_day": 1
},
"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"
}
Terminal window
curl -X GET "https://charm.appfleece.app/api/v1/subscriptions/plans/<plan_id>" \
-H "Authorization: Bearer chrm_live_..."

unauthorized · invalid_token · insufficient_scope · access_required · not_found · 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.