Turnstile

Turnstile's API enables you to integrate billing and usage data with your existing systems to automate your Quote-to-Cash workflow. Use the API to ingest usage events for <a href="http://help.turnstile.ai/en/articles/11880004-recording-usage-in-turnstile">consumption-based pricing</a> and receive webhooks for key lifecycle events like quote acceptance and invoice generation. This guide covers authentication, available endpoints, and payload formats.

All production API endpoints live at <a href="https://api.tryturnstile.com/endpoint" rel="nofollow noopener noreferrer" target="_blank"><code>https://api.tryturnstile.com/endpoint</code></a>

We also have test endpoints at <a href="https://api.tryturnstile.com/test/endpoint" rel="nofollow noopener noreferrer" target="_blank"><code>https://api.tryturnstile.com/test/endpoint</code></a> that merely validate request shape (fields and types).

- Test endpoints accept any random value as the bearer token.

- All production API endpoints live at <a href="https://api.tryturnstile.com/endpoint" rel="nofollow noopener noreferrer" target="_blank"><code>https://api.tryturnstile.com/endpoint</code></a>
- We also have test endpoints at <a href="https://api.tryturnstile.com/test/endpoint" rel="nofollow noopener noreferrer" target="_blank"><code>https://api.tryturnstile.com/test/endpoint</code></a> that merely validate request shape (fields and types). 
 - Test endpoints accept any random value as the bearer token.

All production API endpoints are authenticated using Bearer tokens. Please contact support for your API token.

"security": [ { "bearerAuth": [] } ]

Accepts: <code>POST</code> requests with <code>application/json</code> encoding

- Endpoint: <code>/usage/ingest</code> 
- Accepts: <code>POST</code> requests with <code>application/json</code> encoding

All of the following fields are required.

- <code>turnstile_customer_id</code> (string): The Turnstile customer ID associated with the customer.
- <code>stripe_customer_id</code> (string): The Stripe customer ID associated with the customer. May be accepted in certain cases. If both <code>turnstile_customer_id</code> and <code>stripe_customer_id</code> are provided, <code>stripe_customer_id</code> will be used.

<code>timestamp</code> (string): The timestamp when the event happened. This must be in RFC3339 format (UTC), such as <code>2024-05-29T01:23:45Z</code>.

<code>quantity</code> (integer): Number of events. Negatives supported.

<code>event_type</code> (string): The kind of event, used to associate the event with a <a href="http://help.turnstile.ai/en/articles/11942940-create-products-and-billable-metrics-in-the-catalog">billable metric in your Turnstile catalog</a>. Examples: <code>test_run</code>, <code>page_processed</code>.

- <code>customer_alias</code>
 - <code>turnstile_customer_id</code> (string): The Turnstile customer ID associated with the customer.
 - <code>stripe_customer_id</code> (string): The Stripe customer ID associated with the customer. May be accepted in certain cases. If both <code>turnstile_customer_id</code> and <code>stripe_customer_id</code> are provided, <code>stripe_customer_id</code> will be used.
- <code>timestamp</code> (string): The timestamp when the event happened. This must be in RFC3339 format (UTC), such as <code>2024-05-29T01:23:45Z</code>.
- <code>quantity</code> (integer): Number of events. Negatives supported.
- <code>event_type</code> (string): The kind of event, used to associate the event with a <a href="http://help.turnstile.ai/en/articles/11942940-create-products-and-billable-metrics-in-the-catalog">billable metric in your Turnstile catalog</a>. Examples: <code>test_run</code>, <code>page_processed</code>.

Turnstile can send you webhooks when certain events occur within the system. Please contact support for further details on getting access to this feature.

We support several quote and invoice lifecycle events. The most popular are shown below.

Occurs when a quote is accepted or signed and becomes a subscription.

{ "changeCause": "PHASE_ACTIVE", "crmCustomerId": "18688415805", "effectiveEnd": "2025-02-20T22:07:07.427Z", "effectiveStart": "2025-02-20T22:07:07.427Z", "newEntitlements": [ { "productName": "API Calls Processed", "productUnitName": "api_calls", "quantity": 100 } ], "orderFlowType": "TURNSTILE_SIGN", "publicAccountViewUrl": "https://app.tryturnstile.com/p/abc/def", "quoteId": "b24fd8f6-4b90-48c1-b5b8-507dce6c3d6d", "subscriptionUrl": "uri", "tcv": "$3.14", "turnstileCustomerId": "ef0a2a9e-1b30-4fe7-b985-5389721580dd", "turnstileCustomerName": "Pepsi Co", "turnstileSubscriptionId": "bb03c399-b627-47cb-83ff-3681bea36819", "type": "QUOTE" }

API Reference

Return To Turnstile App

Find answers and get help from Intercom Support and Community Experts

Conversations you've started through the messenger will appear here.

No conversations created by you

Try using different keywords or checking for typos.

No conversations found

Title

This site employs cookies and other technologies that we and our third party vendors use to monitor and record personal information about you and your interactions with the site (including content viewed, cursor movements, screen recordings, and chat contents) for the purposes described in our Cookie Policy. By continuing to visit our site, you agree to our {websiteTermsLink}, {privacyPolicyLink} and {cookiePolicyLink}.

This site uses cookies and similar technologies ("cookies") as strictly necessary for site operation. We and our partners also would like to set additional cookies to enable site performance analytics, functionality, advertising and social media features. See our {cookiePolicyLink} for details. You can change your cookie preferences in our Cookie Settings.

We use cookies to make our site work and also for analytics and advertising purposes. You can enable or disable optional cookies as desired. See our {cookiePolicyLink} for more details.

Advertising cookies are set by our advertising partners to collect information about your use of the site, our communications, and other online services over time and with different browsers and devices. They use this information to show you ads online that they think will interest you and measure the ads' performance. Social media cookies are set by social media platforms to enable you to share content on those platforms, and are capable of tracking information about your activity across other online services for use as described in their privacy policies.

These cookies enable the website to provide enhanced functionality and personalisation. They may be set by us or by third party providers whose services we have added to our pages. If you do not allow these cookies then some or all of these services may not function properly.

These cookies are necessary for the website to function and cannot be switched off in our systems.

These cookies allow us to count visits and traffic sources so we can measure and improve the performance of our site. They help us to know which pages are the most and least popular and see how visitors move around the site.

You have the right to opt out of the sale of your personal information. See our {cookiePolicyLink} for more details about how we use your data.

Your Privacy Choices

We use cookies to enhance your experience. You can customize your cookie preferences below. See our {cookiePolicyLink} for more details.

Cookie Settings

Empty Help Center

Uh oh. That page doesn’t exist.

Home

Search results

Disappointed

Neutral

Smiley

Thinking...

Searching through sources...

Analyzing...

Tickets submitted through the messenger or by a support agent in your conversation will appear here.

API Reference

Production vs Test Endpoints

Authentication

Usage Ingestion

Payload Body

Provisioning (beta)

v1.quote.finalized