How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Orb Credits API

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

Orb Credits API is one of 21 APIs that Orb publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Credits. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 5 operations across 4 paths, and defines 8 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, https://api.withorb.com/v1.

5 operations 4 paths 8 schemas 3 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.withorb.com/v1
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

Orb Credits API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Authenticate with an Orb API key sent as a Bearer token in the Authorization header: Authorization: Bearer .

Paths & Operations 5

Across 4 paths, the API surfaces 5 operations — 3 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Credits 5
GET
/customers/{customer_id}/credits
Fetch customer credit balance
fetchCustomerCredits 1 param → 200
GET
/customers/{customer_id}/credits/ledger
Fetch customer credits ledger
fetchCustomerCreditsLedger 3 params → 200
POST
/customers/{customer_id}/credits/ledger_entries
Create ledger entry
createLedgerEntry 1 param body → 201
POST
/customers/{customer_id}/credits/top_ups
Create top-up
createTopUp 1 param body → 201
GET
/customers/{customer_id}/credits/top_ups
List top-ups
listTopUps 1 param → 200

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are LedgerEntry (9 properties), LedgerEntryCreate (7 properties), TopUpCreate (6 properties), CreditBlock (6 properties). Each schema is shown below with its type and property counts.

CreditBlockList
object
2 properties
CreditBlock
object
6 properties
TopUpCreate
object
6 properties 4 required
LedgerEntry
object
9 properties
TopUp
object
6 properties
LedgerEntryCreate
object
7 properties 1 required
LedgerEntryList
object
2 properties
PaginationMetadata
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

orb-billing-credits-api-openapi.yml Raw ↑

Other APIs Orb publishes across the network.

Orb Alerts API
Orb Coupons API
Orb Customers API
Orb Events API
Orb Invoices API
Orb Items API
Orb Metrics API
Orb Plans API
Orb Prices API
Orb Subscriptions API
Orb Alerts API
Orb Availability API
Where this information came from

This is an independent, third-party profile of Orb Credits API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.