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,
});

​
Perubahan Rencana Terjadwal

Gunakan parameter effective_at untuk mengontrol kapan perubahan rencana berlaku:
NilaiPerilaku
immediatelyTerapkan perubahan rencana segera. Ini adalah defaultnya.
next_billing_dateJadwalkan perubahan untuk tanggal penagihan berikutnya. Pelanggan mempertahankan akses ke rencana mereka saat ini hingga periode penagihan berakhir.
Perubahan rencana terjadwal ideal untuk penurunan — pelanggan tetap mendapatkan manfaat rencana mereka saat ini hingga akhir periode penagihan, kemudian otomatis beralih ke rencana baru.
Untuk membatalkan perubahan rencana terjadwal sebelum berlaku, gunakan endpoint Batal Perubahan Rencana Terjadwal.

​
Penanganan Kegagalan Pembayaran

Gunakan parameter on_payment_failure untuk mengontrol apa yang terjadi ketika pembayaran perubahan rencana gagal:
NilaiPerilaku
prevent_changePertahankan langganan pada rencana saat ini hingga pembayaran berhasil. Perubahan rencana tetap tertunda.
apply_changeTerapkan perubahan rencana segera terlepas dari hasil pembayaran. Ini adalah defaultnya.
Jika on_payment_failure tidak ditentukan, perilaku default sesuai dengan pengaturan tingkat bisnis Anda yang dikonfigurasi di dasbor.

​
Kode Diskon

Anda dapat menerapkan kode diskon saat mengubah rencana dengan memasukkan parameter discount_code.
SkenarioPerilaku
discount_code disediakanMemvalidasi dan menerapkan diskon ke rencana baru.
discount_code tidak disediakan, diskon yang ada dengan preserve_on_plan_change=trueDiskon yang ada dipertahankan jika berlaku untuk produk baru.
discount_code tidak disediakan, tidak ada diskon yang dapat dipertahankanTidak ada diskon yang diterapkan.
Gunakan kode diskon selama perubahan rencana untuk menawarkan harga promosi pada peningkatan, atau berikan kode saat memigrasi pelanggan ke tingkat rencana baru.
Gunakan prevent_change untuk peningkatan penting 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,
do_not_bill
​
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).

​
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
Opsi yang tersedia:
immediately,
next_billing_date
​
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.

Last modified on April 20, 2026