ChargeOver API Documentation

This is the complete API documentation for connecting to the ChargeOver API using MindCloud's Universal API. If you are new to MindCloud, start with the Introduction to see how one API can sit in front of many different apps.

MindCloud is an integration company that offers one normalized API to access 3,100+ apps from a single place. It cleans up provider-specific quirks, keeps requests and responses consistent, and centralizes authentication so you do not need to manage separate flows for every app. Browse other apps.

Meet ChargeOver: Manage customers, subscriptions, invoices, payments, and usage billing. Keep reading to get started.

Quickstart

Before you run your first ChargeOver request, you need three things:

1. A MindCloud account — sign in or create an account at MindCloud.
2. A MindCloud API Key — create one in API Keys. Keep it on your server.
3. At least one ChargeOver connection — create or choose one in Connections. Note its connectionId.

Every ChargeOver action uses the same URL pattern:

https://connect.mindcloud.co/v1/universal/chargeOver/latest/actions/{actionSlug}

You need a MindCloud API Key and a ChargeOver connection. Then call an action such as Get Contact:

curl --request GET \
  --url "https://connect.mindcloud.co/v1/universal/chargeOver/latest/actions/get-contact" \
  --header "Authorization: Bearer $MINDCLOUD_API_KEY" \
  --get \
  --data-urlencode "connectionId=$CONNECTION_ID"

Every response comes back in the same envelope, with your rows in a data array:

{
  "success": true,
  "data": [
    { "id": "1042", "name": "Ava" }
  ],
  "meta": {}
}

After your first request works, use Shape your requests to control arguments, pagination, filtering, fields, and errors.

Authentication

Authentication has two layers. Your MindCloud API Key authenticates the request to MindCloud, sent as a Bearer token in the Authorization header. The connectionId selects the connected ChargeOver account that should run the action. MindCloud stores and refreshes the ChargeOver credentials behind that connection, so you never send provider tokens with your requests.

Pass connectionId in the query string for GET and DELETE actions, and in the JSON body for POST, PUT, and PATCH actions. Keep your MindCloud API Key on your server; do not ship it in browser code, mobile apps, public repositories, or logs.

ChargeOver actions

All 24 published actions for this ChargeOver version. Each page documents the endpoint, arguments, and response controls.

• PUTCancel Subscription
• PUTEmail Invoice
• PUTEmail Receipt
• GETGet Contact
• GETGet Customer
• GETGet Invoice
• GETGet Invoice PDF
• GETGet Item
• GETGet Subscription
• GETGet Transaction
• PUTInvoice Subscription Now
• GETList Contacts
• GETList Customers
• GETList Invoices
• GETList Items
• GETList Subscriptions
• GETList Transactions
• GETList Usage Records
• POSTRecord Usage
• PUTSuspend Subscription
• PUTUncancel Subscription
• PUTUnsuspend Subscription
• PUTVoid Invoice
• PUTVoid Transaction

Related apps

More Commerce apps on the Universal API, behind the same REST shape. Or browse all apps.

StripeShopifySquareWooCommerceXeroThinkificWhopGumroad