title: "Entitlements" description: "Entitlements define which features are available to a tenant and how usage-based operations are limited and enforced." They combine subscription state with cr...

Entitlements

Entitlements define which features are available to a tenant and how usage-based operations are limited and enforced. They combine subscription state with credit-based consumption rules.

Entitlements apply uniformly across the system wherever an operation requires them.

What an entitlement is

An entitlement is a contractual capability assigned to a tenant. It determines whether a feature is available and, where applicable, how much it may be used.

Entitlements consist of:

• a mandatory Base subscription
• optional add-on subscriptions
• credits associated with certain add-ons

The absence of a required entitlement makes the corresponding operation unavailable.

Base subscription

Every tenant must have an active Base subscription.

The Base subscription:

• is required for the tenant to exist
• enables access to the system
• cannot be replaced by add-ons

If the Base subscription is cancelled, the tenant is deactivated and no functionality remains available.

Add-on subscriptions

Add-on subscriptions extend the Base subscription with additional capabilities or capacity.

Examples include:

• API access
• Data exchange
• Resource planning
• Additional users
• Additional database capacity

Each add-on:

• operates independently
• becomes active when purchased
• requires an active Base subscription

Removing an add-on affects only the functionality or capacity provided by that add-on.

Credits and usage

Some add-ons include credits that limit how often certain operations may be performed.

Credits represent one-time workloads, not continuous system capacity.

Two credit types exist:

• Monthly credits

• included with the add-on

• reset automatically each billing period

• expire if unused

• Top-up credits (roll-over credits)

• purchased separately

• never expire
• are consumed only after monthly credits are exhausted

Credit consumption order

When an operation requires credits, consumption follows a fixed order:

1. Monthly credits
2. Top-up credits
3. Rejection if no credits remain

This order is deterministic and does not vary by operation type.

Operations that cannot be covered by available credits are rejected.

flowchart TD

A[API Call or Data Exchange Operation]

A --> M{Monthly credits available?}

M -->|Yes| MC[Consume monthly credit]
MC --> OK1[Operation completed]

M -->|No| X{Extra credits available?}

X -->|Yes| XC[Consume extra credit]
XC --> OK2[Operation completed]

X -->|No| FAIL[Operation rejected: no credits]

Where entitlements are enforced

Entitlements are enforced wherever a credit-gated operation is executed.

This includes:

• API calls
• data import and export
• other system operations that consume credits

Enforcement behavior is consistent across UI-initiated actions and API-initiated actions. If an operation requires credits and none are available, the operation does not proceed.

Common issues

• Assuming add-ons can function without the Base subscription
  Add-ons are inactive without an active Base subscription.

• Expecting top-up credits to reset monthly
  Only monthly credits reset. Top-up credits persist until consumed.

• Assuming unused monthly credits carry over
  Monthly credits expire at the end of each billing period.

• Expecting partial execution when credits are exhausted
  Operations requiring credits are rejected when no credits remain.

Related resources