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

List plan groups

List plan groups with cursor-based pagination.

GET
/plan-groups

List plan groups with cursor-based pagination.

Authorization

ApiKeyAuth
x-api-key<token>

In: header

Query Parameters

limit?integer
cursor?string

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/plan-groups"
{  "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    }  ],  "hasMore": true,  "nextCursor": "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"  }}
{  "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"  }}

Get plan group GET

Retrieve a plan group by ID, including its plans ordered by sortOrder.

Remove plan from group DELETE

Remove a plan from a plan group.