Properties
| Name | Type | Description |
|---|---|---|
| line1 | string | Primary street address line. |
| line2 | string | Secondary address line (apartment, suite, unit, etc.). |
| city | string | City or locality. |
| state | string | State, province, or region code. |
| zipcode | string | Postal or ZIP code. |
| country | string | ISO 3166-1 alpha-2 country code. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/affirm/refs/heads/main/json-schema/checkout-address-object-schema.json",
"title": "AddressObject",
"description": "A postal address.",
"type": "object",
"properties": {
"line1": {
"type": "string",
"description": "Primary street address line.",
"example": "example_value"
},
"line2": {
"type": "string",
"description": "Secondary address line (apartment, suite, unit, etc.).",
"example": "example_value"
},
"city": {
"type": "string",
"description": "City or locality.",
"example": "example_value"
},
"state": {
"type": "string",
"description": "State, province, or region code.",
"example": "example_value"
},
"zipcode": {
"type": "string",
"description": "Postal or ZIP code.",
"example": "example_value"
},
"country": {
"type": "string",
"description": "ISO 3166-1 alpha-2 country code.",
"example": "example_value"
}
}
}