Skip to main content
Vindicia Knowledge Center

Entitlement Data Members

Entitlement Data Members

Entitlement Data Members

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

Data Members

Data Type

Description

account

Account

The Account object with which this Entitlement object is associated.

See The Account Object.

active

Boolean

A Boolean flag that, if set to true, indicates that the Entitlement is currently active.

autoBillVid

string

The AutoBill VID associated with this Entitlement.

description

string

Your description for the Entitlement.

endTimestamp

dateTime

The date on which the Entitlement will expire, plus a grace period for the final billing transaction. (Blank for no end date.)

If CashBox returns this Entitlement object in the active status, you may assume that the object is active until this date (or the next failed billing attempt, if such occurs).

Re-fetch this Entitlement object to determine if it is still valid. If you call fetchDeltaSince() to retrieve Entitlement objects that might have changed but do not receive an update to this object, consider this Entitlement to be invalid after this time stamp.

merchantAutoBillId

string

Your AutoBill ID associated with this Entitlement.

merchantEntitlementId

string

An identifier for a specific privilege on your site. This ID, which has a special meaning in your application, specifies the resources to which a customer has access. Define this ID in the merchantEntitlementId field in Product or BillingPlan objects.

merchantProductId

string

Your Product ID associated with this Entitlement, if any.

productVid

string

The Product VID associated with this Entitlement, if any.

startTimestamp

dateTime

The time the entitlement begins.

For Users

Learn More
For Users

Cashbox Features

Learn More
Cashbox Features
Back to Top