Skip to main content
POST
Alterar plano da assinatura
Altera o produto principal de uma assinatura ativa. O novo valor começa a ser cobrado no próximo ciclo de cobrança — o ciclo atual não é afetado.
Requer a permissão SUBSCRIPTION:CREATE.

Corpo da requisição

O produto informado em productId precisa ter um cycle configurado (WEEKLY, MONTHLY, SEMIANNUALLY ou ANNUALLY). Produtos avulsos (sem ciclo) retornam erro.
Exemplo — upgrade de plano:

Resposta

Retorna um objeto de atualização pendente (status: "PENDING"). A mudança é aplicada automaticamente no início do próximo ciclo.
Um evento subscription.plan_changed é disparado imediatamente após a solicitação, com os detalhes do novo plano e o ID da atualização pendente.
Só pode existir uma atualização PENDING por assinatura. Chamar o endpoint novamente sobrescreve a alteração anterior ainda não aplicada.

Authorizations

Authorization
string
header
required

Todas as requisições devem incluir sua chave de API no header Authorization usando o formato Bearer <abacatepay-api-key>. Sem esse header a requisição será rejeitada.

Saiba mais sobre como criar e usar chaves de API na documentação de autenticação.

Body

application/json
id
string
required

Identificador único da assinatura a ser alterada.

Example:

"subs_abc123xyz"

productId
string
required

Identificador do novo produto. Deve ter ciclo de cobrança definido.

Example:

"prod_plano_pro"

quantity
integer
required

Quantidade do novo produto.

Required range: x >= 1
Example:

1

Response

Alteração de plano agendada com sucesso.

data
object

Atualização de plano pendente de uma assinatura.

error
string | null
Example:

null

success
boolean

Se a requisição obteve sucesso ou não.

Example:

true