API → PaymentsGet balance for an org
hidden

Parameters

Name

Type

Req.

  • id

    string / UUID
    required

Returns

  • 200 OK

    successful operation

    Name

    Type

    Req.

    body

    object
    optional
    Object Properties
    • created_at

      string / ISO-8601
      optional
    • id

      string / UUID
      optional
    • map_id

      string / UUID
      optional
    • modeling_app_enterprise_price

      oneOf
      optional
      One of
      • flat

        object
        optional
        Object Properties
        • interval

          string
          optional
          Possible values
          • day:  Day.
          • month:  Month.
          • week:  Week.
          • year:  Year.
        • price

          number / USD Price
          optional
        • type

          string
          optional
          Possible values
          • flat
      • per_user

        object
        optional
        Object Properties
        • interval

          string
          optional
          Possible values
          • day:  Day.
          • month:  Month.
          • week:  Week.
          • year:  Year.
        • price

          number / USD Price
          optional
        • type

          string
          optional
          Possible values
          • per_user
      • enterprise

        object
        optional
        Object Properties
        • type

          string
          optional
          Possible values
          • enterprise
    • monthly_credits_remaining

      number / USD Price
      optional
    • pre_pay_cash_remaining

      number / USD Price
      optional
    • pre_pay_credits_remaining

      number / USD Price
      optional
    • subscription_details

      object
      optional
      Object Properties
      • modeling_app

        object
        optional
        Object Properties
        • description

          string
          optional
        • features

          array
          optional
          Array of
        • name

          string
          optional
          Possible values
          • free:  The free tier.
          • pro:  The pro tier.
          • team:  The team tier.
          • enterprise:  The enterprise tier.
        • pay_as_you_go_credits

          number / USD Price
          optional
        • price

          oneOf
          optional
          One of
          • flat

            object
            optional
            Object Properties
            • interval

              string
              optional
              Possible values
              • day:  Day.
              • month:  Month.
              • week:  Week.
              • year:  Year.
            • price

              number / USD Price
              optional
            • type

              string
              optional
              Possible values
              • flat
          • per_user

            object
            optional
            Object Properties
            • interval

              string
              optional
              Possible values
              • day:  Day.
              • month:  Month.
              • week:  Week.
              • year:  Year.
            • price

              number / USD Price
              optional
            • type

              string
              optional
              Possible values
              • per_user
          • enterprise

            object
            optional
            Object Properties
            • type

              string
              optional
              Possible values
              • enterprise
        • support_tier

          string
          optional
          Possible values
          • community:  Community support.
          • standard:  Standard support.
          • premium:  Premium support.
          • priority:  Priority support.
        • Possible values
          • always:  The data is always used for training and cannot be turned off.
          • default_on:  The data is used for training by default, but can be turned off.
          • default_off:  The data is not used for training by default, but can be turned on.
        • type

          oneOf
          optional
          One of
          • individual

            object
            optional
            Object Properties
            • type

              string
              optional
              Possible values
              • individual
          • organization

            object
            optional
            Object Properties
            • saml_sso

              boolean
              optional
            • type

              string
              optional
              Possible values
              • organization
        • zoo_tools_included

          array
          optional
    • subscription_id

      string
      optional
    • total_due

      number / USD Price
      optional
    • updated_at

      string / ISO-8601
      optional
get
/orgs/{id}/payment/balance
$ curl "https://api.zoo.dev/orgs/{id}/payment/balance" \
	--header "Authorization: Bearer $TOKEN"
200 OK
Response
{
  "created_at": "2024-04-18T22:05:02.021Z",
  "id": "03ca99c1-a3e6-48ac-98f8-913b67c8c332",
  "map_id": "236b1db8-a62c-4728-92fe-1ac76e6ee30c",
  "modeling_app_enterprise_price": {
    "type": "enterprise"
  },
  "monthly_credits_remaining": "75.66",
  "pre_pay_cash_remaining": "0.21",
  "pre_pay_credits_remaining": "83.90",
  "subscription_details": {
    "modeling_app": {
      "description": "6vBSVIQb5SWckCEO0eCYnWw7GYA42",
      "features": [
        {
          "info": "oazcBEd5LNv0IcPodvys1zth6LdIp5IRoBwwichVCRMrbSwR7k9bvxlnON30lsEpTbeCsRpk5"
        }
      ],
      "name": "pro",
      "pay_as_you_go_credits": "99.14",
      "price": {
        "interval": "week",
        "price": "82.26",
        "type": "flat"
      },
      "support_tier": "premium",
      "training_data_behavior": "always",
      "type": {
        "saml_sso": false,
        "type": "organization"
      },
      "zoo_tools_included": [
        "diff_chrome_extension"
      ]
    }
  },
  "subscription_id": "CEPzq4g3",
  "total_due": "38.03",
  "updated_at": "2024-04-18T22:05:02.021Z"
}