Cancelar assinatura
Solicita o cancelamento da assinatura.
- Boleto ou PIX: cancelamento é imediato — a assinatura muda para
canceled, o acesso é revogado de imediato nas integrações (MemberKit/Circle) e não há mais cobranças. - Cartão de crédito: o cancelamento é solicitado ao gateway de pagamento e a assinatura
fica com status
cancelingaté a confirmação (assíncrona).
Cancelar uma assinatura que já está cancelada ou em outro status que não permite cancelamento não tem efeito (operação idempotente).
Sem campo de autorização: o portal autentica por você com a sua chave de Homologação e as requisições rodam só no ambiente de testes.
Token de acesso devolvido por POST /auth/token. Envie como "Authorization: Bearer ". Vale 24 horas.
In: header
Path Parameters
uuidResponse Body
curl -X DELETE "https://pagpolar-api.creativecode.dev.br/v1/subscriptions/497f6eca-6276-4993-bfeb-53cbbbba6f08"{
"data": {
"success": true
}
}{
"error": {
"code": "invalid_request",
"message": "string",
"request_id": "string"
}
}{
"error": {
"code": "invalid_request",
"message": "string",
"request_id": "string"
}
}{
"error": {
"code": "invalid_request",
"message": "string",
"request_id": "string"
}
}{
"error": {
"code": "invalid_request",
"message": "string",
"request_id": "string"
}
}Assinaturas
Assine, consulte, cancele, troque o plano e troque o cartão.
Executar upgrade ou downgrade de plano POST
Executa a troca de plano de uma assinatura. A direção (upgrade ou downgrade) é determinada automaticamente pela comparação de preço entre o plano atual e o novo plano. - **Upgrade**: cobra a diferença proporcional imediatamente, no cartão salvo da assinatura (`payment_choice=current`) ou em um novo cartão informado no corpo da requisição (`payment_choice=new_card`). - **Upgrade no cartão aprovado, mas sem a troca concluída na hora** (por exemplo, falha no gateway ao atualizar o plano): a resposta é `200` com `upgrade.status` `pending`, e a venda da diferença continua em `PROCESSING`. A troca é confirmada quando o gateway avisa o pagamento; nesse momento a venda passa a `PAID` e o webhook `TRANSACTION_PAID` é enviado. Não cobre de novo. - **Downgrade**: não gera cobrança imediata; é agendado para entrar em vigor na próxima renovação da assinatura. O header `Idempotency-Key` é **obrigatório**. Em caso de timeout, reenvie a requisição com a mesma chave: a resposta original será devolvida sem processar a troca duas vezes.