Skip to content
Docs

Plans, subscriptions, payment methods, invoices, usage and prepaid credits.

Base URLhttps://api.socialit.com/v1AuthenticationErrorsRate limits9 endpointsMCP toolset billing

Get usage

GET/usage

Plan, limits and consumption for the current period: connected accounts against the allowance (plan included + extra accounts + lifetime + Apple seats), members, profiles, webhooks, API keys, posts, storage, API requests this hour, X API pass-through calls and spend, and prepaid credits. Also covers the deprecated usage-stats snapshot.

Access: readZernio: GET /v1/usageGET /v1/usage-stats

Try it with MCPAsk your agent to call get-usage (toolset billing)Set up MCP

Returns object

objectstring

usage

planstring

freeprobusinessenterprise

intervalstring | null
period_startstring (date-time) | null
period_endstring (date-time) | null
accountsobject
Show 10 child attributes
usedinteger
includedinteger | null
extra_purchasedinteger
lifetimeinteger
appleinteger
legacy_subscribedinteger
limitinteger | null
availableinteger | null
over_limitinteger
pausedinteger
membersobject
Show 2 child attributes
usedinteger
limitinteger | null
profilesobject
Show 2 child attributes
usedinteger
limitinteger | null
webhooksobject
Show 2 child attributes
usedinteger
limitinteger | null
api_keysobject
Show 2 child attributes
usedinteger
limitinteger | null
postsobject
Show 2 child attributes
this_monthinteger
limit_per_monthinteger | null
storageobject
Show 2 child attributes
used_bytesinteger
limit_bytesinteger | null
apiobject
Show 2 child attributes
requests_this_hourinteger
limit_per_hourinteger
x_apiobject
Show 3 child attributes
callsinteger
spend_centsinteger
calls_by_operationmap of integer
credits_centsinteger

Responses

  • 200OK
  • 4XXErrors: invalid request, auth, permission, not found, conflict, plan or rate limit
  • 5XXErrors: server or upstream network error
GET/usage
curl "https://api.socialit.com/v1/usage" \
  -H "Authorization: Bearer $SOCIALIT_API_KEY"
Response · 200
{
  "object": "usage",
  "plan": "free",
  "interval": "string",
  "period_start": "2026-10-13T09:00:00.000Z",
  "period_end": "2026-10-13T09:00:00.000Z",
  "accounts": {
    "used": 1,
    "included": 1,
    "extra_purchased": 1,
    "lifetime": 1,
    "apple": 1,
    "legacy_subscribed": 1,
    "limit": 1,
    "available": 1,
    "over_limit": 1,
    "paused": 1
  },
  "members": {
    "used": 1,
    "limit": 1
  },
  "profiles": {
    "used": 1,
    "limit": 1
  },
  "webhooks": {
    "used": 1,
    "limit": 1
  },
  "api_keys": {
    "used": 1,
    "limit": 1
  },
  "posts": {
    "this_month": 1,
    "limit_per_month": 1
  },
  "storage": {
    "used_bytes": 1,
    "limit_bytes": 1
  },
  "api": {
    "requests_this_hour": 1,
    "limit_per_hour": 1
  },
  "x_api": {
    "calls": 1,
    "spend_cents": 1,
    "calls_by_operation": {
      "key": 1
    }
  },
  "credits_cents": 1
}

Get X API usage

GET/usage/x-api

Metering of X API pass-through calls (debited from prepaid credits at cost) over a window: totals, per-operation breakdown and a day/month series. Pair with GET /billing/x-pricing. Profile-restricted keys only see their profiles’ accounts.

Access: read

Try it with MCPAsk your agent to call get-x-api-usage (toolset billing)Set up MCP

Query parameters

rangestringdefault: "cycle"

cycleprev_cycle7d30d90d12mocustom

fromstring (date)
tostring (date)
granularitystringdefault: "day"

daymonthtotal

account_idstring

pattern ^sa_[0-9A-Za-z]{27}$

