Skip to content
EntitlerDocs

GET/v1/pricing/features

List the features on sale

Returns the features of the catalogue served on the default track, archived ones included. Needs catalogue:read.

curl 'https://api.entitler.co/v1/pricing/features' \
  -H "Authorization: Bearer $ENTITLER_KEY"

Credentials

Send any one of these:

  • Bearer token

Query parameters

NameTypeDescription
target.team_idstring
target.project_idstring
target.environment_idstring

Responses

200The ListFeaturesOnSaleResponse message.

ListFeaturesOnSaleResponse

  • featuresarray of Featurerequired
    • archivedbooleanrequired
    • idstringrequired
    • keystringrequired
    • kindFeatureKindrequired

      One of FEATURE_KIND_UNSPECIFIED, FEATURE_KIND_SWITCH, FEATURE_KIND_METERED, FEATURE_KIND_SETTING, FEATURE_KIND_GROUP.

    • versionFeatureVersion
      • changeIdstring
      • descriptionstringrequired
      • deviceLimitcommon.DeviceLimit
        • atLimitcommon.DeviceAtLimitrequired

          One of DEVICE_AT_LIMIT_UNSPECIFIED, DEVICE_AT_LIMIT_REFUSE, DEVICE_AT_LIMIT_END_OLDEST.

        • kindcommon.DeviceLimitKindrequired

          One of DEVICE_LIMIT_KIND_UNSPECIFIED, DEVICE_LIMIT_KIND_SIGNED_IN, DEVICE_LIMIT_KIND_IN_USE.

        • lockoutMinutesarray of integer (int64)required
        • lockoutQuietDaysinteger (int64)

          at least 0; at most 4294967295

      • innerWindowMeterWindow
        • anchorWindowAnchorrequired

          One of WINDOW_ANCHOR_UNSPECIFIED, WINDOW_ANCHOR_PERIOD, WINDOW_ANCHOR_CALENDAR.

        • countinteger (int64)required

          at least 0; at most 4294967295

        • unitWindowUnitrequired

          One of WINDOW_UNIT_UNSPECIFIED, WINDOW_UNIT_HOURS, WINDOW_UNIT_DAYS, WINDOW_UNIT_WEEKS, WINDOW_UNIT_MONTHS.

      • lateDaysinteger (int64)

        at least 0; at most 4294967295

      • limitsCustomerMembersbooleanrequired
      • measurecommon.Measure
        • decimalsinteger (int64)

          at least 0; at most 4294967295

        • moneycommon.Money
      • memberscommon.GroupValue
        • membersarray of common.GroupMemberrequired
          • benefitThousandthsinteger (int64)

            at least 0; at most 4294967295

          • featureKeystringrequired
          • groupcommon.GroupValue
          • meteredcommon.Limit
            • countinteger

              at least 0; at most 18446744073709552000

            • unlimitedcommon.Unlimited
          • moneycommon.MarketLimits
            • limitsarray of common.MarketLimitrequired
              • limitcommon.Limit
              • marketIdstringrequired
          • settingcommon.SettingValue
            • choicestring
            • numbercommon.Limit
              • countinteger

                at least 0; at most 18446744073709552000

              • unlimitedcommon.Unlimited
            • textstring
          • switchboolean
          • waitcommon.Wait
            • countinteger (int64)required

              at least 0; at most 4294967295

            • unitcommon.WaitUnitrequired

              One of WAIT_UNIT_UNSPECIFIED, WAIT_UNIT_DAYS, WAIT_UNIT_MONTHS.

      • namestringrequired
      • numberintegerrequired

        at least 0; at most 18446744073709552000

      • resetMeterReset
        • billingPeriodBillingPeriodReset
        • windowMeterWindow
          • anchorWindowAnchorrequired

            One of WINDOW_ANCHOR_UNSPECIFIED, WINDOW_ANCHOR_PERIOD, WINDOW_ANCHOR_CALENDAR.

          • countinteger (int64)required

            at least 0; at most 4294967295

          • unitWindowUnitrequired

            One of WINDOW_UNIT_UNSPECIFIED, WINDOW_UNIT_HOURS, WINDOW_UNIT_DAYS, WINDOW_UNIT_WEEKS, WINDOW_UNIT_MONTHS.

      • roundingRounding

        One of ROUNDING_UNSPECIFIED, ROUNDING_NEAREST, ROUNDING_UP, ROUNDING_DOWN.

      • settingcommon.SettingType
        • choicecommon.ChoiceSetting
          • optionsarray of common.SettingOptionrequired
            • keystringrequired
            • namestringrequired
        • numbercommon.NumberSetting
          • maxinteger

            at least 0; at most 18446744073709552000

          • mininteger

            at least 0; at most 18446744073709552000

        • textcommon.TextSetting
      • sharesLimitbooleanrequired
      • unitstringrequired
      • zonesarray of Zonerequired
        • keystringrequired
        • namestringrequired
  • servedServedCatalogue
    • changeIdstring
    • nothingNothingServed
    • releaseServedRelease
      • idstringrequired
      • numberintegerrequired

        at least 0; at most 18446744073709552000

    • trackServedTrack
      • idstringrequired
      • namestringrequired

ErrorA refusal, with the HTTP status of its gRPC code.

Error

  • errorobjectrequired
    • codestringrequired
    • parametersobjectrequired

      Each value: string

    • reasonstringor nullrequired