v1

latestOpenAPI 3.0.02026-07-1498163181.9 KB

Checkout Sessions

List of checkout sessions

Returns ths list of checkout sessions

get/api/v1/checkout/sessions

Query parameters

pagenumber

Page number. Starts from 1

limitnumber

Number of items per page

isnullboolean

Returns null values

notnullboolean

Returns not null values

gtstring date-time

Returns values greater than the given date

gtestring date-time

Returns values greater than or equal to the given date

ltstring date-time

Returns values less than the given date

ltestring date-time

Returns values less than or equal to the given date

Filter by created date

idsstring

Filter by id. Returns items with given ids

paymentLinkIdstring

To filter checkout sessions by payment link id

subscriptionIdstring

To filter checkout sessions by subscription id

invoiceIdstring

To filter checkout sessions by invoice ids

mode'payment' | 'subscription'

To filter checkout sessions by mode

paymentMethodTypesPaymentMethodType[]

To filter checkout sessions by payment method type

statusstring

To filter checkout sessions by status

paymentStatus'unpaid' | 'paid'

To filter checkout sessions by payment status

customerIdstring

To filter checkout sessions by customer id

couponIdstring

To filter checkout sessions by applied coupon id

Response

pagenumber required

Page number. Starts from 1

limitnumber required

Number of items per page

countnumber required

hasMoreboolean required

Example response

{
  "page": 1,
  "limit": 10,
  "count": 1,
  "query": {
    "page": 1,
    "limit": 10
  },
  "data": [
    {
      "paymentLinkId": "c3611c05-df51-4b47-b601-f2eac02f4ef0",
      "subscriptionId": "c3611c05-df51-4b47-b601-f2eac02f4ef0",
      "invoiceId": "c3611c05-df51-4b47-b601-f2eac02f4ef0",
      "amountTotal": 100000000,
      "amountSubtotal": 100000000,
      "amountDetails": {
        "feePercentage": 1
      },
      "paymentSetting": {
        "allowedChains": [
          {
            "chainId": 137
          }
        ],
        "preferredChainId": 1
      },
      "customerDetails": {
        "taxIds": {
          "data": [
            {
              "customerId": "c3611c05-df51-4b47-b601-f2eac02f4ef0"
            }
          ]
        }
      },
      "customFields": {
        "fields": [
          {
            "text": {
              "maximumLength": 1,
              "minimumLength": 1
            },
            "numeric": {
              "maximumLength": 1,
              "minimumLength": 1
            }
          }
        ]
      },
      "lineItems": {
        "data": [
          {
            "quantity": 1,
            "price": {
              "productId": "c3611c05-df51-4b47-b601-f2eac02f4ef0",
              "intervalCount": 1,
              "product": {
                "defaultPriceId": "c3611c05-df51-4b47-b601-f2eac02f4ef0"
              }
            },
            "taxRates": [
              {
                "percentage": 1
              }
            ]
          }
        ]
      },
      "paymentIntent": {
        "organizationId": "c3611c05-df51-4b47-b601-f2eac02f4ef0",
        "paymentMethodId": "c3611c05-df51-4b47-b601-f2eac02f4ef0",
        "paymentMethod": {
          "assetId": "c3611c05-df51-4b47-b601-f2eac02f4ef0",
          "asset": {
            "chainId": 1,
            "decimals": 1,
            "superToken": {
              "decimals": 1
            }
          },
          "customerId": "c3611c05-df51-4b47-b601-f2eac02f4ef0"
        },
        "paymentReceipt": {
          "organizationId": "c3611c05-df51-4b47-b601-f2eac02f4ef0",
          "paymentIntentId": "c3611c05-df51-4b47-b601-f2eac02f4ef0"
        }
      }
    }
  ]
}