Skip to main content

When this fires

When an add-on activation completes — via POST /subscriptions/{id}/addons or a customer portal purchase. Any prorated activation charge has already succeeded; proratedPrice is the amount charged (zero when the remaining period was free). customer.state_changed fires alongside it with trigger addon_activated, reflecting the feature the add-on unlocked. Use it to enable the add-on’s feature in your app the moment it is paid.

Body

application/json
id
string
required
event
string
required
Allowed value: "addon.activated"
timestamp
string
required
organizationId
string
required
mode
enum<string>
required
Available options:
live,
sandbox
apiVersion
string
required
data
object
required

Response

200

Return any 2xx status code to acknowledge receipt of the event.