Subscription & Entitlements

Subscription (license) information and entitlement usage for the current account, including plan details, feature limits, and consumption metrics.

License schema

Get licenses (subscription)

get

/v1/licenses

Returns one account-level license (type is platform, integrator, or endpoint) plus zero or more connector, integrationApp, or integrationAppChild licenses, oldest first.

Pass type=io to receive only the account-level license as a single object (not an array) with _userId added — use this when you need the subscription plan without filtering the list yourself.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

typestring · enumOptional

Set to io to return only the account-level license as a single object. Any other value is ignored and the full array is returned.

Example: ioPossible values:

Responses

200

List of licenses. With type=io, a single License object instead of an array.

application/json

Subscription plan or connector/Integration App license. Fields describe what the plan entitles, not what is configured on the account.

_idstring · objectIdRead-onlyRequired

License identifier.

Example: 624cb0356309dc3a543733a4

_userIdstring · objectIdRead-onlyOptional

Account owner the license belongs to. Present only on the single-object response of GET /v1/licenses?type=io; absent from the array response.

Example: 624cb0346309dc3a543733a2

createdstring · date-timeRead-onlyRequired

License creation timestamp.

Example: 2022-04-05T21:10:13.226Z

lastModifiedstring · date-timeRead-onlyRequired

Last modification timestamp.

Example: 2026-05-18T06:14:25.052Z

expiresstring · date-timeOptional

License expiration timestamp.

Example: 2099-12-31T00:00:00.000Z

typestring · enumRequired

License type (subscription category). Only the account-level license describes the full subscription plan.

Example: platformPossible values:

cdcbooleanOptional

When true, the account is licensed for CDC (change data capture) features.

tierstringOptional

Subscription tier name — the plan level the account is on. On platform licenses a year marker in the name identifies the plan generation; the rest of the name is free-form (packages, custom names).

Example: enterprise (2024)

supportTierstring · enumOptional

Support plan level.

Example: premierPossible values:

trialEndDatestring · date-timeOptional

Trial end timestamp. Remains populated after the trial ends with the original expiration date.

Example: 2024-05-06T00:00:00.000Z

_connectorIdstring · objectIdOptional

Connector id. Present on connector, integrationApp, and integrationAppChild licenses.

Example: 5f8489ca15e4c824e38a769f

_integrationIdstring · objectIdOptional

Integration id. Present on connector, integrationApp, and integrationAppChild licenses.

Example: 5f7e39a76bb8d813180a9549

_editionIdstring · objectIdOptional

Edition id — present on integrationApp and integrationAppChild licenses.

Example: 60a2c4e6f321d800129a1a3c

_parentIdstring · objectIdOptional

Parent license id — present only on integrationAppChild licenses. References the parent integrationApp license.

Example: 61b3d5f7e432e900130b2b4d

optsobjectOptional

Connector/license options (connector edition, add-on licenses, etc.). Present only on connector-specific licenses.

Example: {"connectorEdition":"premium","addonLicenses":[{"type":"store","licenses":[{"addOnEdition":"premium"}]}]}

resumablebooleanRead-onlyOptional

When true, the license/account is eligible for self-service resume after suspension.

Example: false

disableOveragebooleanOptional

When true, overage charges are disabled for this account.

Example: false

requestUserToMigrateSandboxbooleanOptional

When true, the user should be prompted to migrate legacy sandbox data to environments.

Example: false

ssobooleanOptional

When true, the plan entitles the account to use SSO (Single Sign-On).

Example: true

scimbooleanOptional

When true, the plan entitles the account to provision users through SCIM. Derived from the SCIM add-on together with sso — reads false whenever the plan does not also entitle SSO. Present on account-level licenses.

vanbooleanOptional

When true, the plan entitles the account to use VAN (Value Added Network) for EDI.

Example: true

lookupCachebooleanOptional

When true, the plan entitles the account to use Lookup Caches (in-memory lookups).

Example: true

abstractFlowsbooleanOptional

When true, the plan entitles the account to use Abstract Flows (multi-instance templates).

Example: true

apiManagementbooleanOptional

When true, the plan entitles the account to use API Management (APIM).

Example: true

concurrencyintegerOptional

