List promotional credits

cURL

curl -X GET "https://api.metrifox.com/api/v1/credit_systems/promotional-credits?status=active" \
  -H "x-api-key: your_api_key"

{
  "statusCode": 200,
  "message": "Promotional credits fetched",
  "meta": {
    "current_page": 1,
    "total_pages": 1,
    "total_count": 1,
    "next_page": null,
    "prev_page": null
  },
  "data": [
    {
      "id": "625f5cee-259b-4994-b7eb-416b9e551f2c",
      "name": "December Campaign Credit",
      "description": "Bonus credits for the december promotion",
      "credit_system_id": "9c1f1d2e-0000-0000-0000-000000000010",
      "credit_system_name": "Token Credits",
      "quantity": 500,
      "reset_interval": "monthly",
      "reset_anchor": null,
      "starts_at": "2026-06-01T00:00:00Z",
      "expires_at": "2026-09-01T00:00:00Z",
      "duration_value": 3,
      "duration_unit": "month",
      "allow_multiple_grants": false,
      "status": "active",
      "is_applied": true,
      "created_at": "2026-05-20T10:00:00Z",
      "updated_at": "2026-05-20T10:00:00Z"
    }
  ],
  "errors": {}
}

GET

api

credit_systems

promotional-credits

cURL

curl -X GET "https://api.metrifox.com/api/v1/credit_systems/promotional-credits?status=active" \
  -H "x-api-key: your_api_key"

{
  "statusCode": 200,
  "message": "Promotional credits fetched",
  "meta": {
    "current_page": 1,
    "total_pages": 1,
    "total_count": 1,
    "next_page": null,
    "prev_page": null
  },
  "data": [
    {
      "id": "625f5cee-259b-4994-b7eb-416b9e551f2c",
      "name": "December Campaign Credit",
      "description": "Bonus credits for the december promotion",
      "credit_system_id": "9c1f1d2e-0000-0000-0000-000000000010",
      "credit_system_name": "Token Credits",
      "quantity": 500,
      "reset_interval": "monthly",
      "reset_anchor": null,
      "starts_at": "2026-06-01T00:00:00Z",
      "expires_at": "2026-09-01T00:00:00Z",
      "duration_value": 3,
      "duration_unit": "month",
      "allow_multiple_grants": false,
      "status": "active",
      "is_applied": true,
      "created_at": "2026-05-20T10:00:00Z",
      "updated_at": "2026-05-20T10:00:00Z"
    }
  ],
  "errors": {}
}

Use this to find the id of the promotional credit you want to grant. Pass that id to the Grant promotional credit endpoint.

Filter by status (scheduled, active, expired, deactivated), by credit_system_id, or by search (matches the name). Results are paginated — see the meta object.

Authorizations

x-api-key

string

header

required

Query Parameters

credit_system_id

string<uuid>

Filter by the credit system the promotional credit funds

status

enum<string>

Filter by lifecycle status

Available options:

scheduled,

active,

expired,

deactivated

string

Filter by promotional credit name

page

integer

default:1

The page of results to return

per_page

integer

default:25

Number of records per page

Response

Promotional credits

statusCode

integer

Example:

200

message

string

Example:

"Promotional credits fetched"