UserAddress

  • Name
    object
    Type
    string
    Description

    Type of object is always userAddress.

    Allowed values: userAddress 
  • Name
    id
    Type
    string
    Description

    Unique identifier for the address.

    Example: "adr_0SNlurA049MEWV5ELDmnaqVXgTFT"
  • Name
    city
    Type
    string
    Description

    The city/municipality of the address.

    Example: "New York City"
  • Name
    country
    Type
    string
    Description

    The ISO 3166-1 alpha-2 country code of the address.

    Example: "US"
  • Name
    createdAt
    Type
    string
    Description

    The time the address was created.

    Example: "2021-01-21T19:38:34Z"
  • Name
    line1
    Type
    string
    Description

    The first line of the address, e.g. street and house number.

    Example: "129 West 81st Street"
  • Name
    line2
    Type
    nullable string
    Description

    The second line of the address, e.g. apartment number.

    Example: "Apartment 5"
  • Name
    postalCode
    Type
    nullable string
    Description

    The postal code of the address.

    Example: "10024"
  • Name
    state
    Type
    nullable string
    Description

    The state/province/region of the address.

    Example: "NY"
  • Name
    user
    Type
    string
    Description

    Unique identifier for the address user.

    Example: "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"

Example

{
  "object": "userAddress",
  "id": "adr_0SNlurA049MEWV5ELDmnaqVXgTFT",
  "city": "New York City",
  "country": "US",
  "createdAt": "2021-01-21T19:38:34.0Z",
  "line1": "129 West 81st Street",
  "line2": "Apartment 5",
  "postalCode": "10024",
  "state": "NY",
  "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
}