Skip to main content
GET
/
api
/
v1
/
credit_systems
/
v2
/
wallets
/
{id}
/
credit-allocations
Python SDK
from metrifox_sdk import MetrifoxClient

client = MetrifoxClient(api_key="your_api_key")

# List credit allocations for a wallet
allocations = client.wallets.list_credit_allocations("b7bf0d46-9f7d-4d58-9bb4-6bfb2d3e6a5c")
for alloc in allocations['data']:
    available = alloc['amount'] - alloc['consumed']
    print(f"{alloc['allocation_type']}: {available} available / {alloc['amount']} granted")

# Filter by status
active = client.wallets.list_credit_allocations(
    "b7bf0d46-9f7d-4d58-9bb4-6bfb2d3e6a5c",
    status="active",
)
{
  "statusCode": 200,
  "message": "Credit allocations fetched successfully",
  "meta": {},
  "data": [
    {
      "id": "a3f2b8e0-4d11-4f9a-8c2d-7e1b3a9f0c12",
      "amount": 100,
      "consumed": 35,
      "allocation_type": "subscription",
      "invoice_id": "0d9e5a0e-7de4-48c6-b01a-b1759394578b",
      "order_id": null,
      "order_number": null,
      "valid_until": "2026-04-12T16:55:21.847Z",
      "created_at": "2026-03-12T16:55:22.014Z",
      "transactions": [
        {
          "id": "2e8c1a4f-9b73-4f1a-bd64-58a9d7c83ef0",
          "amount": 10,
          "quantity": 2,
          "event_name": "image_generated",
          "usage_event_id": "ue_01HXYZ123ABC",
          "created_at": "2026-03-15T09:22:03.114Z"
        },
        {
          "id": "9af2e7b1-8c3d-4d52-9b1a-23c7e4f60d21",
          "amount": 25,
          "quantity": 5,
          "event_name": "image_generated",
          "usage_event_id": "ue_01HXYZ456DEF",
          "created_at": "2026-03-18T14:08:47.802Z"
        }
      ]
    },
    {
      "id": "f51c9d3a-2b48-4e10-9c61-71d8b4e2a503",
      "amount": 50,
      "consumed": 0,
      "allocation_type": "topup",
      "invoice_id": "762d8b5f-e416-4d88-8461-2a357b91ff25",
      "order_id": "ord_01HABCDEFGHIJK",
      "order_number": "ORD012",
      "valid_until": null,
      "created_at": "2026-03-20T11:04:18.221Z",
      "transactions": []
    }
  ],
  "errors": {}
}

Documentation Index

Fetch the complete documentation index at: https://docs.metrifox.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
id
string<uuid>
required

The unique wallet identifier

Query Parameters

​
status
string

Optional allocation status filter (e.g. active, expired)

Response

Credit allocations fetched successfully

​
statusCode
integer
Example:

200

​
message
string
Example:

"Credit allocations fetched successfully"

​
meta
object
​
data
object[]
​
errors
object