Members

Member objects allow you to keep your member's data in a single place, track memberships, invoices, charges, fees, and etc. Everything that is associated with the same customer.

The API allows you to create, delete, and update your members. You can retrieve individual members as well as a list of all your members.

Here is the list of all properties the member object has:

Member

PropertyTypeRequiredDescription
namestringtrueThe full name of the member
emailstringtrueThe email address of the member
phonestringfalseThe primary phone number of the member
twitterHandlestringfalseThe twitter handle of the member
teamidfalseReference to the team the member belongs to
contactPersonbooleanfalseTrue if the member is a contact person in his company
billingPersonbooleanfalseTrue if the member is the billing person of his company and receives all the invoices
officeidfalseReference to the location the member belongs to. It will default to the only location if left empty
paymentDetailsarrayreadonlyArray containing all the names of the payment details added to the member account
createdAtdatereadonlyThe date when the member has been created at.
createdByidreadonlyThe user that created the member.
modifiedAtdatereadonlyThe date when the member has been modified for the last time. Before the first modification, this field equals to the createdAt field.
modifiedByidreadonlyThe user that did the last modification to the member. Before the first modification, this field equals to the createdBy field.
statusenumfalseThe member status. It could be active, contact or former
calculatedStatusenumreadonlyThe actual member status calculated by the platform. Please, refer to this article for more information