Stash Documentation
Integration GuidesAPI ReferencePartner with usChangelog

Generate Checkout

Generates a quick payment URL for server-side operations. This endpoint is used internally for creating payment links with user information.

POST
/sdk/server/checkout_links/generate_quick_pay_url

Authorization

X-Stash-Api-Key<token>

DEPRECATED: API key authentication is no longer supported for new shops. Use HMAC authentication via the x-stash-hmac-signature header instead for the best security. Existing shops may continue using their X-Stash-Api-Key for server-to-server operations, but are encouraged to migrate to HMAC as soon as possible.

In: header

Request Body

item?pie.sdk.quickpay.GenerateQuickPayUrlRequest.Item

Item to purchase with inline pricing. Mutually exclusive with catalog_items; provide exactly one of the two.

bonusItems?array<Bonus items to include with the purchase (free items granted alongside the main item)>

Optional bonus items to include with the purchase. These are free items granted alongside the main item.

user?pie.sdk.quickpay.GenerateQuickPayUrlRequest.User

User information for the payment

transactionId?string

Optional transaction ID for tracking

regionCode?string

Region code (2-3 letter country code, defaults to US if not set)

currency?string

ISO-4217 Currency code (currently only USD supported)

catalogItems?array<pie.sdk.quickpay.GenerateQuickPayUrlRequest.CatalogItem>

Managed Catalog SKUs (id + quantity) to resolve server-side. Requires the shop to have managed catalog enabled. Mutually exclusive with item; provide exactly one of the two.

checkoutSessionId?string

Optional checkout-session id (the per-tab analytics session for this checkout, shared with telemetry and the funnel webhooks); persisted on the order. Distinct from the multi-PSP payment session_id used during authorization.

Response Body

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

How is this guide?

Generate authenticated URL POST

Generates an authenticated URL for a specific target (home or loyalty) for a user. This endpoint is used for server-side URL generation.

Create a subscription change checkout link POST

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.