Sign in
account

Get Subscription

Get subscription, usage, and overage info for the authenticated user.

is_admin_managed=True when user is an org member (billed by org admin) or has no stripe_data on their subscription (manually provisioned).

get/api/account/subscription

Response

Successful Response

plan_tierstring required
statusstring required
cancel_at_period_endboolean
current_period_startstring nullable
current_period_endstring nullable
usage_percentagenumber required
is_limitedboolean required
overage_eligibleboolean
overage_enabledboolean required
overage_limit_usdnumber nullable required
overage_spend_usdnumber required
overage_percentagenumber required
is_in_overageboolean required
is_org_memberboolean required
is_admin_managedboolean required
storage_used_bytesinteger required
storage_limit_bytesinteger nullable

Changes

Changed in 1 of the 16 revisions of this API.2

  • 76be672861582See the full diff
    • ○

      added the optional property storage_limit_bytes to the response with the 200 status

      response-optional-property-added

    • ○

      added the required property storage_used_bytes to the response with the 200 status

      response-required-property-added