Get billing details

Object describing the limits associated with the current service plan. The values are integers, or null. Either external_messages_day or external_messages_period is included depending on the organization's billing mode (per-day vs. per-plan-period messaging quota). Each key:

• contacts: Stored contacts — The maximum number of contacts stored in your contact database at any time. Each contact can have a name, phone number, and up to 100 custom fields, and can be added to groups. By default, a contact is automatically created for each phone number you communicate with, as long as there is space in your contact database. Automatic contact creation can be disabled in the project settings if you don't need to store contacts. You can send messages to an unlimited number of different phone numbers if you don't store them in your contact database.
• phones: Routes — The maximum number of different routes that your organization uses to send or receive messages through Telerivet, including Android phones, virtual numbers, alphanumeric sender IDs, SMS shortcodes, and integrations with chat apps like WhatsApp. On service plans that support multiple routes, you can distribute messages among different routes for higher volume, geographic reach, or better rates.
• active_services: Active automated services — The number of automated services that run in response to certain events, such as when a new message is received, when a message's status changes, or when triggered by a user. Common types of automations like polls and auto-replies can be created from built-in templates. Custom actions can be created using a drag-and-drop flow builder, JavaScript, or a webhook.
• users: User logins — The maximum number of user accounts you can add for people in your organization to log in and use Telerivet. Each user account can have its own permissions.
• stored_messages: Stored messages — The total number of messages stored in your Telerivet account, including scheduled messages. You can delete old or unneeded messages to stay under this limit.
• service_invocations_day: Daily service invocations — The maximum number of times automated services can run per day, excluding Webhook API services. This includes service rules triggered by incoming messages, scheduled triggers, and manual invocations. The counter resets at midnight in your organization's timezone.
• api_requests_day: Daily API requests — The maximum number of API requests your organization can make per day, counting both REST API and Webhook API requests. The quota resets daily at midnight in the organization's time zone. If you pay Telerivet directly for each message, REST API requests to send messages, and Webhook API requests to receive notifications of incoming messages and delivery reports, are exempt from this limit.
• projects: Projects — Each project represents an independent mobile messaging system. Each project has its own messages, contacts, routes, and services, and its own set of user permissions. If necessary, you can add multiple projects under one organization and one billing plan.
• data_rows: Rows in custom data tables — Custom data tables are used to store responses to polls and other automated services. You can also import your own data to build data-driven automations.
• script_module_mb: Cloud Script module storage quota (MB) — Storage quota for Cloud Script modules — code modules that you push to Telerivet to run as part of automated services. Measured as the total size of all module files across the organization.
• stored_file_mb: File storage quota (MB) — Storage quota for files uploaded to Telerivet, including media attachments sent or received in messages.
• custom_actions: Custom actions per service — The maximum number of custom actions or conditions allowed per automated service. Custom actions extend services with logic written in a drag-and-drop flow builder, JavaScript, or webhooks. Plans with the Advanced Automation feature have no per-service limit.
• groups: Contact groups — The maximum number of contact groups. Groups are used to organize contacts and to send messages to many recipients at once.
• custom_contact_fields: Custom contact fields — The maximum number of custom fields that can be defined for contacts. Custom fields store extra information about contacts beyond the built-in name and phone number — for example, an account ID, language preference, or any project-specific attribute.
• external_messages_day: Included Messages/Day - Bring Your Own Connectivity — The maximum number of messages that can be sent or received per day when using your own connectivity provider or an Android phone with the Telerivet Gateway app (not when paying Telerivet for each message). The counter resets at midnight in your organization's timezone. This limit applies when the plan's billing mode has a per-day messaging quota.
• external_messages_period: Included Messages/Plan Period - Bring Your Own Connectivity — The maximum number of messages that can be sent or received per plan period (typically monthly or yearly) when using your own connectivity provider or an Android phone with the Telerivet Gateway app (not when paying Telerivet for each message). This limit applies when the plan has a per-plan-period messaging quota. Each sent or received SMS message part, voice call, USSD session, chat app message, or MMS message is counted as one message; multi-part SMS messages are counted based on the number of SMS parts in the message.
• ai_chat_credits_day: AI chat credits/day

Object describing which platform features are enabled for this organization. The keys are string feature IDs and the values are booleans. Available features:

