Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Available from CRM.COM R4.0.0
Tip
Excerpt

This method is creating cancel subscriptions provisioning requests in a pending life cycle state, by specifying the service and the smartcard that should be cancelled, and the subscription that the service should belong to.

...

Name

Type

Description

token

String

The token retrieved from the login method

subscription_identifier 

(mandatory)

Subscription identifier

The subscription that the service to be cancelled belongs to. The available subscription identifier fields are the following:

Include Page
V4:subscription_identifier
V4:subscription_identifier

service_identifier

(mandatory)

Product identifier

The service that should be cancelled. Only products classified as services can be specified. The available product identifier fields are the following:

Include Page
V4:product_identifier
V4:product_identifier

smartcard_identifier

(mandatory)

Installed Item identifier

The smartcard that the service should be added on. Only installed items classified as smartcards through the provisioning provider can be specified. The available installed item identifier fields are the following:

Include Page
V4:installed_item_identifier
V4:installed_item_identifier

process_immediately

(optional)

booleanDefines if the provisioning request will be processed immediately after its creation. If enabled then the provisioning request will be sent through Web API during its creation. If not enabled then the provisioning request will be created and processed later on by the active provisioning request processing run. If not specified then the provisioning request will not be processed immediately

start_date

(optional)

StringThe date that the provisioning request will be applied. If not specified then it is set to the date that the request is submitted

priority

(optional)

String

The priority of the provisioning request. The supported values are the following:

  • REGULAR
  • EXPRESS

If not specified then it is set to REGULAR

scheduled_date

(optional)

Date

The date that the provisioning request is scheduled to be processed. If not specified and process_immediatelly is also set to false, then the provisioning request will be processed immediately

Tip

Available from CRM.COM R7.0.0

Restrictions

  • It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

...