GET
/
api
/
v1
/
checkout-sessions
curl --request GET \
  --url https://app.flowglad.com/api/v1/checkout-sessions \
  --header 'Authorization: <api-key>'
{
  "data": [
    {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "livemode": true,
      "billingAddress": {
        "name": "<string>",
        "firstName": "<string>",
        "lastName": "<string>",
        "address": {
          "line1": "<string>",
          "line2": "<string>",
          "city": "<string>",
          "state": "<string>",
          "postal_code": "<string>",
          "country": "<string>"
        },
        "phone": "<string>"
      },
      "priceId": "<string>",
      "purchaseId": "<string>",
      "invoiceId": "<string>",
      "quantity": 123,
      "organizationId": "<string>",
      "customerName": "<string>",
      "customerEmail": "<string>",
      "customerId": "<string>",
      "paymentMethodType": "card",
      "discountId": "<string>",
      "successUrl": "<string>",
      "cancelUrl": "<string>",
      "type": "purchase",
      "outputMetadata": {},
      "outputName": "<string>"
    }
  ],
  "currentCursor": "<string>",
  "nextCursor": "<string>",
  "hasMore": true,
  "total": 123
}

Authorizations

​
Authorization
string
header
required

Query Parameters

​
cursor
string
​
limit
number
Required range: 1 <= x <= 100

Response

200
application/json
Successful response
​
data
object[]
required

A checkout session record, which describes a checkout process that can be used to complete purchases, invoices, or product orders. Each session has a specific type that determines its behavior and required fields.

​
hasMore
boolean
required
​
total
number
required
​
currentCursor
string
​
nextCursor
string