Plans
Entitlements

List plan version entitlements

get/api/v1/plan-versions/{plan_version_id}/entitlements

Path parameters

plan_version_idstring MeteroidId required
Example:plv_7n42DGM5Tflk9n8mt7Fhc7

Plan version ID

Response

Resolved entitlements for this plan version

Example response

{
  "data": [
    {
      "feature": {
        "id": "feat_7n42DGM5Tflk9n8mt7Fhc7",
        "product": {
          "id": "prd_7n42DGM5Tflk9n8mt7Fhc7"
        }
      },
      "value": {
        "metric_id": "bm_7n42DGM5Tflk9n8mt7Fhc7"
      }
    }
  ]
}

Changes

Changed in 8 of the 54 revisions of this API.14112

  • v14e013b4e4a8f11See the full diff
    • added EntitlementProductRef to the data/items/feature/product response property oneOf list for the response status 200

      response-property-one-of-added

    • removed ProductRef from the data/items/feature/product response property oneOf list for the response status 200

      response-property-one-of-removed

    • added the required property data/items/feature/code to the response with the 200 status

      response-required-property-added

    • removed the required property data/items/origin from the response with the 200 status

      response-required-property-removed

    This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • v107a61fe347a511See the full diff
    • removed the required property data/items/value/oneOf[MeteredResolvedEntitlementValue]/overage_behavior from the response with the 200 status

      response-required-property-removed

    • removed the optional property data/items/value/oneOf[MeteredResolvedEntitlementValue]/warning_threshold_pct from the response with the 200 status

      response-optional-property-removed

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • v1ed86d893d43e54See the full diff
    • added BooleanResolvedEntitlementValue MeteredResolvedEntitlementValue to the data/items/value response property oneOf list for the response status 200

      response-property-one-of-added

    • removed the required property data/items/created_at from the response with the 200 status

      response-required-property-removed

    • removed the required property data/items/feature_id from the response with the 200 status

      response-required-property-removed

    • removed the required property data/items/id from the response with the 200 status

      response-required-property-removed

    • removed the required property data/items/updated_at from the response with the 200 status

      response-required-property-removed

    • added discriminator to data/items/value response property for the response status 200

      response-property-discriminator-added

    • removed subschema #1 subschema #2 from the data/items/value response property oneOf list for the response status 200

      response-property-one-of-removed

    • added the required property data/items/feature to the response with the 200 status

      response-required-property-added

    • added the required property data/items/origin to the response with the 200 status

      response-required-property-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • v1ac42ddd7b4b455See the full diff
    • the response property data/items/value/oneOf[subschema #2]/enabled became optional for the status 200

      response-property-became-optional

    • the response property data/items/value/oneOf[subschema #2]/reset_period became optional for the status 200

      response-property-became-optional

    • removed the required property data/items/feature from the response with the 200 status

      response-required-property-removed

    • removed the required property data/items/origin from the response with the 200 status

      response-required-property-removed

    • removed the required property data/items/value/oneOf[subschema #2]/metric_id from the response with the 200 status

      response-required-property-removed

    • api operation id list_plan_version_resolved_entitlements removed and replaced with list_plan_version_entitlements

      api-operation-id-removed

    • api tag Entitlements added

      api-tag-added

    • added the required property data/items/feature_id to the response with the 200 status

      response-required-property-added

    • added the required property data/items/id to the response with the 200 status

      response-required-property-added

    • added the required property data/items/updated_at to the response with the 200 status

      response-required-property-added

    This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • endpoint added

      endpoint-added

    • api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 274 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog