POST
/
api
/
v1
/
checkout-sessions
curl --request POST \
  --url https://app.flowglad.com/api/v1/checkout-sessions \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "customerExternalId": "<string>",
  "priceId": "<string>",
  "successUrl": "<string>",
  "cancelUrl": "<string>",
  "outputMetadata": {},
  "outputName": "<string>",
  "quantity": 123
}'
{
  "checkoutSession": {
    "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>"
  },
  "url": "<string>"
}

Authorizations

​
Authorization
string
header
required

Body

application/json
​
customerExternalId
string
required

The id of the Customer for this purchase session, as defined in your system

​
priceId
string
required

The ID of the price the customer shall purchase

​
successUrl
string
required

The URL to redirect to after the purchase is successful

​
cancelUrl
string
required

The URL to redirect to after the purchase is cancelled or fails

​
outputMetadata
object

Metadata that will get added to the purchase or subscription created when this checkout session succeeds. Ignored if the checkout session is of type invoice.

​
outputName
string

The name of the purchase or subscription created when this checkout session succeeds. Ignored if the checkout session is of type invoice.

​
quantity
number

The quantity of the purchase or subscription created when this checkout session succeeds. Ignored if the checkout session is of type invoice.

Response

200
application/json
Successful response
​
checkoutSession
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.

​
url
string
required

The URL to redirect to complete the purchase