ChargeDesk · Schema

Customer

A customer billing record in ChargeDesk

PaymentsBillingSubscriptionChargesRefundsCustomer ManagementPayment GatewayHelpdesk IntegrationREST API

Properties

Name	Type	Description
id	string	Unique identifier assigned by ChargeDesk
object	string
customer_id	string	Customer identifier (from your system or gateway)
email	string	Customer email address
name	string	Customer full name
phone	string	Customer phone number
username	string	Customer username in your system
customer_company	string	Company or organization name
website	string	Customer website URL
description	string	Notes or description about the customer
country	string	2-letter ISO country code
delinquent	boolean	Whether the customer has failed payments
card_on_file	boolean	Whether the customer has a card on file
tax_number	string	Customer tax identification number
billing_address	object	Customer billing address
invoice_details	string	Custom invoice details or notes
metadata	object	Arbitrary key-value metadata

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://api.chargedesk.com/v1/schema/customer",
  "title": "Customer",
  "description": "A customer billing record in ChargeDesk",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier assigned by ChargeDesk"
    },
    "object": {
      "type": "string",
      "const": "customer"
    },
    "customer_id": {
      "type": "string",
      "description": "Customer identifier (from your system or gateway)"
    },
    "email": {
      "type": "string",
      "format": "email",
      "description": "Customer email address"
    },
    "name": {
      "type": "string",
      "description": "Customer full name"
    },
    "phone": {
      "type": "string",
      "description": "Customer phone number"
    },
    "username": {
      "type": "string",
      "description": "Customer username in your system"
    },
    "customer_company": {
      "type": "string",
      "description": "Company or organization name"
    },
    "website": {
      "type": "string",
      "format": "uri",
      "description": "Customer website URL"
    },
    "description": {
      "type": "string",
      "description": "Notes or description about the customer"
    },
    "country": {
      "type": "string",
      "description": "2-letter ISO country code",
      "minLength": 2,
      "maxLength": 2
    },
    "delinquent": {
      "type": "boolean",
      "description": "Whether the customer has failed payments"
    },
    "card_on_file": {
      "type": "boolean",
      "description": "Whether the customer has a card on file"
    },
    "tax_number": {
      "type": "string",
      "description": "Customer tax identification number"
    },
    "billing_address": {
      "type": "object",
      "description": "Customer billing address",
      "properties": {
        "line1": { "type": "string" },
        "line2": { "type": "string" },
        "city": { "type": "string" },
        "state": { "type": "string" },
        "postal_code": { "type": "string" },
        "country": { "type": "string" }
      }
    },
    "invoice_details": {
      "type": "string",
      "description": "Custom invoice details or notes"
    },
    "metadata": {
      "type": "object",
      "description": "Arbitrary key-value metadata",
      "additionalProperties": { "type": "string" }
    }
  },
  "required": ["customer_id"]
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this

find_json_schemasBrowse and filter every JSON Schema in the catalog.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This JSON Schema

curl "https://apis.io/api/v1/json-schemas/customer"

All schemas

curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.