Stash Documentation
Integration GuidesAPI ReferencePartner with us

Create a subscription change checkout link

Creates a checkout link for upgrading an existing subscription to a new plan. Only subscriptions in a `active`, `trialing`, or `cancelled` (still within paid period before expiration) state are eligible for upgrades.

POST
/sdk/subscriptions/{subscriptionId}/change-checkout-links

Authorization

X-Stash-Api-Key<token>

API key authentication for server-side SDK operations. Used for secure server-to-server communication.

In: header

Path Parameters

subscriptionIdstring

ID of the subscription to modify

Request Body

newPlan?string

New plan ID or code for upgrade. At least one of new_plan or update_payment_method must be set.

updatePaymentMethod?boolean

If true, the user must provide a new payment method during checkout

referenceId?string

Optional client reference ID for tracking

metadata?object

Optional custom key-value metadata

Empty Object

billingAnchor?string

Optional new billing anchor timestamp. If set, resets the billing cycle to start from this time. Must be within the current billing period.

Formatdate-time
initialPayment?pie.sdk.checkout_links.InitialPayment

Optional override for the upgrade charge. When set, our default proration calculation is skipped.

paymentMethod?string

Optional preferred payment method (e.g. card, google_pay, apple_pay, paypal)

Response Body

curl -X POST "https://test-api.stash.gg/sdk/subscriptions/string/change-checkout-links" \  -H "Content-Type: application/json" \  -d '{}'
{
  "id": "string",
  "url": "string"
}
{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string",
      "property1": null,
      "property2": null
    }
  ]
}

How is this guide?