-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat!: remove docs on obsolete management API operation `CancelBundle…
…InShop` (#234)
- Loading branch information
Showing
1 changed file
with
1 addition
and
18 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -310,7 +310,7 @@ After you created a bundle you can query the bundle and can check the state of t | |
### Delete bundle | ||
|
||
After a bundle was created (bundle exist and provisioning state is `Succeeded`), you also can delete it. Delete of a bundle means all containing licenses are deleted afterwards. This is possible until you called [Handover the bundle to the shop](#handover-a-bundle-to-shop). After a bundle was handed over to shop, you can no longer delete it. You have to [cancel it](#cancel-a-bundle-in-shop) instead. | ||
After a bundle was created (bundle exist and provisioning state is `Succeeded`), you also can delete it. Delete of a bundle means all containing licenses are deleted afterwards. This is possible until you called [Handover the bundle to the shop](#handover-a-bundle-to-shop). After a bundle was handed over to shop, you can no longer delete it. | ||
|
||
> DELETE `https://api.tapio.one/management/bundles/{id}?subscriptionId=<subscriptionId>` | ||
|
@@ -358,23 +358,6 @@ After the bundle was created successfully (provisioning state), you can hand it | |
|
||
After the handover was successfully called, you have to query the bundle by calling the [Get bundle information](#get-bundle-information) route to check the provisioning state. The state update can take up to 1 minute. In case the state is `Failed` you have to contact the tapio support [[email protected]](mailto:[email protected]). If the provisioning state is `Succeeded` the handover was successful. | ||
|
||
### Cancel a bundle in shop | ||
|
||
Shop-managed bundles can be canceled. Calling this route will suspend the given bundle in the shop. This means the customer can not longer use this bundle. The customer will be notified of this bundle cancel by the shop. | ||
|
||
> DELETE `https://api.tapio.one/management/bundles/{id}/inshop?subscriptionId=<subscriptionId>` | ||
| Property | Description | Datatype | Required | | ||
| -------------- | ------------------------ | -------- | -------- | | ||
| id | bundle id | Guid | yes | | ||
| subscriptionId | customer subscription id | Guid | yes | | ||
|
||
> The canceled bundle will be available as pause bundle for a grace-period. After the grace-period, it will be delteted in the system. | ||
#### Response model | ||
|
||
202 - No Content. | ||
|
||
### Get the shop expiry date of a bundle | ||
|
||
Only works for shop-managed bundles. Gets the current shop expiry date of the bundle. After this period, the bundle will automatically renew. The customer can cancel it in the shop if the bundle is no longer required. | ||
|