Skip to main content
GET
/
api
/
v1
/
checkout-sessions
List Checkout Sessions
curl --request GET \
  --url https://app.flowglad.com/api/v1/checkout-sessions \
  --header 'Authorization: <api-key>'
{
  "data": [
    {
      "id": "<string>",
      "createdAt": 0,
      "updatedAt": 0,
      "livemode": true,
      "status": "open",
      "priceId": "<string>",
      "purchaseId": "<string>",
      "invoiceId": "<string>",
      "quantity": -1,
      "organizationId": "<string>",
      "customerName": "<string>",
      "customerEmail": "<string>",
      "customerId": "<string>",
      "discountId": "<string>",
      "type": "<string>",
      "outputName": "<string>",
      "expires": 0,
      "billingAddress": {
        "address": {
          "country": "<string>",
          "name": "<string>",
          "line1": "<string>",
          "line2": "<string>",
          "city": "<string>",
          "state": "<string>",
          "postal_code": "<string>"
        },
        "name": "<string>",
        "firstName": "<string>",
        "lastName": "<string>",
        "email": "[email protected]",
        "phone": "<string>"
      },
      "paymentMethodType": "card",
      "successUrl": "<string>",
      "cancelUrl": "<string>",
      "preserveBillingCycleAnchor": true,
      "outputMetadata": {},
      "targetSubscriptionId": "<unknown>",
      "automaticallyUpdateSubscriptions": "<unknown>"
    }
  ],
  "hasMore": true,
  "total": 123,
  "currentCursor": "<string>",
  "nextCursor": "<string>"
}

Authorizations

Authorization
string
header
required

Query Parameters

cursor
string
limit
string

Response

Successful response

data
object[]
required

A time-limited checkout session, which captures the payment details needed to create a subscription, or purchase, or pay a standalone invoice.

hasMore
boolean
required
total
number
required
currentCursor
string
nextCursor
string