Loading
Salesforce now sends email only from verified domains. Read More
Communications Cloud
Table of Contents
Filter by (0)Add
Select Filters

          No results
          No results
          Here are some search tips

          Check the spelling of your keywords.
          Use more general search terms.
          Select fewer filters to broaden your search.

            Search all of Salesforce Help
            Search all of Salesforce Help
            Customize the Billing and Usage Tab Components in Communications Service Console

            You are here:

            1. Salesforce Help
            2. Docs
            3. Communications Cloud

            Customize the Billing and Usage Tab Components in Communications Service Console

            Customize the FlexCards in the Billing and Usage tab to meet your business requirements.

            The Billing and Usage tab is built using FlexCards that use various Integration Procedures (IPs) to fetch and save the required data.

            Here's information about the FlexCards used in each section or subtab of the tab. You can customize the tab by adding or removing FlexCards or by modifying the IPs that are used as the data source by various FlexCards.

            Use this information to plan your tab customizations.

            Flexcard Data Source Required Input Sample Input Used In
            SFIBillingInquiryOverview sfi_GetOverviewData NA NA Overview subtab
            SFIBillingInquiryOverviewBalance sfi_GetOverviewData NA NA Billing Account Details section on the Overview subtab
            SFIBillingInquiryUsageDetailsContainer sfi_GetUsageConsumptionData NA NA Current Service Usage Details section on the Overview subtab
            SFIBillingInquiryUsageDetailsProgressBar sfi_GetUsageConsumptionData NA NA Current Service Usage Details section on the Overview subtab
            SFIBillingInquiryInvoiceoverview sfi_GetOverviewData NA NA Last Bill Details section on the Overview subtab
            SFIBillingInquiryPaymentOverview sfi_GetOverviewData NA NA Last Payment Details section on the Overview subtab
            SFIBillingInquiryUsageRecordsContainer sfi_GetUsageRecordsData

            Pagination attributes including offset and pageSize.

            		 
            {"offset":"0","usageStartDate":"03-26-2024","usageEndDate":"03-28-2024","usageMinimumCharge":"3","usageMaximumCharge":"10","usageType":"voice","usageStatus":"guided;rated","pagesize":"10"}
            		 Service Usage subtab
            SFIBillingInquiryUsageRecordsDataTable sfi_GetUsageRecordsData Pagination attributes including offset and pageSize, and totalRows. 
            {"offset":"0","usageStartDate":"03-26-2024","usageEndDate":"03-28-2024","usageMinimumCharge":"3","usageMaximumCharge":"10","usageType":"voice","usageStatus":"guided;rated","pagesize":"10"}
            		 Service Usage subtab
            SFIBillingInquiryInvoices sfi_GetInvoices NA NA Bills subtab
            SFIBillingInquiryPaymentsSummary sfi_GetPayments NA NA Payments subtab

            Customize the Current Service Usage Details Section on the Overview Subtab on the Billing and Usage Tab

            To customize the information in the Current Service Usage Details section, configure the sfi_GetUsageConsumptionData Integration Procedure.

            REQUIRED EDITIONS
            Available in: Lightning Experience
            Available in: Enterprise, Unlimited, and Developer Editions
            REQUIRED USER PERMISSIONS  
            To configure Omnistudio components: Omnistudio Admin

            This Integration Procedure uses the TM Forum 677 API to retrieve information about a billing account's service usage.

            Note
            Note When you configure the Integration Procedure, ensure that you adhere to the API specifications.
            1. Configure the request path that retrieves the real consumption data.
              1. In the sfi_GetUsageConsumptionData Integration Procedure, go to the TransformUsageConsumptionData section.
              2. Expand the SEND/RESPONSE TRANSFORMATIONS section.
              3. In Send JSON Path, replace the default value with your customized remote action.
              4. Save your changes.
            2. Configure the counter types associated with your usage plans.
              1. In the sfi_GetUsageConsumptionData Integration Procedure, go to the UsageConsumptionConfig section.
              2. In the Element Value Map section, add counter types as comma separated values.
                The default counter type is used.
                For example, you can set the counter types as sms and voice: "counterType": "sms,voice".
              3. Save your changes.
            3. Configure thresholds for your counter types.
              1. In the sfi_GetUsageConsumptionData Integration Procedure, go to the UsageConsumptionConfig section.
              2. Click Edit as JSON.
              3. Add your required objects, each with a threshold and a color node.
                With thresholds, you can provide your service agents with a visual representation of data.
                For example, green can suggest that the customer used less than 50% of the minutes allocated to them in their plan, and red can indicate that the customer exceeded their data plan limit.
                Here's the default configuration:
                "thresholds": [
    {
        "threshold": 74,
        "color": "#2E844A"
    },
    {
        "threshold": 99,
        "color": "#FCC003"
    },
    {
        "threshold": 100,
        "color": "#BA0517"
    }
]
              4. Save your changes.

            See Also

            Customize the Service Usage Subtab on the Billing and Usage Tab in Communications Service Console

            To customize the Service Usage subtab, configure the sfi_GetUsageRecordsData Integration Procedure.

            REQUIRED EDITIONS
            Available in: Lightning Experience
            Available in: Enterprise, Unlimited, and Developer Editions
            REQUIRED USER PERMISSIONS  
            To configure Omnistudio components: Omnistudio Admin

            This Integration Procedure uses the TM Forum 635 API to retrieve service usage records.

            Note
            Note When you configure the Integration Procedure, ensure that you adhere to the API specifications.
            1. Configure the request path that retrieves the service usage records.
              1. In the sfi_GetUsageRecordsData Integration Procedure, go to the TransformUsageRecordsData section.
              2. Expand the SEND/RESPONSE TRANSFORMATIONS section.
              3. In Send JSON Path, replace the default value with your customized remote action.
            2. Modify the mock TM Forum 635 API data.
              1. In the sfi_GetUsageRecordsData Integration Procedure, go to the UsageRecordsStub section.
              2. Expand the RESPONSE TRANSFORMATIONS section.
              3. In Response JSON Path, replace the default value with your customized remote action.
            3. Customize the maximum number of service usage records retrieved at a time.
              By default, 20 records are retrieved.
              1. In the sfi_GetUsageRecordsData Integration Procedure, go to the UsageRecordsResponse section.
              2. Expand the ADDITIONAL OUTPUT RESPONSE section.
              3. Update UsageRecordsCount with your custom API response count.

            See Also

            Customize Options for Your Service Agents to View and Download Bills

            Configure the SFIBillingInquiryInvoices Flexcard to customize file types for bills.

            REQUIRED EDITIONS
            Available in: Lightning Experience
            Available in: Enterprise, Unlimited, and Developer Editions
            REQUIRED USER PERMISSIONS  
            To configure Omnistudio components: Omnistudio Admin
            1. Update the commsBillingInquiryActionMenuItems Lightning Web Component (LWC) in the SFIBillingInquiryInvoices Flexcard:
              For information on how to edit Flexcards, see FlexCards Versioning and Cloning.
              1. Click the commsBillingInquiryActionMenuItems LWC.
              2. Click the Properties tab.
              3. In the Attributes section, update the value of the documentTypeMapping attribute.
                With the default configuration, your service agents can view and download bills in the PDF, CSV, HTML, and Text formats. 
                {
  "PDF": "application/pdf",
  "CSV": "text/csv",
  "HTML": "text/html",
  "Text": "text/plain"
}
            2. Save your changes.

            Your service agents can view and download bills in your customized formats.

             
            Loading
            Salesforce Help | Article