API DOCUMENTATION Last Update: Apr 2022

Membership Levels - List

Retrives the list of existing Membership Levels in a given Membership Program.

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

 

  field   Example   Note
API 1.5 Required
user_id john1970 Required
user_api_key 1959ca5645adac9b13dcb3 Required
account_id greatwidgets Required
type manage_membership_levels Required
action list Required
membership_program_id 8121227452706343 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

 

 

Example PHP Request:

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

  1. $data['API'] = '1.5';
  2. $data['user_id'] = 'john1970';
  3. $data['user_api_key'] = '1959caadac9b13dcb3';
  4. $data['type'] = 'manage_membership_levels';
  5. $data['action'] = 'info';
  6. $data['account_id'] = 'greatwidgets';
  7. $data['membership_program_id'] = '8121227452706343';

 

Success XML Response

  1. <response status="success">
  2. <membership_level>
  3. <membership_level_id>53</membership_level_id>
  4. <membership_program_id>8121227452706343</membership_program_id>
  5. <membership_level_qualifier>0</membership_level_qualifier>
  6. <membership_level_multiplier>1.0</membership_level_multiplier>
  7. <membership_level_description>Basic</membership_level_description>
  8. </membership_level>
  9. <membership_level>
  10. <membership_level_id>54</membership_level_id>
  11. <membership_program_id>8121227452706343</membership_program_id>
  12. <membership_level_qualifier>10000</membership_level_qualifier>
  13. <membership_level_multiplier>1.5</membership_level_multiplier>
  14. <membership_level_description>Silver</membership_level_description>
  15. </membership_level>
  16. <membership_level>
  17. <membership_level_id>55</membership_level_id>
  18. <membership_program_id>8121227452706343</membership_program_id>
  19. <membership_level_qualifier>50000</membership_level_qualifier>
  20. <membership_level_multiplier>2.0</membership_level_multiplier>
  21. <membership_level_description>Gold</membership_level_description>
  22. </membership_level>
  23. </response>

Error XML Response:

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