Octobat website screenshot

Octobat

Octobat is a billing, invoicing, and tax-compliance platform for online businesses. It automates the creation, delivery, and storage of legally compliant invoices, credit notes, self-billing invoices, and tax receipts for every online transaction, and provides a real-time tax (VAT / GST / sales tax) determination engine for tax-exclusive and tax-inclusive billing models. Octobat integrates with Stripe, GoCardless, and other payment providers, and exposes a Stripe-style REST API at base URL https://apiv2.octobat.com authenticated with HTTP Basic (secret key). Octobat also ships Beanie (a hosted checkout) and Plaza (marketplace / platform tax and invoicing for connected accounts). Operating status - Octobat was acquired by Mirakl in November 2021; the standalone marketing site (octobat.com) now redirects to mirakl.com, while the developer documentation at docs.octobat.com and the apiv2.octobat.com API remain available to existing integrators.

Octobat publishes 9 API contracts indexed on the APIs.io network, including Coupons API, Credit Notes API, Customers API, and 6 more. Tagged areas include Billing, Invoicing, Tax Compliance, VAT, and E-Commerce.

The Octobat catalog on APIs.io includes 1 Spectral governance ruleset.

Octobat’s developer surface includes engineering blog, authentication, documentation, and 10 more developer resources.

25.7/100 emerging ▬ flat Agent 23/100 agent aware Heartbeat 0/100 dormant saas Full breakdown ↓
scored 2026-11-13 · rubric v0.28.0 · Show this score on your site →
AccessPaid
1 published contract
BillingInvoicingTax ComplianceVATE-CommercePaymentsFintech

What this lets a business do 2

Business capabilities this provider's published APIs can perform, derived from its own contracts. Browse all capabilities →

Subscription Billing & Revenue Management
BC-4250
Credit NotesInvoices
POST /invoices PATCH /invoices/{id} PATCH /invoices/{id}/confirm POST /invoices/{id}/send
Subscription Lifecycle Management
BC-4240
Subscriptions
POST /subscriptions POST /usage_items

Kin Score

Kin Score Kin Score How this is scored →
scored 2026-11-13 · rubric v0.28.0
Regulatory Posture applies to this provider. Its tags matched the Payments regime, so Regulatory Posture carries 15 points of the composite. If this regime is wrong for your business, say so on your provider repo — the applicability map is public and we will correct it.
Create-or-Update Ergonomics applies to this provider. This API accepts writes, so it carries 10 points of the composite. It is scored from the published contracts themselves: whether a caller can create-or-update in one call, whether the write accepts a key the caller already holds, and whether the response says which branch ran. Without that, every write needs a search-and-branch in front of it, and the first time that check is skipped a duplicate record is created. Scored against the observed mean rather than raw — a provider at the catalog average is unchanged by this facet, not penalised by it.
The six quality facets above are damped to 75 points between them, because the conditional facet above carries the other 25. That is why each facet's contribution is shown against a damped maximum: raising a quality facet moves the composite by 75% of its nominal weight, not 100%. The full arithmetic is at apis.io/rating/.
Show this score on your site. Kin Score badge preview for Octobat It updates itself when the score changes. Paste this where you link to your API docs:
<a href="https://apis.io/providers/octobat/"><img src="https://apis.io/badge/octobat/card.svg" alt="Octobat on APIs.io — Kin Score by API Evangelist"></a>
Other styles, a README pill and a shields.io endpoint are on the badge page.
Raise your score.
Agent readiness — checks not met, largest first (exact, from this profile):
  • MCP Server +12 pts — deployment.mode + probe verdict on the mcp/ manifest, not the pointer; an unprobed slug falls back to authorship Ask about this →
  • Idempotency +9 pts — OpenAPI mutating operations declare an idempotency key — a header, a request-body property, or a named de-duplication token whose own description says so (verified); else common[].type matches /idempoten/i (documented) Ask about this →
  • Stable Error Semantics +8 pts — OpenAPI $refs a shared error schema across 4xx/5xx responses (verified), else common[].type includes ErrorCatalog / ErrorCodes / DeclineCodes Ask about this →
  • A2A Agent Card +8 pts — a2a/-a2a.yml manifest, graded on conformance.grade against A2A 1.0.0 Ask about this →
  • Registration Without a Human +6 pts — a `registration_endpoint` in the served RFC 8414 / OIDC discovery document Ask about this →
  • Delegated User Identity +6 pts — a served discovery document listing authorization_code in grant_types_supported (served), else an oauth2 authorizationCode flow or openIdConnect declared in an OpenAPI (documented) Ask about this →
