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

Manage recurring subscriptions

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

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

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

4 operations 2 paths 3 schemas 2 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 Subscriptions 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 4

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

Subscriptions 4

Manage recurring subscriptions

GET
/subscriptions
List all subscriptions
listSubscriptions 4 params → 200401
POST
/subscriptions
Create a subscription record
createSubscription body → 200400401
GET
/subscriptions/{subscription_id}
Retrieve a subscription
getSubscription 1 param → 200401404
POST
/subscriptions/{subscription_id}
Update a subscription record
updateSubscription 1 param body → 200401404

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are Subscription (16 properties), SubscriptionInput (14 properties), Error (1 property). Each schema is shown below with its type and property counts.

SubscriptionInput
object
14 properties 1 required
Subscription
object
16 properties
Error
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

chargedesk-subscriptions-api-openapi.yml Raw ↑

Other APIs ChargeDesk publishes across the network.

ChargeDesk REST API
ChargeDesk Charges API
ChargeDesk Customers API
ChargeDesk Gateway API
ChargeDesk Products API
ChargeDesk Webhooks API