APappdirect
AppResellerAssignment

List subscription assignments

Changed on

Retrieves a list of assignments for a given subscription. You can filter the list using optional query parameters.

get/appReseller/v1/subscriptionAssignments

Request

Query parameters

numberinteger

Page number starting at 1. The default value is 1.

sizeinteger

Number of results per page. The default value is 50.

sortstring

Sort field and order. For ascending sort order, use the '+[FieldName]' format. For descending order, use '-[FieldName]' format. The default value is '-createdOn'.

createdOnstring

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

statusstring

Subscription status (valid values are PENDING_REQUIRED_DATA, PENDING_SEAT_AVAILABILITY, PENDING_USER_ACTIVATION, PENDING_REMOTE_CREATION, SUBSCRIPTION_SUSPENDED_FREE_TRIAL_EXPIRED, SUBSCRIPTION_SUSPENDED_RENEW_CONTRACT, SUBSCRIPTION_SUSPENDED_PAY_INVOICE, SUBSCRIPTION_SUSPENDED_MANUAL_SUSPENSION, FAILED, ACTIVE, PENDING_REMOTE_CANCELLATION, CANCELLED). The filter format is: in([status], ...).

subscriptionIdstring required

Subscription ID purchased by the Reseller company

userIdstring

User ID. Use the in([id], ...) format to filter by multiple IDs, or the userId=[id] format to filter by a single ID.

Response

Success

Example response

{
  "content": [
    {
      "id": "63bf81c2-8e01-48b7-a8b1-46a0efa0e823",
      "status": "ACTIVE",
      "createdOn": 1529083173000,
      "subscriptionId": "386626c0-53e2-4515-8450-4a720bb5d029",
      "user": {
        "id": "386626c0-53e2-4515-8450-4a720bb5d029",
        "firstName": "Michael",
        "lastName": "Jordan"
      }
    },
    {
      "id": "5cdf116b-0603-4d26-88d8-5e1afd625931",
      "status": "CANCELLED",
      "createdOn": 1527863555000,
      "subscriptionId": "386626c0-53e2-4515-8450-4a720bb5d029",
      "user": {
        "id": "bb14ace3-4490-47e8-84f1-ab6a85da69e5",
        "firstName": "Mary",
        "lastName": "Gonzalez"
      }
    }
  ],
  "page": {
    "size": 50,
    "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