Home

Download this help site
(PDF 82MB)

Download

MembershipLevels API V2 call

Icon

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.

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

Retrieving details for all membership levels

Syntax

Example

Retrieving details for a particular membership level

Syntax

Example

Icon

Each API call must include an authentication information that verifies your account and prevents others from accessing your data. For more information, see Authenticating API access from a 3rd-party server or application or Authenticating API access from a Wild Apricot site page.

Parameters

The following parameters are used within the MembershipLevels API call:

Variable

Description

{baseAPIaddress}

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

{accountID}

The account identifier that appears on the Account and billing screen and 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.

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.

FieldDescription
KindIndicates the renewal period for the membership level. Possibles values are Never , Monthly , TwiceAYear , Quarterly , and EveryNYears .
StartFromJoinDateFor 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 .
DatesWhere the value for Kind is EveryNYears and StartFromJoinDate equals false , values will appear in Month and Day fields to indicate the specified renewal date.
YearPeriodFor 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.

FieldDescription
AdminApprovalRequiredIndicates whether administrator approval is required before a new membership is activated. Possible values are true and false .
PrepayRequiredIndicates whether payment must be received before a new membership is activated. Possible values are true and false .

Sample JSON response

Sample XML response

On this page:   

See also:

  • No labels