Skip to main content
POST
JavaScript

Thay đổi kế hoạch đã lên lịch

Sử dụng tham số effective_at để kiểm soát khi nào thay đổi kế hoạch có hiệu lực:
Thay đổi kế hoạch đã lên lịch là lý tưởng cho việc hạ cấp — khách hàng giữ quyền lợi kế hoạch hiện tại cho đến cuối chu kỳ thanh toán, sau đó tự động chuyển sang kế hoạch mới.
Để hủy thay đổi kế hoạch đã lên lịch trước khi có hiệu lực, sử dụng endpoint Cancel Scheduled Plan Change.

Xử lý lỗi thanh toán

Sử dụng tham số on_payment_failure để kiểm soát điều gì xảy ra khi thanh toán thay đổi kế hoạch thất bại:
Nếu on_payment_failure không được chỉ định, hành vi sẽ mặc định theo cấu hình cấp doanh nghiệp của bạn trong bảng điều khiển.

Mã giảm giá

Bạn có thể áp dụng một hoặc nhiều mã giảm giá xếp chồng khi thay đổi gói bằng cách truyền mảng discount_codes (tối đa 20 mục, áp dụng theo thứ tự của mảng). Trường đơn discount_code đã lỗi thời nhưng vẫn hoạt động cho các tích hợp hiện có; không thể kết hợp với discount_codes trong cùng một yêu cầu.
Sử dụng mã giảm giá trong quá trình thay đổi gói để cung cấp giá khuyến mãi khi nâng cấp, hoặc truyền mã khi di chuyển khách hàng sang cấp gói mới.
Sử dụng prevent_change cho những nâng cấp quan trọng mà bạn muốn đảm bảo thanh toán trước khi cấp quyền truy cập vào các tính năng cao cấp.

Ủy quyền

Authorization
string
header
bắt buộc

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

Tham số đường dẫn

subscription_id
string
bắt buộc

Subscription Id

Nội dung

application/json
product_id
string
bắt buộc

Unique identifier of the product to subscribe to

proration_billing_mode
enum<string>
bắt buộc

Proration Billing Mode

Tùy chọn có sẵn:
prorated_immediately,
full_immediately,
difference_immediately,
do_not_bill
quantity
integer<int32>
bắt buộc

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

Phạm vi bắt buộc: 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
không còn sử dụng

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
Tùy chọn có sẵn:
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.

Tùy chọn có sẵn:
prevent_change,
apply_change

Phản hồi

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.

Lần sửa đổi cuối 22 tháng 5, 2026