Skip to main content

CreateCheckoutSessionRequest

amountinteger

Possible values: >= 1

currencyCurrencyCode (string)required

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

Examples:
Example: USD
merchantIdstring
locationIdstring
descriptionstringnullable
successUrlstring<uri>required
cancelUrlstring<uri>required
webhookUrlstring<uri>nullable
lineItems object[]
  • Array [
    • namestring
    descriptionstringnullable
    quantityinteger

    Possible values: >= 1

    unitPriceinteger

    Possible values: >= 0

    priceIdstringnullable
  • ]
    • customerEmailstring<email>nullable
    metadata objectnullable
    property name*anynullable
    expiresInintegernullable

    Possible values: >= 60

    allowedPaymentMethodsstring[]nullable
    captureMethodstringnullable
    saveCardbooleannullable
    createSubscription object
    planNamestringrequired
    intervalstringrequired
    intervalCountintegernullable
    startDatestringrequired
    endDatestringnullable
    maxCyclesintegernullable
    webhookUrlstringnullable
    metadata objectnullable
    property name*anynullable
    shippingAddressCollection object
    enabledboolean
    allowedCountriesstring[]
    shippingOptions object[]
  • Array [
    • idstringrequired
    namestringrequired
    amountintegerrequired

    Possible values: >= 0

    estimatedDaysMinintegernullable
    estimatedDaysMaxintegernullable
  • ]
    • promotionCodestringnullable
    promotionCodesstring[]nullable
    CreateCheckoutSessionRequest
    {
      "amount": 0,
      "currency": "USD",
      "merchantId": "string",
      "locationId": "string",
      "description": "string",
      "successUrl": "string",
      "cancelUrl": "string",
      "webhookUrl": "string",
      "lineItems": [
        {
          "name": "string",
          "description": "string",
          "quantity": 0,
          "unitPrice": 0,
          "priceId": "string"
        }
      ],
      "customerEmail": "user@example.com",
      "metadata": {},
      "expiresIn": 0,
      "allowedPaymentMethods": [
        "string"
      ],
      "captureMethod": "string",
      "saveCard": true,
      "createSubscription": {
        "planName": "string",
        "interval": "string",
        "intervalCount": 0,
        "startDate": "string",
        "endDate": "string",
        "maxCycles": 0,
        "webhookUrl": "string",
        "metadata": {}
      },
      "shippingAddressCollection": {
        "enabled": true,
        "allowedCountries": [
          "string"
        ]
      },
      "shippingOptions": [
        {
          "id": "string",
          "name": "string",
          "amount": 0,
          "estimatedDaysMin": 0,
          "estimatedDaysMax": 0
        }
      ],
      "promotionCode": "string",
      "promotionCodes": [
        "string"
      ]
    }