Person - membership list

GET

/api/v2{person_uri}membership/all

Get the full membership history for a person, current and historic, use the /summary endpoint for a faster summary

Parameters

Path Parameters

person_uri

required

URIs are unique identifiers for resources in the system, they are structured as follows /bucket/resource_type/uid/

string

Example

/example/person/6305f074683e800f3abe809e/

Responses

200

Successful operation

object

contact_uri

string

count

The number of memberships for this contact

number

memberships

A list of member records for this contact

Array<object>

object

admin_contact

The URI of the contact that is the admin for this membership. Admin contacts can manage the membership and are the primary contact for membership communication.

string

advise_lapse

boolean

amount

number

auto_renew

boolean

billing_contact

The URI of the billing contact for this membership.

string

cancellation_date

string

created

string

currency

string

display_value

string

end_date

string

externally_managed

boolean

gc_subscription_id

gift_aid

boolean

has_renewed

boolean

lapse_reason

string

last_updated

string

linked_members

Array<string>

max_linked_members

number

member

The URI of the contact that is the primary member

string

membership_number

string

membership_plan_type

string

membership_record_status

string

membership_type

The URI of the membership plan for this membership

string

mute_communications

boolean

next_membership_type

The URI of the membership plan that this member should renew onto.

string

next_payment_plan

The URI of the payment plan that this member should use for payment when they renew.

string

paid

boolean

payment_date

payment_method

string

payment_plan

string

payment_reference

period

string

record_state

string

start_date

string

stripe_subscription_id

tags

Array<string>

tax

string

uid

string

uri

A membership uri will always be in the format /bucket/member/uid/ with the word ‘member’ in the middle

string

user_interface

object

can_create_member

boolean

can_delete_member

boolean

can_edit_member

boolean

can_restore_member

boolean

policy_name

string

xero_account_code