Get Subscription

A Subscription is an instance of a plan. It holds the actual amounts and dates of payments for the plan.

Attribute	Child Attribute	Description
id string		The Subscription ID
payer		The payer for the subscription
	id string	The Payer ID
	firstName string	Payer's first name
	lastName string	Payer's last name
	emailAddress string	Payer's email
	mobileNumber string	Payer's mobile number
planId string		The Plan ID this subscription was created from
planName string		The name of the plan
status string		The current status of the subscription. Can be: active - Subscription is in progress cancelled - The subscription has been cancelled. Can be due to a failed payment or manually cancelling the subscription. failed - The subscription has one or more failed payments and needs attention. complete - All payments have been successfully settled. This subscription is now closed.
startDate DateTime		The start date of the subscription
freePeriods array of freePeriods		Not currently used, but lets you set a period of time where no payments will be scheduled.
fixedPayments array of fixedPayment		A list of the fixed payments for this subscription
	amount integer	The amount in cents for this payment.
	description string	The description for this payment
	cancelPlanOnFailure boolean	Whether or not the subscription will be cancelled if this payment fails
	metadata string	Contains the metadata added when creating the subscription
	transactionDate	The date of this payment in UTC
recurringPayment recurringPayment		The recurring payment portion of this subscription
	amount integer	The amount in cents for each payment created
	endAfterNumberOfPayments integer	If set, the number of recurring payments to be generated before completing the subscription
	endAfterTotalAmount integer	If set, the total amount collected on a recurring basis before completing the subscription
	frequencyInterval string	Can be "days", "months", or "years"
	frequencyOffset integer	There will be this many intervals between each recurring payment
	description string	A description for the recurring payment
	cancelPlanOnFailure boolean	If true, the subscription will be cancelled if any one of the recurring payments fails
	metadata string	Contains the metadata added when creating the subscription
	endAfterDate date	If set, the subscription will complete after this date
	startDate date	The start date of the subscription
totalAmount integer		If set, this is the total amount that will be collected for the subscription. Used mainly for percentage based plans.
metadata string		Contains the metadata added when creating the subscription
surcharge array of strings		Contains the Source Types that will have their fees surcharged. Valid values are any combination of "bank-account" and "credit-card". eg. ["bank-account", "credit-card"].