Sign up

API → Orgs → Set the enterprise price for an organization
hidden

You must be a Zoo employee to perform this request.

Parameters

Name

Type

Req.

  • id

    string / UUID
    required

    The organization ID.

  • bodyapplication/json

    oneOf
    optional

    The price for an enterprise subscription.

    One of

    • flat

      object
      optional

      A flat price that we publicly list.

      Object Properties

      • interval

        string
        optional

        The interval the price is charged. A plan's interval.

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

      • price

        number / USD Price
        optional

        The price.

      • type

        string
        optional
        Possible values
        • flat

    • per_user

      object
      optional

      A per user price that we publicly list.

      Object Properties

      • interval

        string
        optional

        The interval the price is charged. A plan's interval.

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

      • price

        number / USD Price
        optional

        The price.

      • type

        string
        optional
        Possible values
        • per_user

Returns

  • 200 OK

    successful operation

    Name

    Type

    Req.

    body

    object
    optional

    A struct of Zoo product subscriptions.

    Object Properties

    • modeling_app

      object
      optional

      A modeling app subscription. A subscription tier we offer for the Modeling App.

      Object Properties

      • annual_discount

        integer
        optional

        Annual discount. The percentage off the monthly price if the user pays annually.

      • description

        string
        optional

        A description of the tier.

      • features

        array
        optional

        Features that are included in the subscription.

        Array of

        • info

          string
          optional

          Information about the feature.

      • name

        string
        optional

        The name of the tier. An enum representing a Modeling App subscription tier name.

        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

        The amount of pay-as-you-go credits the individual or org gets outside the modeling app.

      • price

        oneOf
        optional

        The price of the tier per month. If this is for an individual, this is the price they pay. If this is for an organization, this is the price the organization pays per member in the org. This is in USD. The price for a subscription tier.

        One of

        • flat

          object
          optional

          A flat price that we publicly list.

          Object Properties

          • interval

            string
            optional

            The interval the price is charged. A plan's interval.

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

          • price

            number / USD Price
            optional

            The price.

          • type

            string
            optional
            Possible values
            • flat

        • per_user

          object
          optional

          A per user price that we publicly list.

          Object Properties

          • interval

            string
            optional

            The interval the price is charged. A plan's interval.

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

          • price

            number / USD Price
            optional

            The price.

          • type

            string
            optional
            Possible values
            • per_user

        • enterprise

          object
          optional

          Enterprise: The price is not listed and the user needs to contact sales.

          Object Properties

          • type

            string
            optional
            Possible values
            • enterprise

      • share_links

        array
        optional

        The options for sharable links through the modeling app.

      • support_tier

        string
        optional

        The support tier the subscription provides. The support tier the subscription provides.

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

      • training_data_behavior

        string
        optional

        The behavior of the users data (can it be used for training, etc). An enum representing a subscription training data behavior.

        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

        If the tier is offered for an individual or an org. An enum representing a subscription tier type.

        One of

        • individual

          object
          optional

          A subscription tier that can be applied to individuals only.

          Object Properties

          • type

            string
            optional
            Possible values
            • individual

        • organization

          object
          optional

          An subscription tier that can be applied to organizations only.

          Object Properties

          • saml_sso

            boolean
            optional

            Whether or not the subscription type supports SAML SSO.

          • type

            string
            optional
            Possible values
            • organization

      • zoo_tools_included

        array
        optional

        The Zoo tools that you can call unlimited times with this tier.

put
/orgs/{id}/enterprise/pricing
$ curl -X PUT "https://api.zoo.dev/orgs/{id}/enterprise/pricing" \
	--header "Authorization: Bearer $TOKEN" \
	--header "Content-Type: application/json" \
	--data '"{}"'
200 OK
Response
{
  "modeling_app": {
    "annual_discount": 27,
    "description": "23J1kRh4epp1dTgzg0tWvDTT",
    "features": [
      {
        "info": "4DjzTHoooKLkqq0QERkZuuEi"
      }
    ],
    "name": "pro",
    "pay_as_you_go_credits": "23.53",
    "price": {
      "interval": "day",
      "price": "5.35",
      "type": "per_user"
    },
    "share_links": [
      "public"
    ],
    "support_tier": "standard",
    "training_data_behavior": "default_off",
    "type": {
      "saml_sso": false,
      "type": "organization"
    },
    "zoo_tools_included": [
      "diff_chrome_extension"
    ]
  }
}