Search the Aria Knowledgebase for
User Documentation, APIs, SDKs, and more!

 

Home > User Documentation > Processing Payments > Credits > Create a Service Credit

Create a Service Credit

Overview

Aria's service credits feature allows you to apply credits to a selection of plans and services and configure credits to expire after a specific period of time to limit their liability. If applied to multiple plans (both master plans and supplemental plans) and services, the credit may be allocated proportionately, based on the percentage of each applicable line item total, with respect to the total of all eligible charges.

The Proportional allocation of service credits parameter governs whether to proportionally allocate credits across all eligible service charges (including surcharge). This parameter is set to False by default, which means that credits apply to invoice line items FIFO (First In First Out), and not proportionately across all eligible service charges. The Proportional allocation of service credits parameter can be set by navigating to Configuration > Billing > Invoice Settings.

You can also assign multiple plans and services to a service credit and set an expiration date via the create_advanced_service_credit API.

Creating a Service Credit

Getting Here: Click Accounts > search for an account > Payments & Credits > Credits

  1. Click Create a New Credit.

The Create New Credit screen displays.

  1. Enter the Credit Amount that you want to issue to the customer.
  2. Select Service Credit from the Credit Type field.
  3. Select the reason why you are issuing the credit to the customer from the Credit Reason drop-down.
  4. Enter any additional information about the credit in the CSR Comments field (optional).
  5. Click the calendar icon next to the Initial Credit Date field to select the first date on which the first credit should be issued to the customer.

If you select Once for the Generation Frequency field, this will be the only date on which the credit is issued to the customer.

  1. Select one of the following options from the Expiration drop-down.
  • Months (from initial credit date):  A Maximum applicable months input field displays. Specify the number of months from the initial credit date after which the service credit should automatically expire. For example, if a service credit has an initial credit date of 12/15/2014, and you input a value of 2 (months), the service credit will automatically expire at the conclusion of the two month period and any unconsumed service credits will be canceled at 12AM on 2/15/2014. If 2/15/2014 happens to be the account's billing anniversary date, the service credit is applied to the invoice line items and then expired.

expiration (months)v2.png

  • Specific Date: A Credit Expiration Date input field displays. Provide an exact date after which the service credit should automatically expire (any unconsumed service credits will be canceled).

expiration (specific date)v2.png

A message under Recent Comments displays upon expiration of the service credits, notifying you of the expired credit amount, credit ID, and date of expiration.

Aria will automatically cancel any unconsumed service credits on an account upon meeting an expiration setting. Canceled service credits display in the UI and API responses with a canceled status. A nightly batch process automatically expires any unconsumed service credits on an account once their expiration dates pass.

  1. Select one of the following options from the When to Apply drop-down.
  • Against any charge: This option applies the credit to any charge generated for the customer.
  • Against specific plan(s) and/or service(s): A Plan field displays. At least one plan must be selected or you will receive an error when attempting to create the credit.
  1. Select a plan from the Plan drop-down.

A subset of the plan’s services populate under a Select Service(s) section.

  • To have the service credit apply proportionately across all services, keep the All Services check box (default) selected.
  • To have the service credit applied to one or more specific services, check all applicable services under the Select Service(s) section.
  1. Add another plan (optional) by clicking the Add Plan hyperlink.

You can remove a selected plan from this list at any time by changing the plan selection back to Select a Plan in the Plan drop-down.

when to applyv2.png

  • Against specific service type(s): An Eligible Service Types field displays. At least one service type must be selected or you will receive an error when attempting to create the credit.
  1. Select a service code to which the credit should be applied from the Service Code drop-down.

If you do not select a service code, the credit is applied to any service in the selected plan.

  1. Select one of the following options from the Generation Frequency field.
  • Once: This option generates a single credit for the customer. This single credit will remain in effect until it is fully consumed by future charges.
  • Multiple: This option generates multiple credits for the customer. When selecting this option, you are able to specify the number of credits and a time interval between credits.
    • Number of credits: Enter the number of times the credit should be applied to the customer's invoices.
    • Time between credits: Enter the number of months that should elapse between each time that the credit is applied to the customer's invoices.

                  

  1. Click Create Credit.

service credit screenv2.png

A confirmation screen displays.

  1. Confirm your entry, then click Create Credit.

The service credit will be applied to the customer's future invoices.

You must to post a comment.
Last modified
11:14, 31 May 2016

Tags

Classifications

This page has no classifications.