UpdateRefresh

The UpdateRefresh web service XML- or JSON-based information exchange systems that use the Internet for direct application-to-application interaction. These systems can include programs, objects, messages, or documents. provides an external client system with the ability to update or cancel an existing Refresh. When updating a Refresh, a Subscription A billing entity that incurs a charge. Examples include a network attached device whose usage you want to measure and charge for, or a monthly software subscription Refresh History record must also be created.

UpdateRefresh Request

The UpdateRefresh request contains the following elements:

Element Name	Content Type	Description	Required?
ExternalReference	String69	The client may use this identifier to correlate the request and the response.	Optional
TargetIdentifier	Container	Contains a choice of: SubscriptionIdentifier (Integer8) PrimarySerialNumber (String25)	Mandatory
Refreshes	Container	See Refreshes Request Container for details.	Mandatory

Refreshes Request Container

The Refreshes request container contains the following elements:

Element Name	Content Type	Description	Required?
Refresh	Container	See Refreshes request container for details.	Mandatory

Refresh Request Container

The Refresh request container contains the following elements:

Element Name	Content Type	Description	Required?
RefreshNumber	Integer 0-999	Unique refresh ID number	Mandatory
Automatic	Container	Choice of Update, Disable or Enable. See Automatic Request Container for details.	Optional
Recurring	Container	See Recurring Request Container for details.	Optional

Either the Automatic or the Recurring container must be specified in the request.

Automatic Request Container

The Automatic request container contains the following elements:

Element Name	Content Type	Description	Required?
Update	Container	See Update Request Container for details.	Optional
Disable	Boolean	If set to ‘true’, the Refresh is not processed automatically when the low threshold notification is dispatched.	Optional
Enable	Container	See Enable Request Container for details.	Optional

Either the Update, Disable or Enable must be specified in the request.

Update Request Container

The Update request container contains the following elements:

Element Name	Content Type	Description	Required?
Reload	Container	Contains the following two mandatory elements: ReloadMethod (String6) ReloadOption (String6) These are unique CMP identifiers representing Reload which will be purchased by the automatic Refresh.	Optional

Enable Request Container

The Enable request container contains the following elements:

Element Name	Content Type	Description	Required?
AutoPurchase	Boolean	This flag can initiate the Refresh purchase if the Low Threshold has already been breached. If set to ‘true’ then CMP will make the purchase regardless of the balance. Defaults to ‘false’ which results in no action. To enable with no AutoPurchase, empty tags (<Enable></Enable>) would need to be sent for this to be a valid enable request.	Optional

Recurring Request Container

The Recurring request container contains the following elements:

Element Name	Content Type	Description	Required?
Cancel	Container	See Cancel Request Container	Optional

Cancel Request Container

The Recurring request container contains the following elements:

Element Name	Content Type	Description	Required?
ExpiryDate	Date	This is defaulted to the next Recurring Cycle date -1 day. YYYY-MM-DDZ To cancel with no ExpiryDate, empty tags (<Cancel></Cancel>) would need to be sent for this to be a valid cancel request.	Optional

UpdateRefreshResponse

The UpdateRefresh response is the response to the UpdateRefresh Request. It contains the following elements:

Element Name	Content Type	Description	Required?
ExternalReference	String69	Returned unmodified in the response. The client may use this identifier to correlate the request and the response.	Optional