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

Cacheflow Subscriptions API

The Subscriptions API from Cacheflow — 16 operation(s) for subscriptions.

Cacheflow Subscriptions API is one of 57 APIs that Cacheflow publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Subscription. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, authentication docs, and rate-limit docs.

This API exposes 21 operations across 16 paths, and defines 75 schemas. It is described by OpenAPI 3.2.0, at version 0.0.3.

Requests are made against 2 base URLs: https://api.getcacheflow.com, https://api.sandbox.getcacheflow.com.

21 operations 16 paths 75 schemas 1 DELETE11 GET1 PATCH6 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
0.0.3
Base URL
https://api.getcacheflow.com
Resource Areas
1

Paths & Operations 21

Across 16 paths, the API surfaces 21 operations — 1 DELETE, 11 GET, 1 PATCH, 6 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Subscriptions 21
GET
/api/latest/data/customers/{id}/contracts
List subscriptions for a customer
getCustomerContracts 1 param → 200
POST
/api/latest/data/contracts/archive
Archive subscriptions
archiveSubscriptions body → 200
POST
/api/latest/data/contracts/{id}/auto-renew
Auto renew a subscription
autoRenewContract 1 param → 200
PUT
/api/latest/data/contracts/{id}/billing-method
Update a subscription's billing method
updateBillingMethod 1 param body → 200
POST
/api/latest/data/contracts/{id}/billing-method
Create a payment method for a subscription
createBillingMethod 1 param body → 201
GET
/api/latest/data/contracts
List subscriptions
listContracts 5 params → 200
POST
/api/latest/data/contracts
Create a subscription
createContract body → 201
GET
/api/latest/data/contracts/{id}/proposals
List proposals for a subscription
getContractProposals 1 param → 200
POST
/api/latest/data/contracts/{id}/proposals
Create change proposal for a subscription
createContractProposal 4 params → 200
GET
/api/latest/data/contracts/{id}
Retrieve a subscription
getContract 1 param → 200
DELETE
/api/latest/data/contracts/{id}
Delete a subscription
deleteContract 1 param → 200
PATCH
/api/latest/data/contracts/{id}
Update a subscription
updateContract 1 param body → 200
GET
/api/latest/data/contracts/{id}/events
Retrieve events for a subscription
getContractEvents 1 param → 200
GET
/api/latest/data/contracts/{id}/payments
Retrieve payments for a subscription
getContractPayments 1 param → 200
GET
/api/latest/data/contracts/expired
List expired subscriptions
getExpiredContracts 1 param → 200
GET
/api/latest/data/contracts/urgent
List urgent usage subscriptions
getUrgentCount → 200
GET
/api/latest/data/contracts/{id}/payments/active-usage
Retrieve the active usage billing schedules for a subscription
getUsageSchedule 2 params → 200
GET
/api/latest/data/contracts/usage
List usage subscriptions
listActiveUsageBasedContracts → 200
POST
/api/latest/data/contracts/restore
Restore subscriptions
restoreSubscriptions body → 200
PUT
/api/latest/data/contracts/{id}/issue-dates
Recalculate outstanding billing schedule issue dates
updateIssueDates 1 param body → 200
GET
/api/latest/data/billing-schedules/{id}
Retrieve a billing schedule
getBillingSchedule 1 param → 200

Schemas 75

The contract defines 75 schemas that model the data the API accepts and returns. The most detailed are Proposal (69 properties), Contract (38 properties), Product (36 properties), BillingSchedule (33 properties). Each schema is shown below with its type and property counts.

PlaidAccount
object
5 properties
CreateAccountsWithPlaidRequest
object
5 properties
Unit
object
7 properties
CustomerSummary
object
7 properties
NextPaymentDueSummary
object
7 properties
Money
object
Total list amount for this level. null for usage.
4 properties
Address
object
17 properties
ItemOverride
object
7 properties 1 required
ContractEvent
object
10 properties
Document
object
7 properties
OrganizationSummary
object
6 properties
Proposal
object
69 properties 27 required
ApprovalRuleSummary
object
4 properties
BillingSchedule
object
33 properties 13 required
CreateAccountsWithManualRequest
object
10 properties
Contact
object
13 properties 6 required
ProductUsage
object
10 properties 1 required
TransferSummary
object
3 properties
RenewalConfiguration
object
10 properties
LineItemLevel
object
5 properties
ProposalAttachment
object
12 properties
PaymentComponent
object
26 properties 3 required
_ContactInternal
object
12 properties 1 required
PricebookEntry
object
8 properties 1 required
OverrideRange
object
3 properties 1 required
VirtualAccount
object
1 property
Product
object
36 properties 16 required
ObjectReference
object
5 properties
InvoiceConfiguration
object
8 properties
RenewalConfigurationChange
object
6 properties
BillingMethodSummary
object
8 properties
BillingMethodRequest
object
5 properties
PaymentSchedule
object
19 properties 3 required
CreateContractRequest
object
4 properties
MultipleIdRequest
object
1 property
Customer
object
18 properties 5 required
BillingItem
object
28 properties 12 required
ItemSchedule
object
21 properties 2 required
ProposalEvent
object
10 properties
ExternalSource
object
3 properties 2 required
BundleItem
object
7 properties 4 required
CompanyInfo
object
18 properties
Payment
object
16 properties 4 required
ProductTaxConfig
object
7 properties
User
object
12 properties
PersonSummary
object
7 properties
Transfer
object
33 properties 2 required
ProposalChanges
object
8 properties
Item
object
22 properties 11 required
ContractUsageSummary
object
9 properties 7 required
PaymentMethod
object
21 properties
Account
object
27 properties
ProposalItemChange
object
11 properties
BillingMethod
object
12 properties 6 required
PaymentMethodSummary
object
9 properties
Duration
object
2 properties 2 required
TaxCode
object
7 properties
ItemScheduleLevel
object
9 properties 5 required
DocumentVersion
object
9 properties
ItemLevelOverride
object
3 properties 2 required
ProposalContact
object
7 properties 3 required
Contract
object
38 properties 18 required
QuantityOverride
object
4 properties 2 required
CreateAccountsWithStripeRequest
object
3 properties
UpdateIssueDatesRequest
object
2 properties
UpdateContractRequest
object
2 properties
SyncEvent
object
12 properties
ContractSummary
object
17 properties 13 required
SpanGroup
object
14 properties 9 required
ItemLevel
object
5 properties 3 required
LineItemSpan
object
27 properties 7 required
SigningDocument
object
10 properties 3 required
BundlePriceEntry
object
2 properties 1 required
ProductLevel
object
6 properties 1 required
ProposalEventDetails
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cacheflow-subscriptions-api-openapi.yml Raw ↑

Other APIs Cacheflow publishes across the network.

Cacheflow Accounts API
Cacheflow Addresses API
Cacheflow Approval Groups API
Cacheflow Approval Requests API
Cacheflow Attachments API
Cacheflow Authentication API
Cacheflow Branding API
Cacheflow Checkout API
Cacheflow Close API
Cacheflow Contacts API
Cacheflow Countries API
Cacheflow CRM API
Where this information came from

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