new MembershipLevelsAPI(rest)
This class is used to interact with Membership Levels in TidyHQ.
Parameters:
| Name | Type | Description |
|---|---|---|
rest | Rest | The rest instance to use for requests. |
- Source
Methods
(async) getMembershipLevel(membership_level_id, optionsopt) → {Promise.<TidyAPI_V1_MembershipLevel>}
Get a single membership level.
Parameters:
| Name | Type | Attributes | Default | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
membership_level_id | number | The ID of the membership level. | ||||||||||
options | object | <optional> | {} | Properties
|
- Source
Returns:
- The membership level.
- Type:
- Promise.<TidyAPI_V1_MembershipLevel>
(async) getMembershipLevels(optionsopt) → {Promise.<TidyAPI_V1_MembershipLevels>}
Get a list of all membership levels.
Parameters:
| Name | Type | Attributes | Default | Description | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options | object | <optional> | {} | Properties
|
- Source
Returns:
- The list of membership levels.
- Type:
- Promise.<TidyAPI_V1_MembershipLevels>
(async) getPricingVariations(membership_level_id, optionsopt) → {Promise.<TidyAPI_V1_PricingVariation>}
Get pricing variations for a membership level.
Parameters:
| Name | Type | Attributes | Default | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
membership_level_id | number | The ID of the membership level. | ||||||||||
options | object | <optional> | {} | Properties
|
- Source
Returns:
- The pricing variations for the membership level.
- Type:
- Promise.<TidyAPI_V1_PricingVariation>