/subscriptions/{id}

Reads a subscription. status stays active until it really ends; cancel_at holds the end date of a scheduled cancellation.

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

GET/subscriptions/{id}

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

200The subscription.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.

cURL

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

application/json

{
  "id": "5d6e7f80-91a2-4b3c-8d4e-5f60718293a4",
  "status": "active",
  "amount": "29.9",
  "currency": "BRL",
  "interval": "month",
  "description": "Blackevin Pro",
  "gateway": {
    "id": "9424c381-a90d-4921-97e9-5175d91058fb",
    "name": "stripe-br",
    "provider": "stripe",
    "sandbox": true
  },
  "customer": {
    "id": "0b1c2d3e-4f5a-6b7c-8d9e-0f1a2b3c4d5e",
    "external_ref": "user_42",
    "email": "[email protected]",
    "name": null,
    "document": null,
    "phone": null,
    "address_line1": null,
    "address_line2": null,
    "address_number": null,
    "neighborhood": null,
    "city": null,
    "state": null,
    "zipcode": null,
    "country": "BR"
  },
  "metadata": {},
  "current_period_end": "2026-10-25T12:00:00Z",
  "cancel_at_period_end": false,
  "cancel_requested_at": null,
  "cancel_at": null,
  "replaces": null,
  "canceled_at": null,
  "created_at": "2026-09-25T12:00:00Z",
  "links": {
    "self": "https://pay.example.com/api/v1/subscriptions/5d6e7f80-91a2-4b3c-8d4e-5f60718293a4"
  }
}

application/json

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

application/json

{
  "error": "Resource not found"
}

/subscriptions/{id}

Authorization

Parameters

Response Body

Are you sure?

Keyboard shortcuts