Jump to Content
Cacheflow
API Reference
v1.0

Cacheflow
API Reference
v1.0API Reference

API SETUP

  • Retrieve or create an API token
  • API Endpoints

CUSTOMERS

  • Contacts
    • Retrieve a contactget
    • Delete a contactdel
    • Update a contactpatch
    • List contacts for a customerget
    • Create a contactpost
  • Customers
    • List customersget
    • Create a customerpost
    • Retrieve a customerget
    • Delete a customerdel
    • Update a customerpatch
    • Retrieve a customer by external idget

PROPOSALS

  • Proposal Approvals
    • Action an approvalpost
    • Retrieve approval status for a proposalget
    • Request approval for a proposalpost
  • Proposals
    • List proposals for a customerget
    • Get an item scheduleget
    • Delete an item scheduledel
    • Update an item schedulepatch
    • Add an item schedulepost
    • Get a proposal itemget
    • Delete a proposal itemdel
    • Update a proposal itempatch
    • Accept a proposalpost
    • List events for a proposalget
    • Add a proposal itempost
    • Batch add/update/remove proposal itemspatch
    • Archive proposalspost
    • Bulk expire proposalsput
    • Cancel a proposalpost
    • Clear legacy checkout flag from all proposalspost
    • Copy a proposalpost
    • List proposalsget
    • Create a proposalpost
    • Add new renewal configuration to proposalpost
    • Retrieve a proposalget
    • Delete a proposaldel
    • Update a proposalpatch
    • List upgrades for a proposalget
    • Retrieve a proposal by external IDget
    • Retrieve the signing document for a proposalget
    • Retrieve signing view for a proposalget
    • Share a proposalpost
    • Perform proposal maintenance: expire and regeneratepost
    • Preview proposal delta spansget
    • Restore proposalspost
    • Toggle legacy checkout flag for a specific proposalpost
    • Update a cover letterput
    • List proposal templatesget

SUBSCRIPTIONS

  • Subscriptions
    • List subscriptions for a customerget
    • Archive subscriptionspost
    • List subscriptionsget
    • List proposals for a subscriptionget
    • Create change proposal for a subscriptionpost
    • Retrieve a subscriptionget
    • Update a subscriptionpatch
    • Retrieve payments for a subscriptionget
    • Retrieve the active usage billing schedules for a subscriptionget
    • Restore subscriptionspost
    • Recalculate outstanding billing schedule issue datesput
    • Retrieve a billing scheduleget
  • Usage
    • List usage for a billing scheduleget
    • Create usagepost

TRANSACTIONS

  • Invoices
    • List invoices for a customerget
    • Archive invoicespost
    • Retrieve an invoiceget
    • Update an invoicepatch
    • Retrieve invoice activityget
    • List invoicesget
    • Resend invoice emailpost
    • Receive Payment for an Invoicepost
    • Fetch past_due invoices for an organizationget
    • Creates and sync an invoice for a billing schedulepost
  • Payments
    • Retrieve a paymentget
    • Get payment by referenceget
    • List paymentsget
    • Update a billing schedulepatch

PRODUCTS

  • Products
    • Copy a productpost
    • List productsget
    • Create a productpost
    • Retrieve a productget
    • Delete a productdel
    • Update a productpatch
    • List available upgrades for bundle items nested within a bundle productget
    • Retrieve latest version of a product by root_idget
    • Retrieve stats about how a product is usedget
    • List active productsget
    • Create a product versionpost

SETTINGS

  • Attachments
    • List attachmentsget
    • Create an attachmentpost
    • Retrieve an attachmentget
    • Delete an attachmentdel
    • Update an attachmentpatch
  • Webhooks
    • Create a webhookpost
    • Get events for a webhookget
    • Delete a webhookdel
    • Update a webhookpatch
    • Test a webhookget
    • List webhooksget

Cacheflow API

  • Integrations
    • Event record by idget
    • Reconciliation summaryget
    • List integration eventsget
    • Give the counts of integration eventsget
    • List events for billing schedulesget
    • List integration eventsget
    • Reconciliation summaryget
    • Link object based on entitypost
    • Resync billing schedulesput
    • UnLink object based on entitypost
  • Approval Requests
    • Retrieve approval requestsget
  • CRM
    • Create a renewal deal in CRM for a renewal proposalpost
    • List deal pipelinesget
    • List external customersget
    • List external productsget
    • Trigger a sync of a proposal to CRMput
  • Invoice
    • Restore invoicespost
  • Refunds
    • List Refundsget
    • Schedule a refund for a transferpost
    • Get Refund by IDget
    • Get Refund activity by IDget
    • Get Refund events by IDget
    • Get Refund activity by IDpost
  • Authentication
    • List SSO Providersget
  • Metrics
    • Creates metrics for this contractput
    • Gets item interval metrics for this contractget
    • Gets item metrics for this contractget
  • Payment Methods
    • List payment methods.get
  • Proposal Deltas
    • Retrieve proposal delta spansget
  • DocuSign
    • Retrieve DocuSign envelope quotaget
  • Payment Terms
  • Slack
  • Migration
    • Convert a proposal to a subscriptionpost
    • Migrate subscription to Cacheflowpost
  • Stripe
Powered by 

API Endpoints

Environment endpoints

EnvironmentEndpoint
Productionhttps://[YourCompanyDomain].api.getcacheflow.com
Sandboxhttps://[YourCompanyDomain].api.sandbox.getcacheflow.com

Domain example

Company = www.mytestcompany.com
https://mytestcompany.api.getcacheflow.com

API Tokens

API tokens are specific to the environment they are created in and cannot be used across environments.

  • Table of Contents
    • Environment endpoints
      • Domain example
      • API Tokens