Skip to main content
GET
/
api
/
v1
/
checkout-sessions
List checkout sessions
curl --request GET \
  --url https://demo.api.loopcrypto.xyz/api/v1/checkout-sessions \
  --header 'api-key: <api-key>' \
  --header 'entity-id: <api-key>'
{
  "totalResults": 100,
  "checkoutSessions": [
    {
      "id": "cs_12345",
      "active": "true",
      "elements": [
        {
          "itemId": "12334-55322-122-123314",
          "externalPriceId": "price_12345"
        }
      ],
      "externalSubscriptionId": "sub_12345",
      "externalCustomerId": "cus_12345",
      "externalInvoiceId": "in_12345",
      "referenceId": "ref_12345",
      "emailAddress": "info@loopcrypto.xyz",
      "freeTrialDays": 7,
      "couponCodeId": "12345",
      "payInvoiceImmediately": true,
      "cartEnabled": false,
      "billDate": 1746869711,
      "metadata": {},
      "expirationDate": "1746869711",
      "childTemplate": true,
      "suggestedAllowanceAmount": 1001,
      "minimumAllowanceAmount": 1001,
      "minimumBalanceAmount": 1001,
      "upgradeSubscription": true,
      "template": false,
      "successUrl": "https://www.loopcrypto.xyz/success",
      "tokens": [
        {
          "networkId": 1,
          "tokenSymbol": "USDC",
          "tokenAddress": "0x2791bca1f2de4661ed88a30c99a7a9449aa84174"
        }
      ],
      "resetBillingCycle": true
    }
  ]
}

Authorizations

​
api-key
string
header
required
​
entity-id
string
header
required

Query Parameters

​
active
boolean

Optional filter to retrieve all active/inactive checkout sessions

​
email
string

Optional filter to retrieve all checkout sessions associated to an email

​
externalCustomerId
string

Optional filter to retrieve all checkout sessions associated with an external Stripe customer ID

​
externalSubscriptionId
string

Optional filter to retrieve all checkout sessions associated with an external Stripe subscription ID

​
externalInvoiceId
string

Optional filter to retrieve all checkout sessions associated with an external Stripe invoice ID

​
externalInvoiceNumber
string

Optional filter to retrieve all checkout sessions associated with an external Stripe invoice number

​
expiresBefore
number

Optional filter to retrieve all checkout sessions that expire before a given date. Date is in epoch seconds

​
page
number

Optional pagination parameter to specify the page number of the results to return. Default is 1 which is the first page.

​
limit
number

Optional pagination parameter to specify the number of results per page. Default is 25, maximum is 100.

​
sortBy
string

Optional sorting parameter to specify the field to sort the results by. Default is "dateCreated".

​
sortDir
string

Optional sorting parameter to specify the direction to sort the results by. Valid options are "asc" and "desc". Default is "desc".

Response

Ok

​
totalResults
number
required

The total count of / matching the search criteria, regardless of page size or number.

Example:

100

​
checkoutSessions
object[]
required

The list of checkout sessions

⌘I