Returns object

objectstring

x_api_usage

rangestring
fromstring
tostring
granularitystring
totalsobject
Show 3 child attributes
callsinteger
spend_centsinteger
spend_micro_usdinteger
by_operationarray of object
Show 3 item attributes
operationstring
callsinteger
spend_centsinteger
daysarray of object
Show 3 item attributes
datestring
callsinteger
spend_centsinteger

Responses

  • 200OK
  • 4XXErrors: invalid request, auth, permission, not found, conflict, plan or rate limit
  • 5XXErrors: server or upstream network error
GET/usage/x-api
curl "https://api.socialit.com/v1/usage/x-api" \
  -H "Authorization: Bearer $SOCIALIT_API_KEY"
Response · 200
{
  "object": "x_api_usage",
  "range": "string",
  "from": "+15551234567",
  "to": "+15551234567",
  "granularity": "string",
  "totals": {
    "calls": 1,
    "spend_cents": 1,
    "spend_micro_usd": 1
  },
  "by_operation": [
    {
      "operation": "string",
      "calls": 1,
      "spend_cents": 1
    }
  ],
  "days": [
    {
      "date": "string",
      "calls": 1,
      "spend_cents": 1
    }
  ]
}

Get billing overview

GET/billing

Plan, billing interval, subscription status and period, extra accounts, recurring price, account allowance and publishing pause, payment method, invoices summary, upcoming invoice, credits and the dashboard banner.

Access: readZernio: GET /v1/billing

Try it with MCPAsk your agent to call get-billing (toolset billing)Set up MCP

Returns object

objectstring

billing

planstring

freeprobusinessenterprise

plan_namestring
intervalstring | null
statusstring
providerstring

nonestripeappleltdenterprise

customer_idstring | null
subscription_idstring | null
current_period_startstring (date-time) | null
current_period_endstring (date-time) | null
cancel_at_period_endboolean
canceled_atstring (date-time) | null
extra_accountsinteger
priceobject | null
Show 6 child attributes
currencystring
base_centsinteger
extra_account_centsinteger
extra_accounts_centsinteger
total_centsinteger
periodstring
accountsobject
Show 10 child attributes
usedinteger
includedinteger | null
extra_purchasedinteger
lifetimeinteger
appleinteger
legacy_subscribedinteger
limitinteger | null
availableinteger | null
over_limitinteger
pausedinteger
publishing_pausedobject
Show 2 child attributes
activeboolean
account_idsarray of string
bannerobject | null
Show 4 child attributes
typestring
severitystring
messagestring
actionstring
payment_methodobject | null
Show 10 child attributes
objectstring

payment_method

idstring
typestring
brandstring | null
last4string | null
exp_monthinteger | null
exp_yearinteger | null
walletstring | null
is_defaultboolean
created_atstring (date-time) | null
has_payment_methodboolean
invoicesobject
Show 3 child attributes
latestobject | null
Show 21 child attributes
objectstring

invoice

idstring
numberstring | null
statusstring | null
currencystring
amount_due_centsinteger
amount_paid_centsinteger
amount_remaining_centsinteger
subtotal_centsinteger
tax_centsinteger
total_centsinteger
billing_reasonstring | null
descriptionstring | null
period_startstring (date-time) | null
period_endstring (date-time) | null
hosted_invoice_urlstring | null
invoice_pdfstring | null
due_datestring (date-time) | null
paid_atstring (date-time) | null
created_atstring (date-time) | null
linesarray of object
Show 5 item attributes
descriptionstring | null
amount_centsinteger
quantityinteger | null
period_startstring (date-time) | null
period_endstring (date-time) | null
open_countinteger
open_amount_centsinteger
upcoming_invoiceobject | null
Show 3 child attributes
amount_due_centsinteger
currencystring
next_payment_attemptstring (date-time) | null
credits_centsinteger
x_usage_blockedboolean
legacyobject
Show 6 child attributes
billing_modestring
lifetime_seatsinteger
subscribed_seatsinteger
apple_seatsinteger
sourcestring | null
meteredboolean

