Credit Notes

A Credit Note is a document that specifies the money owed by a business to its customer. The seller usually issues a Credit Note for the same or lower amount than the invoice, and then repays the money to the customer or set it off against other 'due' invoices.

Chargebee supports two types of Credit Notes - Adjustment Credit Note and Refundable Credit Note.

  1. Adjustment Credit Notes are created for the 'unpaid' component of the invoice and it can have statuses - Adjusted and Voided.

  2. Refundable Credit Notes are created for 'paid' component of the invoice and it can have statuses - Refunded, Refund Due and Voided. The credits available in the Refundable Credit Notes will be automatically applied when a new invoice gets generated for the customer.

Credit Notes pipeline can be used to request and retrieve a list of credit notes satisfying all the conditions specified in the filter parameters below. Read more about this here

Configuring the Credentials

Select the account credentials which has access to relevant Chargebee data from the dropdown menu & Click Next

Credentials not listed in dropdown ?

Click on + Add New for adding new credentials

All accounts which your credentials have access to should be available here. If they are not, please check the credentials selected / configured by you.

Data Pipelines Details

Data Pipeline

Select Credit Notes from the dropdown

Setting Parameters

Parameter Description Values

Fetch Mode


Specifies the manner in which data will get fetched from the data warehouse : FULL will fetch the entire column(s) from the selected table/view, INCREMENTAL will bring the fresh record(S) added since last fetch


Default Value: FULL

Insert Mode


This refers to the manner in which data will get updated in the data warehouse, with 'Delete' selected, the data will be upserted (only new records or records with changes) and with 'Append' selected, all data fetched will be inserted. Selecting 'Replace' will ensure the table is dropped and recreated with fresh data on each run. Recommended to use "Upsert" option unless there is a specific requirement.

Upsert, Append, Replace

Default Value: UPSERT

Datapipeline Scheduling

Scheduling specifies the frequency with which data will get updated in the data warehouse. You can choose between Manual Run, Normal Scheduling or Advance Scheduling.

Manual Run

If scheduling is not required, you can use the toggle to run the pipeline manually.

Normal Scheduling

Use the dropdown to select an interval-based hourly, monthly, weekly, or daily frequency.

Advance Scheduling

Set schedules fine-grained at the level of Months, Days, Hours, and Minutes.

Detailed explanation on scheduling of pipelines can be found here

Dataset & Name

Dataset Name

Key in the Dataset Name(also serves as the table name in your data warehouse).Keep in mind, that the name should be unique across the account and the data source. Special characters (except underscore _) and blank spaces are not allowed. It is best to follow a consistent naming scheme for future search to locate the tables.

Dataset Description

Enter a short description (optional) describing the dataset being fetched by this particular pipeline.


Choose the events for which you’d like to be notified: whether "ERROR ONLY" or "ERROR AND SUCCESS".

Once you have finished click on Finish to save it. Read more about naming and saving your pipelines including the option to save them as templates here

Still have Questions?

We’ll be happy to help you with any questions you might have! Send us an email at

Subscribe to our Newsletter for latest updates at DataChannel.