# Orb Customer API

**Canonical:** https://apis.io/apis/orb-billing/orb-billing-customer-api/  
**Provider:** Orb — https://apis.io/providers/orb-billing/  
**Base URL:** https://api.withorb.com/v1  
**Documentation:** https://docs.withorb.com/api-reference/customer

Orb Customer API is one of 32 APIs that [Orb](https://apis.io/providers/orb-billing/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Customers. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, and API documentation.

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.

## Operations (15)

| Method | Path | Summary |
|---|---|---|
| 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 |

## Machine-readable artifacts (13)

- **OpenAPI** — https://artifacts.apis.io/orb-billing/openapi/orb-billing-customer-api-openapi.yml
- **APIReference** — https://docs.withorb.com/api-reference/customer
- **PostmanCollection** — https://artifacts.apis.io/orb-billing/collections/orb-billing.postman_collection.json
- **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

## Other Orb APIs (12)

- [Orb Alerts API](https://apis.io/apis/orb-billing/orb-billing-alerts-api/)
- [Orb Credits API](https://apis.io/apis/orb-billing/orb-billing-credits-api/)
- [Orb Events API](https://apis.io/apis/orb-billing/orb-billing-events-api/)
- [Orb Accounting sync webhooks API](https://apis.io/apis/orb-billing/orb-billing-accounting-sync-webhooks-api/)
- [Orb Alert API](https://apis.io/apis/orb-billing/orb-billing-alert-api/)
- [Orb Automation webhooks API](https://apis.io/apis/orb-billing/orb-billing-automation-webhooks-api/)
- [Orb Availability API](https://apis.io/apis/orb-billing/orb-billing-availability-api/)
- [Orb Coupon API](https://apis.io/apis/orb-billing/orb-billing-coupon-api/)
- [Orb Credit API](https://apis.io/apis/orb-billing/orb-billing-credit-api/)
- [Orb Credit note API](https://apis.io/apis/orb-billing/orb-billing-credit-note-api/)
- [Orb Customer webhooks API](https://apis.io/apis/orb-billing/orb-billing-customer-webhooks-api/)
- [Orb Dimensional Price Group API](https://apis.io/apis/orb-billing/orb-billing-dimensional-price-group-api/)

## Tags

Customers

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/orb-billing/orb-billing-customer-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/orb-billing/.