구독 요금제 변경의 영향을 실제로 변경하기 전에 미리 확인합니다. 즉각적인 청구 금액과 새로운 구독 세부정보를 반환하지만 실제 변경은 하지 않습니다.
discount_code in the preview request to see how the discount affects the immediate charge and new plan pricing before committing to the change.
| 필드 | 설명 |
|---|---|
immediate_charge | 즉시 생성될 요금으로, 품목 및 요약 포함 |
new_plan | 요금제 변경 후 어떻게 보일지를 보여주는 전체 구독 객체 |
immediate_charge.summary contains the total amount that would be charged. Use this to display pricing to your customers before they confirm the plan change.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 >= 0Addons for the new plan. Note : Leaving this empty would remove any existing addons
Optional discount code to apply to the new plan.
If provided, validates and applies the discount to the plan change.
If not provided and the subscription has an existing discount with preserve_on_plan_change=true,
the existing discount will be preserved (if applicable to the new product).
When to apply the plan change.
immediately (default): Apply the plan change right awaynext_billing_date: Schedule the change for the next billing dateimmediately, 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 outcomeIf not specified, uses the business-level default setting.
prevent_change, apply_change