Sign in
Subscriptions

List the quotas for a given subscription

Changed on
get/subscriptions/{subscription_id}/quotas

Request

  • The document declares no server URL.
  • Auth: one of:
    • HTTP bearer
    • API key in header x-pollination-token

Path parameters

subscription_idstring uuid required

Response

Successful Response

type'storage' | 'compute_hours' | 'parallel_workflow_containers' | 'runs_per_study' | 'private_repositories' | 'private_projects' | 'teams' | 'members' | 'cpu_limit' | 'memory_limit' | 'rhino_plugin_license' | 'revit_plugin_license' | 'application_cpu' | 'application_memory' required

The type of comsumption-limited resource to which the quota refers.

idstring uuid

The unique ID for this Quota

period_startstring date-time

The start of the quota usage tracking period

limitnumber double

The maximum amount of a resource the account can consume

usagenumber double

The current amount of a resource allocated to the account linked to the subscription

resetsboolean

Whether consumption is reset to 0 every billing period

enforcedboolean

Whether the limit triggers a blocking response from the server

exceededboolean

Whether the resource usage is greater than or equal to the limit

display_namestring

The human-readable name

descriptionstring

The description

unitstring

The unit in which the usage and limit are measured

Example response

[
  {
    "owner": {
      "id": "0ad77f99-8043-46e4-8220-7221487c3ee5",
      "account_type": "user",
      "name": "ladybugbot",
      "display_name": "Ladybug Bot",
      "description": "Beep Boop!"
    }
  }
]

Changes

  • e25504ef9dccRevision changes
    • breaking

      response property detail/items/loc/items/ list-of-types was widened by adding types integer to media type application/json of response 422

    • warning

      added the new runs_per_study enum value to the /// response property for the response status

  • be42c3cf5190Revision changes
    • info

      endpoint added