List all clients

GET

clients

curl --request GET \
  --url https://gate.chip-in.asia/api/v1/clients/ \
  --header 'Authorization: Bearer <token>'

{
  "results": [
    {
      "type": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_on": 1619740800,
      "updated_on": 1619740800,
      "bank_account": "<string>",
      "bank_code": "<string>",
      "email": "jsmith@example.com",
      "phone": "+44 45643564564",
      "full_name": "<string>",
      "personal_code": "<string>",
      "street_address": "<string>",
      "country": "<string>",
      "city": "<string>",
      "zip_code": "<string>",
      "state": "<string>",
      "shipping_street_address": "<string>",
      "shipping_country": "<string>",
      "shipping_city": "<string>",
      "shipping_zip_code": "<string>",
      "shipping_state": "<string>",
      "cc": [
        "jsmith@example.com"
      ],
      "bcc": [
        "jsmith@example.com"
      ],
      "legal_name": "<string>",
      "brand_name": "<string>",
      "registration_number": "<string>",
      "tax_number": "<string>"
    }
  ],
  "next": "<string>",
  "previous": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200 - application/json

results

object[]

Record of a single customer of your business. Create one for each of your clients; you will be able to issue invoices/subscriptions for them later easily using /billing_templates/ API.

Each BillingTemplateClient (there can be many attached to a single BillingTemplate) will bind a single Client to a BillingTemplate.

results.email

string

required

Email address

Maximum length: 254

results.type

string

Object type identifier

results.id

string

results.created_on

integer

Object creation time

Example:

1619740800

results.updated_on

integer

Object last modification time

Example:

1619740800

results.bank_account

string

Bank account number (e.g. IBAN)

Maximum length: 34

results.bank_code

string

SWIFT/BIC code of the bank

Maximum length: 11

results.phone

string

Phone number in the <country_code> <number> format

Maximum length: 32

Example:

"+44 45643564564"

results.full_name

string

Name and surname of client. It is advisable to include full_name in request body.

Maximum length: 128

results.personal_code

string

Personal identification code of client

Maximum length: 32

results.street_address

string

Street house number and flat address where applicable

Maximum length: 128

results.country

string

Country code in the ISO 3166-1 alpha-2 format (e.g. 'GB')

Maximum length: 2

results.city

string

City name

Maximum length: 128

results.zip_code

string

ZIP or postal code

Maximum length: 32

results.state

string

State code

Maximum length: 128

results.shipping_street_address

string

Street house number and flat address where applicable

Maximum length: 128

results.shipping_country

string

Country code in the ISO 3166-1 alpha-2 format (e.g. 'GB')

Maximum length: 2

results.shipping_city

string

City name

Maximum length: 128

results.shipping_zip_code

string

ZIP or postal code

Maximum length: 32

results.shipping_state

string

State code

Maximum length: 128

results.cc

string[]

Email addresses to receive a carbon copy of all notification emails

Email address

results.bcc

string[]

Email addresses to receive a blind carbon copy of all notification emails

Email address

results.legal_name

string

Legal name of company

Maximum length: 128

results.brand_name

string

Company brand name

Maximum length: 128

results.registration_number

string

Registration number of company

Maximum length: 32

results.tax_number

string

Tax payer registration number

Maximum length: 32

string | null

The next page of pagination results. null if there are no more results.

string | null

The previous page of pagination results. null if there was no previous page.

Delete a client List recurring tokens

curl --request GET \
  --url https://gate.chip-in.asia/api/v1/clients/ \
  --header 'Authorization: Bearer <token>'

{
  "results": [
    {
      "type": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_on": 1619740800,
      "updated_on": 1619740800,
      "bank_account": "<string>",
      "bank_code": "<string>",
      "email": "jsmith@example.com",
      "phone": "+44 45643564564",
      "full_name": "<string>",
      "personal_code": "<string>",
      "street_address": "<string>",
      "country": "<string>",
      "city": "<string>",
      "zip_code": "<string>",
      "state": "<string>",
      "shipping_street_address": "<string>",
      "shipping_country": "<string>",
      "shipping_city": "<string>",
      "shipping_zip_code": "<string>",
      "shipping_state": "<string>",
      "cc": [
        "jsmith@example.com"
      ],
      "bcc": [
        "jsmith@example.com"
      ],
      "legal_name": "<string>",
      "brand_name": "<string>",
      "registration_number": "<string>",
      "tax_number": "<string>"
    }
  ],
  "next": "<string>",
  "previous": "<string>"
}

Overview

API Reference

Authorizations

Response