v1

latestOpenAPI 3.0.1Apache 2.02026-07-26193304444.4 KB

Customer Addresses

Create a new address for a customer

Creates a new address for the specified customer.

Validation Rules:

country_code: Required, must be a valid ISO 3166-1 alpha-2 code (e.g., US, NZ, AU)
state_code: Required for US and CA, must be valid for the country
postcode: Required, must be valid format for the country
type: Required, must be either BILLING or SHIPPING
address_line_1: Required, maximum 50 characters
city: Required, maximum 28 characters
state: Maximum 35 characters

🔒 Requires: customers:write scope

post/customers/{customer_id}/addresses

customer_idstring uuid required

The unique identifier of the customer.

address_line_1string required

Primary address line (street address, P.O. box, etc.).

address_line_2string nullable

Secondary address line (apartment, suite, unit, building, floor, etc.).

citystring required

City or town name.

country_codestring required

ISO 3166-1 alpha-2 country code (e.g., US, NZ, AU).

postcodestring required

Postal code or ZIP code.

statestring nullable

State, province, or region name.

state_codestring nullable

State or province code. Required for US and CA.

suburbstring nullable

Suburb or district.

type'BILLING' | 'SHIPPING' required

The type of address.

Address created successfully