Skip to main content
POST
/
api
/
payments
/
stripe
/
{environment}
/
checkout-sessions
Create Stripe Checkout Session
curl --request POST \
  --url https://api.example.com/api/payments/stripe/{environment}/checkout-sessions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "mode": "subscription",
  "lineItems": [
    {
      "priceId": "price_123",
      "quantity": 1
    }
  ],
  "successUrl": "https://app.example.com/billing/success",
  "cancelUrl": "https://app.example.com/billing/cancel",
  "subject": {
    "type": "team",
    "id": "team_123"
  },
  "customerEmail": "buyer@example.com",
  "idempotencyKey": "checkout-team_123-pro"
}
'
import requests

url = "https://api.example.com/api/payments/stripe/{environment}/checkout-sessions"

payload = {
"mode": "subscription",
"lineItems": [
{
"priceId": "price_123",
"quantity": 1
}
],
"successUrl": "https://app.example.com/billing/success",
"cancelUrl": "https://app.example.com/billing/cancel",
"subject": {
"type": "team",
"id": "team_123"
},
"customerEmail": "buyer@example.com",
"idempotencyKey": "checkout-team_123-pro"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
mode: 'subscription',
lineItems: [{priceId: 'price_123', quantity: 1}],
successUrl: 'https://app.example.com/billing/success',
cancelUrl: 'https://app.example.com/billing/cancel',
subject: {type: 'team', id: 'team_123'},
customerEmail: 'buyer@example.com',
idempotencyKey: 'checkout-team_123-pro'
})
};

fetch('https://api.example.com/api/payments/stripe/{environment}/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://api.example.com/api/payments/stripe/{environment}/checkout-sessions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'mode' => 'subscription',
'lineItems' => [
[
'priceId' => 'price_123',
'quantity' => 1
]
],
'successUrl' => 'https://app.example.com/billing/success',
'cancelUrl' => 'https://app.example.com/billing/cancel',
'subject' => [
'type' => 'team',
'id' => 'team_123'
],
'customerEmail' => 'buyer@example.com',
'idempotencyKey' => 'checkout-team_123-pro'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

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

curl_close($curl);

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

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

func main() {

url := "https://api.example.com/api/payments/stripe/{environment}/checkout-sessions"

payload := strings.NewReader("{\n \"mode\": \"subscription\",\n \"lineItems\": [\n {\n \"priceId\": \"price_123\",\n \"quantity\": 1\n }\n ],\n \"successUrl\": \"https://app.example.com/billing/success\",\n \"cancelUrl\": \"https://app.example.com/billing/cancel\",\n \"subject\": {\n \"type\": \"team\",\n \"id\": \"team_123\"\n },\n \"customerEmail\": \"buyer@example.com\",\n \"idempotencyKey\": \"checkout-team_123-pro\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.example.com/api/payments/stripe/{environment}/checkout-sessions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"mode\": \"subscription\",\n \"lineItems\": [\n {\n \"priceId\": \"price_123\",\n \"quantity\": 1\n }\n ],\n \"successUrl\": \"https://app.example.com/billing/success\",\n \"cancelUrl\": \"https://app.example.com/billing/cancel\",\n \"subject\": {\n \"type\": \"team\",\n \"id\": \"team_123\"\n },\n \"customerEmail\": \"buyer@example.com\",\n \"idempotencyKey\": \"checkout-team_123-pro\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/payments/stripe/{environment}/checkout-sessions")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"mode\": \"subscription\",\n \"lineItems\": [\n {\n \"priceId\": \"price_123\",\n \"quantity\": 1\n }\n ],\n \"successUrl\": \"https://app.example.com/billing/success\",\n \"cancelUrl\": \"https://app.example.com/billing/cancel\",\n \"subject\": {\n \"type\": \"team\",\n \"id\": \"team_123\"\n },\n \"customerEmail\": \"buyer@example.com\",\n \"idempotencyKey\": \"checkout-team_123-pro\"\n}"

response = http.request(request)
puts response.read_body
{
  "checkoutSession": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "subjectType": "<string>",
    "subjectId": "<string>",
    "customerEmail": "jsmith@example.com",
    "checkoutSessionId": "cs_test_123",
    "customerId": "cus_123",
    "paymentIntentId": "pi_123",
    "subscriptionId": "sub_123",
    "url": "https://checkout.stripe.com/c/pay/cs_test_123",
    "lastError": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}
{
"error": "INVALID_INPUT",
"message": "environment: Invalid enum value",
"statusCode": 400,
"nextActions": "<string>"
}
{
"error": "INVALID_INPUT",
"message": "environment: Invalid enum value",
"statusCode": 400,
"nextActions": "<string>"
}
{
"error": "INVALID_INPUT",
"message": "environment: Invalid enum value",
"statusCode": 400,
"nextActions": "<string>"
}
{
"error": "INVALID_INPUT",
"message": "environment: Invalid enum value",
"statusCode": 400,
"nextActions": "<string>"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

environment
enum<string>
required

Payment provider environment.

Available options:
test,
live

Body

application/json

Metadata keys starting with insforge_ are reserved and rejected.

mode
enum<string>
required
Available options:
payment,
subscription
lineItems
object[]
required
Required array length: 1 - 100 elements
successUrl
string<uri>
required
cancelUrl
string<uri>
required
subject
object
customerEmail
string<email> | null
metadata
object
idempotencyKey
string
Required string length: 1 - 200

Response

Checkout Session created

checkoutSession
object
required