Lists plan-change requests, newest first.

GET

/api/v1/provision/admin/plan-change-requests

curl --request GET \
  --url 'https://example.com/api/v1/provision/admin/plan-change-requests?status=Pending'

Parameters

Query Parameters

status

Decision state of a consumer plan-change request.

Allowed values: Pending Approved Rejected

Optional status filter (Pending / Approved / Rejected).

entitlementId

string format: uuid

Optional entitlement filter.

Responses

200

OK

Array<object>

A plan-change request and its decision state.

object

id

string format: uuid

entitlementId

string format: uuid

currentPlanName

null | string

requestedPlanName

string

requestedAt

string format: date-time

requesterEmail

The requester’s notification email (their own address; empty for pure device activations).

null | string

status

Decision state of a consumer plan-change request.

Allowed values: Pending Approved Rejected

applied

True when the requested plan is active (the request was approved and applied).

boolean

reviewedBy

null | string

reviewedAt

null | string format: date-time

reviewNote

null | string

Array<object>

A plan-change request and its decision state.

object

id

string format: uuid

entitlementId

string format: uuid

currentPlanName

null | string

requestedPlanName

string

requestedAt

string format: date-time

requesterEmail

The requester’s notification email (their own address; empty for pure device activations).

null | string

status

Decision state of a consumer plan-change request.

Allowed values: Pending Approved Rejected

applied

True when the requested plan is active (the request was approved and applied).

boolean

reviewedBy

null | string

reviewedAt

null | string format: date-time

reviewNote

null | string

Example

[
  {
    "status": "Pending"
  }
]

Array<object>

A plan-change request and its decision state.

object

id

string format: uuid

entitlementId

string format: uuid

currentPlanName

null | string

requestedPlanName

string

requestedAt

string format: date-time

requesterEmail

The requester’s notification email (their own address; empty for pure device activations).

null | string

status

Decision state of a consumer plan-change request.

Allowed values: Pending Approved Rejected

applied

True when the requested plan is active (the request was approved and applied).

boolean

reviewedBy

null | string

reviewedAt

null | string format: date-time

reviewNote

null | string

Example

[
  {
    "status": "Pending"
  }
]

401

Unauthorized

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

403

Forbidden

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}