Sign up

API → Payments → Get balance for an user
hidden

Parameters

Name

Type

Req.

  • id

    string
    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

        • 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
/users/{id}/payment/balance
$ curl "https://api.zoo.dev/users/{id}/payment/balance" \
	--header "Authorization: Bearer $TOKEN"
200 OK
Response
{
  "created_at": "2025-01-09T18:26:53.200Z",
  "id": "c7aea778-e8b1-436d-b544-8daa5cea9fd0",
  "map_id": "fb477429-552e-42bf-a948-fb63cca59d30",
  "modeling_app_enterprise_price": {
    "interval": "year",
    "price": "77.04",
    "type": "per_user"
  },
  "monthly_credits_remaining": "14.69",
  "pre_pay_cash_remaining": "87.10",
  "pre_pay_credits_remaining": "46.43",
  "subscription_details": {
    "modeling_app": {
      "annual_discount": 22,
      "description": "6bhnKas4Cli8M",
      "features": [
        {
          "info": "FFLbSIM3HXYxnUoH1tcmvNh"
        }
      ],
      "name": "pro",
      "pay_as_you_go_credits": "84.80",
      "price": {
        "interval": "week",
        "price": "50.26",
        "type": "flat"
      },
      "share_links": [
        "password_protected"
      ],
      "support_tier": "priority",
      "training_data_behavior": "default_off",
      "type": {
        "type": "individual"
      },
      "zoo_tools_included": [
        "text_to_cad"
      ]
    }
  },
  "subscription_id": "S81ICrw4CpA3V5rCdcqO0JxaL",
  "total_due": "82.68",
  "updated_at": "2025-01-09T18:26:53.201Z"
}