Update an address

Idempotency Supported

Adds or replaces the address for a subscription. If an address is already present for the specified label, it will be replaced otherwise new address is added with that label.

Sample Request

URL Format

POST https://[site].chargebee.com/api/v2/addresses

Input Parameters

subscription_id

required, string, max chars=50

A unique and immutable identifier for the subscription. If not provided, it is autogenerated.

label

required, string, max chars=50

Label to identify the address. This is unique for all the address for a subscription.

first_name

optional, string, max chars=150

First name.

last_name

optional, string, max chars=150

Last name.

optional, string, max chars=70

Email.

company

optional, string, max chars=250

Company name.

phone

optional, string, max chars=50

Phone number.

addr

optional, string, max chars=150

Address line 1.

extended_addr

optional, string, max chars=150

Address line 2.

extended_addr2

optional, string, max chars=150

Address line 3.

city

optional, string, max chars=50

Name of the city.

state_code

optional, string, max chars=50

The ISO 3166-2 state/province code without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code as AZ (not US-AZ ). For Tamil Nadu (India), set as TN (not IN-TN ). For British Columbia (Canada), set as BC (not CA-BC ).

state

optional, string, max chars=50

The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code is provided.

zip

optional, string, max chars=20

Zip or postal code. The number of characters is validated according to the rules specified here .

country

optional, string, max chars=50

The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code .

Note: If you enter an invalid country code, the system will return an error.

Brexit

If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.

validation_status

optional, enumerated string, default=not_validated

The address verification status.

not_validated

Address is not yet validated.

valid

Address was validated successfully.

partially_valid

The address is valid for taxability but has not been validated for shipping.

invalid

Address is invalid.

Returns

addressAddress object

Resource object representing address