Alterar Plano

Modifique o plano de uma assinatura existente, permitindo tanto upgrades quanto downgrades para diferentes níveis de preços.

Nota: Isso usará as informações de pagamento existentes do cliente para atualizar/diminuir o plano.

POST /subscriptions/{subscription_id}/change-plan

JavaScript

JavaScript

import DodoPayments from 'dodopayments';

const client = new DodoPayments({
  bearerToken: process.env['DODO_PAYMENTS_API_KEY'], // This is the default and can be omitted
});

await client.subscriptions.changePlan('subscription_id', {
  product_id: 'product_id',
  proration_billing_mode: 'prorated_immediately',
  quantity: 0,
});

​

Alterações de Plano Agendadas

Use o parâmetro effective_at para controlar quando a alteração do plano entra em vigor:

Valor	Comportamento
immediately	Aplique a alteração do plano imediatamente. Este é o padrão.
next_billing_date	Agende a alteração para a próxima data de cobrança. O cliente mantém acesso ao plano atual até o final do período de faturamento.

Alterações de plano agendadas são ideais para downgrades — os clientes mantêm os benefícios do plano atual até o final do período de faturamento e, em seguida, mudam automaticamente para o novo plano.

Para cancelar uma alteração de plano agendada antes que ela entre em vigor, use o endpoint Cancelar Alteração de Plano Agendada.

​

Tratamento de Falha de Pagamento

Use o parâmetro on_payment_failure para controlar o que acontece quando o pagamento da alteração do plano falha:

Valor	Comportamento
prevent_change	Mantenha a assinatura no plano atual até que o pagamento seja bem-sucedido. A alteração do plano permanece pendente.
apply_change	Aplique a alteração do plano imediatamente, independentemente do resultado do pagamento. Este é o padrão.

Se on_payment_failure não for especificado, o comportamento será o padrão configurado em nível de negócios no painel.

​

Códigos de Desconto

Você pode aplicar um ou mais códigos de desconto acumulados ao alterar planos passando o array discount_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; não pode ser combinado com discount_codes na mesma solicitação.

Valor discount_codes	Comportamento
Não fornecido (null / omitido)	Descontos existentes com preserve_on_plan_change=true são preservados se aplicáveis ao novo produto.
[] (array vazio)	Todos os descontos existentes são removidos da assinatura.
["CODE_A", "CODE_B", ...]	Substitui quaisquer descontos existentes com este conjunto acumulado, validado e aplicado na ordem do array.

Use códigos de desconto durante mudanças de plano para oferecer preços promocionais em upgrades, ou passe códigos ao migrar clientes para um novo nível de plano.

Use prevent_change para upgrades críticos onde você deseja garantir o pagamento antes de conceder acesso a recursos premium.

Autorizações

Authorization · string · header · obrigatório

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Parâmetros de caminho

subscription_id · string · obrigatório

Subscription Id

Corpo

application/json

product_id · string · obrigatório

Unique identifier of the product to subscribe to

proration_billing_mode · enum<string> · obrigatório

Proration Billing Mode

Opções disponíveis: prorated_immediately, full_immediately, difference_immediately, do_not_bill

quantity · integer<int32> · obrigatório

Number of units to subscribe for. Must be at least 1.

Intervalo obrigatório: x >= 0

adaptive_currency_fees_inclusive · boolean | null

Whether 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 · Attach Addon Request · object[] | null

Addons for the new plan. Note : Leaving this empty would remove any existing addons

Show child attributes

discount_code · string | null · obsoleto

DEPRECATED: Use discount_codes instead. Cannot be used together with discount_codes.

discount_codes · string[] | null

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.

effective_at · enum<string>

When to apply the plan change.

• immediately (default): Apply the plan change right away
• next_billing_date: Schedule the change for the next billing date

Opções disponíveis: immediately, next_billing_date

metadata · object

Metadata for the payment. If not passed, the metadata of the subscription will be taken

Show child attributes

on_payment_failure · null | enum<string>

Controls behavior when the plan change payment fails.

• prevent_change: Keep subscription on current plan until payment succeeds
• apply_change (default): Apply plan change immediately regardless of payment outcome

If not specified, uses the business-level default setting.

Opções disponíveis: prevent_change, apply_change

Resposta

200

Subscription plan changed. If on_payment_failure=prevent_change, the plan change is pending until payment succeeds.