Controlar el cobro

PATCH /api/instance/billing/:instance Define el modo de cobro de una instancia. Úselo para saltar la prueba y cobrar desde ya. El cambio es de una sola vía: una vez en cobro, la instancia no vuelve a prueba. Autentique con el TokenAccount de su cuenta, el mismo que usa para crear y administrar instancias.

Modos de cobro

`billingMode`	Qué hace
`trial`	Modo por defecto de una instancia nueva. La instancia recibe los días de prueba de su contrato a partir de la primera conexión.
`billable`	Cobra la instancia desde ya, sin días gratis. Útil para un cliente que ya probó antes y está volviendo.

El cambio a billable es definitivo. Una instancia en cobro no puede volver a trial, la API responde 400.

Ejemplo

curl -X PATCH "https://ryzeapi.cloud/api/instance/billing/mi-instancia" \
  -H "token: $Token_Account" \
  -H "Content-Type: application/json" \
  -d '{"billingMode": "billable"}'

await fetch("https://ryzeapi.cloud/api/instance/billing/mi-instancia", {
  method: "PATCH",
  headers: {
    "token": process.env.Token_Account,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({ billingMode: "billable" })
});

import os, requests

requests.patch(
    "https://ryzeapi.cloud/api/instance/billing/mi-instancia",
    headers={
        "token": os.environ["Token_Account"],
        "Content-Type": "application/json"
    },
    json={"billingMode": "billable"}
)

Respuesta de éxito

200 OK

{
  "billingMode": "billable"
}

La respuesta confirma el modo que quedó vigente en la instancia.

Path parameters

string

requerido

Nombre de la instancia.

Headers

string

requerido

Su TokenAccount, el mismo que usa para crear y administrar instancias.

Body

string

requerido

Uno de trial o billable. Una vez billable, la instancia no puede volver a trial.

Qué ocurre en cada cambio

A billable

La instancia pasa a cobrarse a partir de ahora. Si ya está conectada, el monto comprometido del ciclo empieza a contar en este momento y va hasta la renovación, aunque usted elimine la instancia antes.

A trial

Solo vale mientras la instancia aún no entró en cobro. Una instancia que ya es billable no vuelve a prueba, la API responde 400. La prueba sigue las reglas de su contrato y el historial del número.

Errores

HTTP	`error`	Cuándo
400	`billingMode obrigatorio`	El cuerpo no incluyó el campo `billingMode`.
400	`billingMode invalido (trial\|billable)`	Valor fuera de los dos aceptados.
400	`instancia billable nao pode voltar para trial`	La instancia ya está en cobro y no puede volver a prueba.
401	`Invalid token`	Token ausente o inválido.
403	`Instance does not belong to your account`	La instancia no es suya.
404	`instance not found`	El nombre no existe.

Cómo funciona el cobro

Entienda el crédito, la prueba y la medición por día.

Webhooks Enterprise

Reaccione a cada cambio de estado por evento.

Primeros pasos

Facturación

Auditoría

Referencia

Controlar el cobro

Modos de cobro

Ejemplo

Respuesta de éxito

Path parameters

Headers

Body

Qué ocurre en cada cambio

Errores

Siguiente

Cómo funciona el cobro

Webhooks Enterprise

​Modos de cobro

​Ejemplo

​Respuesta de éxito

​Path parameters

​Headers

​Body

​Qué ocurre en cada cambio

​Errores

​Siguiente

Cómo funciona el cobro

Webhooks Enterprise

Modos de cobro

Ejemplo

Respuesta de éxito

Path parameters

Headers

Body

Qué ocurre en cada cambio

Errores

Siguiente