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
Cacheflow

Cacheflow Proposals API

The Proposals API from Cacheflow — 43 operation(s) for proposals.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

Tagged areas include Proposals. 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 55 operations across 43 paths, and defines 86 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.

55 operations 43 paths 86 schemas 6 DELETE16 GET6 PATCH24 POST3 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 55

Across 43 paths, the API surfaces 55 operations — 6 DELETE, 16 GET, 6 PATCH, 24 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Proposals 55
GET
/api/latest/data/customers/{id}/proposals
List proposals for a customer
getCustomerProposals 1 param → 200
GET
/api/latest/data/item-schedules/{id}
Get an item schedule
getItemSchedule 1 param → 200
DELETE
/api/latest/data/item-schedules/{id}
Delete an item schedule
deleteItemSchedule 1 param → 200
PATCH
/api/latest/data/item-schedules/{id}
Update an item schedule
updateItemSchedule 1 param body → 200
POST
/api/latest/data/proposal-items/{id}/schedules
Add an item schedule
addItemSchedule 1 param body → 200
GET
/api/latest/data/proposal-items/{id}
Get a proposal item
getProposalItem 1 param → 200
DELETE
/api/latest/data/proposal-items/{id}
Delete a proposal item
deleteProposalItem 1 param → 200
PATCH
/api/latest/data/proposal-items/{id}
Update a proposal item
updateProposalItem 1 param body → 200
POST
/api/latest/proposals/{id}/accept
Accept a proposal
acceptProposal 1 param body → 200
PUT
/api/latest/proposals/{id}/billing-method
Update the payment method for a proposal
addBillingMethod 1 param body → 201
GET
/api/latest/proposals/{id}/events
List events for a proposal
getProposalEvents 1 param → 200
POST
/api/latest/proposals/{id}/events
Create an event for a proposal
addProposalEvent 2 params body → 201
POST
/api/latest/proposals/{id}/items
Add a proposal item
addProposalItem 1 param body → 200
PATCH
/api/latest/proposals/{id}/items
Batch add/update/remove proposal items
updateProposalItems 1 param body → 200
POST
/api/latest/proposals/{id}/renewal
Propagate renewal proposal changes to Subscription
applyRenewal 1 param → 200
POST
/api/latest/proposals/archive
Archive proposals
archiveProposals body → 200
PUT
/api/latest/proposals/bulk-expire
Bulk expire proposals
bulkExpireProposals 2 params → 200
POST
/api/latest/proposals/{id}/cancel
Cancel a proposal
cancelProposal 1 param → 200
POST
/api/latest/proposals/{id}/signing-document
Create the signing document for a proposal
createSigningDocument 2 params body → 200
DELETE
/api/latest/proposals/{id}/signing-document
Delete the signing document for a proposal
cancelSigningDocument 3 params → 200
POST
/api/latest/proposals/clear-legacy-checkout
Clear legacy checkout flag from all proposals
clearLegacyCheckout body → 200
POST
/api/latest/proposals/{id}/copy
Copy a proposal
copyProposal 2 params → 201
POST
/api/latest/proposals/{id}/invoice-config
Add new invoice configuration to proposal
createInvoiceConfiguration 1 param body → 201
DELETE
/api/latest/proposals/{id}/invoice-config
Delete invoice configuration to proposal
deleteInvoiceConfiguration 1 param → 200
POST
/api/latest/proposals/{id}/create-payment-intent
Create payment intent for a proposal
createPaymentIntent 1 param → 200
GET
/api/latest/proposals
List proposals
getProposals 5 params → 200
POST
/api/latest/proposals
Create a proposal
createProposal body → 201
POST
/api/latest/proposals/{id}/renewal-config
Add new renewal configuration to proposal
createRenewalConfiguration 1 param body → 201
DELETE
/api/latest/proposals/{id}/renewal-config
Delete auto-renewal configuration on proposal
deleteRenewalConfiguration 1 param → 200
GET
/api/latest/proposals/{id}
Retrieve a proposal
getProposal 1 param → 200
DELETE
/api/latest/proposals/{id}
Delete a proposal
deleteProposal 1 param → 200
PATCH
/api/latest/proposals/{id}
Update a proposal
updateProposal 1 param body → 200
POST
/api/latest/proposals/{id}/tax-estimate
Estimate tax for a proposal
estimateProposalTax 1 param → 201
GET
/api/latest/proposals/{id}/upgrades
List upgrades for a proposal
getAvailableProposalUpgrades 1 param → 200
GET
/api/latest/proposals/external/{externalId}
Retrieve a proposal by external ID
getProposalByExternalId 1 param → 200
GET
/api/latest/proposals/{id}/pdf-view
View a proposal document
getProposalPdf 2 params → 200
GET
/api/latest/proposals/{id}/signing-diagnostics
Retrieve signing diagnostics for a proposal
getSigningDiagnostics 1 param → 200
GET
/api/latest/proposals/{id}/signing-document/content
Retrieve the signing document for a proposal
getSigningDocumentContent 1 param → 200
GET
/api/latest/proposals/{id}/signing-view
Retrieve signing view for a proposal
getSigningView 2 params → 200
POST
/api/latest/proposals/{id}/payment-method/{paymentType}/init
Initialize plaid for a proposal
initPaymentMethod 2 params → 200
POST
/api/latest/proposals/{id}/billing-invites
Share a proposal
inviteBillingContact 2 params body → 200
POST
/api/latest/proposals/maintenance
Perform proposal maintenance: expire and regenerate
maintainProposals body → 200
GET
/api/latest/proposals/{id}/preview
Preview a proposal
previewProposal 1 param → 200
GET
/api/latest/proposals/{id}/delta-spans/preview
Preview proposal delta spans
previewProposalDeltaSpans 1 param → 200
POST
/api/latest/proposals/{id}/request
Create a proposal as buyer
requestNewProposal 2 params body → 200
POST
/api/latest/proposals/restore
Restore proposals
restoreProposals body → 200
POST
/api/latest/proposals/{id}/set-renewal-billing
System auth required. Update renewal proposals with previous accepted. Useful for fixing billing methods on renewals.
setBillingMethodOnRenewal 1 param → 201
POST
/api/latest/proposals/{id}/toggle-legacy-checkout
Toggle legacy checkout flag for a specific proposal
toggleLegacyCheckout 1 param → 200
PATCH
/api/latest/proposals/{id}/checkout-state
Update a proposal checkout state
updateCheckoutStateAsBuyer 2 params body → 200
PUT
/api/latest/proposals/{id}/cover-letter
Update a cover letter
updateCoverLetter 1 param body → 200
PATCH
/api/latest/proposals/{id}/customer
Update billing info for a proposal
updateCustomerAsBuyer 2 params body → 200
POST
/api/latest/proposals/{ids}/pricing
System auth required. Update item pricing and schedules. Useful after out-of-band item adjustments.
updateProposalsPricing 1 param → 201
POST
/api/latest/proposals/{id}/signing-update
Update the signing for a proposal. poll=true indicates that polling protection should be used, false or null that there is an expected update.
updateSigningDocument 2 params → 200
GET
/api/latest/proposals/{id}/view
View a proposal as buyer
viewProposal 3 params → 200
GET
/api/latest/data/proposal-templates
List proposal templates
listVisibleTemplates → 200

