PApaypal
Features

Create a feature

Creates a new feature that represents a capability or functionality that can be entitled to customers. Features are the building blocks of your entitlement system - they define what can be granted to customers and what aspects can be configured. Each feature can have multiple privileges that allow fine-grained control over its behavior (e.g., a 'seats' feature might have 'max' and 'max_admins' privileges). Once created, features can be assigned to plans with specific privilege values.

post/features

Request

Request body

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.

Example request

{
  "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"
        ]
      }
    }
  ]
}

Response

Feature was successfully created and is now available for use in plan entitlements

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.