Send Docs Feedback

Configure billing documents

Introduction

Before you generate billing documents, you need to provide some basic information such as the country in which you’re registered for tax purposes (this allows monetization to generate the applicable taxes on the documents), and the number of days to allow for payment after you issue an invoice. You can also set an approximate tax rate for each developer.

When the Apigee Edge configuration team initially sets up your organization profile, the team sets billing configuration options, such as billing cycle (pro-rated or calendar month), billing type (prepaid or postpaid, or both), and so on. After the profile is created, you can modify the billing configuration settings using the UI and API.

There are a subset of billing configuration options that can be set using the monetization API only, such as billing cycle (pro-rated or calendar month), billing type (pre-paid, post-paid, or both), and more.

The following sections describe how to configure billing documents and an approximate tax rate for developer using the UI and API:

For information about creating billing documents, see Create billing documents. When generating billing documents, you need to specify criteria that further configures the billing document. For example, you need to specify a billing month and year for the documents, and optionally, the types of rate plans to include in the billing documents. 

Understanding billing types

The billing type defines the developer payment model to be used for billing.

For the prepaid billing model, funds are deducted form the developer's balance at the time that the API product is used. The developer must maintain a prepaid balance sufficient to purchase the API product. In this case, you can manage prepaid account balances, as described in Manage prepaid account balances.

For the postpaid billing model, the developer is billed monthly (through an invoice) for the use of API products. The developer pays for the use of API products based on the payment terms set by the plan(s) included on the invoice. In this case, you need to set up your bank account information that will appear on billing invoices, as described in Add bank accounts.

You can configure the billing type to support both payment models.

When you create or edit developers and companies within your organization, you can specify the billing type to use as folllows:

If not specified, the billing type defaults to PREPAID for the developer or company.

You can configure the billing type(s) supported by your organization using the monetization API only, as described in Configuring billing documents in the API.

Configuring billing documents using the UI

Before you generate billing documents, you need to provide some basic information such as the country in which you’re registered for tax purposes (this allows monetization to generate the applicable taxes on the documents), and the number of days to allow for payment after you issue an invoice. You provide this information in the billing document configuration.

To set billing configuration options:

  1. On the Monetization tab, select Billing Document Configuration.

    This opens the Billing Document Configuration page.

  2. Select a tab in the Billing Document Configuration page:
  3. Click Edit to edit the fields in the tab.
  4. Repeat steps 2 and 3 for each tab in the Billing Document Configuration page.
  5. Click Save to save the configuration (or revert to return to the previous version, if any).

Configuring tax and document settings

Use the Tax and Document Setting tab to specify tax-related information, such as the country in which you are registered for tax purposes, as well as other billing document settings, such as whether you want self-billing invoices generated instead of revenue share statements.

To configure tax and document settings:

  1. Select the Tax and Document Setting tab on the Billing Document Configuration page.
  2. Click Edit and enter the following information:

     

    Field Description
    Tax Settings
    Tax Nexus

    The country in which you are registered for tax purposes. Select a country from the drop-down menu.

    If your tax nexus is the United States, you need to provide additional information on all the states where you are registered for tax purposes. You provide this information as part of a configuration questionnaire when you first purchase monetization.

    Tax Registration Number

    Your tax registration number or Value Added Tax (VAT) registration number, if applicable. This field is optional because the tax registration number or VAT registration number does not apply in all countries. The number you enter in this field is displayed at the bottom of the tax invoice.

    Document Setting for All Tax Models. This section applies only to billing for plans that involve revenue share, and for which the API provider uses either the disclosed, undisclosed, or disclosed hybrid tax models.
    Netting Statements

    Directs monetization to produce netting statements that show the net balances between invoices and revenue share statements.

    Two checkboxes are displayed in this section:

    • Generate a Netting Statement when creating Billing Documents. Select this to produce a netting statement when you create a billing document. By default, monetization converts the various currencies into your base currency when it generates netting statements.
    • Create one Netting Statement per currency. This checkbox is enabled only if you select "Generate a Netting Statement when creating Billing Documents". Select "Create one Netting Statement per currency" to generate a separate netting statement for each currency used.
    Revenue Share and Rate Card Plans

    This applies to only to revenue share and rate card plans. It directs monetization to generate separate invoices for fees charged for these plans. These pertain to any fees charged in addition to the plan rates.

    Select "Generate separate invoices for Revenue Share Fees and/or rate card fees" to generate separate invoices for these fees. If you make this selection:

    • For undisclosed tax models, the fees are charged on a separate invoice. (If you don’t select "Generate separate invoices for Revenue Share Fees and/or rate card fees", these fees are charged in the revenue share statement.)
    • For both disclosed and hybrid tax models, the fees are charged on a separate invoice and are grouped with any other rate card plans the API provider sets up.
    Document Settings for Undisclosed Tax Models. This section applies only to billing for plans that involve revenue share, and for which the API provider uses the undisclosed tax model.
    Self-Billing Invoices

    Directs monetization to generate a self-billing invoice instead of a revenue share statement. A self-billing invoice is a financial document that details the amount due to the developer. It acts as an invoice to the API Provider on behalf of the developer.

    Two checkboxes are displayed in this section:

    • Include Self-Billing Invoices. Select this to generate self-billing invoices instead of revenue share statements. By default, self-billing invoices are generated only for developers who have signed an agreement with the API provider. )
    • Include Self-Billing Invoices for all developers and partners. This checkbox is enabled only if you select “Include Self-Billing Invoices “. Select this checkbox to generate self-billing invoices for all developers and partners.
  3. Click Save to save the configuration (or revert to return to the previous version, if any).

Configuring the logo and address

Use the Documents Logo and Address tab to add a company logo and address for display in billing documents.

To configure the logo and address:

  1. Select the Documents Logo and Address tab in the Billing Document Configuration page.
  2. Click Edit, and enter the following information.

     

    Field Description
    Company Logo
    Logo URL

    The URL of your company logo.

  3. Click Save to save the configuration (or revert to return to the previous version, if any).

Configuring billing documents using the API

Billing documents are configured based on various properties in the organization profile (see Organization profile configuration settings for details). For example, the logo and address included in a billing document is based on the logoURL and address property settings in the organization profile. The billing document-related properties in the organization profile include:

  • Tax properties: taxNexus, taxRegNo
  • Tax document properties: issueNettingStmt, nettingStmtPerCurrency, seperateInvoiceForFees, hasSelfBilling, selfBillingForAllDev, selfBillingAsExchOrg
  • Payment schedule properties: billingCycle, billingType
  • Document logo and address properties: logoURL, address

See the Updating the organization profile and Organizing profile configuration settings for the API for details on how to update the properties.

Configuring an approximate tax rate for developers

When you create or edit developers within your organization, you can configure an approximate tax rate by setting the MINT_APPROX_TAX_RATE custom attribute using the Edge management UI or API. For more information, see Managing app developers and Create Developer, respectively.

Help or comments?