Skip to main content
POST
JavaScript

Perubahan Rencana Terjadwal

Gunakan parameter effective_at untuk mengontrol kapan perubahan rencana berlaku:
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:
Jika on_payment_failure tidak ditentukan, perilaku default sesuai dengan pengaturan tingkat bisnis Anda yang dikonfigurasi di dasbor.
Atur collect_via_payment_link ke true untuk mengarahkan pelanggan ke halaman checkout yang di-host, bukan menagih metode pembayaran tersimpan mereka. Respons kemudian menyertakan payment_id, payment_link, client_secret, dan expires_on — arahkan pelanggan ke payment_link untuk menyelesaikan pembayaran. Hal ini memerlukan: Request yang tidak memenuhi persyaratan ini akan mengembalikan 422. Selama link belum dibayar, subscription tetap menggunakan plan saat ini dan request change-plan berikutnya akan mengembalikan 409, kecuali Anda menetapkan cancel_older_payment_link.

Mengarahkan Ulang Setelah Pembayaran

Tetapkan return_url untuk mengarahkan customer kembali ke situs Anda setelah mereka membayar link tersebut. Pengarahan ulang menambahkan subscription_id, payment_id, dan status sebagai parameter query.
  • status adalah status pembayaran plan change, bukan status subscription.
  • Jika pembayaran gagal, subscription tetap aktif pada plan saat ini. Untuk mencoba lagi, panggil kembali change-plan untuk mendapatkan link baru.
  • Plan baru dapat diterapkan tidak lama setelah pengarahan ulang, saat payment webhook diterima.
return_url memerlukan collect_via_payment_link: true. Tanpanya, request akan mengembalikan 422. Jika customer meninggalkan checkout tanpa membayar, tetapkan cancel_older_payment_link ke true pada request change-plan berikutnya. Dodo Payments membatalkan link yang belum dibayar, dan perubahan plan baru menggantikan perubahan plan yang masih menunggu. Link yang dibatalkan tidak lagi menerima pembayaran. Request divalidasi sebelum link dibatalkan, sehingga request yang tidak valid membuat link customer tetap ada. Link hanya dibatalkan jika customer belum mulai membayar: Setiap request change-plan menerbitkan invoice-nya sendiri. Perubahan plan yang digantikan dan invoice-nya dibatalkan.
Lihat Panduan Upgrade & Downgrade Subscription untuk alur lengkapnya, termasuk pembayaran yang ditolak, penggantian link yang masih menunggu, dan hal yang terjadi jika link kedaluwarsa.

Kode Diskon

Anda dapat menerapkan satu atau beberapa kode diskon bertumpuk saat mengubah plan dengan meneruskan array discount_codes (maks. 20 entri, diterapkan sesuai urutan dalam array). Field singular discount_code sudah deprecated tetapi masih berfungsi untuk integrasi yang sudah ada; field tersebut tidak dapat digabungkan dengan discount_codes dalam request yang sama.
Gunakan kode diskon selama perubahan plan untuk menawarkan harga promosi pada upgrade, atau teruskan kode saat memindahkan customer ke tingkat plan baru.
Gunakan prevent_change untuk upgrade kritis ketika 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
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

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.

cancel_scheduled_change_plan
boolean

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.

discount_code
string | null
usang

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
Opsi yang tersedia:
immediately,
next_billing_date
metadata
null | 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
return_url
string | null

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.

Respons

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.

client_secret
string | null

Client secret for an embedded checkout.

expires_on
string<date-time> | null

When the link stops working.

payment_id
string | null

Id of the payment that settles the plan change.

Checkout page URL. Give this to the customer.

Terakhir diubah pada 25 September 2026