Schemas 86

The contract defines 86 schemas that model the data the API accepts and returns. The most detailed are Proposal (69 properties), Product (36 properties), CreateProposalRequest (31 properties), ProposalSummary (31 properties). Each schema is shown below with its type and property counts.

OrganizationSummary
object
6 properties
Proposal
object
69 properties 27 required
ItemScheduleLevelRequest
object
Level price and discount info. Required for tiered products.
2 properties
RenewalConfiguration
object
10 properties
_ContactInternal
object
12 properties 1 required
InvoiceConfiguration
object
8 properties
ExternalSource
object
3 properties 2 required
InvoiceConfigurationRequest
object
3 properties
OrgRequest
object
1 property
User
object
12 properties
ItemLevelOverrideRequest
object
3 properties 2 required
BuyerUpdateCustomerRequest
object
7 properties
CustomerRequest
object
15 properties
PaymentMethod
object
21 properties
TaxCode
object
7 properties
RenewalConfigurationRequest
object
4 properties
ItemScheduleLevel
object
9 properties 5 required
QuantityOverride
object
4 properties 2 required
BundlePriceEntry
object
2 properties 1 required
ProductLevel
object
6 properties 1 required
ItemLevelOverride
object
3 properties 2 required
ProposalEventDetails
object
3 properties
ItemOverrideRequest
object
7 properties 1 required
CreateContactRequest
object
7 properties 3 required
PlaidAccount
object
5 properties
ItemLevelRequest
object
2 properties
CustomerSummary
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
ApprovalRuleSummary
object
4 properties
LineItemLevel
object
5 properties
PaymentMethodInitResponse
object
3 properties
OverrideRange
object
3 properties 1 required
MultipleIdRequest
object
1 property
BundleItem
object
7 properties 4 required
OrgId
object
1 property
Payment
object
16 properties 4 required
StripePaymentIntentResponse
object
3 properties
ProposalChanges
object
8 properties
BillingMethod
object
12 properties 6 required
Duration
object
2 properties 2 required
SigningDocument
object
10 properties 3 required
ProposalItemRequest
object
12 properties
PaymentComponent
object
26 properties 3 required
PricebookEntry
object
8 properties 1 required
ItemScheduleRequest
object
10 properties
ObjectReference
object
5 properties
RenewalConfigurationChange
object
6 properties
ProposalSummaryEvent
object
6 properties
ProposalEvent
object
10 properties
PricebookEntryChange
object
4 properties
ProductTaxConfig
object
7 properties
PersonSummary
object
7 properties
Item
object
22 properties 11 required
ProductUpgrade
object
4 properties 3 required
AcceptRequest
object
1 property
SigningDocumentSummary
object
6 properties
SigningDocumentViewResponse
object
1 property
CreateAccountsWithStripeRequest
object
3 properties
Unit
object
7 properties
ProposalContact
object
7 properties 3 required
ItemLevel
object
5 properties 3 required
ProposalSummary
object
31 properties 14 required
SigningDocumentCreateRequest
object
3 properties
CreateAccountsWithPlaidRequest
object
5 properties
BuyerProposalRequest
object
2 properties
ItemDeltaSpansResponse
object
2 properties 2 required
RequestNewProposalRequest
object
1 property
CreateAccountsWithManualRequest
object
10 properties
Contact
object
13 properties 6 required
ProposalAttachment
object
12 properties
CreateProposalRequest
object
31 properties
VirtualAccount
object
1 property
Product
object
36 properties 16 required
BillingMethodRequest
object
5 properties
PaymentSchedule
object
19 properties 3 required
Customer
object
18 properties 5 required
ProposalTemplateSummary
object
11 properties
ItemSchedule
object
21 properties 2 required
CoverLetterRequest
object
4 properties
Account
object
27 properties
DocumentVersion
object
9 properties
ProposalItemChange
object
11 properties
LineItemSpan
object
27 properties 7 required
SpanGroup
object
14 properties 9 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cacheflow-proposals-api-openapi.yml Raw ↑

Other APIs Cacheflow publishes across the network.

Cacheflow Accounts API
AE Profile APIs.io
Cacheflow Addresses API
AE Profile APIs.io
Cacheflow Approval Groups API
AE Profile APIs.io
Cacheflow Approval Requests API
AE Profile APIs.io
Cacheflow Attachments API
AE Profile APIs.io
Cacheflow Authentication API
AE Profile APIs.io
Cacheflow Branding API
AE Profile APIs.io
Cacheflow Checkout API
AE Profile APIs.io
Cacheflow Close API
AE Profile APIs.io
Cacheflow Contacts API
AE Profile APIs.io
Cacheflow Countries API
AE Profile APIs.io
Cacheflow CRM API
AE Profile APIs.io
#Proposals
← Back to C APIs
API Details
ID
cacheflow:cacheflow-proposals-api
Base URL
https://api.getcacheflow.com
Docs
https://developer.getcacheflow.com/reference
Provider
Cacheflow
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=cacheflow-proposals-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/cacheflow-proposals-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 Cacheflow Proposals 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.