Jump to Content
API Reference
v1.0
API Reference
Moon (Dark Mode)
Sun (Light Mode)
v1.0
API Reference
Request approval for a proposal
Search
JUMP TO
API SETUP
Retrieve or create an API token
API Endpoints
CUSTOMERS
Contacts
Retrieve a contact
get
Delete a contact
delete
Update a contact
patch
List contacts for a customer
get
Create a contact
post
Customers
List customers
get
Create a customer
post
Retrieve a customer
get
Delete a customer
delete
Update a customer
patch
Retrieve a customer by external id
get
PROPOSALS
Proposal Approvals
Action an approval
post
Retrieve approval status for a proposal
get
Request approval for a proposal
post
Proposals
List proposals for a customer
get
Get an item schedule
get
Delete an item schedule
delete
Update an item schedule
patch
Add an item schedule
post
Get a proposal item
get
Delete a proposal item
delete
Update a proposal item
patch
Accept a proposal
post
List events for a proposal
get
Add a proposal item
post
Batch add/update/remove proposal items
patch
Archive proposals
post
Bulk expire proposals
put
Cancel a proposal
post
Clear legacy checkout flag from all proposals
post
Copy a proposal
post
List proposals
get
Create a proposal
post
Add new renewal configuration to proposal
post
Retrieve a proposal
get
Delete a proposal
delete
Update a proposal
patch
List upgrades for a proposal
get
Retrieve a proposal by external ID
get
Retrieve the signing document for a proposal
get
Retrieve signing view for a proposal
get
Share a proposal
post
Perform proposal maintenance: expire and regenerate
post
Preview proposal delta spans
get
Restore proposals
post
Toggle legacy checkout flag for a specific proposal
post
Update a cover letter
put
List proposal templates
get
SUBSCRIPTIONS
Subscriptions
List subscriptions for a customer
get
Archive subscriptions
post
List subscriptions
get
List proposals for a subscription
get
Create change proposal for a subscription
post
Retrieve a subscription
get
Update a subscription
patch
Retrieve payments for a subscription
get
Retrieve the active usage billing schedules for a subscription
get
Restore subscriptions
post
Recalculate outstanding billing schedule issue dates
put
Retrieve a billing schedule
get
Usage
List usage for a billing schedule
get
Create usage
post
TRANSACTIONS
Invoices
List invoices for a customer
get
Archive invoices
post
Retrieve an invoice
get
Update an invoice
patch
Retrieve invoice activity
get
List invoices
get
Resend invoice email
post
Receive Payment for an Invoice
post
Fetch past_due invoices for an organization
get
Creates and sync an invoice for a billing schedule
post
Payments
Retrieve a payment
get
Get payment by reference
get
List payments
get
Update a billing schedule
patch
PRODUCTS
Products
Copy a product
post
List products
get
Create a product
post
Retrieve a product
get
Delete a product
delete
Update a product
patch
List available upgrades for bundle items nested within a bundle product
get
Retrieve latest version of a product by root_id
get
Retrieve stats about how a product is used
get
List active products
get
Create a product version
post
SETTINGS
Attachments
List attachments
get
Create an attachment
post
Retrieve an attachment
get
Delete an attachment
delete
Update an attachment
patch
Webhooks
Create a webhook
post
Get events for a webhook
get
Delete a webhook
delete
Update a webhook
patch
Test a webhook
get
List webhooks
get
Cacheflow API
Integrations
Event record by id
get
Reconciliation summary
get
List integration events
get
Give the counts of integration events
get
List events for billing schedules
get
List integration events
get
Reconciliation summary
get
Link object based on entity
post
Resync billing schedules
put
UnLink object based on entity
post
Approval Requests
Retrieve approval requests
get
CRM
Create a renewal deal in CRM for a renewal proposal
post
List deal pipelines
get
List external customers
get
List external products
get
Trigger a sync of a proposal to CRM
put
Invoice
Restore invoices
post
Refunds
List Refunds
get
Schedule a refund for a transfer
post
Get Refund by ID
get
Get Refund activity by ID
get
Get Refund events by ID
get
Get Refund activity by ID
post
Authentication
List SSO Providers
get
Metrics
Creates metrics for this contract
put
Gets item interval metrics for this contract
get
Gets item metrics for this contract
get
Payment Methods
List payment methods.
get
Proposal Deltas
Retrieve proposal delta spans
get
DocuSign
Retrieve DocuSign envelope quota
get
Payment Terms
Slack
Migration
Convert a proposal to a subscription
post
Migrate subscription to Cacheflow
post
Stripe
Powered by
Request approval for a proposal
post
https://example.com/api/latest/proposals/
{id}
/approval-requests
Language
Shell
Node
Ruby
PHP
Python
RESPONSE
Click
Try It!
to start a request and see the response here!
