Get Entitlement
Retrieve a specific entitlement by ID. For metered entitlements, the response includes live balance, usage, and access status for the current billing period.
Authorizations
API key authentication
Path Parameters
The unique identifier of the entitlement
^ent_[a-zA-Z0-9]+$Query Parameters
Evaluate balance and access at this point in time (RFC 3339 datetime with any UTC offset, e.g. 2024-01-15T10:30:00Z or 2024-01-15T15:30:00+05:30). Defaults to current time.
Response
Successfully retrieved the entitlement.
- Option 1
- Option 2
- Option 3
A specific entitlement. The response shape varies by featureType.
entitlement Unique identifier for the entitlement.
^ent_[a-zA-Z0-9]+$Unique identifier for a customer
^cus_[a-zA-Z0-9]+$The feature this entitlement grants access to.
^feat_[a-zA-Z0-9]+$The unique key identifying the feature.
The type of feature.
boolean Unique identifier for a product
^prod_[a-zA-Z0-9]+$The subscription this entitlement is associated with, if any.
Current status of the entitlement.
active, canceled, expired When the entitlement becomes active.
When the entitlement expires. Null means no expiration.
Whether the customer currently has active access to this entitlement.
Additional metadata for the entitlement.
Always null for boolean entitlements. Surfaced on every entitlement so clients can read config without first switching on featureType.