Langsung ke konten utama
POST
/
subscriptions
/
{subscription_id}
/
change-plan
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,
});

​
Penanganan Kegagalan Pembayaran

Gunakan parameter on_payment_failure untuk mengendalikan apa yang terjadi ketika pembayaran perubahan paket gagal:
ValueBehavior
prevent_changePertahankan langganan pada paket saat ini hingga pembayaran berhasil. Perubahan paket tetap tertunda.
apply_changeTerapkan perubahan paket segera terlepas dari hasil pembayaran. Ini adalah bawaan.
Jika on_payment_failure tidak ditentukan, perilaku default mengikuti pengaturan tingkat bisnis Anda yang dikonfigurasi di dashboard.
Gunakan prevent_change untuk peningkatan kritis di mana Anda ingin memastikan pembayaran sebelum memberikan akses ke fitur premium.

Otorisasi

​
Authorization
string
header
wajib

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

Parameter Path

​
subscription_id
string
wajib

Subscription Id

Body

application/json
​
product_id
string
wajib

Unique identifier of the product to subscribe to

​
proration_billing_mode
enum<string>
wajib

Proration Billing Mode

Opsi yang tersedia:
prorated_immediately,
full_immediately,
difference_immediately
​
quantity
integer<int32>
wajib

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

Rentang yang diperlukan: x >= 0
​
addons
Attach Addon Request · object[] | null

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

​
discount_code
string | null

Optional discount code to apply to the new plan. If provided, validates and applies the discount to the plan change. If not provided and the subscription has an existing discount with preserve_on_plan_change=true, the existing discount will be preserved (if applicable to the new product).

​
metadata
object

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

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

Opsi yang tersedia:
prevent_change,
apply_change

Respons

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