Skip to content
Sections

API reference

Usage

The account’s own usage against its plan.

The account's usage this period

get/v1/usage

Daily API requests and linked-variant peaks, with the allowances. Works while the account is suspended.

Called by
Account client
Scope
usage:read

Responses

200Usage this period.Show
  • allowancesobjectrequired

    Null: unlimited.

    Child attributes
    • api_requests_per_monthinteger | nullrequired
    • linked_variantsinteger | nullrequired
    • sync_interval_minutesintegerrequired
  • dailyarray of objectrequired
    Child attributes
    • api_requestsintegerrequired
    • datestring (date)required

      e.g. 2026-11-21

    • linked_variants_peakintegerrequired
  • periodobjectrequired
    Child attributes
    • endstring (date)required

      e.g. 2026-11-21

    • startstring (date)required

      e.g. 2026-11-21

  • totalsobjectrequired
    Child attributes
    • api_requestsintegerrequired
    • linked_variantsintegerrequired
    • linked_variants_peakintegerrequired
  • 401Missing, expired or revoked token (invalid_token).
  • 403The token lacks a scope (insufficient_scope), the account is suspended (account_suspended), or the client kind cannot call this.
  • 429Too many requests (rate_limited); see Retry-After.
Request
curl -sS -X GET 'https://suppliers.presslane.ai/v1/usage' \
  -H "Authorization: Bearer $TOKEN"
Response · 200
{
  "allowances": {
    "api_requests_per_month": 1,
    "linked_variants": 1,
    "sync_interval_minutes": 1
  },
  "daily": [
    {
      "api_requests": 1,
      "date": "2026-11-21",
      "linked_variants_peak": 1
    }
  ],
  "period": {
    "end": "2026-11-21",
    "start": "2026-11-21"
  },
  "totals": {
    "api_requests": 1,
    "linked_variants": 1,
    "linked_variants_peak": 1
  }
}
Try it in the sandbox