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 Customers API

Manage customer billing records

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

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

This API exposes 6 operations across 3 paths, and defines 5 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.

6 operations 3 paths 5 schemas 1 DELETE3 GET2 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 Customers 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 6

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

Customers 6

Manage customer billing records

GET
/customers
List all customers
listCustomers 3 params → 200401
POST
/customers
Create a customer record
createCustomer body → 200400401
GET
/customers/{customer_id}
Retrieve a customer
getCustomer 1 param → 200401404
POST
/customers/{customer_id}
Update a customer record
updateCustomer 1 param body → 200401404
DELETE
/customers/{customer_id}
Delete a customer record
deleteCustomer 2 params → 200401404
GET
/customers/grouped
Get structured billing history for customers
getGroupedCustomers → 200401

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are Customer (17 properties), CustomerInput (15 properties), BillingAddress (6 properties), CustomerList (5 properties). Each schema is shown below with its type and property counts.

CustomerInput
object
15 properties 1 required
CustomerList
object
5 properties
BillingAddress
object
6 properties
Customer
object
17 properties
Error
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

chargedesk-customers-api-openapi.yml Raw ↑

Other APIs ChargeDesk publishes across the network.

ChargeDesk REST API
ChargeDesk Charges API
ChargeDesk Gateway API
ChargeDesk Products API
ChargeDesk Subscriptions API
ChargeDesk Webhooks API