List promotional credit customers

cURL

curl -X GET "https://api.metrifox.com/api/v1/credit_systems/promotional-credits/625f5cee-259b-4994-b7eb-416b9e551f2c/customers?status=granted" \
  -H "x-api-key: your_api_key"

{
  "statusCode": 200,
  "message": "Promotional credit customers fetched",
  "meta": {
    "total_count": 1,
    "total_pages": 1
  },
  "data": [
    {
      "id": "a1b2c3d4-0000-0000-0000-000000000001",
      "customer_id": "f4a2f74c-661b-428c-87f8-75cc1aa19c4c",
      "customer_key": "cust_001",
      "customer_name": "Acme Inc",
      "customer_email": "billing@acme.test",
      "active": true,
      "applied_at": "2026-06-01T10:00:00Z",
      "revoked_at": null,
      "created_at": "2026-06-01T10:00:00Z"
    }
  ],
  "errors": {}
}

GET

api

credit_systems

promotional-credits

{id}

customers

cURL

curl -X GET "https://api.metrifox.com/api/v1/credit_systems/promotional-credits/625f5cee-259b-4994-b7eb-416b9e551f2c/customers?status=granted" \
  -H "x-api-key: your_api_key"

{
  "statusCode": 200,
  "message": "Promotional credit customers fetched",
  "meta": {
    "total_count": 1,
    "total_pages": 1
  },
  "data": [
    {
      "id": "a1b2c3d4-0000-0000-0000-000000000001",
      "customer_id": "f4a2f74c-661b-428c-87f8-75cc1aa19c4c",
      "customer_key": "cust_001",
      "customer_name": "Acme Inc",
      "customer_email": "billing@acme.test",
      "active": true,
      "applied_at": "2026-06-01T10:00:00Z",
      "revoked_at": null,
      "created_at": "2026-06-01T10:00:00Z"
    }
  ],
  "errors": {}
}

Filter by status=granted or status=revoked to narrow results, and use search to match on customer name or customer key. Results are paginated — check the meta object for total_count and total_pages.

Authorizations

x-api-key

string

header

required

Path Parameters

string<uuid>

required

The unique identifier of the promotional credit

Query Parameters

status

enum<string>

Filter grants by status. Omit to return both granted and revoked grants.

Available options:

granted,

revoked

string

Filter by customer name or customer key

Response

Customers for the promotional credit

statusCode

integer

Example:

200

message

string

Example:

"Promotional credit customers fetched"