Sign up

API → Payments → Update the user's subscription

Parameters

Name

Type

Req.

  • bodyapplication/json

    object
    optional
    Object Properties

Returns

  • 200 OK

    successful operation

    Name

    Type

    Req.

    body

    object
    optional
    Object Properties

    • modeling_app

      object
      optional
      Object Properties

      • annual_discount

        integer
        optional

      • description

        string
        optional

      • endpoints_included

        array
        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
put
/user/payment/subscriptions
$ curl -X PUT "https://api.zoo.dev/user/payment/subscriptions" \
	--header "Authorization: Bearer $TOKEN" \
	--header "Content-Type: application/json" \
	--data '{
  "modeling_app": "free",
  "pay_annually": true
}'
200 OK
Response
{
  "modeling_app": {
    "annual_discount": 6,
    "description": "FMu",
    "endpoints_included": [
      "modeling"
    ],
    "features": [
      {
        "info": "S9d9rE28g2M2TcDtXyqm3ofj3WBGZ5hOz0AhZ1Ea8LbV2WT34Ne7dTjMIjZGywuahj"
      }
    ],
    "name": "pro",
    "pay_as_you_go_credits": "30.80",
    "price": {
      "interval": "day",
      "price": "29.35",
      "type": "per_user"
    },
    "share_links": [
      "password_protected"
    ],
    "support_tier": "standard",
    "training_data_behavior": "default_off",
    "type": {
      "type": "individual"
    },
    "zoo_tools_included": [
      "diff_chrome_extension"
    ]
  }
}