Object Index / Definition

You are viewing an old version of the API
Create​Order​Request​Discount

Deprecated

Please use the OrderLineItemDiscount type in the order field of CreateOrderRequest instead

Represents a discount that can apply to either a single line item or an entire order.

Properties

Name Description
amount_money
Money

Only used for ad hoc discounts. The monetary amount of the discount.

catalog_object_id
string

Only used for catalog discounts. The catalog object ID for an existing CatalogDiscount.

Do not provide a value for this field if you provide values in other fields for an ad hoc discount.

Max Length 192
name
string

Only used for ad hoc discounts. The discount's name.

Max Length 255
percentage
string

Only used for ad hoc discounts. The percentage of the discount, as a string representation of a decimal number.

A value of 7.25 corresponds to a percentage of 7.25%. This value range between 0.0 up to 100.0

Max Length 10

Share Feedback

Thanks for visiting the Square API documentation. What's on your mind?