Sign in

v1

latestOpenAPI 3.1.02026-07-24170121.2 MB

Create a Customer

This API creates a customer.

post/v1/customers

Headers

Acceptstring required

Indicates which content types, expressed as MIME types, the client is able to understand.

Content-Typestring required

Indicates the media type of the resource sent in the HTTP message body. <br /><br /><b>Possible Values:</b><br /> application/json<br />application/x-www-form-urlencoded

Request body

emailstring required

Email address of the customer. It is displayed next to the customer in the dashboard and can be used for searching and tracking.

namestring

Name of the customer.

descriptionstring

An arbitrary string that you can attach to a customer. It is displayed next to the customer in the dashboard.

send_email_addressstring

Email address to which the invoices will be sent.

cc_email_addressstring

Email address to which the invoices will be sent.

countrystring

Customer's country name.

address_1string

The customer's address for line 1.

address_2string

The customer's address for line 2.

citystring

The cutomer's city name. Can be a City/District/Suburb/Town/Village.

statestring

The customer's state name. Can be State/County/Province/Region.

zipinteger

The customer's ZIP code.

phoneinteger

The customer's phone number.

Response

201

Example response

{
  "data": {
    "object": "customer",
    "customer_id": "ADjPnVDNMjMpVpMN",
    "name": "Foo Bar",
    "email": "foo@someplace.com",
    "description": "Foo Bar",
    "send_email_address": "foo@someplace.com",
    "cc_email_address": "foo@someplace.com",
    "address_1": "Foo Bar",
    "address_2": "Foo Bar",
    "city": "Foo Bar",
    "state": "NY",
    "zip": 11501,
    "phone": 5555555555,
    "country": "Foo Bar",
    "created_at": 1724443729,
    "updated_at": 1724443729,
    "readable_created_at": "1 second ago",
    "readable_updated_at": "1 second ago",
    "invoice_prefix": "1MAA"
  },
  "meta": {
    "include": [
      "card"
    ]
  }
}