Type at least two letters.

    ↑ ↓ to moveEnter to open

    Billing API

    Plans, your usage and spend cap, checkout and the billing portal.

    Updated

    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

    GET/api/v1/plans
    PublicoperationId: listPlans

    Public. Free includes the REST API and API keys. `checkoutAvailable` is false until payments are open; plans and limits apply anyway.

    Responses

    200PlanList

    Plans

    7 fields
    dataarray of Plan
    11 fields of data
    idstring

    One of: free, starter, pro, ultra, enterprise

    namestring
    priceCentsinteger or null

    Monthly base price in USD cents; null is a custom quote

    priceCentsYearlyinteger or null

    Price of a year paid at once in USD cents; null means monthly only or custom

    priceLabelstring
    currencystring
    intervalstring
    summarystring
    selfServeboolean
    limitsPlanLimits
    featuresarray of string
    oneTimearray of object

    One-time purchases, bought with `POST /billing/purchases`. Empty when they are not on sale.

    11 fields of oneTime
    idstring

    One of: deep-audit

    namestring
    priceCentsinteger
    priceLabelstring
    currencystring
    followUpPercentOffinteger

    Discount on every further deep audit of a site that had one.

    followUpPriceCentsinteger

    Price of a further deep audit of the same site.

    runsinteger

    Deep audits of the site in one purchase

    validDaysinteger

    Days from the purchase in which the audit can be started

    summarystring
    availableboolean

    False until this product can be paid for.

    trialDaysinteger

    0: no trial.

    moneyBackDaysinteger

    Refund on request within this many days of the first payment

    earlyAccessobject
    3 fields of earlyAccess
    percentOffinteger
    monthsinteger
    activeboolean
    modestring

    `mock`: test mode, a plan is switched on without Stripe (UAT and previews only).

    One of: off, mock, stripe

    checkoutAvailableboolean

    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

    GET/api/v1/billing
    Scope: Any keyoperationId: getBilling

    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

    200Billing

    Billing state

    14 fields
    planobject
    2 fields of plan
    idstring
    namestring
    statusstring

    free, trialing, active, past_due or manual

    cancelAtPeriodEndboolean
    trialobject
    3 fields of trial
    endsAtstring or null (date-time)
    availableboolean
    daysinteger
    periodobject
    2 fields of period
    startstring (date-time)
    endstring (date-time)
    usageobject
    5 fields of usage
    sitesobject
    2 fields of sites
    usedinteger
    limitinteger
    creditsobject
    2 fields of credits
    usedinteger
    includedinteger
    automationsobject
    2 fields of automations
    usedinteger
    limitinteger
    extraSitesobject
    3 fields of extraSites
    boughtinteger
    centsPerMonthinteger or null
    amountCentsinteger
    overageobject
    2 fields of overage
    creditsinteger
    amountCentsinteger
    deepAuditPassesarray of object

    Bought deep audits that were not started yet (`POST /billing/purchases`).

    4 fields of deepAuditPasses
    idstring
    siteIdstring
    runsLeftinteger
    expiresAtstring (date-time)
    deepAuditFollowUpSitesarray of string

    Ids of the sites that had a deep audit bought; the next one costs less there.

    oneTimeAuditsboolean

    The one-time deep audit can be bought now.

    spendCapCentsinteger
    limitsPlanLimits
    11 fields of limits
    sitesinteger
    creditsPerPeriodinteger

    Audit credits included per billing period. A run costs the credits of its checks (full passive audit 48, full deep 75).

    overageCentsPer1000Creditsinteger or null

    USD cents per 1

    schedulesarray of string
    deepAuditsboolean

    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`).

    savedScopesinteger

    Saved scopes of the account's own

    automationsinteger

    Fair-use cap on automations

    historyDaysinteger
    apiPerMinuteinteger
    apiWriteboolean

    API keys may write. Free: read-only; a write with a key answers `403 plan_limit`.

    extraSiteCentsPerMonthinteger or null

    Price of one extra site a month in USD cents; null means none can be bought

    modestring

    One of: off, mock, stripe

    checkoutAvailableboolean
    portalAvailableboolean
    ErrorProblem (application/problem+json)

    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)

    PATCH/api/v1/billing
    App session onlyoperationId: updateBilling

    `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

    spendCapCentsinteger

    Min 0 · Max 100000

    extraSitesinteger

    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

    200Billing

    Billing state

    14 fields
    planobject
    2 fields of plan
    idstring
    namestring
    statusstring

    free, trialing, active, past_due or manual

    cancelAtPeriodEndboolean
    trialobject
    3 fields of trial
    endsAtstring or null (date-time)
    availableboolean
    daysinteger
    periodobject
    2 fields of period
    startstring (date-time)
    endstring (date-time)
    usageobject
    5 fields of usage
    sitesobject
    2 fields of sites
    usedinteger
    limitinteger
    creditsobject
    2 fields of credits
    usedinteger
    includedinteger
    automationsobject
    2 fields of automations
    usedinteger
    limitinteger
    extraSitesobject
    3 fields of extraSites
    boughtinteger
    centsPerMonthinteger or null
    amountCentsinteger
    overageobject
    2 fields of overage
    creditsinteger
    amountCentsinteger
    deepAuditPassesarray of object

    Bought deep audits that were not started yet (`POST /billing/purchases`).

    4 fields of deepAuditPasses
    idstring
    siteIdstring
    runsLeftinteger
    expiresAtstring (date-time)
    deepAuditFollowUpSitesarray of string

    Ids of the sites that had a deep audit bought; the next one costs less there.

    oneTimeAuditsboolean

    The one-time deep audit can be bought now.

    spendCapCentsinteger
    limitsPlanLimits
    11 fields of limits
    sitesinteger
    creditsPerPeriodinteger

    Audit credits included per billing period. A run costs the credits of its checks (full passive audit 48, full deep 75).

    overageCentsPer1000Creditsinteger or null

    USD cents per 1

    schedulesarray of string
    deepAuditsboolean

    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`).

    savedScopesinteger

    Saved scopes of the account's own

    automationsinteger

    Fair-use cap on automations

    historyDaysinteger
    apiPerMinuteinteger
    apiWriteboolean

    API keys may write. Free: read-only; a write with a key answers `403 plan_limit`.

    extraSiteCentsPerMonthinteger or null

    Price of one extra site a month in USD cents; null means none can be bought

    modestring

    One of: off, mock, stripe

    checkoutAvailableboolean
    portalAvailableboolean
    ErrorProblem (application/problem+json)

    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)

    POST/api/v1/billing/checkout
    App session onlyoperationId: startCheckout

    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

    planstringrequired

    One of: starter, pro, ultra

    intervalstring

    One of: month, year · Default: month

    {
      "plan": "starter"
    }

    Responses

    200RedirectUrl

    Checkout page

    1 field
    urlstring (uri)required
    ErrorProblem (application/problem+json)

    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)

    POST/api/v1/billing/purchases
    App session onlyoperationId: buyOneTimeAudit

    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

    productstringrequired

    One of: deep-audit

    siteIdstringrequired
    {
      "product": "deep-audit",
      "siteId": "string"
    }

    Responses

    200RedirectUrl

    Checkout page

    1 field
    urlstring (uri)required
    ErrorProblem (application/problem+json)

    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)

    POST/api/v1/billing/portal
    App session onlyoperationId: openBillingPortal

    Card, invoices, plan change and cancellation, on Stripe's page. `409 no_billing_account` before a first checkout.

    Responses

    200RedirectUrl

    Portal page

    1 field
    urlstring (uri)required
    ErrorProblem (application/problem+json)

    RFC 9457 problem

    Try it: signed in, open this operation in the app. It runs against your own account, with no key to paste.