# Replyable API Documentation ## API Docs - Authentication [Current workspace and API key](https://docs.replyable.ai/current-workspace-and-api-key-41994489e0.md): Returns the workspace business profile and the API key used for the request. - Subscription [Current workspace subscription](https://docs.replyable.ai/current-workspace-subscription-41994490e0.md): Returns the current subscription for the API key's workspace, if any. - Subscription [Initiate subscription checkout](https://docs.replyable.ai/initiate-subscription-checkout-41994491e0.md): Creates a hosted checkout session for the requested plan. Returns a `checkout_url` that the client - Subscription [Change subscription plan](https://docs.replyable.ai/change-subscription-plan-41994492e0.md): Immediately swaps `plan_id` on the current subscription via - Subscription [Cancel subscription at period end](https://docs.replyable.ai/cancel-subscription-at-period-end-41994493e0.md): Schedules cancellation at the end of the current billing period or trial. Does not perform destructive - Subscription [Resume a scheduled cancellation](https://docs.replyable.ai/resume-a-scheduled-cancellation-41994494e0.md): Workspace API resume undoes `cancel_at_period_end` on the *current* - Channels [List enabled channels](https://docs.replyable.ai/list-enabled-channels-41994495e0.md): Returns the enabled/configured channels for the workspace. - Contacts [List contacts](https://docs.replyable.ai/list-contacts-41994496e0.md): Returns workspace contacts with optional type filter, search, and pagination. - Contacts [Create a contact](https://docs.replyable.ai/create-a-contact-41994497e0.md): Creates a new contact in the workspace. At least one of name, email, or phone is required. - Contacts [View a contact](https://docs.replyable.ai/view-a-contact-41994498e0.md): - Contacts [Update a contact](https://docs.replyable.ai/update-a-contact-41994499e0.md): - Conversations [List conversations](https://docs.replyable.ai/list-conversations-41994500e0.md): - Conversations [View a conversation](https://docs.replyable.ai/view-a-conversation-41994501e0.md): - Messages [List conversation messages](https://docs.replyable.ai/list-conversation-messages-41994502e0.md): - Messages [Send a message](https://docs.replyable.ai/send-a-message-41994503e0.md): Sends a message into a workspace conversation. - Leads [List leads](https://docs.replyable.ai/list-leads-41994504e0.md): - Leads [Create a lead](https://docs.replyable.ai/create-a-lead-41994505e0.md): - Leads [View a lead](https://docs.replyable.ai/view-a-lead-41994506e0.md): - Leads [Update a lead](https://docs.replyable.ai/update-a-lead-41994507e0.md): - Knowledge [List knowledge base entries](https://docs.replyable.ai/list-knowledge-base-entries-41994508e0.md): - Platform > Public Plans [List commercially visible plans](https://docs.replyable.ai/list-commercially-visible-plans-41994233e0.md): Returns active, customer-facing plans from `PlanService::activeCommercialPlans()`. - Platform > Public Plans [Show one commercially visible plan](https://docs.replyable.ai/show-one-commercially-visible-plan-41994234e0.md): Resolves an active commercial plan by public id via - Platform > Plans Management [List all plans including inactive and soft-deleted](https://docs.replyable.ai/list-all-plans-including-inactive-and-soft-deleted-41994235e0.md): Platform super-admin catalog. Includes assignment counts. - Platform > Plans Management [Create a plan](https://docs.replyable.ai/create-a-plan-41994236e0.md): Creates a plan through `PlanService::createPlan()`. Requires a - Platform > Plans Management [Show a plan for administration](https://docs.replyable.ai/show-a-plan-for-administration-41994237e0.md): - Platform > Plans Management [Update a plan](https://docs.replyable.ai/update-a-plan-41994238e0.md): Updates commercial fields through `PlanService::updatePlan()`. - Platform > Billing Webhooks [Receive a billing provider webhook](https://docs.replyable.ai/receive-a-billing-provider-webhook-41994239e0.md): Provider-signed ingress. The raw body is verified before any billing - Platform > Channel Webhooks [Meta webhook verification challenge](https://docs.replyable.ai/meta-webhook-verification-challenge-41994240e0.md): - Platform > Channel Webhooks [Receive Meta messaging events](https://docs.replyable.ai/receive-meta-messaging-events-41994241e0.md): - Platform > Channel Webhooks [Receive Telegram bot updates](https://docs.replyable.ai/receive-telegram-bot-updates-41994242e0.md): - Platform > Channel Webhooks [WhatsApp Business verification challenge](https://docs.replyable.ai/whatsapp-business-verification-challenge-41994243e0.md): - Platform > Channel Webhooks [Receive WhatsApp Business messaging events](https://docs.replyable.ai/receive-whatsapp-business-messaging-events-41994244e0.md): - Platform > Channel Webhooks [Receive WhatsApp Web inbound messages](https://docs.replyable.ai/receive-whatsapp-web-inbound-messages-41994245e0.md): Authenticated with the companion shared secret, not a Platform Admin session. - Platform > Commerce Webhooks [Receive a WooCommerce webhook](https://docs.replyable.ai/receive-a-woocommerce-webhook-41994246e0.md): HMAC-verified against the connection webhook secret. Tenant is the connection's business. ## Schemas - [PublicPlan](https://docs.replyable.ai/publicplan-17122760d0.md): - [Subscription](https://docs.replyable.ai/subscription-17122997d0.md): - [PublicPlanFeature](https://docs.replyable.ai/publicplanfeature-17122761d0.md): - [CheckoutRequest](https://docs.replyable.ai/checkoutrequest-17122998d0.md): - [PublicPlanLimit](https://docs.replyable.ai/publicplanlimit-17122762d0.md): - [CheckoutResponse](https://docs.replyable.ai/checkoutresponse-17122999d0.md): - [PlatformPlan](https://docs.replyable.ai/platformplan-17122763d0.md): - [ChangePlanRequest](https://docs.replyable.ai/changeplanrequest-17123000d0.md): - [PlatformPlanCreateRequest](https://docs.replyable.ai/platformplancreaterequest-17122764d0.md): - [ApiKeyInfo](https://docs.replyable.ai/apikeyinfo-17123001d0.md): - [PlatformPlanUpdateRequest](https://docs.replyable.ai/platformplanupdaterequest-17122765d0.md): - [Business](https://docs.replyable.ai/business-17123002d0.md): - [WebhookAcceptResponse](https://docs.replyable.ai/webhookacceptresponse-17122766d0.md): - [Channel](https://docs.replyable.ai/channel-17123003d0.md): - [Error](https://docs.replyable.ai/error-17122767d0.md): - [Contact](https://docs.replyable.ai/contact-17123004d0.md): - [ValidationError](https://docs.replyable.ai/validationerror-17122768d0.md): - [ContactCreateRequest](https://docs.replyable.ai/contactcreaterequest-17123005d0.md): - [ContactUpdateRequest](https://docs.replyable.ai/contactupdaterequest-17123006d0.md): - [Conversation](https://docs.replyable.ai/conversation-17123007d0.md): - [Message](https://docs.replyable.ai/message-17123008d0.md): - [MessageCreateRequest](https://docs.replyable.ai/messagecreaterequest-17123009d0.md): - [Lead](https://docs.replyable.ai/lead-17123010d0.md): - [LeadCreateRequest](https://docs.replyable.ai/leadcreaterequest-17123011d0.md): - [LeadUpdateRequest](https://docs.replyable.ai/leadupdaterequest-17123012d0.md): - [KnowledgeBaseEntry](https://docs.replyable.ai/knowledgebaseentry-17123013d0.md):