Get a subscription

Timestamp of when record was created, in UTC.

The subscription's end date.

If applicable, the internal reference ID to the payment page associated with the transaction.

A custom identifier for the paypoint, if applicable.

Fee applied to the subscription.

The subscription's frequency.

The subscription's ID.

The last time the subscription was processed.

Timestamp of when record was last updated, in UTC.

The number of cycles the subscription has left.

The subscription's payment method.

Net amount.

The next date the subscription will be processed.

The name of the parent organization.

The alternate or common name that this business is doing business under, usually referred to as a DBA name.

The entrypoint identifier.

The paypoint's ID. Note that this is different than the entryname.

Business legal name.

Payment plan ID.

Custom identifier to indicate the transaction or request source.

The subscription start date.

The subscription's status.

• 0: Paused
• 1: Active

Subscription type or category. Can't be changed after the subscription is created; if sent to the update endpoint, it's ignored.

• Regular: A standard recurring subscription that charges a fixed amount each cycle.
• BalanceDriven: A subscription that charges the payor's outstanding balance at run time instead of a fixed amount. Each scheduled run reads the live balance and charges that amount; a zero balance is skipped, not charged. BalanceDriven subscriptions only accept the firstofmonth, fifteenthofmonth, and endofmonth frequencies, ignore any startDate and endDate you supply (start date is calculated from frequency; the schedule runs until cancelled), and don't store a static totalAmount on the schedule.

The subscription amount, including any fees.

The total number of cycles the subscription is set to run.

When true, the subscription has no explicit end date and will run until canceled.