/subscriptions/{id}/resume

Takes back a cancellation scheduled for the end of the period. The same subscription keeps renewing on the same day and card, with no new checkout and no second charge. Accepted, not done yet; the gateway is called in the background. cancel_at returns to null right away and the app hears subscription.resumed.

Server URLhttps://pay.contagorda.com/api/v1

POST/subscriptions/{id}/resume

Authorization

Bearer token: an app key from Apps (sk_app_live_… or sk_app_test_…), or the tenant key from Settings (sk_live_… or sk_test_…). The key picks the mode: a live key only sees live data, a test key only sandbox data.

Parameters

idstring · pathrequired

The resource id.

Response Body

202Resume requested. The subscription, with no scheduled cancellation.application/json

idstringoptional

Format uuid

statusstringoptional

pending: waiting for the first payment; active: grants access (also while a cancellation is scheduled); past_due: a renewal failed and the gateway is retrying; canceled: ended.

One of pending, active, past_due, canceled

amountstringoptional

Price per interval, decimal with a dot.

currencystringoptional

intervalstringoptional

One of month, year

descriptionstring | nulloptional

gatewayobjectoptional

The configuration that handles the payment.

idstringoptional

Format uuid

namestringoptional

providerstringoptional

One of stripe, asaas, abacatepay, pagarme, cielo

sandboxbooleanoptional

customerobject | nulloptional

idstringoptional

Format uuid

external_refstringoptional

Your own id for the customer, as sent to /connect.

emailstring | nulloptional

namestring | nulloptional

documentstring | nulloptional

phonestring | nulloptional

address_line1string | nulloptional

address_line2string | nulloptional

address_numberstring | nulloptional

neighborhoodstring | nulloptional

citystring | nulloptional

statestring | nulloptional

zipcodestring | nulloptional

countrystring | nulloptional

metadataobjectoptional

What the product sent with the checkout, echoed back on the subscription and on every renewal cycle.

current_period_endstring | nulloptional

End of the paid period, when the next renewal is charged. Can be null in subscription.activated; the date then arrives in subscription.updated.

Format date-time

cancel_at_period_endbooleanoptional

true once a cancellation is scheduled for the end of the period.

cancel_requested_atstring | nulloptional

When the cancellation was asked for.

Format date-time

cancel_atstring | nulloptional

When a scheduled cancellation ends it.

Format date-time

replacesstring | nulloptional

The subscription this one replaced (a plan change).

Format uuid

canceled_atstring | nulloptional

When it ended.

Format date-time

created_atstringoptional

Format date-time

linksobjectoptional

selfstringoptional

Format uri

401Missing or invalid secret key.application/json

errorstringoptional

What went wrong.

404No such resource for this tenant.application/json

errorstringoptional

What went wrong.

422The subscription has no scheduled cancellation, is being canceled now, is already canceled or has not started yet.application/json

errorsobjectoptional

One message per field (idempotency_key, gateway, amount, replaces, subscription or record).

cURL

curl -X POST "https://pay.contagorda.com/api/v1/subscriptions/7f3a9c1e-2b4d-4e8f-9a1b-3c5d7e9f0a12/resume" \
  -H "Authorization: Bearer $PAY_SECRET_KEY"

application/json

{
  "id": "7f3a9c1e-2b4d-4e8f-9a1b-3c5d7e9f0a12",
  "status": "active",
  "amount": "49.90",
  "currency": "BRL",
  "interval": "month",
  "description": "Pro plan",
  "gateway": {
    "id": "7f3a9c1e-2b4d-4e8f-9a1b-3c5d7e9f0a12",
    "name": "stripe-br",
    "provider": "stripe",
    "sandbox": true
  },
  "customer": {
    "id": "7f3a9c1e-2b4d-4e8f-9a1b-3c5d7e9f0a12",
    "external_ref": "user_42",
    "email": "[email protected]",
    "name": "Ana Souza",
    "document": "123.456.789-09",
    "phone": "+55 11 99999-0000",
    "address_line1": "Av. Paulista",
    "address_line2": null,
    "address_number": "1000",
    "neighborhood": "Bela Vista",
    "city": "São Paulo",
    "state": "SP",
    "zipcode": "01310-100",
    "country": "BR"
  },
  "metadata": {
    "plan": "pro",
    "account_id": "acc_42"
  },
  "current_period_end": "2026-09-25T12:00:00Z",
  "cancel_at_period_end": true,
  "cancel_requested_at": "2026-09-25T12:00:00Z",
  "cancel_at": "2026-09-25T12:00:00Z",
  "replaces": "7f3a9c1e-2b4d-4e8f-9a1b-3c5d7e9f0a12",
  "canceled_at": "2026-09-25T12:00:00Z",
  "created_at": "2026-09-25T12:00:00Z",
  "links": {
    "self": "https://example.com"
  }
}

application/json

{
  "error": "Invalid or missing API key"
}

application/json

{
  "error": "Resource not found"
}

application/json

{
  "errors": {
    "subscription": "Subscription has no scheduled cancellation"
  }
}

/subscriptions/{id}/resume

Authorization

Parameters

Response Body

Are you sure?

Keyboard shortcuts