AddAdjustmentRequest allows you to add a onetime or recurring amount to any subscription.
Learn More:
<?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>
Name | Type | Occurrence | Meaning |
---|---|---|---|
AddAdjustmentRequest | container | required | Parent Element |
Username | string | required | Merchant API Username (Not your Merchant Center login) |
Token | string | required | Hash of API Username and Password. Creating a Token |
Guid | string | always | This is the identifier for the subscription and should be referenced in future management requests |
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 |
<?xml version="1.0" encoding="utf-8"?> <AddAdjustmentResponse> <Ack>string</Ack> <Timestamp>timestamp</Timestamp> <Adjustment> <AdjustmentID>string</AdjustmentID> </Adjustment> </AddAdjustmentResponse>
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 |
Adjustment | container | always | Parent Element |
Adjustment/AdjustmentID | string | always | Use the Adjustment ID to remove the adjustment later on |