Skip to content
MoltaroMoltaroMoltaro Docs

Return membership plans owned by the selected entitlement model.

GET
/api/workspace/entitlement-operations/models/membership/{modelId}/plans
curl --request GET \
  --url 'https://example.com/api/workspace/entitlement-operations/models/membership/example/plans?ConditionFamily=0&TermKind=0&TermUnit=0'

Authorizations

Section titled “Authorizations”
  • None

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
modelId
required
string

Query Parameters

Section titled “Query Parameters”
Search
string

Optional search text matched against plan key and display name.

IncludeInactive
boolean

Whether inactive plans should be included.

PlanFamilyIds
Array<string>

Optional model-scoped plan family ids that at least one assigned family must match.

ConditionFamily
integer format: int32
Allowed values: 0 1 2 3

Optional active plan condition family filter.

TermKind
integer format: int32
Allowed values: 0 1 2 3

Optional derived active plan term shape filter.

TermValue
integer format: int32

Optional duration/window value paired with TermKind.

TermUnit
integer format: int32
Allowed values: 0 1 2

Optional duration/window unit paired with TermKind.

RenewalPolicyId
string

Optional renewal policy id currently assigned to the plan.

Page
integer format: int32

One-based page number.

PageSize
integer format: int32

Requested page size.

access_token
string

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

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
Data

Paginated membership plan list response.

object
Items
Array<object>
nullable

Membership plan summary row.

object
Id
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
Id
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
RenewalPolicy

Renewal policy summary attached to a plan.

object
Id
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
TotalCount
integer format: int32
Page
integer format: int32
PageSize
integer format: int32
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": {
    "Items": [
      {
        "DurationUnit": 0,
        "GracePeriodUnit": 0,
        "RenewalPolicy": {
          "Mode": 0
        }
      }
    ]
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

403

Section titled “403”

Forbidden

Media typeapplication/json
object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
key
additional properties
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

404

Section titled “404”

Not Found

Media typeapplication/json
object
Data

Paginated membership plan list response.

object
Items
Array<object>
nullable

Membership plan summary row.

object
Id
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
Id
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
RenewalPolicy

Renewal policy summary attached to a plan.

object
Id
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
TotalCount
integer format: int32
Page
integer format: int32
PageSize
integer format: int32
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": {
    "Items": [
      {
        "DurationUnit": 0,
        "GracePeriodUnit": 0,
        "RenewalPolicy": {
          "Mode": 0
        }
      }
    ]
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}