Operations API
Addresses

Create Address

This API endpoint (POST) creates a new address for a customer. If the request succeeds, it returns an Address Object. Permissions: customer.edit Webhook event: customer-updated

Path Parameters

id * The id of the customer.

Body Parameters

phone string The customer's billing phone.



name string * The customer's billing name or company.



representative string The name of the contact person for this address.



is_company boolean This attribute shows whether this address belongs to a business or an individual.



email string * The customer's email.



shipping_address boolean Always false for billing addresses.



address string * The customer's address.



city string * The customer's city.



postcode string The customer's postcode.



state string (State Codes) The customer's state (if supported).



country string (Country Codes) * The customer's billing country in ISO 3166 format.



vat string The customer's VAT number (if supported).



locale string (Language Codes) The preferred language of the representative for this address. The default value is English (en).