Skip to main content
When a promotion is applied to a subscription, Yuno stores a copy of it on the subscription. The copy is the promotion object. Create Subscription and Update Subscription return it. The copy is never edited: changing the plan’s attachment or the promotion afterwards does not change it. See Promotions on subscription plans.

Attributes

string
The ID of the promotion (UUID).Example: 8f2d6c1e-3b7a-4c55-9a1e-2f4d8b7c6a10
string
The name of the promotion.Example: Welcome 20% x3
object
The discount. The fields depend on type.
object
The number of charges the discount covers.
enum
What a pause does to the promotion: KEEP (its remaining cycles continue on resume) or END (the promotion ends with the reason PAUSE). It is copied from the plan’s attachment when the promotion is applied.
enum
ACTIVE, while cycles remain. COMPLETED, when all cycles are used. ENDED, when the promotion ends early.
timestamp
When the promotion was applied (ISO 8601).Example: 2026-11-02T14:00:00Z
timestamp
When the promotion ended. null while it is active.
enum
null while the promotion is active. Otherwise one of: REPLACED (another promotion was applied), REMOVED (removed from the subscription), PLAN_CHANGE (the plan changed and the promotion ended), PAUSE (the subscription was paused and on_pause is END), or CANCELED (the subscription was canceled).

Example

A subscription with a percentage promotion, 2 of 3 cycles used:
Promotion object
A fixed-amount promotion:
Fixed discount

In webhooks

subscription.cycle_executed carries a shorter promotion object on each discounted cycle, with id, discount_amount and cycles_remaining.