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