Synchronous workflow

While the provisioning flow is designed to be used asynchronously via callbacks, there is a possibility to implement a synchronous solution using the same endpoints.

1. Create account

   The creation of accounts is currently synchronous by design. It returns the account ID and contact ID needed for the following provisioning calls.

2. Create Trial

   To use Create Trial in a synchronous manner, combine its use with the tenant status endpoint.
   Ensure that you submit a unique request ID, so that any potential errors can be easily correlated to the request they came from.
   1. Trigger Create Trial as normal
   2. wait for a period of time (recommended 120 seconds)
   3. call tenant status to check if trial provisioning is finished - check for the tenant and opportunity ID
   4. If the data is not ready yet, check if an error was returned for the submitted request ID
   5. if there is no error, return to step ii

   ❗️

   Automated trial provisioning is currently unavailable for N-Central and EDR.

3. Convert Trial

   Convert trial should be called before the trial expires. This will convert the product into a contracted, billable instance. Pricing is calculated based on default volume discounts based on the committed quantities submitted. Overage will be charged at the same rate as the committed quantities.
   When using this synchronously with the tenant status, check for the contract name and contract end date. Ensure that you submit a unique request ID, so that any potential errors can be easily correlated to the request they came from. Provisioning usually takes around 3-5 minutes.

4. Amend subscription

   ❗️

   Amend subscription cannot currently be confirmed via the tenant status endpoint

   Amend subscription is a process which can be used to upgrade the committed quantities on an existing contract to make use of a higher tier of volume discount. However, no important IDs change, as the contract number and tenant stay the same.

5. Create subscription

   If no trial is desired, a contract can be directly created using Create Subscription, which combines create trial and convert trial into one process to create an immediately contracted product instance. This can also be verified via the tenant status endpoint. Provisioning usually takes around 5-7 minutes.

6. Suspend subscription

   To suspend an active subscription, the Suspend subscription endpoint is available. This can also be verified via the tenant status endpoint. The TenantStatus of the relevant tenant will be changed to "Suspended". This is near instant.