Get customer billing address

Overview

Get the latest saved billing address for a user (with its city -> state -> country chain). If that user's company pays via partner or brand (who_will_pay), the billing address of the paying company's owner user comes back instead. This way the invoice always resolves to the party that actually pays. Read-only; returns null in data when no address is stored yet.

Prerequisites

• A bearer token in the Authorization header.

Base URL

Endpoint

GET /api/v1/billing-address/get

Authentication

• Requires a bearer token in the Authorization: Bearer <bearer-token> header.

• Bearer account / partner token.

• user_id must sit inside your own account tree. It must be a user inside the caller's own company hierarchy.

Rate limit

• No rate limit.

Query parameters

How it works

• 200 — { data: {.} } with the address, or { data: null } when none exists. Column aliases,. Also returns city.state.country.
• 422 — user_id missing/invalid or outside the caller's hierarchy.

Response

200 OK · 200

{
  "data": {
    "id": 1,
    "user_id": 3,
    "city_id": 456,
    "name": "Test User",
    "billing_email": "[email protected]",
    "mobile": "123-456-7890",
    "zipcode": "12345",
    "billing_address": "123 Example St",
    "company": "Example Corp",
    "city": {
      "id": 456,
      "name": "Megarine",
      "state_id": 4902,
      "state": {
        "id": 4902,
        "name": "Sidi Bel Abb\u00e8s",
        "country_id": 4,
        "country": {
          "id": 4,
          "name": "Algeria"
        }
      }
    }
  }
}

200 OK (no address saved) · 200

{
  "data": null
}

422 Out of scope · 422

{
  "message": "The selected user id does not belong to your company hierarchy.",
  "errors": {
    "user_id": [
      "The selected user id does not belong to your company hierarchy."
    ]
  }
}

Errors

Example request

curl --request GET \
  --url "https://production-api.shoutaboutus.com/api/v1/billing-address/get?user_id=123" \
  --header 'Authorization: Bearer <bearer-token>' \
  --header 'Accept: application/json'