General
Core API
Customer Portal API
Integrations
benefit_grant.updated
Sent when a benefit grant is updated.
Discord & Slack support: Basic
"benefit_grant.updated"- BenefitGrantDiscordWebhook
- BenefitGrantCustomWebhook
- BenefitGrantGitHubRepositoryWebhook
- BenefitGrantDownloadablesWebhook
- BenefitGrantLicenseKeysWebhook
- BenefitGrantMeterCreditWebhook
Show child attributes
Show child attributes
Creation timestamp of the object.
Last modification timestamp of the object.
The ID of the grant.
Whether the benefit is granted.
Whether the benefit is revoked.
The ID of the subscription that granted this benefit.
The ID of the order that granted this benefit.
The ID of the customer concerned by this grant.
The ID of the benefit concerned by this grant.
A customer in an organization.
Show child attributes
Show child attributes
The ID of the customer.
Creation timestamp of the object.
Last modification timestamp of the object.
The ID of the customer in your system. This must be unique within the organization. Once set, it can't be updated.
"usr_1337"
The email address of the customer. This must be unique within the organization.
Whether the customer email address is verified. The address is automatically verified when the customer accesses the customer portal using their email address.
The name of the customer.
"John Doe"
Show child attributes
Show child attributes
AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZW 2 elements["911144442", "us_ein"]The ID of the organization owning the customer.
Timestamp for when the customer was soft deleted.
A benefit of type discord.
Use it to automatically invite your backers to a Discord server.
Show child attributes
Show child attributes
The ID of the benefit.
Creation timestamp of the object.
Last modification timestamp of the object.
"discord"The description of the benefit.
Whether the benefit is selectable when creating a product.
Whether the benefit is deletable.
The ID of the organization owning the benefit.
Properties for a benefit of type discord.
Show child attributes
Show child attributes
The ID of the Discord server.
The ID of the Discord role to grant.
Whether to kick the member from the Discord server on revocation.
The timestamp when the benefit was granted. If None, the benefit is not granted.
The timestamp when the benefit was revoked. If None, the benefit is not revoked.
Was this page helpful?
{
"type": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"data": {
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z",
"id": "<string>",
"is_granted": true,
"is_revoked": true,
"subscription_id": "<string>",
"order_id": "<string>",
"customer_id": "<string>",
"benefit_id": "<string>",
"customer": {
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z",
"metadata": {},
"external_id": "usr_1337",
"email": "<string>",
"email_verified": true,
"name": "John Doe",
"billing_address": {
"country": "AD",
"line1": "<string>",
"line2": "<string>",
"postal_code": "<string>",
"city": "<string>",
"state": "<string>"
},
"tax_id": [
"911144442",
"us_ein"
],
"organization_id": "<string>",
"deleted_at": "2023-11-07T05:31:56Z",
"avatar_url": "<string>"
},
"benefit": {
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z",
"type": "<string>",
"description": "<string>",
"selectable": true,
"deletable": true,
"organization_id": "<string>",
"metadata": {},
"properties": {
"guild_id": "<string>",
"role_id": "<string>",
"kick_member": true,
"guild_token": "<string>"
}
},
"properties": {
"account_id": "<string>",
"guild_id": "<string>",
"role_id": "<string>",
"granted_account_id": "<string>"
},
"granted_at": "2023-11-07T05:31:56Z",
"revoked_at": "2023-11-07T05:31:56Z",
"error": {
"message": "<string>",
"type": "<string>",
"timestamp": "<string>"
},
"previous_properties": {
"account_id": "<string>",
"guild_id": "<string>",
"role_id": "<string>",
"granted_account_id": "<string>"
}
}
}