FRfrontegg
Plans (Formerly Bundles)

Create Plan

Create a new plan

post/resources/plans/v1

Request

Request body

namestring required

String that represents the plan name

defaultTreatment'true' | 'false'

Enum that represents the default treatment

descriptionstring

Feature plan description

metadatastring

JSON String

defaultTimeLimitationnumber

Number that represents the default time limitation in days for auto-assigned plans

assignOnSignupboolean

Boolean indicating whether a plan is assigned automatically upon signup

Example request

{
  "name": "Test Plan",
  "defaultTreatment": "true",
  "rules": [
    {
      "description": "This is the first rule",
      "conditionLogic": "and",
      "conditions": [
        {
          "attribute": "myCustomAttribute",
          "attributeType": "custom",
          "op": "in_list",
          "value": {
            "list": [
              "valueA",
              "valueB"
            ]
          }
        }
      ],
      "treatment": "true"
    }
  ],
  "description": "This is a test plan",
  "metadata": "{ \"some-key\": \"some-value\" }"
}

Response

idstring required

UUID string that represents the plan ID

vendorIdstring required

UUID string that represents the vendor ID

namestring required

String that represents the plan name

defaultTreatment'true' | 'false'

Enum that represents the default treatment

descriptionstring

Feature plan description

metadataobject

JSON String

defaultTimeLimitationnumber

Number that represents the default time limitation in days for auto-assigned plans

assignOnSignupboolean required

Boolean indicating whether a plan is assigned automatically upon signup

createdAtstring required

Date when plan was created

updatedAtstring

Date when plan was last updated

Example response

{
  "id": "e6a5012c-cbeb-4c1e-ab80-e5f43efd44e3",
  "vendorId": "e6a5012c-cbeb-4c1e-ab80-e5f43efd44e3",
  "name": "Test Plan",
  "defaultTreatment": "true",
  "rules": [
    {
      "description": "This is the first rule",
      "conditionLogic": "and",
      "conditions": [
        {
          "attribute": "myCustomAttribute",
          "attributeType": "custom",
          "op": "in_list",
          "value": {
            "list": [
              "valueA",
              "valueB"
            ]
          }
        }
      ],
      "treatment": "true"
    }
  ],
  "description": "This is a test plan",
  "createdAt": "2022-01-01T00:00:00",
  "updatedAt": "2022-01-01T00:00:00",
  "features": {
    "id": "e6a5012c-cbeb-4c1e-ab80-e5f43efd44e3",
    "name": "Test Feature",
    "key": "test-feature",
    "permissions": [
      "permission.read",
      "permission.write"
    ]
  },
  "entitlements": {
    "id": "e6a5012c-cbeb-4c1e-ab80-e5f43efd44e3",
    "name": "Test Feature",
    "key": "test-feature",
    "permissions": [
      "permission.read",
      "permission.write"
    ]
  }
}

Changes

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