Sign in

v1

latestOpenAPI 3.0.02026-07-2671142187.3 KB
Add-Ons

Get add-on collection

Query all add-ons filtered by provided parameters

get/add-ons

Query parameters

idinteger

The add-on id

namestring

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

descriptionstring

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

amountnumber float

The amount charged to subscriptions which apply this add-on

frequency'one_time' | 'recurring'

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
isQuantityEditable'false' | 'true'

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
sortBy'asc' | 'desc'

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
limitinteger

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.

offsetinteger

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-tokenstring required

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

Response

Successful add-on collection query. The response body contains the data representation of all queried add-ons matching the provided parameters.

Example response

{
  "data": [
    {
      "id": 123456,
      "dateCreated": "2024-01-01 12:30:45",
      "dateUpdated": "1970-01-01 00:00:00",
      "name": "My new add-on",
      "description": "",
      "amount": 25,
      "frequency": "recurring",
      "isQuantityEditable": "true"
    }
  ]
}