PApaddlehq
Addresses

List addresses for a customer

Changed on

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.

get/customers/{customer_id}/addresses

Request

  • Base URL
    https://sandbox-api.paddle.com
  • Auth
    HTTP bearer

Path parameters

customer_idstring required

Unique Paddle ID for this customer entity, prefixed with ctm_.

Example:ctm_01grnn4zta5a1mf02jjze7y2ys

Paddle ID of the customer entity to work with.

Query parameters

idstring[]

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

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.

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.

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.

statusStatusQuery[]

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

searchstring

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

Headers

Skip-Countstring

Set to true to skip the count query on list operations. When set, meta.pagination.estimated_total returns -1 instead of an exact count.

Response

The request has succeeded.

Example response

{
  "data": [
    {
      "id": "add_01gm302t81w94gyjpjpqypkzkf",
      "customer_id": "ctm_01grnn4zta5a1mf02jjze7y2ys",
      "description": "Paddle.com",
      "first_line": "3811 Ditmars Blvd",
      "city": "Astoria",
      "postal_code": "11105-1803",
      "region": "NY",
      "custom_data": {
        "customer_reference_id": "abcd1234"
      },
      "created_at": "2024-10-12T07:20:50.52Z",
      "updated_at": "2024-10-13T07:20:50.52Z",
      "import_meta": {
        "external_id": "9b95b0b8-e10f-441a-862e-1936a6d818ab",
        "imported_from": "paddle_classic"
      }
    }
  ],
  "meta": {
    "request_id": "b15ec92e-8688-40d4-a04d-f44cbec93355",
    "pagination": {
      "estimated_total": 999
    }
  }
}

Changes

  • v14f35a8c6ea4dRevision changes
    • breaking

      added to the ////// response property oneOf list for the response status

  • v1e1ac347eb3c5Revision changes
    • breaking

      added the pattern ^ctm_[a-z\d]{26}$ to the path request parameter customer_id

    • info

      added the new optional header request parameter Skip-Count