The Plans API allows you to query and mutate all information about your plans created in Plan Builder. The API is centred around the Plan object --
Field | Type | Description |
id | ID | The plan's unique identifier |
label | String | The plan's unique label or slug |
displayName | String | The plan's public, human-readable name |
product | ​Product​ | The product this plan is for |
cost | Int | The base cost of the plan without the addition of metered feature costs |
free | Boolean | Indicates whether this is a free plan |
published | Boolean | Indicates whether this plan is published |
​