Get subscription collection

The subscription id

The date (in YYYY-MM-DD format) on which the subscription activates. Any free trial applied to the subscription begins on this date and this date determines when the first recurring billing date occurs.

The upcoming billing date (in YYYY-MM-DD format) for the subscription.

The subscription activity status. Note that statuses term_ending and term_ended are internal statuses not available for editing in the API. term_ending is synonymous with active and term_ended is synonymous with cancelled.

• active - Subscription is active and will bill every cycle
• paused - Subscription is paused and not billing. It can be resumed when desired.
• cancelled - Subscription is cancelled and not billing. It cannot be resumed.
• term_ending - Subscription is expiring at the end of next billing. It is considered active.
• term_ended - Subscription has expired and is no longer billing. It is considered cancelled.

The payment plan id to which the subscription is tied to

The code for the customer who owns the subscription

The number of times the subscription has successfully billed. Note that any declined or failed billings are excluded from the tally.

The setup amount charged on the first billing for the subscription, only if useCustomSetupAmount is also true. Otherwise, the payment plan default setup amount is charged.

The recurring amount charged each cycle for the subscription. The value can differ from the payment plan if desired.

The free trial length (in days) for the subscription before it commences billing.

The number of cycles the subscription will bill before ending. This field will only be greater than zero for expiring subscriptions.

Field indicating whether the subscription has one or more declined/failed payments.

• false - Subscription has no declined or failed payments.
• true - Subscription has at least one declined and/or failed payment.

Add-on linked to the subscription

Sorting preference of returned resources in the response body. Must be in the format PARAMETER.ORDER, where PARAMETER is any allowed query parameter in the request (e.g. id) and ORDER is one of the following:

• asc - sort by the parameter in ascending order
• desc - sort by the parameter in descending order

The maximum number of resources to return. Up to a maximum of 100 resources can be returned in a request. Not including this parameter will default to returning all available resources selected up to maximum 100.

Starting index for resources returned based on the provided query parameters and sorting conditions. Not including this parameter will default to starting with the first resource (inclusive).

Your API access token for authentication and access to the Helcim API