Commet
  • Pricing
Log InTry out
Add plan to group POSTCreate plan group POSTDelete plan group DELETEGet plan group GETList plan groups GETRemove plan from group DELETEReorder plans in group PUTUpdate plan group PUT
DocumentationKnowledge BaseBuild with AIAPI ReferenceWebhooks

Create plan group

Create a new plan group for organizing plans.

POST
/plan-groups

Create a new plan group for organizing plans.

Authorization

ApiKeyAuth
x-api-key<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string
description?string
isPublic?boolean

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/plan-groups" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'
{  "success": true,  "data": {    "id": "string",    "name": "string",    "description": "string",    "isPublic": true,    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "plans": [      {        "id": "string",        "name": "string",        "sortOrder": -9007199254740991      }    ],    "object": "plan_group",    "livemode": true  }}
{  "success": false,  "error": {    "type": "string",    "code": "string",    "message": "string",    "param": "string",    "details": null,    "doc_url": "string"  }}
{  "success": false,  "error": {    "type": "string",    "code": "string",    "message": "string",    "param": "string",    "details": null,    "doc_url": "string"  }}
{  "success": false,  "error": {    "type": "string",    "code": "string",    "message": "string",    "param": "string",    "details": null,    "doc_url": "string"  }}

Add plan to group POST

Add an existing plan to a plan group with optional sort order.

Delete plan group DELETE

Delete a plan group. Plans in the group are unlinked, not deleted.