Skip to main content
GET
/
api
/
v1
/
credit_systems
/
promotional-credits
/
{id}
cURL
curl -X GET https://api.metrifox.com/api/v1/credit_systems/promotional-credits/625f5cee-259b-4994-b7eb-416b9e551f2c \
  -H "x-api-key: your_api_key"
{
  "statusCode": 200,
  "message": "Promotional credit fetched",
  "meta": {},
  "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": {}
}

Authorizations

x-api-key
string
header
required

Path Parameters

id
string<uuid>
required

The unique identifier of the promotional credit

Response

Promotional credit

statusCode
integer
Example:

200

message
string
Example:

"Promotional credit fetched"

meta
object
data
object

A promotional credit — a time-bound credit allocation campaign tied to a credit system that can be granted to customers as a consumable balance.

errors
object