1. Public Plans
  • 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
      GET
    • Create a lead
      POST
    • View a lead
      GET
    • Update a lead
      PATCH
  • Knowledge
    • List knowledge base entries
  • Platform
    • Public Plans
      • List commercially visible plans
        GET
      • Show one commercially visible plan
        GET
    • Plans Management
      • List all plans including inactive and soft-deleted
      • Create a plan
      • Show a plan for administration
      • Update a plan
    • 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. Public Plans

Show one commercially visible plan

GET
//api/v1/plans/{plan}
Resolves an active commercial plan by public id via
PlanService::findActiveCommercialPlan(). Inactive, hidden, or
unknown identifiers return 404 — they are not distinguished from
missing plans.

Request

Path Params

Responses

🟢200PublicPlanResponse
application/json
One commercially visible plan
Headers

Bodyapplication/json

🟠404NotFound
🟠429TooManyRequests
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '//api/v1/plans/'
Response Response Example
200 - Example 1
{
    "data": {
        "id": "string",
        "slug": "string",
        "name": "string",
        "description": "string",
        "currency": "string",
        "monthly_price": "string",
        "yearly_price": "string",
        "trial_days": 0,
        "is_default": true,
        "sort_order": 0,
        "features": [
            {
                "key": "string",
                "enabled": true,
                "label": "string"
            }
        ],
        "limits": [
            {
                "key": "string",
                "value": 0,
                "unlimited": true,
                "label": "string"
            }
        ]
    }
}
Modified at 2026-08-18 22:33:35
Previous
List commercially visible plans
Next
List all plans including inactive and soft-deleted
Built with