Getting Started

Product Catalog

Customers

Subscriptions

Invoices, Credit Notes and Quotes

Taxes

Payments

Site Configuration

Data Privacy & Security

Data Operations

Reports and Analytics

Integrations

File Attachments & Comments 

File Attachments 

Introduction 

Adding relevant information to a record is always bound to come in handy. You can attach new files to an entity's record, which will serve the purpose of having every related information in one place.

The following are the entities where you can attach files:

  • Customer
  • Subscription
  • Invoice
  • Credit Note
  • Plan
  • Addon
  • Coupon

The files could be related to any of the above mentioned entities. Let's review some examples when file attachments can be used:

  • You've come to an agreement with a customer about the pricing for a plan. After you sign the agreement, the document can be uploaded against the respective customer's record.
  • Your customer is eligible for tax exemption and have shared the copy of the document with you. You can attach the document against the respective customer's record.
  • You allow your customers to make payments offline via cheque and want to maintain a record of the cheques you receive. By taking a scanned copy of the cheque, you can attach the file against the invoice generated.
Note

The files attached are not made available to your customers.

Attach a file 

To attach files, you need to navigate to the respective record in a module. The following example will show you how to upload a file to an existing plan in your Chargebee app:

  1. Navigate to Product Catalog > Plans and select a plan you want to upload the file to. Find the section called Comments & Attachments

  2. Clicking on Add Attachment will give you the option to drag and drop the file or browse for it. After selecting the file, you will get the option to add a description for the file and upload it.

  3. Clicking on Submit will upload the file. You will find the file under the plan you attached it to.

Note
  • The size limit for a single attachment is 5 MB.
  • You can attach up to 5 files per record.

Delete a file 

Files that were attached before can be deleted from the respective module.
Clicking the icon next to the file will take you through the deletion.

Comments 

You can add comments or small notes to some Chargebee entities. These comments are visible to all Chargebee users who can see the entity you have commented on. The following entities support comments:

  • Customers
  • Subscriptions
  • Invoices
  • Credit Notes
  • Plans
  • Addons
  • Coupons
Note

Comments are not visible to your customers.

Add a comment 

Follow these steps to add a comment to a Chargebee entity:

  1. Navigate to the details page of the entity.

  2. Scroll down to the last section titled Comments. Any existing comments are shown in this section.

  3. Click Add Comment.

  4. In the text box that appears, type in your comment or note. It can be a string up to 1000 characters long.

  5. Click Add, and the comment shows up on top of the list.

Delete a comment 

Follow these steps to delete a comment from a Chargebee entity:

  1. Navigate to the details page of the entity.
  2. Scroll down to the last section titled Comments. Any existing comments are shown in this section.
  3. Click on the bin icon next to the comment you want to delete.
  4. Click Delete on the confirmation dialog, and the comment is deleted from the list.

FAQ 

How do I add a description to a file that was attached to a record previously?

Navigate to the file you want to add a description for and click on the option that says ‘Add Description'.

Can I attach multiple files at once?

No, you will have to add files one-by-one.

Can comments be edited?

Comments in Chargebee cannot be edited. We recommend deleting a comment and adding a new one instead.

Was this article helpful?
Loading…