GetEntitlementPlan

GET

/api/v1/provision/consumer/me/entitlements/{entitlementId}/plan

curl --request GET \
  --url https://example.com/api/v1/provision/consumer/me/entitlements/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/plan

Parameters

Path Parameters

entitlementId

required

string format: uuid

Responses

200

OK

The plan context for an entitlement or session: what is applied, and what is available.

object

entitlementId

string format: uuid

assignedPlanName

null | string

appliedPlan

One of:

null

null

object

A plan a consumer can see or switch to.

object

id

string format: uuid

name

string

description

string

availablePlans

Array<object>

A plan a consumer can see or switch to.

object

id

string format: uuid

name

string

description

string

The plan context for an entitlement or session: what is applied, and what is available.

object

entitlementId

string format: uuid

assignedPlanName

null | string

appliedPlan

One of:

null

null

object

A plan a consumer can see or switch to.

object

id

string format: uuid

name

string

description

string

availablePlans

Array<object>

A plan a consumer can see or switch to.

object

id

string format: uuid

name

string

description

string

Example^generated

{
  "entitlementId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "assignedPlanName": "example",
  "appliedPlan": {
    "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "name": "example",
    "description": "example"
  },
  "availablePlans": [
    {
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "name": "example",
      "description": "example"
    }
  ]
}

The plan context for an entitlement or session: what is applied, and what is available.

object

entitlementId

string format: uuid

assignedPlanName

null | string

appliedPlan

One of:

null

null

object

A plan a consumer can see or switch to.

object

id

string format: uuid

name

string

description

string

availablePlans

Array<object>

A plan a consumer can see or switch to.

object

id

string format: uuid

name

string

description

string

Example^generated

{
  "entitlementId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "assignedPlanName": "example",
  "appliedPlan": {
    "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "name": "example",
    "description": "example"
  },
  "availablePlans": [
    {
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "name": "example",
      "description": "example"
    }
  ]
}

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

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