Follow

MembershipLevels API call

You can use the MembershipLevels API call to retrieve details about all your membership levels, or just one membership level in particular.

Wild Apricot's API is intended for use by developers with technical expertise. If you need assistance, we provide support via email or through our Developers forum.

Retrieving details for all membership levels

Syntax
GET [baseAPIaddress]/v2/Accounts/[accountID]/MembershipLevels
Example
GET https://api.wildapricot.org/v2/Accounts/58293/MembershipLevels

Retrieving details for a particular membership level

Syntax
GET [baseAPIaddress]/v2/Accounts/[accountID]/MembershipLevels/[levelID]
Example
GET https://api.wildapricot.org/v2/Accounts/58293/MembershipLevels/257271
Each API call must include an authentication information that verifies your account and prevents others from accessing your data. For more information, see API access options.

Parameters

The following parameters are used within the MembershipLevels API call:

baseAPIaddress
The base address of the API. For more information, see API access options.

accountID
The account identifier that is returned by the Accounts API call.

levelID
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.

Response fields

The MembershipLevels API call retrieves the following information about your membership levels.

AdminApprovalRequired
Indicates whether administrator approval is required before a new membership is activated. Possible values are true and false.

ApplicationReview
Contains fields that correspond to options that appear on the New applications tab on the Membership level detail screen.

AutomaticRecurringPayments
Indicates whether automatic recurring payments have been enabled for this level. Possible values are true and false.

BundleMembersLimit
For bundle membership levels, this indicates the bundle member limit. For individual membership levels, the value is 0.

Description
The description of the level as it appears on the General tab of the Membership level detail screen.

Id
The identifier for the membership level.

MemberCanChangeToLevels
Lists the membership levels that members on this level can change to.

MembershipFee
The membership fee for this level.

Name
The level name as it appears on the General tab of the Membership level detail screen.

PrepayRequired
Indicates whether payment must be received before a new membership is activated. Possible values are true and false.

PublicCanApply
Indicates whether the Public can apply option has been enabled for this level. Possible values are true and false.

RenewalPeriod
Contains fields that correspond to options that appear on the Renewal policy tab on the Membership level detail screen.

  • Kind
    Indicates the renewal period for the membership level. Possibles values are Never, Monthly, TwiceAYear, Quarterly, and EveryNYears.
  • StartFromJoinDate
    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.
  • Dates
    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.
  • YearPeriod
    For renewal periods of every x number of years, YearPeriod indicates the number of years between renewals.

Type
Indicates whether the membership level is an individual level or a bundle level. Possible values are Individual and Bundle.

Url
The address of the API call for this membership level.

Sample JSON response

[
{
"Id": 29877,
"Url": "http://api.wildapricot.org/v2/accounts/42353/MembershipLevels/29877",
"Name": "Bronze",
"Description": "",
"PublicCanApply": true,
"Type": "Individual",
"MembershipFee": 10,
"RenewalPeriod": {
"Kind": "EveryNYears",
"StartFromJoinDate": true,
"YearPeriod": 1
},
"AutomaticRecurringPayments": false,
"ApplicationReview": {
"AdminApprovalRequired": true,
"PrepayRequired": true
}
},
{
"Id": 29878,
"Url": "http://api.wildapricot.org/v2/accounts/42353/MembershipLevels/29878",
"Name": "Silver",
"Description": "",
"PublicCanApply": true,
"Type": "Individual",
"MembershipFee": 15,
"RenewalPeriod": {
"Kind": "EveryNYears",
"StartFromJoinDate": true,
"YearPeriod": 1
},
"AutomaticRecurringPayments": false,
"ApplicationReview": {
"AdminApprovalRequired": true,
"PrepayRequired": true
}
},
{
"Id": 29879,
"Url": "http://api.wildapricot.org/v2/accounts/42353/MembershipLevels/29879",
"Name": "Platinum",
"Description": "",
"PublicCanApply": true,
"Type": "Individual",
"MembershipFee": 25,
"RenewalPeriod": {
"Kind": "EveryNYears",
"StartFromJoinDate": true,
"YearPeriod": 1
},
"AutomaticRecurringPayments": false,
"ApplicationReview": {
"AdminApprovalRequired": true,
"PrepayRequired": true
}
},
{
"Id": 29880,
"Url": "http://api.wildapricot.org/v2/accounts/42353/MembershipLevels/29880",
"Name": "Gold",
"Description": "",
"PublicCanApply": true,
"Type": "Individual",
"MembershipFee": 20,
"RenewalPeriod": {
"Kind": "EveryNYears",
"StartFromJoinDate": true,
"YearPeriod": 1
},
"AutomaticRecurringPayments": false,
"ApplicationReview": {
"AdminApprovalRequired": true,
"PrepayRequired": true
}
},
{
"Id": 29881,
"Url": "http://api.wildapricot.org/v2/accounts/42353/MembershipLevels/29881",
"Name": "Corporate",
"Description": "",
"PublicCanApply": false,
"Type": "Bundle",
"MembershipFee": 100,
"BundleMembersLimit": 25,
"RenewalPeriod": {
"Kind": "Never"
},
"AutomaticRecurringPayments": false,
"ApplicationReview": {
"AdminApprovalRequired": true,
"PrepayRequired": true
}
}
]

