Pré-visualize os efeitos de uma mudança de plano de assinatura antes de se comprometer com ela. Retorna o valor da cobrança imediata e os detalhes da nova assinatura sem fazer alterações reais.
Documentation Index
Fetch the complete documentation index at: https://docs.dodopayments.com/llms.txt
Use this file to discover all available pages before exploring further.
discount_code na solicitação de pré-visualização para ver como o desconto afeta a cobrança imediata e o novo preço do plano antes de confirmar a alteração.| Campo | Descrição |
|---|---|
immediate_charge | A cobrança que seria criada imediatamente, incluindo itens de linha e resumo |
new_plan | O objeto completo da assinatura mostrando como ficaria após a mudança de plano |
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Subscription Id
Unique identifier of the product to subscribe to
Proration Billing Mode
prorated_immediately, full_immediately, difference_immediately, do_not_bill Number of units to subscribe for. Must be at least 1.
x >= 0Whether adaptive currency fees should be included in the price (true) or added on top (false). If not specified, uses the subscription's stored setting.
Addons for the new plan. Note : Leaving this empty would remove any existing addons
DEPRECATED: Use discount_codes instead. Cannot be used together with discount_codes.
Stacked discount codes to apply to the new plan. Max 20. Cannot be used together with discount_code. If provided, replaces any existing discount codes. Empty array removes all discounts. If not provided (None), existing discounts with preserve_on_plan_change=true are preserved.
When to apply the plan change.
immediately (default): Apply the plan change right awaynext_billing_date: Schedule the change for the next billing dateimmediately, next_billing_date Metadata for the payment. If not passed, the metadata of the subscription will be taken
Controls behavior when the plan change payment fails.
prevent_change: Keep subscription on current plan until payment succeedsapply_change (default): Apply plan change immediately regardless of payment outcomeIf not specified, uses the business-level default setting.
prevent_change, apply_change