Transaction Item - Vindicia Subscribe — SaaS Knowledge Center

V2

This topic shows information relevant specifically for Subscribe REST API version 20210401 referred to as V2

Attributes

Name	Type	Description
object	string	Value is “TransactionItem”
sku	string	The SKU or unique identifier of the product purchased with this item (for one-time transactions this is an ad-hoc value.
index_number	integer	Sequential index of all items on the transaction.
item_type	enum(TransactionItemType)
name	string	Merchant-provided name or inherited description of the product purchased
subscription_item	Subscription Item	Subscription Item associated with this item.
price	decimal	unit price of this item
metadata	hash	A set of key/value pairs that you can attach to an object. Useful for storing additional information.
quantity	decimal	The unit quantity for the item; for license-based products this is the license/seat quantity.
tax_classification	string	The tax code or classification applicable to this item.
tokens	Token Amount	Tokens granted to the account on this transaction for purchasing this item
campaign_code	string	Campaign code redeemed on this Transaction Item.
campaign_id	string	The unique identifier for a campaign applied to this item.
campaign_description	string	Detailed description of the campaign for the discount on this item, if there is one.
discount_tickets	Discount Tickets	Discount Tickets offer the ability to redeem multiple campaign discounts. This attribute is an array of Discount Tickets applicable to this Trasaction item.
item_discounts	Transaction Item Discount	Array of discounts associated with this item.
tax_total	decimal	The total tax on this item
service_period_starts	datetime	The start date for the period the charge on this item covers.
service_period_ends	datetime	The end date for the period the charge on this item covers.
tax_type	string	Fixed Tax definition (read only).
tax	Tax Item	Array listing the individual tax items associated with the corresponding transactionItem.
related_transactions	string	List of merchantTransactionIds for all Transactions related to this item. e.g. For a credit resulting from the removal of an SubscriptionItem, this will contain the list of all Transactions that originally billed for the item within the time frame covered by the credit.
item_refunds	Transaction Item Refund Summary	Detail on item-level refunds applied to this item.
discount	decimal	The total discount amount applied to this item.
subtotal	decimal	The pre-tax (post-discount) subtotal.
total	decimal	The grand total of this item

Transaction Item Refund Summary

Parent topic:Resources