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.
Versioned HMAC-SHA256 signature authenticating server-to-server SDK requests (your backend calling Stash), as opposed to client-side SDK operations. Recommended over the deprecated X-Stash-Api-Key for the best security. Header format: v1;{appId};{unixMillisTimestamp};{base64Signature} (semicolon-delimited). {base64Signature} is the base64-encoded HMAC-SHA256 of the string {unixMillisTimestamp}.{requestBody} using your app ingress secret (the ingress secret is shown base64-encoded in Studio; base64-decode it to the raw bytes used as the HMAC key), where {requestBody} is the compact canonical request JSON for POST requests and empty for GET requests. The timestamp must be within 5 minutes of Stash server time. Your appId is your immutable app identifier, shown in Stash Studio under Project Settings > App details; your ingress secret is under Project Settings > API Secrets.
In: header
Path Parameters
ID of the subscription to modify
New plan ID or code for upgrade. At least one of new_plan or update_payment_method must be set.
If true, the user must provide a new payment method during checkout
Optional client reference ID for tracking
Optional custom key-value metadata
Empty Object
Optional new billing anchor timestamp. If set, resets the billing cycle to start from this time. Must be within the current billing period.
date-timeOptional override for the upgrade charge. When set, our default proration calculation is skipped.
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?
Generate Checkout POST
Generates a quick payment URL for server-side operations. This endpoint is used internally for creating payment links with user information.
Create a subscription checkout link POST
Creates a checkout link for purchasing a subscription plan. The link can be shared with users to complete their subscription purchase.