Attach this org as a sandbox

POST

/billing/sandbox/attach

curl --request POST \
  --url https://api.sloose.com/billing/sandbox/attach \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "code": "example" }'

• Production
• Staging

Redeems a link code, moving this org onto the production org’s billing account. Only an org that pays nothing of its own — Free or trialing — can become a sandbox; one with a live subscription keeps it.

Authorizations

• sessionAuth
• apiTokenAuth

Request Body^required

Media typeapplication/json

object

code

string | null

key

additional properties

Example^generated

{
  "code": "example"
}

Responses

200

Attached. The entitlements are the production org’s.

Media typeapplication/json

object

ok

required

boolean

productionOrg

required

object

id

required

string

name

required

string

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

number

boolean

boolean

null

null

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

{
  "ok": true,
  "entitlements": {
    "kind": "production",
    "plan": {
      "key": "free"
    },
    "status": "free",
    "warnings": [
      "LIMIT_ROWS"
    ]
  }
}

400

code is missing or blank.

Media typeapplication/json

object

error

required

string

key

additional properties

Example^generated

{
  "error": "example"
}

401

No bearer, or one that is expired, revoked or no longer resolves to a member.

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

Example^generated

{
  "error": "example",
  "code": "example"
}

403

The production org’s sandbox allowance is already used up.

Media typeapplication/json

object

error

required

string

code

required

string

Allowed values: LIMIT_SANDBOX

key

additional properties

Example

{
  "code": "LIMIT_SANDBOX"
}

404

The code is unknown, already used, or expired.

Media typeapplication/json

object

error

required

string

code

required

string

Allowed values: LINK_INVALID

key

additional properties

Example

{
  "code": "LINK_INVALID"
}

409

Already a sandbox, has a subscription of its own, or already belongs to that billing account.

Media typeapplication/json

object

error

required

string

code

required

string

Allowed values: SANDBOX_ORG HAS_SUBSCRIPTION SAME_ACCOUNT

key

additional properties

Example

{
  "code": "SANDBOX_ORG"
}