1. Plans Management
  • Authentication
    • Current workspace and API key
      GET
  • Subscription
    • Current workspace subscription
      GET
    • Initiate subscription checkout
      POST
    • Change subscription plan
      POST
    • Cancel subscription at period end
      POST
    • Resume a scheduled cancellation
      POST
  • Channels
    • List enabled channels
      GET
  • Contacts
    • List contacts
      GET
    • Create a contact
      POST
    • View a contact
      GET
    • Update a contact
      PATCH
  • Conversations
    • List conversations
      GET
    • View a conversation
      GET
  • Messages
    • List conversation messages
      GET
    • Send a message
      POST
  • Leads
    • List leads
    • Create a lead
    • View a lead
    • Update a lead
  • Knowledge
    • List knowledge base entries
  • Platform
    • Public Plans
      • List commercially visible plans
      • Show one commercially visible plan
    • Plans Management
      • List all plans including inactive and soft-deleted
        GET
      • Create a plan
        POST
      • Show a plan for administration
        GET
      • Update a plan
        PATCH
    • Billing Webhooks
      • Receive a billing provider webhook
    • Channel Webhooks
      • Meta webhook verification challenge
      • Receive Meta messaging events
      • Receive Telegram bot updates
      • WhatsApp Business verification challenge
      • Receive WhatsApp Business messaging events
      • Receive WhatsApp Web inbound messages
    • Commerce Webhooks
      • Receive a WooCommerce webhook
  • Schemas
    • PublicPlan
    • Subscription
    • PublicPlanFeature
    • CheckoutRequest
    • PublicPlanLimit
    • CheckoutResponse
    • PlatformPlan
    • ChangePlanRequest
    • PlatformPlanCreateRequest
    • ApiKeyInfo
    • PlatformPlanUpdateRequest
    • Business
    • WebhookAcceptResponse
    • Channel
    • Error
    • Contact
    • ValidationError
    • ContactCreateRequest
    • ContactUpdateRequest
    • Conversation
    • Message
    • MessageCreateRequest
    • Lead
    • LeadCreateRequest
    • LeadUpdateRequest
    • KnowledgeBaseEntry
  1. Plans Management

List all plans including inactive and soft-deleted

GET
//api/v1/platform/plans
Platform super-admin catalog. Includes assignment counts.

Request

Authorization
API Key
Add parameter in cookie
replyable-session
Example:
replyable-session: ********************
or

Responses

🟢200PlatformPlanListResponse
application/json
Administrative plan list
Bodyapplication/json

🟠401Unauthenticated
🟠403Forbidden
🟠429TooManyRequests
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '//api/v1/platform/plans'
Response Response Example
200 - Example 1
{
    "data": [
        {
            "id": "string",
            "slug": "string",
            "name": "string",
            "description": "string",
            "is_active": true,
            "is_default": true,
            "sort_order": 0,
            "monthly_price": "string",
            "yearly_price": "string",
            "currency": "string",
            "trial_days": 0,
            "features": {
                "property1": true,
                "property2": true
            },
            "limits": {
                "property1": 0,
                "property2": 0
            },
            "metadata": {},
            "businesses_count": 0,
            "created_at": "2019-08-24T14:15:22.123Z",
            "updated_at": "2019-08-24T14:15:22.123Z",
            "deleted_at": "2019-08-24T14:15:22.123Z"
        }
    ]
}
Modified at 2026-08-18 22:33:35
Previous
Show one commercially visible plan
Next
Create a plan
Built with