Skip to main content
POST
Annulla piano di fatturazione

Autorizzazioni

Authorization
string
header
obbligatorio

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

Parametri del percorso

account_id
string<uuid>
obbligatorio

Corpo

application/json

Schema della richiesta cliente per annullare il piano di abbonamento di un account.

cancel_at_period_end
boolean
predefinito:true

Annulla il piano alla fine del periodo di fatturazione

cancel_immediately
boolean
predefinito:false

Annulla immediatamente il piano

Risposta

status
string
obbligatorio

Stato dell'operazione di fatturazione

account_status
string | null

Stato del conto dopo l'operazione

effective_at
string<date-time> | null

Quando è entrata in vigore la modifica della fatturazione

eligible
boolean | null

Indica se l'account era idoneo per l'operazione

previous_plan_id
string | null

ID del piano di fatturazione precedente

target_plan_id
string | null

ID del piano di fatturazione target