Extracto de uso

Esta página documenta el extracto de uso, la factura con detalle de un período. Donde el Consumo muestra el total del ciclo en curso, el extracto lo desglosa línea por línea: cada instancia que tuvo período facturable en la ventana, el número que estuvo conectado, cuántos días contaron, el precio unitario y el importe, más los totales de uso, crédito y cobro.

Extracto detallado

GET /api/account/billing/statement?from=<rfc3339>&to=<rfc3339> Devuelve el extracto de una ventana. Autentique con el TokenAccount de la cuenta, o con el token global pasando ?account=<nombre-de-la-cuenta>. Los parámetros from y to son obligatorios, en formato RFC3339.

string

requerido

Inicio de la ventana, en RFC3339 (ej. 2026-08-01T00:00:00Z).

string

requerido

Fin de la ventana, en RFC3339 (ej. 2026-09-01T00:00:00Z).

string

Nombre de la cuenta. Obligatorio solo cuando usa el token global. Con el TokenAccount, la cuenta ya viene del propio token.

curl "https://ryzeapi.cloud/api/account/billing/statement?from=2026-08-01T00:00:00Z&to=2026-09-01T00:00:00Z" \
  -H "token: $Token_Account"

const params = new URLSearchParams({
  from: "2026-08-01T00:00:00Z",
  to: "2026-09-01T00:00:00Z"
});

await fetch(`https://ryzeapi.cloud/api/account/billing/statement?${params}`, {
  headers: { "token": process.env.Token_Account }
});

import os, requests

requests.get(
    "https://ryzeapi.cloud/api/account/billing/statement",
    headers={"token": os.environ["Token_Account"]},
    params={"from": "2026-08-01T00:00:00Z", "to": "2026-09-01T00:00:00Z"}
)

200 OK

{
  "items": [
    {
      "instanceName": "cliente-acme",
      "numberJid": "5511999998888@s.whatsapp.net",
      "billableFrom": "2026-08-01T00:00:00Z",
      "billableTo": "2026-09-01T00:00:00Z",
      "days": 31,
      "unitPriceCents": 5000,
      "amountCents": 5000
    },
    {
      "instanceName": "cliente-beta",
      "numberJid": "5511988887777@s.whatsapp.net",
      "billableFrom": "2026-08-15T00:00:00Z",
      "billableTo": "2026-09-01T00:00:00Z",
      "days": 17,
      "unitPriceCents": 5000,
      "amountCents": 2741
    }
  ],
  "peakInstances": 2,
  "usageCents": 7741,
  "creditCents": 50000,
  "overageCents": 0,
  "totalChargedCents": 50000,
  "cycleStart": "2026-08-01T00:00:00Z",
  "cycleEnd": "2026-09-01T00:00:00Z"
}

Campos de la respuesta

array

Los detalles del período, una línea por instancia que tuvo período facturable en la ventana. Una instancia eliminada a mitad del período sigue apareciendo, con el nombre y el número que tenía, porque el registro sobrevive a la eliminación. Vea Cómo funciona el cobro.

Mostrar campos de cada ítem

string

Nombre de la instancia en el período.

string

El número de WhatsApp que estuvo conectado a la instancia en el período.

string

Inicio del período facturable dentro de la ventana.

string

Fin del período facturable dentro de la ventana.

integer

Días facturables del ítem en la ventana.

integer

Precio unitario mensual aplicado, en centavos. Definido por el tramo de volumen de su contrato en el pico de instancias del período.

integer

El importe del ítem, en centavos, proporcional a los días: unitPriceCents por days dividido por los días del período.

integer

Pico de instancias simultáneas en cobro en la ventana. Es lo que define el tramo de precio unitario.

integer

La suma de los amountCents de todos los ítems, en centavos. El uso del período.

integer

El crédito incluido en su contrato para el período, en centavos. Es el piso de la factura.

integer

Cuánto pasó el uso del crédito, en centavos: el mayor entre 0 y usageCents menos creditCents. Queda 0 cuando el uso cabe en el crédito.

integer

El total cobrado en el período, en centavos: el mayor entre creditCents y usageCents. Es decir, nunca paga por debajo del crédito, y paga el uso cuando supera el crédito.

string

Inicio de la ventana consultada.

string

Fin de la ventana consultada.

¿Necesita un documento listo para enviar a su cliente? En el panel, en /settings, pestaña Facturas y uso, descarga el extracto del período formateado en PDF, y también sus facturas en PDF.

Historial de conexiones

La línea de tiempo de cuándo estuvo conectado cada número.

Cómo funciona el cobro

Crédito, prueba y el modelo comprometido en detalle.

Primeros pasos

Facturación

Auditoría

Referencia

Extracto de uso

Extracto detallado

Campos de la respuesta

Siguiente

Historial de conexiones

Cómo funciona el cobro

​Extracto detallado

​Campos de la respuesta

​Siguiente

Historial de conexiones

Cómo funciona el cobro

Extracto detallado

Campos de la respuesta

Siguiente