Subscriptions

Patch subscriptions

Partially update one or more existing subscriptions.

patch/subscriptions

Request

Base URL
https://api.helcim.com/v2
URL
https://api.helcim.com/v2/subscriptions
Auth
none declared. Required headers: api-token

Headers

api-tokenstring required

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

Request body

Example request

{
  "subscriptions": [
    {
      "id": 123456,
      "dateActivated": "2024-03-01",
      "recurringAmount": 20.99,
      "hasFreeTrialPeriod": false
    }
  ]
}

Response

Successful subscription patch. The response body contains the data representation of all updated subscriptions. Any payments altered as part of the update will be included with their associated subscription.

Example response

{
  "data": [
    {
      "id": 123456,
      "dateCreated": "2024-01-01 12:30:45",
      "dateUpdated": "1970-01-01 00:00:00",
      "dateActivated": "2024-03-01",
      "dateBilling": "2024-03-07",
      "status": "active",
      "paymentPlanId": 5878,
      "customerCode": "CST1200",
      "timesBilled": 0,
      "setupAmount": 0,
      "recurringAmount": 20.99,
      "freeTrialPeriod": 0,
      "hasFailedPayments": "false",
      "addOnIds": [
        123,
        455
      ],
      "payments": [
        {
          "id": 49978,
          "setupAmount": 0,
          "recurringAmount": 0,
          "addOnAmount": 0,
          "amount": 20.99,
          "taxAmount": 0,
          "status": "waiting",
          "dateDue": "2024-03-07 00:00:00",
          "dateProcessed": "1970-01-01 00:00:00",
          "paymentNumber": 1,
          "numberOfRetries": 0
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.