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

Ordway Customers API

Manage billing customers and their contacts, notes, and payment methods

Ordway Customers API is one of 21 APIs that Ordway publishes on the 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 and API documentation.

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

Requests are made against 2 base URLs: https://api.ordwaylabs.com/api/v1, https://staging.ordwaylabs.com/api/v1.

7 operations 4 paths 5 schemas 1 DELETE4 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://api.ordwaylabs.com/api/v1
Authentication
API Key, API Key, API Key, API Key
Terms of Service
Resource Areas
1

Authentication & Security 4

Ordway Customers API declares 4 security schemes for authenticating requests. An API key is passed in the header as X-API-KEY (ApiKeyAuth). An API key is passed in the header as X-User-Token (UserTokenAuth). An API key is passed in the header as X-User-Email (UserEmailAuth). An API key is passed in the header as X-User-Company (CompanyAuth). By default, every request must be authenticated.

  • ApiKeyAuth — Ordway API key
  • UserTokenAuth — Ordway user authentication token
  • UserEmailAuth — Ordway user email address
  • CompanyAuth — Ordway company identifier

Paths & Operations 7

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

Customers 7

Manage billing customers and their contacts, notes, and payment methods

GET
/customers
List customers
listCustomers 3 params → 200401
POST
/customers
Create a customer
createCustomer body → 201401422
GET
/customers/{id}
Retrieve a customer
getCustomer 1 param → 200404
PUT
/customers/{id}
Update a customer
updateCustomer 1 param body → 200404
DELETE
/customers/{id}
Delete a customer
deleteCustomer 1 param → 204404
GET
/customers/{id}/contacts
List contacts for a customer
listCustomerContacts 1 param → 200404
GET
/customers/{id}/customer_notes
List notes for a customer
listCustomerNotes 1 param → 200404

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are Customer (35 properties), Contact (23 properties), CustomerInput (13 properties), CustomerNote (9 properties). Each schema is shown below with its type and property counts.

Error
object
2 properties
Contact
object
23 properties 3 required
Customer
object
35 properties 2 required
CustomerNote
object
9 properties 3 required
CustomerInput
object
13 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ordway-customers-api-openapi.yml Raw ↑

Other APIs Ordway publishes across the network.

Ordway Billing Runs API
Ordway Billing Schedules API
Ordway Chart of Accounts API
Ordway Coupons API
Ordway Credits API
Ordway Debit Memos API
Ordway Invoices API
Ordway Journal Entries API
Ordway Orders API
Ordway Payment Runs API
Ordway Payments API
Ordway Plans API
Where this information came from

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