Skip to main content
POST
JavaScript

Geplante Tarifänderungen

Verwenden Sie den effective_at-Parameter, um zu steuern, wann die Tarifänderung wirksam wird:
Geplante Tarifänderungen sind ideal für Downgrades – Kunden behalten ihre aktuellen Tarifvorteile bis zum Ende des Abrechnungszeitraums und wechseln dann automatisch zum neuen Tarif.
Um eine geplante Tarifänderung zu stornieren, bevor sie wirksam wird, verwenden Sie den Geplante Tarifänderung stornieren Endpunkt.

Zahlungsfehlerbehandlung

Verwenden Sie den on_payment_failure-Parameter, um zu steuern, was passiert, wenn die Zahlung für die Tarifänderung fehlschlägt:
Falls on_payment_failure nicht angegeben ist, erfolgt die Standardverhalten gemäß Ihrer Geschäftseinstellung im Dashboard.

Rabattcodes

Sie können einen oder mehrere stapelbare Rabattcodes anwenden, wenn Sie Pläne ändern, indem Sie das discount_codes Array übergeben (maximal 20 Einträge, in Array-Reihenfolge angewendet). Das einzelne discount_code Feld ist veraltet, funktioniert aber noch für bestehende Integrationen; es kann nicht mit discount_codes in derselben Anfrage kombiniert werden.
Verwenden Sie Rabattcodes bei Planänderungen, um Aktionspreise bei Upgrades anzubieten, oder geben Sie Codes weiter, wenn Sie Kunden in eine neue Planstufe migrieren.
Verwenden Sie prevent_change für kritische Upgrades, bei denen Sie sicherstellen möchten, dass die Zahlung erfolgt, bevor Sie Zugang zu Premium-Funktionen gewähren.

Autorisierungen

Authorization
string
header
erforderlich

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

Pfadparameter

subscription_id
string
erforderlich

Subscription Id

Body

application/json
product_id
string
erforderlich

Unique identifier of the product to subscribe to

proration_billing_mode
enum<string>
erforderlich

Proration Billing Mode

Verfügbare Optionen:
prorated_immediately,
full_immediately,
difference_immediately,
do_not_bill
quantity
integer<int32>
erforderlich

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

Erforderlicher Bereich: 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
veraltet

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
Verfügbare Optionen:
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.

Verfügbare Optionen:
prevent_change,
apply_change

Antwort

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.

Zuletzt geändert am 22. Mai 2026