Reseller Get Expired Users API

Retrieve paginated list of expired users in reseller organization

Reseller

Reseller Get Expired Users API

Retrieve a paginated list of users with expired subscriptions. Identify users who need renewal or re-engagement.

Expired Users

Subscription ended.

Pagination

Page through results.

Re-engagement

Target for renewal.


Endpoint Overview

QUERY/graphql

Retrieve a paginated list of expired users within reseller's organization.

Authentication:Bearer Token
Required scopes:reseller

Request Parameters

pageInt

Page number for pagination (0-indexed).

sizeInt

Number of users per page.


GraphQL Query

query resellerGetExpiredUsers($page: Int, $size: Int) {
  resellerGetExpiredUsers(page: $page, size: $size) {
    totalElements
    size
    number
    content {
      id
      email
      username
      enabled
      createdAt
    }
  }
}

Variables:

{
  "page": 0,
  "size": 20
}

HTTP Request:

curl -X POST https://api.orbnet.com/graphql \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -d '{
    "query": "query resellerGetExpiredUsers($page: Int, $size: Int) { resellerGetExpiredUsers(page: $page, size: $size) { totalElements size number } }",
    "variables": { "page": 0, "size": 20 }
  }'

Response

200Expired Users Retrieved Successfully
{
  "data": {
    "resellerGetExpiredUsers": {
      "totalElements": 50,
      "size": 20,
      "number": 0
    }
  }
}

Response Fields

totalElementsInt!

Total number of expired users.

sizeInt!

Number of users per page.

numberInt!

Current page number (0-indexed).

content[User!]!

Array of expired user objects.



Subscription Renewal

Consider reaching out to expired users with renewal offers to retain customers.

Renew Subscriptions

Renew subscriptions for expired users.

Renew Subscription