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

Charthop customer API

The customer API from Charthop — 4 operation(s) for customer.

Charthop customer API is one of 87 APIs that Charthop publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include customer. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 7 operations across 4 paths, and defines 19 schemas. It is described by OpenAPI 2.0, at version V1.0.0.

Requests are made against the base URL https://api.charthop.com.

7 operations 4 paths 19 schemas 4 GET2 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
V1.0.0
Base URL
https://api.charthop.com
Contact
Resource Areas
1

Paths & Operations 7

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

customer 7
GET
/v1/customer
Return all visible customers, paginated by name
findCustomers 4 params → 200400404
POST
/v1/customer
Create a new customer
createCustomer 1 param → 201400401403
GET
/v1/customer/{customerId}
Return a particular customer by id
getCustomer 1 param → 200400404
PATCH
/v1/customer/{customerId}
Update an existing customer
updateCustomer 2 params → 204400401403404
GET
/v1/customer/{customerId}/invoices
Returns a list of all the invoices for the given customer
getCustomerInvoices 1 param → 200400404
GET
/v1/customer/{customerId}/subscription
Returns information about the Charthop subscription for the given customer
getCharthopSubscription 1 param → 200400404
PATCH
/v1/customer/{customerId}/subscription
Update a subscription on a customer
updateSubscription 2 params → 204400401403404

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are Customer (35 properties), CreateCustomer (21 properties), UpdateCustomer (21 properties), Address (9 properties). Each schema is shown below with its type and property counts.

Address
object
9 properties 1 required
Customer
object
35 properties 3 required
Invoice
object
6 properties 4 required
FeatureAccessOption
object
4 properties 2 required
PaymentInfo
object
3 properties 1 required
Subscription
object
3 properties 3 required
AccessAction
object
3 properties 1 required
InvoiceResponse
object
1 property 1 required
CreateCustomer
object
21 properties 3 required
Geopoint
object
2 properties 2 required
Attribution
object
6 properties
ResultsAccess
object
2 properties 1 required
UpdateCustomer
object
21 properties
Plan
object
6 properties 6 required
PlanTier
object
2 properties 1 required
UpdateSubscription
object
1 property 1 required
TrialProduct
object
3 properties 3 required
ResultsCustomer
object
3 properties 1 required
ProductItem
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

charthop-customer-api-openapi.yml Raw ↑

Other APIs Charthop publishes across the network.

Charthop access API
Charthop action API
Charthop ai API
Charthop ai-credit-limit API
Charthop ai-hint API
Charthop ai-prompt API
Charthop app API
Charthop appConfig API
Charthop approval API
Charthop approval-delegate API
Charthop approval-request API
Charthop assessment API