developer_guide:call_reference:addadjustmentrequest

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:addadjustmentrequest [2012/02/25 20:34] – created mattdeveloper_guide:call_reference:addadjustmentrequest [2012/02/26 01:50] (current) – [Elements] matt
Line 1: Line 1:
-====== AddAdjustmentRequest Call Reference ======+====== AddAdjustmentRequest ======
  
-AddAdjustmentRequest allows you to add a onetime or recurring amount to any subscription.+==== Overview ==== 
 + 
 +**AddAdjustmentRequest** allows you to add a onetime or recurring amount to any subscription.
  
-**View:**+**Learn More:**
  
   * [[:developer_guide:developer_guide#using-the-apis|Using the APIs]]     * [[:developer_guide:developer_guide#using-the-apis|Using the APIs]]  
Line 12: Line 14:
  
 ===== AddAdjustmentRequest ===== ===== AddAdjustmentRequest =====
- 
-==== 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 43: Line 40:
  
 ^ Name ^ Type ^ Occurrence  ^ Meaning ^ ^ Name ^ Type ^ Occurrence  ^ Meaning ^
-| AddAdjustmentRequest | container | required | Parent Element | +**AddAdjustmentRequest** | 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 Unique ID +| Guid | string | always This is the identifier for the subscription and should be referenced in future management requests 
-| Adjustment| container | required | Parent Element | +**Adjustment** | container | required | Parent Element | 
-| Adjustment/Name| string | required | Adjustment short name |+| Adjustment/Name | string | required | Adjustment short name |
 | Adjustment/Description | string | required | Adjustment memo | | Adjustment/Description | string | required | Adjustment memo |
 | Adjustment/Price | currency | required | Adjustment Price | | Adjustment/Price | currency | required | Adjustment Price |
 | Adjustment/TrialPrice| currency | optional | Adjustment Trial Price | | Adjustment/TrialPrice| currency | optional | Adjustment Trial Price |
 +
  
 ===== AddAdjustmentResponse ===== ===== AddAdjustmentResponse =====
- 
- 
-==== 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 70: Line 62:
         <Ack>string</Ack>          <Ack>string</Ack> 
  <Timestamp>timestamp</Timestamp>  <Timestamp>timestamp</Timestamp>
 +        <Adjustment>
 +             <AdjustmentID>string</AdjustmentID>
 +        </Adjustment>
     </AddAdjustmentResponse>     </AddAdjustmentResponse>
  
 </code> </code>
- 
- 
  
 ==== Elements ==== ==== Elements ====
Line 80: Line 73:
  
 ^ Name ^ Type ^ Occurrence  ^ Meaning ^ ^ Name ^ Type ^ Occurrence  ^ Meaning ^
-| AddAdjustmentResponse | container | required | Parent Element |      +**AddAdjustmentResponse** | 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 |
 +| **Adjustment** | container | always | Parent Element |
 +| Adjustment/AdjustmentID | string | always | Use the Adjustment ID to remove the adjustment later on |
 +
developer_guide/call_reference/addadjustmentrequest.1330220072.txt.gz · Last modified: 2012/02/24 23:00 (external edit)