Back to Developer Center

API v1 Reference

Memberships

A membership is a transaction type in NeonCRM that gives an account the status of holding a membership.

Membership Levels and Terms

Memberships are sorted into different Levels. Each level can have one or many terms. A membership term generally will have:

  • Name
  • Start date
  • End date
  • JOIN or RENEW designation
  • Cost

Membership terms are configured in the NeonCRM system settings. A list of terms can be retrieved through the API using the List Membership Terms method.

Members

Memberships can be assigned to both individual and organization accounts using the Add Membership to Account method.

To determine which membership(s) an account has, use the List Membership History method. This provides a complete list of all membership terms associated with an account, past, present, and future.

To query the database for accounts with a particular membership, use the List Members method.

Related Data Types

Memberships are related to and dependent on several other data types in NeonCRM, as demonstrated in this diagram:

membership-relationships

Data Structure

When created through the API, a membership typically has the following fields:

Name Format Required Description
Account ID Integer Yes The account ID to which this membership is being added.
Term ID Integer Yes Possible values can be retrieved from List Membership Terms method.
Term Name String Possible values can be retrieved from List Membership Terms method.
Auto Renewal Boolean Should this membership term automatically renew? Possible values: true, false
Source ID Integer Possible values can be retrieved from List Sources method.
Source Name String Possible values can be retrieved from List Sources method.
Send Acknowledgement Email Boolean Determines whether this operation triggers the default system email. Value must be TRUE or FALSE. FALSE is the default value if the parameter is not provided.
Membership Custom Fields Membership custom fields can be populated. Possible values can be retrieved from List Custom Fields method. Multiple custom fields may be present.
Payment Fields If the membership term costs money, relevant payment fields must be included in the request. Further details can be found in the Add Membership to Account method.