Skip to main content
GET
/
v1
/
checkouts
Retrieve a checkout session.
curl --request GET \
  --url https://api.creem.io/v1/checkouts \
  --header 'x-api-key: <api-key>'
{
  "id": "<string>",
  "object": "<string>",
  "status": "completed",
  "product": "<string>",
  "request_id": "<string>",
  "units": 1,
  "custom_price": 1500,
  "order": {
    "id": "<string>",
    "object": "<string>",
    "product": "<string>",
    "amount": 2000,
    "currency": "USD",
    "status": "pending",
    "type": "recurring",
    "created_at": "2023-09-13T00:00:00Z",
    "updated_at": "2023-09-13T00:00:00Z",
    "customer": "<string>",
    "transaction": "tx_1234567890",
    "discount": "dis_1234567890",
    "sub_total": 1800,
    "tax_amount": 200,
    "discount_amount": 100,
    "amount_due": 1900,
    "amount_paid": 1900,
    "fx_amount": 15,
    "fx_currency": "EUR",
    "fx_rate": 1.2,
    "affiliate": "<string>"
  },
  "subscription": "<string>",
  "customer": "<string>",
  "custom_fields": [
    {
      "key": "<string>",
      "label": "<string>",
      "optional": true,
      "text": {
        "max_length": 123,
        "minimum_length": 123,
        "value": "<string>"
      },
      "checkbox": {
        "label": "<string>",
        "value": true
      }
    }
  ],
  "checkout_url": "<string>",
  "success_url": "https://example.com/return",
  "license_keys": [
    {
      "id": "<string>",
      "object": "<string>",
      "product_id": "prod_abc123",
      "status": "active",
      "key": "ABC123-XYZ456-XYZ456-XYZ456",
      "activation": 5,
      "created_at": "2023-09-13T00:00:00Z",
      "activation_limit": 1,
      "expires_at": "2023-09-13T00:00:00Z",
      "instance": {
        "id": "<string>",
        "object": "license-instance",
        "name": "My Customer License Instance",
        "status": "active",
        "created_at": "2023-09-13T00:00:00Z"
      }
    }
  ],
  "feature": [
    {
      "id": "feat_abc123",
      "description": "Get access to the full course materials.",
      "type": "licenseKey",
      "private_note": "Thank you for your purchase! Here is your access code: XYZ123",
      "file": {
        "files": [
          {
            "id": "file_abc123",
            "file_name": "ebook.pdf",
            "url": "https://storage.creem.io/files/ebook.pdf",
            "type": "application/pdf",
            "size": 1024000
          }
        ]
      },
      "license_key": {
        "id": "<string>",
        "object": "<string>",
        "product_id": "prod_abc123",
        "status": "active",
        "key": "ABC123-XYZ456-XYZ456-XYZ456",
        "activation": 5,
        "created_at": "2023-09-13T00:00:00Z",
        "activation_limit": 1,
        "expires_at": "2023-09-13T00:00:00Z",
        "instance": {
          "id": "<string>",
          "object": "license-instance",
          "name": "My Customer License Instance",
          "status": "active",
          "created_at": "2023-09-13T00:00:00Z"
        }
      },
      "customer_credits": {
        "amount": "100",
        "unit_label": "tokens"
      },
      "license": {
        "id": "<string>",
        "object": "<string>",
        "product_id": "prod_abc123",
        "status": "active",
        "key": "ABC123-XYZ456-XYZ456-XYZ456",
        "activation": 5,
        "created_at": "2023-09-13T00:00:00Z",
        "activation_limit": 1,
        "expires_at": "2023-09-13T00:00:00Z",
        "instance": {
          "id": "<string>",
          "object": "license-instance",
          "name": "My Customer License Instance",
          "status": "active",
          "created_at": "2023-09-13T00:00:00Z"
        }
      }
    }
  ],
  "metadata": {
    "userId": "user_123",
    "visitCount": 42,
    "lastVisit": "2023-04-01"
  },
  "discount": {
    "id": "dis_3e6Z6TzvHKdsjEgXnGDEp0",
    "discountCode": "HOLIDAY2024",
    "name": "<string>",
    "amount": 123,
    "durationInMonths": 123
  }
}

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:
{
  "userId": "user_123",
  "visitCount": 42,
  "lastVisit": "2023-04-01"
}
ā€‹
discount
object

The discount applied to the checkout, if any.