Skip to content

Get a subscription contract

GET /subscriptions/contracts/{contract_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_contract
NameInTypeDescription
contract_idpathstringSubscription contract GID (percent-encoded) or its numeric id, as GET /subscriptions/contracts lists it.

Returns SubscriptionContract.

FieldTypeDescription
idstringSubscription contract GID.
numeric_idstringThe contract’s numeric id, usable in every {contract_id} path.
statusstring or nullACTIVE, PAUSED, CANCELLED, EXPIRED or FAILED. (nullable)
customerobject
plan_idstring or nullThe subscription plan the contract was bought with; null for a paid membership. (nullable)
program_idstring or nullThe membership programme; null for a product subscription. (nullable)
frequencyobject or null(nullable)
currencystring or null(nullable)
per_cycle_totalnumberΣ discounted line price × quantity per delivery, shipping excluded.
linesarray of SubscriptionLine
deliveryobject or null(nullable)
payment_methodobject or null(nullable)
next_cycleobject or null(nullable)
cyclesarray of SubscriptionCycle
last_attemptobject or null(nullable)
last_order_idstring or null(nullable)
cancel_reasonstring or nullGiven when the contract was cancelled through Charm. (nullable)
notestring or nullThe merchant’s internal note. (nullable)
created_atstring or null(nullable)
cancelled_atstring or null(nullable)
paused_atstring or null(nullable)
updated_atstring or null(nullable)
{
"id": "id",
"numeric_id": "numeric id",
"status": "active",
"customer": {
"id": "id",
"email": "shopper@example.com"
},
"plan_id": "plan id",
"program_id": "program id",
"frequency": {
"unit": "unit",
"count": 1
},
"currency": "EUR",
"per_cycle_total": 1,
"lines": [
{
"id": "id",
"product_id": "8123456789",
"variant_id": "44123456789",
"selling_plan_id": "selling plan id",
"title": "title",
"variant_title": "variant title",
"sku": "sku",
"quantity": 1,
"price": 1,
"discounted_price": 1
}
],
"delivery": {
"type": "earn",
"city": "city",
"country": "country",
"zip": "zip",
"option": "option",
"price": 1
},
"payment_method": {
"id": "id",
"brand": "brand",
"last_digits": "last digits",
"expiry_month": 1,
"expiry_year": 1
},
"next_cycle": {
"index": 1,
"expected_at": "2026-10-01T09:30:00.000Z"
},
"cycles": [
{
"index": 1,
"expected_at": "2026-10-01T09:30:00.000Z",
"status": "active",
"skipped": false,
"forgiven": false,
"order_id": "order id"
}
],
"last_attempt": {
"state": "state",
"error_code": "error code",
"cycle_index": 1,
"at": "2026-10-01T09:30:00.000Z"
},
"last_order_id": "last order id",
"cancel_reason": "cancel reason",
"note": "note",
"created_at": "2026-10-01T09:30:00.000Z",
"cancelled_at": "2026-10-01T09:30:00.000Z",
"paused_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/contracts/<contract_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.