Configure Bill Cycle Notifications

With the Action Framework (refer to Action Framework), you can configure notifications to trigger every time the bill cycle status changes to Paused or Resumed. This alerts you to know when the external fees and documents can be added to the invoice.

Complete the following steps to set up the notifications:

Select Rating & Billing from the application menu , then click Billing Management in the left pane.
Locate the Bill Cycles section.

Bill Cycles Section
Click the name of the bill cycle you wish to configure to open the Bill Cycle Details window.

Bill Cycle Details Window
On the Bill Cycle Details window, scroll down to the Actions section and click Bill Cycle Run Action to open the Action Configuration window.

Bill Cycle Run Actions Section

On the Action Configuration window, complete the required and relevant information in each section:

Action Configuration for Bill Cycle Run Action Window

Action Details — Click the Edit button to open the Configure Action Details window, and complete required and relevant information. When finished with the configuration, click Finish to save your changes.

Action Configuration for Bill Cycle Run Action Window

Required fields are marked with an asterisk.
- Friendly Name*: Enter the name for the bill cycle action.
- Enable Action: Select this checkbox to enable the action.
- Description: Enter additional information about the action.
Approval Operations — Click the Edit button to open the Configure Required Approvals window, and complete required and relevant information. Click Finish to save your changes.

Configure Required Approvals for Bill Cycle Run Action Window

Required fields are marked with an asterisk.
- Enabled: Select to require approvals of the action.
- Allow Schedule: Select to allow scheduling actions.
- Schedule (Days): Select the number of days when the bill cycle run approves automatically if it has not been approved manually.
HTTP Request Operations — Click the Edit button to open the Configure HTTP Request window, and complete required and relevant information. When finished with the configuration, click Finish to save your changes.

Configure HTTP Request for Bill Cycle Run Actions

Required fields are marked with an asterisk.
- HTTP Request Type: Select a type from the drop-down list.
  - Webhook - Status Change: This type has fewer configuration requirements, and allows you to configure multiple triggers within a single notification request. When you select this option, the additional Triggers field displays. To set up notifications for adding external charges, complete the required and relevant fields:
    
    Webhook Status Change HTTP Request Type Configuration
    - Triggers*: Select either the Inclusive or Exclusive radio button.Then select the bill cycle statuses for which you can configure notifications: Paused or Resumed. Refer toNotification Management Module.
    - External Application*: Select an option from the drop-down list, if available.
    - URL*: The URL of the website to access.
    - Content Type*: Select the content type for the Payload, such as application/json or text/plain. You can enter up to 255 characters.
    - Date Format*: Select the necessary date format such as MM/DD/YYYY.
    - Add New Header Name/Value: Click this button to display two additional fields, which can be used to add extra content to the header.
      
      If you have added too many Name/Value fields, you can click the Remove Last Header Name/Value button to remove the last set of Name and Value fields.
      - Name*: The header’s name.
      - Value*: The value to be included in the header.
    - Payload: Specifies the payload for the defined HTTP Method that should match the structure of the expected request body and the Content Type. Select parameters from the list under Palette on the right to compose the required request body.
      
      You can highlight a palette item and then drag it to the Payload text box.
  - User Defined: Provides more flexibility by allowing you to configure more fields for your notifications such as associated URL, HTTP Method, Date Format, Content Type, and Payload settings.
    
    User Defined HTTP Request Type Configuration
    - Trigger: Select an option for when emails should be sent.
    - Step Trigger: Select Include External Charges to include external charges. Or select one of the other options if you do not need to include external charges.
    - External Application*: Select an option from the drop-down list, if available.
    - URL*: The URL of the website to access.
    - Content Type*: Select the content type for the Payload, such as application/json or text/plain. You can enter up to 255 characters.
    - Date Format*: Select the necessary date format such as MM/DD/YYYY.
    - Add New Header Name/Value: Click this button to display two additional fields, which can be used to add extra content to the header.
      
      If you have added too many Name/Value fields, you can click the Remove Last Header Name/Value button to remove the last set of Name and Value fields.
      - Name*: The header’s name.
      - Value*: The value to be included in the header.
    - Payload: Specifies the payload for the defined HTTP Method that should match the structure of the expected request body and the Content Type. Select parameters from the list under Palette on the right to compose the required request body.
      
      You can highlight a palette item and then drag it to the Payload text box.
Email Operations — Click the Add button to add a new email operation, or click Edit in the Actions column to change an existing email operation. When finished with the configuration, click Finish to save your changes.

Configure Email for Bill Cycle Run Actions Window

Required fields are marked with an asterisk.

Existing email operations that were configured with certain Trigger and Trigger Step combinations may not be valid anymore. These operations are displayed, but they are not enabled and not editable.
- Triggers*: Select either Inclusive, to send notifications when the triggers that you select occur; or Exclusive, to send notifications when all triggers except the ones that you select occur. The Inclusive option is selected by default. Next, select the bill cycle triggers. You can select multiple triggers by holding the Shift or CTRL key.
- Email Template*: Select an email template. For information about customizing an email template or creating your own, refer to Notification Templates.
- Recipient Email*: Enter the customer email address to which the notification will be sent, if you are not using the account email address.
- BCC: Enter the email address to which a blind carbon copy will be sent. This email address will be hidden from other recipients.

Topic updated: 09/2024.