Skip to main content
POST
Node.js

Headers

x-api-key
string
required

API key from your PriceOS dashboard.

Path Parameters

customerId
string
required

Internal customer ID.

Body

application/json
productKey
string
required

Product key from your PriceOS dashboard. Must reference a Stripe product (not a custom product).

stripePriceId
string | null

Optional Stripe price ID. When provided, it must be active and belong to the selected Stripe product.

successUrl
string<uri>

Optional checkout success redirect URL.

cancelUrl
string<uri>

Optional checkout cancel redirect URL.

metadata
object

Optional metadata to attach to the Stripe checkout session.

customerInfo
object

Optional customer info used when creating/updating the customer.

checkoutParams
object

Optional Stripe Checkout Session params to merge into the request.

Response

Checkout session

url
string<uri>
required

Stripe checkout URL.