A comprehensive list of the order amount promotion rule resource's attributes and relationships
An order amount promotion rule object is returned as part of the response body of each successful list, retrieve, create or update API call to the /api/order_amount_promotion_rules endpoint.
Last updated
| Field | Type | Description |
|---|---|---|
type
string
order_amount_promotion_rules
id
string
The order amount promotion rule unique identifier
links.self
string
The order amount promotion rule endpoint URL
attributes.created_at
datetime
Time at which the resource was created.
attributes.updated_at
datetime
Time at which the resource was last updated.
attributes.reference
string
A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.
attributes.reference_origin
string
Any identifier of the third party system that defines the reference code.
attributes.metadata
object
Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.
attributes.order_amount_cents
integer
Apply the promotion only when order is over this amount, in cents.
attributes.order_amount_float
float
Apply the promotion only when order is over this amount, float.
attributes.formatted_order_amount
string
Apply the promotion only when order is over this amount, formatted.
attributes.use_subtotal
boolean
Send this attribute if you want to compare the specified amount with order's subtotal (excluding discounts, if any).
relationships.promotion
object
The associated promotion.
relationships.versions
array
The associated changes.
meta.mode
string
The resource environment (can be one of test or live)
