TThrottle Developers
Sign inGet API key
Curated reference

API Surface by Integration Task

Start here for the endpoints most native checkout integrations need. Use the full OpenAPI reference when you need every schema and response field.

Open full Swagger docsDownload OpenAPI JSON

Auth and API Keys

Create and manage server-side keys for merchant integrations.

GET/api/v1/api-keys

List active API keys for the current merchant.

Clerk JWT or API key
POST/api/v1/api-keys

Create a new secret API key. The raw key is returned once.

Clerk JWT
DELETE/api/v1/api-keys/{id}

Revoke an API key.

Clerk JWT

Checkout Sessions

Mint sessions for hosted checkout and iframe embeds.

POST/api/v1/checkout-sessions/embed-token

Create a payment-ready checkout session and return hosted/embed URLs.

X-API-KeyGuide
POST/api/v1/checkout-sessions/{id}/complete

Complete a buyer-facing checkout session from the hosted checkout surface.

Session-scoped public routeGuide

Carts and Items

Build a native Throttle cart before checkout.

POST/api/v1/carts

Create a native cart for a store.

X-API-KeyGuide
GET/api/v1/carts/{id}

Fetch a cart snapshot.

X-API-Key
POST/api/v1/carts/{id}/items

Add a line item.

X-API-Key
PATCH/api/v1/carts/{cartId}/items/{id}

Update quantity, price, or metadata for a line item.

X-API-Key
DELETE/api/v1/carts/{cartId}/items/{id}

Remove a line item.

X-API-Key
POST/api/v1/carts/{id}/checkout

Convert a cart into an order and begin payment.

X-API-Key

Shipping and Tax

Configure calculation rules and quote totals for native carts.

GET/api/v1/shipping-tax/config?storeId={id}

Read draft and published shipping/tax config.

X-API-KeyGuide
POST/api/v1/shipping-tax/quote-tokens

Create a publishable quote token for storefront estimates.

X-API-Key
POST/api/v1/shipping-tax/quotes

Request a storefront shipping/tax estimate.

Publishable quote token
POST/api/v1/shipping-tax/carts/{cartId}/calculate

Calculate and optionally persist totals for a native cart.

X-API-Key

Orders and Payments

Read orders, inspect payments, and issue refunds.

GET/api/v1/orders

List orders for a merchant.

X-API-Key
GET/api/v1/orders/{id}

Fetch an order and its state.

X-API-Key
GET/api/v1/orders/{id}/payments

List payments attached to an order.

X-API-Key
POST/api/v1/payments/{id}/refund

Refund a captured payment.

X-API-Key

Webhooks

Subscribe HTTPS endpoints and inspect delivery attempts.

POST/api/v1/webhook-endpoints

Create a signed outbound webhook endpoint.

X-API-KeyGuide
GET/api/v1/webhook-endpoints

List active webhook endpoints.

X-API-Key
PATCH/api/v1/webhook-endpoints/{id}

Update endpoint URL, enabled events, or active state.

X-API-Key
GET/api/v1/webhook-deliveries

Read recent delivery attempts for debugging.

X-API-Key

Embed Config

Allow storefront origins and brand hosted checkout.

GET/api/v1/embed-config

Read allowed origins and checkout branding.

X-API-KeyGuide
PUT/api/v1/embed-config

Set allowed origins, primary color, logo URL, and merchant name.

X-API-Key