---
title: "Get billing address"
method: GET
path: "/v1/account/billing-address"
tags: ["account"]
---

# Get billing address

`GET /v1/account/billing-address`

## Request

- Base URL: `https://api.brixsignage.com`
- URL: `https://api.brixsignage.com/v1/account/billing-address`
- Auth: HTTP bearer

Returns the billing address on file with the billing provider: the country used to determine invoice tax, and, for the United States and Canada, the state and postal code. The response includes `configured: false` when no billing address has been set yet.

## Response `200`

Success.

- object
  - `data` union, required
    - object
      - `configured` true, required
      - `address` object, required
        - `country` string, nullable, required: ISO 3166-1 alpha-2.
        - `stateCode` string, nullable, required: State or province, without the country prefix (`CA`, `ON`).
        - `zip` string, nullable, required
        - `city` string, nullable, required
        - `line1` string, nullable, required
      - `needsState` boolean, required: The country needs a state and postal code (US, Canada).
    - object
      - `configured` false, required
      - `address` unknown, required
      - `reason` string: Present when the address could not be read.

## Other responses

- `401`: Missing, expired or revoked bearer token.
- `403`: You do not hold the permission for the whole workspace (a grant at one location is not enough).
- `5XX`: Server error. The body carries a `requestId` to quote to support.

---

[API](https://skmtc.dev/brixsignage/apis/brix-api.md) · [All operations](https://skmtc.dev/brixsignage/apis/brix-api/llms.txt) · [OpenAPI document](https://skmtc.dev/brixsignage/apis/brix-api/revisions/02fd3665dc7d?raw)