Orb

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

GitHub OpenAPI

Operations 15

GET /customers List customers #
POST /customers Create customer #
GET /customers/external_customer_id/{external_customer_id} Fetch customer by external ID #
PUT /customers/external_customer_id/{external_customer_id} Update customer by external ID #
GET /customers/external_customer_id/{external_customer_id}/costs Fetch customer costs by external ID #
POST /customers/external_customer_id/{external_customer_id}/portal_sessions Create portal session by external ID #
POST /customers/external_customer_id/{external_customer_id}/sync_payment_methods_from_gateway Update payment methods from payment provider #
GET /customers/{customer_id} Fetch customer #
PUT /customers/{customer_id} Update customer #
DELETE /customers/{customer_id} Delete customer #
GET /customers/{customer_id}/balance_transactions List balance transactions #
POST /customers/{customer_id}/balance_transactions Create customer balance transaction #
GET /customers/{customer_id}/costs Fetch customer costs #
POST /customers/{customer_id}/portal_sessions Create portal session #
POST /customers/{customer_id}/sync_payment_methods_from_gateway Update payment methods from payment provider #

Documentation

📖
APIReference
https://docs.withorb.com/api-reference/customer
📖
APIReference
https://docs.withorb.com/api-reference/plan
📖
APIReference
https://docs.withorb.com/api-reference/subscription
📖
Documentation
https://docs.withorb.com/events-and-metrics/event-ingestion
📖
APIReference
https://docs.withorb.com/api-reference/event
📖
Documentation
https://docs.withorb.com/invoicing/structure
📖
APIReference
https://docs.withorb.com/api-reference/invoice
📖
APIReference
https://docs.withorb.com/api-reference/credit
📖
APIReference
https://docs.withorb.com/api-reference/price
📖
APIReference
https://docs.withorb.com/api-reference/alert
📖
Documentation
https://docs.withorb.com/guides/integrations-and-exports/webhooks

Specifications

⚙
OpenAPI
https://artifacts.apis.io/orb-billing/openapi/orb-billing-customer-api-openapi.yml

Other Resources

🔗
PostmanCollection
https://artifacts.apis.io/orb-billing/collections/orb-billing.postman_collection.json

Work with this as data

Every API 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 apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • 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 API 
curl "https://apis.io/api/v1/apis/orb-billing:orb-billing-customer-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

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.

OpenAPI Specification

orb-billing-customer-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Reference Customer API
  description: 'Orb''s API is built with the following principles in mind:


    1. **Predictable developer experience**: Where applicable, the Orb API uses industry-standard patterns such as

    cursor-based pagination and standardized error output. To help with debugging in critical API

    actions, the API always strives to provide detailed and actionable error messages. Aliases

    such as external customer IDs aid in fast integration times.

    2. **Reliably real time**: Orb''s event-based APIs, such as event ingestion are designed to handle extremely high

    throughput and scale with concurrent load. Orb also provides a real-time event-level credits

    ledger and a highly performant webhooks architecture.

    3. **Flexibility at the forefront**: Features like timezone localization and the ability to amend historical usage

    show the flexible nature of the platform.


    You can download the latest OpenAPI spec here - pass `?version=3.0` for an

    OpenAPI 3.0-compatible spec.'
  contact:
    name: Orb, Inc.
    url: https://www.withorb.com/
    email: team@withorb.com
  version: '1.0'
servers:
- url: https://api.withorb.com/v1
  description: Production server
security:
- APIKeyAuth: []
tags:


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