Skip to content
Fous Docs
MarkdownStudio

Account

The organization behind the key.

The Account object

  • organizationobject
    Show child attributes
    • idstring
    • namestring
  • creditsobject
    Show child attributes
    • balanceinteger

      Whole credits (1 credit = $0.01).

    • balance_usdnumber

      The balance in US dollars.

  • limitsobject

    The plan’s limits.

    Show child attributes
    • requests_per_minuteinteger

      Calls a minute, counted apart for runs and queries and for searches, builds and sign-ins.

    • concurrent_runsinteger

      Runs and queries going at once.

    • monthly_spend_limit_creditsnumber or null

      The organization’s monthly spend limit, in credits; null: no limit.

  • buildsobject
    Show child attributes
    • free_per_monthinteger

      Public builds a month that cost nothing.

    • used_this_monthinteger

      Builds this month so far.

  • pricesobject

    What each call costs, in credits.

    Show child attributes
    • searchinteger

      A search: free.

    • runinteger

      A run that completes.

    • queryinteger

      A query that answers.

    • build_after_allowanceinteger

      A public build once the month’s free builds are used.

    • private_buildinteger

      A private build, always.

  • keyobject

    The key this call was made with.

    Show child attributes
    • kindstring

      user: a key created in Fous Studio. agent: a key an agent got by connecting itself.

      useragent

    • namestring
    • client_namestring or null

      agent: the agent that connected.

    • expires_atstring or null

      When the key stops working; null: never.

    • last_used_atstring or null

Get the account

The organization behind the key: credit balance, plan limits, monthly build allowance and prices. Free.

Returns

An Account object.

  • 200The account.