Bottle's invoices to a business

GET

/console/businesses/{id}/invoices

const url = 'https://example.com/console/businesses/019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f/invoices';
const options = {
  method: 'GET',
  headers: {cookie: 'bottle.session_token=<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/console/businesses/019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f/invoices \
  --cookie bottle.session_token=<bottle.session_token>

What Stripe has billed the business for Bottle, newest first: the same list the business sees on its billing page. Empty while it is on trial, or where billing is not set up.

Authorizations

consoleRole
support

Parameters

Path Parameters

required

UUID v7

string format: uuid

Example

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

UUID v7

Responses

200

Invoices

application/json

object

invoices

required

Array<object>

object

required

string

number

required

string | null

date

required

string format: date-time

total

required

integer

currency

required

ISO 4217, lower case, as Stripe writes it.

string

status

required

string

Allowed values: draft open paid uncollectible void

url

required

string | null format: uri

pdfUrl

required

string | null format: uri

Example

{
  "invoices": [
    {
      "status": "draft"
    }
  ]
}

401

Not signed in

application/json

object

error

required

string

message

required

string

Example

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

403

Not Bottle staff, no two-step sign-in, or a console role too low for this

application/json

object

error

required

string

message

required

string

Example

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

404

Not found

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"
    }
  ]
}