Get The Features For A Plan
Overview
Returns the list of features and their key values for a specified plan
Endpoint
GET
https://api.salable.app/plans/{plan UUID}/features
Where {plan UUID} is the UUID for the specific plan. This can be copied from the products page of the dashboard.
Headers
Header Name | Description | Required | Value |
---|---|---|---|
x-api-key | Your API key, from the Salable Dashboard | string |
Sample Request
https://api.salable.app/plans/bd2b6575-2ca0-407a-94b5-1d9c19fd5fe0/features
x-api-key: "Your API Key"
Response
The response is an array of objects.
Element | Description | Type | Notes | ||
---|---|---|---|---|---|
planuuid | The UUID of the Plan | string | |||
featureUuid | The UUID of a feature assigned to the plan | string | |||
value | The value assigned to the feature for this plan | string | |||
enumValueUUID | If the feature has an Enum value this is the UUID | string | |||
isUnlimited | Identifies if the feature is set to unlimited | boolean | |||
updatedAt | Date and time the feature was last updated in ISO 8601 and Coordinated Universal Time (UTC) | string | The format is: YYYY-MM-DDThh: mm:ss.sssZ | ||
feature | The properties of this feature | array of objects | |||
uuid | The UUID of the Product | string | |||
name | The name given to the feature in the Salable Dashboard | string | |||
description | The description of the feature, for use in tooltips | string | |||
displayName | The display name for the feature definined in the Salable Dashboard | string | |||
variableName | The variable name assigned in the Salable Dashboard | string | |||
status | Indicates if the feature is currently active | string | Options are 'ACTIVE', 'DEPRECATED', or 'COMING_SOON' | ||
visibility | Identifies if the feature shown on pricing tables or not | string | Options are 'public' or 'private' | ||
valueType | Identifies the type of value the variable will have | string | Options are 'boolean', 'numerical', or 'enum' | ||
defaultValue | Identifies the default option for the feature | string | |||
showUnlimited | Identifies if the feature is set to unlimited | boolean | |||
productUuid | UUID of the product | string | |||
updatedAt | Date and time the feature was last updated in ISO 8601 and Coordinated Universal Time (UTC) | string | The format is: YYYY-MM-DDThh: mm:ss.sssZ | ||
featureEnumOptions | Lists the options for features with the Enum type | array of objects | |||
uuid | UUID of the option for the feature | string | |||
name | The description/name of the feature option given in the Salable Dashboard | string | |||
featureUuid | The UUID for the feature | string | |||
updatedAt | Date and time the value was last updated in ISO 8601 and Coordinated Universal Time (UTC) | string | The format is: YYYY-MM-DDThh: mm:ss.sssZ |
Sample Response
[
{
"planUuid": "bd2b6575-2ca0-407a-94b5-1d9c19fd5fe0",
"featureUuid": "2cf5f0f2-ea92-48f4-8b26-b1616cd2b7d2",
"value": "10",
"enumValueUuid": null,
"isUnlimited": false,
"updatedAt": "2022-07-28T09:53:03.732Z",
"feature": {
"uuid": "2cf5f0f2-ea92-48f4-8b26-b1616cd2b7d2",
"name": "thing 1",
"description": "nnnnn",
"displayName": "Thing 2",
"variableName": "thing_",
"status": "ACTIVE",
"visibility": "public",
"valueType": "numerical",
"defaultValue": "10",
"showUnlimited": false,
"productUuid": "e6d24c05-6ceb-46af-8168-2eea7f35e252",
"updatedAt": "2022-07-14T13:17:32.635Z"
},
"enumValue": null
},
{
"planUuid": "bd2b6575-2ca0-407a-94b5-1d9c19fd5fe0",
"featureUuid": "f419276d-d235-4c70-953b-13d85b73daec",
"value": "",
"enumValueUuid": "8cee857f-de91-4b7c-b400-2f0915cfde17",
"isUnlimited": false,
"updatedAt": "2022-07-28T09:53:03.732Z",
"feature": {
"uuid": "f419276d-d235-4c70-953b-13d85b73daec",
"name": "thing 2 ",
"description": "nnnmmkmkm",
"displayName": "2",
"variableName": "thing_2_",
"status": "ACTIVE",
"visibility": "public",
"valueType": "enum",
"defaultValue": "how long can this option be does it cause any issues at all?",
"showUnlimited": false,
"productUuid": "e6d24c05-6ceb-46af-8168-2eea7f35e252",
"updatedAt": "2022-07-14T13:18:26.895Z"
},
"enumValue": {
"uuid": "8cee857f-de91-4b7c-b400-2f0915cfde17",
"name": "how long can this option be does it cause any issues at all?",
"featureUuid": "f419276d-d235-4c70-953b-13d85b73daec",
"updatedAt": "2022-07-14T13:18:27.000Z"
}
}
]