v1

latestOpenAPI 3.1.02026-07-241040774.6 KB

Listar endereços

Este recurso permite a recuperação dos endereços de um determinado cliente através do seu identificador(customer_id). Pode ser utilizados alguns parâmetros como filtro da listagem.

get/customers/{customer_id}/addresses

Path parameters

customer_idstring required

Código do cliente. Formato: cus_XXXXXXXXXXXXXXXX.

Query parameters

pageinteger

Página atual.

sizeinteger

Quantidade de itens.

Response

200

Example response

{
  "data": [
    {
      "id": "addr_84BkRGZBtWiYJ9ox",
      "line_1": "10882, Malibu Point, Central Malibu",
      "zip_code": "90265",
      "city": "Malibu",
      "state": "CA",
      "country": "US",
      "status": "active",
      "created_at": "2017-04-19T17:49:05Z",
      "updated_at": "2017-04-19T17:49:05Z"
    }
  ],
  "paging": {
    "total": 2
  }
}