---
title: "Set payment option"
method: PATCH
path: "/v1/account/payment-option"
tags: ["account"]
---

# Set payment option

`PATCH /v1/account/payment-option`

## Request

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

Sets how a workspace billed directly by Brix pays: `card` or `invoice`. Choosing `card` requires a saved card and returns 409 if none exists; every invoice Brix issues is then charged to that card automatically. Returns 409 if the workspace is billed through the billing provider instead, and 404 for white-label workspaces.

## Request body

- object
  - `option` 'card' | 'invoice', required

## Response `200`

Success.

- object
  - `data` object, required
    - `changed` boolean, required
    - `payment` AccountPayment, required: Payment settings of an account that Brix invoices directly.
      - `option` 'card' | 'invoice', required: How issued invoices are paid: charged to the saved card, or paid from the invoice email.
      - `card` object, nullable, required
        - `brand` string, required
        - `last4` string, nullable, required
        - `expMonth` integer, nullable, required
        - `expYear` integer, nullable, required
        - `savedAt` string, nullable, required: ISO-8601 timestamp (UTC).
      - `backupCard` object, nullable, required: Charged once when the card is declined.
        - `brand` string, required
        - `last4` string, nullable, required
        - `expMonth` integer, nullable, required
        - `expYear` integer, nullable, required
        - `savedAt` string, nullable, required: ISO-8601 timestamp (UTC).
      - `lastPaid` object, nullable, required: The card the last invoice was paid with.
        - `label` string, required: `Visa •••• 5278`.
        - `brand` string, required
        - `last4` string, required
        - `invoiceNumber` string, required
        - `paidAt` string, nullable, required: ISO-8601 timestamp (UTC).
      - `cardAvailable` boolean, required: Card payment can be set up for this workspace.
      - `invoiceEmail` string, nullable, required: One more address that gets every invoice. The owners always get them.

## 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).
- `404`: A workspace billed by a partner.
- `409`: `not_brix_billed`, or `card_required` (save a card first).
- `422`: Bad `option`.
- `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)