An address.
Property | Description |
---|---|
addressLine1 nullable |
The first line of the address. |
addressLine2 nullable |
The second line of the address, if applicable. |
city nullable |
The city for this address. |
country |
The country code for this address. |
name nullable |
The name of the addressee. |
state nullable |
The state for this address. |
stateOther nullable write-only |
The This property is write-only. It is not available in responses. |
type |
The type of object represented. |
zip nullable |
The postal code for this address. |
The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.
{
"description": "An address.",
"properties": {
"addressLine1": {
"description": "The first line of the address.",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"addressLine2": {
"description": "The second line of the address, if applicable.",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"city": {
"description": "The city for this address.",
"maxLength": 50,
"nullable": true,
"type": "string"
},
"country": {
"description": "The country code for this address.",
"maxLength": 2,
"minLength": 2,
"type": "string"
},
"name": {
"description": "The name of the addressee.",
"maxLength": 50,
"nullable": true,
"type": "string"
},
"state": {
"description": "The state for this address.",
"nullable": true,
"type": "string"
},
"stateOther": {
"description": "The `state` property is validated against known states/provinces of all\ncountries. If this address does not have a standard state/province\nabbreviation, use the `stateOther` property when creating or updating\naddresses.\n\n*This property is write-only. It is not available in responses.*",
"maxLength": 50,
"nullable": true,
"type": "string",
"writeOnly": true
},
"type": {
"description": "The type of object represented.",
"enum": [
"address"
],
"type": "string"
},
"zip": {
"description": "The postal code for this address.",
"maxLength": 10,
"nullable": true,
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
}
},
"required": [
"type",
"country"
],
"type": "object"
}