logo

Invoices

Endpoints related to hub invoices, including the ability to pay an invoice.

List Billing Invoices

List the Invoices assoicated with the Hub.

Requires the billing-invoices-view capability.

SecuritybearerAuth and hubAuth
Request
query Parameters
sort
Array of strings

An array of sort values. To sort descending, put a - in front of the value, e.g. -id.

object

In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be page[size]=20&page[number]=2

meta
Array of strings

A comma separated list of meta values. Meta values will show up under a resource's meta field. In the case of applying a meta to a collection of resources, each resource will have it's own relevant meta data. In some rare cases, meta may not apply to individual resources, and may appear in the root document. These will be clearly labeled.

Items Value: "due"
object

Filter Field

The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.

Responses
200

Returns a list of Invoices.

default

General error response from the platform

get/v1/billing/invoices
Response samples
application/json
{
  • "data": [
    ]
}

Get Billing Invoice

Requires the billing-invoices-view capability.

SecuritybearerAuth and hubAuth
Request
path Parameters
invoiceId
required
string

The ID of the invoice.

query Parameters
meta
Array of strings

A comma separated list of meta values. Meta values will show up under a resource's meta field. In the case of applying a meta to a collection of resources, each resource will have it's own relevant meta data. In some rare cases, meta may not apply to individual resources, and may appear in the root document. These will be clearly labeled.

Items Value: "due"
Responses
200

Returns an invoice resource.

default

General error response from the platform

get/v1/billing/invoices/{invoiceId}
Response samples
application/json
{
  • "data": {
    }
}

Create Invoice Job

Creates a new Job on an Invoice. Generally used to make a payment on an Invoice.

Requires the billing-invoices-pay capability.

SecuritybearerAuth and hubAuth
Request
path Parameters
invoiceId
required
string

The ID of the invoice.

Request Body schema: application/json
action
required
string

The name of the action to perform.

Value: "pay"
Responses
202

Returns a Job Descriptor.

default

General error response from the platform

post/v1/billing/invoices/{invoiceId}/tasks
Request samples
application/json
{
  • "action": "pay"
}
Response samples
application/json
{
  • "data": {
    }
}
➔ Next to Methods