GoCardless API API Documentation
Pause a Subscription
POST {{url}}/subscriptions/{{subscription}}/actions/pause
Pause a subscription object. No payments will be created until it is resumed. This can only be used when a subscription is collecting a fixed number of payments (created using count), when they continue forever (created without count or end_date) or the subscription is already paused for a number of cycles.
Body
PARAM
| Key | Datatype | Required | Description |
HEADERS
| Key | Datatype | Required | Description |
RESPONSES
status OK
| {
"subscriptions": {
"id": "SB000AJY2BWBJ9",
"created_at": "2024-03-04T21:00:19.488Z",
"amount": 88976,
"currency": "USD",
"status": "paused",
"name": "orchestrate granular e-commerce",
"start_date": "2024-03-05",
"end_date": null,
"interval": 1,
"interval_unit": "monthly",
"day_of_month": 5,
"month": null,
"count": 12,
"metadata": {
"order_no": "ORDER910"
},
"payment_reference": null,
"upcoming_payments": [],
"app_fee": null,
"links": {
"mandate": "MD000ZG53ED8SZ"
},
"retry_if_possible": true,
"earliest_charge_date_after_resume": "2024-04-05"
}
} |
Curl
curl -X POST 'https://api-sandbox.gocardless.com/subscriptions/https://api-sandbox.gocardless.com/actions/pause' -d '{"subscriptions":{"pause_cycles":1}}'
ENDPOINTS