Documentation

Docs

Look up how one thing works. Each page covers a single feature — what it does, how it behaves at the edges, and where it hands off to something else.

Want to be walked through a job end to end instead? Start with Guides. Integrating the API? Developer docs. Building an app for the marketplace? Extensions.

Getting started

What Throttle is, the objects it stores, and how a workspace is laid out.

  • What Throttle stores The objects Throttle owns, the one thing it deliberately does not store, and how workspace, application, and environment scope everything else.

Selling

Carts, checkout, discounts, quotes, and subscriptions.

  • Discounts Percentage and fixed-amount promotion codes: the limits you can put on them, the nine reasons a code gets rejected, and how product scoping matches.
  • Subscriptions How a one-time checkout becomes recurring billing, what the renewal cron and dunning actually do, and the one gap to plan around before launching.

Orders & money

Capturing, refunding, returning, and getting paid.

  • Refunds and returns Four ways to give a buyer their money back — refund, cancel, return, or exchange — and which one fits the situation you are actually in.
  • Invoice terms (Net-N) How Throttle decides an invoice's due date, the four places that value can come from, and why a term is frozen onto the invoice at issue.

Configuration

Payment connectors, shipping and tax, email, and webhooks.

  • Payment connectors Connecting a processor per environment, why sandbox and production are separate connections, and what happens to live payments if billing lapses.
  • Shipping and tax The draft-and-publish model behind rates and tax rules, why exactly one config is live at a time, and how it differs from a connected provider.

Access & environments

Teams, roles, API keys, and the production/sandbox split.

  • API keys and environments Reading a Throttle key at a glance, why a publishable key can only do two things, and how keys bind to one workspace environment for life.
  • Team and roles The two-tier access model — workspace roles and per-application roles — and why granting workspace admin is almost always more than someone needs.
  • Going live What switching from a sandbox environment to production invalidates, in what order to change it, and the checks that gate the switch.