/subscriptions/{id}/resume

Desfaz um cancelamento agendado para o fim do período. A mesma subscription continua renovando no mesmo dia e no mesmo cartão, sem novo checkout e sem segunda cobrança. Aceito, ainda não concluído; o gateway é chamado em segundo plano. cancel_at volta a null na hora e o app recebe subscription.resumed.

Server URLhttps://pay.contagorda.com/api/v1
POST/subscriptions/{id}/resume

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

202Retomada pedida. A subscription, sem cancelamento agendado.
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.
errorstringopcional

O que deu errado.

404Recurso não encontrado para este tenant.
errorstringopcional

O que deu errado.

422A subscription não tem cancelamento agendado, está sendo cancelada agora, já está cancelada ou ainda não começou.
errorsobjectopcional

Uma mensagem por campo (idempotency_key, gateway, amount, replaces, subscription ou record).

Tem certeza?

Atalhos de teclado

⌘ KBuscar e navegar⌘ JAbrir e fechar o Workbenchg hIníciog pPagamentosg cClientesg sSubscriptionsg aAppsg gGateways?Esta listaEscFechar