8 more unmet checks in the Agent Readiness table above.
Kin Score — facets with the most composite points still available (weight × headroom):
Each check links to what satisfies it. Publish the artifact, or tell us where it already lives, and the score moves on the next scoring run.
Not sure how this applies to your stack? Ask about any one item. Kin Lane reads every question, looks at your profile and your situation, and replies with what a fix would take — scoped to that one area, priced up front, yours whether you ship it or not. Ask a question →
Ask about:
Octobat · a person reads this and replies by email.
or email info@apis.io
Improve this rating by publishing the missing artifacts — every area above can be raised, and the full rubric is at apis.io/rating/. Every facet and dimension name above is a link: it opens that measurement's own page — what it means, the exact checks that feed it, how the whole catalog distributes on it, and the providers at the top of it. This rating is computed from the provider profile at artifacts.apis.io/octobat/apis.yml: open an issue on github.com/api-evangelist/octobat to ask a question or point us at an artifact you publish. Submit an artifact on GitHub — free → Manage your own listing — the Influence plan, $499/mo →

Standards implemented 1

Standards this provider implements or carries. De facto ones are profiled and measured by the API Commons; formal ones come from the standards directory and are linked by the provider's own tags. The evidence column says how each claim was established — not that it was made.

measured — observed by APIs.io (published)

APIs 9

Individual APIs this provider publishes, each with its own machine-readable definition.

Octobat Coupons API

Discount coupons for invoices and subscriptions.

Octobat Credit Notes API

Compliant credit notes issued against invoices.

Octobat Customers API

Customers and their billing / tax details.

Octobat Invoices API

Compliant invoices, their items, and lifecycle actions.

Octobat Payouts API

Settlement payouts and their balance transactions.

Octobat Products API

Products and their tax categorization.

Octobat Subscriptions API

Recurring-billing subscriptions and metered usage.

Octobat Tax Evidence API

Real-time tax determination for customers and carts / checkouts.

Octobat Transactions API

Payments registered against invoices for reconciliation and tax reporting.

Scroll for all 9

Open Collections 10

Open, tool-agnostic API collections (OpenAPI-derived and Bruno).

Octobat Coupons API

OPEN COLLECTION

Octobat API

OPEN COLLECTION

Scroll for all 10

Octobat API pricing

Not yet checked against Octobat's own pricing page. Compiled by API Evangelist on 2026-07-03 from www.octobat.com/; confirm before you rely on a figure.

PlanPrice
Starter subscription —
Growth subscription —
Plaza / Platform subscription —
Enterprise / Mirakl enterprise —

Plan details, limits and sources →

Rate limits

Compiled by API Evangelist, not yet checked against Octobat's documentation. Rate-limit details →

Pricing Plans 1

Published pricing tiers and plan structures.

Octobat Plans Pricing

4 plans

PLANS

Rate Limits 1

Documented rate limits and quota policies.

Octobat Rate Limits

3 limits

RATE LIMITS

FinOps 1

Cost, billing, and metering signals for API financial operations.

Spectral Rules 1

Spectral governance rulesets for linting and validating these APIs. Counts are the severity each rule declares, not results of running them.

Octobat API Rules

60 rules · 56 error-severity 1 warn-severity 3 info-severity

SPECTRAL

Security Posture 2

Authentication, domain security, vulnerability disclosure, and trust-center signals.

Octobat Authentication

http · 1 scheme

SECURITY

Octobat Domain Security

TLSv1.3 · HSTS

SECURITY

Agentic Access (API Evangelist recommendations) 1

Recommended x-agentic-access execution contracts for AI agents.

Octobat Agentic Access

48 operations · 32 acting

48 operations · 32 acting

AGENTIC

Resources

Documentation 1

Reference material describing how the API behaves

Agent Surfaces 1

MCP servers, agent skills, and machine-readable catalogs

Build 1

SDKs, sample code, and the tooling you integrate with

Access & Security 2

Authentication, authorization, and security posture

Operate 1

Status, limits, changes, and where to get help

Commercial 2

Pricing, plans, and the legal terms of use

Company 3

The organization behind the API

Other 2

Properties that don't map to a standard resource type

Source (apis.yml)

