Skip to main content
Promotions is enabled per organizationPromotions works only after Yuno enables it for your organization: the Promotions section of the Dashboard and the quote your payments use. Ask your Technical Account Manager or Key Account Manager. See Promotions.

Attributes

A promotion is a discount with a date window and a set of conditions. You create, view and disable promotions in the Yuno Dashboard. You can also create, retrieve, list and disable code promotions with the API: Create Promotion, Retrieve Promotion, List Promotions and Disable Promotion. This page describes the attributes. A promotion can’t be edited after you create it: the only change is to disable it.
string
The unique identifier of the promotion (UUID). Assigned by Yuno.Example: b7c1a4f2-6e0d-4a3b-9c55-1f2e7d8a0b31
string
The account the promotion applies to (UUID). One promotion belongs to one account. If you run the same campaign on several accounts, create it once per account.Example: 493e9374-510a-4201-9e09-de669d75f256
string
The promotion name (1 to 255 characters). The checkout shows it as the title of the discount in the order summary.Example: 10% off with credit cards - Mother’s Day
string
Shown with the name on the quote. Optional, up to 1000 characters. null when you don’t set one.
object
The window in which the promotion runs. Always UTC.
object
How the promotion is redeemed.
object
What the customer saves.
object
The conditions a payment must meet. AND across keys, OR inside each key’s values list. Omit a key or send null for no condition on that dimension; an empty values list is rejected. An empty conditions object ({}) applies to every payment of the account. A CODE promotion applies to the whole payment, whatever the payment method, so the API accepts countries and amounts only: a bins, payment_methods or card_types condition on a code is rejected with 400 INVALID_REQUEST and the message conditions.bins: FORBIDDEN, conditions.payment_methods: FORBIDDEN or conditions.card_types: FORBIDDEN.
object
The cap on the uses of a code. null when the promotion has no cap, and always null for an AUTOMATIC promotion: only a CODE promotion can hold a cap.
enum
Computed from schedule and from the disable at the moment you read the promotion.Possible values:
  • SCHEDULED = starts_at is in the future.
  • ACTIVE = Running now. Payments that meet the conditions get a quote.
  • EXPIRED = ends_at has passed.
  • DISABLED = You disabled it. Final.
timestamp
When the promotion was created (ISO 8601, UTC). When two promotions save the same amount, the oldest one applies.
timestamp
When you disabled the promotion (ISO 8601, UTC). null while the promotion is not disabled. The only field that changes after creation.

Limits

A promotion holds up to 500 BIN prefixes, 100 BIN ranges, 20 payment method types, 10 card types and 250 countries, and up to 50 currencies in the amount condition and in a fixed discount. Money amounts use the whole minor units of their currency.

How a promotion is chosen

One payment gets one promotion. When two or more match, Yuno applies the one with the biggest saving for the customer, then the oldest, then the smallest id. When a payment carries a code, the promotion of the code competes in the same selection, and it has no advantage. See Promotion codes. A fixed discount is capped at the payment amount, but a promotion never makes a charge of zero: a quote whose charge would be zero answers 204, and a quote request or a payment that carries a code and would charge zero is refused with 422 PROMOTION_NOT_APPLICABLE and the reason ZERO_CHARGE. A promotion whose discount is zero doesn’t apply.

Examples

An AUTOMATIC promotion:
A CODE promotion with a cap: