Skip to content
SlooseSloose

Grant an entitlement override

POST
/entitlements/admin/orgs/{orgId}/overrides
curl --request POST \
  --url https://api.sloose.com/entitlements/admin/orgs/org_9f3c/overrides \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "key": "example", "value": 1, "reason": "example", "grantedBy": "example", "expiresAt": "example" }'

Backoffice route: a staff session, or ADMIN_TOKEN; never a customer’s session. Raises a limit or switches on a feature for one org without changing its plan. reason is required because an override nobody can explain later is a liability; grantedBy is the staff member unless the request says otherwise. Written down as org.override.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
orgId
required

The org id.

string
Example
org_9f3c

The org id.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
key

A plan limit key or a feature key.

string | null
value
Any of:
number
reason

Why. Required.

string | null
grantedBy

Who authorised it. Defaults to the staff member making the request, or “admin token”.

string | null
expiresAt

ISO date. Omitted means it does not expire.

string | null
key
additional properties
Examplegenerated
{
  "key": "example",
  "value": 1,
  "reason": "example",
  "grantedBy": "example",
  "expiresAt": "example"
}

Responses

Section titled “Responses”

201

Section titled “201”

Granted, with the org’s entitlements as they now resolve.

Media typeapplication/json
object
override
required
object
id
required
string
key
required
string
value
required
Any of:
number
reason
required
string
grantedBy
required
string
expiresAt
required
string | null
key
additional properties
entitlements
required

Everything the widget needs to know about what this org may do.

object
orgId
required
string
kind
required
string
Allowed values: production sandbox
subscriptionOrgId
required

The org whose subscription governs this one.

string
creditsOrgId
required

The org whose ledger holds the AI credits this one spends.

string
plan
required
object
id
required
string
key
required
string | null
Allowed values: free team business enterprise
name
required
string
version
required
number
rank
required
number
status
required
string | null
Allowed values: free trialing active past_due suspended cancelled
period
required
object
start
required
string
end
required
string
limits
required
object
crm_users_max
required

CRM users allowed to use the widget; null = unlimited.

number | null
connectors_max
required

Production connectors the org may have; null = unlimited. CSV uploads do not count.

number | null
runs_per_month
required

Import runs that write at least one row, per period; null = unlimited (fair use). Dry runs never count.

number | null
rows_per_run
required

The most rows one import set may declare. Checked before anything is written.

number
rows_per_month
required

Server-side runs only. Browser runs are never refused on it.

number
row_overage_per_1000
required

USD per 1,000 rows beyond rows_per_month, server-side runs only; null = not offered.

number | null
modules_max
required

Null = unlimited.

number | null
schedules_max
required
number
history_days
required
number
ai_credits_monthly
required
number
sandbox_orgs
required
number
features
required
object
shared_projects
required
boolean
helper_libraries
required
boolean
server_run
required
boolean
mcp
required
boolean
rollback
required
boolean
scheduled_imports
required
boolean
crmUsers
required
object
active
required
number | null
max
required
number | null
overrides
required
Array<object>
object
id
required
string
key
required
string
value
required
Any of:
number
reason
required
string
grantedBy
required
string
expiresAt
required
string | null
overageAllowed
required
boolean
overageEnabled
required
boolean
graceEndsAt
required
string | null
trialEndsAt
required
string | null
cancelAtPeriodEnd
required
boolean
subscriptionVersion
required
string
resolvedAt
required
string
usage
required
object
periodStart
required
string
periodEnd
required
string
rowsWritten
required
number
rowsOverage
required
number
creditsUsed
required
number
runs
required
number
balance
required

AI credits. Included credits reset each period; purchased ones do not.

object
included
required
number
purchased
required
number
reserved
required
number
available
required

Included + purchased − reserved

number
periodStart
required
string
periodEnd
required
string
warnings
required

Applies right now regardless of the action.

Array<string>
Allowed values: LIMIT_ROWS LIMIT_RUNS LIMIT_ROWS_PER_RUN LIMIT_CONNECTORS LIMIT_MODULES LIMIT_SCHEDULES LIMIT_CRM_USERS LIMIT_SANDBOX FEATURE_SHARED_PROJECTS FEATURE_HELPER_LIBRARIES FEATURE_SERVER_RUN FEATURE_MCP FEATURE_ROLLBACK FEATURE_SCHEDULED_IMPORTS CREDITS_EXHAUSTED STATUS_SUSPENDED STATUS_PAST_DUE
cached
required
boolean
Example
{
  "entitlements": {
    "kind": "production",
    "plan": {
      "key": "free"
    },
    "status": "free",
    "warnings": [
      "LIMIT_ROWS"
    ]
  }
}

400

Section titled “400”

The key is unknown, the value is the wrong type for it, or a required field is missing.

Media typeapplication/json
object
error
required
string
key
additional properties
Examplegenerated
{
  "error": "example"
}

401

Section titled “401”

A bearer that is neither the token nor a live session (code: AUTH_REQUIRED).

Media typeapplication/json

The error envelope every non-2xx answer uses.

object
error
required

Human-readable explanation.

string
code

Machine-readable reason. Absent on a few legacy 400s.

string
key
additional properties
Examplegenerated
{
  "error": "example",
  "code": "example"
}

403

Section titled “403”

A customer’s session, an API token, or no bearer at all — not staff, and not the ADMIN_TOKEN (code: ADMIN_REQUIRED).

Media typeapplication/json

The error envelope every non-2xx answer uses.

object
error
required

Human-readable explanation.

string
code

Machine-readable reason. Absent on a few legacy 400s.

string
key
additional properties
Examplegenerated
{
  "error": "example",
  "code": "example"
}