Interface: Tier
Defined in: schemas/v2/resources/tier.ts:4
A membership level on a campaign, which can have benefits attached to it.
Properties
amount_cents
amount_cents:
number
Defined in: schemas/v2/resources/tier.ts:8
Monetary amount associated with this tier (in U.S. cents)
created_at
created_at:
string
Defined in: schemas/v2/resources/tier.ts:14
Datetime this tier was created
Format
date-time
description
description:
string
Defined in: schemas/v2/resources/tier.ts:19
Tier display description
discord_role_ids
discord_role_ids:
null
|string
[]
Defined in: schemas/v2/resources/tier.ts:24
The discord role IDs granted by this tier
edited_at
edited_at:
string
Defined in: schemas/v2/resources/tier.ts:30
Datetime tier was last modified
Format
date-time
image_url
image_url:
null
|string
Defined in: schemas/v2/resources/tier.ts:36
Full qualified image URL associated with this tier
Format
uri
patron_count
patron_count:
number
Defined in: schemas/v2/resources/tier.ts:41
Number of patrons currently registered for this tier
post_count
post_count:
number
Defined in: schemas/v2/resources/tier.ts:46
Number of posts published to this tier
published
published:
boolean
Defined in: schemas/v2/resources/tier.ts:51
Whether the tier is currently published
published_at
published_at:
null
|string
Defined in: schemas/v2/resources/tier.ts:57
Datetime this tier was last published
Format
date-time
remaining
remaining:
null
|number
Defined in: schemas/v2/resources/tier.ts:62
Remaining number of patrons who may subscribe, if there is a Tier.user_limit
requires_shipping
requires_shipping:
boolean
Defined in: schemas/v2/resources/tier.ts:67
Whether this tier requires a shipping address from patrons
title
title:
string
Defined in: schemas/v2/resources/tier.ts:72
Tier display title
unpublished_at
unpublished_at:
null
|string
Defined in: schemas/v2/resources/tier.ts:78
Datetime tier was unpublished, while applicable
Format
date-time
url
url:
string
Defined in: schemas/v2/resources/tier.ts:84
Fully qualified URL associated with this tier
Format
uri
user_limit
user_limit:
null
|number
Defined in: schemas/v2/resources/tier.ts:89
Maximum number of patrons this tier is limited to, if applicable