Description
The Promotion object contains information about a promotion that can be applied to an Order
ℹ️ Note
This object supports custom data via the data attribute.
Attributes
| Attribute | Type | Description |
|---|---|---|
actions |
List[PromotionAction] | Returns a list of PromotionAction objects associated with this Promotion |
campaign |
Campaign | Returns the Campaign object associated with this Promotion |
code |
String | Returns the code that can be used to apply this Promotion |
expires_at |
Timestamp | Returns the timestamp when this Promotion ends |
id |
String | Returns the unique id for this Promotion |
name |
String | Returns the name of this Promotion |
scopes |
List[PromotionScope] | Returns a list of PromotionScope objects associated with this Promotion |
starts_at |
Timestamp | Returns the timestamp when this Promotion starts |
usage_count |
Number | Returns the number of times this Promotion has been used |
usage_limit |
Number | Returns the maximum number of times this Promotion can be used |
valid? |
Boolean | Returns whether this Promotion is active (within the start and expiry dates and not over the usage limit) |