The customer object

Customers are entities representing individuals or businesses who interact with your business and make payments.
The Customer resource is a core entity within Speed. Use it to store all of the profile information. You can then associate a customer with an invoice and share it with them to get paid.

{
    "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": {
        "key_1": "value_1",
        "key_2": "value_2"
    },
    "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.