SubscriptionBridge: recurring billing and subscription management system - Documentation

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== CancellationRequest ======

==== Overview ====

**CancellationRequest** will cancel the subscription. The status of the subscription will change to "cancelled" and the payment gateway will be notified (if applicable). 

**Learn More:**

  * [[:developer_guide:developer_guide#using-the-apis|Using the APIs]]  
  * [[:developer_guide:developer_guide#http-status-code|HTTP Status Codes]]  
  * [[:developer_guide:developer_guide#error-codes|Error Codes]] 
  * [[:developer_guide:developer_guide#troubleshooting|Troubleshooting]] 

===== CancellationRequest =====

==== XML ====

<code>

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

</code>



==== Elements ====


^ Name ^ Type ^ Occurrence  ^ Meaning ^
| **CancellationRequest** | container | required | Parent Element |
| Username | string | required | Merchant API Username (Not your Merchant Center login) |
| Token| string | required | Hash of API Username and Password. [[:developer_guide:developer_guide:LinkID|Creating a Token]] |
| Guid | string | always | This is the identifier for the subscription and should be referenced in future management requests |
| Reason | string | required | The reason you are canceling the subscription |


===== CancellationResponse =====


==== XML ====

<code>

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

</code>



==== 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 |