• direct_connectivity: Direct Connectivity — Use Telerivet-managed phone routes where Telerivet handles billing with upstream messaging gateways on your behalf, instead of requiring you to bring your own gateway credentials.
• airtime_transfer: Airtime Topup & Transfer — Send airtime to prepaid mobile phones as a reward or participation incentive, or top-up the airtime on your own SIM card directly from Telerivet. (Requires Pro plan or above)
• click_tracking: Click Tracking — Shorten links and track which contacts clicked a link in your message.
• custom_gateway: Custom Gateways — Integrate with an SMS shortcode or another gateway API. Telerivet can integrate with both HTTP or SMPP messaging APIs, and can configure VPN connections directly with mobile networks if necessary. (Integration fee varies depending on API - contact us)
• custom_logo: Custom Logo — Replace the Telerivet logo in the web app with your own logo. (Requires Pro plan or above)
• custom_domain: Custom Domain Name — Access your Telerivet account from your own domain name like sms.example.com, and hide Telerivet branding from users. Configure a custom domain for branded short links. (Contact us for pricing)
• soft_limits: Soft Limits — Allow exceeding your plan's daily, monthly, or annual limits by paying for extra messages, API requests, or service invocations.
• auto_resend: Automatic Message Resend & Failover — Configure custom rules to automatically resend failed messages and failover between routes. (Requires plan with Advanced custom automation)
• export_storage: Cloud Data Export — Automatically export and backup messages, contacts, and other data to the cloud. Connect your own Amazon Web Services S3 account for data storage. (Requires plan with Advanced custom automation)
• static_ip_address: Static IP Address — Configure Telerivet to use a static IP address for outbound HTTP requests if you need to allow inbound traffic from specific IP addresses in your firewall. (Requires plan with Advanced custom automation)
• script_modules: Cloud Script Modules — Run Cloud Script API code from an external codebase hosted on GitHub, or push code to Telerivet directly from your development environment. Use source control to track version history. (Requires plan with Advanced custom automation)
• service_templates: Service Templates — Create reusable automated services that can be shared with multiple projects and organizations. (Contact us for pricing)
• single_sign_on: SAML Single Sign-On — Allow users to log in via your organization's single sign-on identity provider (SAML 2.0). (Contact us for pricing)
• contact_sync: Contact Data Sync — Synchronize contact information and opt-out status across multiple Telerivet projects. (Requires Growth plan or above)
• external_airtime_providers: External Airtime Providers — Configure airtime providers in your projects using your own credentials with an external airtime provider, in addition to (or instead of) Telerivet-managed airtime.
• wire_payments: Wire Payments — Pay Telerivet invoices via bank wire transfer in addition to credit card and other online payment methods.
• custom_dashboards: Custom Dashboards — Create custom dashboards with charts and metrics showing Telerivet usage and providing business intelligence about the results of your campaigns. (Requires Pro plan or above)
• branded_short_links: Branded Short Links — Configure a custom domain name for short links, instead of using the default domain (rvt.me). (Requires Growth plan or above)
• custom_solutions: Custom Solution Development — Work with Telerivet's professional services team to implement a custom solution for your business needs. (Contact us for pricing)

Per-unit overage rates billed when usage exceeds the corresponding plan limit. Only present when the soft_limits feature is enabled in plan_features — without soft_limits, reaching a limit blocks further usage until the counter resets rather than accruing per-unit charges, so the rates would not apply and the field is omitted entirely. When present, each entry is an object with amount and currency properties, where amount is the positive per-unit cost in currency, or null if no rate is configured. Keys:

• message: Cost per external (bring your own connectivity) message sent or received beyond the daily limit (plan_limits.external_messages_day) or per-period limit (plan_limits.external_messages_period).
• api_request: Cost per REST API request beyond plan_limits.api_requests_day.
• service_invocation: Cost per automated-service invocation beyond plan_limits.service_invocations_day.

Object mapping each plan_limits key to the current integer usage count for that metric — present only when the request was made with usage=true. Includes either external_messages_day or external_messages_period (matching whichever the organization's billing mode produces in plan_limits), not both. Reset schedules and the per-service custom_actions semantics described on getUsage apply here as well.