VEverbiflow
sequences

Get Workspace Credit Summary

get/api/workspace/credit-summary

Request

  • Base URL
    https://platform.verbiflow.com/api/bridge
  • URL
    https://platform.verbiflow.com/api/bridge/api/workspace/credit-summary
  • Auth
    • HTTP bearer and API key in header x-flage-org-id
    • or HTTP bearer and API key in header x-flage-org-slug

Response

Successful Response

base_credits_limitstring required

Exact non-negative credit quantity in canonical decimal notation.

billing_state'known' | 'needs_reconciliation' required

Whether the Stripe billing period is authoritative. needs_reconciliation uses a provisional calendar-month period for continued execution.

credit_overage_mode'metered' | 'blocked' required

Whether work above included capacity remains metered or is blocked.

credits_availablestring required

Exact non-negative credit quantity in canonical decimal notation.

credits_consumedstring required

Exact non-negative credit quantity in canonical decimal notation.

credits_limitstring required

Exact non-negative credit quantity in canonical decimal notation.

credits_reservedstring required

Exact non-negative credit quantity in canonical decimal notation.

credits_usedstring required

Exact non-negative credit quantity in canonical decimal notation.

hard_credits_availablestring required

Exact non-negative credit quantity in canonical decimal notation.

hard_credits_limitstring required

Exact non-negative credit quantity in canonical decimal notation.

included_overage_creditsstring required

Exact non-negative credit quantity in canonical decimal notation.

is_hard_limit_reachedboolean required

Whether no credit capacity remains before the workspace hard ceiling.

is_over_included_limitboolean required

Whether consumed plus reserved credits exceed included and purchased capacity.

purchased_creditsstring required

Exact non-negative credit quantity in canonical decimal notation.

Changes

No recorded changes to this operation across all 1 revision of this API.