PApax8
Subscriptions

List Subscriptions

Fetch a paginated list of subscriptions. Default page is 0 and default size is 10. The maximum page size is 200.

Each entry represents one subscription lineage, identified by its original subscription ID, and reflects the most recent record in that lineage. A subscription that has been modified therefore appears once, under its original ID — not once per change. Use GET /subscriptions/{subscriptionId}/history to see the individual records.

get/subscriptions

Request

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

Query parameters

pagenumber

The page number to request in the subscriptions list

sizenumber

Returns this number of subscriptions per page

sort'quantity,asc' | 'quantity,desc' | 'startDate,asc' | 'startDate,desc' | 'endDate,asc' | 'endDate,desc' | 'createdDate,asc' | 'createdDate,desc' | 'billingStart,asc' | 'billingStart,desc' | 'price,asc' | 'price,desc'

Return subscriptions sorted by this field and direction Formatted as fieldName,direction - ex. sort=createdDate,desc

status'Active' | 'Cancelled' | 'PendingManual' | 'PendingAutomated' | 'PendingCancel' | 'WaitingForDetails' | 'Trial' | 'Converted' | 'PendingActivation' | 'Activated'

Return only subscriptions matching this status value

billingTerm'Monthly' | 'Annual' | '2-Year' | '3-Year' | 'One-Time' | 'Trial' | 'Activation'

Return only subscriptions matching this billingTerm value

companyIdstring uuid
Example:f7fc273a-8d86-45c9-a26f-ffd42416adda

Return only subscriptions matching this companyId value

productIdstring uuid
Example:aaaee3f-262c-47a4-b0e6-f9ce8b54fcd7

Return only subscriptions matching this productId value

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"
      }
    }
  ],
  "page": {
    "size": 50,
    "totalElements": 237,
    "totalPages": 5,
    "number": 1
  }
}

Changes

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