Hooks API
TypeCoupon1
External coupon record created while applying a subscription benefit.
Return this object only when the subscription operation created a distinct external coupon that Bubblehouse should track. Omit it when your platform applied the monetary benefit directly without creating a coupon. Bubblehouse assigns the Custom API integration identity and internal visibility itself; returned integration and internal fields are ignored.
| Kind | Type |
|---|---|
| Used in | ApplySubscriptionDiscount1 |
Properties
-
typestring requiredCoupon type, normally discount_code.
-
codestring optionalCustomer-visible coupon code, when one exists.
-
code_idstring optionalStable coupon ID assigned by the external system.
-
extrasJSON object optionalAdditional stable string metadata needed to identify the coupon.
-
Current coupon redemption status.
-
use_countinteger optionalKnown number of coupon uses.
-
Time when the external system created the coupon.
-
Time when the coupon expires.