Skip to main content
Vindicia Knowledge Center

The product object

The product object

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 CashBox.
created datetime The date/time the object was created.
descriptions ProductDescription[] Language-specific product/service descriptions
status enum Merchants may define whether they want to declare a product as available to offer. Value can be Active,Suspended
tax_classification string The tax classification or code for this product.
default_billing_plan BillingPlan Billing Plan to assign to subscriptions where this product is the “primary” and no plan has set.
default_rate_plan RatePlan The rate plan to assign to subscription items assigned to this product, where using rated pricing.
end_of_life datetime The date/time after which this product should be treated as out-of-service.
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.
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 ProductPrice[] 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).
  • cURL
  • Java
Example Object
{
    "object": "Product",
    "id": "prod_1234",
    "vid": "190828347a650eeca011ac8a6be550416d4cf9a0",
    "created": "2016-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
        }
}
{
    "object": "Product",
    "id": "prod_1234",
    "vid": "190828347a650eeca011ac8a6be550416d4cf9a0",
    "created": "2016-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
        }
}

For Users

Learn More
For Users

Cashbox Features

Learn More
Cashbox Features
Back to Top