Responses

  • 200OK
  • 4XXErrors: invalid request, auth, permission, not found, conflict, plan or rate limit
  • 5XXErrors: server or upstream network error
GET/billing
curl "https://api.socialit.com/v1/billing" \
  -H "Authorization: Bearer $SOCIALIT_API_KEY"
Response · 200
{
  "object": "billing",
  "plan": "free",
  "plan_name": "string",
  "interval": "string",
  "status": "string",
  "provider": "none",
  "customer_id": "string",
  "subscription_id": "string",
  "current_period_start": "2026-10-13T09:00:00.000Z",
  "current_period_end": "2026-10-13T09:00:00.000Z",
  "cancel_at_period_end": true,
  "canceled_at": "2026-10-13T09:00:00.000Z",
  "extra_accounts": 1,
  "price": {
    "currency": "USD",
    "base_cents": 1,
    "extra_account_cents": 1,
    "extra_accounts_cents": 1,
    "total_cents": 1,
    "period": "string"
  },
  "accounts": {
    "used": 1,
    "included": 1,
    "extra_purchased": 1,
    "lifetime": 1,
    "apple": 1,
    "legacy_subscribed": 1,
    "limit": 1,
    "available": 1,
    "over_limit": 1,
    "paused": 1
  },
  "publishing_paused": {
    "active": true,
    "account_ids": [
      "string"
    ]
  },
  "banner": {
    "type": "string",
    "severity": "string",
    "message": "string",
    "action": "string"
  },
  "payment_method": {
    "object": "payment_method",
    "id": "string",
    "type": "string",
    "brand": "string",
    "last4": "string",
    "exp_month": 1,
    "exp_year": 1,
    "wallet": "string",
    "is_default": true,
    "created_at": "2026-10-13T09:00:00.000Z"
  },
  "has_payment_method": true,
  "invoices": {
    "latest": {
      "object": "invoice",
      "id": "string",
      "number": "string",
      "status": "string",
      "currency": "USD",
      "amount_due_cents": 1,
      "amount_paid_cents": 1,
      "amount_remaining_cents": 1,
      "subtotal_cents": 1,
      "tax_cents": 1,
      "total_cents": 1,
      "billing_reason": "string",
      "description": "string",
      "period_start": "2026-10-13T09:00:00.000Z",
      "period_end": "2026-10-13T09:00:00.000Z",
      "hosted_invoice_url": "https://example.com",
      "invoice_pdf": "string",
      "due_date": "2026-10-13T09:00:00.000Z",
      "paid_at": "2026-10-13T09:00:00.000Z",
      "created_at": "2026-10-13T09:00:00.000Z",
      "lines": [
        {
          "description": "string",
          "amount_cents": 1,
          "quantity": 1,
          "period_start": "2026-10-13T09:00:00.000Z",
          "period_end": "2026-10-13T09:00:00.000Z"
        }
      ]
    },
    "open_count": 1,
    "open_amount_cents": 1
  },
  "upcoming_invoice": {
    "amount_due_cents": 1,
    "currency": "USD",
    "next_payment_attempt": "2026-10-13T09:00:00.000Z"
  },
  "credits_cents": 1,
  "x_usage_blocked": true,
  "legacy": {
    "billing_mode": "string",
    "lifetime_seats": 1,
    "subscribed_seats": 1,
    "apple_seats": 1,
    "source": "string",
    "metered": true
  }
}

List plans

GET/billing/plans

Prices (price_cents per month, year = per month billed yearly; billed_cents per billing period), extra account prices, limits and features of every plan.

Access: read

Try it with MCPAsk your agent to call list-plans (toolset billing)Set up MCP

Returns object

objectstringrequired

list

dataarray of objectrequired
Show 12 item attributes
objectstring

plan

idstring

freeprobusinessenterprise

