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.

Kode Diskon

Anda dapat menerapkan satu atau lebih kode diskon bertumpuk saat mengubah rencana dengan melewatkan array discount_codes (maksimal 20 entri, diterapkan sesuai urutan array). Kolom singular discount_code sudah tidak digunakan lagi tetapi masih berfungsi untuk integrasi yang ada; tidak dapat digabungkan dengan discount_codes dalam permintaan yang sama.
Gunakan kode diskon selama perubahan rencana untuk menawarkan harga promosi pada peningkatan, atau lewati 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
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_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

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 22 Mei 2026