RErecurrente
subscriptions

Previsualizar el prorrateo de cambios

Changed on

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).

post/subscriptions/{id}/proration_preview

Request

Path parameters

idstring required

ID de la suscripción

Request body

mode'next_cycle' | 'now' | 'now_and_charge'

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

Response

Estimación del prorrateo

net_amount_in_centsinteger

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

currencystring
chargeableboolean

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

Changes

  • 3d76463f9fd8Revision changes
    • warning

      deleted the header request parameter X-SECRET-KEY

    • info

      the endpoint scheme security secretKey was added to the API

  • 3f07af5cbba7Revision changes
    • info

      api operation id preview-subscription-proration removed and replaced with subscriptions_previewSubscriptionProration