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
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.ACTIVE, while cycles remain. COMPLETED, when all cycles are used. ENDED, when the promotion ends early.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
Fixed discount
In webhooks
subscription.cycle_executed carries a shorter promotion object on each discounted cycle, with id, discount_amount and cycles_remaining.