v1

latestOpenAPI 3.0.02026-07-2671142187.3 KB

Payment Plans

Patch payment plans

Partially update one or more existing payment plans. Each specified payment plan must contain one or fields in the request body to update.

patch/payment-plans

Headers

api-tokenstring required

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

Request body

Example request

{
  "paymentPlans": [
    {
      "id": 123456,
      "name": "My updated monthly plan",
      "description": "Now with a new amount and free trial period",
      "recurringAmount": 15.99,
      "freeTrialPeriod": 14,
      "billSetupImmediately": "immediate"
    }
  ]
}

Response

Successful payment plan patch. The response body contains the data representation of all updated payment plans.

Example response

{
  "data": [
    {
      "id": 123456,
      "dateCreated": "2024-01-01 12:30:45",
      "dateUpdated": "1970-01-01 00:00:00",
      "name": "My updated monthly plan",
      "description": "Now with a new amount and free trial period",
      "type": "subscription",
      "status": "active",
      "currency": "CAD",
      "cardTerminalId": 12345,
      "setupAmount": 15,
      "recurringAmount": 15.99,
      "billSetupImmediately": "immediate",
      "billingPeriod": "monthly",
      "billingPeriodIncrements": 1,
      "dateBilling": "Sign-up",
      "termType": "forever",
      "freeTrialPeriod": 14,
      "taxType": "customer",
      "taxCalculation": "country_only",
      "termLength": 0,
      "paymentMethod": "card",
      "businessEmail": "test@myBusiness.com",
      "addOnIds": [],
      "isProrated": "no"
    }
  ]
}