AutoBillItem Subobject

The AutoBillItem object allows you to add multiple items to an AutoBill, and define the duration of their inclusion. The following table lists and describes the data members of the AutoBillItem object.

Data Members	Data Type	Description
`addedDate`	dateTime	Read only. Specifies the dateTime when the `AutoBillItem` was added to the `AutoBill`.
`amount`	decimal	The amount to bill. If non-null, this field will override the Product’s `price`. Value cannot be negative. This field is populated only if the you wish to override the default (product-based) price for the item. Otherwise, it is blank. Note: `AutoBillItems` may have an amount, or a `ratePlan`, but not both.
`campaignCode`	string	The Campaign code redeemed on this `AutoBillItem`. To apply a Campaign, use this field to pass in a valid Coupon or Promotion code. Note: This data member will not be returned.
`campaignId`	string	Read only. The unique identifier for a Campaign applied to this `AutoBillItem`. This is a read-only field returned by Subscribe for informational purposes. Values sent in with a SOAP call will be ignored.
`currency`	string	The ISO 4217 currency code to be used for the override `amount`. This value will be ignored if `amount` is `null`.
`cycles`	int	The number of billing cycles this item will be active. If `null`, the item will remain active until explicitly removed.
`cyclesRemaining`	int	A read-only field indicating how many billing cycles remain for this item.
`index`	int	The index number of the item in the `items` field of an `AutoBill`. (Should be unique in array. First item should have index 0.)
`merchantAutoBillItemId`	string	Your unique identifier for this `AutoBillItem` object. Note: use of the forward slash character (/) in merchant identifiers is not allowed. See Merchant Identifiers for more information.
`nameValues`	NameValuePair	Optional. An array of name–value pair items for this `AutoBill` object.. Note: All name-value pairs included with an AutoBill object will be automatically copied to any resultant Transactions, and similarly AutoBill Item `nameValues` will be inherited by their corresponding Transaction Items. See The NameValuePair Object
`product`	Product	The Product to be AutoBilled. When creating a new `AutoBillItem` an existing `VID` or `SKU` must be specified or a new `Product` will be created. It is generally recommended that `Products` be created explicitly in advance, rather than implicitly. See Product Data Members.
`quantity`	string	Number of items, or the number of units of a product when the product can be purchased in multiples. Subscribe uses this number to determine the cost of the item to the customer. `Quantity` must be a whole number unless the item is a rated item. For license-based rated products, Quantity indicates the license count.
`ratePlan`	RatePlan	The Rate Plan associated with this Item. Note: `AutoBillItems` may have an `amount`, or a `ratePlan`, but not both. See RatePlan Data Members.
`removedDate`	dateTime	A read-only attribute indicating the time this item was removed.
`startDate`	string	Specifies when the AutoBill will begin billing for the `AutoBillItem`, and when the item’s entitlements will become Active. Valid input includes `null` (for which the `startDate` will be `today`), yyyy-mm-dd, or a time interval. Acceptable time interval strings include an integer followed by: - Season - Month - Week - Day For example: - 1 Season - 2 Month - 3 Week - 1 Day Appending an “s” is not required for time intervals greater than 1; however, it is acceptable. The output format is yyyy-mm-dd.
“token	Token	The token associated with amount (if this is a Token-based AutoBill). This value will be ignored if amount is null.
`transitionedFromAutoBillItemVid`	string	Read only. The unique Vindicia identifier of the `AutoBillItem` this item replaced as the result of an `AutoBill.modify` call.
`transitionedFromMerchantAutoBillItemId`	string	Read only. Your identifier for the `AutoBillItem` this item replaced as the result of an `AutoBill.modify` call.
`transitionedToAutoBillItemVid`	string	Read only. The unique Vindicia identifier of the `AutoBillItem` that replaced this item as a result of an `AutoBill.modify` call.
`transitionedToMerchantAutoBillItemId`	string	Read only. Your identifier for the `AutoBillItem` that replaced this item as a result of an `AutoBill.modify` call.
`VID`	string	Vindicia’s Globally Unique Identifier (GUID) for this object. When creating a new `AutoBillItem` object, leave this field blank; it will be automatically populated by Subscribe.
Parent topic:AutoBill Subobjects

Home

Guides

APIs