Attributes
| Name | Type | Description |
|---|---|---|
| object | string | Value is “Product” |
| id | string | A merchant-specified unique identifier. Optionally, this object can be identified by its vid. |
| vid | string | A Globally Unique Identifier (GUID) for this object. This field is created by Subscribe. |
| created | datetime | The date/time the object was created. |
| descriptions | Product Description | Language-specific product/service descriptions |
| status | enum | Merchants can describe the current status of the Product. Available Values:- Active - Suspended Use this attribute to filter your product list to only display active products. The system does not block subscription creation with products of type Suspended. |
| tax_classification | string | The tax classification or code for this product. |
| br_tax_category | enum | Can be: Goods or Services |
| default_billing_plan | Billing Plan | Billing Plan to assign to subscriptions where this product is the “primary” and no plan has been set. |
| default_rate_plan | Rate Plan | The Rate Plan to assign to subscription items assigned to this product, where using rated pricing. |
| end_of_life | datetime | The date/time specifying the planned expiration date for this Product. Use this attribute to filter your product list to only display products with future expiration dates as currently available for subscription.Note: The End of Life parameter does not impact existing subscriptions or block new subscriptions from being activated. It can be used to ensure the product is not displayed in the catalog. |
| metadata | hash | A set of key/value pairs that you can attach to an object. Useful for storing additional information. |
| entitlements | Entitlement | Entitlements granted by active subscriptions using this product on one or more subscription items. |
| inherited_entitlements | Entitlement | If a Product has other products bundled with it, the Entitlements for the Products in the bundle will be returned |
| billing_descriptor | string | Optional “soft descriptor” to send to the payment processor for transactions associated with a subscription using this product. |
| credit_granted | Credit | Credits to be granted upon purchase of this product. |
| prices | Product Price | Default (i.e. “List”) prices for the product; one price per currency code. Prices can be overridden at purchase or with modification. |
| bundled_products | Product | Other Products considered “bundled” under this one; purchase of this product’s SKU under a single price, grants the entitlements associated with it and with all bundled products (as of the time of creation). |
Example Object
{
"object":"Product",
"id":"prod_1234",
"vid":"190828347a650eeca011ac8a6be550416d4cf9a0",
"created":"2020-05-15T23:45:06-07:00",
"descriptions":{
"object":"List",
"data":[
{
"object":"ProductDescription",
"language":"EN",
"description":"prod_1234"
}
],
"total_count":1
},
"status":"Active",
"tax_classification":"DownloadableElectronicData",
"default_billing_plan":{...},
"metadata":{
"COA_CODE":"GNGX102"
},
"entitlements":{...},
"credit_granted":{...},
"prices":{
"object":"List",
"data":[
{
"object":"ProductPrice",
"amount":2,
"currency":"USD"
}
],
"total_count":1
}
}