Hooks API

Type

Coupon1

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

  • type string required

    Coupon type, normally discount_code.

  • code string optional

    Customer-visible coupon code, when one exists.

  • code_id string optional

    Stable coupon ID assigned by the external system.

  • extras JSON object optional

    Additional stable string metadata needed to identify the coupon.

  • redemption_status RedemptionStatus1 optional

    Current coupon redemption status.

  • use_count integer optional

    Known number of coupon uses.

  • creation_time time optional

    Time when the external system created the coupon.

  • expiration_time time optional

    Time when the coupon expires.

Previous
SendEvent1