The Charge Object - 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
vid	string	A Globally Unique Identifier (GUID) for this object. Assigned by Subscribe.
subscription	Subscription	The subscription to which this additional charge applies
invoice	Invoice	The invoice to which this additional charge applies
description	string	A description of the charge. This is a free-form string of 256 or fewer characters.
product	Products	Product used to determine charge amount added to Subscription.
tax_classification	string	Tax classification for charge. This field is required UNLESS the price is to be based on the Product, (in which case the tax classification can be based on the associated Product tax classification).
amount	decimal	Amount to charge. This field is required UNLESS the price is to be based on the Product.
currency	enum	ISO 4217 currency code for amount. Either token, OR currency must be specified.
token	Token	Token associated with amount (if this is a Token-based Subscription). Either token, OR currency must be specified.
quantity	integer	Optional value to be included in charge. Defaults to 1, if not specified
discount	number	Calculated discount amount.
subtotal	number	Calculated subtotal. This is the taxable amount.
tax_total	number	Calculated tax total
total	number	Calculated total amount which includes subtotal, tax and discounts.
item_discounts	Invoice Item Discount	The array of the Invoice item discounts
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 charge.Note: This is input to the charge object that results in item_discounts attribute being generated.
Parent topic:Charges (Pending)