namestring
rankinteger
self_serveboolean
currentboolean
price_centsobject
Show 2 child attributes
monthinteger | null
yearinteger | null
billed_centsobject
Show 2 child attributes
monthinteger | null
yearinteger | null
extra_account_centsobject
Show 2 child attributes
monthinteger | null
yearinteger | null
extra_account_billed_centsobject
Show 2 child attributes
monthinteger | null
yearinteger | null
limitsmap of integer | null
featuresmap of boolean
pageintegerrequired
limitintegerrequired
totalinteger | null
has_morebooleanrequired
next_page_urlstring | null
previous_page_urlstring | null

Responses

  • 200OK
  • 4XXErrors: invalid request, auth, permission, not found, conflict, plan or rate limit
  • 5XXErrors: server or upstream network error
GET/billing/plans
curl "https://api.socialit.com/v1/billing/plans" \
  -H "Authorization: Bearer $SOCIALIT_API_KEY"
Response · 200
{
  "object": "list",
  "data": [
    {
      "object": "plan",
      "id": "free",
      "name": "string",
      "rank": 1,
      "self_serve": true,
      "current": true,
      "price_cents": {
        "month": 1,
        "year": 1
      },
      "billed_cents": {
        "month": 1,
        "year": 1
      },
      "extra_account_cents": {
        "month": 1,
        "year": 1
      },
      "extra_account_billed_cents": {
        "month": 1,
        "year": 1
      },
      "limits": {},
      "features": {}
    }
  ],
  "page": 1,
  "limit": 1,
  "total": 1,
  "has_more": true,
  "next_page_url": "https://example.com",
  "previous_page_url": "https://example.com"
}

Get X API pricing

GET/billing/x-pricing

The X API pass-through price table (zero markup) by operation and tier. Safe to cache for a billing period.

Access: readZernio: GET /v1/billing/x-pricing

Try it with MCPAsk your agent to call get-x-pricing (toolset billing)Set up MCP

Returns object

objectstring

x_pricing

currencystring
markupstring
sourcestring
last_verifiedstring
tiersarray of object
Show 3 item attributes
tierstring
price_per_call_usdnumber
operation_countinteger
operationsarray of object
Show 7 item attributes
operationstring
display_namestring
price_per_call_usdnumber
price_per_call_centsnumber
price_micro_usdinteger
tierstring
triggered_byarray of string

Responses

  • 200OK
  • 4XXErrors: invalid request, auth, permission, not found, conflict, plan or rate limit
  • 5XXErrors: server or upstream network error
GET/billing/x-pricing
curl "https://api.socialit.com/v1/billing/x-pricing" \
  -H "Authorization: Bearer $SOCIALIT_API_KEY"
Response · 200
{
  "object": "x_pricing",
  "currency": "USD",
  "markup": "string",
  "source": "string",
  "last_verified": "string",
  "tiers": [
    {
      "tier": "string",
      "price_per_call_usd": 1.5,
      "operation_count": 1
    }
  ],
  "operations": [
    {
      "operation": "string",
      "display_name": "string",
      "price_per_call_usd": 1.5,
      "price_per_call_cents": 1.5,
      "price_micro_usd": 1,
      "tier": "string",
      "triggered_by": [
        "string"
      ]
    }
  ]
}

Get prepaid credits

GET/billing/credits

Credit balance (USD cents) used for X API pass-through calls, whether X actions are blocked, and the credit packs for sale.

Access: read

Try it with MCPAsk your agent to call get-billing-credits (toolset billing)Set up MCP

Returns object

objectstring

credits

balance_centsinteger
x_usage_blockedboolean
packsarray of object
Show 4 item attributes
idstring
price_centsinteger
credits_centsinteger
ios_product_idstring | null

Responses

  • 200OK
  • 4XXErrors: invalid request, auth, permission, not found, conflict, plan or rate limit
  • 5XXErrors: server or upstream network error
GET/billing/credits
curl "https://api.socialit.com/v1/billing/credits" \
  -H "Authorization: Bearer $SOCIALIT_API_KEY"
