Skip to main content
GET
List license renewal batches
Returns renewal batches: a group is one renewal run covering several licence requests, with a shared status and payment. Use List License Requests for the individual requests inside a batch.

Query Parameters

page
number
default:1

1-based page number

Required range: x >= 1
Example:

1

limit
number
default:50

Page size (max 100)

Required range: 1 <= x <= 100
Example:

50

downstreamEntityId
string

Narrow the results to a single entity in your organization. Defaults to your whole subtree (your entity plus every branch beneath it). Returns 404 if the id is not in your subtree.

Example:

"6610b3d2c2e0a51b8c0d1f02"

status
enum<string>

Batch status

Available options:
processing,
submitting,
pending input,
submitted,
partially submitted,
completed,
failed,
cancelled,
pending review,
in progress
Example:

"submitted"

Response

A page of renewal batches

data
object
required
requestId
string
required

Unique request identifier

Example:

"dev-2c5e7cf2-9acf-4c8c-ab2f-b81f39d775a8"

timestamp
string
required

Response timestamp

Example:

"2025-11-12T20:49:03.293Z"