Overview
/
Developer Tools
/
API Reference
/
Payments
/
Create the subscription for an org.

Create the subscription for an org

HTTP Request

  • application/json

    //
    • modeling_app:

      string,
      //
    • pay_annually:

      boolean
      //
    }

Response

  • 201 Created
    • //
      • action_client_secret:

        string,
        //
      • action_type:

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

        {{ ... }
        //
        • :

          ,
          //
          • //
            {
            • type:

              "individual"
            }
          • //
            {
            • type:

              "organization",
            • saml_sso:

              boolean
              //
            }
        • annual_discount:

          numberdouble,
          //
        • description:

          string,
          //
        • display_name:

          string,
          //
        • ml_custom_models:

          boolean,
          //
        • monthly_pay_as_you_go_api_credits:

          numberuint64,
          //
        • monthly_pay_as_you_go_api_credits_monetary_value:

          numberUSD Price,
          //
        • name:

          string,
          //
        • pay_as_you_go_api_credit_price:

          numberUSD Price,
          //
        • billing_mode:

          "standard"+1
          • //Standard self-serve billing through the normal subscription flow.
            "standard"
          • //Contract-managed billing controlled outside the standard subscription flow.
            "contract"
          ,
          //
        • :

          [[ ... ],
          //
          • one of

            "modeling"+2
            • //The modeling API.
              "modeling"
            • //ML-Ephant ML API.
              "ml"
            • //CAD File API.
              "file"
            //
          ]
        • :

          [[ ... ],
          //
          • //
            {
            • info:

              string
              //
            }
          ]
        • :

          ,
          //
          • //
            {
            • type:

              "contract"
            }
          • //
            {
            • type:

              "flat",
            • price:

              numberUSD Price,
              //
            • interval:

              "day"+4
              • //Day.
                "day"
              • //Month.
                "month"
              • //Week.
                "week"
              • //Year.
                "year"
              • //Don't use.
                "unknown"
              //
            }
          • //
            {
            • type:

              "per_user",
            • price:

              numberUSD Price,
              //
            • interval:

              "day"+4
              • //Day.
                "day"
              • //Month.
                "month"
              • //Week.
                "week"
              • //Year.
                "year"
              • //Don't use.
                "unknown"
              //
            }
        • [[ ... ],
          //
          • one of

            "public"+2
            • //Publicly accessible share links.
              "public"
            • //Share links guarded by a password.
              "password_protected"
            • //Share links restricted to members of the organization.
              "organization_only"
            //
          ]
        • support_tier:

          "community"+3
          • //Community support.
            "community"
          • //Standard email support.
            "standard_email"
          • //Priority email support.
            "priority_email"
          • //Premium support.
            "premium"
          ,
          //
        • training_data_behavior:

          "always"+2
          • //The data is always used for training and cannot be turned off.
            "always"
          • //The data is used for training by default, but can be turned off.
            "default_on"
          • //The data is not used for training by default, but can be turned on.
            "default_off"
          ,
          //
        • :

          [[ ... ]
          //
          • one of

            "modeling_app"+1
            • //The modeling app.
              "modeling_app"
            • //The Text-to-CAD UI.
              "text_to_cad"
            //
          ]
        }
      }

Examples

post
/org/payment/subscriptions
201 Created
Response