Skip to main content
GET
JavaScript

Authorizations

Authorization
string
header
required

Rye API key

Path Parameters

id
string
required

The id of the checkout intent to look up

Response

Checkout intent information

buyer
object
required
quantity
integer<int32>
required
Required range: x >= 0
productUrl
string
required
createdAt
string<date-time>
required
id
string
required
state
enum<string>
required
Available options:
retrieving_offer
referenceId
string
Maximum string length: 255
Example:

"order-1234"

discoverPromoCodes
boolean
constraints
object
promoCodes
string[]

Promo code string with validation constraints.

  • Must contain only letters, digits, underscores, or hyphens
  • Maximum length of 32 characters
Maximum string length: 32
Pattern: ^[a-zA-Z0-9_\-]+$
variantSelections
object[]