|
Description |
Parameters |
|
|---|---|---|
|
Passed |
Returned |
|
|
This method places a cancellation order for a specified subscription. Warning: The method allows placing the cancellation order for subscriptions in any status, except for the Ordered, Terminated and Cancelled statuses. Placing cancellation orders for the subscriptions in mentioned statuses is prohibited in Billing GUI. |
4 | 2 |
Syntax
Copy
ItemResult BM::PlaceSubscriptionCancellationOrder_API(
Int SubscriptionID;
Int CancelType;
Int ReasonID;
Str Descr
)returns
Copy
Str ErrorMessage – message after cancellation order for specified subscription has been placed: "Cancellation Order has been placed".
Int CancellationOrderID – The ID of placed cancellation order.Special Notes
- Int SubscriptionID – ID of subscription to be canceled.
- Int CancelType – cancellation type:
- 10 – customer is refunded. Corresponds to the behavior of subscription, for which all check boxes of Subscription Cancellation Options (Control Panel) are selected. The refund, overuse and cancellation fees are taken.
- 20 – customer account is credited (credit memo is created). The refund, overuse and cancellation fees are taken.
- 30 – customer is not refunded / credited. Corresponds to the behavior of subscription, for which all check boxes of Subscription Cancellation Options (Control Panel) are deselected. No refund, overuse or cancellation fees are taken.
- Int ReasonID – ID of system reason code to be stated as reason of subscription cancellation.
- Str Descr – optional comment on the reason subscription is canceled.
Important: There is no option to manage overuse fee, and this API method does not provide possibility to cancel a subscription according to configured refund policy. That is, you cannot use this method when the policy is set to No Refund and there are some overuse fee to be taken on the subscription cancellation.