Attributes
| Name | Type | Description |
|---|---|---|
| object | string | Value is “Entitlement” |
| id | string | A merchant-specified unique identifier. |
| description | string | The Merchant-specified description of the entitled service. |
| account | Account | The Account responsible for granting the Entitlement (if at account-level). |
| subscription | Subscription | The Subscription responsible for granting the Entitlement (if at subscription-level). |
| billing_plan | Billing Plan | The Billing Plan associated with the entitlement (when at subscription-level and provided due to Billing Plan assignment). |
| subscription_item | Subscription Item | The Subscription Item associated with the Entitlement (when at subscription-level and provided due to an active SubscriptionItem with a product granting this Entitlement). |
| product | Product | The Product associated with the entitlement (when at subscription-level and provided due to an active Subscription Item with this product). |
| starts | datetime | The date/time at which entitlement begins. |
| ends | datetime | The date/time at which entitlement ends. |
| active | boolean | Indicates whether this Entitlement is currently active. |
Example Object
{
"object":"Entitlement",
"id":"ent_1234",
"description":"Sample Entitlement",
"account":{
"object":"Account",
"id":"cust_2234",
"vid":"07ac3365421741777c1f936480918c61aba85759"
},
"subscription":{
"object":"Subscription",
"id":"sub_1234",
"vid":"400dc2e6524e754914d8bd40e495f05f53939ddc"
},
"subscription_item":{
"object":"SubscriptionItem",
"id":"sub_1234.1",
"vid":"7fb1cdb3fcfa1541c5d31b70332e97cc38cfeab8"
},
"product":{
"object":"Product",
"id":"prod_1234",
"vid":"63143baaeb00f89c796681ea1c3298a8b66f6d5e"
},
"starts":"2021-05-27T05:52:02-07:00",
"ends":"2026-08-04T00:00:00-07:00",
"active":true
}