Orb

Orb (Orb, Inc., withorb.com) calls itself "the revenue design company": a usage-based billing and metering platform that helps modern software companies design, execute, and operate revenue and adapt pricing as products, usage, and costs evolve. The Orb REST API at api.withorb.com ingests metered events, models customers, plans, prices, and items, runs subscriptions, and automates invoicing, prepaid credit ledgers, coupons, alerts, and webhooks for revenue teams.

Orb publishes 32 API contracts indexed on the APIs.io network, including Alerts API, Credits API, Events API, and 29 more. Tagged areas include Billing, Usage-Based Billing, Metering, Subscription, and Invoicing.

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

Orb’s developer surface includes changelog, sandbox, engineering blog, authentication, documentation, API reference, getting-started guide, and 42 more developer resources.

🌐 Visit website 📡 Profile data on GitHub

69.9/100 exemplar ▲ 34.6 Agent 48/100 agent ready Front door AI 4/6 moderate Heartbeat 100/100 alive saas Full breakdown ↓
scored 2026-11-13 · rubric v0.28.0 · Show this score on your site →

AccessPaid

2 published contracts 1 MCP Servers 6 Agent Skills

Billing Usage-Based Billing Metering Subscription Invoicing FinOps Pricing Revenue

What this lets a business do 3

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

Subscription Billing & Revenue Management

BC-4250

CreditsEventsInvoicesMetrics

Subscription Lifecycle Management

BC-4240

Subscriptions

Pricing Management

BC-440

Coupons

Kin Score

Kin Score How this is scored →
scored 2026-11-13 · rubric v0.28.0

Composite quality — 69.9/100 · exemplar

Contract Quality 10.8 / 19

Developer Ergonomics 10.3 / 15

Access Clarity 11.2 / 15

Operational Transparency 7.7 / 10

Contract Governance 2.9 / 9

Discoverability 5.0 / 8

Regulatory Posture 5.3 / 15

Create-or-Update Ergonomics 3.9 / 10

Agent readiness — 48/100 · agent ready

Machine-Readable Contract 18 / 18

Agentic Access Contract 10 / 10

Documented Reversibility 6 / 6

MCP Server 12 / 12

Machine-Readable Auth 10 / 10

Idempotency 9 / 9

Stable Error Semantics 8 / 8

Request/Response Examples 0 / 7

Rate-Limit Signaling 7 / 7

Typed Event Surface 6 / 6

Agent Skills 5 / 5

Well-Known Catalog 0 / 4

Consent & Bot Identity 0 / 3

A2A Agent Card 8 / 8

Dry-Run / Simulate Mode 0 / 4

Delegated User Identity 0 / 6

Protected Resource Metadata 0 / 5

Registration Without a Human 0 / 6

Agentic Commerce Well-Known Document 0 / 5

Pagination 5 / 5

Distinct Operations 3 / 3

MCP Tool Quality 6 / 6

Regulatory Posture applies to this provider. Its tags matched the Horizontal (data, software, accessibility, platform) 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.

It updates itself when the score changes. Paste this where you link to your API docs:

<a href="https://apis.io/providers/orb-billing/"><img src="https://apis.io/badge/orb-billing/card.svg" alt="Orb 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):

Request/Response Examples +7 pts — share of operations carrying request/response examples; else an Examples / Code Samples link 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 →
Protected Resource Metadata +5 pts — a served /.well-known/oauth-protected-resource carrying `resource` (documented), and naming its authorization_servers (verified) Ask about this →
Agentic Commerce Well-Known Document +5 pts — a parsing /.well-known/ucp.json or acp.json declaring a version and at least one service, OR (0.27) a live x402 payment challenge from _data/x402-adoption.json — `self` when its endpoints are on the provider's own domain, `platform` when they are on a vendor's Ask about this →
Dry-Run / Simulate Mode +4 pts — OpenAPI: destructive operations expose a dry_run / simulate / preview / validate_only parameter Ask about this →

2 more unmet checks in the Agent Readiness table above.

Kin Score — facets with the most composite points still available (weight × headroom):

Contract Quality scores 57.7 — up to +10.6 composite points Ask about this →
Contract Governance scores 31.8 — up to +8.2 composite points Ask about this →
Developer Ergonomics scores 68.5 — up to +6.3 composite points Ask about this →

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 →

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/orb-billing/apis.yml: open an issue on github.com/api-evangelist/orb-billing 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 →

Markets this provider is in provisional

The Kin Score Market layer reads a provider inside its market: its position, and how deep its integrations go. Depth is only comparable within a position. Provisional and unweighted: not part of the Kin Score or agent readiness.

Market	Position	Depth	Registered MCP server	Declares compatibility
Billing, Subscriptions and Monetization	builds-on	22.2	-	-

Registered MCP server and declares compatibility are report only — not weighted. Undeclared means we found nothing we can read, so there is no number: we never infer integrations.

Standards implemented 3

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.

Agent2Agent

measured — observed by APIs.io (conformant)

Model Context Protocol (MCP)

measured — observed by APIs.io (documented)

OpenAPI

measured — observed by APIs.io (published)

APIs 32

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

Orb Alerts API

The Alerts API from Orb — 4 operation(s) for alerts.

Orb Credits API

The Credits API from Orb — 4 operation(s) for credits.

Orb Events API

The Events API from Orb — 4 operation(s) for events.

Orb Accounting sync webhooks API

