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"import requests
url = "https://{defaultHost}/api/v1/credit_systems/promotional-credits/{id}/customers"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://{defaultHost}/api/v1/credit_systems/promotional-credits/{id}/customers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{defaultHost}/api/v1/credit_systems/promotional-credits/{id}/customers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://{defaultHost}/api/v1/credit_systems/promotional-credits/{id}/customers"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{defaultHost}/api/v1/credit_systems/promotional-credits/{id}/customers")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{defaultHost}/api/v1/credit_systems/promotional-credits/{id}/customers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"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": {}
}{
"message": "<string>",
"errors": {}
}{
"message": "<string>",
"errors": {}
}Promotional Credits
List promotional credit customers
List the customers a promotional credit has been granted to, including revoked grants
GET
/
api
/
v1
/
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"import requests
url = "https://{defaultHost}/api/v1/credit_systems/promotional-credits/{id}/customers"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://{defaultHost}/api/v1/credit_systems/promotional-credits/{id}/customers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{defaultHost}/api/v1/credit_systems/promotional-credits/{id}/customers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://{defaultHost}/api/v1/credit_systems/promotional-credits/{id}/customers"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{defaultHost}/api/v1/credit_systems/promotional-credits/{id}/customers")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{defaultHost}/api/v1/credit_systems/promotional-credits/{id}/customers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"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": {}
}{
"message": "<string>",
"errors": {}
}{
"message": "<string>",
"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
Path Parameters
The unique identifier of the promotional credit
Query Parameters
Filter grants by status. Omit to return both granted and revoked grants.
Available options:
granted, revoked Filter by customer name or customer key
⌘I

