更改计划
修改现有订阅的计划,允许升级和降级到不同的定价层级。
注意:这将使用客户的现有支付信息来升级/降级计划。
计划更改安排
使用effective_at 参数来控制计划更改生效的时间:
支付失败处理
使用on_payment_failure 参数来控制在计划更改支付失败时会发生什么:
on_payment_failure,则默认行为为您在仪表板中配置的业务级别设置。优惠码
在更改计划时,可以通过传递discount_codes 数组(最多 20 个条目,按数组顺序应用)应用一个或多个叠加折扣码。单一的 discount_code 字段已弃用,但现有集成仍可使用;无法在同一请求中与 discount_codes 结合使用。
授权
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
路径参数
Subscription Id
请求体
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
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 响应
Subscription plan changed. If on_payment_failure=prevent_change, the plan change is pending until payment succeeds.