Skip to main content

CreateCheckoutSessionRequest

amountintegerrequired

Possible values: >= 1

currencyCurrencyCode (string)required

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

Examples:
Example: USD
merchantIdstring<uuid>required
successUrlstring<uri>required
cancelUrlstring<uri>required
lineItems object[]

Possible values: >= 1

  • Array [
    • namestringrequired

    Possible values: non-empty and <= 200 characters

    quantityintegerrequired

    Possible values: >= 1

    unitAmountintegerrequired

    Possible values: >= 1

    totalAmountintegerrequired

    Possible values: >= 1

  • ]
    • customerEmailstring<email>
    metadata object
    property name*string
    CreateCheckoutSessionRequest
    {
      "amount": 0,
      "currency": "USD",
      "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "successUrl": "string",
      "cancelUrl": "string",
      "lineItems": [
        {
          "name": "string",
          "quantity": 0,
          "unitAmount": 0,
          "totalAmount": 0
        }
      ],
      "customerEmail": "[email protected]",
      "metadata": {}
    }