Knowledge Center

Knowledge Center > Billing and Payments > Invoices > Creating a Custom Invoice Template > Configure the Subscription or Rate Plan Summary Table

Configure the Subscription or Rate Plan Summary Table

The Subscription and Rate Plan Summary Tables display the metadata for subscriptions and rate plans, as well as the Subtotal, Tax, and Total. You can configure these tables to display one row per subscription or rate plan by specifying the ViewBy parameter. The Subtotal, Tax, and TOTAL will be rolled up accordingly.

Configuring Subscription Totals

Suppose one of your customers has two subscriptions, and two rate plans in each subscription. You can use the ViewBy table filter to show a total for each subscription. The field code is as follows:

{ MERGEFIELD "TableFilter:ViewBy Subscription" \* MERGEFORMAT }

Note that the table filter parameter is enclosed in quotation marks. When a parameter contains a space, you must enclose the parameter in quotation marks, otherwise it will not be processed correctly.

The table filter is shown in bold in the following template:

SUBSCRIPTION SUMMARY

Subscription Identifier

Subscription Detail

Subscription Term

Subtotal

Tax

TOTAL

«TableStart:Subscription» «TableFilter: ViewBy Subscription» «Subscription.SubscriptionNumber»

Subscription Notes:  «Subscription.Notes»

«Subscription.TermStartDate»

-

«Subscription.TermEndDate»

«Subscription.AmountWithoutTax»

«Subscription.TaxAmount»

«Subscription.ExtendedPrice» «TableEnd:Subscription»

The table will list one row per subscription on the invoice:

SUBSCRIPTION SUMMARY
Subscription Identifier Subscription Detail Subscription Term Subtotal Tax TOTAL

A-S00000010

Annual subscription for gold members.

01/01/2012

-

12/31/2012

$59.99

$0.00

$59.99

A-S00000011

Annual subscription for silver members.

01/01/2012

-

12/31/2012

$29.99

$0.00

$29.99

Configuring Rate Plan Totals

Suppose one of your customers has two subscriptions, and two rate plans in each subscription. You can use the ViewBy table filter to show a total for each rate plan. The field code is as follows:

{ MERGEFIELD "TableFilter:ViewBy RatePlan" \* MERGEFORMAT }

The table filter is shown in bold in the following template:

RATE PLAN SUMMARY
Subscription Identifier Rate Plan Name Subtotal Tax TOTAL

«TableStart:Subscription»«TableFilter: ViewBy RatePlan»«Subscription.SubscriptionNumber»

«Subscription.RatePlan.Name»

«Subscription.AmountWithoutTax»

«Subscription.TaxAmount»

«Subscription.ExtendedPrice»«TableEnd:Subscription»

The table will list one row per rate plan on the invoice:

RATE PLAN SUMMARY
Subscription Identifier Rate Plan Name Subtotal Tax TOTAL

A- S00000010

Data Plan

$39.99

$0.00

$39.99

A- S00000010

Cable Plan

$20.00

$0.00

$20.00

A- S00000011

Data Plan

$19.99

$0.00

$19.99

A- S00000011

Cable Plan

$10.00

$0.00

$10.00

Hiding Zero Value Rows

In both the Subscription and Rate Plan Summary tables, you have the option to hide zero dollar line items.

The HideZeroValueRows table filter will hide all the rows where the subscription or rate plan totals equal zero, by filtering out all rows where the Subscription.ExtendedPrice is 0. The field code is as follows:

{ MERGEFIELD TableFilter:HideZeroValueRows \* MERGEFORMAT }

To enable this option you must modify your current invoice template by including the tag <<TableFilter:HideZeroValueRows>>By default all rows including those where Subscription.ExtendedPrice is 0 are displayed, as the sample invoice template does not include the <<TableFilter:HideZeroValueRows>> tag.

In the following example the table will show one row per rate plan and hide all the rows where the Rate Plan Total is 0.

RATE PLAN SUMMARY
Subscription Identifier Rate Plan Name Subtotal Tax TOTAL

«TableStart:Subscription»«TableFilter: ViewBy RatePlan»«TableFilter:HideZeroValueRows»«Subscription.SubscriptionNumber»

«Subscription.RatePlan.Name»

«Subscription.AmountWithoutTax»

«Subscription.TaxAmount»

«Subscription.ExtendedPrice»«TableEnd:Subscription»

Instructions and a sample template are also available from within the Zuora application. Click your username at the top right and navigate to​​​​​ Billing Manage Invoice Rules and Templates.

Last modified
23:07, 3 Nov 2016

Tags

Classifications

(not set)