BenefitGrant

March 27, 2026 ยท View on GitHub

Fields

FieldTypeRequiredDescription
created_atdate:heavy_check_mark:Creation timestamp of the object.
modified_atdate:heavy_check_mark:Last modification timestamp of the object.
idstr:heavy_check_mark:The ID of the grant.
granted_atdate:heavy_minus_sign:The timestamp when the benefit was granted. If None, the benefit is not granted.
is_grantedbool:heavy_check_mark:Whether the benefit is granted.
revoked_atdate:heavy_minus_sign:The timestamp when the benefit was revoked. If None, the benefit is not revoked.
is_revokedbool:heavy_check_mark:Whether the benefit is revoked.
subscription_idNullable[str]:heavy_check_mark:The ID of the subscription that granted this benefit.
order_idNullable[str]:heavy_check_mark:The ID of the order that granted this benefit.
customer_idstr:heavy_check_mark:The ID of the customer concerned by this grant.
member_idOptionalNullable[str]:heavy_minus_sign:The ID of the member concerned by this grant.
benefit_idstr:heavy_check_mark:The ID of the benefit concerned by this grant.
errorOptionalNullable[models.BenefitGrantError]:heavy_minus_sign:The error information if the benefit grant failed with an unrecoverable error.
customermodels.Customer:heavy_check_mark:N/A
memberOptionalNullable[models.Member]:heavy_minus_sign:N/A
benefitmodels.Benefit:heavy_check_mark:N/A
propertiesmodels.Properties:heavy_check_mark:N/A