Feature Discount Schemes
A feature discount scheme applies promotional pricing to a feature, such as an introductory or loyalty discount. See the Feature Discount Schemes guide for how they are used.
Methods
Section titled “Methods”Retrieve Single Feature Discount Scheme
Section titled “Retrieve Single Feature Discount Scheme”/backend/api/v1/featureDiscountSchemes/ID - fetch the scheme with the specified ID.
List Feature Discount Schemes
Section titled “List Feature Discount Schemes”/backend/api/v1/featureDiscountSchemes/ - list all schemes.
Additional Query Parameters
Section titled “Additional Query Parameters”| Parameter | Type | Required | Description |
|---|---|---|---|
idAfter | integer | No | Only include schemes with a higher ID |
createdSince | datetime | No | Only include schemes created since the given time |
updatedSince | datetime | No | Only include schemes updated since the given time |
/backend/api/v1/featureDiscountSchemes/ - add a new scheme. The newly-added scheme will be returned.
/backend/api/v1/featureDiscountSchemes/ID - update the scheme with the specified ID. The modified scheme will be returned.
DELETE
Section titled “DELETE”/backend/api/v1/featureDiscountSchemes/ID - delete the scheme with the specified ID.
Fields
Section titled “Fields”| Field | Name | Type | Description |
|---|---|---|---|
| featureDiscountSchemeName | Scheme Name | Text | Full name of the discount scheme |
| featureDiscountSchemeShortName | Discount Scheme (Short) | Text | Abbreviated name for the discount scheme |
| featureDiscountSchemeDescription | Discount Scheme Description | Text | Detailed description of what the discount scheme provides |
| featureDiscountSchemeDisplayClass | Discount Scheme Display Class | Text | CSS class used for displaying this discount scheme in the interface |
| featureDiscountSchemeDisplayPosition | Discount Scheme Display Position | Number | Numerical order for displaying this scheme in lists and menus |
| availability | Discount Scheme Availability | Preset Value | Controls the availability of this discount scheme |
| currency | Currency | Preset Value | Limits the availabilty to customers using the specified currency |
| customerID | Customer | Text | The ID of the customer this discount scheme is restricted to |
| customerGroups | Customer Groups | Text | Array of customer group names that can use this discount scheme |
| oneOffChargeDiscountType | One Off Charge Discount Type | Preset Value | Name of the discount type applied to one-off charges |
| oneOffChargeDiscountAmount | One Off Charge Discount Amount | Number | Amount of discount for one-off charges |
| recurringChargeDiscountType | Recurring Charge Discount Type | Preset Value | Name of the discount type applied to recurring charges |
| recurringChargeDiscountAmount | Recurring Charge Discount Amount | Number | Amount of discount for recurring charges |
| initialLength | Initial Length | Text | Duration for which the discount scheme initially applies |
| initialLengthType | Initial Length Type | Preset Value | Name of the time unit for the initial length period |
| id | Feature Discount Scheme ID | Text | The unique identifier for this feature discount scheme |