Skip to main content

​
Object Structure

JSON
{
  "status": "success",
  "message": "customer created successfully",
  "data": {
    "id": "cus_abc123xyz456",
    "object": "customer",
    "created_at": "2025-10-13T14:30:00Z",
    "name": "Andrew Robin",
    "email": "andrew.robin@example.com",
    "country": "US",
    "phone": {
      "calling_code": "1",
      "number": "2025550183"
    },
    "billing_address": [
      {
        "name": "Andrew Robin",
        "address": {
          "line1": "123 Main Street",
          "line2": "Apt 45B",
          "city": "New York",
          "state": "NY",
          "country": "US",
          "postal_code": "10001"
        },
        "phone": {
          "calling_code": "1",
          "number": "2125550199"
        },
				"label":"home"
      }
    ],
    "shipping_address": [
      {
        "name": "Andrew Robin",
        "address": {
          "line1": "789 Broadway Avenue",
          "line2": "Suite 500",
          "city": "New York",
          "state": "NY",
          "country": "US",
          "postal_code": "10003"
        },
        "phone": {
          "calling_code": "1",
          "number": "9175550132"
        },
				"label":"home"
      }
    ],
    "metadata": {
      "referral_code": "REF2025ABC"
    }
  }
}

​
Parameters

​
Customer

FieldSubfieldTypeDescription
idstringThe unique identifier for the customer.
objectstringThe type of object, which is “customer”.
created_atstring (ISO Timestamp)The timestamp when the customer object was created.
namestringThe name of the customer.
emailstringThe email address of the customer.
countrystringThe country of the customer (e.g., SG for Singapore).
phoneobjectThe phone details of the customer. (See Phone Table)
billing_addressobjectThe billing details of the customer.
namestringThe name associated with the billing details.
addressobjectThe address associated with the billing details. (See Address Table)
phoneobjectThe phone details associated with the billing address. (See Phone Table)
labelstringDenotes the type of address (Example - home, work)
shipping_addressobjectThe shipping details of the customer.
namestringThe name associated with the shipping details.
addressobjectThe address associated with the shipping details. (See Address Table)
phoneobjectThe phone details associated with the shipping address. (See Phone Table)
labelstringDenotes the type of address (Example - home, work)
metadatajsonSet of key-value pairs attached to the customer

​
Phone

FieldTypeDescription
calling_codestringThe international calling code for the customer’s phone number.
numberstringThe phone number of the customer.

​
Address

FieldTypeDescription
line1stringThe first line of the address.
line2stringThe second line of the address
citystringThe city of the address.
statestring/nullThe state or province of the address (optional).
countrystringThe country code (e.g., SG for Singapore).
postal_codestringThe postal code of the address.