| Field | Type | Required | Description | Example |
|---|---|---|---|---|
resource |
String | ✔️ | Indicates the response contains a customer object. Will always contain the string customer for this endpoint. |
customer |
id |
String | ✔️ | The identifier uniquely referring to this customer. Example: cst_vsKJpSsabw. |
cst_5B8cwPMGnU |
mode |
Mode | ✔️ | Whether this entity was created in live mode or in test mode. | live |
name |
Optional<String> | ✔️ | The full name of the customer. | John Doe |
email |
Optional<String> | ✔️ | The email address of the customer. If the domain contains non-ASCII characters, encode it as Punycode per RFC 3492. |
example@email.com |
locale |
Optional<LocaleResponse> | ✔️ | Allows you to preset the language to be used. | en_US |
metadata |
Optional<Metadata> | ✔️ | Provide any data you like, for example a string or a JSON object. We will save the data alongside the entity. Whenever you fetch the entity with our API, we will also include the metadata. You can use up to approximately 1kB. |
|
createdAt |
String | ✔️ | The entity's date and time of creation, in ISO 8601 format. | 2024-03-20T09:13:37+00:00 |
links |
CustomerResponseLinks | ✔️ | An object with several relevant URLs. Every URL object will contain an href and a type field. |