developer_guide:call_reference:cancellationrequest

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision
Previous revision
developer_guide:call_reference:cancellationrequest [2012/02/18 00:21] – created mattdeveloper_guide:call_reference:cancellationrequest [2012/03/25 20:10] (current) earlyimpact
Line 1: Line 1:
-====== CancellationRequest Call Reference ======+====== CancellationRequest ======
  
-CancellationRequest will return cancel the subscription. The status will change to "cancelled" and the gateway will be notified (if applicable). +==== Overview ==== 
 + 
 +**CancellationRequest** will cancel the subscription. The status of the subscription will change to "cancelled" and the payment gateway will be notified (if applicable). 
  
-**View:**+**Learn More:**
  
   * [[:developer_guide:developer_guide#using-the-apis|Using the APIs]]     * [[:developer_guide:developer_guide#using-the-apis|Using the APIs]]  
Line 9: Line 11:
   * [[:developer_guide:developer_guide#error-codes|Error Codes]]    * [[:developer_guide:developer_guide#error-codes|Error Codes]] 
   * [[:developer_guide:developer_guide#troubleshooting|Troubleshooting]]    * [[:developer_guide:developer_guide#troubleshooting|Troubleshooting]] 
- 
  
 ===== CancellationRequest ===== ===== 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 ====
Line 38: Line 34:
  
 ^ Name ^ Type ^ Occurrence  ^ Meaning ^ ^ Name ^ Type ^ Occurrence  ^ Meaning ^
-| CancellationRequest | container | required | Parent Element | +**CancellationRequest** | container | required | Parent Element | 
-| Username | string | required | Merchant API username (this is not your SubscriptionBridge login id) | +| Username | string | required | Merchant API Username (Not your Merchant Center login) | 
-| Token | string | required | Your application's security tokenview alsoHow to create token +| Token| string | required | Hash of API Username and Password[[:developer_guide:developer_guide:LinkID|Creating Token]] 
-| Guid | string | required The Subscription ID or Order Number |+| 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 | | Reason | string | required | The reason you are canceling the subscription |
  
  
 ===== CancellationResponse ===== ===== 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. 
- 
  
  
Line 72: Line 62:
  
 ^ Name ^ Type ^ Occurrence  ^ Meaning ^ ^ Name ^ Type ^ Occurrence  ^ Meaning ^
-| CancellationResponse | container | required | Parent Element |+**CancellationResponse** | container | required | Parent Element |
 | Ack | string | always | Success, Error, or Warning | | Ack | string | always | Success, Error, or Warning |
 | Timestamp | string | always | All responses return the official SB time stamp in UTC/GMT | | Timestamp | string | always | All responses return the official SB time stamp in UTC/GMT |
developer_guide/call_reference/cancellationrequest.1329542519.txt.gz · Last modified: 2012/02/16 23:00 (external edit)