benefit_grant.updated

Sent when a new benefit grant is updated.

Discord & Slack support: Basic

type

string

required

Allowed value: "benefit_grant.updated"

Example:

"benefit_grant.updated"

data

object

required

data.created_at

string

required

Creation timestamp of the object.

data.modified_at

string | null

required

Last modification timestamp of the object.

data.id

string

required

The ID of the grant.

data.is_granted

boolean

required

Whether the benefit is granted.

data.is_revoked

boolean

required

Whether the benefit is revoked.

data.subscription_id

string | null

required

The ID of the subscription that granted this benefit.

data.order_id

string | null

required

The ID of the order that granted this benefit.

data.customer_id

string

required

The ID of the customer concerned by this grant.

data.user_id

string

required

deprecated

data.benefit_id

string

required

The ID of the benefit concerned by this grant.

data.customer

object

required

A customer in an organization.

data.customer.id

string

required

The ID of the customer.

Example:

"992fae2a-2a17-4b7a-8d9e-e287cf90131b"

data.customer.created_at

string

required

Creation timestamp of the object.

data.customer.modified_at

string | null

required

Last modification timestamp of the object.

data.customer.metadata

object

required

data.customer.external_id

string | null

required

The ID of the customer in your system. This must be unique within the organization. Once set, it can't be updated.

Example:

"usr_1337"

data.customer.email

string

required

The email address of the customer. This must be unique within the organization.

Example:

"customer@example.com"

data.customer.email_verified

boolean

required

Whether the customer email address is verified. The address is automatically verified when the customer accesses the customer portal using their email address.

Example:

true

data.customer.name

string | null

required

The name of the customer.

Example:

"John Doe"

data.customer.billing_address

object | null

required

data.customer.tax_id

any[] | null

required

Example:

["911144442", "us_ein"]

data.customer.organization_id

string

required

The ID of the organization owning the customer.

Example:

"1dbfc517-0bbf-4301-9ba8-555ca42b9737"

data.customer.deleted_at

string | null

required

Timestamp for when the customer was soft deleted.

data.customer.avatar_url

string

required

Example:

"https://www.gravatar.com/avatar/xxx?d=blank"

data.properties

object

required

data.benefit

object

required

A benefit of type custom.

Use it to grant any kind of benefit that doesn't fit in the other types.

data.granted_at

string | null

The timestamp when the benefit was granted. If None, the benefit is not granted.

data.revoked_at

string | null

The timestamp when the benefit was revoked. If None, the benefit is not revoked.

data.previous_properties

object | null

Was this page helpful?

benefit_grant.created

benefit_grant.revoked

{
  "type": "benefit_grant.updated",
  "data": {
    "created_at": "2023-11-07T05:31:56Z",
    "modified_at": "2023-11-07T05:31:56Z",
    "id": "<string>",
    "granted_at": "2023-11-07T05:31:56Z",
    "is_granted": true,
    "revoked_at": "2023-11-07T05:31:56Z",
    "is_revoked": true,
    "subscription_id": "<string>",
    "order_id": "<string>",
    "customer_id": "<string>",
    "user_id": "<string>",
    "benefit_id": "<string>",
    "customer": {
      "id": "992fae2a-2a17-4b7a-8d9e-e287cf90131b",
      "created_at": "2023-11-07T05:31:56Z",
      "modified_at": "2023-11-07T05:31:56Z",
      "metadata": {},
      "external_id": "usr_1337",
      "email": "customer@example.com",
      "email_verified": true,
      "name": "John Doe",
      "billing_address": {
        "line1": "<string>",
        "line2": "<string>",
        "postal_code": "<string>",
        "city": "<string>",
        "state": "<string>",
        "country": "US"
      },
      "tax_id": [
        "911144442",
        "us_ein"
      ],
      "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
      "deleted_at": "2023-11-07T05:31:56Z",
      "avatar_url": "https://www.gravatar.com/avatar/xxx?d=blank"
    },
    "properties": {
      "account_id": "<string>",
      "guild_id": "<string>",
      "role_id": "<string>"
    },
    "benefit": {
      "created_at": "2023-11-07T05:31:56Z",
      "modified_at": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "type": "<string>",
      "description": "<string>",
      "selectable": true,
      "deletable": true,
      "organization_id": "<string>",
      "properties": {
        "note": "<string>"
      },
      "is_tax_applicable": true
    },
    "previous_properties": {
      "account_id": "<string>",
      "guild_id": "<string>",
      "role_id": "<string>"
    }
  }
}

Core API

Customer Portal API

Webhook Events

OAuth 2.0 API

benefit_grant.updated