Docs

Log in to read the version of docs relevant to your site, or use the dropdown versions

Invoice Notes

The Invoice Notes option lets you add additional contextual notes to the invoices, for better clarity.

Invoice Notes specific to each customer or subscription can be provided. You can also set them up at the Plan, Addon, or Coupon level to ensure they are included only when that specific item is part of the invoice.

You may also provide a general Invoice Note under Settings > Configure Chargebee > Invoices, credit notes and quotes, and the note will appear on all invoices.

Adding Invoice Notes

Invoice Notes can be added to the following resources (Customer, Subscription, Plan, Addon, and Coupon) in their corresponding details pages.

When an invoice is generated, the Invoice Notes present in the resources associated with the invoice will be retrieved and stored within the invoice. For example, during an invoice generation, if Invoice Notes are present for the customer, subscription, and plan associated with the invoice, then the invoice will display them (refer to the image below).

Note:

The notes added will not be reflected in previously generated invoices. They will only be added to upcoming invoices.

Editing/Deleting Invoice Notes

You can edit or delete the notes in the details page of the resources (Customer, Subscription, Plan, Addon, and Coupon). However, once the invoice has been generated, the notes stored within the invoice cannot be edited.

Viewing Invoice Notes

Invoice Notes will be part of both the HTML and PDF invoices sent to the customer.

When Invoice Notes are present for multiple entities (Plans, Addons, etc.) of an invoice, they will be displayed in the following order:

  • Plan
  • Addon
  • Coupon
  • Subscription
  • Customer
  • General Notes

Adding General Notes

If you would like to add a note that is general for all invoices, you can use the Invoice Notes option available under Settings > Configure Chargebee > Invoices, credit notes and quotes > Invoices tab. For example, if you want to add terms and conditions or a "Thank You" note, you can do so using this option.

Adding Invoice Notes via API

You can also add Invoice Notes using the API. This can be done using the Create & Update APIs of the desired resource.

  • Create operation: To add Invoice Notes while creating the resource.
  • Update operation:
    • To add Invoice Notes if not previously present.
    • To edit or delete the existing notes.

For example, Invoice Notes for a subscription can be passed with the Create a subscription API request. You can also use the Update a subscription API request to create Invoice Notes if not added via the Create subscription API. The existing Invoice Notes of a subscription can be edited or deleted using the Update subscription API request.

You can obtain the list of notes stored with an invoice from the notes attribute present under the invoice object.

Notes while Closing an Invoice

You can also add and remove existing notes while closing an invoice via API (metered billing). The list of parameters to configure this can be found in Close a Pending Invoice API.

Note:

You cannot edit or delete the Invoice Notes for Coupons via API, as there is no Update API available for Coupons.

Was this article helpful?