/subscriptions/{id}

Lê uma subscription. status fica active até ela terminar de fato; cancel_at guarda a data de fim de um cancelamento agendado.

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

GET/subscriptions/{id}

Autorização

Bearer token: a key de um app, em Apps (sk_app_live_… ou sk_app_test_…), ou a tenant key, em Settings (sk_live_… ou sk_test_…). A key define o modo: uma key live só vê dados live, uma key test só dados de sandbox.

Parâmetros

idstring · pathobrigatório

O id do recurso.

Response body

200A subscription.application/json

idstringopcional

Formato uuid

statusstringopcional

pending: esperando o primeiro pagamento; active: dá acesso (também com um cancelamento agendado); past_due: uma renovação falhou e o gateway está tentando de novo; canceled: encerrada.

Um de pending, active, past_due, canceled

amountstringopcional

Preço por intervalo, decimal com ponto.

currencystringopcional

intervalstringopcional

Um de month, year

descriptionstring | nullopcional

gatewayobjectopcional

A configuração que processa o pagamento.

idstringopcional

Formato uuid

namestringopcional

providerstringopcional

Um de stripe, asaas, abacatepay, pagarme, cielo

sandboxbooleanopcional

customerobject | nullopcional

idstringopcional

Formato uuid

external_refstringopcional

O seu próprio id para o cliente, como mandado no /connect.

emailstring | nullopcional

namestring | nullopcional

documentstring | nullopcional

phonestring | nullopcional

address_line1string | nullopcional

address_line2string | nullopcional

address_numberstring | nullopcional

neighborhoodstring | nullopcional

citystring | nullopcional

statestring | nullopcional

zipcodestring | nullopcional

countrystring | nullopcional

metadataobjectopcional

O que o produto mandou com o checkout, devolvido na subscription e em cada ciclo de renovação.

current_period_endstring | nullopcional

Fim do período pago, quando a próxima renovação é cobrada. Pode vir null em subscription.activated; a data chega depois em subscription.updated.

Formato date-time

cancel_at_period_endbooleanopcional

true quando um cancelamento está agendado para o fim do período.

cancel_requested_atstring | nullopcional

Quando o cancelamento foi pedido.

Formato date-time

cancel_atstring | nullopcional

Quando um cancelamento agendado a encerra.

Formato date-time

replacesstring | nullopcional

A subscription que esta substituiu (troca de plano).

Formato uuid

canceled_atstring | nullopcional

Quando ela terminou.

Formato date-time

created_atstringopcional

Formato date-time

linksobjectopcional

selfstringopcional

Formato uri

401Secret key ausente ou inválida.application/json

errorstringopcional

O que deu errado.

404Recurso não encontrado para este tenant.application/json

errorstringopcional

O que deu errado.

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}

Autorização

Parâmetros

Response body

Tem certeza?

Atalhos de teclado