Sign in

v1

latestOpenAPI 3.0.32026-07-26172157253.6 KB
Stripe Payments

Create Stripe Checkout Session

Create a local checkout attempt with the caller's user context and then create a Stripe Checkout Session. Subscription mode requires a billing subject.

post/api/payments/stripe/{environment}/checkout-sessions

Path parameters

environment'test' | 'live' required

Payment provider environment.

Request body

mode'payment' | 'subscription' required
successUrlstring uri required
cancelUrlstring uri required
customerEmailstring email nullable
metadataMetadata
idempotencyKeystring

Example request

{
  "lineItems": [
    {
      "priceId": "price_123"
    }
  ],
  "subject": {
    "type": "team",
    "id": "team_123"
  }
}

Response

Checkout Session created

Example response

{
  "checkoutSession": {
    "checkoutSessionId": "cs_test_123",
    "customerId": "cus_123",
    "paymentIntentId": "pi_123",
    "subscriptionId": "sub_123",
    "url": "https://checkout.stripe.com/c/pay/cs_test_123"
  }
}