List subscription mandates
GET /customer/{id}/subscription-mandates
Scope: subscription-mandates:read
Query parameters: page (default 0), pageSize (default 30, max 100)
Response:
{
"data": [
{
"id": "mandate_101",
"type": "subscription_mandate",
"plan": {
"id": "plan_5",
"type": "subscription_plan",
"name": "Monthly Unlimited",
"base100_price": 2999,
"currency": "GBP"
},
"state": "ACTIVE",
"created": "2025-01-01T00:00:00.000Z",
"grace": 0,
"earliest_cancellation_date": "2025-04-01T00:00:00.000Z",
"renewal_date": "2025-03-01T00:00:00.000Z"
}
],
"total": 2,
"page": 0,
"pageSize": 30
}
Mandate fields
| Field | Type | Description |
|---|---|---|
id | string | Mandate ID (prefixed with mandate_) |
type | string | Always "subscription_mandate" |
plan | object | The subscription plan (see below) |
state | string | ACTIVE, PAUSED, or SUSPENDED |
created | string | Creation date |
grace | number | Grace period in days |
earliest_cancellation_date | string | Earliest date the customer can cancel (ISO 8601) |
renewal_date | string | Next renewal date (ISO 8601) |
Plan fields
| Field | Type | Description |
|---|---|---|
id | string | Plan ID (prefixed with plan_) |
type | string | Always "subscription_plan" |
name | string | Plan name |
base100_price | number | Recurring price in base-100 (pence/cents) |
currency | string | Currency code |