younifyd
Menu

Retrieve An Address

Retrieve an address

GET/addresses

Use it in a workflow

  1. Add a step and choose the Chargebee connector.
  2. Pick the Retrieve An Address action (under Chargebee API).
  3. Fill in the fields below, then reference the result from later steps as {{retrieveAnAddress.response.data}}.

Request

Query parameters

subscription_idstringrequired

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

labelstringrequired

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

Headers

chargebee-request-origin-devicestring

The device from which the customer has made the request

chargebee-request-origin-userstring (email)

The email address of your customer/user. Use this when the email address has only ASCII characters.

chargebee-request-origin-user-encodedstring (email)

The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.

chargebee-request-origin-ipstring

The IP address of the customer where the request originated

chargebee-business-entity-idstring

If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.

Response

Returns 200 with an object. Read it in later steps with {{retrieveAnAddress.response.data.<field>}}.

addressobject

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

labelstringrequired

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

first_namestring

First name

last_namestring

Last name

emailstring (email)

Email

companystring

Company name

phonestring

Phone number

addrstring

Address line 1

extended_addrstring

Address line 2

extended_addr2string

Address line 3

citystring

Name of the city

state_codestring

<p class="mb-2">The <a href="https://www.iso.org/obp/ui/#search" target="_blank">ISO 3166-2 state/province code</a> without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code> as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">AZ</code> (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">US-AZ</code> ). For Tamil Nadu (India), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">TN</code> (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">IN-TN</code> ). For British Columbia (Canada), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">BC</code> (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">CA-BC</code> ).</p>

statestring

State or Province

countrystring

<p class="mb-2">The billing address country of the customer. Must be one of <a href="https://www.iso.org/iso-3166-country-codes.html" target="_blank" rel="noopener noreferrer">ISO 3166 alpha-2 country code</a> .</p> <p class="mb-2"><strong class="font-semibold">Note</strong>: If you enter an invalid country code, the system will return an error.</p> <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Brexit</strong></p><p class="mb-2">If you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank" rel="noopener noreferrer">EU VAT</a> in 2021 or later, or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank" rel="noopener noreferrer">manually enable</a> the Brexit configuration, then <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code> (the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>) is available as an option.</p></div>

zipstring

Zip or postal code. The number of characters is validated according to the rules [specified here](https://chromium-i18n.appspot.com/ssl-address) .

validation_statusstring

The address verification status. \* partially_valid - The address is valid for taxability but has not been validated for shipping. \* not_validated - Address is not yet validated. \* invalid - Address is invalid. \* valid - Address was validated successfully.

One ofnot_validatedvalidpartially_validinvalidDefault "not_validated"

subscription_idstringrequired

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

json
{
  "address": null
}

Need more? See the Chargebee guide for connection setup and behaviour shared by every action.

Retrieve An Address — Chargebee — Documentation