/subscriptions/{id}/cancel
Aceito, ainda não concluído; o gateway é chamado em segundo plano. Por padrão, a subscription termina no fim do período pago; envie at_period_end false para encerrar agora. O resultado chega como webhooks subscription.canceling e subscription.canceled.
Server URLhttps://pay.contagorda.com/api/v1
POST/subscriptions/{id}/cancel
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.
Request body
application/json, opcional
at_period_endbooleanopcional
false encerra a subscription agora, sem reembolsar o período atual.
Padrão true
Response body
202Cancelamento pedido.
idstringopcional
Formato uuid
statusstringopcional
Fica active até a subscription terminar de fato.
cancel_requested_atstringopcional
Formato date-time
cancel_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 já está cancelada ou ainda não começou.
errorsobjectopcional
Uma mensagem por campo (idempotency_key, gateway, amount, replaces, subscription ou record).