Skip to main content
Monitor your API usage by billing period. Usage records track every billable operation and are summarized monthly.

​
Billing periods

Billing periods use the YYYY-MM format (e.g., 2026-03). If no period is specified, the current month is used.

​
Usage summary

Get an aggregated summary of usage for a billing period: 
curl "https://api.contro.me/v1/partner/usage/summary?period=2026-03" \
  -H "x-contro-api-key: $CONTRO_API_KEY"

​
Response

{
  "period": "2026-03",
  "items": [
    { "type": "card_issuance", "total": 150.00, "count": 30 },
    { "type": "transaction", "total": 45.50, "count": 910 },
    { "type": "kyc", "total": 75.00, "count": 25 },
    { "type": "monthly_fee", "total": 50.00, "count": 1 }
  ]
}

​
Summary item fields

FieldTypeDescription
typestringUsage type. One of card_issuance, transaction, monthly_fee, api_call, kyc
totalnumberTotal cost for this type in USD. Example: 150.00
countnumberNumber of operations in this period. Example: 30

​
Detailed usage records

List individual usage records with optional filtering: 
curl "https://api.contro.me/v1/partner/usage/records?period=2026-03&type=card_issuance&limit=50" \
  -H "x-contro-api-key: $CONTRO_API_KEY"

​
Query parameters

ParameterTypeDescription
cursorstringPagination cursor from the previous response’s nextCursor
limitintegerItems per page (1–100, default 20). Example: 50
periodstringBilling period in YYYY-MM format. Example: "2026-03"
typestringFilter by usage type. One of card_issuance, transaction, monthly_fee, api_call, kyc

​
Response

{
  "data": [
    {
      "id": "usage_abc123",
      "type": "card_issuance",
      "amount": 5.00,
      "referenceId": "card_def456",
      "billingPeriod": "2026-03",
      "createdAt": "2026-03-15T10:30:00Z"
    }
  ],
  "hasMore": true,
  "nextCursor": "cursor_xyz"
}

​
Record fields

FieldTypeDescription
idstringUsage record ID. Example: "usage_abc123"
typestringUsage type. One of card_issuance, transaction, monthly_fee, api_call, kyc
amountnumberCost for this operation in USD. Example: 5.00
referenceIdstringID of the related resource (card, transaction, or cardholder). Example: "card_def456"
billingPeriodstringBilling period in YYYY-MM format. Example: "2026-03"
createdAtstringISO 8601 creation timestamp. Example: "2026-03-15T10:30:00Z"