List addresses for a customer

gethttps://api.paddle.com/customers/{customer_id}/addresses

Returns a paginated list of addresses for a customer. Use the query parameters to page through results.

By default, Paddle returns addresses that are active. Use the status query parameter to return addresses that are archived.

Path Parameters

customer_idstringrequired

Paddle ID of the customer entity to work with.

Query Parameters

afterstring

Return entities after the specified Paddle ID when working with paginated endpoints. Used in the meta.pagination.next URL in responses for list operations.

idarray[string]

Return only the IDs specified. Use a comma-separated list to get multiple entities.

order_bystring

Order returned entities by the specified field and direction ([ASC] or [DESC]). For example, ?order_by=id[ASC].

Valid fields for ordering: id.

per_pageinteger

Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is requested. Check meta.pagination.per_page in the response to see how many were returned.

Default: 50; Maximum: 200.

searchstring

Return entities that match a search query. Searches all fields except status, created_at, and updated_at.

statusarray[string]

Return entities that match the specified status. Use a comma-separated list to specify multiple status values.

Response

dataarray[object]

Represents an address entity.

idstring

Unique Paddle ID for this address entity, prefixed with add_.

customer_idstring

Paddle ID for the customer related to this address, prefixed with cus_.

descriptionstring or null

Memorable description for this address.

first_linestring or null

First line of this address.

second_linestring or null

Second line of this address.

citystring or null

City of this address.

postal_codestring or null

ZIP or postal code of this address. Required for some countries.

regionstring or null

State, county, or region of this address.

country_codestring

Supported two-letter ISO 3166-1 alpha-2 country code for this address.

custom_dataobject or null

Your own structured key-value data.

statusstring

Whether this entity can be used in Paddle.

created_atstring<date-time>

RFC 3339 datetime string of when this entity was created. Set automatically by Paddle.

updated_atstring<date-time>

RFC 3339 datetime string of when this entity was updated. Set automatically by Paddle.

import_metaobject or null

Import information for this entity. null if this entity is not imported.

metaobject

Information about this response.

request_idstring

Unique ID for the request relating to this response. Provide this when contacting Paddle support about a specific request.

paginationobject

Keys used for working with paginated results.

Response