Maximum number of concurrent flow executions the plan allows.

Example: 25

maxAllowedDataRetentionintegerOptional

Maximum data retention period (in days) the plan allows.

Example: 180

auditLogRetentionYearsintegerOptional

Maximum audit log retention (in years) the plan allows.

Example: 3

aiConversationsPrepaidBalancenumberOptional

Remaining prepaid credit balance for Ora (Celigo's AI assistant). Customers purchase credits up front and usage costs are deducted as they interact with Ora.

Example: 47.96

aiAgentsPrepaidBalancenumberOptional

Remaining prepaid credit balance for AI Agents — LLM/AI capabilities used within flows, APIs, and automations (e.g., AI-powered transforms, hooks). Customers purchase credits up front and usage costs are deducted as AI agents run. This balance is separate from Ora credits.

Example: 19.62

204

The account has no licenses, or type=io was requested and the account has no account-level license.

401

Unauthorized. The request lacks a valid bearer token, or the provided token failed to authenticate.

Note: the 401 response is produced by the auth middleware before the request reaches the endpoint handler, so it does not follow the standard {errors: [...]} envelope. Instead the body is a bare {message: string} object with no code, no errors array. Callers handling 401s should key off the HTTP status and the message string, not try to destructure an errors[].

application/json

get/v1/licenses

GET /v1/licenses HTTP/1.1
Host: api.integrator.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "_id": "624cb0356309dc3a543733a4",
    "created": "2024-04-05T21:10:13.226Z",
    "lastModified": "2025-08-10T14:22:33.000Z",
    "expires": "2099-12-31T00:00:00.000Z",
    "type": "platform",
    "tier": "enterprise (2024)",
    "supportTier": "premier",
    "resumable": false,
    "disableOverage": false,
    "requestUserToMigrateSandbox": false,
    "sso": true,
    "scim": false,
    "van": true,
    "cdc": true,
    "lookupCache": true,
    "abstractFlows": true,
    "apiManagement": true,
    "concurrency": 25,
    "maxAllowedDataRetention": 180,
    "auditLogRetentionYears": 3,
    "aiConversationsPrepaidBalance": 47.96,
    "aiAgentsPrepaidBalance": 19.62,
    "platform": {
      "production": {
        "numEndpoints": 600,
        "numAddOnEndpoints": 0,
        "numFlows": 80,
        "numAddOnFlows": 5000,
        "numAgents": 0,
        "numAddOnAgents": 100
      },
      "apiManagement": true,
      "numEnvironments": 5
    },
    "edi": {
      "enabled": true,
      "onboarded": true,
      "disableOverage": false,
      "tier": "basic",
      "numTradingPartners": 3,
      "numAddOnTradingPartners": 0,
      "numDocumentTypes": 5,
      "numAddOnDocumentTypes": 0,
      "labelPrinting": {
        "enabled": true,
        "onboarded": true,
        "numLabels": 10000,
        "numAddOnLabels": 0
      }
    },
    "api": {
      "builder": true,
      "enablePricing": false,
      "disableOverages": false,
      "numInvocations": 0,
      "apimNumInvocations": 0,
      "numAddOnInvocations": 0
    },
    "topics": {
      "enabled": true,
      "topicsAllowed": 20,
      "retentionCeilingDays": 90
    },
    "filesql": {
      "enabled": true
    },
    "lookupCacheUsage": {
      "numUnits": 100000000,
      "numAddOnUnits": 0
    },
    "di": {
      "enabled": false,
      "volume": 0,
      "volumeAddOn": 0,
      "disableOverage": false
    },
    "logging": {
      "enabled": true,
      "maxLogMode": "detailed",
      "maxDebugDuration": 4320,
      "maxRetentionPeriod": 180
    },
    "storage": {
      "maxAllowedUsage": 200,
      "disableOverage": false
    }
  }
]

Get license entitlement usage

get

/v1/licenseEntitlementUsage

Returns entitlement usage for the environment the request is made in -- how many resources it is consuming vs. what is entitled. Pair with GET /v1/licenses for the entitlement limits; the license's pricing model decides what the flow count means.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Entitlement usage

application/json

Entitlement usage information for the account/license, keyed by usage category.