Response · 200
{
  "object": "credits",
  "balance_cents": 1,
  "x_usage_blocked": true,
  "packs": [
    {
      "id": "string",
      "price_cents": 1,
      "credits_cents": 1,
      "ios_product_id": "string"
    }
  ]
}

Preview a plan change

GET/billing/preview

Recurring price and the proration due now for switching plan, interval or extra accounts. Without a subscription the preview is the first period (requires_checkout: true). Upgrades are invoiced immediately; downgrades credit the next invoice.

Access: read

Try it with MCPAsk your agent to call preview-billing-change (toolset billing)Set up MCP

Query parameters

planstringrequired

freeprobusinessenterprise

intervalstring

monthyear

extra_accountsinteger

0–100000

Returns object

objectstring

billing_preview

planstring
intervalstring
extra_accountsinteger
change_typestring

newupgradedowngradeinterval_changeextra_accountsnone

requires_checkoutboolean
currencystring
recurringobject
Show 4 child attributes
base_centsinteger
extra_accounts_centsinteger
total_centsinteger
periodstring
amount_due_now_centsinteger
proration_dateinteger | null
linesarray of object
Show 5 item attributes
descriptionstring | null
amount_centsinteger
prorationboolean
period_startstring (date-time) | null
period_endstring (date-time) | null
next_invoice_atstring (date-time) | null
accountsobject
Show 3 child attributes
usedinteger
limit_afterinteger | null
over_limit_afterinteger

Responses

  • 200OK
  • 4XXErrors: invalid request, auth, permission, not found, conflict, plan or rate limit
  • 5XXErrors: server or upstream network error
GET/billing/preview
curl "https://api.socialit.com/v1/billing/preview?plan=value" \
  -H "Authorization: Bearer $SOCIALIT_API_KEY"
Response · 200
{
  "object": "billing_preview",
  "plan": "string",
  "interval": "string",
  "extra_accounts": 1,
  "change_type": "new",
  "requires_checkout": true,
  "currency": "USD",
  "recurring": {
    "base_cents": 1,
    "extra_accounts_cents": 1,
    "total_cents": 1,
    "period": "string"
  },
  "amount_due_now_cents": 1,
  "proration_date": 1,
  "lines": [
    {
      "description": "string",
      "amount_cents": 1,
      "proration": true,
      "period_start": "2026-10-13T09:00:00.000Z",
      "period_end": "2026-10-13T09:00:00.000Z"
    }
  ],
  "next_invoice_at": "2026-10-13T09:00:00.000Z",
  "accounts": {
    "used": 1,
    "limit_after": 1,
    "over_limit_after": 1
  }
}

List invoices

GET/billing/invoices

Stripe invoices of the workspace, newest first, with hosted page and PDF links.

Access: read

Try it with MCPAsk your agent to call list-billing-invoices (toolset billing)Set up MCP

Query parameters

pageintegerdefault: 1

1–50

limitintegerdefault: 20

1–100

statusstring

draftopenpaiduncollectiblevoid

Returns object

objectstringrequired

list

dataarray of objectrequired
Show 21 item attributes
objectstring

invoice

idstring
numberstring | null
statusstring | null
currencystring
amount_due_centsinteger
amount_paid_centsinteger
amount_remaining_centsinteger
subtotal_centsinteger
tax_centsinteger
total_centsinteger
billing_reasonstring | null
descriptionstring | null
period_startstring (date-time) | null
period_endstring (date-time) | null
hosted_invoice_urlstring | null
invoice_pdfstring | null
due_datestring (date-time) | null
paid_atstring (date-time) | null
created_atstring (date-time) | null
linesarray of object
Show 5 item attributes
descriptionstring | null
amount_centsinteger
quantityinteger | null
period_startstring (date-time) | null
period_endstring (date-time) | null
pageintegerrequired
limitintegerrequired
totalinteger | null
has_morebooleanrequired
next_page_urlstring | null
previous_page_urlstring | null

