The Discount Ticket 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
object	string	Value is “DiscountTicket”
id	string	A merchant-specified unique identifier. If not specified, this object can be identified by its vid.
vid	string	A Globally Unique Identifier (GUID) for this object assigned by Subscribe.
campaign_code	Campaign Code	Campaign code redeemed by this DiscountTicket. This attribute is required in order to create a DiscountTicket. Use a valid CampaignCode (id)
state	enum	The state of the discount ticket. Can be:- `Unredeemed` - `RedemptionFailed` - `Redeemed` - `Active` - `Inactive` Note: This is a read-only attribute.
added_date	datetime	The time this DiscountTicket was added.Note: This is a read-only attribute.
removed_date	datetime	When a Subscription Item is removed from a subscription or replaced its associated discount ticket is also removed. This attribute displays the time this DiscountTicket was removed. Note: This is a read-only attribute.
end_date	datetime	The time this DiscountTicket ceased to be active.Note: This is a read-only attribute.
start_billing_sequence	integer	The billing period of the subscription/charge on which the discount will first be applied. When not indicated, the discount is applied on the next billing period.
end_billing_sequence	integer	Read-only attribute indicating the Subscription sequence when this DiscountTicket will cease to be active. The length of the discount period is indicated by thecampaign..Note: This is a read-only attribute.
previous_discount_ticket_id	string	For future use.
previous_discount_ticket_vid	string	For future use.
campaign_id	Campaign id	The unique identifier for the Campaign associated with this DiscountTicket
metadata	hash	A set of key/value pairs that you can attach to an object. Useful for storing additional information. For more details, see Metadata.
Parent topic:Discount Tickets