Logo
GoCardless API API Documentation

Resume a Subscription

POST {{url}}/subscriptions/{{subscription}}/actions/resume

Resume a subscription object. Payments will start to be created again based on the subscriptions recurrence rules. The chargedate on the next payment will be the same as the subscriptions earliestchargedateafter_resume

Resume a Subscription API Docs

 

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": "active", "name": "orchestrate granular e-commerce", "start_date": "2024-03-05", "end_date": "2025-03-06", "interval": 1, "interval_unit": "monthly", "day_of_month": 5, "month": null, "count": 12, "metadata": { "order_no": "ORDER910" }, "payment_reference": null, "upcoming_payments": [ { "charge_date": "2024-04-05", "amount": 88976 }, { "charge_date": "2024-05-06", "amount": 88976 }, { "charge_date": "2024-06-05", "amount": 88976 }, { "charge_date": "2024-07-05", "amount": 88976 }, { "charge_date": "2024-08-05", "amount": 88976 }, { "charge_date": "2024-09-05", "amount": 88976 }, { "charge_date": "2024-10-07", "amount": 88976 }, { "charge_date": "2024-11-05", "amount": 88976 }, { "charge_date": "2024-12-05", "amount": 88976 }, { "charge_date": "2025-01-06", "amount": 88976 } ], "app_fee": null, "links": { "mandate": "MD000ZG53ED8SZ" }, "retry_if_possible": true, "earliest_charge_date_after_resume": null } }



Curl
curl -X POST 'https://api-sandbox.gocardless.com/subscriptions/subscription/actions/resume'

ENDPOINTS