Update a subscription for a user

hidden

Parameters

• id

  string

  required

• bodyapplication/json

  object

  optional

  Object Properties

  • modeling_app

    string

    optional

  • pay_annually

    boolean

    optional

Returns

• 200 OK

  successful operation

  Name

  Type

  Req.

  body

  object

  optional

  Object Properties

  • action_client_secret

    string

    optional

  • action_type

    string

    optional

    Possible values

    • payment_intent:  The client secret belongs to a PaymentIntent (initial invoice payment).
    • setup_intent:  The client secret belongs to a SetupIntent (trial or setup-only flow).

  • modeling_app

    object

    optional

    Object Properties

    • annual_discount

      number

      optional

    • billing_mode

      string

      optional

      Possible values

      • standard:  Standard self-serve billing through the normal subscription flow.
      • contract:  Contract-managed billing controlled outside the standard subscription flow.

    • description

      string

      optional

    • display_name

      string

      optional

    • endpoints_included

      array

      optional

    • features

      array

      optional

      Array of

      • info

        string

        optional

    • ml_custom_models

      boolean

      optional

    • monthly_pay_as_you_go_api_credits

      integer

      optional

    • monthly_pay_as_you_go_api_credits_monetary_value

      number / USD Price

      optional

    • name

      string

      optional

    • pay_as_you_go_api_credit_price

      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.
          • unknown:  Don't use.

        • 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.
          • unknown:  Don't use.

        • price

          number / USD Price

          optional

        • type

          string

          optional

          Possible values

          • per_user

      • contract

        object

        optional

        Object Properties

        • type

          string

          optional

          Possible values

          • contract

    • share_links

      array

      optional

    • support_tier

      string

      optional

      Possible values

      • community:  Community support.
      • standard_email:  Standard email support.
      • priority_email:  Priority email support.
      • premium:  Premium 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