apis.yml Raw ↑
aid: octobat
url: https://raw.githubusercontent.com/api-evangelist/octobat/refs/heads/main/apis.yml
name: Octobat
kind: company
description: Octobat is a billing, invoicing, and tax-compliance platform for online businesses. It automates the creation,
  delivery, and storage of legally compliant invoices, credit notes, self-billing invoices, and tax receipts for every online
  transaction, and provides a real-time tax (VAT / GST / sales tax) determination engine for tax-exclusive and tax-inclusive
  billing models. Octobat integrates with Stripe, GoCardless, and other payment providers, and exposes a Stripe-style REST
  API at base URL https://apiv2.octobat.com authenticated with HTTP Basic (secret key). Octobat also ships Beanie (a hosted
  checkout) and Plaza (marketplace / platform tax and invoicing for connected accounts). Operating status - Octobat was acquired
  by Mirakl in November 2021; the standalone marketing site (octobat.com) now redirects to mirakl.com, while the developer
  documentation at docs.octobat.com and the apiv2.octobat.com API remain available to existing integrators.
deliveryModel:
  model: saas
  open_source: false
  commercial: true
  callable_host: true
  label: Hosted service · you call their endpoint
  confidence: high
  source:
  - openapi
  - pricing
  generated: '2026-08-28'
  method: derived
