Ordway Subscriptions API
Manage subscription lifecycle and charges
Manage subscription lifecycle and charges
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/ordway-subscriptions-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Ordway REST Billing Runs Subscriptions API
description: RESTful API for bidirectional integration with the Ordway billing and revenue automation platform. Enables managing customers, subscriptions, invoices, payments, usage data, and revenue recognition schedules. Supports usage-based billing, ASC 606 compliant revenue recognition, accounts receivable automation, and SaaS metrics reporting.
version: v1
contact:
name: Ordway Support
url: https://support.ordwaylabs.com
termsOfService: https://ordwaylabs.com/
servers:
- url: https://api.ordwaylabs.com/api/v1
description: Production
- url: https://staging.ordwaylabs.com/api/v1
description: Staging
security:
- ApiKeyAuth: []
UserTokenAuth: []
UserEmailAuth: []
CompanyAuth: []
tags:
- name: Subscriptions
description: Manage subscription lifecycle and charges
paths:
/subscriptions:
get:
summary: List subscriptions
operationId: listSubscriptions
tags:
- Subscriptions
parameters:
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/size'
- $ref: '#/components/parameters/sort'
- name: updated_date>
in: query
description: Filter subscriptions updated after this date-time (ISO 8601)
schema:
type: string
format: date-time
responses:
'200':
description: List of subscriptions
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Subscription'
'401':
$ref: '#/components/responses/Unauthorized'
post:
summary: Create a subscription
operationId: createSubscription
tags:
- Subscriptions
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SubscriptionInput'
responses:
'201':
description: Subscription created
content:
application/json:
schema:
$ref: '#/components/schemas/Subscription'
'422':
$ref: '#/components/responses/UnprocessableEntity'
/subscriptions/{id}:
get:
summary: Retrieve a subscription
operationId: getSubscription
tags:
- Subscriptions
parameters:
- $ref: '#/components/parameters/id'
responses:
'200':
description: Subscription details
content:
application/json:
schema:
$ref: '#/components/schemas/Subscription'
'404':
$ref: '#/components/responses/NotFound'
put:
summary: Update a subscription
operationId: updateSubscription
tags:
- Subscriptions
parameters:
- $ref: '#/components/parameters/id'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SubscriptionInput'
responses:
'200':
description: Subscription updated
content:
application/json:
schema:
$ref: '#/components/schemas/Subscription'
'404':
$ref: '#/components/responses/NotFound'
components:
responses:
Unauthorized:
description: Authentication credentials missing or invalid
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
NotFound:
description: Resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
UnprocessableEntity:
description: Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
schemas:
Error:
type: object
properties:
error:
type: string
errors:
type: object
additionalProperties: true
Subscription:
type: object
required:
- company_id
- subscription_id
- subscription_line_id
properties:
company_id:
type: string
subscription_id:
type: string
subscription_line_id:
type: string
customer_id:
type: string
status:
type:
- string
- 'null'
billing_start_date:
type:
- string
- 'null'
format: date
service_start_date:
type:
- string
- 'null'
format: date
contract_effective_date:
type:
- string
- 'null'
format: date
cancellation_date:
type:
- string
- 'null'
format: date
auto_renew:
type:
- boolean
- 'null'
currency:
type:
- string
- 'null'
payment_terms:
type:
- string
- 'null'
cmrr:
type:
- number
- 'null'
discounted_cmrr:
type:
- number
- 'null'
product_id:
type:
- string
- 'null'
product_name:
type:
- string
- 'null'
plan_name:
type:
- string
- 'null'
charge_id:
type:
- string
- 'null'
charge_name:
type:
- string
- 'null'
pricing_model:
type:
- string
- 'null'
list_price:
type:
- number
- 'null'
quantity:
type:
- number
- 'null'
discount:
type:
- number
- 'null'
effective_price:
type:
- number
- 'null'
charge_type:
type:
- string
- 'null'
billing_period:
type:
- string
- 'null'
current_period_start_date:
type:
- string
- 'null'
format: date
current_period_end_date:
type:
- string
- 'null'
format: date
contract_term:
type:
- string
- 'null'
renewal_term:
type:
- string
- 'null'
version:
type:
- integer
- 'null'
custom_fields:
type:
- object
- 'null'
additionalProperties: true
created_by:
type:
- string
- 'null'
updated_by:
type:
- string
- 'null'
created_date:
type:
- string
- 'null'
format: date-time
updated_date:
type:
- string
- 'null'
format: date-time
SubscriptionInput:
type: object
properties:
customer_id:
type: string
status:
type: string
billing_start_date:
type: string
format: date
service_start_date:
type: string
format: date
auto_renew:
type: boolean
currency:
type: string
payment_terms:
type: string
custom_fields:
type: object
additionalProperties: true
parameters:
size:
name: size
in: query
description: Number of records per page
schema:
type: integer
minimum: 1
maximum: 500
default: 50
sort:
name: sort
in: query
description: Comma-separated list of fields to sort by (prefix with - for descending)
schema:
type: string
page:
name: page
in: query
description: Page number for pagination (1-based)
schema:
type: integer
minimum: 1
default: 1
id:
name: id
in: path
required: true
description: Resource identifier
schema:
type: string
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: X-API-KEY
description: Ordway API key
UserTokenAuth:
type: apiKey
in: header
name: X-User-Token
description: Ordway user authentication token
UserEmailAuth:
type: apiKey
in: header
name: X-User-Email
description: Ordway user email address
CompanyAuth:
type: apiKey
in: header
name: X-User-Company
description: Ordway company identifier
externalDocs:
description: Ordway API Documentation
url: https://ordwaylabs.stoplight.io/docs/ordway/ZG9jOjQ4OTgxNg-overview