# Orb Credit API

**Canonical:** https://apis.io/apis/orb-billing/orb-billing-credit-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 Credit 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 Credit. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, and API documentation.

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

## Operations (18)

| Method | Path | Summary |
|---|---|---|
| GET | `/credit_blocks/{block_id}` | Fetch credit block |
| PUT | `/credit_blocks/{block_id}` | Update credit block |
| DELETE | `/credit_blocks/{block_id}` | Delete credit block |
| GET | `/credit_blocks/{block_id}/invoices` | List invoices for credit block |
| GET | `/customers/external_customer_id/{external_customer_id}/credits` | Fetch customer credit balance by external customer id |
| GET | `/customers/external_customer_id/{external_customer_id}/credits/balance` | Fetch customer credit balance summary by external customer id |
| GET | `/customers/external_customer_id/{external_customer_id}/credits/ledger` | Fetch customer credits ledger by external ID |
| POST | `/customers/external_customer_id/{external_customer_id}/credits/ledger_entry` | Create ledger entry by external ID |
| GET | `/customers/external_customer_id/{external_customer_id}/credits/top_ups` | List top-ups by external ID |
| POST | `/customers/external_customer_id/{external_customer_id}/credits/top_ups` | Create top-up by external ID |
| DELETE | `/customers/external_customer_id/{external_customer_id}/credits/top_ups/{top_up_id}` | Deactivate top-up by external ID |
| GET | `/customers/{customer_id}/credits` | Fetch customer credit balance |
| GET | `/customers/{customer_id}/credits/balance` | Fetch customer credit balance summary |
| GET | `/customers/{customer_id}/credits/ledger` | Fetch customer credits ledger |
| POST | `/customers/{customer_id}/credits/ledger_entry` | Create ledger entry |
| GET | `/customers/{customer_id}/credits/top_ups` | List top-ups |
| POST | `/customers/{customer_id}/credits/top_ups` | Create top-up |
| DELETE | `/customers/{customer_id}/credits/top_ups/{top_up_id}` | Deactivate top-up |

## Machine-readable artifacts (13)

- **OpenAPI** — https://artifacts.apis.io/orb-billing/openapi/orb-billing-credit-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 note API](https://apis.io/apis/orb-billing/orb-billing-credit-note-api/)
- [Orb Customer API](https://apis.io/apis/orb-billing/orb-billing-customer-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

Credit

---

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