aiAgentsActionsUsageintegerOptional

AI agent actions consumed in the current billing period, including billable MCP server invocations (tool calls and resource reads). Metered on production usage only.

Example: 87

401

Unauthorized. The request lacks a valid bearer token, or the provided token failed to authenticate.

Note: the 401 response is produced by the auth middleware before the request reaches the endpoint handler, so it does not follow the standard {errors: [...]} envelope. Instead the body is a bare {message: string} object with no code, no errors array. Callers handling 401s should key off the HTTP status and the message string, not try to destructure an errors[].

application/json

get/v1/licenseEntitlementUsage

GET /v1/licenseEntitlementUsage HTTP/1.1
Host: api.integrator.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "flowUsage": {
    "numEnabled": 12,
    "flows": [
      {
        "_id": "69d097584e0c505cda036df9",
        "name": "HubSpot Contacts → Snowflake (Nightly)",
        "integration": {
          "_id": "69d0973d4e0c505cda0368d1",
          "name": "POC – HubSpot → Snowflake"
        }
      }
    ]
  },
  "endpointUsage": {
    "numConsumed": 8,
    "endpoints": [
      {
        "type": "http",
        "assistant": "hubspot",
        "connections": [
          {
            "_id": "62ac9ab6cd606e428737008e",
            "name": "HubSpot (Production)"
          }
        ]
      },
      {
        "type": "rdbms",
        "connections": [
          {
            "_id": "69d096cd4e0c505cda036a3a",
            "name": "Snowflake DW"
          }
        ]
      }
    ]
  },
  "agentUsage": {
    "numActive": 0,
    "agents": []
  },
  "environmentUsage": {
    "numEnabled": 2,
    "environments": [
      {
        "_id": "60a2c4e6f321d800129a1a3c",
        "name": "Production",
        "enabled": true
      },
      {
        "_id": "61b3d5f7e432e900130b2b4d",
        "name": "Staging",
        "enabled": true
      }
    ]
  },
  "ediTradingPartnerUsage": {
    "numConsumed": 1,
    "tradingPartners": [
      {
        "tradingPartnerName": "Acme Corp",
        "ediProfiles": [
          {
            "id": "69014f1691348b59ebed05a9",
            "name": "Acme EDI Profile"
          }
        ]
      }
    ]
  },
  "ediDocumentTypeUsage": {
    "numConsumed": 1,
    "documents": [
      {
        "category": "Purchase Order",
        "fileDefinitions": [
          {
            "_id": "69014f1691348b59ebed059b",
            "name": "Generic EDI 850"
          }
        ]
      }
    ]
  },
  "ediLabelPrintingUsage": {
    "numConsumed": 1542,
    "flows": [
      {
        "_id": "6a25e22136b14ada888433f4",
        "name": "Bartender — UPS labels",
        "integration": {
          "_id": "69d0973d4e0c505cda0368d1",
          "name": "NetSuite — Acme"
        },
        "numConsumed": 812
      },
      {
        "_id": "6a25e22136b14ada888433f5",
        "name": "Bartender — FedEx labels",
        "integration": {
          "_id": "69d0973d4e0c505cda0368e2",
          "name": "NetSuite — Globex"
        },
        "numConsumed": 530
      }
    ]
  },
  "apiUsage": {
    "ioInvocationCount": 1250,
    "apimInvocationCount": 0
  },
  "syncUsage": {
    "entitlement": 0,
    "volume": 0
  },
  "lookupCacheUsage": {
    "numUnits": 4820
  },
  "aiAgentsActionsUsage": 87
}

Get historic label-printing usage

get

/v1/ediLabelPrinting/usage/summary

Returns account-wide EDI label-printing (BarTender) consumption bucketed into the trailing 12 ISO weeks (Monday–Sunday UTC), most-recent week first. Each week's total sums every flow and environment under the account. Pair with the ediLabelPrintingUsage block on GET /v1/licenseEntitlementUsage for the current week's per-flow breakdown.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Historic weekly label-printing usage

application/json

Historic weekly EDI label-printing (BarTender) consumption, account-wide across all flows and environments. Covers the trailing 12 ISO weeks (Monday–Sunday UTC).

401

Unauthorized. The request lacks a valid bearer token, or the provided token failed to authenticate.

