Preview Charge

Retrieves a charge preview from ChargeDesk.

GET

Query

Arguments

string

Charge to preview.

string

Product to preview. Ignored if Charge ID is also provided.

string

Amount to preview. Required if no charge or product is provided; otherwise overrides the charge or product amount.

string

Currency to preview. Required if no charge or product is provided; otherwise overrides the charge or product currency.

string

Two-letter ISO country code for the customer location.

string

Customer tax identification number used to determine whether 0% tax should apply.

boolean

Override the company setting for whether tax is added to or included in the final amount.

Field selectionChoose which fields should be included in the response. Learn more

string

Comma-separated response fields to include.

Try this request

Request

curl --request GET \
  --url "https://connect.mindcloud.co/v1/universal/chargeDesk/latest/actions/preview-charge" \
  --header "Authorization: Bearer $MINDCLOUD_API_TOKEN" \
  --get \
  --data-urlencode 'connectionId=$CONNECTION_ID'

{
  "success": true,
  "data": [
    {
      "subtotalAmount": 1,
      "subtotalAmountFormatted": "string",
      "taxRates": [
        {}
      ],
      "totalAmount": 1,
      "totalAmountFormatted": "string"
    }
  ],
  "meta": {}
}

Every app you connect,one REST pattern

Call any app with one REST pattern. MindCloud handles each provider's auth, request shape, and responses for you.

Learn what the Universal API is

One REST patternUse the same request structure across apps like Slack, HubSpot, Salesforce, and thousands more.

Managed connectionsSend a MindCloud connection ID instead of handling provider tokens, refresh logic, and credential storage yourself.

Action-level docsEach action page shows the exact endpoint, required arguments, optional controls, and response behavior for that app version.