Developers API reference Version 1 · generated from the code openapi.json
Routes

account

Read the usage of a plan

GET /api/v1/usage

What a space holds of what its plan allows: flows, steps and storage.

Required scope: read

Query parameters

  • space string · optional

    The space to measure: me (default) or org:<id>.

Response

200 Usage

  • space string

    The space measured, as asked.

  • plan string

    Code of the plan of that space.

  • meters array of Meter

    One meter per metric.

    4 fields
    • metric string

      What is counted.

    • used number

      How much the space holds.

    • limit number or null

      How much the plan allows; null when unlimited.

    • status string

      near: close to the limit. full: at the limit, nothing more can be added.

Errors

  • 401

    No valid credential.

  • 403

    The credential lacks the required scope, or the account may not do this.

  • 422

    A value is missing or malformed.

  • 429

    Too many requests; Retry-After gives the seconds to wait.

planner_banner_ad_pt