Payloads Orb delivers for accounting sync events. Endpoint configuration, retries and signature verification are covered in the [webhooks guide](https://docs.withorb.com/integra...

Orb Alert API

[Alerts within Orb](/product-catalog/configuring-alerts) monitor spending, usage, or credit balance and trigger webhooks when a threshold is exceeded. Alerts created through the...

Orb Automation webhooks API

Payloads Orb delivers for automation events. Endpoint configuration, retries and signature verification are covered in the [webhooks guide](https://docs.withorb.com/integrations...

Orb Availability API

The Availability API from Orb — 1 operation(s) for availability.

Orb Coupon API

A coupon represents a reusable discount configuration that can be applied either as a fixed or percentage amount to an invoice or subscription. Coupons are activated using a red...

Orb Credit API

The [Credit Ledger Entry resource](/product-catalog/prepurchase) models prepaid credits within Orb.

Orb Credit note API

The [Credit Note](/invoicing/credit-notes) resource represents a credit that has been applied to a particular invoice.

Orb Customer API

A customer is a buyer of your products, and the other party to the billing relationship. In Orb, customers are assigned system generated identifiers automatically, but it's ofte...

Orb Customer webhooks API

Payloads Orb delivers for customer events. Endpoint configuration, retries and signature verification are covered in the [webhooks guide](https://docs.withorb.com/integrations-a...

Orb Dimensional Price Group API

The Dimensional Price Group API from Orb — 4 operation(s) for dimensional price group.

Orb Dunning webhooks API

Payloads Orb delivers for dunning events. Endpoint configuration, retries and signature verification are covered in the [webhooks guide](https://docs.withorb.com/integrations-an...

Orb Event API

The [Event](/core-concepts#event) resource represents a usage event that has been created for a customer. Events are the core of Orb's usage-based billing model, and are used to...

Orb Invoice and credit note webhooks API

Payloads Orb delivers for invoice & credit note events. Endpoint configuration, retries and signature verification are covered in the [webhooks guide](https://docs.withorb.com/i...

Orb Invoice API

An [`Invoice`](/core-concepts#invoice) is a fundamental billing entity, representing the request for payment for a single subscription. This includes a set of line items, which ...

Orb Item API

The Item resource represents a sellable product or good. Items are associated with all line items, billable metrics, and prices and are used for defining external sync behavior ...

Orb License API

The License API from Orb — 7 operation(s) for license.

Orb License Type API

The LicenseType resource represents a type of license that can be assigned to users. License types are used during billing by grouping metrics on the configured grouping key.

Orb Metric API

The Metric resource represents a calculation of a quantity based on events. Metrics are defined by the query that transforms raw usage events into meaningful values for your cus...

Orb Payment method webhooks API

Payloads Orb delivers for payment method events. Endpoint configuration, retries and signature verification are covered in the [webhooks guide](https://docs.withorb.com/integrat...

Orb Plan API

The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be subscribed to by a customer. Plans define the billing behavior of the subscription. You can see ...

Orb Plan webhooks API

Payloads Orb delivers for plan events. Endpoint configuration, retries and signature verification are covered in the [webhooks guide](https://docs.withorb.com/integrations-and-e...

Orb Price and billable metric webhooks API

Payloads Orb delivers for price & billable metric events. Endpoint configuration, retries and signature verification are covered in the [webhooks guide](https://docs.withorb.com...

Orb Price API

The Price resource represents a price that can be billed on a subscription, resulting in a charge on an invoice in the form of an invoice line item. Prices take a quantity and d...

Orb Price interval API

The Price Interval resource represents a period of time for which a price will bill on a subscription. A subscription’s price intervals define its billing behavior.

Orb Subscription API

A [subscription](/core-concepts#subscription) represents the purchase of a plan by a customer. By default, subscriptions begin on the day that they're created and renew automati...

Orb Subscription Change API

The Subscription Change API from Orb — 4 operation(s) for subscription change.

Orb Subscription webhooks API

Payloads Orb delivers for subscription events. Endpoint configuration, retries and signature verification are covered in the [webhooks guide](https://docs.withorb.com/integratio...

Orb System webhooks API

Payloads Orb delivers for system events. Endpoint configuration, retries and signature verification are covered in the [webhooks guide](https://docs.withorb.com/integrations-and...

Orb Webhook endpoint API

A webhook endpoint is an HTTPS URL that Orb sends [webhook events](/integrations-and-exports/webhooks) to.

Scroll for all 32

Open Collections 12

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

Orb Alerts API

OPEN COLLECTION

Orb Alerts Coupons API

OPEN COLLECTION

Orb Alerts Credits API

OPEN COLLECTION

Orb Alerts Customers API

OPEN COLLECTION

Orb Alerts Events API

OPEN COLLECTION

Orb Alerts Invoices API

OPEN COLLECTION

Orb Alerts Items API

OPEN COLLECTION

Orb Alerts Metrics API

OPEN COLLECTION

Orb Alerts Plans API

OPEN COLLECTION

Orb Alerts Prices API

OPEN COLLECTION

Orb Alerts Subscriptions API

OPEN COLLECTION

Orb API

OPEN COLLECTION

Scroll for all 12

MCP Servers 1

Model Context Protocol servers that expose these APIs to AI agents.

Orb MCP server

Orb's hosted Model Context Protocol server. Exposes 100+ Orb API operations as tools (customers, subscriptions, plans and prices, billable metrics, invoices, credits, alerts, li...

MCP SERVER

Agent Skills 6

Packaged agent skills for driving this provider's APIs from an AI assistant.

change-a-subscription-plan

AGENT SKILL

debug-usage-and-events

AGENT SKILL

grant-and-track-prepaid-credits

AGENT SKILL

investigate-a-customer-bill

AGENT SKILL

issue-and-collect-an-invoice

AGENT SKILL

model-a-price-change

AGENT SKILL

Orb API pricing

Prices published by Orb.

Plan	Price
Business	$6.00 per credit, or less with volume discounts
Enterprise	Custom
Enterprise Support Bundle	Custom pricing.

Plan details, limits and sources →

Rate limits

Analytics (live mode): 10 queries per second
Analytics (test mode): 5 queries per second
Analytics (trial mode): 1 query per second

All 16 limits →

Pricing Plans 1

Published pricing tiers and plan structures.

Orb Plans Pricing

3 plans

PLANS

Rate Limits 1

Documented rate limits and quota policies.

Orb Rate Limits

16 limits

RATE LIMITS

FinOps 1

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

Orb Finops

FINOPS

Spectral Rules 1

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

Orb API Rules

59 rules · 57 error-severity 1 warn-severity 1 info-severity

SPECTRAL

OpenAPI Overlays 12

Overlays applied on top of this provider's contracts. Each card says who wrote it: a document the provider publishes, or one API Evangelist derived or generated.

Orb Alerts Api Overlay

2 actions · update · orb-billing-alerts-api-openapi.yml

DERIVED

Orb Coupons Api Overlay

3 actions · update · orb-billing-coupons-api-openapi.yml

DERIVED

Orb Credits Api Overlay

4 actions · update · orb-billing-credits-api-openapi.yml

DERIVED

Orb Customers Api Overlay

6 actions · update · orb-billing-customers-api-openapi.yml

DERIVED

Orb Events Api Overlay

2 actions · update · orb-billing-events-api-openapi.yml

DERIVED

Orb Invoices Api Overlay

5 actions · update · orb-billing-invoices-api-openapi.yml

DERIVED

Orb Items Api Overlay

3 actions · update · orb-billing-items-api-openapi.yml

DERIVED

Orb Metrics Api Overlay

3 actions · update · orb-billing-metrics-api-openapi.yml

DERIVED

Orb Openapi Overlay

115 actions · update · orb-billing-openapi.json

DERIVED

Orb Plans Api Overlay

4 actions · update · orb-billing-plans-api-openapi.yml

DERIVED

Orb Prices Api Overlay

4 actions · update · orb-billing-prices-api-openapi.yml

DERIVED

Orb Subscriptions Api Overlay

7 actions · update · orb-billing-subscriptions-api-openapi.yml

DERIVED

Scroll for all 12

Security Posture 4

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

Orb Authentication

http · 1 scheme

SECURITY

Orb Domain Security

TLSv1.3 · HSTS · DMARC

SECURITY

Orb Vulnerability Disclosure

no policy recorded

SECURITY

Orb Trust Center

SOC 2

SECURITY

Agentic Access (API Evangelist recommendations) 1

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

Orb Agentic Access

51 operations · 26 acting · 1 human-in-the-loop

51 operations · 26 acting

AGENTIC

Resources

Get Started 3

Portal, sign-up, and the first successful call

Sandbox

Sandbox

GettingStarted

GettingStarted

SignUp

SignUp

Documentation 2

Reference material describing how the API behaves

Documentation

Documentation

APIReference

APIReference

Agent Surfaces 5

MCP servers, agent skills, and machine-readable catalogs

WellKnown

AgentSkill

LLMsTxt

MCPServer

AgenticAccess

Design & Contract 8

Pagination, idempotency, versioning, errors, and events

Spectral

DataModel

Components

Idempotency

Conventions

Lifecycle

ErrorCatalog

Conformance

Scroll for all 8

Build 6

SDKs, sample code, and the tooling you integrate with

ToolCrosswalk

IntegrationEdges

SDKs

Packages

GitHubOrganization

GitHubOrganization

Postman

Postman

Access & Security 6

Authentication, authorization, and security posture

Compliance

Compliance

TrustCenter

TrustCenter

VulnerabilityDisclosure

VulnerabilityDisclosure

DomainSecurity

DomainSecurity

Authentication

Authentication

Security

Security

Operate 6

Status, limits, changes, and where to get help

ChangeLog

Deprecation

RateLimits

Support

StatusPage

ChangeLog

Commercial 5

Pricing, plans, and the legal terms of use

Plans

FinOps

Pricing

TermsOfService

PrivacyPolicy

Company 3

The organization behind the API

Blog

Blog

Website

Website

Newsroom

Newsroom

Other 5

Properties that don't map to a standard resource type

Overlay

AgentCard

Hosts

Vendors

CapabilityMap

Source (apis.yml)

aid: orb-billing
url: https://raw.githubusercontent.com/api-evangelist/orb-billing/refs/heads/main/apis.yml
name: Orb
kind: company
description: 'Orb (Orb, Inc., withorb.com) calls itself "the revenue design company": a usage-based billing and metering platform
  that helps modern software companies design, execute, and operate revenue and adapt pricing as products, usage, and costs
  evolve. The Orb REST API at api.withorb.com ingests metered events, models customers, plans, prices, and items, runs subscriptions,
  and automates invoicing, prepaid credit ledgers, coupons, alerts, and webhooks for revenue teams.'
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: high
  probe_state: covered
  source:
  - plans
  - authentication
  - rate-limits
  - security
  - sandbox
  generated: '2026-11-13'
  method: derived
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/icons/orb-billing.png
x-docs-platform: mintlify
x-docs-platform-confidence: medium
x-docs-platform-checked: 2026-10-04
x-docs-hosting: vercel
tags:
- Billing
- Usage-Based Billing
- Metering
- Subscription
- Invoicing
- FinOps
- Pricing
- Revenue
tags_raw:
- Billing
- Usage-Based Billing
- Metering
- Subscriptions
- Invoicing
- FinOps
created: '2026-06-20'
modified: '2026-11-11'
specificationVersion: '0.23'
maintainers:
- FN: Kin Lane
  email: kin@apievangelist.com
common:
- type: WellKnown
  url: well-known/orb-billing-well-known.yml
- type: Spectral
  url: rules/orb-billing-rules.yml
- type: AgentSkill
  url: skills/_index.yml
- type: DataModel
  url: data-model/orb-billing-data-model.yml
- type: Components
  url: components/orb-billing-components.yml
- type: ChangeLog
  url: changelog/orb-billing-changelog.yml
- type: Idempotency
  url: conventions/orb-billing-conventions.yml
- type: Conventions
  url: conventions/orb-billing-conventions.yml
- type: Sandbox
  url: sandbox/orb-billing-sandbox.yml
- type: Compliance
  url: https://security.withorb.com/
- type: Deprecation
  url: lifecycle/orb-billing-lifecycle.yml
- type: Lifecycle
  url: lifecycle/orb-billing-lifecycle.yml
- type: ErrorCatalog
  url: errors/orb-billing-problem-types.yml
- type: Conformance
  url: conformance/orb-billing-conformance.yml
- type: Overlay
  url: overlays/orb-billing-alerts-api-overlay.yaml
- type: LLMsTxt
  url: llms/orb-billing-llms.txt
- type: AgentCard
  url: a2a/orb-billing-a2a.yml
- type: ToolCrosswalk
  url: mcp/orb-billing-tool-crosswalk.yml
- type: MCPServer
  url: mcp/orb-billing-mcp.yml
- type: Hosts
  url: hosts/orb-billing-hosts.yml
- type: IntegrationEdges
  url: integrations/orb-billing-integration-edges.yml
- type: Vendors
  url: vendors/orb-billing-vendors.yml
- type: SDKs
  url: packages/orb-billing-packages.yml
- type: Packages
  url: packages/orb-billing-packages.yml
- url: https://www.withorb.com/blog
  type: Blog
- type: CapabilityMap
  url: capabilities/orb-billing-capability-edges.yml
  name: Orb Business Capability Map
- type: AgenticAccess
  url: agentic-access/orb-billing-agentic-access.yml
- type: TrustCenter
  url: security/orb-billing-trust-center.yml
- type: VulnerabilityDisclosure
  url: security/orb-billing-vulnerability-disclosure.yml
- type: DomainSecurity
  url: security/orb-billing-domain-security.yml
- type: Authentication
  url: authentication/orb-billing-authentication.yml
- type: GitHubOrganization
  url: https://github.com/orbcorp
- type: Website
  url: https://www.withorb.com
- type: Documentation
  url: https://docs.withorb.com
- type: Plans
  url: plans/orb-billing-plans-pricing.yml
- type: RateLimits
  url: rate-limits/orb-billing-rate-limits.yml
- type: FinOps
  url: finops/orb-billing-finops.yml
- type: APIReference
  url: https://docs.withorb.com/api-reference
- type: GettingStarted
  url: https://docs.withorb.com/quickstart
- type: Support
  url: https://support.withorb.com
- type: Pricing
  url: https://www.withorb.com/pricing
- type: SignUp
  url: https://app.withorb.com/signup
- type: TermsOfService
  url: https://www.withorb.com/terms
- type: PrivacyPolicy
  url: https://www.withorb.com/privacy-policy
- type: StatusPage
  url: https://status.withorb.com
- type: Security
  url: https://www.withorb.com/security
- type: Newsroom
  url: https://www.withorb.com/press
- type: ChangeLog
  url: https://changelog.withorb.com
- type: Postman
  url: https://docs.withorb.com/essentials/postman
apis:
- aid: orb-billing:orb-billing-alerts-api
  name: Orb Alerts API
  description: The Alerts API from Orb — 4 operation(s) for alerts.
  humanURL: https://docs.withorb.com/api-reference/customer
  baseURL: https://api.withorb.com/v1
  tags:
  - Alerts
  properties:
  - type: OpenAPI
    url: openapi/orb-billing-alerts-api-openapi.yml
  - type: OpenAPI
    name: OpenAPI (provider-hosted)
    url: https://docs.withorb.com/api-reference/orb-openapi.json
  - type: APIReference
    url: https://docs.withorb.com/api-reference/customer
  - type: PostmanCollection
    url: collections/orb-billing.postman_collection.json
  - type: APIReference
    url: https://docs.withorb.com/api-reference/plan
  - type: APIReference
    url: https://docs.withorb.com/api-reference/subscription
  - type: Documentation
    url: https://docs.withorb.com/events-and-metrics/event-ingestion
  - type: APIReference
    url: https://docs.withorb.com/api-reference/event
  - type: Documentation
    url: https://docs.withorb.com/invoicing/structure
  - type: APIReference
    url: https://docs.withorb.com/api-reference/invoice
  - type: APIReference
    url: https://docs.withorb.com/api-reference/credit
  - type: APIReference
    url: https://docs.withorb.com/api-reference/price
  - type: APIReference
    url: https://docs.withorb.com/api-reference/alert
  - type: Documentation
    url: https://docs.withorb.com/guides/integrations-and-exports/webhooks
- aid: orb-billing:orb-billing-credits-api
  name: Orb Credits API
  description: The Credits API from Orb — 4 operation(s) for credits.
  humanURL: https://docs.withorb.com/api-reference/customer
  baseURL: https://api.withorb.com/v1
  tags:
  - Credit
  tags_raw:
  - Credits
  properties:
  - type: OpenAPI
    url: openapi/orb-billing-credits-api-openapi.yml
  - type: OpenAPI
    name: OpenAPI (provider-hosted)
    url: https://docs.withorb.com/api-reference/orb-openapi.json
  - type: APIReference
    url: https://docs.withorb.com/api-reference/customer
  - type: PostmanCollection
    url: collections/orb-billing.postman_collection.json
  - type: APIReference
    url: https://docs.withorb.com/api-reference/plan
  - type: APIReference
    url: https://docs.withorb.com/api-reference/subscription
  - type: Documentation
    url: https://docs.withorb.com/events-and-metrics/event-ingestion
  - type: APIReference
    url: https://docs.withorb.com/api-reference/event
  - type: Documentation
    url: https://docs.withorb.com/invoicing/structure
  - type: APIReference
    url: https://docs.withorb.com/api-reference/invoice
  - type: APIReference
    url: https://docs.withorb.com/api-reference/credit
  - type: APIReference
    url: https://docs.withorb.com/api-reference/price
  - type: APIReference
    url: https://docs.withorb.com/api-reference/alert
  - type: Documentation
    url: https://docs.withorb.com/guides/integrations-and-exports/webhooks
- aid: orb-billing:orb-billing-events-api
  name: Orb Events API
  description: The Events API from Orb — 4 operation(s) for events.
  humanURL: https://docs.withorb.com/api-reference/customer
  baseURL: https://api.withorb.com/v1
  tags:
  - Event
  tags_raw:
  - Events
  properties:
  - type: OpenAPI
    url: openapi/orb-billing-events-api-openapi.yml
  - type: OpenAPI
    name: OpenAPI (provider-hosted)
    url: https://docs.withorb.com/api-reference/orb-openapi.json
  - type: APIReference
    url: https://docs.withorb.com/api-reference/customer
  - type: PostmanCollection
    url: collections/orb-billing.postman_collection.json
  - type: APIReference
    url: https://docs.withorb.com/api-reference/plan
  - type: APIReference
    url: https://docs.withorb.com/api-reference/subscription
  - type: Documentation
    url: https://docs.withorb.com/events-and-metrics/event-ingestion
  - type: APIReference
    url: https://docs.withorb.com/api-reference/event
  - type: Documentation
    url: https://docs.withorb.com/invoicing/structure
  - type: APIReference
    url: https://docs.withorb.com/api-reference/invoice
  - type: APIReference
    url: https://docs.withorb.com/api-reference/credit
  - type: APIReference
    url: https://docs.withorb.com/api-reference/price
  - type: APIReference
    url: https://docs.withorb.com/api-reference/alert
  - type: Documentation
    url: https://docs.withorb.com/guides/integrations-and-exports/webhooks
- aid: orb-billing:orb-billing-accounting-sync-webhooks-api
  name: Orb Accounting sync webhooks API
  description: Payloads Orb delivers for accounting sync events. Endpoint configuration, retries and signature verification
    are covered in the [webhooks guide](https://docs.withorb.com/integrations-and-exports/webhooks).
  humanURL: https://docs.withorb.com/api-reference/customer
  baseURL: https://api.withorb.com/v1
  tags:
  - Accounting sync webhooks
  properties:
  - type: OpenAPI
    url: openapi/orb-billing-accounting-sync-webhooks-api-openapi.yml
  - type: APIReference
    url: https://docs.withorb.com/api-reference/customer
  - type: PostmanCollection
    url: collections/orb-billing.postman_collection.json
  - type: APIReference
    url: https://docs.withorb.com/api-reference/plan
  - type: APIReference
    url: https://docs.withorb.com/api-reference/subscription
  - type: Documentation
    url: https://docs.withorb.com/events-and-metrics/event-ingestion
  - type: APIReference
    url: https://docs.withorb.com/api-reference/event
  - type: Documentation
    url: https://docs.withorb.com/invoicing/structure
  - type: APIReference
    url: https://docs.withorb.com/api-reference/invoice
  - type: APIReference
    url: https://docs.withorb.com/api-reference/credit
  - type: APIReference
    url: https://docs.withorb.com/api-reference/price
  - type: APIReference
    url: https://docs.withorb.com/api-reference/alert
  - type: Documentation
    url: https://docs.withorb.com/guides/integrations-and-exports/webhooks
- aid: orb-billing:orb-billing-alert-api
  name: Orb Alert API
  description: '[Alerts within Orb](/product-catalog/configuring-alerts) monitor spending,

    usage, or credit balance and trigger webhooks when a threshold is exceeded.


    Alerts created through the API can be scoped to either customers or subscriptions.'
  humanURL: https://docs.withorb.com/api-reference/customer
  baseURL: https://api.withorb.com/v1
  tags:
  - Alert
  properties:
  - type: OpenAPI
    url: openapi/orb-billing-alert-api-openapi.yml
  - type: APIReference
    url: https://docs.withorb.com/api-reference/customer
  - type: PostmanCollection
    url: collections/orb-billing.postman_collection.json
  - type: APIReference
    url: https://docs.withorb.com/api-reference/plan
  - type: APIReference
    url: https://docs.withorb.com/api-reference/subscription
  - type: Documentation
    url: https://docs.withorb.com/events-and-metrics/event-ingestion
  - type: APIReference
    url: https://docs.withorb.com/api-reference/event
  - type: Documentation
    url: https://docs.withorb.com/invoicing/structure
  - type: APIReference
    url: https://docs.withorb.com/api-reference/invoice
  - type: APIReference
    url: https://docs.withorb.com/api-reference/credit
  - type: APIReference
    url: https://docs.withorb.com/api-reference/price
  - type: APIReference
    url: https://docs.withorb.com/api-reference/alert
  - type: Documentation
    url: https://docs.withorb.com/guides/integrations-and-exports/webhooks
- aid: orb-billing:orb-billing-automation-webhooks-api
  name: Orb Automation webhooks API
  description: Payloads Orb delivers for automation events. Endpoint configuration, retries and signature verification are
    covered in the [webhooks guide](https://docs.withorb.com/integrations-and-exports/webhooks).
  humanURL: https://docs.withorb.com/api-reference/customer
  baseURL: https://api.withorb.com/v1
  tags:
  - Automation webhooks
  properties:
  - type: OpenAPI
    url: openapi/orb-billing-automation-webhooks-api-openapi.yml
  - type: APIReference
    url: https://docs.withorb.com/api-reference/customer
  - type: PostmanCollection
    url: collections/orb-billing.postman_collection.json
  - type: APIReference
    url: https://docs.withorb.com/api-reference/plan
  - type: APIReference
    url: https://docs.withorb.com/api-reference/subscription
  - type: Documentation
    url: https://docs.withorb.com/events-and-metrics/event-ingestion
  - type: APIReference
    url: https://docs.withorb.com/api-reference/event
  - type: Documentation
    url: https://docs.withorb.com/invoicing/structure
  - type: APIReference
    url: https://docs.withorb.com/api-reference/invoice
  - type: APIReference
    url: https://docs.withorb.com/api-reference/credit
  - type: APIReference
    url: https://docs.withorb.com/api-reference/price
  - type: APIReference
    url: https://docs.withorb.com/api-reference/alert
  - type: Documentation
    url: https://docs.withorb.com/guides/integrations-and-exports/webhooks
- aid: orb-billing:orb-billing-availability-api
  name: Orb Availability API
  description: The Availability API from Orb — 1 operation(s) for availability.
  humanURL: https://docs.withorb.com/api-reference/customer
  baseURL: https://api.withorb.com/v1
  tags:
  - Availability
  properties:
  - type: OpenAPI
    url: openapi/orb-billing-availability-api-openapi.yml
  - type: APIReference
    url: https://docs.withorb.com/api-reference/customer
  - type: PostmanCollection
    url: collections/orb-billing.postman_collection.json
  - type: APIReference
    url: https://docs.withorb.com/api-reference/plan
  - type: APIReference
    url: https://docs.withorb.com/api-reference/subscription
  - type: Documentation
    url: https://docs.withorb.com/events-and-metrics/event-ingestion
  - type: APIReference
    url: https://docs.withorb.com/api-reference/event
  - type: Documentation
    url: https://docs.withorb.com/invoicing/structure
  - type: APIReference
    url: https://docs.withorb.com/api-reference/invoice
  - type: APIReference
    url: https://docs.withorb.com/api-reference/credit
  - type: APIReference
    url: https://docs.withorb.com/api-reference/price
  - type: APIReference
    url: https://docs.withorb.com/api-reference/alert
  - type: Documentation
    url: https://docs.withorb.com/guides/integrations-and-exports/webhooks
- aid: orb-billing:orb-billing-coupon-api
  name: Orb Coupon API
  description: A coupon represents a reusable discount configuration that can be applied either as a fixed or percentage amount
    to an invoice or subscription. Coupons are activated using a redemption code, which applies the discount to a subscription
    or invoice. The duration of a coupon determines how long it remains available for use by end users.
  humanURL: https://docs.withorb.com/api-reference/customer
  baseURL: https://api.withorb.com/v1
  tags:
  - Coupon
  properties:
  - type: OpenAPI
    url: openapi/orb-billing-coupon-api-openapi.yml
  - type: APIReference
    url: https://docs.withorb.com/api-reference/customer
  - type: PostmanCollection
    url: collections/orb-billing.postman_collection.json
  - type: APIReference
    url: https://docs.withorb.com/api-reference/plan
  - type: APIReference
    url: https://docs.withorb.com/api-reference/subscription
  - type: Documentation
    url: https://docs.withorb.com/events-and-metrics/event-ingestion
  - type: APIReference
    url: https://docs.withorb.com/api-reference/event
  - type: Documentation
    url: https://docs.withorb.com/invoicing/structure
  - type: APIReference
    url: https://docs.withorb.com/api-reference/invoice
  - type: APIReference
    url: https://docs.withorb.com/api-reference/credit
  - type: APIReference
    url: https://docs.withorb.com/api-reference/price
  - type: APIReference
    url: https://docs.withorb.com/api-reference/alert
  - type: Documentation
    url: https://docs.withorb.com/guides/integrations-and-exports/webhooks
- aid: orb-billing:orb-billing-credit-api
  name: Orb Credit API
  description: The [Credit Ledger Entry resource](/product-catalog/prepurchase) models prepaid credits within Orb.
  humanURL: https://docs.withorb.com/api-reference/customer
  baseURL: https://api.withorb.com/v1
  tags:
  - Credit
  properties:
  - type: OpenAPI
    url: openapi/orb-billing-credit-api-openapi.yml
  - type: APIReference
    url: https://docs.withorb.com/api-reference/customer
  - type: PostmanCollection
    url: collections/orb-billing.postman_collection.json
  - type: APIReference
    url: https://docs.withorb.com/api-reference/plan
  - type: APIReference
    url: https://docs.withorb.com/api-reference/subscription
  - type: Documentation
    url: https://docs.withorb.com/events-and-metrics/event-ingestion
  - type: APIReference
    url: https://docs.withorb.com/api-reference/event
  - type: Documentation
    url: https://docs.withorb.com/invoicing/structure
  - type: APIReference
    url: https://docs.withorb.com/api-reference/invoice
  - type: APIReference
    url: https://docs.withorb.com/api-reference/credit
  - type: APIReference
    url: https://docs.withorb.com/api-reference/price
  - type: APIReference
    url: https://docs.withorb.com/api-reference/alert
  - type: Documentation
    url: https://docs.withorb.com/guides/integrations-and-exports/webhooks
- aid: orb-billing:orb-billing-credit-note-api
  name: Orb Credit note API
  description: 'The [Credit Note](/invoicing/credit-notes) resource represents a credit that has been applied to a

    particular invoice.'
  humanURL: https://docs.withorb.com/api-reference/customer
  baseURL: https://api.withorb.com/v1
  tags:
  - CreditNote
  tags_raw:
  - Credit note
  properties:
  - type: OpenAPI
    url: openapi/orb-billing-credit-note-api-openapi.yml
  - type: APIReference
    url: https://docs.withorb.com/api-reference/customer
  - type: PostmanCollection
    url: collections/orb-billing.postman_collection.json
  - type: APIReference
    url: https://docs.withorb.com/api-reference/plan
  - type: APIReference
    url: https://docs.withorb.com/api-reference/subscription
  - type: Documentation
    url: https://docs.withorb.com/events-and-metrics/event-ingestion
  - type: APIReference
    url: https://docs.withorb.com/api-reference/event
  - type: Documentation
    url: https://docs.withorb.com/invoicing/structure
  - type: APIReference
    url: https://docs.withorb.com/api-reference/invoice
  - type: APIReference
    url: https://docs.withorb.com/api-reference/credit
  - type: APIReference
    url: https://docs.withorb.com/api-reference/price
  - type: APIReference
    url: https://docs.withorb.com/api-reference/alert
  - type: Documentation
    url: https://docs.withorb.com/guides/integrations-and-exports/webhooks
- aid: orb-billing:orb-billing-customer-api
  name: Orb Customer API
  description: 'A customer is a buyer of your products, and the other party to the billing relationship.


    In Orb, customers are assigned system generated identifiers automatically, but it''s often desirable to have these

    match existing identifiers in your system. To avoid having to denormalize Orb ID information, you can pass in an

    `external_customer_id` with your own identifier. See

    [Customer ID Aliases](/events-and-metrics/customer-aliases) for further information about how these

    aliases work in Orb.


    In addition to having an identifier in your system, a customer may exist in a payment provider solution like

    Stripe. Use the `payment_provider_id` and the `payment_provider` enum field to express this mapping.


    A customer also has a timezone (from the standard [IANA timezone database](https://www.iana.org/time-zones)), which

    defaults to your account''s timezone. See [Timezone localization](/essentials/timezones) for

    information on what this timezone parameter influences within Orb.'
  humanURL: https://docs.withorb.com/api-reference/customer
  baseURL: https://api.withorb.com/v1
  tags:
  - Customers
  tags_raw:
  - Customer
  properties:
  - type: OpenAPI
    url: openapi/orb-billing-customer-api-openapi.yml
  - type: APIReference
    url: https://docs.withorb.com/api-reference/customer
  - type: PostmanCollection
    url: collections/orb-billing.postman_collection.json
  - type: APIReference
    url: https://docs.withorb.com/api-reference/plan
  - type: APIReference
    url: https://docs.withorb.com/api-reference/subscription
  - type: Documentation
    url: https://docs.withorb.com/events-and-metrics/event-ingestion
  - type: APIReference
    url: https://docs.withorb.com/api-reference/event
  - type: Documentation
    url: https://docs.withorb.com/invoicing/structure
  - type: APIReference
    url: https://docs.withorb.com/api-reference/invoice
  - type: APIReference
    url: https://docs.withorb.com/api-reference/credit
  - type: APIReference
    url: https://docs.withorb.com/api-reference/price
  - type: APIReference
    url: https://docs.withorb.com/api-reference/alert
  - type: Documentation
    url: https://docs.withorb.com/guides/integrations-and-exports/webhooks
- aid: orb-billing:orb-billing-customer-webhooks-api
  name: Orb Customer webhooks API
  description: Payloads Orb delivers for customer events. Endpoint configuration, retries and signature verification are covered
    in the [webhooks guide](https://docs.withorb.com/integrations-and-exports/webhooks).
  humanURL: https://docs.withorb.com/api-reference/customer
  baseURL: https://api.withorb.com/v1
  tags:
  - Customer webhooks
  properties:
  - type: OpenAPI
    url: openapi/orb-billing-customer-webhooks-api-openapi.yml
  - type: APIReference
    url: https://docs.withorb.com/api-reference/customer
  - type: PostmanCollection
    url: collections/orb-billing.postman_collection.json
  - type: APIReference
    url: https://docs.withorb.com/api-reference/plan
  - type: APIReference
    url: https://docs.withorb.com/api-reference/subscription
  - type: Documentation
    url: https://docs.withorb.com/events-and-metrics/event-ingestion
  - type: APIReference
    url: https://docs.withorb.com/api-reference/event
  - type: Documentation
    url: https://docs.withorb.com/invoicing/structure
  - type: APIReference
    url: https://docs.withorb.com/api-reference/invoice
  - type: APIReference
    url: https://docs.withorb.com/api-reference/credit
  - type: APIReference
    url: https://docs.withorb.com/api-reference/price
  - type: APIReference
    url: https://docs.withorb.com/api-reference/alert
  - type: Documentation
    url: https://docs.withorb.com/guides/integrations-and-exports/webhooks
- aid: orb-billing:orb-billing-dimensional-price-group-api
  name: Orb Dimensional Price Group API
  description: The Dimensional Price Group API from Orb — 4 operation(s) for dimensional price group.
  humanURL: https://docs.withorb.com/api-reference/customer
  baseURL: https://api.withorb.com/v1
  tags:
  - Dimensional Price Group
  properties:
  - type: OpenAPI
    url: openapi/orb-billing-dimensional-price-group-api-openapi.yml
  - type: APIReference
    url: https://docs.withorb.com/api-reference/customer
  - type: PostmanCollection
    url: collections/orb-billing.postman_collection.json
  - type: APIReference
    url: https://docs.withorb.com/api-reference/plan
  - type: APIReference
    url: https://docs.withorb.com/api-reference/subscription
  - type: Documentation
    url: https://docs.withorb.com/events-and-metrics/event-ingestion
  - type: APIReference
    url: https://docs.withorb.com/api-reference/event
  - type: Documentation
    url: https://docs.withorb.com/invoicing/structure
  - type: APIReference
    url: https://docs.withorb.com/api-reference/invoice
  - type: APIReference
    url: https://docs.withorb.com/api-reference/credit
  - type: APIReference
    url: https://docs.withorb.com/api-reference/price
  - type: APIReference
    url: https://docs.withorb.com/api-reference/alert
  - type: Documentation
    url: https://docs.withorb.com/guides/integrations-and-exports/webhooks
- aid: orb-billing:orb-billing-dunning-webhooks-api
  name: Orb Dunning webhooks API
  description: Payloads Orb delivers for dunning events. Endpoint configuration, retries and signature verification are covered
    in the [webhooks guide](https://docs.withorb.com/integrations-and-exports/webhooks).
  humanURL: https://docs.withorb.com/api-reference/customer
  baseURL: https://api.withorb.com/v1
  tags:
  - Dunning webhooks
  properties:
  - type: OpenAPI
    url: openapi/orb-billing-dunning-webhooks-api-openapi.yml
  - type: APIReference
    url: https://docs.withorb.com/api-reference/customer
  - type: PostmanCollection
    url: collections/orb-billing.postman_collection.json
  - type: APIReference
    url: https://docs.withorb.com/api-reference/plan
  - type: APIReference
    url: https://docs.withorb.com/api-reference/subscription
  - type: Documentation
    url: https://docs.withorb.com/events-and-metrics/event-ingestion
  - type: APIReference
    url: https://docs.withorb.com/api-reference/event
  - type: Documentation
    url: https://docs.withorb.com/invoicing/structure
  - type: APIReference
    url: https://docs.withorb.com/api-reference/invoice
  - type: APIReference
    url: https://docs.withorb.com/api-reference/credit
  - type: APIReference
    url: https://docs.withorb.com/api-reference/price
  - type: APIReference
    url: https://docs.withorb.com/api-reference/alert
  - type: Documentation
    url: https://docs.withorb.com/guides/integrations-and-exports/webhooks
- aid: orb-billing:orb-billing-event-api
  name: Orb Event API
  description: 'The [Event](/core-concepts#event) resource represents a usage event that has been created for a

    customer. Events are the core of Orb''s usage-based billing model, and are used to calculate the usage charges for

    a given billing period.'
  humanURL: https://docs.withorb.com/api-reference/customer
  baseURL: https://api.withorb.com/v1
  tags:
  - Event
  properties:
  - type: OpenAPI
    url: openapi/orb-billing-event-api-openapi.yml
  - type: APIReference
    url: https://docs.withorb.com/api-reference/customer
  - type: PostmanCollection
    url: collections/orb-billing.postman_collection.json
  - type: APIReference
    url: https://docs.withorb.com/api-reference/plan
  - type: APIReference
    url: https://docs.withorb.com/api-reference/subscription
  - type: Documentation
    url: https://docs.withorb.com/events-and-metrics/event-ingestion
  - type: APIReference
    url: https://docs.withorb.com/api-reference/event
  - type: Documentation
    url: https://docs.withorb.com/invoicing/structure
  - type: APIReference
    url: https://docs.withorb.com/api-reference/invoice
  - type: APIReference
    url: https://docs.withorb.com/api-reference/credit
  - type: APIReference
    url: https://docs.withorb.com/api-reference/price
  - type: APIReference
    url: https://docs.withorb.com/api-reference/alert
  - type: Documentation
    url: https://docs.withorb.com/guides/integrations-and-exports/webhooks
- aid: orb-billing:orb-billing-invoice-and-credit-note-webhooks-api
  name: Orb Invoice and credit note webhooks API
  description: Payloads Orb delivers for invoice & credit note events. Endpoint configuration, retries and signature verification
    are covered in the [webhooks guide](https://docs.withorb.com/integrations-and-exports/webhooks).
  humanURL: https://docs.withorb.com/api-reference/customer
  baseURL: https://api.withorb.com/v1
  tags:
  - Invoice and credit note webhooks
  properties:
  - type: OpenAPI
    url: openapi/orb-billing-invoice-and-credit-note-webhooks-api-openapi.yml
  - type: APIReference
    url: https://docs.withorb.com/api-reference/customer
  - type: PostmanCollection
    url: collections/orb-billing.postman_collection.json
  - type: APIReference
    url: https://docs.withorb.com/api-reference/plan
  - type: APIReference
    url: https://docs.withorb.com/api-reference/subscription
  - type: Documentation
    url: https://docs.withorb.com/events-and-metrics/event-ingestion
  - type: APIReference
    url: https://docs.withorb.com/api-reference/event
  - type: Documentation
    url: https://docs.withorb.com/invoicing/structure
  - type: APIReference
    url: https://docs.withorb.com/api-reference/invoice
  - type: APIReference
    url: https://docs.withorb.com/api-reference/credit
  - type: APIReference
    url: https://docs.withorb.com/api-reference/price
  - type: APIReference
    url: https://docs.withorb.com/api-reference/alert
  - type: Documentation
    url: https://docs.withorb.com/guides/integrations-and-exports/webhooks
- aid: orb-billing:orb-billing-invoice-api
  name: Orb Invoice API
  description: 'An [`Invoice`](/core-concepts#invoice) is a fundamental billing entity, representing the request for payment
    for

    a single subscription. This includes a set of line items, which correspond to prices in the subscription''s plan and

    can represent fixed recurring fees or usage-based fees. They are generated at the end of a billing period, or as

    the result of an action, such as a cancellation.'
  humanURL: https://docs.withorb.com/api-reference/customer
  baseURL: https://api.withorb.com/v1
  tags:
  - Invoices
  tags_raw:
  - Invoice
  properties:
  - type: OpenAPI
    url: openapi/orb-billing-invoice-api-openapi.yml
  - type: APIReference
    url: https://docs.withorb.com/api-reference/customer
  - type: PostmanCollection
    url: collections/orb-billing.postman_collection.json
  - type: APIReference
    url: https://docs.withorb.com/api-reference/plan
  - type: APIReference
    url: https://docs.withorb.com/api-reference/subscription
  - type: Documentation
    url: https://docs.withorb.com/events-and-metrics/event-ingestion
  - type: APIReference
    url: https://docs.withorb.com/api-reference/event
  - type: Documentation
    url: https://docs.withorb.com/invoicing/structure
  - type: APIReference
    url: https://docs.withorb.com/api-reference/invoice
  - type: APIReference
    url: https://docs.withorb.com/api-reference/credit
  - type: APIReference
    url: https://docs.withorb.com/api-reference/price
  - type: APIReference
    url: https://docs.withorb.com/api-reference/alert
  - type: Documentation
    url: https://docs.withorb.com/guides/integrations-and-exports/webhooks
- aid: orb-billing:orb-billing-item-api
  name: Orb Item API
  description: 'The Item resource represents a sellable product or good. Items are associated with all line items, billable
    metrics,

    and prices and are used for defining external sync behavior for invoices and tax calculation purposes.'
  humanURL: https://docs.withorb.com/api-reference/customer
  baseURL: https://api.withorb.com/v1
  tags:
  - Item
  properties:
  - type: OpenAPI
    url: openapi/orb-billing-item-api-openapi.yml
  - type: APIReference
    url: https://docs.withorb.com/api-reference/customer
  - type: PostmanCollection
    url: collections/orb-billing.postman_collection.json
  - type: APIReference
    url: https://docs.withorb.com/api-reference/plan
  - type: APIReference
    url: https://docs.withorb.com/api-reference/subscription
  - type: Documentation
    url: https://docs.withorb.com/events-and-metrics/event-ingestion
  - type: APIReference
    url: https://docs.withorb.com/api-reference/event
  - type: Documentation
    url: https://docs.withorb.com/invoicing/structure
  - type: APIReference
    url: https://docs.withorb.com/api-reference/invoice
  - type: APIReference
    url: https://docs.withorb.com/api-reference/credit
  - type: APIReference
    url: https://docs.withorb.com/api-reference/price
  - type: APIReference
    url: https://docs.withorb.com/api-reference/alert
  - type: Documentation
    url: https://docs.withorb.com/guides/integrations-and-exports/webhooks
- aid: orb-billing:orb-billing-license-api
  name: Orb License API
  description: The License API from Orb — 7 operation(s) for license.
  humanURL: https://docs.withorb.com/api-reference/customer
  baseURL: https://api.withorb.com/v1
  tags:
  - License
  properties:


# --- truncated at 32 KB (53 KB total) ---
# Full source: https://artifacts.apis.io/orb-billing/apis.yml

Orb API — frequently asked questions

Does Orb have an API?

Yes. APIs.io lists 32 APIs from Orb, including Orb Alerts API, Orb Credits API and Orb Events API, and 29 more.

Is there an OpenAPI specification for the Orb API?

Yes. APIs.io indexes 32 OpenAPI specifications for Orb, each linked for download from this page.

How do I authenticate with the Orb API?

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

How much does the Orb API cost?

Orb publishes its prices; its Business plan is $6.00 per credit, or less with volume discounts as of 2026-11-11. APIs.io lists 3 pricing plans for Orb, with each plan's price, limits and inclusions under Pricing on this page.

Does Orb have an MCP server?

Yes. APIs.io lists 1 MCP server for Orb: Orb's hosted Model Context Protocol server. Exposes 100+ Orb API operations as tools (customers, subscriptions, plans and prices, billable metrics, invoices, credits, alerts, licenses, event search, p

Is the Orb API ready for AI agents?

Orb has a Kin Score of 69.9 out of 100 (exemplar) and an Agent Readiness score of 47.9 (agent-ready), 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/orb-billing"

All providers

curl "https://apis.io/api/v1/providers?limit=25"

Every operation they expose

curl "https://apis.io/api/v1/providers/orb-billing/operations?limit=25"

How their score was established

curl "https://apis.io/api/v1/providers/orb-billing/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.

GitHub Google LinkedIn

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