Getting Started

Building Blocks

Subscription Features

Localization

Invoices

Credits

Billing Features

Taxes

Payment Methods

Direct Debit Payments

Configuring Gateways

Fraud Management

Hosted Pages

Attach Additional Data

Migration

Open Source Resources

Other Features

API Integration

Third Party Integrations

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. It can also be set up at a Plan, Addon, or Coupon level, to ensure they are included only when that specific item is part of the Invoice.

You may also provide default Invoice Notes under SettingsSite SettingsCustomize Invoice & Credit Note and they 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. It can either be plain text or HTML content.

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 the previously generated invoices. It will only be added to the 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 that have been 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, it will be displayed in following order:

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

Adding Default Notes 

If you would like to add a note that is general for all invoices, you could use the Invoice Notes option available under SettingsSite SettingsCustomize Invoice & Credit Note. For example, if you would like to add terms and conditions or a "Thank You" note, you could do so using this option.

Adding Invoice Notes via API 

You could also add Invoice Notes using 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 could also use the Update a subscription  API request to create Invoice Notes if not added via Create a subscription API. The existing Invoice Notes of a subscription can be edited or deleted using the Update a subscription API request.

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

Note

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

Loading…