Interface: Member
Defined in: schemas/v2/resources/member.ts:5
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 | 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 | The member's email address. Requires the campaigns.members[email] scope |
full_name | string | Full name of the member user Example John Doe |
is_follower | boolean | 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 | The user is in a free trial period. |
is_gifted | boolean | The user's membership is from a free gift |
last_charge_date | null | string | Datetime of last attempted charge. null if never charged |
last_charge_status | null | "Paid" | "Declined" | "Deleted" | "Pending" | "Refunded" | "Refunded by Patreon" | "Partially Refunded" | "Fraud" | "Free Trial" | "Other" | The result of the last attempted charge. The only successful status is 'Paid'. null if never charged Note: this will likely be either 'Paid' or 'Pending' |
lifetime_support_cents | number | 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 | null | string | Datetime of next charge. null if annual pledge downgrade |
note | string | The creator's notes on the member |
patron_status | null | "active_patron" | "declined_patron" | "former_patron" | A null value indicates the member has never pledged |
pledge_cadence | null | number | Number of months between charges Note: this will be 1 if Campaign.is_monthly is true Example 1 |
pledge_relationship_start | null | string | Datetime of beginning of most recent pledge chainfrom 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 |