GOgocardless
Subscription

Resume a subscription

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

This fails with:

  • forbidden if the subscription was created by an app and you are not authenticated as that app, or if the subscription was not created by an app and you are authenticated as an app

  • validation_failed if invalid data is provided when attempting to resume a subscription.

  • subscription_not_paused if the subscription is not paused.

<p class="notice--warning"><strong>Warning</strong>: There is a mandatory minimum 14 business day wait between resuming an `AUD` subscription and its next charge date. There is a mandatory minimum 10 calendar day wait between resuming an `NZD` subscription and its next charge date.</p>
post/subscriptions/{subscription_id}/actions/resume

Request

  • Base URL
    https://api.gocardless.com
  • Auth
    HTTP bearer

Path parameters

subscription_idstring required

The subscription id

Headers

GoCardless-Versionstring required

Request body

Response

Action completed successfully

Example response

{
  "subscriptions": {
    "id": "SB123",
    "created_at": "2014-01-01T12:00:00.000Z",
    "amount": 1000,
    "name": "12 month subscription",
    "start_date": "2014-10-21",
    "end_date": "2015-10-21",
    "interval": 1,
    "interval_unit": "monthly",
    "day_of_month": 28,
    "currency": "EUR",
    "month": "january",
    "count": 5,
    "payment_reference": "GOLDPLAN",
    "status": "active",
    "upcoming_payments": [
      {
        "amount": 2500,
        "charge_date": "2014-11-03"
      }
    ],
    "app_fee": 100,
    "links": {
      "mandate": "MD123"
    },
    "earliest_charge_date_after_resume": "2014-11-03"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.