Skip to main content
Vindicia Knowledge Center

Product Data Members

Product Data Members

Product Data Members

The following table lists and describes the data members of the Product object.

Data Member

Data Type

Description

billingStatementIdentifier

string

Optional. The transaction description on the customer’s billing statement that is sent by the bank when the customer is charged through this Product object. This field’s value and format are set by your payment processor; consult with Vindicia Client Services before setting the value.

If GlobalCollect, Chase Paymentech, MeS, or Litle is your payment processor, see Custom Billing Statement Identifier Requirements in the CashBox Programming Guide. 

Note If this identifier is also defined in a BillingPlan object associated with the AutoBill object for this Product object, the billing statement identifier on BillingPlan takes precedence.

bundledProducts

Product

Zero or more products “bundled” or grouped with this Product.

creditGranted

Credit

The credit(s) to be granted upon purchase of this Product.

See the Credit Subobject.

defaultBillingPlan

BillingPlan

Optional. Recurring pricing is governed by this attribute if a billing plan is not explicitly associated with the AutoBill object for this Product object.

defaultRatePlan

RatePlan

Optional. A default Rate Plan for the Product.

descriptions

ProductDescription

Optional. Zero or more language/product description pairs.

Note In the absence of a product description, the merchantProductId will be used.

endOfLifeTimestamp

dateTime

Optional. A time stamp that specifies the expiration date for this Product object. Use this attribute to filter your product list, and present only those products with future expiration dates as currently available for subscription.

(This attribute is for your information only, and does not affect CashBox operations.)

merchantEntitlementIds

MerchantEntitlementId

An array of identifiers that determine the customer’s entitlements. Use these IDs within your application to grant access to products or services. These IDs are returned to you inside Entitlement objects along with the dates until which they are valid for a given customer. The status of a customer’s AutoBill object with which this product is associated determines the date until which the Entitlement objects are valid.

Note Entitlements are available to customers through Product, BillingPlan, and Account objects. When adding Products to an AutoBillEntitlements are cumulative, unless otherwise defined.

See Entitlement Data Members.

merchantProductId

string

Your unique identifier for the product. If you track your products internally by SKU, use the SKU as your merchantProductId, to allow you to map your local records to CashBox Transactions that have this Product as a line item.

nameValues

NameValuePair

Optional. An array of name–value pairs, each of which enables you to add additional product information, not included in this Product object’s other attributes.

See The NameValuePair Object.

prices

ProductPrice

An array of ProductPrice objects, one per currency (or Token) code.

See the ProductPrice Subobject.

status

ProductStatus

An enumerated string value that describes the current status of the Product object. See the ProductStatus Subobject for the values.

For example, use this value to determine whether to make a Product object available for subscription purchase.

(This attribute is for your information only, and does not affect CashBox operations.)

taxClassification

string

A string that defines your tax classification for this Product.

 

VID

string

Vindicia's Globally Unique Identifier (GUID) for this object. When creating a new Product object, leave this field blank; it will be automatically populated by CashBox.

For Users

Learn More
For Users

Cashbox Features

Learn More
Cashbox Features
Back to Top