Get payment plan collection

get

https://api.helcim.com/v2/payment-plans

Query all payment plans filtered by the provided parameters

Query Params

integer

The payment plan id

name

string

Given payment plan name. Only exact matches are currently supported.

type

string

enum

The payment plan billing type:

subscription - On sign-up plan bills on subscription activation date
cycle - Pick a day plans bill on specific days

Allowed:

status

string

enum

The payment plan activity status:

active - Status value for active plans
inactive - Status value for inactive plans

Allowed:

currency

string

enum

The currency subscriptions to the payment plan are billed with. Both CAD and USD are only applicable to Canadian merchants.

CAD - Canadian Dollars
USD - American Dollars

Allowed:

setupAmount

float

The monetary amount charged at time of sign-up for subscriptions to the payment plan

recurringAmount

float

The recurring monetary amount charged for subscriptions to the payment plan

billingPeriod

string

enum

The cycle at which subscriptions to the payment plan are billed:

daily - Cycle value for plans billed daily
weekly - Cycle value for plans billed weekly
monthly - Cycle value for plans billed monthly
yearly - Cycle value for plans billed yearly

Allowed:

billingPeriodIncrements

integer

The frequency to which subscriptions for the payment plan are processed based on billing period.

1 - Monthly plan will bill every month based on the scheduled billing day.
2 - Yearly plan will bill every two years, or a weekly plan every 2 weeks.
3 - Monthly plan will be billed quarterly.
4 - Weekly plan will bill every 4 weeks.
30 - Daily plan will bill every 30 days.

dateBilling

string

The date subscriptions to the payment plan are billed. This field requires specific formatting depending on the plan's billing cycle. See below examples for required formats:

Sign-up - Stored billing date for on sign-up plans
Daily - Stored billing date for plans billing daily
Monday - Weekly billing plans billing on a specific day store their billing day as the weekday name
08 - Monthly billing plans billing on a specific day store their billing day in DD format
06-15 - Yearly billing plans billing on a specific day store their billing day in MM-DD format

termType

string

enum

Identifies whether subscriptions to the plan expire after a set number of billings:

forever - Value for plans whose subscriptions do not expire
expires - Value for plans whose subscriptions expire after a set number of billings

Allowed:

freeTrialPeriod

integer

Free trial length (in days) for subscriptions to the payment plan

taxType

string

enum

The tax rate applied to subscriptions to the payment plan:

no_tax - No taxes applied to subscriptions to the plan
customer - Subscriptions to the plan tax according to the customer's location
merchant - Subscriptions to the plan tax according to your business' location

Allowed:

taxCalculation

string

enum

The specific country and province/state tax(es) applied to the tax rate calculation:

country_only - country tax applied only
country_province - summed total of country and province/state taxes applied
province_only - province/state tax applied only

Allowed:

paymentMethod

string

enum

The allowed payment methods subscriptions to this plan can utilize:

card - Subscriptions to plan bill via credit card
bank - Subscriptions to the plan bill via ACH
card_bank - Subscriptions to the plan can bill via either credit card or ACH

Allowed:

addOnId

integer

Add-on linked to the payment plan

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 payment plans found matching the provided parameters.

500

Helcim internal server error encountered.

200Successful payment plan collection query. The response body contains the data representation of all queried payment plans 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.