MembershipLevels API V1 call
You can use the MembershipLevels API call to retrieve details about all your membership levels, or just one membership level in particular.
For all membership levels
For a particular membership level
The following parameters are used within the MembershipLevels API call:
The version number of the API. To retrieve a list of API versions, use the base API call.
The ID of a membership level. You can retrieve a list of membership level IDs by calling the MembershipLevels API without specify a level ID.
String of characters used to authenticate your account and prevent others from accessing your data. You can get your API key by clicking the API key link from the Settings screen. The API key can be passed as a URL parameter or as a HTTP header field.
The MembershipLevels API call retrieves the following information about your membership levels.
The identifier for the membership level.
The address of the API call for this membership level.
The level name as it appears on the General tab of the Membership level detail screen.
The description of the level as it appears on the General tab of the Membership level detail screen.
Indicates whether the Public can apply option has been enabled for this level. Possible values are true and false.
Indicates whether the membership level is an individual level or a bundle level. Possible values are Individual and Bundle.
The membership fee for this level.
Lists the membership levels that members on this level can change to.
For bundle membership levels, this indicates the bundle member limit. For individual membership levels, the value is 0.
Contains fields that correspond to options that appear on the Renewal policy tab on the Membership level detail screen.
Indicates the renewal period for the membership level. Possibles values are Never, Monthly, TwiceAYear, Quarterly, and EveryNYears.
For renewal periods of every x number of years – where the value for Kind is EveryNYears – StartFromJoinDate indicates whether the Join date option was selected, so that renewal takes place on the join date. Possible values are true and false.
Where the value for Kind is EveryNYears and StartFromJoinDate equals false, values will appear in Month and Day fields to indicate the specified renewal date.
For renewal periods of every x number of years, YearPeriod indicates the number of years between renewals.
Indicates whether automatic recurring payments have been enabled for this level. Possible values are true and false.
Contains fields that correspond to options that appear on the New applications tab on the Membership level detail screen.
Indicates whether administrator approval is required before a new membership is activated. Possible values are true and false.
Indicates whether payment must be received before a new membership is activated. Possible values are true and false.