Skip to main content
POST
Usa POST /subscription/usage para reportar el consumo medido contra una suscripción. La facturación por uso te permite cobrar un monto variable además de la tarifa fija del plan — por ejemplo una suscripción base más un cargo por solicitud o por gigabyte.
Los medidores de uso y su tarificación por plan se configuran en el Dashboard, en Suscripciones → Medidores de uso, no por la API. Este endpoint solo ingiere los eventos de uso en bruto. Consulta Facturación por uso e híbrida para el modelo completo.

​
Cómo los cargos medidos llegan a una factura

  1. Defines un medidor (p. ej. api_requests) con un modo de agregación, y lo tarificas en un plan.
  2. A lo largo del período de facturación llamas a POST /subscription/usage por cada evento de uso.
  3. En la renovación, Therius agrega los eventos de ese período según el modo de agregación del medidor, resta las unidades incluidas del plan, aplica el esquema de tarificación y suma el resultado a la factura como su propia línea.
El período de facturación al que cuenta un evento se determina por su timestamp occurredAt. Envía un header Idempotency-Key opcional cuando tu trabajo de reporte pueda reintentar — una repetición con el mismo par (meterCode, Idempotency-Key) devuelve el evento original con duplicate: true en vez de registrar un segundo.

Autorizaciones

​
Authorization
string
header
requerido

Your secret API key: Bearer prv_production_xxx (production) or Bearer prv_sandbox_xxx (sandbox).

Encabezados

​
Idempotency-Key
string

Optional. A replay with the same (meterCode, Idempotency-Key) pair returns the original event instead of recording a second one. Use it when your reporting job may retry.

Cuerpo

application/json
​
subscriptionId
string
requerido

UUID of the subscription the usage is attributed to.

​
meterCode
string
requerido

The code of a usage meter belonging to your merchant account, e.g. api_requests.

Ejemplo:

"api_requests"

​
quantity
number
requerido

Non-negative quantity for this event, in the meter's units.

Ejemplo:

500

​
merchantCode
string

Your merchant account identifier.

​
occurredAt
string<date-time>

Optional RFC 3339 timestamp of when the usage occurred. Defaults to the time the request is received. Determines which billing period the event falls into.

Respuesta

Event recorded, or the original event on an idempotent replay.

​
id
string

UUID of the usage event.

​
meterCode
string

The meter the event was recorded against.

​
quantity
number

The recorded quantity.

​
occurredAt
string<date-time>

Timestamp the event was attributed to (the billing-period key).

​
duplicate
boolean

true when this response is an idempotent replay of a previously recorded event.