Skip to main content
GET
/
earnings
List earnings
curl --request GET \
  --url https://api.openquota.ai/v1/earnings \
  --header 'Authorization: Bearer <token>'
{
  "earnings": [
    {
      "id": "<string>",
      "user_id": "<string>",
      "period_id": "<string>",
      "deal_id": "<string>",
      "plan_version_id": "<string>",
      "rule_chip_id": "<string>",
      "rule_version": "<string>",
      "amount_cents": 123,
      "status": "open",
      "created_at": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "limit": 1,
    "offset": 1,
    "next_offset": 1
  }
}

Authorizations

​
Authorization
string
header
required

Provide your API key as Authorization: Bearer <key>. Generate keys in the OpenQuota admin under Settings → API Keys.

Query Parameters

​
limit
integer
default:50
Required range: 1 <= x <= 500
​
offset
integer | null
default:0
Required range: x >= 0
​
user_id
string

Filter to earnings attributed to a single user ID.

Response

A page of earnings.

​
earnings
object[]
required
​
pagination
object
required