Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

ChargeDesk Charges API

Manage charge records across payment gateways

ChargeDesk Charges API is one of 7 APIs that ChargeDesk publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Charges. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 8 operations across 5 paths, and defines 8 schemas. It is described by OpenAPI 3.0.3, at version v1.

Requests are made against a single base URL, https://api.chargedesk.com/v1.

8 operations 5 paths 8 schemas 1 DELETE4 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
v1
Base URL
https://api.chargedesk.com/v1
Authentication
HTTP Basic
Terms of Service
Resource Areas
1

Authentication & Security 1

ChargeDesk Charges API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

  • basicAuth — Use your ChargeDesk secret key as the username with an empty password. Format: Authorization: YOURSECRETKEY:

Paths & Operations 8

Across 5 paths, the API surfaces 8 operations — 1 DELETE, 4 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Charges 8

Manage charge records across payment gateways

GET
/charges
List all charges
listCharges 12 params → 200401
POST
/charges
Create a charge record
createCharge body → 200400401
GET
/charges/preview
Preview a charge with tax calculation
previewCharge 3 params → 200401
GET
/charges/{charge_id}
Retrieve a single charge
getCharge 1 param → 200401404
POST
/charges/{charge_id}
Update a charge record
updateCharge 1 param body → 200401404
DELETE
/charges/{charge_id}
Delete a charge record
deleteCharge 1 param → 200401404
GET
/charges/{charge_id}/items
Get line items for a charge
getChargeItems 1 param → 200401404
POST
/charges/{charge_id}/email
Send email notification for a charge
emailCharge 1 param → 200401404

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are Charge (16 properties), ChargeInput (12 properties), ChargeList (5 properties), ChargeLineItem (5 properties). Each schema is shown below with its type and property counts.

ProductRef
object
2 properties
ChargeInput
object
12 properties 3 required
SubscriptionRef
object
1 property
ChargeLineItem
object
5 properties
ChargeList
object
5 properties
CustomerRef
object
3 properties
Charge
object
16 properties
Error
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

chargedesk-charges-api-openapi.yml Raw ↑

Other APIs ChargeDesk publishes across the network.

ChargeDesk REST API
ChargeDesk Customers API
ChargeDesk Gateway API
ChargeDesk Products API
ChargeDesk Subscriptions API
ChargeDesk Webhooks API