The customer object
Unique identifier for the object.
Time at which the object was created. Measured in seconds since the Unix epoch.
customer The customer's address.
Show child attributes
Show child attributes
ID of the default payment method for the customer.
Whether the customer has any unpaid or past-due invoices.
An arbitrary description attached to the customer.
The customer's email address.
The prefix for the customer used to generate unique invoice numbers.
Invoicing preferences for the customer.
Show child attributes
Show child attributes
Legal information about the customer.
Show child attributes
Show child attributes
The customer's full name.
The customer's phone number.
Radar's risk assessment of the customer.
Show child attributes
Show child attributes
Present once a redaction has been created for this object. null when the object has never been redacted. Available from API version 2026-09-14.
Show child attributes
Show child attributes
The account that the object belongs to. Only returned if the request is made with a valid Yorlet-Context header.
Only returned if the object has been deleted.
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
Show child attributes
Show child attributes
Was this page helpful?
{
"id": "<string>",
"created": 123,
"object": "customer",
"address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"country": "<string>",
"postal_code": "<string>",
"state": "<string>"
},
"default_payment_method": "<string>",
"delinquent": true,
"description": "<string>",
"email": "[email protected]",
"invoice_prefix": "<string>",
"invoicing": {
"arrears_emails": true,
"email_cc": [
"[email protected]"
],
"email_to": "[email protected]"
},
"legal": {
"dob": {
"day": 16,
"month": 6,
"year": 5949
},
"first_name": "<string>",
"last_name": "<string>"
},
"name": "<string>",
"phone": "<string>",
"radar": {
"message": "<string>",
"reason": "<string>",
"risk_level": "<string>"
},
"redaction": {
"redacted_at": 123
},
"account": "<string>",
"deleted": false,
"metadata": {}
}