PApaypal
Features

Update a feature

Updates an existing feature's properties including name, description, and privileges. The feature code itself cannot be changed. When updating privileges, the entire privileges array is replaced - to add or remove individual privileges, you must provide the complete desired list. Changes to features automatically propagate to all plans and subscriptions using them, though assigned values remain unchanged.

put/features/{feature_code}

Request

Path parameters

feature_codestring required

The unique identifier code of the feature. This is the code that was specified when the feature was created.

Request body

namestring

Name of the feature

descriptionstring

Description of the feature

Example request

{
  "name": "Number of seats",
  "description": "Number of users allowed in the account",
  "privileges": [
    {
      "code": "MAX-USERS",
      "name": "Maximum seats",
      "value_type": "INTEGER",
      "config": {
        "select_options": [
          "google",
          "okta",
          "azure"
        ]
      }
    }
  ]
}

Response

Feature was successfully updated with the new configuration

codestring required

Unique identifier for the feature across your entire system. This code is used when creating entitlements and should represent the feature's function (e.g., 'seats', 'api-access', 'API_STORAGE'). Allows alphanumeric characters, underscores, and hyphens.

namestring

Customer-facing name of the feature that clearly describes what functionality or capability it provides. This name appears in billing interfaces and customer portals.

descriptionstring

Detailed explanation of what this feature provides, its limitations, and how it affects the customer's experience.

created_atstring date-time required

Date and time in ISO 8601 format.

Example response

{
  "code": "USER-SEATS",
  "name": "Number of seats",
  "description": "Number of users allowed in the account",
  "privileges": [
    {
      "code": "MAX-USERS",
      "name": "Maximum seats",
      "value_type": "INTEGER",
      "config": {
        "select_options": [
          "google",
          "okta",
          "azure"
        ]
      }
    }
  ],
  "created_at": "2023-10-01T12:00:00Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.