Copperx API Documentation

This is the complete API documentation for connecting to the Copperx 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 Copperx: Copperx API for managing organizations, payment settings, customers, invoices, payment links, checkout sessions, products, prices, tax rates, subscriptions, webhooks, and related payment operations. Keep reading to get started.

Quickstart

Before you run your first Copperx 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 Copperx connection — create or choose one in Connections. Note its connectionId.

Every Copperx action uses the same URL pattern:

POST https://connect.mindcloud.co/v2/universal/apps/copperx/actions/{actionSlug}/run

You need a MindCloud API Key and a Copperx connection. Then call an action such as Get Current User:

curl --request POST \
  --url "https://connect.mindcloud.co/v2/universal/apps/copperx/actions/get-current-user/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 Copperx account. See Copperx API Authentication for the full flow and how to get your connection credentials.

Copperx actions

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

• PUTActivate Payment Link
• PUTActivate Product
• PUTDeactivate Payment Link
• PUTDeactivate Product
• PUTDuplicate Invoice
• PUTFinalize Invoice
• GETGet Checkout Session
• GETGet Current User
• GETGet Customer
• GETGet Invoice
• GETGet Organization Info
• GETGet Payment Link
• GETGet Payment Setting
• GETGet Price
• GETGet Price Constants
• GETGet Product
• GETGet Subscription
• GETGet Tax Rate
• GETGet Webhook Endpoint
• GETGet Withdrawal Address
• GETList Assets
• GETList Chains
• GETList Checkout Sessions
• GETList Customers
• GETList Invoices
• GETList Payment Links
• GETList Prices
• GETList Products
• GETList Subscriptions
• GETList Tax Rates
• GETList Transactions
• GETList Webhook Endpoints
• GETList Withdrawal Addresses
• PUTSend Invoice
• PUTVoid Invoice

Related apps

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

Google SheetsGmailSlackGoogle CalendarGoogle DriveNotionGoogle FormsMailchimp