PApaddlehq
Addresses

Update an address for a customer

Changed on

Updates an address for a customer using its ID and related customer ID.

If successful, your response includes a copy of the updated address entity.

patch/customers/{customer_id}/addresses/{address_id}

Request

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

Path parameters

address_idstring required

Paddle ID of the address entity to work with.

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.

Request body

descriptionstring nullable

Memorable description for this address.

first_linestring nullable

First line of this address.

second_linestring nullable

Second line of this address.

citystring nullable

City of this address.

postal_codestring nullable

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

regionstring nullable

State, county, or region of this address.

custom_dataCustomData

Your own structured key-value data.

status'active' | 'archived'

Whether this entity can be used in Paddle.

Example request

{
  "description": "Paddle.com",
  "first_line": "3811 Ditmars Blvd",
  "city": "Astoria",
  "postal_code": "11105-1803",
  "region": "NY",
  "custom_data": {
    "customer_reference_id": "abcd1234"
  }
}

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"
  }
}

Changes

  • v14f35a8c6ea4dRevision changes
    • breaking

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

    • info

      added to the //// request property oneOf list

  • v1e1ac347eb3c5Revision changes
    • breaking

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