v1

latestOpenAPI 3.0.02026-07-2671142187.3 KB

Subscriptions

Patch subscription add-ons

Partially update the quantity of one or more add-ons applied to the target subscription. The add-ons specified must support editing of quantity for the designated quantity to be saved.

patch/subscriptions/{subscriptionId}/add-ons

Path parameters

subscriptionIdinteger required

The subscription id

Headers

api-tokenstring required

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

Request body

Example request

{
  "addOns": [
    {
      "addOnId": 123456,
      "quantity": 5
    }
  ]
}

Response

Successful subscription add-on patch. The response body contains the data representation of all updated subscription add-ons.

Example response

{
  "data": [
    {
      "addOnId": 123456,
      "name": "My editable add-on",
      "description": "",
      "amount": 3.5,
      "firstProcessedNumber": 0,
      "lastProcessedNumber": 0,
      "isActive": "true",
      "frequency": "recurring",
      "quantity": 5
    }
  ]
}