Addon Create

Swagger documentation: POST API/Addon/Create

The purpose of this endpoint is to add an addon to a subscription in the external system.

Request & Response

The request contains the same fields as the Subscription Update endpoint. The main difference is the value of the ActionType fields, in the parent object and the add-ons:

• The ActionType of the parent object is equal to None. This is because the subscription itself remains unchanged.
• All addons contained in the order have an ActionType of Provision, and the rest have an ActionType of None.

Please note the ActionTypes of an Addon Create call made for an order containing only Addon A:

The Addons object contains the following fields:

• ID – The ID of the add-on in the external system
• Name – The name of the add-on in the Interworks Cloud Platform.
• ProductID – The ID of the add-on as a product in your system.
• ActionType – The value of the ActionType field in a Addon Create/Update request is Provision.
• Quantity – The quantity of add-ons
• AttributeList – Contains the properties of the add-on in a similar way to the AttributeList of the subscription

The response contains the following fields:

• Code – The error code. Only a value of 0 means that there no error occurred.
• Message – A description of the error (if applicable)
• Result – Contains the ID of the subscription in the external system. This ExternalID is then sent in every subsequent request.

When this Endpoint is Called

Addon Create is called when:

• An order containing addons is executed in the BSS
• A product with addons is purchased via the Storefront during basket checkout.

Implementation Checklist

To test this endpoint:

• Execute an order containing addons in the BSS
• Purchase a subscription containing an addon via the Storefront
• Create a subscription containing addons manually in the BSS

Then, check if the subscription has been created successfully, and contains the selected addons.

Addon Update

Swagger documentation: POST API/Addon/Update

The purpose of this endpoint is to update the addons of a subscription in the external system whenever a change is made to their quantity.

Request & Response

All addons contained in the order have an ActionType of Provision, and the rest have an ActionType of None.

The response contains the same fields as Addon Create.

Please note that the Quantity field contains the current total amount of licenses for the addon, i.e., including those added or cancelled when the endpoint was triggered. To find the difference, please check the records in your system.

When this Endpoint is Called

Addon Update is called when additional licenses are purchased for an addon via the storefront, or when its quantity is changed in the BSS.

Implementation Checklist

To test this endpoint:

• Purchase additional licenses for an addon via the Storefront
• Change the quantity of an addon in the BSS

Then, check if the addons have been updated successfully, based on your choices.

Addon Cancel

Swagger documentation: POST API/Addon/Cancel

The purpose of this endpoint is to cancel the addons of a subscription in the external system whenever a cancellation is requested via the Storefront, or made in the BSS.

Request & Response

All addons contained in the cancellation have an ActionType of Cancel, and the rest have an ActionType of None.

The response contains the same fields as Addon Create.

When this Endpoint is Called

Addon Update is called when addon is cancelled, either in the Storefront or the BSS.

Implementation Checklist

To test this endpoint:

• Cancel an addon of a subscription in the Storefront
• Cancel an addon in the BSS

Then, check if the addons have been cancelled successfully.