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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Octane

Octane Credits API

Manage customer credit grants and ledgers

Documentation Provider Profile APIs.io OpenAPI GitHub

Octane Credits API is one of 17 APIs that Octane 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 and API documentation.

This API exposes 11 operations across 7 paths, and defines 4 schemas. It is described by OpenAPI 3.0.3, at version 1.0.0.

Requests are made against a single base URL, https://api.getoctane.io.

11 operations 7 paths 4 schemas 1 DELETE5 GET4 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.0
Base URL
https://api.getoctane.io
Authentication
HTTP Bearer
Contact
Octane Support
Resource Areas
1

Authentication & Security 1

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

  • BearerApiKeyAuth — API key passed as a Bearer token in the Authorization header.

Paths & Operations 11

Across 7 paths, the API surfaces 11 operations — 1 DELETE, 5 GET, 4 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Credits 11

Manage customer credit grants and ledgers

GET
/customers/{customer_name}/credit_balance
Get Customer Credit Balance
customersCustomerNameCreditBalanceGet 1 param → 200
GET
/customers/{customer_name}/credit_top_off_plan
Get Customer Credit Top-Off Plan
customersCustomerNameCreditTopOffPlanGet 1 param → 200
POST
/customers/{customer_name}/credit_top_off_plan
Create Customer Credit Top-Off Plan
customersCustomerNameCreditTopOffPlanPost 1 param body → 200
PUT
/customers/{customer_name}/credit_top_off_plan
Update Customer Credit Top-Off Plan
customersCustomerNameCreditTopOffPlanPut 1 param body → 200
DELETE
/customers/{customer_name}/credit_top_off_plan
Delete Customer Credit Top-Off Plan
customersCustomerNameCreditTopOffPlanDelete 1 param → 204
GET
/credits/grant
List Credit Grants
creditsGrantGet → 200
POST
/credits/grant
Create Credit Grant
creditsGrantPost body → 200
POST
/credits/grant/{grant_uuid}/grant
Issue Credit Grant
creditsGrantGrantUuidGrantPost 1 param → 200
POST
/credits/grant/{grant_uuid}/void
Void Credit Grant
creditsGrantGrantUuidVoidPost 1 param → 200
GET
/credits/ledger/{customer_name}
Get Customer Credit Ledger
creditsLedgerCustomerNameGet 1 param → 200
GET
/credits/ledger/{customer_name}/{as_of_str}
Get Customer Credit Ledger As Of Date
creditsLedgerCustomerNameAsOfStrGet 2 params → 200

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are CreateCreditGrantArgs (4 properties), CreditTopOffPlan (4 properties), CreateCreditTopOffPlanInputArgs (3 properties), CustomerCreditBalance (2 properties). Each schema is shown below with its type and property counts.

CustomerCreditBalance
object
2 properties
CreditTopOffPlan
object
4 properties
CreateCreditGrantArgs
object
4 properties
CreateCreditTopOffPlanInputArgs
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

octane-credits-api-openapi.yml Raw ↑

Other APIs Octane publishes across the network.

Octane Admin API
AE Profile APIs.io
Octane Avalara API
AE Profile APIs.io
Octane Billing Settings API
AE Profile APIs.io
Octane Coupons API
AE Profile APIs.io
Octane Customer Portal API
AE Profile APIs.io
Octane Customers API
AE Profile APIs.io
Octane Features API
AE Profile APIs.io
Octane Invoices API
AE Profile APIs.io
Octane Live Measurements API
AE Profile APIs.io
Octane Measurements API
AE Profile APIs.io
Octane Meters API
AE Profile APIs.io
Octane Price Plans API
AE Profile APIs.io
#Credits
← Back to O APIs
API Details
ID
octane:octane-credits-api
Base URL
https://api.getoctane.io
Docs
https://docs.getoctane.io
Provider
Octane
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=octane-credits-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/octane-credits-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of Octane 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.