Subscriptions (Packages)

Merge Tag	Type	Description
{{package.package_id}}	integer	Subscription ID #
{{package.customer_id}}}}	integer	Customer ID #
{{package.brand_id}}}}	integer	Brand ID #
{{package.brand_name}}}}	string	Brand name
{{package.class_id}}	integer	Class ID #
{{package.class_name}}	string	Class name
{{package.external_key}}	string	External key value
{{package.token}}	string	Unique token
{{package.nickname}}	string	Nickname for the subscription
{{package.paymethod}}	string	Payment method for the subscription, one of: crd, inv, ach, tok
{{package.paymethod_name}}	string	Payment method for the subscription (e.g. Credit Card)
{{package.paymethod_detail}}	string	Payment method details (e.g. "Visa x1111")
{{package.creditcard_id}}	integer	Credit card ID # (if the subscription is paid by credit card)
{{package.tokenized_id}}	integer	Tokenized ID # (if the subscription is paid by an external service token)
{{package.admin_id}}	integer	Admin/Worker ID #
{{package.admin_name}}	string	Admin/Worker name
{{package.bill_addr1}}	string	Billing address line 1
{{package.bill_addr2}}	string	Billing address line 2
{{package.bill_addr3}}	string	Billing address line 3
{{package.bill_city}}	string	Billing address city
{{package.bill_state}}	string	Billing address state/province
{{package.bill_postcode}}	string	Billing address postal code
{{package.bill_country}}	string	Billing address country
{{package.bill_notes}}	string	(deprecated)
{{package.bill_block}}	string	Printable billing address
{{package.ship_addr1}}	string	Ship address line 1
{{package.ship_addr2}}	string	Ship address line 2
{{package.ship_addr3}}	string	Ship address line 3
{{package.ship_city}}	string	Ship address city
{{package.ship_state}}	string	Ship address state/province
{{package.ship_postcode}}	string	Ship address postal code
{{package.ship_country}}	string	Ship address country
{{package.ship_notes}}	string	(deprecated)
{{package.ship_block}}	string	Printable shipping address
{{package.currency_id}}	integer	Currency ID #
{{package.currency_symbol}}	string	Currency symbol
{{package.currency_iso4217}}	string	Currency ISO 4217 code
{{package.amount_collected}}	float	Total amount collected so far for this subscription
{{package.amount_invoiced}}	float	Total amount invoiced so far
{{package.amount_due}}	float	Total amount due (invoiced - collected)
{{package.amount_overdue}}	float	Total amount past due
{{package.suspendfrom_datetime}}	datetime	Date/time this subscription was suspended from
{{package.suspendto_datetime}}	datetime	Date/time this subscription was suspended to
{{package.next_invoice_datetime}}	datetime	The date the next invoice will be generated
{{package.is_overdue}}	boolean	Whether or not the subscription is overdue
{{package.days_overdue}}	integer	# of days overdue the subscription is
{{package.start_datetime}}	datetime	Date/time this subscription was started/effective
{{package.cancel_datetime}}	datetime	Date/time this subscription was cancelled
{{package.write_datetime}}	datetime	Date/time the subscription was created
{{package.mod_datetime}}	datetime	Date/time the subscription was last updated, upgraded, downgraded, etc.
{{package.holduntil_datetime}}	datetime	Date/time invoicing for this subscription is being delayed until
{{package.package_status_id}}	integer	Subscription status ID #
{{package.package_status_name}}	string	Human-friendly subscription status
{{package.package_status_str}}	string	Status string
{{package.package_status_state}}	string	Status code
{{package.mrr}}	float	Current monthly recurring revenue of the subscription
{{package.arr}}	float	Current annual recurring revenue of the subscription
{{package.cancel_reason}}	string	Reason for cancellation
{{package.terms_id}}	integer	Terms ID #
{{package.terms_name}}	string	Terms name
{{package.terms_days}}	integer	Terms # of days
{{package.paycycle}}	string	Payment cycle for the subscription (e.g. monthly, etc.)
{{package.paycycle_name}}	string	Payment cycle name
{{package.custom_1}}	mixed	Custom field #1
{{package.custom_2}}	mixed	Custom field #2
{{package.custom_3}}	mixed	Custom field #3
{{package.custom_4}}	mixed	Custom field #4
{{package.custom_5}}	mixed	Custom field #5
{{package.custom_6}}	mixed	Custom field #6
{{package.custom_7}}	mixed	Custom field #7
{{package.custom_8}}	mixed	Custom field #8
{{package.custom_9}}	mixed	Custom field #9
{{package.custom_10}}	mixed	Custom field #10
{{package.custom_11}}	mixed	Custom field #11
{{package.custom_12}}	mixed	Custom field #12
{{package.custom_13}}	mixed	Custom field #13
{{package.custom_14}}	mixed	Custom field #14
{{package.custom_15}}	mixed	Custom field #15
{{package.custom_16}}	mixed	Custom field #16
{{package.custom_17}}	mixed	Custom field #17
{{package.custom_18}}	mixed	Custom field #18
{{package.custom_19}}	mixed	Custom field #19
{{package.custom_20}}	mixed	Custom field #20
{{package.first_invoice_schedule_template_id}}	integer	Payment schedule to use for the first invoice generated
{{package.recurring_invoice_schedule_template_id}}	integer	Payment schedule to use for the subsequent generated invoices
{{package.line_items}}	array	A list of line items for the subscription
{{package.tags}}	array	A list of tags
{{package.url_self}}	string	URL for viewing the subscription in the GUI