List Checkout Sessions

curl --request GET \
  --url https://app.flowglad.com/api/v1/checkout-sessions \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://app.flowglad.com/api/v1/checkout-sessions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.flowglad.com/api/v1/checkout-sessions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.flowglad.com/api/v1/checkout-sessions"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://app.flowglad.com/api/v1/checkout-sessions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "id": "<string>",
      "createdAt": 0,
      "updatedAt": 0,
      "livemode": true,
      "pricingModelId": "<string>",
      "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": "jsmith@example.com",
        "phone": "<string>"
      },
      "successUrl": "<string>",
      "cancelUrl": "<string>",
      "preserveBillingCycleAnchor": true,
      "outputMetadata": {},
      "targetSubscriptionId": null,
      "automaticallyUpdateSubscriptions": null
    }
  ],
  "hasMore": true,
  "total": 123,
  "currentCursor": "<string>",
  "nextCursor": "<string>"
}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "NOT_FOUND",
  "message": "Not found",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

GET

api

checkout-sessions

List Checkout Sessions

curl --request GET \
  --url https://app.flowglad.com/api/v1/checkout-sessions \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://app.flowglad.com/api/v1/checkout-sessions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.flowglad.com/api/v1/checkout-sessions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.flowglad.com/api/v1/checkout-sessions"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://app.flowglad.com/api/v1/checkout-sessions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "id": "<string>",
      "createdAt": 0,
      "updatedAt": 0,
      "livemode": true,
      "pricingModelId": "<string>",
      "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": "jsmith@example.com",
        "phone": "<string>"
      },
      "successUrl": "<string>",
      "cancelUrl": "<string>",
      "preserveBillingCycleAnchor": true,
      "outputMetadata": {},
      "targetSubscriptionId": null,
      "automaticallyUpdateSubscriptions": null
    }
  ],
  "hasMore": true,
  "total": 123,
  "currentCursor": "<string>",
  "nextCursor": "<string>"
}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "NOT_FOUND",
  "message": "Not found",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

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.

Option 1
Option 2
Option 3
Option 4

Show child attributes

hasMore

boolean

required

total

number

required

currentCursor

string

nextCursor

string

⌘I

API Documentation

Payments

Checkout Sessions

Products

Prices

Purchases

Customer

Discounts

Invoice Line Items

Invoices

Pricing Models

API Keys

Subscriptions

Payment Methods

Usage Meters

Usage Events

Webhooks

Features

Product Features

Subscription Item Features

Resources

Resource Claims

List Checkout Sessions

Authorizations

Query Parameters

Response