This is an old revision of the document!

CancellationRequest Call Reference

CancellationRequest will return cancel the subscription. The status will change to “cancelled” and the gateway will be notified (if applicable).

View:

CancellationRequest

Overview

The box below lists all fields that could be included in the call request. To learn more about an individual field or its type, scroll down to find it in the table below the box.

XML

<?xml version="1.0" encoding="utf-8"?>
    <CancellationRequest>
        <Username>string</Username>	
        <Token>string</Token>	
        <Guid>string</Guid>	
	<Reason>string</Reason>	
    </CancellationRequest>

Elements

Name	Type	Occurrence	Meaning
CancellationRequest	container	required	Parent Element
Username	string	required	Merchant API username (this is not your SubscriptionBridge login id)
Token	string	required	Your application's security token. view also: How to create a token
Guid	string	required	The Subscription ID or Order Number
Reason	string	required	The reason you are canceling the subscription

CancellationResponse

Overview

The box below lists all fields that could be included in the call response. To learn more about an individual field or its type, scroll down to find it in the table below the box.

XML

<?xml version="1.0" encoding="utf-8"?>
    <CancellationResponse>
        <Ack>string</Ack>
	<Timestamp>timestamp</Timestamp>
    </CancellationResponse>

Elements

Name	Type	Occurrence	Meaning
CancellationResponse	container	required	Parent Element
Ack	string	always	Success, Error, or Warning
Timestamp	string	always	All responses return the official SB time stamp in UTC/GMT

SubscriptionBridge: recurring billing and subscription management system - Documentation

Table of Contents

CancellationRequest Call Reference