플랜 변경
기존 구독의 플랜을 수정하여 다양한 가격대의 업그레이드 및 다운그레이드를 가능하게 합니다.
참고: 이 작업은 고객의 기존 결제 정보를 사용하여 플랜을 업그레이드/다운그레이드합니다.
예약된 요금제 변경
요금제 변경이 언제 적용될지 제어하려면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.