Skip to main content
DELETE
Desfazer a troca de plano agendada
DELETE /subscriptions/:id/change-plan Faz parte do recurso Assinaturas — o conceito e os dez estados estão lá. Apaga uma troca de plano que estava marcada para a virada do ciclo. A assinatura continua no plano atual, e a próxima fatura sai com o preço de hoje. Devolve a assinatura como ela ficou.
Como saber se há o que desfazer. O campo scheduledPlanChange da assinatura traz { planId, effectiveDate } enquanto existir troca marcada, e null quando não existir. Ele vem no GET /subscriptions/{id} e no corpo desta rota — é por ele que você confirma que a chamada fez efeito.
Não falha quando não há nada agendado. A rota devolve a assinatura do mesmo jeito, com 200. Desfazer duas vezes tem o mesmo efeito de desfazer uma — você não precisa consultar antes para saber se existe agendamento.
Troca que já entrou em vigor não volta por aqui. Esta rota só alcança o que está agendado. Se a troca já valeu — o caso de um plano mais caro, que passa a valer na hora —, o caminho de volta é uma nova troca para o plano anterior, com as regras normais: para baixo, ela será agendada para a virada.

Authorizations

x-api-key
string
header
required

API Key da Credential (gerada no Backoffice)

Headers

Idempotency-Key
string

Chave única para garantir idempotência da requisição

Path Parameters

id
string
required

ID da assinatura

Response

Assinatura, com o agendamento removido se havia um