createObject

Classes SoftLayer_Billing_Item_Cancellation_Request
Tags method sldn billing

SoftLayer_Billing_Item_Cancellation_Request::createObject

Creates a cancellation request.

Description

This method creates a service cancellation request.

You need to have “Cancel Services” privilege to create a cancellation request. You have to provide at least one SoftLayer_Billing_Item_Cancellation_Request_Item in the “items” property. Make sure billing item’s category code belongs to the cancelable product codes. You can retrieve the cancelable product category by the SoftLayer_Product_Item_Category::getValidCancelableServiceItemCategories service.

Parameters

Name Type Description
templateObject SoftLayer_Billing_Item_Cancellation_Request The SoftLayer_Billing_Item_Cancellation_Request object that you wish to create.

Required Headers

Optional Headers

Return Values

Error Handling

  • Throw the exception “A cancellation request should have at least one billing item to cancel.” if no cancellation item is proviced. 
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [SoftLayer_Billing_Item_Cancellation_Request]}' \
'https://api.softlayer.com/rest/v3.1/SoftLayer_Billing_Item_Cancellation_Request/createObject'