Previsualizar el prorrateo de cambios | Documentación API de Recurrente

Calcula el prorrateo neto de un conjunto de cambios de productos sin aplicarlos (equivalente al preview de facturas de Stripe). Envía los mismos items y mode que enviarías a PUT /subscriptions/{id}. Útil para mostrar el monto antes de cobrar con mode: now_and_charge.

chargeable indica si el neto puede cobrarse de inmediato (positivo y mayor al mínimo de la moneda). Si es false, usa mode: now (se reflejará en el próximo cobro).

Calcula el prorrateo neto de un conjunto de cambios de productos **sin aplicarlos** (equivalente al preview de facturas de Stripe). Envía los mismos `items` y `mode` que enviarías a `PUT /subscriptions/{id}`. Útil para mostrar el monto antes de cobrar con `mode: now_and_charge`. `chargeable` indica si el neto puede cobrarse de inmediato (positivo y mayor al mínimo de la moneda). Si es `false`, usa `mode: now` (se reflejará en el próximo cobro).

Authentication

X-SECRET-KEYstring

Tu clave secreta de API.

Una llave de cuenta (sk_live_..., sk_test_...) opera sobre su propia cuenta y, con X-ACCOUNT-ID, sobre sus cuentas conectadas.

Una llave de organización (sk_org_live_..., sk_org_test_...) alcanza todas las cuentas de una organización y solo sirve para leer: saldos, movimientos y reportes. Para operar sobre una cuenta debe nombrarla con X-ACCOUNT-ID; omitirlo en una lectura devuelve todas las cuentas de la organización. Cualquier otro endpoint responde 403 con code: organization_key_unsupported.

Tu clave secreta de API. Una llave de cuenta (`sk_live_...`, `sk_test_...`) opera sobre su propia cuenta y, con `X-ACCOUNT-ID`, sobre sus cuentas conectadas. Una llave de organización (`sk_org_live_...`, `sk_org_test_...`) alcanza todas las cuentas de una organización y solo sirve para leer: saldos, movimientos y reportes. Para operar sobre una cuenta debe nombrarla con `X-ACCOUNT-ID`; omitirlo en una lectura devuelve todas las cuentas de la organización. Cualquier otro endpoint responde `403` con `code: organization_key_unsupported`.

Path parameters

idstringRequired

ID de la suscripción

Request

This endpoint expects an object.

modeenumOptional

Mismo significado que en PUT /subscriptions/{id}. next_cycle no genera prorrateo.

Allowed values:

itemslist of objectsOptional

Lista de cambios a previsualizar (mismo formato que en la actualización).

Response

Estimación del prorrateo

net_amount_in_centsintegerOptional

Prorrateo neto en centavos. Positivo = cobro; negativo = crédito.

currencystringOptional

chargeablebooleanOptional

true si el neto puede cobrarse de inmediato (positivo y mayor al mínimo de la moneda).

lineslist of objectsOptional

Desglose por producto (prorrateos positivos y créditos).

$	curl -X POST https://app.recurrente.com/api/subscriptions/id/proration_preview \
>	-H "X-SECRET-KEY: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{}'

1	{
2	"net_amount_in_cents": 4250,
3	"currency": "GTQ",
4	"chargeable": true,
5	"lines": [
6	{
7	"description": "Prorrateo: Plan Pro",
8	"amount_in_cents": 4250
9	}
10	]
11	}