SYsync
Account

Get the account, plan, limits and balance behind these credentials

Changed on

Works with an API key (x-api-key), an OAuth access token or a Studio session. Call it before submitting work to check the plan limits and remaining credits or free allowance, and after a 402, 403 or 429 to decide how to recover: billingModel says whether to top up credits (credits), pay or update the payment method (usage), upgrade (free) or contact sync. (enterprise). Send people to billingUrl for anything that needs a payment.

get/v2/account

Request

  • Base URL
    https://api.sync.so
  • Auth
    API key in header x-api-key

Response

Account, organization, plan, limits and balance

credentialType'api_key' | 'oauth' | 'session' required

api_key: an x-api-key header. oauth: an access token issued to a connected app such as an MCP client. session: a Studio sign-in (cookie or plugin bearer token).

billingModel'credits' | 'usage' | 'free' | 'enterprise' required

How generations are paid for, which decides how to recover from a 402. credits: prepaid credits; top up, turn on auto top-up or upgrade at billingUrl. usage: usage is metered and invoiced; pay the open invoice or update the payment method at billingUrl. Usage-based organizations cannot top up. free: a monthly free allowance; upgrade to a paid plan at billingUrl. enterprise: negotiated billing (enterprise, partner and program plans, including pilots); contact your sync. account team.

billingUrlstring uri required

Studio billing page where a person can change plan, pay, top up or update the payment method. Send a person here; it needs a signed-in browser.

Changes