Skip to main content

When this fires

After a Plan Grant is committed through the API or dashboard. The payload is the grant as it existed at creation, and its last timeline event is created. customer.state_changed also fires with trigger plan_access_granted.

Body

application/json
id
string
required
event
string
required
Allowed value: "plan_grant.created"
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.