ChargeDesk API Documentation
This is the complete API documentation for connecting to the ChargeDesk 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 ChargeDesk: ChargeDesk helps support teams manage billing data, charges, customers, subscriptions, products, webhooks, and billing activity across connected payment gateways. Keep reading to get started.
Quickstart
Before you run your first ChargeDesk request, you need three things:
- A MindCloud account — sign in or create an account at MindCloud.
- A MindCloud API Key — create one in API Keys. Keep it on your server.
- At least one ChargeDesk connection — create or choose one in Connections. Note its
connectionId.
Every ChargeDesk action uses the same URL pattern:
POST https://connect.mindcloud.co/v2/universal/apps/chargeDesk/actions/{actionSlug}/runYou need a MindCloud API Key and a ChargeDesk connection. Then call an action such as List Charges:
curl --request POST \
--url "https://connect.mindcloud.co/v2/universal/apps/chargeDesk/actions/list-charges/run" \
--header "Authorization: Bearer $MINDCLOUD_API_KEY" \
--header "Content-Type: application/json" \
--data '{
"connectionId": "$CONNECTION_ID",
"arguments": {}
}'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.
Authenticate with a MindCloud API Key plus a connectionId for your ChargeDesk account. See ChargeDesk API Authentication for the full flow and how to get your connection credentials.
ChargeDesk actions
All 24 published actions for this ChargeDesk version. Each page documents the endpoint, arguments, and response controls.
- POSTCreate Charge
- POSTCreate Customer
- POSTCreate Product
- POSTCreate Subscription
- POSTCreate Webhook
- POSTEmail Charge
- GETGroup Customers
- GETList Agent Activity
- GETList Charges
- GETList Customers
- GETList Products
- GETList Subscription Cancellations
- GETList Subscriptions
- GETList Webhook Notifications
- GETPreview Charge
- GETRetrieve Charge
- GETRetrieve Charge Items
- GETRetrieve Customer
- GETRetrieve Product
- GETRetrieve Subscription
- PUTUpdate Charge
- PUTUpdate Customer
- PUTUpdate Product
- PUTUpdate Subscription
Related apps
More Commerce apps on the Universal API, behind the same REST shape. Or browse all apps.