API DOCUMENTATION Last Update: July 2025

Campaign Fees List

Returns a list of the fees for a given campaign.

 

Headers

  Key   Value   Note
api_access_key user_api_key Optional

 

 

The data to be submitted to the API is composed of the following fields:

 

  field   Example   Note
user_id john1970 Required
user_password 1959caadac9b13dcb3 Required if not included in the headers
type campaign_fees Required
account_id greatwidgets Required
campaign_id 1234567890123456 Required
Output Format:
output JSON or XML Optional. If not provided, defaults to XML
callback someFunctionName Optional: JSONP format
condensed yes Optional (No white space)
Applies only to JSON(P) output

 

Notes:

  • Headers: the user_api_key value can be included in either the header section or the body of the request. If the key is provided in both locations, the API will process and validate only the value provided in the headers.

  • Campaign fees are only available for Points and GiftCard (Stored Value) type of campaigns.

 

Example PHP Request:

If you are using PHP, the $data array would look like this:

  1. $data['user_id'] = 'john1970';
  2. $data['user_password'] = '1959caadac9b13dcb3';
  3. $data['type'] = 'campaign_fees';
  4. $data['account_id'] = 'greatwidgets';
  5. $data['campaign_id'] = '1234567890123456';

 

Success XML Response:

  1. <response status="success">
  2. <campaign>
  3. <id>1111222233334444</id>
  4. </campaign>
  5. <fees>
  6. <fee>
  7. <id>463</id>
  8. <interval>1</interval>
  9. <interval_type>years</interval_type>
  10. <amount>10</amount>
  11. <description>Yearly account fee</description>
  12. </fee>
  13. ...
  14. </fees>
  15. </response>

Notes:

  • When identifying a depreciation entry to another API call, you use the <id> that is returned in the XML construct such as the one above.
  • The amount is either the amount of points or money to be deducted, depending on the campaign type.

 

Error XML Response:

  1. <response status="error">
  2. <error>Error message</error>
  3. </response>