Skip to content
SlooseSloose

The billing page in one call

GET
/billing/summary
curl --request GET \
  --url https://api.sloose.com/billing/summary \
  --header 'Authorization: Bearer <token>'

Subscription, plan, limits, balance, usage, open notices and the purchasable credit packs.

A sandbox reports the production org’s subscription, notices and top-up settings — the ones that actually govern it — alongside its own usage and warnings.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

The org’s billing state.

Media typeapplication/json

Everything the billing page renders, in one call.

object
stripeConfigured
required

False on a deployment without Stripe keys; the UI hides purchase paths.

boolean
kind
required
string
Allowed values: production sandbox
billingOrgId
required

Whose subscription this describes — itself, or the production org for a sandbox.

string
subscription
required
object
status
required
string | null
Allowed values: free trialing active past_due suspended cancelled
interval
required
string | null
collectionMethod
required
string | null
currentPeriodStart
required
string | null
currentPeriodEnd
required
string | null
cancelAtPeriodEnd
required
boolean
trialEnd
required
string | null
graceEndsAt
required
string | null
suspendedAt
required
string | null
dataRetainedUntil
required
string | null
hasStripeCustomer
required
boolean
plan
required
object
key
required
string | null
Allowed values: free team business enterprise
name
required
string
version
required
number
priceMonthlyCents
required
number | null
priceAnnualCents
required
number | null
currency
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
scheduledPlan
required

A plan change that takes effect at the next renewal.

object
key
required
string | null
Allowed values: free team business enterprise
name
required
string
overage
required
object
offered
required

Whether the plan offers overage at all.

boolean
enabled
required
boolean
perThousand
required
number | null
autotopup
required
object
enabled
required
boolean
threshold
required

Top up when the available balance falls below this.

number | null
monthlyCapCents
required

Never spend more than this in a calendar month.

number | null
packKey
required
string | null
spentCentsThisMonth
required
number
spentMonth
required
string | null
pausedReason
required

Why automatic top-up stopped — a failed charge, or the monthly cap. Saving settings clears it.

string | null
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
usage
required
object
periodStart
required
string
periodEnd
required
string
rowsWritten
required
number
rowsOverage
required
number
creditsUsed
required
number
runs
required
number
warnings
required
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
notices
required
Array<object>
object
id
required
string
orgId
required
string
kind
required
string
createdAt
required
string
acknowledgedAt
required
string | null
resolvedAt
required
string | null
key
additional properties
creditPacks
required
Array<object>
object
key
required
string
name
required
string
credits
required
number
priceCents
required
number
currency
required
string
purchasable
required

False until the pack has a Stripe price attached.

boolean
Example
{
  "kind": "production",
  "subscription": {
    "status": "free"
  },
  "plan": {
    "key": "free"
  },
  "scheduledPlan": {
    "key": "free"
  },
  "warnings": [
    "LIMIT_ROWS"
  ]
}

401

Section titled “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
Examplegenerated
{
  "error": "example",
  "code": "example"
}

403

Section titled “403”

The bearer’s role is too low, or it was issued for a different org.

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"
}