Alterar Plano
Modifique o plano de uma assinatura existente, permitindo upgrades e downgrades para diferentes níveis de preço.
Observação: Por padrão, isso usa as informações de pagamento existentes do cliente. Defina collect_via_payment_link para cobrar por meio de uma página de checkout hospedada.
Alterações de Plano Agendadas
Use o parâmetroeffective_at para controlar quando a alteração do plano entra em vigor:
Tratamento de Falha de Pagamento
Use o parâmetroon_payment_failure para controlar o que acontece quando o pagamento da alteração do plano falha:
on_payment_failure não for especificado, o comportamento será o padrão configurado em nível de negócios no painel.Coleta por meio de Payment Link
Definacollect_via_payment_link como true para enviar o cliente a uma página de checkout hospedada em vez de cobrar o método de pagamento salvo. A resposta então inclui payment_id, payment_link, client_secret e expires_on — redirecione o cliente para payment_link para concluir o pagamento.
Isso requer:
422. Enquanto o link não for pago, a assinatura permanece no plano atual, e uma nova solicitação change-plan retorna 409, a menos que você defina cancel_older_payment_link.
Redirecionamento após o pagamento
Definareturn_url para enviar o cliente de volta ao seu site após o pagamento do link. O redirecionamento adiciona subscription_id, payment_id e status como parâmetros de query.
statusé o status do pagamento da alteração de plano, não o status da assinatura.- Quando o pagamento falha, a assinatura permanece ativa no plano atual. Para tentar novamente, chame
change-planoutra vez para obter um novo link. - O novo plano pode ser aplicado pouco depois do redirecionamento, quando o webhook de pagamento chegar.
return_url requer collect_via_payment_link: true. Sem ele, a solicitação retorna 422.
Substituindo um link de pagamento pendente
Se o cliente sair do checkout sem pagar, definacancel_older_payment_link como true na próxima solicitação change-plan. Dodo Payments cancela o link não pago, e a nova alteração de plano substitui a pendente. O link cancelado não aceita mais pagamentos.
A solicitação é validada antes que o link seja cancelado, portanto uma solicitação inválida mantém o link do cliente. O link só é cancelado se o cliente ainda não tiver iniciado o pagamento:
change-plan emite sua própria invoice. A alteração de plano substituída e sua invoice são canceladas.
Códigos de desconto
Você pode aplicar um ou mais códigos de desconto combinados ao alterar planos, passando o arraydiscount_codes (máximo de 20 entradas, aplicadas na ordem do array). O campo singular discount_code está obsoleto, mas ainda funciona para integrações existentes; ele não pode ser combinado com discount_codes na mesma solicitação.
Autorizações
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Parâmetros de caminho
Subscription Id
Corpo
Unique identifier of the product to subscribe to
Proration Billing Mode
prorated_immediately, full_immediately, difference_immediately, do_not_bill, prorated_immediately_keep_cycle 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
Cancel the payment link of a pending plan change, so that this change can replace it.
The link is cancelled only if the customer has not started to pay. A
paid or in-progress payment gives a 409. A failed cancel gives a
503, and a retry is safe.
The request is validated before the cancel. A later failure, for example an amount below the minimum, leaves the subscription on its current plan with no open link. A retry is safe.
The preview route shares this request body and ignores this field.
Replace a scheduled plan change with this one.
The scheduled change is cancelled by the transaction that applies this change. A change that never applies leaves the schedule in place.
effective_at: next_billing_date is allowed. The new schedule then
replaces the old one in the request transaction.
A pending plan change still gets a 409. This field does not affect it.
The preview route shares this request body, so a preview that sets this
field also passes the scheduled-change 409.
Collect the plan-change amount with a payment link. The customer then pays on a checkout page.
The business needs the allow_plan_change_via_payment_link capability.
The request needs effective_at: immediately. The request also needs
on_payment_failure: prevent_change.
The preview route shares this request body and ignores this field.
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 date
immediately, 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 outcome
With effective_at: next_billing_date, the plan change payment replaces the renewal payment.
If that payment fails with prevent_change, the plan change is cancelled.
The subscription then renews on the current plan, with the usual payment retries.
If not specified, uses the business-level default setting.
prevent_change, apply_change The URL that receives the customer after they pay the payment link.
Needs collect_via_payment_link: true. Without it, the request gets a
422. A change that collects no money issues no link and does not use
the URL. The preview route validates this field but does not use it.
The redirect adds subscription_id, payment_id and status. The
status value is the status of the plan-change payment. It is not the
status of the subscription. When that payment fails, the subscription
stays active on its current plan. To try again, call this endpoint
again to get a new link. The new plan can apply after the redirect,
when the payment webhook arrives.
Resposta
Subscription plan changed. A link request can return checkout details. A pending plan change applies after payment succeeds.
Handles for a hosted checkout page that settles a plan change.
The four fields repeat UpdatePaymentMethodResponse and a subset of
CreateSubscriptionResponse. A shared type would rename the generated SDK
types for all three routes, so each route keeps its own.