The OnApp Billing service module integrates with your OnApp platform to bill your clients for their monthly usage. Once your OnApp usage service renews, your client’s usage stats and the total amount due for the previous period is calculated. The OnApp usage pricing and total due each month is determined by OnApp. Ubersmith simply retrieves the details for billing.


The OnApp Billing service module only integrates with the OnApp platform up to version 5.5. If you are using OnApp beyond version 5.5 or are integrating with OnApp for the first time, use the OnApp Billing Plugin.


In order to begin billing for this service, you need to configure Ubersmith. Once all the necessary pieces have been configured, any current or new service based on the service plan will be ready. The configuration steps are as follows:

  1. Create a generic OnApp billing service plan.
  2. Add the OnApp Billing service module to your service plan.
  3. Configure the service module (below).
  4. Create an OnApp billing service.
  5. Configure the service plan (below).
  6. Configure the service (below).


Configuring the Service Module

  1. In the OnApp Hostname field, type your OnApp host name.
  2. In the OnApp Username field, type your OnApp user name.
  3. In the OnApp Password field, type your OnApp password.
  4. In the Request Timeout field, type your desired timeout in seconds. Using zero results in no timeout and is not recommended, because it can result in daily invoice runs being blocked if your OnApp host is unreachable.

  5. In the Show breakdown on invoice field, select Yes if you want to include the billing details sent from OnApp on your client’s invoice.

  6. Click Save or Save & New. 

Configuring the Service Plan

The service plan can be configured in numerous ways depending on what OnApp services you offer. There are four different billing method options available in Ubersmith, VM resources only, all resources, vCloud resource pool, and CDN resource ID. If you primarily use only one of the four, such as only virtual machines, select that one. Alternatively, you could set up four different service plans, one for each billing method.

  1. Access the Service Plans Details page.
  2. In the Pricing & Period Defaults section, click edit.

    The Edit Service Plan page appears.
  3. In the Post Renew field, select Yes to bill at the end of the service period.
  4. Click Update.
  5. In the Custom Fields Defaults section, click edit.

    The Edit Service Plan page appears.

  6. In the OnApp Billing section, for the OnApp Billing Method select one of the following. 


  7. Ensure each OnApp Billing Applicable field is set to either Yes or Required.
  8. Click Update.

Configuring the Service

Before configuring your client’s individual services, ensure you have configured the service plan (above) these services are based on first.

  1. Access the Service Details page.
  2. In the Custom Fields Defaults section, click edit.

    The Edit Service page appears.

  3. In the OnApp Billing section, select one of the following. 

    • In the OnApp ID field, enter the client’s corresponding OnApp ID to be used for the service.
    • In the OnApp Billing Method field, select the service’s billing method. See Configuring the Service Plan (above) for more information on each method.


  4. Click Save.


On this page:


Related Topics 

Configuring the OnApp Billing Plugin






Document Stage
Audience
Author
Reviewer
Created Date
Updated Date
Version
Links
Graphics