Approves a pending request and applies the requested plan (one transaction).

POST

/api/v1/provision/admin/plan-change-requests/{requestId}/approve

curl --request POST \
  --url https://example.com/api/v1/provision/admin/plan-change-requests/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/approve \
  --header 'Content-Type: application/json' \
  --data '{ "note": "example" }'

Parameters

Path Parameters

requestId

required

string format: uuid

The plan-change request.

Request Body

Optional note (e.g. a payment reference).

One of:

null

null

object

Approve/reject payload for a plan-change request decision.

object

note

null | string

0 <= 512 characters

Example^generated

{
  "note": "example"
}

One of:

null

null

object

Approve/reject payload for a plan-change request decision.

object

note

null | string

0 <= 512 characters

Example^generated

{
  "note": "example"
}

One of:

null

null

object

Approve/reject payload for a plan-change request decision.

object

note

null | string

0 <= 512 characters

Example^generated

{
  "note": "example"
}

Responses

200

OK

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

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"
}

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"
}

400

Bad Request

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"
}

404

Not Found

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"
}

409

Conflict

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"
}