Skip to content

List paid memberships

GET /program/memberships
Scopeprogram:read
Customer session tokenNot accepted: call from your server with an API key
Rate limit classread (limits)
Idempotency keyNot used
MCP toolcharm_list_memberships

Every paid membership: its product and price, term or renewal cadence, grace period, points multiplier and benefits, and whether it is on sale.

Returns MembershipList.

FieldTypeDescription
revisioninteger
subscriptions_availablebooleanWhether auto-renewing (subscription) memberships can be created on this shop yet.
dataarray of Membership
{
"revision": 1,
"subscriptions_available": false,
"data": [
{
"id": "id",
"name": "Gold",
"name_translations": {},
"enabled": true,
"billing_type": "term",
"term": {
"unit": "DAY",
"count": 1
},
"billing_interval": {
"unit": "DAY",
"count": 1
},
"grace_days": 1,
"points_multiplier": 120,
"activity_window_months": 1,
"inactive_points_multiplier": 120,
"highlight": false,
"show_payoff": false,
"product": {
"id": null,
"title": null,
"variant_id": null,
"variant_title": null,
"price": null,
"currency": null
},
"benefits": [
{}
]
}
]
}
Terminal window
curl -X GET "https://charm.appfleece.app/api/v1/program/memberships" \
-H "Authorization: Bearer chrm_live_..."

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.