Skip to main content

SemaswiftDocs

Auth API
Billing API
Voice API
Ticketing API
Engagements API
Uploads API
Automation API
Notifications API
Reports API
Surveys API
CRM API

Introduction
ActivateChannel enables a communication channel for the organization.
CheckChannelQuota checks if organization can add more channels.
DeactivateChannel disables a channel license.
GetChannelByCode retrieves a single channel by its code.
GetChannelLicense retrieves a specific channel license.
GetChannelUsage returns usage statistics for a channel.
NOTE ON ORDERING: the literal-path RPCs below are declared BEFORE GetChannelLicense, whose path is /channels/{channel}. Kratos serves these through gorilla/mux, which matches in registration order and generates registrations in declaration order, so a wildcard declared first swallows every literal sibling that follows it. When these two sat after GetChannelLicense, /channels/licenses and /channels/quota both dispatched to GetChannelLicense with channel='licenses'/'quota' and failed for every caller. Keep literal paths above wildcard ones. ListChannelLicenses returns all channel licenses for the organization.
ListChannels returns all available communication channels.
UpdateChannelConfig modifies channel configuration.
ValidateChannelCodes validates a list of channel codes.
CalculateSeatCost calculates total cost for a seat with given channels.
GetChannelPricing retrieves pricing for a specific channel.
Declared before the {channel_code} wildcard sibling below: mux matches in registration order, and the generator emits registrations in declaration order, so a wildcard declared first swallows every literal after it. GetResolvedChannelPricing returns pricing for all channels resolved for the current organization.
ListChannelPricing returns pricing for all channels.
CheckFeatureAccess checks if organization has access to a feature.
GetFeature retrieves a feature by code.
GetPlanFeatures retrieves features for a specific plan.
ListFeatures retrieves all available features.
ListSubscriptionFeatures retrieves features for the current subscription.
PurchaseFeature purchases a feature as an add-on.
RecordFeatureUsage records usage of a feature.
DownloadInvoice generates and downloads invoice as PDF.
GetInvoice retrieves a specific invoice by ID.
IssueInvoice writes the invoice PreviewInvoice projects.
ListInvoices retrieves all invoices for the organization.
InvoiceService_PayInvoiceByMpesa
PayInvoiceByMpesa initiates an STK push for the invoice's amount due.
SendReminder sends payment reminder for unpaid invoice.
GetPayment retrieves a specific payment by ID.
ListPayments retrieves all payments for the organization.
GetPlan retrieves detailed information about a specific subscription plan.
ListPlans retrieves all available subscription plans.
AddChannelToSeat adds a channel to an existing seat.
CommitReservation finalizes a seat reservation after successful agent creation.
GetChannelSummary returns overview of channel usage across all seats.
GetSeatWithChannels retrieves a seat with its channel details.
ListSeatChannels lists channels enabled on a seat.
PurchaseSeatWithChannels creates a new seat with specified channels.
RemoveChannelFromSeat removes a channel from a seat.
ReserveSeatWithChannels creates a seat reservation with specific channels.
RollbackReservation cancels a seat reservation and refunds the wallet hold.
AddSubscriptionItem adds a new item to the subscription.
CancelSubscription cancels the organization's subscription.
ChangePlan changes the subscription to a different plan with proration.
CheckCapacity verifies if organization can add more of a resource.
CreateSubscription creates a new subscription for the organization.
GetSubscriptionEstimate returns estimated cost for the current billing period.
GetSubscriptionStatusInternal retrieves subscription status by organization ID.
GetSubscriptionStatus returns a simplified subscription status view.
GetSubscription retrieves the organization's current subscription details.
GetUsage retrieves subscription usage summary for a date range.
ListSubscriptionItems lists all items in the subscription.
ReactivateSubscription reactivates a cancelled subscription.
RemoveSubscriptionItem removes an item from the subscription.
UpdateBillingCycle changes the subscription billing cycle (monthly <-> yearly).
UpdateSubscriptionItem updates the quantity of a subscription item.
GetUsageSummary returns aggregated usage statistics.
ListUsageRecords returns detailed usage history.
RecordUsage logs a billable usage event.
GetAlertSettings retrieves low balance alert configuration.
GetWallet retrieves the organization's wallet balance and details.
ListTransactions retrieves wallet transaction history.
TopUp initiates a wallet top-up via M-Pesa STK push.
UpdateAlertSettings configures low balance alerts.

InvoiceService_PayInvoiceByMpesa

InvoiceService_PayInvoiceByMpesa

POST /api/v1/billing/invoices/:invoiceId/pay/mpesa

InvoiceService_PayInvoiceByMpesa

Request

Responses

200
default

A successful response.

An unexpected error response.

ListInvoices retrieves all invoices for the organization.

PayInvoiceByMpesa initiates an STK push for the invoice's amount due.

Documentation

Getting Started
Authentication
API Reference

API Services

Auth API
Billing API
Voice API
Ticketing API
Reports API
Notifications API
Surveys API
CRM API

More

Changelog
GitHub
Support

Copyright © 2026 Semaswift. All rights reserved.