Billing

Read current billing usage

Return current billing usage.

GET/v1/usage

Headers

authorization string required

Bearer workspace API key.

ExampleBearer $NQD_API_KEY
workspace-id string required

Workspace scope for the request. Required for workspace operations and must belong to the authenticated identity.

Minimum length: 1 character. · Maximum length: 128 characters.

Example01JQ2T5Y5Q3R8W9N6M4K2H7P1A

Response

200Success

Response headers

x-request-id string

Correlation identifier returned with every response for support and request tracing.

Example550e8400-e29b-41d4-a716-446655440000
data object

Returned records. Collections and batches use an array; single records use an object.

ShowHide 5 properties
data.currentPlan object

current plan for this usage.

ShowHide 9 properties
data.currentPlan.id string

Opaque identifier for this resource or reference.

Examplefree
data.currentPlan.kind string

kind within current plan.

Allowed values: "free", "pro", "business", "enterprise", "elite", "vip"

Examplefree
data.currentPlan.tier string

tier within current plan.

Allowed values: "free", "solo", "team", "business", "enterprise"

Examplefree
data.currentPlan.name object

Display name of the record.

ShowHide 2 properties
data.currentPlan.name.en string

en within name.

ExampleConsulting services
data.currentPlan.name.ar string

ar within name.

ExampleConsulting services
data.currentPlan.monthlyPrice number

monthly price within current plan.

Example100
data.currentPlan.yearlyPrice number

yearly price within current plan.

Example100
data.currentPlan.currency string

Referenced currency with its opaque ID and ISO 4217 currency code.

ExampleConsulting services
data.currentPlan.limits object

limits within current plan.

ShowHide 1 property
data.currentPlan.limits.paymentsPerMonth number

payments per month within limits.

Example100
data.currentPlan.features object

features within current plan.

ShowHide 3 properties
data.currentPlan.features.recurringAutomation boolean

recurring automation within features.

Exampletrue
data.currentPlan.features.teamCollaboration boolean

team collaboration within features.

Exampletrue
data.currentPlan.features.webhooks boolean

webhooks within features.

Exampletrue
data.participantCount number

participant count for this usage.

Example1
data.billingSubscription object

billing subscription for this usage.

ShowHide 7 properties
data.billingSubscription.status string

Current status of the record or operation.

Exampleactive
data.billingSubscription.productName string

product name within billing subscription.

ExampleConsulting services
data.billingSubscription.variantName string

variant name within billing subscription.

ExampleConsulting services
data.billingSubscription.renewsAt string

ISO 8601 timestamp for renews.

Example2026-01-15T12:00:00.000Z
data.billingSubscription.endsAt string

ISO 8601 timestamp for ends.

Example2026-01-15T12:00:00.000Z
data.billingSubscription.cancelledAt string

ISO 8601 timestamp for cancelled.

Examplenull
data.billingSubscription.trialEndsAt string

ISO 8601 timestamp for trial ends.

Example2026-01-15T12:00:00.000Z
data.billingInvoicesCount number

billing invoices count for this usage.

Example1
data.paymentUsage object

payment usage for this usage.

ShowHide 7 properties
data.paymentUsage.planId string

ID of the related plan.

Examplefree
data.paymentUsage.capacity number

capacity within payment usage.

Example100
data.paymentUsage.used number

used within payment usage.

Example100
data.paymentUsage.remaining number

remaining within payment usage.

Example0
data.paymentUsage.activeProjects number

active projects within payment usage.

Example100
data.paymentUsage.monthStartedAt string

ISO 8601 timestamp for month started.

Example2026-01-15T12:00:00.000Z
data.paymentUsage.monthEndsAt string

ISO 8601 timestamp for month ends.

Example2026-01-15T12:00:00.000Z

Possible errors

400 Invalid request

Response headers

x-request-id string

Correlation identifier returned with every response for support and request tracing.

Example550e8400-e29b-41d4-a716-446655440000
error object

Error details returned for a failed request.

ShowHide 4 properties
error.code string

Stable machine-readable error or resource code.

Exampleinvalid_input
error.message string

Human-readable explanation of the result or error.

ExampleThe request could not be validated.
error.requestId string

Correlation identifier for support and request tracing.

Example550e8400-e29b-41d4-a716-446655440000
error.details object nullable

Additional structured details about the result or error.

ShowHide 1 property
error.details.issues object[]

Structured field issues returned when request validation fails.

ShowHide 3 properties
error.details.issues[].path string | number[]

Field path where the validation issue occurred.

One of: string alternative 1, number alternative 2

Example0 items
error.details.issues[].reason string

Machine-readable reason for the validation issue.

Allowed values: "expected_type", "required", "unexpected_property", "invalid_value", "invalid_json", "invalid_query", "unsupported_media_type", "body_too_large", "body_timeout", "conflicting_scope", "missing_header", "concurrency_required", "invalid_resource_id", "invalid_request"

Exampleinvalid_request
error.details.issues[].code string nullable

Stable machine-readable error or resource code.

Exampleinvalid_input
Example 400 response
{
  "error": {
    "code": "invalid_input",
    "message": "The request could not be validated.",
    "requestId": "550e8400-e29b-41d4-a716-446655440000",
    "details": {
      "issues": [
        {
          "path": [],
          "reason": "invalid_request"
        }
      ]
    }
  }
}
View raw OpenAPI operation

Use the machine-readable contract for client generation and payload validation.

Open OpenAPI contract ↗