Sign in

v1

latestOpenAPI 3.0.02026-07-2671142187.3 KB
Payment Plans

Get payment plan

Query a payment plan by id

get/payment-plans/{paymentPlanId}

Path parameters

paymentPlanIdinteger required

The payment plan id

Query parameters

includeSubObjectsboolean

Specifies whether to include available sub-objects linked to the payment plan. Available sub-objects:

  • add-ons linked to the payment plan

Headers

api-tokenstring required

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

Response

Successful payment plan query. The response body contains the data representation of the queried payment plan and (if requested) any sub-objects linked to it.

idinteger
dateCreatedstring
dateUpdatedstring
namestring
descriptionstring
typestring
statusstring
currencystring
cardTerminalIdinteger
setupAmountnumber float
recurringAmountnumber float
billSetupImmediatelystring
billingPeriodstring
billingPeriodIncrementsinteger
dateBillingstring
termTypestring
freeTrialPeriodinteger
taxTypestring
taxCalculationstring
termLengthinteger
paymentMethodstring
businessEmailstring
addOnIdsinteger[]
isProratedstring

Example response

{
  "id": 123456,
  "dateCreated": "2024-01-01 12:30:45",
  "dateUpdated": "1970-01-01 00:00:00",
  "name": "My new monthly plan",
  "description": "",
  "type": "subscription",
  "status": "active",
  "currency": "CAD",
  "cardTerminalId": 12345,
  "setupAmount": 15,
  "recurringAmount": 10.5,
  "billSetupImmediately": "first_billing",
  "billingPeriod": "monthly",
  "billingPeriodIncrements": 1,
  "dateBilling": "Sign-up",
  "termType": "forever",
  "freeTrialPeriod": 0,
  "taxType": "customer",
  "taxCalculation": "country_only",
  "termLength": 0,
  "paymentMethod": "card",
  "businessEmail": "test@myBusiness.com",
  "isProrated": "no",
  "addOnIds": [],
  "addOns": []
}