Revoke promotional credit

POST

api

credit_systems

promotional-credits

{id}

revoke

cURL

curl -X POST https://api.metrifox.com/api/v1/credit_systems/promotional-credits/625f5cee-259b-4994-b7eb-416b9e551f2c/revoke \
  -H "x-api-key: your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "revoke_from": "specific",
    "customer_keys": ["cust_001"]
  }'

{
  "statusCode": 200,
  "message": "Promotional credit revoked",
  "meta": {},
  "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": false,
      "applied_at": "2026-06-01T10:00:00Z",
      "revoked_at": "2026-06-05T12:00:00Z",
      "created_at": "2026-06-01T10:00:00Z"
    }
  ],
  "errors": {}
}

Customers are identified by their customer_key. Use revoke_from: "specific" with a customer_keys array to revoke from a chosen set of customers, or revoke_from: "all" to revoke from every customer that currently holds this promotional credit.

Only customers with an active grant for this promotional credit are affected. Revoking takes effect immediately.

Authorizations

x-api-key

string

header

required

Path Parameters

string<uuid>

required

The unique identifier of the promotional credit to revoke

Body

application/json

revoke_from

enum<string>

default:specific

specific revokes only from the customers listed in customer_keys. all revokes from every customer that currently holds this promotional credit.

Available options:

specific,

all

Example:

"specific"

customer_keys

string[]

The customer keys to revoke the promotional credit from. Required when revoke_from is specific.

Example:

["cust_001"]

Response

Promotional credit revoked

statusCode

integer

Example:

200

message

string

Example:

"Promotional credit revoked"