Get subscription collection

get

https://api.helcim.com/v2/subscriptions

Query all subscriptions filtered by the provided parameters

Query Params

integer

The subscription id

dateActivated

string

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.

dateBilling

string

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

status

string

enum

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.

Allowed:

paymentPlanId

integer

The payment plan id to which the subscription is tied to

customerCode

string

The code for the customer who owns the subscription

timesBilled

integer

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

setupAmount

float

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.

recurringAmount

float

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

freeTrialPeriod

integer

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

maxCycles

integer

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

hasFailedPayments

string

enum

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.

Allowed:

addOnId

integer

Add-on linked to the subscription

sortBy

string

enum

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

Allowed:

limit

integer

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.

offset

integer

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).

Headers

api-token

string

required

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

Responses

204

No subscriptions found matching the provided parameters.

500

Helcim internal server error encountered.

200Successful subscription collection query. The response body contains the data representation of all queried subscriptions matching the provided parameters.

400You are initiating a request with invalid parameter and/or body values.

401You are not authorized to access this resource. Please ensure that you are authenticated, and that you are using the api-token header

403You do not have permission to access this resource. Please ensure you are both authenticated and that you have the required roles/permissions active.