patreon-api.ts

Appearance

Interface: Benefit ​

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

A benefit added to the campaign, which can be added to a tier to be delivered to the patron.

Properties ​

app_external_id ​

app_external_id: null | string

Defined in: schemas/v2/resources/benefit.ts:8

The third-party external ID this reward is associated with

app_meta ​

app_meta: null | object

Defined in: schemas/v2/resources/benefit.ts:13

Any metadata the third-party app included with this benefit on creation

benefit_type ​

benefit_type: null | string

Defined in: schemas/v2/resources/benefit.ts:18

Type of benefit, such as custom for creator-defined benefits

created_at ​

created_at: string

Defined in: schemas/v2/resources/benefit.ts:24

Datetime this benefit was created

Format ​

date-time

deliverables_due_today_count ​

deliverables_due_today_count: number

Defined in: schemas/v2/resources/benefit.ts:29

Number of deliverables for this benefit that are due today specifically

delivered_deliverables_count ​

delivered_deliverables_count: number

Defined in: schemas/v2/resources/benefit.ts:34

Number of deliverables for this benefit that have been marked complete

description ​

description: null | string

Defined in: schemas/v2/resources/benefit.ts:39

Display description

is_deleted ​

is_deleted: boolean

Defined in: schemas/v2/resources/benefit.ts:44

Whether this benefit has been deleted

is_ended ​

is_ended: boolean

Defined in: schemas/v2/resources/benefit.ts:49

Whether this benefit is no longer available to new patrons

is_published ​

is_published: boolean

Defined in: schemas/v2/resources/benefit.ts:54

Whether this benefit is ready to be fulfilled to patrons

next_deliverable_due_date ​

next_deliverable_due_date: null | string

Defined in: schemas/v2/resources/benefit.ts:60

The next due date (after EOD today) for this benefit

Format ​

date-time

not_delivered_deliverables_count ​

not_delivered_deliverables_count: number

Defined in: schemas/v2/resources/benefit.ts:65

Number of deliverables for this benefit that are due, for all dates

rule_type ​

rule_type: null | string

Defined in: schemas/v2/resources/benefit.ts:70

A rule type designation, such as eom_monthly or one_time_immediate

tiers_count ​

tiers_count: number

Defined in: schemas/v2/resources/benefit.ts:75

Number of tiers containing this benefit

title ​

title: string

Defined in: schemas/v2/resources/benefit.ts:80

Display title