Skip to content

Get All the Plans for a Specific Product

Overview

Returns the list of plans and their key values for a specified product

Endpoint

GET https://api.salable.app/products/{Product UUID}/plans

Where {product UUID} is the UUID for the specific product. 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/products/e6d24c05-6ceb-46af-8168-2eea7f35e252/plans

x-api-key: "Your API Key"

Response

Element Description Type Notes
uuid The UUID of the Plan string
name The name plan as shown in the Salable dashboard string
description The description of the plan, for use in tooltips string
displayName The plans display name for use in pricing tables string
status Current status of the plan string Options are ACTIVE or CANCELLED
trialDays Number of days left on their evaluation ?
evaluation This identifies if the plan has an evaluation period Boolean
evalDays ? integer
organization The UUID of your organization string
visibility Identifies if the plan shown on pricing tables or not string Options are 'public' or 'private'
licenseType The type of license string Options are 'Board','User', or 'Custom ID'
interval The unit for the interval length between payments string Options are 'day', 'month' or 'year'
length The number of interval units between payments integer
active returns if the plan is active or not Boolean
planType The type of plan the license is for string Options are 'Standard', 'Bespoke','Evaluation','Coming Soon'
pricingType Shows if the plan is paid of free string Option are 'paid' or 'free'
environment ? string
type identifies the app the plan is for string Options are 'Trello', 'Miro', or 'Custom'
paddlePlanId if Paddle is the payment provider returns the Paddle plan ID" string
productUuid UUID of the product the plan belongs to string
salablePlan ? Boolean
updatedAt Date and time the plan was last updated in ISO 8601 and Coordinated Universal Time (UTC) string The format is: YYYY-MM-DDThh: mm:ss.sssZ

Sample Response

[
    {
        "uuid": "c0b01797-63d5-433d-b9ef-808f4bff7fbc",
        "name": "Plan One",
        "description": "This is a basic paid plan",
        "displayName": "Display Name For Plan One",
        "status": "ACTIVE",
        "trialDays": null,
        "evaluation": false,
        "evalDays": 0,
        "organisation": "org_lSQANh7rD68mQ4Zx",
        "visibility": "public",
        "licenseType": "board",
        "interval": "month",
        "length": 1,
        "active": true,
        "planType": "Standard",
        "pricingType": "paid",
        "environment": "stg",
        "type": "trello",
        "paddlePlanId": null,
        "productUuid": "e6d24c05-6ceb-46af-8168-2eea7f35e252",
        "salablePlan": false,
        "updatedAt": "2022-08-18T14:11:13.925Z"
    },
    {
        "uuid": "e13628c7-04bf-4d9f-908c-39af73325a75",
        "name": "Plan Two",
        "description": "this is the top notch plan",
        "displayName": "Display Name of Plan Two",
        "status": "ACTIVE",
        "trialDays": null,
        "evaluation": true,
        "evalDays": 7,
        "organisation": "org_lSQANh7rD68mQ4Zx",
        "visibility": "public",
        "licenseType": "user",
        "interval": "month",
        "length": 2,
        "active": true,
        "planType": "Premium",
        "pricingType": "paid",
        "environment": "stg",
        "type": "trello",
        "paddlePlanId": null,
        "productUuid": "e6d24c05-6ceb-46af-8168-2eea7f35e252",
        "salablePlan": false,
        "updatedAt": "2022-08-18T14:13:12.530Z"
    }
]