developer_guide:call_reference:addadjustmentrequest

This is an old revision of the document!


AddAdjustmentRequest Call Reference

AddAdjustmentRequest allows you to add a onetime or recurring amount to any subscription.

View:

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 version="1.0" encoding="utf-8"?>
    <AddAdjustmentRequest>
        <Username>string</Username>	
        <Token>string</Token>
        <Guid>string</Guid>	
        <Adjustment>
             <Name>string</Name>
             <Description>string</Description>
             <Price>currency</Price>
             <TrialPrice>currency</TrialPrice>
        </Adjustment>		
    </AddAdjustmentRequest>

Elements

Name Type Occurrence Meaning
AddAdjustmentRequest 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 Unique ID
Adjustment container required Parent Element
Adjustment/Name string required Adjustment short name
Adjustment/Description string required Adjustment memo
Adjustment/Price currency required Adjustment Price
Adjustment/TrialPrice currency optional Adjustment Trial Price

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.

XML

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

Elements

Name Type Occurrence Meaning
AddAdjustmentResponse 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
developer_guide/call_reference/addadjustmentrequest.1330220072.txt.gz · Last modified: 2012/02/24 23:00 (external edit)