Note: the 401 response is produced by the auth middleware before the request reaches the endpoint handler, so it does not follow the standard {errors: [...]} envelope. Instead the body is a bare {message: string} object with no code, no errors array. Callers handling 401s should key off the HTTP status and the message string, not try to destructure an errors[].

application/json

get/v1/ediLabelPrinting/usage/summary

GET /v1/ediLabelPrinting/usage/summary HTTP/1.1
Host: api.integrator.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "weeks": [
    {
      "weekStart": "2026-03-30T00:00:00.000Z",
      "weekEnd": "2026-04-05T23:59:59.999Z",
      "numConsumed": 1820
    },
    {
      "weekStart": "2026-03-23T00:00:00.000Z",
      "weekEnd": "2026-03-29T23:59:59.999Z",
      "numConsumed": 2410
    }
  ]
}

Get historical monthly entitlement usage

get

/v1/historicalMonthlyUsage

Returns historical monthly usage for accounts whose pricing model meters flow runs (platform licenses), newest month first; the current month's row can carry null usage until the meter has processed. Useful for month-by-month trend analysis of usage vs. allocation. Not available on plans that do not store monthly usage (endpoint and integrator licenses).

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Historical monthly usage

application/json

Month-by-month usage vs allocation for a billing period.

yearintegerOptional

Calendar year.

Example: 2025

monthinteger · min: 1 · max: 12Optional

Calendar month (1-indexed — 1 = January, 12 = December).

Example: 5

401

Unauthorized. The request lacks a valid bearer token, or the provided token failed to authenticate.

Note: the 401 response is produced by the auth middleware before the request reaches the endpoint handler, so it does not follow the standard {errors: [...]} envelope. Instead the body is a bare {message: string} object with no code, no errors array. Callers handling 401s should key off the HTTP status and the message string, not try to destructure an errors[].

application/json

get/v1/historicalMonthlyUsage

GET /v1/historicalMonthlyUsage HTTP/1.1
Host: api.integrator.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "month": 5,
    "year": 2025,
    "allocated": {
      "flows": 5080,
      "endpoints": 600,
      "agents": 100
    },
    "usage": {
      "flows": 23,
      "endpoints": 8,
      "agents": 0
    },
    "sandbox": {
      "allocated": {
        "flows": 0,
        "endpoints": 0,
        "agents": 0
      },
      "usage": {
        "flows": 0,
        "endpoints": 0,
        "agents": 0
      }
    }
  },
  {
    "month": 4,
    "year": 2025,
    "allocated": {
      "flows": 5080,
      "endpoints": 600,
      "agents": 100,
      "apiInvocation": 0
    },
    "usage": {
      "flows": 31,
      "endpoints": 16,
      "agents": 0,
      "apiInvocationCount": 0,
      "diVolume": 0
    },
    "sandbox": {
      "allocated": {
        "flows": 0,
        "endpoints": 0,
        "agents": 0
      },
      "usage": {
        "flows": 0,
        "endpoints": 0,
        "agents": 0
      }
    }
  }
]

Get usage records (legacy)

get

/v1/usage

Returns historical usage records for the current account (legacy usage series).

The response is an array of monthly records with a duration field (milliseconds).

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Usage records

application/json

A monthly usage record returned by GET /v1/usage.

yearintegerOptional

Calendar year.

Example: 2025

monthinteger · max: 11Optional

Calendar month (0-indexed — 0 = January, 11 = December). Differs from historicalMonthlyUsage which uses 1-indexed months.

Example: 4

millisecondsintegerOptional

Usage duration value in milliseconds (legacy metric).

Example: 1660454

401

Unauthorized. The request lacks a valid bearer token, or the provided token failed to authenticate.

Note: the 401 response is produced by the auth middleware before the request reaches the endpoint handler, so it does not follow the standard {errors: [...]} envelope. Instead the body is a bare {message: string} object with no code, no errors array. Callers handling 401s should key off the HTTP status and the message string, not try to destructure an errors[].

application/json

get/v1/usage

GET /v1/usage HTTP/1.1
Host: api.integrator.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "year": 2025,
    "month": 4,
    "milliseconds": 1660454
  }
]