# Retrieve an address

> For the complete machine-readable documentation index, see [llms.txt](https://apidocs.chargebee.com/llms.txt).


Retrieves an address resource for a subscription and the specified label.

## Sample Request

#### cURL

```bash
curl  https://{site}.chargebee.com/api/v2/addresses \
     -G  \
     -u {site_api_key}:\
     -d subscription_id="__test__KyVnHhSBWm2yX2rX" \
     -d label="shipping_address"
```

#### .NET

```dotnet
using ChargeBee.Api;
using ChargeBee.Models;

ApiConfig.Configure("{site}","{site_api_key}");
EntityResult result = Address.Retrieve()
		.SubscriptionId("__test__KyVnHhSBWm2yX2rX")
		.Label("shipping_address")
		.Request();

Address address = result.Address;
```

#### Go

```go
package main
import (
    "fmt"
    "github.com/chargebee/chargebee-go/v3"
    addressAction "github.com/chargebee/chargebee-go/v3/actions/address"
    "github.com/chargebee/chargebee-go/v3/models/address"
)
func main() {
    chargebee.Configure("{site_api_key}","{site}");
    res,err := addressAction.Retrieve(&address.RetrieveRequestParams{
        SubscriptionId : "__test__KyVnHhSBWm2yX2rX",
        Label : "shipping_address",
    }).Request()
    if err != nil {
        fmt.Println(err)
    } else {
        Address := res.Address
    }
}
```

#### Go

```go
package main

import (
  "fmt"
  "github.com/chargebee/chargebee-go/v4"
)

func main() {
  config := &chargebee.ClientConfig{
    SiteName: "{site}",
    ApiKey: "{site_api_key}",
  }    
  client := chargebee.NewClient(config)
  req := &chargebee.AddressRetrieveRequest{
    SubscriptionId : "__test__KyVnHhSBWm2yX2rX",
    Label : "shipping_address",
}
  res, err := client.Address.Retrieve(req)
      if err != nil {
        fmt.Println(err)
    } else {
        Address := res.Address
    }
}
```

#### Java

```java
import com.chargebee.*;
import com.chargebee.ListResult;
import com.chargebee.models.*;
import com.chargebee.models.enums.*;
import java.io.IOException;

public class Sample {

    public static void main(String args[]) throws IOException, Exception {
        Environment.configure("{site}", "{site_api_key}");
        Result result = Address.retrieve()
            .subscriptionId("__test__KyVnHhSBWm2yX2rX")
            .label("shipping_address")
            .request();

        Address address = result.address();
    }
}
```

#### Java

```java
import com.chargebee.v4.client.ChargebeeClient;
import com.chargebee.v4.models.address.Address;
import com.chargebee.v4.models.address.params.AddressRetrieveParams;
import com.chargebee.v4.models.address.responses.AddressRetrieveResponse;

public class AddressRetrieve {

    public static void main(String[] args) {
        ChargebeeClient client = ChargebeeClient.builder()
            .apiKey("{site_api_key}")
            .siteName("{site}")
            .build();

        AddressRetrieveParams params = AddressRetrieveParams.builder()
            .subscriptionId("__test__KyVnHhSBWm2yX2rX")
            .label("shipping_address")
            .build();

        AddressRetrieveResponse response = client.addresses().retrieve(params);

        Address address = response.getAddress();
    }
}
```

#### Node.js

```node
import Chargebee from "chargebee";

const chargebee = new Chargebee({
    site: "{site}",
    apiKey: "{site_api_key}",
});

try {
    const result = await chargebee.address.retrieve({
        subscription_id: "__test__KyVnHhSBWm2yX2rX",
        label: "shipping_address"
    });

    console.log(result);
    const address = result.address;
} catch (err) {
    console.log(err);
}
```

#### PHP

```php
<?php

require __DIR__ . '/vendor/autoload.php';

use Chargebee\ChargebeeClient;

$chargebee = new ChargebeeClient(options: [
    "site" => "{site}",
    "apiKey" => "{site_api_key}",
]);
$result = $chargebee->address()->retrieve([
    "subscription_id" => "__test__KyVnHhSBWm2yX2rX",
    "label" => "shipping_address"
]);
$address = $result->address;
```

#### Python

```python
from chargebee import Chargebee

cb_client = Chargebee(api_key="{site_api_key}", site="{site}")
response = cb_client.Address.retrieve(
    cb_client.Address.RetrieveParams(
        subscription_id="__test__KyVnHhSBWm2yX2rX",
        label="shipping_address"
    )
)
address = response.address
```

#### Ruby

```ruby
require 'chargebee'

ChargeBee.configure(:site => "{site}",
  :api_key => "{site_api_key}")

result = ChargeBee::Address.retrieve({
  :subscription_id => "__test__KyVnHhSBWm2yX2rX",
  :label => "shipping_address"
})

address = result.address
```

## Sample Response

```json
{
  "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

## 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.

## Returns

- `address` (Address object)
  Resource object representing address