1. Subscription
  • 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
      GET
  • Platform
    • Public Plans
      • List commercially visible plans
      • Show one commercially visible plan
    • 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. Subscription

Current workspace subscription

GET
//workspace/subscription
Returns the current subscription for the API key's workspace, if any.

Request

Authorization
Bearer Token
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
or

Responses

🟢200SubscriptionResponse
application/json
Subscription state
Bodyapplication/json

🟠401Unauthenticated
🟠403Forbidden
🟠404NotFound
🟠429TooManyRequests
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '//workspace/subscription' \
--header 'Authorization: Bearer <token>'
Response Response Example
200 - Example 1
{
    "data": {
        "id": "string",
        "status": "trialing",
        "plan": {
            "id": "string",
            "slug": "string",
            "name": "string"
        },
        "current_period_start": "2019-08-24T14:15:22.123Z",
        "current_period_end": "2019-08-24T14:15:22.123Z",
        "trial_ends_at": "2019-08-24T14:15:22.123Z",
        "cancel_at_period_end": true,
        "cancelled_at": "2019-08-24T14:15:22.123Z",
        "ended_at": "2019-08-24T14:15:22.123Z",
        "available_actions": [
            "change_plan"
        ]
    }
}
Modified at 2026-08-18 22:47:00
Previous
Current workspace and API key
Next
Initiate subscription checkout
Built with