Responses

  • 200OK
  • 4XXErrors: invalid request, auth, permission, not found, conflict, plan or rate limit
  • 5XXErrors: server or upstream network error
GET/billing/invoices
curl "https://api.socialit.com/v1/billing/invoices" \
  -H "Authorization: Bearer $SOCIALIT_API_KEY"
Response · 200
{
  "object": "list",
  "data": [
    {
      "object": "invoice",
      "id": "string",
      "number": "string",
      "status": "string",
      "currency": "USD",
      "amount_due_cents": 1,
      "amount_paid_cents": 1,
      "amount_remaining_cents": 1,
      "subtotal_cents": 1,
      "tax_cents": 1,
      "total_cents": 1,
      "billing_reason": "string",
      "description": "string",
      "period_start": "2026-10-13T09:00:00.000Z",
      "period_end": "2026-10-13T09:00:00.000Z",
      "hosted_invoice_url": "https://example.com",
      "invoice_pdf": "string",
      "due_date": "2026-10-13T09:00:00.000Z",
      "paid_at": "2026-10-13T09:00:00.000Z",
      "created_at": "2026-10-13T09:00:00.000Z",
      "lines": [
        {
          "description": "string",
          "amount_cents": 1,
          "quantity": 1,
          "period_start": "2026-10-13T09:00:00.000Z",
          "period_end": "2026-10-13T09:00:00.000Z"
        }
      ]
    }
  ],
  "page": 1,
  "limit": 1,
  "total": 1,
  "has_more": true,
  "next_page_url": "https://example.com",
  "previous_page_url": "https://example.com"
}

Get an invoice

GET/billing/invoices/{id}

Access: read

Try it with MCPAsk your agent to call get-billing-invoice (toolset billing)Set up MCP

Path parameters

idstringrequired

pattern ^in_[A-Za-z0-9_]+$

Returns object

objectstring

invoice

idstring
numberstring | null
statusstring | null
currencystring
amount_due_centsinteger
amount_paid_centsinteger
amount_remaining_centsinteger
subtotal_centsinteger
tax_centsinteger
total_centsinteger
billing_reasonstring | null
descriptionstring | null
period_startstring (date-time) | null
period_endstring (date-time) | null
hosted_invoice_urlstring | null
invoice_pdfstring | null
due_datestring (date-time) | null
paid_atstring (date-time) | null
created_atstring (date-time) | null
linesarray of object
Show 5 item attributes
descriptionstring | null
amount_centsinteger
quantityinteger | null
period_startstring (date-time) | null
period_endstring (date-time) | null

Responses

  • 200OK
  • 4XXErrors: invalid request, auth, permission, not found, conflict, plan or rate limit
  • 5XXErrors: server or upstream network error
GET/billing/invoices/{id}
curl "https://api.socialit.com/v1/billing/invoices/ID" \
  -H "Authorization: Bearer $SOCIALIT_API_KEY"
Response · 200
{
  "object": "invoice",
  "id": "string",
  "number": "string",
  "status": "string",
  "currency": "USD",
  "amount_due_cents": 1,
  "amount_paid_cents": 1,
  "amount_remaining_cents": 1,
  "subtotal_cents": 1,
  "tax_cents": 1,
  "total_cents": 1,
  "billing_reason": "string",
  "description": "string",
  "period_start": "2026-10-13T09:00:00.000Z",
  "period_end": "2026-10-13T09:00:00.000Z",
  "hosted_invoice_url": "https://example.com",
  "invoice_pdf": "string",
  "due_date": "2026-10-13T09:00:00.000Z",
  "paid_at": "2026-10-13T09:00:00.000Z",
  "created_at": "2026-10-13T09:00:00.000Z",
  "lines": [
    {
      "description": "string",
      "amount_cents": 1,
      "quantity": 1,
      "period_start": "2026-10-13T09:00:00.000Z",
      "period_end": "2026-10-13T09:00:00.000Z"
    }
  ]
}