|
| 1 | +# BenefitGrantCustomWebhook |
| 2 | + |
| 3 | + |
| 4 | +## Fields |
| 5 | + |
| 6 | +| Field | Type | Required | Description | |
| 7 | +| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | |
| 8 | +| `created_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | Creation timestamp of the object. | |
| 9 | +| `modified_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | Last modification timestamp of the object. | |
| 10 | +| `id` | *str* | :heavy_check_mark: | The ID of the grant. | |
| 11 | +| `granted_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | The timestamp when the benefit was granted. If `None`, the benefit is not granted. | |
| 12 | +| `is_granted` | *bool* | :heavy_check_mark: | Whether the benefit is granted. | |
| 13 | +| `revoked_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | The timestamp when the benefit was revoked. If `None`, the benefit is not revoked. | |
| 14 | +| `is_revoked` | *bool* | :heavy_check_mark: | Whether the benefit is revoked. | |
| 15 | +| `subscription_id` | *Nullable[str]* | :heavy_check_mark: | The ID of the subscription that granted this benefit. | |
| 16 | +| `order_id` | *Nullable[str]* | :heavy_check_mark: | The ID of the order that granted this benefit. | |
| 17 | +| `customer_id` | *str* | :heavy_check_mark: | The ID of the customer concerned by this grant. | |
| 18 | +| `benefit_id` | *str* | :heavy_check_mark: | The ID of the benefit concerned by this grant. | |
| 19 | +| `error` | [OptionalNullable[models.BenefitGrantError]](../models/benefitgranterror.md) | :heavy_minus_sign: | The error information if the benefit grant failed with an unrecoverable error. | |
| 20 | +| `customer` | [models.Customer](../models/customer.md) | :heavy_check_mark: | A customer in an organization. | |
| 21 | +| `benefit` | [models.BenefitCustom](../models/benefitcustom.md) | :heavy_check_mark: | A benefit of type `custom`.<br/><br/>Use it to grant any kind of benefit that doesn't fit in the other types. | |
| 22 | +| `properties` | [models.BenefitGrantCustomProperties](../models/benefitgrantcustomproperties.md) | :heavy_check_mark: | N/A | |
| 23 | +| `previous_properties` | [OptionalNullable[models.BenefitGrantCustomProperties]](../models/benefitgrantcustomproperties.md) | :heavy_minus_sign: | N/A | |
0 commit comments