CheckoutSessionResponse

successbooleanrequired

data object

Response payload for successful operations.

idstring<uuid>required

merchantIdstring<uuid>required

amountintegerrequired

Possible values: >= 1

currencyCurrencyCode (string)required

Possible values: Value must match regular expression ^[A-Z]{3}$

Examples:

Example 1

Example: USD

Example 2

Example: EUR

Example 3

Example: GBP

statusCheckoutSessionStatus (string)required

Possible values: [PENDING, COMPLETED, CANCELLED, EXPIRED]

successUrlstring<uri>required

cancelUrlstring<uri>required

paymentUrlstring<uri>required

lineItems object[]required

Array [

namestringrequired

Possible values: non-empty and <= 200 characters

quantityintegerrequired

Possible values: >= 1

unitAmountintegerrequired

Possible values: >= 1

totalAmountintegerrequired

Possible values: >= 1

]

customerEmailstring<email>nullable

expiresAtstring<date-time>required

createdAtstring<date-time>required

errorstring

Machine-readable error code.

messagestring

Human-readable response message.

CheckoutSessionResponse

{
  "success": true,
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "amount": 0,
    "currency": "USD",
    "status": "PENDING",
    "successUrl": "string",
    "cancelUrl": "string",
    "paymentUrl": "string",
    "lineItems": [
      {
        "name": "string",
        "quantity": 0,
        "unitAmount": 0,
        "totalAmount": 0
      }
    ],
    "customerEmail": "[email protected]",
    "expiresAt": "2024-07-29T15:51:28.071Z",
    "createdAt": "2024-07-29T15:51:28.071Z"
  },
  "error": "string",
  "message": "string"
}