Params

Param name Description
organization_id
required

Organization ID

Validations:

  • Must be a number.

page
optional

Page number, starting at 1

Validations:

  • Must be a number.

per_page
optional

Number of results per page to return.

Validations:

  • Must be a number.

order
optional

The order to sort the results in. [asc, desc] Defaults to ‘desc’.

Validations:

  • String

sort_by
optional

The field to sort the data by. Defaults to the created date.

Validations:

  • String

pool_ids
optional

Return only the upstream pools which map to the given local pool IDs

Validations:

  • Must be an array of any type

quantities_only
optional

Only returns id and quantity fields

Validations:

  • Must be one of: true, false, 1, 0

attachable
optional

Return only subscriptions which can be attached to the upstream allocation

Validations:

  • Must be one of: true, false, 1, 0