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

Octane Customer Portal API

End-customer portal operations

Octane Customer Portal API is one of 17 APIs that Octane publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Customer Portal. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 18 operations across 11 paths, and defines 16 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.

18 operations 11 paths 16 schemas 9 GET6 POST3 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
Resource Areas
1

Authentication & Security 1

Octane Customer Portal 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 18

Across 11 paths, the API surfaces 18 operations — 9 GET, 6 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Customer Portal 18

End-customer portal operations

GET
/customer_portal_settings
Get Customer Portal Settings
customerPortalSettingsGet → 200
POST
/customer_portal_settings
Create Customer Portal Settings
customerPortalSettingsPost body → 200
GET
/ecp/active_subscription
Get ECP Active Subscription
ecpActiveSubscriptionGet → 200
POST
/ecp/active_subscription
Update ECP Active Subscription
ecpActiveSubscriptionPost body → 200
POST
/ecp/active_subscription/add_ons
Add Add-Ons to ECP Subscription
ecpActiveSubscriptionAddOnsPost body → 200
GET
/ecp/contact_info
Get ECP Contact Info
ecpContactInfoGet → 200
PUT
/ecp/contact_info
Update ECP Contact Info
ecpContactInfoPut body → 200
GET
/ecp/credit/available_balance
Get ECP Credit Balance
ecpCreditAvailableBalanceGet → 200
GET
/ecp/credit_grants
Get ECP Credit Grants
ecpCreditGrantsGet → 200
GET
/ecp/credit/ledger
Get ECP Credit Ledger
ecpCreditLedgerGet → 200
POST
/ecp/credit/purchase
Purchase Credits (ECP)
ecpCreditPurchasePost body → 200
GET
/ecp/credit_top_off_plan
Get ECP Credit Top-Off Plan
ecpCreditTopOffPlanGet → 200
GET
/self_serve_settings
Get Self-Serve Settings
selfServeSettingsGet → 200
POST
/self_serve_settings
Create Self-Serve Settings
selfServeSettingsPost body → 200
PUT
/self_serve_settings
Update Self-Serve Settings
selfServeSettingsPut body → 200
GET
/self_serve_settings/customization
Get Self-Serve Customization
selfServeSettingsCustomizationGet → 200
POST
/self_serve_settings/customization
Create Self-Serve Customization
selfServeSettingsCustomizationPost body → 200
PUT
/self_serve_settings/customization
Update Self-Serve Customization
selfServeSettingsCustomizationPut body → 200

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are ActiveSubscription (18 properties), PricePlan (17 properties), CreateSubscriptionArgs (13 properties), ContactInfoInputArgs (13 properties). Each schema is shown below with its type and property counts.

BillingCycleDate
object
2 properties
ContactInfo
object
13 properties
CreateSubscriptionArgs
object
13 properties
Trial
object
3 properties
TrialInputArgs
object
3 properties
PriceTier
object
A price tier within a tiered pricing scheme.
2 properties
Limit
object
2 properties 2 required
ContactInfoInputArgs
object
13 properties
ActiveSubscription
object
18 properties 4 required
CreditTopOffPlan
object
4 properties
PricePlan
object
17 properties 3 required
MeteredComponent
object
10 properties 4 required
Feature
object
3 properties 1 required
DiscountInputArgs
object
8 properties
PriceScheme
object
Pricing scheme configuration for a metered component.
4 properties
AddOn
object
10 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

octane-customer-portal-api-openapi.yml Raw ↑

Other APIs Octane publishes across the network.

Octane Admin API
Octane Avalara API
Octane Billing Settings API
Octane Coupons API
Octane Credits API
Octane Customers API
Octane Features API
Octane Invoices API
Octane Live Measurements API
Octane Measurements API
Octane Meters API
Octane Price Plans API
Where this information came from

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