List all billing groups

GET 
/billing_groups

List all billing groups

Request

Query Parameters

page[number] integer

Possible values: >= 1

Default value: 1

The page number to load

page[size] integer

Possible values: >= 1 and <= 250

Default value: 20

The size of the page

Responses

200: A paginated array of billing groups

application/json

• Schema
• Example (from schema)

Schema

data

object[]

Array [

record_type string

Possible values: [billing_group]

Identifies the type of the resource.

id uuid

Identifies the type of resource.

organization_id uuid

Identifies the organization that owns the resource.

name string

A user-specified name for the billing group

created_at date-time

ISO 8601 formatted date indicating when the resource was created.

updated_at date-time

ISO 8601 formatted date indicating when the resource was updated.

deleted_at date-time

ISO 8601 formatted date indicating when the resource was removed.

]

meta

object

total_pages integer

total_results integer

page_number integer

page_size integer

{
  "data": [
    {
      "record_type": "billing_group",
      "id": "f5586561-8ff0-4291-a0ac-84fe544797bd",
      "organization_id": "f1486bae-f067-460c-ad43-73a92848f902",
      "name": "My billing group name",
      "created_at": "2019-10-15T10:07:15.527Z",
      "updated_at": "2019-10-15T10:07:15.527Z",
      "deleted_at": null
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}

default: Unexpected error

application/json

• Schema
• Example (from schema)

Schema

errors

Error[]

Array [

code intrequired

title stringrequired

detail string

source

object

pointer json-pointer

JSON pointer (RFC6901) to the offending entity.

parameter string

Indicates which query parameter caused the error.

meta object

]

{
  "errors": [
    {
      "code": "string",
      "title": "string",
      "detail": "string",
      "source": {
        "pointer": "string",
        "parameter": "string"
      },
      "meta": {}
    }
  ]
}

Loading...