---
agentTools:
  projectIndex: https://apidocs.tryspeed.com/llms.txt
---

# 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.

```json
{
    "id": "cus_lky0uwufpsMncXBF",
    "object": "customer",
    "name": "Test",
    "email": "test_user@tryspeed.com",
    "currency": "SATS",
    "billing": {
        "address": {
            "line1": "ABC Society",
            "line2": "PQR Colony",
            "city": "London",
            "state": null,
            "country": null,
            "zipcode": null
        },
        "email": "test@tryspeed.com",
        "email_cc": [
            "test@tryspeed.com",
            "test1@tryspeed.com"
        ]
    },
    "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

***

<b class="para-title">id</b> <span style="font-size:12px; color: #8792a2;">string</span>\
Unique identifier for the object.

***

<b class="para-title">object</b> <span style="font-size:12px; color: #8792a2;">string</span>\
The type of the object indicates to which entity this response belongs.

***

<b class="para-title">name</b> <span style="font-size:12px; color: #8792a2;">string</span>\
This attribute represents the name of the customer.

***

<b class="para-title">email</b> <span style="font-size:12px; color: #8792a2;">string</span>\
This attribute represents email address of your customer.

***

<b class="para-title">currency</b> <span style="font-size:12px; color: #8792a2;">string</span>\
This attribute represents default preferred currency of your customer.

***

<b class="para-title">description</b> <span style="font-size:12px; color: #8792a2;">string</span>\
This attribute represents additional information about your customer.

***

<b class="para-title">phone</b> <span style="font-size:12px; color: #8792a2;">string</span>\
This attribute represents phone number of your customer.

***

<b class="para-title">metadata</b> <span style="font-size:12px; color: #8792a2;">object</span>\
You can use this to store additional information about the object in a structured format.

***

<b class="para-title">preferred\_locales</b> <span style="font-size:12px; color: #8792a2;">array of strings</span>\
The customer's preferred language.

***

<b class="para-title">timezone</b> <span style="font-size:12px; color: #8792a2;">string</span>\
This attribute represents time-zone of your customer.

***

<b class="para-title">created</b> <span style="font-size:12px; color: #8792a2;">timestamp</span>\
Time at which the object was created.

***

<b class="para-title">modified</b> <span style="font-size:12px; color: #8792a2;">timestamp</span>\
Time at which the last modification was made.