Usage

Returns your partner account's real-time credit usage, broken down per workspace and per product. Use this to track consumption without waiting for an invoice.

GET/api/v2/partner/usage

Authentication

Authorization: Bearer $SILLAGE_API_KEY

Query parameters

All fields are optional. With no filters, the window defaults to the start of the current calendar month (UTC) through now.

Parameter	Type	Description
date_from	string (date-time)	Start of the usage window (ISO 8601). If `date_to` is omitted, the window runs 3 months forward from this date.
date_to	string (date-time)	End of the usage window (ISO 8601). If `date_from` is omitted, the window runs 3 months back from this date. The window can never exceed 3 months.

Example request

curl "https://api.getsillage.com/api/v2/partner/usage" \
  -H "Authorization: Bearer $SILLAGE_API_KEY"

Example response

{
  "credits_by_status": {
    "held": 12.5,
    "invoiceable": 340.0
  },
  "workspaces": [
    {
      "id": 101,
      "credits_by_status": {
        "held": 12.5,
        "invoiceable": 340.0
      },
      "by_product": [
        {
          "product": "account_mapping_launch",
          "credits_by_status": { "invoiceable": 200.0 }
        },
        {
          "product": "keyword_signal",
          "credits_by_status": { "held": 12.5, "invoiceable": 140.0 }
        }
      ]
    }
  ]
}

Response fields

Field	Type	Description
credits_by_status	object	Total credits consumed across all your workspaces in the window, keyed by lifecycle status (e.g. `held`, `invoiceable`, `invoice_edited`, `invoice_paid`, `released`).
workspaces	array	One entry per workspace with usage in the window.
workspaces[].id	integer	Identifier for the workspace.
workspaces[].credits_by_status	object	Credits consumed by this workspace, keyed by lifecycle status.
workspaces[].by_product	array	Per-product breakdown for this workspace.
by_product[].product	string	Billable product: `account_mapping_launch`, `content_profile`, `champion_enrichment`, `keyword_signal`, `competitor_signal`, `account_monitoring`, `discovery_essential`, `discovery_standard`, or `discovery_advanced`. `champion_enrichment` is a legacy product that is no longer charged; it only appears on usage recorded before it was removed.
by_product[].credits_by_status	object	Credits consumed by this product, keyed by lifecycle status.

Credit amounts are decimal numbers, not cents. A workspace or product with no activity in the window is omitted rather than listed with zero values.

Discovery is charged per signal found, at the price of its signal type: discovery_essential (10 credits), discovery_standard (20 credits) or discovery_advanced (40 credits).

Errors

Status	Meaning
400	Invalid query parameters.
401	The master key is missing or invalid.
422	The requested window exceeds 3 months (`date_to` too far after `date_from`).
429	Too many requests.
500	An unexpected server error occurred.

Error responses use RFC 9457 problem documents with Content-Type: application/problem+json.