Get a customer's balance link

GET

/invoices/balance-link

const url = 'https://example.com/invoices/balance-link?customerId=019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f';
const options = {
  method: 'GET',
  headers: {cookie: '__Host-bottle.session_token=<__Host-bottle.session_token>'}
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://example.com/invoices/balance-link?customerId=019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f' \
  --cookie __Host-bottle.session_token=<__Host-bottle.session_token>

The customer’s own link for paying every unpaid invoice they were offered a card link for, in one card payment, and what it would pay now. The link is null unless two or more invoices are due.

Authorizations

sessionCookie
invoices:read
apiKey
invoices:read

Parameters

Query Parameters

customerId

required

UUID v7

string format: uuid

Example

019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f

UUID v7

Responses

200

What the balance link would pay

application/json

object

customerId

required

UUID v7

string format: uuid

invoices

required

integer

amountPence

required

integer

url

required

string | null

Example

{
  "customerId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
}

401

Not signed in

application/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}

403

Not a member, or without the permission this needs

application/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}

404

No such customer

application/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}

422

Validation failed

application/json

object

error

required

string

Allowed values: validation

message

required

string

issues

required

Array<object>

object

path

required

string

message

required

string

Example

{
  "error": "validation",
  "issues": [
    {
      "path": "email",
      "message": "Invalid email"
    }
  ]
}