patreon-api.ts

Appearance

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 ​

campaign_lifetime_support_cents ​

campaign_lifetime_support_cents: number

Defined in: schemas/v2/resources/member.ts:10

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 ​

currently_entitled_amount_cents: number

Defined in: schemas/v2/resources/member.ts:16

The amount in cents that the member is entitled to. This includes a current pledge, or payment that covers the current payment period

email ​

email: string

Defined in: schemas/v2/resources/member.ts:22

The member's email address. Requires the campaigns.members[email] scope

full_name ​

full_name: string

Defined in: schemas/v2/resources/member.ts:28

Full name of the member user

Example ​

ts
John Doe

is_follower ​

is_follower: boolean

Defined in: schemas/v2/resources/member.ts:35

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 ​

is_free_trial: boolean

Defined in: schemas/v2/resources/member.ts:40

The user is in a free trial period.

is_gifted ​

is_gifted: boolean

Defined in: schemas/v2/resources/member.ts:45

The user's membership is from a free gift

last_charge_date ​

last_charge_date: null | string

Defined in: schemas/v2/resources/member.ts:52

Datetime of last attempted charge. null if never charged

Format ​

date-time

last_charge_status ​

last_charge_status: null | "Paid" | "Declined" | "Deleted" | "Pending" | "Refunded" | "Refunded by Patreon" | "Partially Refunded" | "Fraud" | "Free Trial" | "Other"

Defined in: schemas/v2/resources/member.ts:61

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 ​

lifetime_support_cents: number

Defined in: schemas/v2/resources/member.ts:81

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 ​

next_charge_date: null | string

Defined in: schemas/v2/resources/member.ts:88

Datetime of next charge. null if annual pledge downgrade

Format ​

date-time

note ​

note: string

Defined in: schemas/v2/resources/member.ts:93

The creator's notes on the member

patron_status ​

patron_status: null | "active_patron" | "declined_patron" | "former_patron"

Defined in: schemas/v2/resources/member.ts:98

A null value indicates the member has never pledged

pledge_cadence ​

pledge_cadence: null | number

Defined in: schemas/v2/resources/member.ts:110

Number of months between charges

Note: this will be 1 if Campaign.is_monthly is true

Example ​

ts
1

pledge_relationship_start ​

pledge_relationship_start: null | string

Defined in: schemas/v2/resources/member.ts:117

Datetime of beginning of most recent pledge chainfrom this member to the campaign. Pledge updates do not change this value

Format ​

date-time

will_pay_amount_cents ​

will_pay_amount_cents: number

Defined in: schemas/v2/resources/member.ts:123

The amount in cents the user will pay at the next pay cycle

Example ​

ts
500