Skip to main content
POST
Cancelar plano de cobrança

Autorizações

Authorization
string
header
obrigatório

Public API bearer credential sent as Authorization: Bearer <token>. Use either an OAuth access token or a Hybridbox Service account token.

Parâmetros de caminho

account_id
string<uuid>
obrigatório

Corpo

application/json

Esquema de solicitação do cliente para cancelar o plano de assinatura de uma conta.

cancel_at_period_end
boolean
padrão:true

Cancelar o plano no final do período de faturamento

cancel_immediately
boolean
padrão:false

Cancele o plano imediatamente

Resposta

status
string
obrigatório

Status da operação de faturamento

account_status
string | null

Status da conta após a operação

effective_at
string<date-time> | null

Quando a alteração no faturamento entrou em vigor

eligible
boolean | null

Se a conta era elegível para a operação

previous_plan_id
string | null

ID do plano de faturamento anterior

target_plan_id
string | null

ID do plano de faturamento desejado