patreon-api.ts

Appearance

Interface: PledgeEvent ​

Defined in: schemas/v2/resources/pledge_event.ts:4

The record of a pledging action taken by the user, or that action's failure.

Properties ​

amount_cents ​

amount_cents: number

Defined in: schemas/v2/resources/pledge_event.ts:9

Amount (in the currency in which the patron paid) of the underlying event

Example ​

ts
500

currency_code ​

currency_code: string

Defined in: schemas/v2/resources/pledge_event.ts:14

ISO code of the currency of the event

date ​

date: string

Defined in: schemas/v2/resources/pledge_event.ts:20

The date which this event occurred

Format ​

date-time

payment_status ​

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

Defined in: schemas/v2/resources/pledge_event.ts:36

Status of underlying payment

pledge_payment_status ​

pledge_payment_status: "queued" | "pending" | "valid" | "declined" | "fraud" | "disabled"

Defined in: schemas/v2/resources/pledge_event.ts:25

The payment status of the pledge

tier_id ​

tier_id: null | string

Defined in: schemas/v2/resources/pledge_event.ts:51

Id of the tier associated with the pledge

tier_title ​

tier_title: null | string

Defined in: schemas/v2/resources/pledge_event.ts:56

Title of the reward tier associated with the pledge

type ​

type: "pledge_start" | "pledge_upgrade" | "pledge_downgrade" | "pledge_delete" | "subscription"

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

Event type.