Skip to main content
GET
Retrieve a checkout session.

Authorizations

x-api-key
string
header
required

API key for authentication. You can find your API key in the Creem dashboard under Settings > API Keys.

Query Parameters

checkout_id
string
required

The ID of the checkout session to retrieve.

Example:

"chk_1234567890"

Response

Successfully retrieved the checkout session

id
string
required

Unique identifier for the object.

mode
enum<string>
required

String representing the environment.

Available options:
test,
prod,
sandbox
object
string
required

String representing the object's type. Objects of the same type share the same value.

status
enum<string>
required

Status of the checkout.

Available options:
pending,
processing,
completed,
expired
Example:

"completed"

product
required

The product associated with the checkout session.

request_id
string

Identify and track each checkout request.

units
number
default:1

The number of units for the of the product.

custom_price
integer

The per-unit price override (in cents, product currency) this checkout was created with. Only present when the checkout was created with a custom_price. One-time payment products only.

Example:

1500

order
object

The order associated with the checkout session.

subscription

The subscription associated with the checkout session.

customer

The customer associated with the checkout session.

custom_fields
object[]

Additional information collected from your customer during the checkout process.

checkout_url
string

The URL to which the customer will be redirected to complete the payment.

success_url
string | null

The URL to which the user will be redirected after the checkout process is completed.

Example:

"https://example.com/return"

license_keys
object[]

License keys issued for the order.

feature
object[]
deprecated

DEPRECATED: Use license_keys instead. Features issued for the order.

metadata
object

Metadata for the checkout in the form of key-value pairs

Example:
discount
object

The discount applied to the checkout, if any.