accessModel:
  pricing: paid
  onboarding: unknown
  trial: false
  try_now: false
  public: false
  label: Paid
  confidence: medium
  source:
  - plans
  - authentication
  - security
  - url: https://www.octobat.com
    status: 302
    note: declared website redirects to https://www.mirakl.com/ — a different registrable domain (octobat.com -> mirakl.com),
      possible rename or acquisition (probed 2026-09-03, roadmap#169)
  generated: '2026-11-13'
  method: derived
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/icons/octobat.png
x-docs-platform: gitbook
x-docs-platform-confidence: high
x-docs-platform-checked: 2026-10-04
tags:
- Billing
- Invoicing
- Tax Compliance
- VAT
- E-Commerce
- Payments
- Fintech
created: '2026-07-03'
modified: '2026-10-06'
specificationVersion: '0.23'
apis:
- aid: octobat:octobat-coupons-api
  name: Octobat Coupons API
  description: Discount coupons for invoices and subscriptions.
  humanURL: https://docs.octobat.com/octobat/development/api
  baseURL: https://apiv2.octobat.com
  tags:
  - Coupons
  properties:
  - type: OpenAPI
    url: openapi/octobat-coupons-api-openapi.yml
  - type: Documentation
    url: https://docs.octobat.com/octobat/development/api
  - type: APIReference
    url: https://v2apidoc.octobat.com
  - type: PostmanCollection
    url: collections/octobat.postman_collection.json
  - type: OpenCollection
    url: collections/octobat.opencollection.json
  - type: Documentation
    url: https://docs.octobat.com/octobat/integrations-docs/generic-integration/register-transactions-in-octobat
  - type: Documentation
    url: https://docs.octobat.com/octobat/integrations-docs/generic-integration/tax-calculation-for-a-cart-or-an-order
- aid: octobat:octobat-credit-notes-api
  name: Octobat Credit Notes API
  description: Compliant credit notes issued against invoices.
  humanURL: https://docs.octobat.com/octobat/development/api
  baseURL: https://apiv2.octobat.com
  tags:
  - Credit Notes
  properties:
  - type: OpenAPI
    url: openapi/octobat-credit-notes-api-openapi.yml
  - type: Documentation
    url: https://docs.octobat.com/octobat/development/api
  - type: APIReference
    url: https://v2apidoc.octobat.com
  - type: PostmanCollection
    url: collections/octobat.postman_collection.json
  - type: OpenCollection
    url: collections/octobat.opencollection.json
  - type: Documentation
    url: https://docs.octobat.com/octobat/integrations-docs/generic-integration/register-transactions-in-octobat
  - type: Documentation
    url: https://docs.octobat.com/octobat/integrations-docs/generic-integration/tax-calculation-for-a-cart-or-an-order
- aid: octobat:octobat-customers-api
  name: Octobat Customers API
  description: Customers and their billing / tax details.
  humanURL: https://docs.octobat.com/octobat/development/api
  baseURL: https://apiv2.octobat.com
  tags:
  - Customers
  properties:
  - type: OpenAPI
    url: openapi/octobat-customers-api-openapi.yml
  - type: Documentation
    url: https://docs.octobat.com/octobat/development/api
  - type: APIReference
    url: https://v2apidoc.octobat.com
  - type: PostmanCollection
    url: collections/octobat.postman_collection.json
  - type: OpenCollection
    url: collections/octobat.opencollection.json
  - type: Documentation
    url: https://docs.octobat.com/octobat/integrations-docs/generic-integration/register-transactions-in-octobat
  - type: Documentation
    url: https://docs.octobat.com/octobat/integrations-docs/generic-integration/tax-calculation-for-a-cart-or-an-order
- aid: octobat:octobat-invoices-api
  name: Octobat Invoices API
  description: Compliant invoices, their items, and lifecycle actions.
  humanURL: https://docs.octobat.com/octobat/development/api
  baseURL: https://apiv2.octobat.com
  tags:
  - Invoices
  properties:
  - type: OpenAPI
    url: openapi/octobat-invoices-api-openapi.yml
  - type: Documentation
    url: https://docs.octobat.com/octobat/development/api
  - type: APIReference
    url: https://v2apidoc.octobat.com
  - type: PostmanCollection
    url: collections/octobat.postman_collection.json
  - type: OpenCollection
    url: collections/octobat.opencollection.json
  - type: Documentation
    url: https://docs.octobat.com/octobat/integrations-docs/generic-integration/register-transactions-in-octobat
  - type: Documentation
    url: https://docs.octobat.com/octobat/integrations-docs/generic-integration/tax-calculation-for-a-cart-or-an-order
- aid: octobat:octobat-payouts-api
  name: Octobat Payouts API
  description: Settlement payouts and their balance transactions.
  humanURL: https://docs.octobat.com/octobat/development/api
  baseURL: https://apiv2.octobat.com
  tags:
  - Payouts
  properties:
  - type: OpenAPI
    url: openapi/octobat-payouts-api-openapi.yml
  - type: Documentation
    url: https://docs.octobat.com/octobat/development/api
  - type: APIReference
    url: https://v2apidoc.octobat.com
  - type: PostmanCollection
    url: collections/octobat.postman_collection.json
  - type: OpenCollection
    url: collections/octobat.opencollection.json
  - type: Documentation
    url: https://docs.octobat.com/octobat/integrations-docs/generic-integration/register-transactions-in-octobat
  - type: Documentation
    url: https://docs.octobat.com/octobat/integrations-docs/generic-integration/tax-calculation-for-a-cart-or-an-order
- aid: octobat:octobat-products-api
  name: Octobat Products API
  description: Products and their tax categorization.
  humanURL: https://docs.octobat.com/octobat/development/api
  baseURL: https://apiv2.octobat.com
  tags:
  - Product
  tags_raw:
  - Products
  properties:
  - type: OpenAPI
    url: openapi/octobat-products-api-openapi.yml
  - type: Documentation
    url: https://docs.octobat.com/octobat/development/api
  - type: APIReference
    url: https://v2apidoc.octobat.com
  - type: PostmanCollection
    url: collections/octobat.postman_collection.json
  - type: OpenCollection
    url: collections/octobat.opencollection.json
  - type: Documentation
    url: https://docs.octobat.com/octobat/integrations-docs/generic-integration/register-transactions-in-octobat
  - type: Documentation
    url: https://docs.octobat.com/octobat/integrations-docs/generic-integration/tax-calculation-for-a-cart-or-an-order
- aid: octobat:octobat-subscriptions-api
  name: Octobat Subscriptions API
  description: Recurring-billing subscriptions and metered usage.
  humanURL: https://docs.octobat.com/octobat/development/api
  baseURL: https://apiv2.octobat.com
  tags:
  - Subscription
  tags_raw:
  - Subscriptions
  properties:
  - type: OpenAPI
    url: openapi/octobat-subscriptions-api-openapi.yml
  - type: Documentation
    url: https://docs.octobat.com/octobat/development/api
  - type: APIReference
    url: https://v2apidoc.octobat.com
  - type: PostmanCollection
    url: collections/octobat.postman_collection.json
  - type: OpenCollection
    url: collections/octobat.opencollection.json
  - type: Documentation
    url: https://docs.octobat.com/octobat/integrations-docs/generic-integration/register-transactions-in-octobat
  - type: Documentation
    url: https://docs.octobat.com/octobat/integrations-docs/generic-integration/tax-calculation-for-a-cart-or-an-order
- aid: octobat:octobat-tax-evidence-api
  name: Octobat Tax Evidence API
  description: Real-time tax determination for customers and carts / checkouts.
  humanURL: https://docs.octobat.com/octobat/development/api
  baseURL: https://apiv2.octobat.com
  tags:
  - Tax Evidence
  properties:
  - type: OpenAPI
    url: openapi/octobat-tax-evidence-api-openapi.yml
  - type: Documentation
    url: https://docs.octobat.com/octobat/development/api
  - type: APIReference
    url: https://v2apidoc.octobat.com
  - type: PostmanCollection
    url: collections/octobat.postman_collection.json
  - type: OpenCollection
    url: collections/octobat.opencollection.json
  - type: Documentation
    url: https://docs.octobat.com/octobat/integrations-docs/generic-integration/register-transactions-in-octobat
  - type: Documentation
    url: https://docs.octobat.com/octobat/integrations-docs/generic-integration/tax-calculation-for-a-cart-or-an-order
- aid: octobat:octobat-transactions-api
  name: Octobat Transactions API
  description: Payments registered against invoices for reconciliation and tax reporting.
  humanURL: https://docs.octobat.com/octobat/development/api
  baseURL: https://apiv2.octobat.com
  tags:
  - Transaction
  tags_raw:
  - Transactions
  properties:
  - type: OpenAPI
    url: openapi/octobat-transactions-api-openapi.yml
  - type: Documentation
    url: https://docs.octobat.com/octobat/development/api
  - type: APIReference
    url: https://v2apidoc.octobat.com
  - type: PostmanCollection
    url: collections/octobat.postman_collection.json
  - type: OpenCollection
    url: collections/octobat.opencollection.json
  - type: Documentation
    url: https://docs.octobat.com/octobat/integrations-docs/generic-integration/register-transactions-in-octobat
  - type: Documentation
    url: https://docs.octobat.com/octobat/integrations-docs/generic-integration/tax-calculation-for-a-cart-or-an-order
common:
- url: https://www.mirakl.com/blogs/
  type: Blog
- type: CapabilityMap
  url: capabilities/octobat-capability-edges.yml
  name: Octobat Business Capability Map
- type: ParentCompany
  url: https://apis.io/providers/mirakl/
  name: Mirakl
  x-relationship: acquired
  x-evidence: description names Mirakl and https://www.octobat.com now redirects to mirakl.com (roadmap#390, corroborate-dead.py)
- type: AgenticAccess
  url: agentic-access/octobat-agentic-access.yml
- type: DomainSecurity
  url: security/octobat-domain-security.yml
- type: Authentication
  url: authentication/octobat-authentication.yml
- type: GitHubOrganization
  url: https://github.com/0ctobat
- type: LinkedIn
  url: https://www.linkedin.com/company/octobat
- type: Website
  url: https://www.octobat.com
- type: Documentation
  url: https://docs.octobat.com
- type: Plans
  url: plans/octobat-plans-pricing.yml
- type: RateLimits
  url: rate-limits/octobat-rate-limits.yml
- type: FinOps
  url: finops/octobat-finops.yml
maintainers:
- FN: Kin Lane
  email: kin@apievangelist.com

Octobat API — frequently asked questions

Does Octobat have an API?

Yes. APIs.io lists 9 APIs from Octobat, including Octobat Coupons API, Octobat Credit Notes API and Octobat Customers API, and 6 more.

Is there an OpenAPI specification for the Octobat API?

Yes. APIs.io indexes 9 OpenAPI specifications for Octobat, each linked for download from this page.

How do I authenticate with the Octobat API?

Octobat uses bearer-token authentication (http · 1 scheme). The details are profiled on APIs.io as Octobat Authentication.

How much does the Octobat API cost?

APIs.io lists 4 pricing plans for Octobat, with each plan's price, limits and inclusions under Pricing on this page.

Is the Octobat API ready for AI agents?

Octobat has a Kin Score of 25.7 out of 100 (emerging) and an Agent Readiness score of 23.0 (agent-aware), scored by API Evangelist on 2026-11-13.

Work with this as data

Every provider here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for providers

9 MCP tools reach this
  • find_providersBrowse and filter every provider in the catalog.
  • get_provider_artifactsEvery artifact this provider publishes, grouped by type.
  • get_provider_operationsEvery operation across all of their OpenAPIs — one call instead of parsing every spec.
  • get_provider_toolsEvery MCP tool they ship, with the operation each wraps.
  • get_provider_evidenceHow each part of their score was established. Free — the basis for a claim should not sit behind it.
  • get_provider_ratingPRO — composite, band, trend and facet scores.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This provider
curl "https://apis.io/api/v1/providers/octobat"
All providers
curl "https://apis.io/api/v1/providers?limit=25"
Every operation they expose
curl "https://apis.io/api/v1/providers/octobat/operations?limit=25"
How their score was established
curl "https://apis.io/api/v1/providers/octobat/evidence"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.