Ubah Rencana
Ubah paket langganan yang sudah ada, termasuk upgrade dan downgrade ke tingkatan harga yang berbeda.
Catatan: Secara default, ini menggunakan informasi pembayaran pelanggan yang sudah ada. Atur collect_via_payment_link untuk menagih melalui halaman checkout yang di-host.
Perubahan Rencana Terjadwal
Gunakan parametereffective_at untuk mengontrol kapan perubahan rencana berlaku:
Penanganan Kegagalan Pembayaran
Gunakan parameteron_payment_failure untuk mengontrol apa yang terjadi ketika pembayaran perubahan rencana gagal:
on_payment_failure tidak ditentukan, perilaku default sesuai dengan pengaturan tingkat bisnis Anda yang dikonfigurasi di dasbor.Mengumpulkan Pembayaran melalui Payment Link
Aturcollect_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:
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
Tetapkanreturn_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.
statusadalah status pembayaran plan change, bukan status subscription.- Jika pembayaran gagal, subscription tetap aktif pada plan saat ini. Untuk mencoba lagi, panggil kembali
change-planuntuk 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.
Mengganti Link Pembayaran yang Menunggu
Jika customer meninggalkan checkout tanpa membayar, tetapkancancel_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:
change-plan menerbitkan invoice-nya sendiri. Perubahan plan yang digantikan dan invoice-nya dibatalkan.
Kode Diskon
Anda dapat menerapkan satu atau beberapa kode diskon bertumpuk saat mengubah plan dengan meneruskan arraydiscount_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.
Otorisasi
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Parameter Path
Subscription Id
Body
Unique identifier of the product to subscribe to
Proration Billing Mode
prorated_immediately, full_immediately, difference_immediately, do_not_bill 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
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.
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.