Sample XML response

<ArrayOfMembershipLevel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://api.wildapricot.org">
<MembershipLevel>
<ApplicationReview>
<AdminApprovalRequired>true</AdminApprovalRequired>
<PrepayRequired>true</PrepayRequired>
</ApplicationReview>
<AutomaticRecurringPayments>false</AutomaticRecurringPayments>
<BundleMembersLimit i:nil="true" />
<Description>
</Description>
<Id>29877</Id>
<MemberCanChangeToLevels i:nil="true" />
<MembershipFee>10.0000</MembershipFee>
<Name>Bronze</Name>
<PublicCanApply>true</PublicCanApply>
<RenewalPeriod>
<Dates i:nil="true" />
<Kind>EveryNYears</Kind>
<StartFromJoinDate>true</StartFromJoinDate>
<YearPeriod>1</YearPeriod>
</RenewalPeriod>
<Type>Individual</Type>
<Url>http://api.wildapricot.org/v2/accounts/42353/MembershipLevels/29877</Url>
</MembershipLevel>
<MembershipLevel>
<ApplicationReview>
<AdminApprovalRequired>true</AdminApprovalRequired>
<PrepayRequired>true</PrepayRequired>
</ApplicationReview>
<AutomaticRecurringPayments>false</AutomaticRecurringPayments>
<BundleMembersLimit i:nil="true" />
<Description>
</Description>
<Id>29878</Id>
<MemberCanChangeToLevels i:nil="true" />
<MembershipFee>15.0000</MembershipFee>
<Name>Silver</Name>
<PublicCanApply>true</PublicCanApply>
<RenewalPeriod>
<Dates i:nil="true" />
<Kind>EveryNYears</Kind>
<StartFromJoinDate>true</StartFromJoinDate>
<YearPeriod>1</YearPeriod>
</RenewalPeriod>
<Type>Individual</Type>
<Url>http://api.wildapricot.org/v2/accounts/42353/MembershipLevels/29878</Url>
</MembershipLevel>
<MembershipLevel>
<ApplicationReview>
<AdminApprovalRequired>true</AdminApprovalRequired>
<PrepayRequired>true</PrepayRequired>
</ApplicationReview>
<AutomaticRecurringPayments>false</AutomaticRecurringPayments>
<BundleMembersLimit i:nil="true" />
<Description>
</Description>
<Id>29879</Id>
<MemberCanChangeToLevels i:nil="true" />
<MembershipFee>25.0000</MembershipFee>
<Name>Platinum</Name>
<PublicCanApply>true</PublicCanApply>
<RenewalPeriod>
<Dates i:nil="true" />
<Kind>EveryNYears</Kind>
<StartFromJoinDate>true</StartFromJoinDate>
<YearPeriod>1</YearPeriod>
</RenewalPeriod>
<Type>Individual</Type>
<Url>http://api.wildapricot.org/v2/accounts/42353/MembershipLevels/29879</Url>
</MembershipLevel>
<MembershipLevel>
<ApplicationReview>
<AdminApprovalRequired>true</AdminApprovalRequired>
<PrepayRequired>true</PrepayRequired>
</ApplicationReview>
<AutomaticRecurringPayments>false</AutomaticRecurringPayments>
<BundleMembersLimit i:nil="true" />
<Description>
</Description>
<Id>29880</Id>
<MemberCanChangeToLevels i:nil="true" />
<MembershipFee>20.0000</MembershipFee>
<Name>Gold</Name>
<PublicCanApply>true</PublicCanApply>
<RenewalPeriod>
<Dates i:nil="true" />
<Kind>EveryNYears</Kind>
<StartFromJoinDate>true</StartFromJoinDate>
<YearPeriod>1</YearPeriod>
</RenewalPeriod>
<Type>Individual</Type>
<Url>http://api.wildapricot.org/v2/accounts/42353/MembershipLevels/29880</Url>
</MembershipLevel>
<MembershipLevel>
<ApplicationReview>
<AdminApprovalRequired>true</AdminApprovalRequired>
<PrepayRequired>true</PrepayRequired>
</ApplicationReview>
<AutomaticRecurringPayments>false</AutomaticRecurringPayments>
<BundleMembersLimit>25</BundleMembersLimit>
<Description>
</Description>
<Id>29881</Id>
<MemberCanChangeToLevels i:nil="true" />
<MembershipFee>100.0000</MembershipFee>
<Name>Corporate</Name>
<PublicCanApply>false</PublicCanApply>
<RenewalPeriod>
<Dates i:nil="true" />
<Kind>Never</Kind>
<StartFromJoinDate i:nil="true" />
<YearPeriod i:nil="true" />
</RenewalPeriod>
<Type>Bundle</Type>
<Url>http://api.wildapricot.org/v2/accounts/42353/MembershipLevels/29881</Url>
</MembershipLevel>
</ArrayOfMembershipLevel>

0 Comments

Please sign in to leave a comment.

Search: WildApricot.com 

About results ( seconds) Sort by: 
Sorry, an error occured when performing search.