List Credit Grants

GET /credit-grants

cURL

curl "https://api.alguna.io/credit-grants?wallet_id=wal_def456" \
  -H "Authorization: Bearer YOUR_API_KEY"

const grants = await alguna.creditGrants.list({
  wallet_id: 'wal_def456'
});

{
  "items": [
    {
      "id": "grant_abc123",
      "wallet_id": "wal_def456",
      "amount": "500.00",
      "description": "Annual credit allocation",
      "expires_at": "2024-12-31T23:59:59Z",
      "payment_id": null,
      "status": "active",
      "created_at": "2024-01-20T10:00:00Z",
      "updated_at": "2024-01-20T10:00:00Z"
    },
    {
      "id": "grant_def456",
      "wallet_id": "wal_def456",
      "amount": "100.00",
      "description": "Promotional credits",
      "expires_at": "2024-03-31T23:59:59Z",
      "payment_id": null,
      "status": "exhausted",
      "created_at": "2024-01-15T08:00:00Z",
      "updated_at": "2024-01-18T14:00:00Z"
    }
  ]
}

List all credit grants, optionally filtered by wallet or expiration.

wallet_id · string

Filter grants by wallet ID.

expires_at · string

Filter grants expiring before this ISO 8601 date.

cURL

curl "https://api.alguna.io/credit-grants?wallet_id=wal_def456" \
  -H "Authorization: Bearer YOUR_API_KEY"

const grants = await alguna.creditGrants.list({
  wallet_id: 'wal_def456'
});

{
  "items": [
    {
      "id": "grant_abc123",
      "wallet_id": "wal_def456",
      "amount": "500.00",
      "description": "Annual credit allocation",
      "expires_at": "2024-12-31T23:59:59Z",
      "payment_id": null,
      "status": "active",
      "created_at": "2024-01-20T10:00:00Z",
      "updated_at": "2024-01-20T10:00:00Z"
    },
    {
      "id": "grant_def456",
      "wallet_id": "wal_def456",
      "amount": "100.00",
      "description": "Promotional credits",
      "expires_at": "2024-03-31T23:59:59Z",
      "payment_id": null,
      "status": "exhausted",
      "created_at": "2024-01-15T08:00:00Z",
      "updated_at": "2024-01-18T14:00:00Z"
    }
  ]
}

items · array

Array of credit grant objects.