Grants

List grants.

get/v2/grants

Query parameters

limitinteger

Maximum number of records to return. Defaults to 100.

starting_afterstring

Return records created after this resource id, ordered by created_at then id.

Cursor resource id from the previous page.

currencystring
Example:usd

Return only grants for this currency. Normalized to lowercase.

Response

Page of resources.

has_moreboolean required

True when additional records are available after the returned page.

Example response

{
  "data": [
    {
      "id": "grant_0194f4e3a2b77c6aa91c4f6b4db2a980",
      "description": "Usage tracked for Acme.",
      "account_id": "account_0194f4e3a2b77c6aa91c4f6b4db2a980",
      "metric_id": "metric_0194f4e3a2b77c6aa91c4f6b4db2a980",
      "currency": "usd",
      "amount": "100.0",
      "expires_at": 1767225600,
      "accepted_at": 1767225600,
      "created_at": 1767225600,
      "updated_at": 1767225600,
      "status": "active",
      "archived_at": 1767225600,
      "effective_at": 1767225600
    }
  ]
}

Changes

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