API Test Keys

Customers Entity

The Customers entity has the following parameters:

Is this page helpful?

Entity

1{
2  "id": "cust_JbRkXMROZUMCVq",
3  "entity": "customer",
4  "name": "John Smith",
5  "email": "john.smith@example.com",
6  "contact": "+11234567890",
7  "gstin": null,
8  "notes": [],
9  "created_at": 1653915355
10}

id

string

Unique identifier of the customer. For example, cust_1Aa00000000004.

name

string

Customer's name. Alphanumeric, with period (.), apostrophe ('), forward slash (/), at (@) and parentheses allowed. The name must be between 3-50 characters in length. For example, John Smith.

contact

string

The customer's phone number. A maximum length of 15 characters including country code. For example, +1123567890.

email

string

The customer's email address. A maximum length of 64 characters. For example, john.smith@example.com.

notes

json object

This is a key-value pair that can be used to store additional information about the entity. It can hold a maximum of 15 key-value pairs, 256 characters (maximum) each. For example, "note_key": "Beam me up Scotty”.

created_at

integer

UNIX timestamp, when the customer was created. For example, 1234567890.

Customers Entity

The Customers entity has the following parameters:

Is this page helpful?

id

string

Unique identifier of the customer. For example, cust_1Aa00000000004.

name

string

Customer's name. Alphanumeric, with period (.), apostrophe ('), forward slash (/), at (@) and parentheses allowed. The name must be between 3-50 characters in length. For example, John Smith.

contact

string

The customer's phone number. A maximum length of 15 characters including country code. For example, +1123567890.

email

string

The customer's email address. A maximum length of 64 characters. For example, john.smith@example.com.

notes

json object

created_at

integer

UNIX timestamp, when the customer was created. For example, 1234567890.

Entity

1{
2  "id": "cust_JbRkXMROZUMCVq",
3  "entity": "customer",
4  "name": "John Smith",
5  "email": "john.smith@example.com",
6  "contact": "+11234567890",
7  "gstin": null,
8  "notes": [],
9  "created_at": 1653915355
10}