Skip to main content
POST
payments.checkout.create-catalog

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Account
string

Optional. One of your account ids (GET /v1/accounts): run on that account, whatever your routing rules say. The response header X-Pramaan-Account names the account that ran.

Pramaan-End-User
string

Optional. Your own tag for your end user: a sticky: end_user rule keeps them on the account that first served them.

Maximum string length: 256
Pramaan-End-User-Group
string

Optional. Your end user's group, matched by rules with endUserGroup.

Maximum string length: 64

Body

application/json
variantId
string
required

Saved catalog variant to sell.

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9_-]+$
customPrice
integer

Explicit selling price in minor units; also applies to subscription renewals until a variant change.

Required range: 1 <= x <= 99999999
productOptions
object

Product overrides.

displayOptions
object

Checkout appearance.

customer
object

Customer contact, address, tax and custom prefill.

variantQuantities
object[]

Per-variant quantities.

Maximum array length: 50
preview
boolean
default:false

Return a quote with a real checkout; this does not complete a purchase.

testMode
boolean

Must agree with the connected account environment.

expiresAt
string<date-time> | null

Checkout expiry; null creates a perpetual checkout. The hosted link lasts at most 24 hours.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$

Response

The result

url
string
required

Hosted checkout link; valid at most 24 hours.

expiresAt
string

Upstream checkout expiry when finite.

preview
object

Quote; actual tax and discounts may differ.

ref
string

Reference to what this call created. Pass it as ref to payments.checkout.get.