APappdirect
AppResellerSubscription

List subscriptions

Changed on

Note: This endpoint is being deprecated. // Retrieves a list of all user subscriptions of a linked company. You can filter the list using optional query parameters.

get/appReseller/v1/subscriptions

Request

Query parameters

context'RESELLER, RESELLER_MANAGER' required

Supported billing contexts

numberinteger

Page number

sizeinteger

Number of results per page

sortstring

Sort field and order. For ascending sort order, use the '+[FieldName]' format. For descending order, use the '-[FieldName]' format.

userIdstring

For RESELLER, the customer's user ID; for RESELLER_MANAGER, the Reseller's user ID

resellerCompanyIdstring required

Reseller's company ID

customerCompanyIdstring required

User's company ID. Required only for RESELLER context

createdOnstring

Date filter, defined by upper or lower inclusive or exclusive limits, in Unix timestamp format. Acceptable values are: gte([timestamp]) - 'greater than or equal to'; gt([timestamp]) - 'greater than'; lte([timestamp]) - 'less than or equal to'; or lt([timestamp]) - 'less than.'

status'INITIALIZED' | 'FAILED' | 'FREE_TRIAL' | 'FREE_TRIAL_EXPIRED' | 'ACTIVE' | 'SUSPENDED' | 'CANCELLED'

Subscription status. Acceptable values are: [status] - 'equal to'; or in([status1],[status2]) - 'status in the list'. For example, status=FAILED or status=in(FAILED,ACTIVE)

paidStatus'PAID, FREE'

Status of the subscription related to the payment

pendingboolean

Indicates whether subscription has pending events

searchTextstring

Search text

Response

Success

Example response

{
  "content": [
    {
      "id": "386626c0-53e2-4515-8450-4a720bb5d029",
      "activeOrder": {
        "id": "1553",
        "status": "PENDING MANUAL RECOVERY",
        "frequency": "One Time",
        "totalFee": "USD350.00",
        "editionName": "Edition",
        "createdOn": 1529083173000
      },
      "company": {
        "id": "6b4bd452-895d-4098-aa56-e6046b238e0f",
        "name": "Company A"
      },
      "user": {
        "id": "386626c0-53e2-4515-8450-4a720bb5d029",
        "firstName": "Michael",
        "lastName": "Jordan"
      },
      "applicationName": "AUTO_DISCOUNTS_APP",
      "pendingEvent": "SUBSCRIPTION_CHANGE",
      "status": "ACTIVE"
    },
    {
      "id": "38e8bb4a-d737-4564-afee-e68edb00fd38",
      "activeOrder": {
        "id": "3345",
        "status": "PENDING MANUAL RECOVERY",
        "frequency": "One Time",
        "totalFee": "USD350.00",
        "editionName": "Recurring Edition",
        "createdOn": 1529083173000
      },
      "company": {
        "id": "698555fc-bc65-4163-9fee-16308edec41b",
        "name": "Company B"
      },
      "user": {
        "id": "698555fc-bc65-4163-9fee-16308edec41b",
        "firstName": "Michael",
        "lastName": "Jordan"
      },
      "applicationName": "AUTO_DISCOUNTS_APP",
      "pendingEvent": "SUBSCRIPTION_CHANGE",
      "status": "ACTIVE"
    }
  ],
  "page": {
    "size": 10,
    "totalElements": 2,
    "totalPages": 1,
    "number": 1
  }
}

Changes

  • 1fc240f06971Revision changes
    • breaking

      the response's body type changed from no type to object for status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status