Subscriptions can have addresses like "Shipping Address" associated with them. This is apart from the billing address as part of credit card information.
Sample address [ JSON ]
{
"addr": "PO Box 9999",
"city": "Walnut",
"country": "US",
"first_name": "John",
"label": "shipping_address",
"last_name": "Doe",
"object": "address",
"state": "California",
"state_code": "CA",
"subscription_id": "__test__KyVnHhSBWm2yX2rX",
"validation_status": "not_validated",
"zip": "91789"
}
Label to identify the address. This is unique for all the address for a subscription.
string, max chars=50
First name.
optional, string, max chars=150
Last name.
optional, string, max chars=150
Email.
optional, string, max chars=70
Company name.
optional, string, max chars=250
Phone number.
optional, string, max chars=50
Address line 1.
optional, string, max chars=150
Address line 2.
optional, string, max chars=150
Address line 3.
optional, string, max chars=150
City.
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
).
optional, string, max chars=50
State or Province.
optional, string, max chars=50
Zip or Postal code.
optional, string, max chars=20
The address verification status.
optional, enumerated string, default=not_validatedPossible values are
not_validatedAddress is not yet validated.validAddress was validated successfully.partially_validAddress is verified but only partially.invalidAddress is invalid.
A unique and immutable identifier for the subscription. If not provided, it is autogenerated.
string, max chars=50
Retrieves an address resource for a subscription and the specified label.
Sample Request
curl https://{site}.chargebee.com/api/v2/addresses \
-G \
-u {site_api_key}:\
-d subscription_id="__test__KyVnHhSBWm2yX2rX" \
-d label="shipping_address"
copy
curl https://{site}.chargebee.com/api/v2/addresses \
-G \
-u {site_api_key}:\
-d subscription_id="__test__KyVnHhSBWm2yX2rX" \
-d label="shipping_address"
Sample Response [ JSON ]
Show more...
{"address": {
"addr": "PO Box 9999",
"city": "Walnut",
"country": "US",
"first_name": "John",
"label": "shipping_address",
"last_name": "Doe",
"object": "address",
"state": "California",
"state_code": "CA",
"subscription_id": "__test__KyVnHhSBWm2yX2rX",
"validation_status": "not_validated",
"zip": "91789"
}}
URL Format GET
https://{site}.chargebee.com/api/v2/addresses
A unique and immutable identifier for the subscription. If not provided, it is autogenerated.
required, string, max chars=50
Label to identify the address. This is unique for all the address for a subscription.
required, string, max chars=50
Resource object representing address.
always returned
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
curl https://{site}.chargebee.com/api/v2/addresses \
-u {site_api_key}:\
-d subscription_id="__test__KyVnHhSBWm3I82re" \
-d label="shipping_address" \
-d first_name="Benjamin" \
-d last_name="Ross" \
-d addr="PO Box 9999" \
-d city="Walnut" \
-d state="California" \
-d zip="91789" \
-d country="US"
copy
curl https://{site}.chargebee.com/api/v2/addresses \
-u {site_api_key}:\
-d subscription_id="__test__KyVnHhSBWm3I82re" \
-d label="shipping_address" \
-d first_name="Benjamin" \
-d last_name="Ross" \
-d addr="PO Box 9999" \
-d city="Walnut" \
-d state="California" \
-d zip="91789" \
-d country="US"
Sample Response [ JSON ]
Show more...
{"address": {
"addr": "PO Box 9999",
"city": "Walnut",
"country": "US",
"first_name": "Benjamin",
"label": "shipping_address",
"last_name": "Ross",
"object": "address",
"state": "California",
"state_code": "CA",
"subscription_id": "__test__KyVnHhSBWm3I82re",
"validation_status": "not_validated",
"zip": "91789"
}}
URL Format POST
https://{site}.chargebee.com/api/v2/addresses
A unique and immutable identifier for the subscription. If not provided, it is autogenerated.
required, string, max chars=50
Label to identify the address. This is unique for all the address for a subscription.
required, string, max chars=50
First name.
optional, string, max chars=150
Last name.
optional, string, max chars=150
Email.
optional, string, max chars=70
Company name.
optional, string, max chars=250
Phone number.
optional, string, max chars=50
Address line 1.
optional, string, max chars=150
Address line 2.
optional, string, max chars=150
Address line 3.
optional, string, max chars=150
City.
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
).
optional, string, max chars=50
The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code
is provided.
optional, string, max chars=50
Zip or Postal code.
optional, string, max chars=20
The address verification status.
optional, enumerated stringPossible values are
not_validatedAddress is not yet validated.validAddress was validated successfully.partially_validAddress is verified but only partially.invalidAddress is invalid.
Resource object representing address.
always returned