---
title: "Create invoice pay link"
method: POST
path: "/v1/account/invoices/{id}/pay-link"
tags: ["account"]
---

# Create invoice pay link

`POST /v1/account/invoices/{id}/pay-link`

## Request

- Base URL: `https://api.brixsignage.com`
- URL: `https://api.brixsignage.com/v1/account/invoices/{id}/pay-link`
- Auth: HTTP bearer

Creates a shareable payment link for one invoice, which can be paid by card or ACH bank transfer. The link can optionally be emailed directly, for example to forward to a finance team.

**Notes.**
- For an invoice Brix issued, `email` is ignored and `emailed` is always false.

## Path parameters

- `id` string, required

## Request body

- object
  - `ttlDays` number: Link lifetime in days, 1–180 (clamped). Default 30.
  - `email` string: Also email the link to this address (card subscription invoices only).

## Response `200`

Success.

- object
  - `data` object, required
    - `url` string, required: A web page where anyone with the link can see and pay the invoice.
    - `emailed` boolean, required

## 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`: Not an invoice of this workspace.
- `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)