Sign up

API → Payments → Get balance for your user

Parameters

No parameters

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

        • annual_discount

          integer
          optional

        • 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

        • share_links

          array
          optional

        • support_tier

          string
          optional
          Possible values
          • community:  Community support.
          • standard:  Standard support.
          • premium:  Premium support.
          • priority:  Priority support.

        • training_data_behavior

          string
          optional
          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
/user/payment/balance
$ curl "https://api.zoo.dev/user/payment/balance" \
	--header "Authorization: Bearer $TOKEN"
200 OK
Response
{
  "created_at": "2025-02-27T21:31:04.607Z",
  "id": "82a699e0-782a-46c2-9e2a-41299cfa7fc9",
  "map_id": "e0f0b159-ea11-4da5-a7ae-41ca599e4b55",
  "modeling_app_enterprise_price": {
    "type": "enterprise"
  },
  "monthly_credits_remaining": "77.82",
  "pre_pay_cash_remaining": "66.46",
  "pre_pay_credits_remaining": "46.61",
  "subscription_details": {
    "modeling_app": {
      "annual_discount": 8,
      "description": "b7ebOfQhpKcmbzdC9dCLWPm1Ubdy",
      "features": [
        {
          "info": "4p2NV2aDqVsRawCUujO"
        }
      ],
      "name": "enterprise",
      "pay_as_you_go_credits": "35.10",
      "price": {
        "interval": "month",
        "price": "28.21",
        "type": "flat"
      },
      "share_links": [
        "organization_only"
      ],
      "support_tier": "community",
      "training_data_behavior": "default_on",
      "type": {
        "saml_sso": true,
        "type": "organization"
      },
      "zoo_tools_included": [
        "modeling_app"
      ]
    }
  },
  "subscription_id": "wqI61wqegQFiU",
  "total_due": "84.15",
  "updated_at": "2025-02-27T21:31:04.607Z"
}