v1

latestOpenAPI 3.0.02026-07-2475182625.5 KB

Subscriptions

List all subscription plan changes

Returns an array of subscription plan change history entries, detailing what changed, when the change occurred, and how it was modified.

get/subscriptions/{subscription_id}/history

Path parameters

subscription_idstring required

Example:1abc2DE_FGhIjKLm3NoPQR

Unique identifier for the subscription.

Query parameters

scope'base_plan' | 'add_on'

Specify the item type to filter results. Valid values include base_plan and add_on.

order'increasing' | 'decreasing'

Specify the sort order of the results. Valid values include increasing and decreasing. The default value is decreasing.

Response

currencystring

The currency in which the transactions are made.

timezonestring

The timezone associated with the changes.

Example response

{
  "currency": "USD",
  "timezone": "UTC",
  "changes": [
    {
      "insertTimestamp": 1684378979000,
      "subscriptionId": "aBCDE12fGH3iJkL4mNOpqr",
      "siteId": "aBCDE12fGH",
      "changeId": "AbC1D2eFGH34ijklmnopQrs",
      "prorated": true,
      "orderId": "AbC1D2eFGH34ijklmnopQrs",
      "itemType": "ADD_ON",
      "itemId": "AbC1D2eFGH34ijklmnopQrs",
      "itemProductPath": "document-viewer",
      "itemProductDisplay": "Document Viewer",
      "itemProductSku": "SKU-12345",
      "changeType": "ADD_ON_REMOVE",
      "changedFrom": "1",
      "changedFromDisplay": "1",
      "changedTo": "0",
      "changedToDisplay": "0"
    }
  ]
}