Interface: Member
Defined in: schemas/v2/resources/member.ts:7
The record of a user's membership to a campaign. Remains consistent across months of pledging.
Properties
| Property | Type | Description |
|---|---|---|
campaign_lifetime_support_cents | number | null | The total amount that the member has ever paid to the campaign in the campaign's currency. 0 if never paid |
currently_entitled_amount_cents | number | The amount in cents that the member is entitled to. This includes a current pledge, or payment that covers the current payment period |
email | string | null | The member's email address. Requires the campaigns.members[email] scope. Members may restrict the sharing of their email address. |
full_name | string | null | Full name of the member user. Can be empty if the user has opted to hide their identity for this membership. Example John Doe |
is_follower | boolean | null | The user is not a pledging patron but has subscribed to updates about public posts. This will always be false, following has been replaced by free membership. Deprecated |
is_free_trial | boolean | null | The user is in a free trial period. |
is_gifted | boolean | The user's membership is from a free gift |
last_charge_date | string | null | Datetime of last attempted charge. null if never charged |
last_charge_status | string | null | Note: The result of the last attempted charge. The only successful status is 'Paid'. |
lifetime_support_cents | number | null | The total amount that the member has ever paid to the campaign in the campaign's currency. 0 if never paid. Use campaign_lifetime_support_cents. Deprecated |
next_charge_date | string | null | Datetime of next charge. null if annual pledge downgrade |
note | string | The creator's notes on the member |
patron_status | string | null | Note: A null value indicates the member has never pledged |
pledge_cadence | string | null | Number of months between charges Note: this will be 1 if Campaign.is_monthly is true Note: this used to be documented as an integer. Example '1' |
pledge_relationship_start | string | null | Datetime of beginning of most recent pledge chain from this member to the campaign. Pledge updates do not change this value |
will_pay_amount_cents | number | The amount in cents the user will pay at the next pay cycle Example 500 |