Addresses

Subscriptions can have addresses like "Shipping Address" associated with them. This is apart from the billing address as part of credit card information.

Sample AddressJSON

API Index URL

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

Addresses attributes

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

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

State or Province

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.

zip

optional, string, max chars=20

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

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.

subscription_id

required, string, max chars=50

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