Billing API
Plans, your usage and spend cap, checkout and the billing portal.
6 live operations. Built from the OpenAPI contract at every release, so this page never lists an endpoint that does not work. Paths are relative to the base URL.
To try these with your own account, sign in and open Automation → Try the API in the app.
The plans, their prices in USD and their limits
Public. Free includes the REST API and API keys. `checkoutAvailable` is false until payments are open; plans and limits apply anyway.
Responses
Plans
7 fields
11 fields of data
One of: free, starter, pro, ultra, enterprise
Monthly base price in USD cents; null is a custom quote
Price of a year paid at once in USD cents; null means monthly only or custom
One-time purchases, bought with `POST /billing/purchases`. Empty when they are not on sale.
11 fields of oneTime
One of: deep-audit
Discount on every further deep audit of a site that had one.
Price of a further deep audit of the same site.
Deep audits of the site in one purchase
Days from the purchase in which the audit can be started
False until this product can be paid for.
0: no trial.
Refund on request within this many days of the first payment
3 fields of earlyAccess
`mock`: test mode, a plan is switched on without Stripe (UAT and previews only).
One of: off, mock, stripe
Try it: signed in, open this operation in the app. It runs against your own account, with no key to paste.
Your plan, this period's usage and your spend cap
Any valid API key may read it. Runs that count are the runs of the billing period that did not fail. Above the included runs, a paid plan charges per run until the monthly spend cap.
Responses
Billing state
14 fields
2 fields of plan
free, trialing, active, past_due or manual
3 fields of trial
2 fields of period
5 fields of usage
2 fields of sites
2 fields of credits
2 fields of automations
3 fields of extraSites
2 fields of overage
Bought deep audits that were not started yet (`POST /billing/purchases`).
4 fields of deepAuditPasses
Ids of the sites that had a deep audit bought; the next one costs less there.
The one-time deep audit can be bought now.
11 fields of limits
Audit credits included per billing period. A run costs the credits of its checks (full passive audit 48, full deep 75).
USD cents per 1
Deep audits on a verified site within the plan's credits. False on every plan while the one-time audits are on sale (now): `level: deep` answers 403 `plan_limit` unless a deep audit was bought for the site (`POST /billing/purchases`).
Saved scopes of the account's own
Fair-use cap on automations
API keys may write. Free: read-only; a write with a key answers `403 plan_limit`.
Price of one extra site a month in USD cents; null means none can be bought
One of: off, mock, stripe
RFC 9457 problem
Try it: signed in, open this operation in the app. It runs against your own account, with no key to paste.
Set the monthly spend cap (signed-in session only)
`spendCapCents` is the most usage above the included runs that one period may cost, 0 to 100000 (USD cents). 0 means no runs above the included ones. API keys get `403 session_required`.
Request body
Min 0 · Max 100000
Sites bought on top of a paid plan's, billed per site and month. `403 plan_limit` on Free, `409 sites_in_use` below the sites in use.
Min 0 · Max 200
{}Responses
Billing state
14 fields
2 fields of plan
free, trialing, active, past_due or manual
3 fields of trial
2 fields of period
5 fields of usage
2 fields of sites
2 fields of credits
2 fields of automations
3 fields of extraSites
2 fields of overage
Bought deep audits that were not started yet (`POST /billing/purchases`).
4 fields of deepAuditPasses
Ids of the sites that had a deep audit bought; the next one costs less there.
The one-time deep audit can be bought now.
11 fields of limits
Audit credits included per billing period. A run costs the credits of its checks (full passive audit 48, full deep 75).
USD cents per 1
Deep audits on a verified site within the plan's credits. False on every plan while the one-time audits are on sale (now): `level: deep` answers 403 `plan_limit` unless a deep audit was bought for the site (`POST /billing/purchases`).
Saved scopes of the account's own
Fair-use cap on automations
API keys may write. Free: read-only; a write with a key answers `403 plan_limit`.
Price of one extra site a month in USD cents; null means none can be bought
One of: off, mock, stripe
RFC 9457 problem
Try it: signed in, open this operation in the app. It runs against your own account, with no key to paste.
Start a checkout for Starter, Pro or Ultra (session only)
Answers a URL to send the person to (a Stripe-hosted page once payments are open). `interval` is `month` (default) or `year`; a year costs ten months. There is no trial: the first payment can be refunded on request within 14 days, bought credits excluded. An account that already has a plan gets `409 already_subscribed` and uses the portal. `503 billing_unavailable` until payments are open.
Request body
One of: starter, pro, ultra
One of: month, year · Default: month
{
"plan": "starter"
}Responses
Checkout page
1 field
RFC 9457 problem
Try it: signed in, open this operation in the app. It runs against your own account, with no key to paste.
Buy the one-time deep audit for a site (session only)
A plan is the monthly monitoring; a deep audit is bought separately, per site, on any plan. `deep-audit` buys one deep audit of one verified site, to be started within 30 days. It does not use the monthly credits; a run that fails goes back to the purchase. A re-audit after the fixes is recommended: every further deep audit of the same site costs 30% less (`GET /plans`, `oneTime`; the sites it applies to are `deepAuditFollowUpSites` in `GET /billing`). Answers a URL to send the person to (a Stripe-hosted page once payments are open). The site must be verified first (`403 verification_required`). `409 pass_active` while the site has a bought audit that was not started yet; `503 billing_unavailable` until payments are open. What an account holds is in `GET /billing` (`deepAuditPasses`).
Request body
One of: deep-audit
{
"product": "deep-audit",
"siteId": "string"
}Responses
Checkout page
1 field
RFC 9457 problem
Try it: signed in, open this operation in the app. It runs against your own account, with no key to paste.
Open the Stripe customer portal (session only)
Card, invoices, plan change and cancellation, on Stripe's page. `409 no_billing_account` before a first checkout.
Responses
Portal page
1 field
RFC 9457 problem
Try it: signed in, open this operation in the app. It runs against your own account, with no key to paste.