Home

Download this help site
(PDF 80MB)

Download

MembershipLevels API V1 call

Icon

Wild Apricot does not provide technical support for its API. If you encounter difficulties using it, add a post describing the issue to our Designers and Developers forum. Wild Apricot staff or other users may be able to suggest a solution.

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

Syntax

For all membership levels

Example:

For a particular membership level

Example:

Parameters

The following parameters are used within the MembershipLevels API call:

Variable

Description

{version}

The version number of the API. To retrieve a list of API versions, use the base API call.

{accountID}

The account identifier that appears on the Account and billing screen and is returned by the Accounts API V1 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.

{APIkey}

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.

Response fields

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

Field

Description

Id

The identifier for the membership level.

Url

The address of the API call for this membership level.

Name

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

Description

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

PublicCanApply

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

Type

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

MembershipFee

The membership fee for this level.

MemberCanChangeToLevels

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

BundleMembersLimit

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

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.

AutomaticRecurringPayments

Indicates whether automatic recurring payments have been enabled for this level. 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.

AdminApprovalRequired

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

PrepayRequired

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

Sample JSON response

Sample XML response

  • No labels
 
Wild Apricot Inc. 144 Front Street West Suite 725, Toronto, Ontario, Canada M5J 2L7