Credits

An organization billed in credits pays for its runs in credits: each audience build, each scheduled refresh cycle, and each lookalike. The price of a run is known before it starts, and the run is charged when it is accepted. A run that fails, is cancelled, or completes with no results gets its credits back. Activations, cohorts, and size estimates carry no credits.

Credits answer only for an organization billed in credits. For any other organization every endpoint on this page, and the two quotes on Audiences, returns 403 with the message Credits are not enabled for your organization. (see Errors), and credits_charged on an audience is null. Ask your Account Manager about credits for your organization.

What reads credits:

• Get Credits returns the balance of the current period.
• Get Credits Statement lists what added credits and what used them in that period.
• Quote Audience and Quote Lookalike return the price of a run before you create it. Each takes the same body as its create. It creates nothing and is free.
• Every audience carries credits_charged, the credits its run was charged after any refund, on Get Audience, List Audiences, the create responses, and the audience.* webhooks.
• Get Usage carries the same balance in its credits block.

The balance and the statement require additional permissions which need to be approved by your Account Manager, the same as Usage. A quote needs only what its create needs.

The endpoints are authenticated and JSON-only. Send Authorization: Bearer <token> and Accept: application/json on every call. They use the read rate bucket (120 requests/min per caller).

The period

Credits are counted over a period: your contract term while today falls in it, otherwise the calendar month. used is what the period’s runs were charged, net of refunds, and available is what you can still spend now, including credits carried in from before the period (a pilot, for example). The share used is used / (used + available), rounded down to one decimal, so it reads 100 only when nothing is left.

state follows the share used:

Get Credits

GET /api/v2/credits

Returns your organization’s credits for the current period: the balance, the share used, the pace and the day the balance runs out at that pace, what expires next, and the credits used per run type and per user.

Auth: bearer token + Accept: application/json. Rate limit: read bucket (120 requests/min).

curl "https://console.intuizi.com/api/v2/credits" \
  -H "Authorization: Bearer <YOUR_TOKEN>" \
  -H "Accept: application/json"

import requests

res = requests.get(
    "https://console.intuizi.com/api/v2/credits",
    headers={
        "Authorization": "Bearer <YOUR_TOKEN>",
        "Accept": "application/json",
    },
)
credits = res.json()["data"]

const res = await fetch("https://console.intuizi.com/api/v2/credits", {
  headers: {
    Authorization: "Bearer <YOUR_TOKEN>",
    Accept: "application/json",
  },
});
const credits = (await res.json()).data;

$res = Http::withToken('<YOUR_TOKEN>')->acceptJson()
    ->get('https://console.intuizi.com/api/v2/credits');
$credits = $res->json('data');

Response

{
  "status": "success",
  "code": 200,
  "message": "Resource fetched successfully.",
  "data": {
    "plan": "access",
    "period": {
      "type": "term",
      "from": "2026-10-01",
      "to": "2027-09-30",
      "days": 365,
      "days_elapsed": 33,
      "percent_elapsed": 9
    },
    "available": 876,
    "used": 124,
    "percent_used": 12.4,
    "state": "ok",
    "threshold": null,
    "expiring_next": null,
    "expired": 0,
    "pace": {
      "credits_per_day": 3.8,
      "runs_out_on": "2027-06-23",
      "lasts_the_period": false
    },
    "by_operation": [
      { "operation_type": "lookalike", "label": "Lookalike", "credits": 120 },
      { "operation_type": "audience_build", "label": "Audience Build", "credits": 4 }
    ],
    "by_user": [
      { "name": "Jane Doe", "credits": 124 }
    ]
  }
}

Response fields

Get Credits Statement

GET /api/v2/credits/statement

Lists the current period’s entries, newest first: credits added (your plan, a top-up, credits from Intuizi), runs charged, refunds, and credits that expired. A run paid from two blocks of credits is one entry.

Auth: bearer token + Accept: application/json. Rate limit: read bucket (120 requests/min).

Query parameters

curl "https://console.intuizi.com/api/v2/credits/statement?search=refund" \
  -H "Authorization: Bearer <YOUR_TOKEN>" \
  -H "Accept: application/json"

import requests

res = requests.get(
    "https://console.intuizi.com/api/v2/credits/statement",
    params={"search": "refund"},
    headers={
        "Authorization": "Bearer <YOUR_TOKEN>",
        "Accept": "application/json",
    },
)
entries = res.json()["data"]["items"]

const res = await fetch("https://console.intuizi.com/api/v2/credits/statement?search=refund", {
  headers: {
    Authorization: "Bearer <YOUR_TOKEN>",
    Accept: "application/json",
  },
});
const entries = (await res.json()).data.items;

$res = Http::withToken('<YOUR_TOKEN>')->acceptJson()
    ->get('https://console.intuizi.com/api/v2/credits/statement', ['search' => 'refund']);
$entries = $res->json('data.items');

Response

{
  "status": "success",
  "code": 200,
  "message": "Resources fetched successfully.",
  "data": {
    "period": { "from": "2026-10-01", "to": "2027-09-30" },
    "items": [
      {
        "id": 4,
        "occurred_at": "2026-11-02T12:00:00+00:00",
        "entry_type": "refund",
        "entry": "Refund",
        "audience": { "id": 90, "name": "Tea Drinkers" },
        "user": "Jane Doe",
        "credits": 4,
        "note": "Run failed (status 403)"
      },
      {
        "id": 3,
        "occurred_at": "2026-11-02T11:00:00+00:00",
        "entry_type": "debit",
        "entry": "Audience Build",
        "audience": { "id": 90, "name": "Tea Drinkers" },
        "user": "Jane Doe",
        "credits": -4,
        "note": null
      },
      {
        "id": 1,
        "occurred_at": "2026-10-01T00:00:00+00:00",
        "entry_type": "grant",
        "entry": "Plan credits",
        "audience": null,
        "user": null,
        "credits": 1000,
        "note": null
      }
    ],
    "pagination": {
      "current_page": 1,
      "per_page": 25,
      "total": 3,
      "last_page": 1
    }
  }
}

Response fields