API documentation

Getting started

Setup

Generate a code, choose the correct host and confirm the integration with a first read request.

Connect and make the first request
Setup requires an active code, the application's public URL and a Stripe Customer ID from the same account.
1

Generate and store the code

Sign in to the web app through the Stripe plugin and open Workspace → API → Setup. Generate the code in that authenticated area and store it directly in a secret manager.

2

Set the base URL

The base URL is https://stripe-ix.betacode.tech/api/v1. Every path in this reference is relative to this URL and must be called over HTTPS.

https://stripe-ix.betacode.tech/api/v1
3

Send the Bearer token

Send the code in the Authorization header on every request. The Bearer scheme, separating space and code are required. Never put the code in the query string or request body.

curl "https://stripe-ix.betacode.tech/api/v1/client/cus_Q1w2E3r4" \
  -H "Authorization: Bearer ixp_test_YOUR_ACCESS_CODE" \
  -H "Accept: application/json"
Test and live modes

ixp_test_ codes only access test data; ixp_live_ codes only access live data. Regenerating or revoking a code immediately invalidates the previous one.

Mode is part of the code scope. Test data and codes can never access live resources, and the reverse also applies.

Security and operations

Store the code in a secret manager, never include it in source code, URLs or logs, and always use HTTPS. Rotate it if exposure is suspected. Stable integrations should handle 429 and 5xx failures with limited retries and exponential backoff.

Regeneration replaces the current code without an overlap period. Update the integration immediately and revoke access that is no longer needed.

Read about errors and retry policy