Vai al contenuto principale
POST
/
v1
/
public
/
accounts
/
{account_id}
/
billing
/
cancel-plan
Annulla piano di fatturazione
curl --request POST \
  --url https://api.hybridbox.io/v1/public/accounts/{account_id}/billing/cancel-plan \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "cancel_at_period_end": true,
  "cancel_immediately": false
}
'
{
  "status": "<string>",
  "account_status": "<string>",
  "effective_at": "2023-11-07T05:31:56Z",
  "eligible": true,
  "previous_plan_id": "<string>",
  "target_plan_id": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.hybridbox.io/llms.txt

Use this file to discover all available pages before exploring further.

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