SMsmolmachines
billing

Get the caller's account.

Changed on

Returns the caller's plan, effective limits, and period usage and spend. Requires the usage:read or machine:read scope.

get/v1/account

Request

Response

Tenant account: plan, effective limits, period usage + spend

budgetRemainingMicrosinteger nullable
effectiveMaxCpusinteger required
effectiveMaxDiskGbinteger required

Largest disk (GB) one machine may request on this account.

effectiveMaxMachinesinteger required
effectiveMaxMemoryMbinteger required
lowBalanceThresholdMicrosinteger

Effective low-balance email threshold (micros): the balance at which a low-balance warning email fires. Always the resolved value — the per-tenant override if set, else the platform default. 0 means the customer has turned the email off.

monthlyBudgetMicrosinteger nullable
pendingPlanIdstring nullable

The plan the account moves to when its paid period ends, or null if none is scheduled.

prepaidCreditMicrosinteger

Prepaid wallet balance (micros). Topped up via Stripe Checkout; drawn down by metered usage. 0 for tenants that have never added credit.

statusstring required
tenantIdstring required

Changes

  • bc31fc04a568Revision changes
    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property ///// from the response with the status

    • info

      the endpoint scheme security ApiKeyAuth was added to the API

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property ///// to the response with the status

    • info

      added the required property ///// to the response with the status

    • info

      added the required property ///// to the response with the status