Create a customer

Discover how to create a customer. You can create a customer without coding (via Speed web application) or programmatically (via customer APIs).

Create customer via Speed web application

On the left sidebar, click on Customers.
Click on Add customer button.
After clicking the Add customer button, you are redirected to a Create page. Here you can fill out the required details including name, email and the optional details like phone number, description, address, etc.
Click on Next.
Fill in the billing and shipping information for the customer.
Click on Add Customer. This will redirect you to the detail page, where you can see the customer details.
Now, you can create an invoice for this customer.

Create customers via API

Create a product using the /customers endpoint and basic details such as name, email, phone number, and others. In this example below, we’ll show how you can create a customer.

Make a POST /customers request specifying the following mandatory parameters:

name
email

{
    "name": "Test",
    "email": "[email protected]",
    "currency": "SATS",
    "billing": {
        "address": {
            "line1": "ABC Society",
            "line2": "PQR Colony",
            "city": "London"
        },
        "email": "[email protected]",
        "email_cc": [
            "[email protected]",
            "[email protected]"
        ]
    },
    "shipping": {
        "address": {
            "line1": "80 The Drive",
            "city": "London",
            "country": "USD"
        },
        "phone": "12344533",
        "calling_code": "+91"
    },
    "timezone": "America/Denver"
}

Request parameters

Provide the basic information outlined in the table below:

Parameter	Required	Type	Description
Name	✅	String	You can use this parameter to add a name of your customer.
Email	✅	String	You can use this parameter to provide an email of your customer.
Description		String	You can use this parameter to add a description about the customer.
Phone Number		String	You can use this to store phone number of the customer.

More information can be found in our API reference.

Response Attributes

Your response contains the following attributes:

{
    "id": "cus_lky0uwufpsMncXBF",
    "object": "customer",
    "name": "Test",
    "email": "[email protected]",
    "currency": "SATS",
    "billing": {
        "address": {
            "line1": "ABC Society",
            "line2": "PQR Colony",
            "city": "London",
            "state": null,
            "country": null,
            "zipcode": null
        },
        "email": "[email protected]",
        "email_cc": [
            "[email protected]",
            "[email protected]"
        ]
    },
    "shipping": {
        "address": {
            "line1": "80 The Drive",
            "line2": null,
            "city": "London",
            "state": null,
            "country": "USD",
            "zipcode": null
        },
        "name": null,
        "email": null,
        "phone": "12344533",
        "calling_code": "+91"
    },
    "description": null,
    "phone": null,
    "calling_code": null,
    "metadata": {},
    "preferred_locales": [
        "en_US"
    ],
    "timezone": "America/Denver",
    "created": 1691240384967,
    "modified": 1691240384967
}

Attributes

id string
Unique identifier for the object.

object string
The type of the object indicates to which entity this response belongs.

name string
This attribute represents the name of the customer.

email string
This attribute represents email address of your customer.

currency string
This attribute represents default preferred currency of your customer.

description string
This attribute represents additional information about your customer.

phone string
This attribute represents phone number of your customer.

metadata object
You can use this to store additional information about the object in a structured format.

preferred_locales array of strings
The customer's preferred language.

timezone string
This attribute represents time-zone of your customer.

created timestamp
Time at which the object was created.

modified timestamp
Time at which the last modification was made.