Skip to main content
GET
Retrieve Subscription Usage
Devuelve el uso medido que una suscripción ha acumulado en su período de facturación actual, valorizado según los medidores asociados a su plan: un elemento por medidor, con la cantidad agregada, la cantidad que realmente se factura después de consumir los créditos incluidos, el precio unitario y el monto resultante, además de un total del período. Es una lectura: no activa la facturación por sí misma. Consulta Facturación basada en el uso para saber cómo una suscripción acumula medidores, créditos y precios en primer lugar.

Cómo leer la respuesta

Toda cantidad y todo monto es un número JSON.
A subscription with one metered item

Cuando no hay nada que facturar

Una suscripción cuyo plan no tiene medidores, o que no tiene ningún plan, devuelve items: [] y un total en cero en lugar de un error.
El reporte es asíncronoPOST /subscriptions/meters/events responde 202 una vez que el evento se valida, antes de que se almacene. Una lectura de uso que ocurre poco después de reportar un evento todavía puede mostrar el total de antes de ese evento: los items de una suscripción mantuvieron la misma quantity y events_count en una lectura hecha inmediatamente después de reportar otro evento en stg. Espera un breve tiempo antes de confiar en que una lectura refleje el último reporte.

Errores

Authorizations

public-api-key
string
header
default:<Your public-api-key>
required
private-secret-key
string
header
default:<Your private-secret-key>
required

Headers

X-Account-Code
string
required

El account_id que encuentras en tu Dashboard de Yuno (UUID).

Path Parameters

subscription_id
string
required

El identificador único de la suscripción.

Response

200

subscription_code
string
Example:

"c2094820-df10-4bd4-b7ef-dbe0d28db857"

period
object

El período de facturación actual de la suscripción.

currency
string
Example:

"COP"

items
object[]

Una entrada por cada medidor asociado al plan de la suscripción. Vacío cuando el plan no tiene medidores o la suscripción no tiene plan.

total
object

La suma del monto de todos los ítems del período. Cero cuando items está vacío.