Update a membership plan.

PUT

/api/workspace/entitlement-operations/models/membership/{modelId}/plans/{planId}

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Put,
    RequestUri = new Uri("https://example.com/api/workspace/entitlement-operations/models/membership/example/plans/example"),
    Content = new StringContent("{ \"Key\": \"example\", \"DisplayName\": \"example\", \"Description\": \"example\", \"PriceAmount\": 1, \"PriceCurrencyCode\": \"example\", \"IsActive\": true, \"DurationValue\": 1, \"DurationUnit\": 0, \"GracePeriodValue\": 1, \"GracePeriodUnit\": 0, \"Resources\": [ { \"EntityDefinitionId\": \"example\", \"ResourceEntityInstanceId\": \"example\", \"SortOrder\": 1 } ], \"RowVersion\": \"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0\", \"MaxCoveredPartyCount\": 1, \"RenewalPolicyId\": \"example\", \"PlanFamilyIds\": [ \"example\" ] }")
    {
        Headers =
        {
            ContentType = new MediaTypeHeaderValue("application/json")
        }
    }
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

const url = 'https://example.com/api/workspace/entitlement-operations/models/membership/example/plans/example';
const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json'},
  body: '{"Key":"example","DisplayName":"example","Description":"example","PriceAmount":1,"PriceCurrencyCode":"example","IsActive":true,"DurationValue":1,"DurationUnit":0,"GracePeriodValue":1,"GracePeriodUnit":0,"Resources":[{"EntityDefinitionId":"example","ResourceEntityInstanceId":"example","SortOrder":1}],"RowVersion":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","MaxCoveredPartyCount":1,"RenewalPolicyId":"example","PlanFamilyIds":["example"]}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request PUT \
  --url https://example.com/api/workspace/entitlement-operations/models/membership/example/plans/example \
  --header 'Content-Type: application/json' \
  --data '{ "Key": "example", "DisplayName": "example", "Description": "example", "PriceAmount": 1, "PriceCurrencyCode": "example", "IsActive": true, "DurationValue": 1, "DurationUnit": 0, "GracePeriodValue": 1, "GracePeriodUnit": 0, "Resources": [ { "EntityDefinitionId": "example", "ResourceEntityInstanceId": "example", "SortOrder": 1 } ], "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "MaxCoveredPartyCount": 1, "RenewalPolicyId": "example", "PlanFamilyIds": [ "example" ] }'

Authorizations

None

Parameters

Path Parameters

modelId

required

string

planId

required

string

Query Parameters

access_token

string

Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.

Request Body

Update a membership plan with membership duration terms.

object

Key

Optional stable plan key. The server generates one when omitted.

string

nullable

DisplayName

required

Plan display name.

string

Description

Optional plan description.

string

nullable

PriceAmount

Optional commercial display price. It is metadata only.

number format: double

nullable

PriceCurrencyCode

Optional three-letter currency code for the commercial display price.

string

nullable

IsActive

Whether this plan can be used for new grants.

boolean

DurationValue

Optional membership duration length.

integer format: int32

nullable

DurationUnit

integer format: int32

Allowed values: 0 1 2

GracePeriodValue

Optional grace period length.

integer format: int32

nullable

GracePeriodUnit

integer format: int32

Allowed values: 0 1 2

Resources

Concrete membership resources selected for this plan.

Array<object>

nullable

Resource selected for a plan.

object

EntityDefinitionId

required

Entity definition of the selected resource instance.

string

ResourceEntityInstanceId

required

Selected runtime EntityInstance id.

string

SortOrder

Display order.

integer format: int32

RowVersion

required

Required concurrency token from the current plan.

string format: uuid

MaxCoveredPartyCount

Optional explicit covered-party limit for delegated explicit Organization/Family models.

integer format: int32

nullable

RenewalPolicyId

Optional default renewal policy used by new grants from this plan.

string

nullable

PlanFamilyIds

Optional plan family ids assigned to this plan.

Array<string>

nullable

Responses

200

application/json

object

Data

Detailed membership plan.

object

string

nullable

Key

string

nullable

DisplayName

string

nullable

EntitlementModelId

string

nullable

EntitlementModelDisplayName

string

nullable

Description

string

nullable

PriceAmount

number format: double

nullable

PriceCurrencyCode

string

nullable

MaxCoveredPartyCount

integer format: int32

nullable

SortOrder

integer format: int32

IsActive

boolean

ResourceCount

integer format: int32

Families

Array<object>

nullable

Plan family reference attached to a plan or exposed for plan authoring.

object

string

nullable

Key

string

nullable

DisplayName

string

nullable

Description

string

nullable

SortOrder

integer format: int32

IsActive

boolean

DurationValue

integer format: int32

nullable

DurationUnit

integer format: int32

Allowed values: 0 1 2

GracePeriodValue

integer format: int32

nullable

GracePeriodUnit

integer format: int32

Allowed values: 0 1 2

Resources

Array<object>

nullable

Resource attached to a plan.

object

string

nullable

EntityDefinitionId

string

nullable

EntityDisplayName

string

nullable

ResourceEntityInstanceId

string

nullable

DisplayName

string

nullable

Breadcrumbs

Array<object>

nullable

One breadcrumb item for a selected plan resource.

object

EntityDefinitionId

string

nullable

EntityDisplayName

string

nullable

ResourceEntityInstanceId

string

nullable

DisplayName

string

nullable

SortOrder

integer format: int32

RowVersion

string format: uuid

RenewalPolicy

Renewal policy summary attached to a plan.

object

string

nullable

Key

string

nullable

DisplayName

string

nullable

Mode

integer format: int32

Allowed values: 0 1 2

LeadDays

integer format: int32

nullable

ExternalPolicyKey

string

nullable

RowVersion

string format: uuid

Errors

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

boolean

Example

{
  "Data": {
    "DurationUnit": 0,
    "GracePeriodUnit": 0,
    "RenewalPolicy": {
      "Mode": 0
    }
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

400

Bad Request

application/json

object

Data

Detailed membership plan.

object

string

nullable

Key

string

nullable

DisplayName

string

nullable

EntitlementModelId

string

nullable

EntitlementModelDisplayName

string

nullable

Description

string

nullable

PriceAmount

number format: double

nullable

PriceCurrencyCode

string

nullable

MaxCoveredPartyCount

integer format: int32

nullable

SortOrder

integer format: int32

IsActive

boolean

ResourceCount

integer format: int32

Families

Array<object>

nullable

Plan family reference attached to a plan or exposed for plan authoring.

object

string

nullable

Key

string

nullable

DisplayName

string

nullable

Description

string

nullable

SortOrder

integer format: int32

IsActive

boolean

DurationValue

integer format: int32

nullable

DurationUnit

integer format: int32

Allowed values: 0 1 2

GracePeriodValue

integer format: int32

nullable

GracePeriodUnit

integer format: int32

Allowed values: 0 1 2

Resources

Array<object>

nullable

Resource attached to a plan.

object

string

nullable

EntityDefinitionId

string

nullable

EntityDisplayName

string

nullable

ResourceEntityInstanceId

string

nullable

DisplayName

string

nullable

Breadcrumbs

Array<object>

nullable

One breadcrumb item for a selected plan resource.

object

EntityDefinitionId

string

nullable

EntityDisplayName

string

nullable

ResourceEntityInstanceId

string

nullable

DisplayName

string

nullable

SortOrder

integer format: int32

RowVersion

string format: uuid

RenewalPolicy

Renewal policy summary attached to a plan.

object

string

nullable

Key

string

nullable

DisplayName

string

nullable

Mode

integer format: int32

Allowed values: 0 1 2

LeadDays

integer format: int32

nullable

ExternalPolicyKey

string

nullable

RowVersion

string format: uuid

Errors

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

boolean

Example

{
  "Data": {
    "DurationUnit": 0,
    "GracePeriodUnit": 0,
    "RenewalPolicy": {
      "Mode": 0
    }
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

403

Forbidden

application/json

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

key

additional properties

Example^generated

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

404

Not Found

application/json

object

Data

Detailed membership plan.

object

string

nullable

Key

string

nullable

DisplayName

string

nullable

EntitlementModelId

string

nullable

EntitlementModelDisplayName

string

nullable

Description

string

nullable

PriceAmount

number format: double

nullable

PriceCurrencyCode

string

nullable

MaxCoveredPartyCount

integer format: int32

nullable

SortOrder

integer format: int32

IsActive

boolean

ResourceCount

integer format: int32

Families

Array<object>

nullable

Plan family reference attached to a plan or exposed for plan authoring.

object

string

nullable

Key

string

nullable

DisplayName

string

nullable

Description

string

nullable

SortOrder

integer format: int32

IsActive

boolean

DurationValue

integer format: int32

nullable

DurationUnit

integer format: int32

Allowed values: 0 1 2

GracePeriodValue

integer format: int32

nullable

GracePeriodUnit

integer format: int32

Allowed values: 0 1 2

Resources

Array<object>

nullable

Resource attached to a plan.

object

string

nullable

EntityDefinitionId

string

nullable

EntityDisplayName

string

nullable

ResourceEntityInstanceId

string

nullable

DisplayName

string

nullable

Breadcrumbs

Array<object>

nullable

One breadcrumb item for a selected plan resource.

object

EntityDefinitionId

string

nullable

EntityDisplayName

string

nullable

ResourceEntityInstanceId

string

nullable

DisplayName

string

nullable

SortOrder

integer format: int32

RowVersion

string format: uuid

RenewalPolicy

Renewal policy summary attached to a plan.

object

string

nullable

Key

string

nullable

DisplayName

string

nullable

Mode

integer format: int32

Allowed values: 0 1 2

LeadDays

integer format: int32

nullable

ExternalPolicyKey

string

nullable

RowVersion

string format: uuid

Errors

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

boolean

Example

{
  "Data": {
    "DurationUnit": 0,
    "GracePeriodUnit": 0,
    "RenewalPolicy": {
      "Mode": 0
    }
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

409

Conflict

application/json

object

Data

Detailed membership plan.

object

string

nullable

Key

string

nullable

DisplayName

string

nullable

EntitlementModelId

string

nullable

EntitlementModelDisplayName

string

nullable

Description

string

nullable

PriceAmount

number format: double

nullable

PriceCurrencyCode

string

nullable

MaxCoveredPartyCount

integer format: int32

nullable

SortOrder

integer format: int32

IsActive

boolean

ResourceCount

integer format: int32

Families

Array<object>

nullable

Plan family reference attached to a plan or exposed for plan authoring.

object

string

nullable

Key

string

nullable

DisplayName

string

nullable

Description

string

nullable

SortOrder

integer format: int32

IsActive

boolean

DurationValue

integer format: int32

nullable

DurationUnit

integer format: int32

Allowed values: 0 1 2

GracePeriodValue

integer format: int32

nullable

GracePeriodUnit

integer format: int32

Allowed values: 0 1 2

Resources

Array<object>

nullable

Resource attached to a plan.

object

string

nullable

EntityDefinitionId

string

nullable

EntityDisplayName

string

nullable

ResourceEntityInstanceId

string

nullable

DisplayName

string

nullable

Breadcrumbs

Array<object>

nullable

One breadcrumb item for a selected plan resource.

object

EntityDefinitionId

string

nullable

EntityDisplayName

string

nullable

ResourceEntityInstanceId

string

nullable

DisplayName

string

nullable

SortOrder

integer format: int32

RowVersion

string format: uuid

RenewalPolicy

Renewal policy summary attached to a plan.

object

string

nullable

Key

string

nullable

DisplayName

string

nullable

Mode

integer format: int32

Allowed values: 0 1 2

LeadDays

integer format: int32

nullable

ExternalPolicyKey

string

nullable

RowVersion

string format: uuid

Errors

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

boolean

Example

{
  "Data": {
    "DurationUnit": 0,
    "GracePeriodUnit": 0,
    "RenewalPolicy": {
      "Mode": 0
    }
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

Update a membership plan.

Authorizations

Parameters

Path Parameters

Query Parameters

Request Body

Responses

200

Example

400

Example

403

Examplegenerated

404

Example

409

Example

Example^generated