Get add-on collection

get

https://api.helcim.com/v2/add-ons

Query all add-ons filtered by provided parameters

Query Params

integer

The add-on id

name

string

The name of the add-on. Only exact matches are currently supported.

description

string

Additional information pertaining to the add-on. Only exact matches are currently supported.

amount

float

The amount charged to subscriptions which apply this add-on

frequency

string

enum

How often the add-on will charge to applied subscriptions:

one_time - Add-on is charged only during the next upcoming recurring billing
recurring - Add-on is charged for every recurring billing after date of application

Allowed:

isQuantityEditable

string

enum

Specifies whether the add-on can be applied multiple times to the same subscription:

false - Add-on can only be applied once
true - Add-on can be applied more than once

Allowed:

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 add-ons found matching the provided parameters.

500

Helcim internal server error encountered.

Language

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful add-on collection query. The response body contains the data representation of all queried add-ons 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.