Subscriptions

Get Subscription History

Returns every record in a subscription's lineage, most recently updated first — one entry per change to quantity, billing term, price, or product.

Use this endpoint to see the individual records behind a subscription. GET /subscriptions/{subscriptionId} returns only the most recent record, so this is the way to look up a specific historical record.

Supply the original subscription ID — the id returned by GET /subscriptions or GET /subscriptions/{subscriptionId}. Unlike those endpoints, this one does not resolve the ID of a later record in the lineage.

get/subscriptions/{subscriptionId}/history

Request

  • Base URL
    https://api.pax8.com/v1
  • URL
    https://api.pax8.com/v1/subscriptions/{subscriptionId}/history
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://token-manager.pax8.com/oauth/token

Path parameters

subscriptionIdstring required
Example:04814f37-bef0-48b7-b388-c04a1e31f889

The original subscription ID for the lineage, as returned in the id field of a subscription response.

Response

successful operation

Example response

{
  "content": [
    {
      "price": 15.39,
      "currencyCode": "USD",
      "partnerCost": 11.39,
      "productName": "Microsoft Office 365 E3",
      "provisioningDetails": [
        {
          "key": "userEmailAddress",
          "description": "Provide the user's email address"
        }
      ],
      "commitmentTerm": {
        "term": "3-Year"
      }
    }
  ]
}

Changes

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