BenefitGrant
March 27, 2026 ยท View on GitHub
Fields
| Field | Type | Required | Description |
|---|---|---|---|
created_at | date | :heavy_check_mark: | Creation timestamp of the object. |
modified_at | date | :heavy_check_mark: | Last modification timestamp of the object. |
id | str | :heavy_check_mark: | The ID of the grant. |
granted_at | date | :heavy_minus_sign: | The timestamp when the benefit was granted. If None, the benefit is not granted. |
is_granted | bool | :heavy_check_mark: | Whether the benefit is granted. |
revoked_at | date | :heavy_minus_sign: | The timestamp when the benefit was revoked. If None, the benefit is not revoked. |
is_revoked | bool | :heavy_check_mark: | Whether the benefit is revoked. |
subscription_id | Nullable[str] | :heavy_check_mark: | The ID of the subscription that granted this benefit. |
order_id | Nullable[str] | :heavy_check_mark: | The ID of the order that granted this benefit. |
customer_id | str | :heavy_check_mark: | The ID of the customer concerned by this grant. |
member_id | OptionalNullable[str] | :heavy_minus_sign: | The ID of the member concerned by this grant. |
benefit_id | str | :heavy_check_mark: | The ID of the benefit concerned by this grant. |
error | OptionalNullable[models.BenefitGrantError] | :heavy_minus_sign: | The error information if the benefit grant failed with an unrecoverable error. |
customer | models.Customer | :heavy_check_mark: | N/A |
member | OptionalNullable[models.Member] | :heavy_minus_sign: | N/A |
benefit | models.Benefit | :heavy_check_mark: | N/A |
properties | models.Properties | :heavy_check_mark: | N/A |