Saltar al contenido principal
POST
/
v1
/
public
/
accounts
/
{account_id}
/
billing
/
cancel-plan
Cancelar plan de facturación
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>"
}

Autorizaciones

​
Authorization
string
header
requerido

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

Parámetros de ruta

​
account_id
string<uuid>
requerido

Cuerpo

application/json

Esquema de solicitud de cliente para cancelar el plan de suscripción de una cuenta.

​
cancel_at_period_end
boolean
predeterminado:true

Cancelar el plan al final del período de facturación

​
cancel_immediately
boolean
predeterminado:false

Cancelar el plan inmediatamente

Respuesta

​
status
string
requerido

Estado de la operación de facturación

​
account_status
string | null

Estado de la cuenta después de la operación.

​
effective_at
string<date-time> | null

Cuándo entró en vigor el cambio de facturación

​
eligible
boolean | null

Si la cuenta era elegible para la operación

​
previous_plan_id
string | null

ID del plan de facturación anterior

​
target_plan_id
string | null

ID del plan de facturación objetivo