Skip to main content
GET
/
customers
/
{customer_id}
/
addresses
/
{address_id}
Get an address for a customer
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.paddle.com/customers/{customer_id}/addresses/{address_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "data": {
    "id": "add_01hv8gq3318ktkfengj2r75gfx",
    "status": "active",
    "customer_id": "ctm_01hv6y1jedq4p1n0yqn5ba3ky4",
    "description": "Head Office",
    "first_line": "4050 Jefferson Plaza, 41st Floor",
    "second_line": null,
    "city": "New York",
    "postal_code": "10021",
    "region": "NY",
    "country_code": "US",
    "custom_data": null,
    "created_at": "2024-04-12T06:42:58.785Z",
    "updated_at": "2024-04-12T06:42:58.785Z",
    "import_meta": null
  },
  "meta": {
    "request_id": "74671066-d786-4e0c-9eb4-418d168d3a19"
  }
}

Authorizations

Authorization
string
header
required

Requests are authenticated with API keys. Provide your API key as a Bearer token in the Authorization header.

API keys are assigned permissions, granting them access to entities and operations. Each endpoint may require one or more permissions, defined with the x-permissions extension. Values for include parameters may require specific permissions as defined in the x-enum-permissions extension. See all available permissions in the permission schema or documentation.

Get an API key and select the permissions you need from the Paddle dashboard under Paddle > Developer Tools > Authentication.

Path Parameters

customer_id
string
required

Paddle ID of the customer entity to work with.

Example:

"ctm_01gw1xk43eqy2rrf0cs93zvm6t"

address_id
string
required

Paddle ID of the address entity to work with.

Example:

"add_01gvcz6r0t0g5cphhwd8n952gb"

Response

OK

data
Address · object
required

Represents an address entity.

meta
Meta · object
required

Information about this response.