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.

  • Adjustment Credit Notes are created for the 'unpaid' component of the invoice and it can have statuses - Adjusted and Voided.
  • 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.

Note: If you have enabled consolidated invoicing, to know the subscriptions attached with a credit note you have to refer line_item's subscription_id. The credit note's subscription_id should not be used (which will be null if the credit note has lines from multiple subscriptions).

Sample credit note [ JSON ]

{ "allocations": [], "amount_allocated": 0, "amount_available": 500, "amount_refunded": 0, "base_currency_code": "USD", "currency_code": "USD", "customer_id": "__test__KyVnJjRnFXtL45kp", "date": 1517468992, "deleted": false, "exchange_rate": 1, "fractional_correction": 0, "id": "__demo_cn__1", "line_item_discounts": [], "line_item_taxes": [], "line_items": [{ "amount": 500, "customer_id": "__test__KyVnJjRnFXtL45kp", "date_from": 1517468992, "date_to": 1517468992, "description": "Support Charge", "discount_amount": 0, "entity_type": "adhoc", "id": "li___test__KyVnJjRnFXtOZ5l2", "is_taxed": false, "item_level_discount_amount": 0, "object": "line_item", "pricing_model": "flat_fee", "quantity": 1, "tax_amount": 0, "tax_exempt_reason": "tax_not_configured", "unit_amount": 500 }], "linked_refunds": [], "object": "credit_note", "price_type": "tax_exclusive", "reason_code": "product_unsatisfactory", "reference_invoice_id": "__demo_inv__1", "resource_version": 1517468992000, "round_off_amount": 0, "status": "refund_due", "sub_total": 500, "taxes": [], "total": 500, "type": "refundable", "updated_at": 1517468992 }

API Index URL GET

https://{site}.chargebee.com/api/v2/credit_notes

Credit note attributes

id
Credit-note id.
string, max chars=50
customer_id
The identifier of the customer this Credit Note belongs to.
string, max chars=50
subscription_id
The identifier of the subscription this Credit Note belongs to.
Note: If consolidated invoicing is enabled, to know the subscriptions attached with this Credit Note you have to refer line_item's subscription_id. This attribute should not be used (which will be null if this credit note has lines from multiple subscriptions).
optional, string, max chars=50
reference_invoice_id
The identifier of the invoice against which this Credit Note is issued.
string, max chars=50
type
The credit note type.
enumerated string
Possible values are
adjustmentAdjustment Credit Note.refundableRefundable Credit Note.
reason_code
The reason for issuing this Credit Note. The following reason codes are supported now.
enumerated string, default=product_unsatisfactory
Possible values are
write_offThis reason will be set automatically for the Credit Notes created during invoice Write Off operation.subscription_changeThis reason will be set automatically for Credit Notes created during Change Subscription operation when proration is enabled.subscription_cancellationThis reason will be set automatically for Credit Notes created during cancel subscription operation.subscription_pauseThis reason will be automatically set to credit notes created during pause/resume subscription operation.
chargebackCan be set when you are recording your customer Chargebacks.product_unsatisfactoryProduct Unsatisfactory.service_unsatisfactoryService Unsatisfactory.order_changeOrder Change.order_cancellationOrder Cancellation.waiverWaiver.otherCan be set when none of the above reason codes are applicable.fraudulentFRAUDULENT.
Show all values[+]
status
The credit note status.
enumerated string
Possible values are
adjustedWhen the Credit Note has been adjusted against an invoice.refundedWhen the entire credits (Credit Note amount) have been used (i.e either allocated to invoices or refunded).refund_dueWhen the credits are yet to be used, or have been partially used.voidedWhen the Credit Note has been cancelled.
vat_number
VAT number of the customer for whom this Credit Note is raised.
optional, string, max chars=20
date
The date the Credit Note is issued.
optional, timestamp(UTC) in seconds
price_type
The price type of the Credit Note.
enumerated string, default=tax_exclusive
Possible values are
tax_exclusiveAll amounts in the document are exclusive of tax.tax_inclusiveAll amounts in the document are inclusive of tax.
currency_code
The currency code (ISO 4217 format) for the credit note.
string, max chars=3
total
Credit Note amount in cents.
optional, in cents, default=0, min=0
amount_allocated
The amount allocated to the invoices.
optional, in cents, default=0, min=0
amount_refunded
The refunds issued from this Credit Note.
optional, in cents, default=0, min=0
amount_available
The yet to be used credits of this Credit Note.
optional, in cents, default=0, min=0
refunded_at
The time this Credit Note got fully used.
optional, timestamp(UTC) in seconds
voided_at
Timestamp indicating the date & time this credit note got voided.
optional, timestamp(UTC) in seconds
resource_version
Version number of this resource. Each update of this resource results in incremental change of this number. This attribute will be present only if the resource has been updated after 2016-09-28.
optional, long
updated_at
Timestamp indicating when this Credit Note was last updated. This attribute will be present only if the resource has been updated after 2016-09-28.
optional, timestamp(UTC) in seconds
sub_total
The Credit Note sub-total.
in cents, min=0
sub_total_in_local_currency
Invoice subtotal in the currency of the place of supply.
optional, in cents, min=0
total_in_local_currency
Total invoice amount in the currency of the place of supply.
optional, in cents, min=0
local_currency_code
The currency code (ISO 4217 format) of the place of supply in which VAT needs to be converted and displayed.
optional, string, max chars=null
round_off_amount
Indicates the rounded-off amount.
optional, in cents, min=0
fractional_correction
Indicates the fractional correction amount.
optional, in cents, min=0
deleted
Indicates that this resource has been deleted.
boolean
line_items
Show attributes[+]
The line items of this Credit Note.
optional, list of line_item
Line item attributes
id
Uniquely identifies a line_item.
optional, string, max chars=40
subscription_id
A unique identifier for the subscription this lineitem belongs to.
optional, string, max chars=3
date_from
Start date of this lineitem.
timestamp(UTC) in seconds
date_to
End date of this lineitem.
timestamp(UTC) in seconds
unit_amount
Unit amount of the lineitem.
in cents
quantity
Quantity of the recurring item which is represented by this lineitem.
optional, integer, default=1
amount
Total amount of this lineitem. Typically equals to unit amount x quantity.
optional, in cents
pricing_model
Charges a single price for the plan/addon.
optional, enumerated string
Possible values are
flat_feeCharge a single price on recurring basis.per_unitCharge the price for each unit of the plan for the subscription on recurring basis.tieredCharges a different per unit price for the quantity purchased from every tier.volumeCharges the per unit price for the total quantity purchased based on the tier under which it falls.stairstepCharges a price for a range.
is_taxed
Specifies whether this line item is taxed or not.
boolean, default=false
tax_amount
The tax amount charged for this item.
optional, in cents, default=0, min=0
tax_rate
Rate of tax used to calculate tax for this lineitem.
optional, double, min=0.0, max=100.0
discount_amount
Total discounts for this line.
optional, in cents, min=0
item_level_discount_amount
'Item' level discounts for this line.
optional, in cents, min=0
description
Detailed description about this lineitem.
string, max chars=250
entity_type
Specifies the modelled entity (plan / addon etc) this lineitem is based on.
enumerated string
Possible values are
plan_setupIndicates that this lineitem is based on 'Plan Setup' charge. The 'entity_id' attribute specifies the plan id.planIndicates that this lineitem is based on 'Plan' entity. The 'entity_id' attribute specifies the plan id.addonIndicates that this lineitem is based on 'Addon' entity. The 'entity_id' attribute specifies the addon id.adhocIndicates that this lineitem is not modelled. i.e created adhoc. So the 'entity_id' attribute will be null in this case.
tax_exempt_reason
The reason or category due to which the line item price/amount is excluded from taxable amount.
optional, enumerated string
Possible values are
tax_not_configuredIf tax is not enabled for the site.region_non_taxableIf the product sold is not taxable in this region, but it is taxable in other regions, hence this region is not part of the Taxable jurisdiction.exportIf the Merchant is not registered for Tax in this region, taxes will not be applied.customer_exemptIf the Customer is marked as Tax exempt.product_exemptIf the Plan or Addon is marked as Tax exempt.zero_ratedIf the rate of tax is 0% and no Sales/ GST tax is collectable for that line item.reverse_chargeIf the Customer is identified as B2B customer (when VAT Number is entered), applicable for EU only.high_value_physical_goodsIf physical goods are sold from outside Australia to customers in Australia, and the price of all the physical good line items is greater than AUD 1000, then tax will not be applied.
entity_id
The identifier of the modelled entity this lineitem is based on. Will be null for 'adhoc' entity type.
optional, string, max chars=100
customer_id
A unique identifier for the customer this lineitem belongs to.
optional, string, max chars=100
discounts
Show attributes[+]
The list of discounts applied to this Credit Note.
optional, list of discount
Discount attributes
amount
Discount amount.
in cents, min=0
description
Detailed description of this discount line item.
optional, string, max chars=250
entity_type
Type of this Discount lineitem.
enumerated string
Possible values are
item_level_couponRepresents the 'Item' level coupons applied to this invoice. Further the 'entity_id' attribute specifies the coupon id this discount is based on.document_level_couponRepresents the 'Document' level coupons applied to this document. Further the 'entity_id' attribute specifies the coupon id this discount is based on.promotional_creditsRepresents the Promotional Credits item in invoice. The 'entity_id' attribute will be null in this case.prorated_creditsRepresents the credit adjustment items in invoice. The 'entity_id' attribute will be null in this case.
entity_id
The identifier of the modelled entity this lineitem is bases on. Will be null for 'Prorated Credits' & 'Promotional Credits'.
optional, string, max chars=100
line_item_discounts
Show attributes[+]
The list of discount(s) applied for each line item of this invoice.
optional, list of line_item_discount
Line item discount attributes
line_item_id
The unique reference id of the line item for which the discount is applicable.
string, max chars=50
discount_type
Type of this discount line item.
enumerated string
Possible values are
item_level_couponRepresents the 'Item' level coupons applied to this invoice. Further the 'coupon_id' attribute specifies the coupon id this discount is based on.document_level_couponRepresents the 'Document' level coupons applied to this document. Further the 'coupon_id' attribute specifies the coupon id this discount is based on.promotional_creditsRepresents the Promotional Credits item in invoice. The 'coupon_id' attribute will be null in this case.prorated_creditsRepresents the credit adjustment items in invoice. The 'coupon_id' attribute will be null in this case.
coupon_id
Coupon id.
optional, string, max chars=50
discount_amount
Discount amount.
in cents, min=0
line_item_tiers
Show attributes[+]
The list of tiers applicable for this line item.
optional, list of line_item_tier
Line item tier attributes
line_item_id
Uniquely identifies a line_item.
optional, string, max chars=40
starting_unit
The lower limit of a range of units for the tier.
integer, min=1
ending_unit
The upper limit of a range of units for the tier.
optional, integer
quantity_used
The number of units purchased in a range.
integer, min=1
unit_amount
The price of the tier if the charge model is a stairtstep pricing , or the price of each unit in the tier if the charge model is tiered/volume pricing.
in cents, min=0
taxes
Show attributes[+]
The tax-lines of this Credit Note.
optional, list of tax
Tax attributes
name
The name of the tax applied. E.g. GST.
string, max chars=100
amount
The tax amount.
in cents, min=0
description
Description of the tax item.
optional, string, max chars=250
line_item_taxes
Show attributes[+]
The list of taxes applied on line items.
optional, list of line_item_tax
Line item tax attributes
line_item_id
The unique reference id of the line item for which the tax is applicable.
optional, string, max chars=40
tax_name
The name of the tax applied.
string, max chars=100
tax_rate
The rate of tax used to calculate tax amount.
double, default=0.0, min=0.0, max=100.0
is_partial_tax_applied
Indicates if tax is applied only on a portion of the line item amount.
optional, boolean
is_non_compliance_tax
Indicates the non-compliance tax that should not be reported to the jurisdiction.
optional, boolean
taxable_amount
Indicates the actual portion of the line item amount that is taxable.
in cents, min=0
tax_amount
The tax amount.
in cents, min=0
tax_juris_type
The type of tax jurisdiction.
optional, enumerated string
Possible values are
countryThe tax jurisdiction is a country.federalThe tax jurisdiction is a federal.stateThe tax jurisdiction is a state.countyThe tax jurisdiction is a county.cityThe tax jurisdiction is a city.specialSpecial tax jurisdiction.unincorporatedCombined tax of state and county.otherJurisdictions other than the ones listed above.
tax_juris_name
The name of the tax jurisdiction.
optional, string, max chars=250
tax_juris_code
The tax jurisdiction code.
optional, string, max chars=250
tax_amount_in_local_currency
Total tax amount in the currency of the place of supply. This is applicable only for Invoice and Credit Notes API.
optional, in cents, min=0
local_currency_code
The currency code (ISO 4217 format) of the place of supply in which VAT needs to be converted and displayed. This is applicable only for Invoice and Credit Notes API.
optional, string, max chars=null
linked_refunds
Show attributes[+]
Refunds issued from this Credit Note.
optional, list of credit_note_transaction
Linked refund attributes
txn_id
Uniquely identifies the transaction.
string, max chars=40
applied_amount
The transaction amount applied to this invoice.
in cents, min=0
applied_at

timestamp(UTC) in seconds
txn_status
The status of this transaction.
optional, enumerated string
Possible values are
in_progressTransaction is being processed via ACH.successThe transaction is successful.voidedThe transaction got voided or authorization expired at gateway.failureTransaction failed. Refer the 'error_code' and 'error_text' fields to know the reason for failure.timeoutTransaction failed because of Gateway not accepting the connection.needs_attentionConnection with Gateway got terminated abruptly. So, status of this transaction needs to be resolved manually.
txn_date
Indicates when this transaction occurred.
optional, timestamp(UTC) in seconds
txn_amount
Total amount of the transaction.
optional, in cents, min=1
allocations
Show attributes[+]
Invoice allocations made from this Credit Note.
optional, list of applied_credit
Allocation attributes
invoice_id

string, max chars=50
allocated_amount
Amount of this refund transaction.
in cents, min=0
allocated_at
Indicates when this refund occured.
timestamp(UTC) in seconds
invoice_date
Closing date of the invoice. Typically this is the date on which invoice is generated.
optional, timestamp(UTC) in seconds
invoice_status
Current status of the invoice.
enumerated string
Possible values are
paidIndicates a paid invoice.postedIndicates the payment is not yet collected and will be in this state till the due date to indicate the due period.payment_dueIndicates the payment is not yet collected and is being retried as per retry settings.not_paidIndicates the payment is not made and all attempts to collect is failed.voidedIndicates a voided invoice.pendingIndicates the invoice is not closed yet. New line items can be added when the invoice is in this state.

Create Credit Note

Creates a Credit Note for an Invoice.
Sample Request 
curl  https://{site}.chargebee.com/api/v2/credit_notes \
     -u {site_api_key}:\
     -d reference_invoice_id="__demo_inv__1" \
     -d total=500 \
     -d type="refundable" \
     -d reason_code="product_unsatisfactory" \
     -d customer_notes="Products were returned because they were defective"
copy
curl  https://{site}.chargebee.com/api/v2/credit_notes \
     -u {site_api_key}:\
     -d reference_invoice_id="__demo_inv__1" \
     -d total=500 \
     -d type="refundable" \
     -d reason_code="product_unsatisfactory" \
     -d customer_notes="Products were returned because they were defective"

Sample Response [ JSON ]

Show more...
{ "credit_note": { "allocations": [], "amount_allocated": 0, "amount_available": 500, "amount_refunded": 0, "base_currency_code": "USD", "currency_code": "USD", "customer_id": "__test__KyVnJjRnFXtL45kp", "date": 1517468992, "deleted": false, "exchange_rate": 1, "fractional_correction": 0, "id": "__demo_cn__1", "line_item_discounts": [], "line_item_taxes": [], "line_items": [ { "amount": 500, "customer_id": "__test__KyVnJjRnFXtL45kp", "date_from": 1517468992, "date_to": 1517468992, "description": "Support Charge", "discount_amount": 0, "entity_type": "adhoc", "id": "li___test__KyVnJjRnFXtOZ5l2", "is_taxed": false, "item_level_discount_amount": 0, "object": "line_item", "pricing_model": "flat_fee", "quantity": 1, "tax_amount": 0, "tax_exempt_reason": "tax_not_configured", "unit_amount": 500 }, {..} ], "linked_refunds": [], "object": "credit_note", "price_type": "tax_exclusive", "reason_code": "product_unsatisfactory", "reference_invoice_id": "__demo_inv__1", "resource_version": 1517468992000, "round_off_amount": 0, "status": "refund_due", "sub_total": 500, "taxes": [], "total": 500, "type": "refundable", "updated_at": 1517468992 }, "invoice": { "adjustment_credit_notes": [], "amount_adjusted": 0, "amount_due": 0, "amount_paid": 1000, "amount_to_collect": 0, "applied_credits": [], "base_currency_code": "USD", "billing_address": { "first_name": "Duncan", "last_name": "Walpole", "object": "billing_address", "validation_status": "not_validated" }, "credits_applied": 0, "currency_code": "USD", "customer_id": "__test__KyVnJjRnFXtL45kp", "date": 1517468992, "deleted": false, "due_date": 1517468992, "dunning_attempts": [], "exchange_rate": 1, "first_invoice": true, "has_advance_charges": false, "id": "__demo_inv__1", "is_gifted": false, "issued_credit_notes": [ { "cn_date": 1517468992, "cn_id": "__demo_cn__1", "cn_reason_code": "product_unsatisfactory", "cn_status": "refund_due", "cn_total": 500 }, {..} ], "line_items": [ { "amount": 1000, "customer_id": "__test__KyVnJjRnFXtL45kp", "date_from": 1517468992, "date_to": 1517468992, "description": "Support Charge", "discount_amount": 0, "entity_type": "adhoc", "id": "li___test__KyVnJjRnFXtMj5kw", "is_taxed": false, "item_level_discount_amount": 0, "object": "line_item", "pricing_model": "flat_fee", "quantity": 1, "tax_amount": 0, "tax_exempt_reason": "tax_not_configured", "unit_amount": 1000 }, {..} ], "linked_orders": [], "linked_payments": [ { "applied_amount": 1000, "applied_at": 1517468992, "txn_amount": 1000, "txn_date": 1517468992, "txn_id": "txn___test__KyVnJjRnFXtN85kx", "txn_status": "success" }, {..} ], "net_term_days": 0, "new_sales_amount": 1000, "object": "invoice", "paid_at": 1517468992, "price_type": "tax_exclusive", "recurring": false, "resource_version": 1517468992000, "round_off_amount": 0, "status": "paid", "sub_total": 1000, "tax": 0, "term_finalized": true, "total": 1000, "updated_at": 1517468992, "write_off_amount": 0 } }

URL Format POST

https://{site}.chargebee.com/api/v2/credit_notes

Input Parameters

reference_invoice_id
The identifier of the invoice against which this Credit Note is issued.
required, string, max chars=50
total
Credit Note amount in cents. You can either pass the total parameter or the line_items parameter. Passing both will result in an error.
optional, in cents, default=0, min=0
type
The credit note type.
required, enumerated string
Possible values are
adjustmentAdjustment Credit Note.refundableRefundable Credit Note.
reason_code
The reason for issuing this Credit Note. The following reason codes are supported now.
required, enumerated string, default=product_unsatisfactory
Possible values are
product_unsatisfactoryProduct Unsatisfactory.service_unsatisfactoryService Unsatisfactory.order_changeOrder Change.order_cancellationOrder Cancellation.waiverWaiver.otherCan be set when none of the above reason codes are applicable.
Show all values[+]
date
The date the Credit Note is issued.
optional, timestamp(UTC) in seconds
customer_notes
The Customer Notes to be filled in the Credit Notes created.
optional, string, max chars=2000
comment
This comment will be added to the credit note.
optional, string, max chars=300
+
line_items
Parameters for line_items. Multiple line_items can be passed by specifying unique indices.
pass parameters as line_items[<param name>][<idx:0..n>]
line_items[reference_line_item_id][0..n]
Uniquely identifies a line_item.
required, string, max chars=40
line_items[unit_amount][0..n]
Unit amount of the line item. Required for FLAT_FEE, PER_UNIT and VOLUME pricing model.
optional, in cents
line_items[quantity][0..n]
Quantity of the line item. Required for PER_UNIT and VOLUME pricing model.
optional, integer, default=1
line_items[amount][0..n]
Amount of the line item. Applicable only for Stairstep pricing_model.
optional, in cents
line_items[date_from][0..n]
Start date of this lineitem.
optional, timestamp(UTC) in seconds
line_items[date_to][0..n]
End date of this lineitem.
optional, timestamp(UTC) in seconds
line_items[description][0..n]
Description for the line item.
optional, string, max chars=250

Returns

credit_note
Resource object representing credit_note.
always returned
invoice
Resource object representing invoice.
always returned

Retrieve a credit note

Retrieves the Credit Note identified by the specified Credit Note number.
Sample Request 
curl  https://{site}.chargebee.com/api/v2/credit_notes/__demo_cn__6 \
     -u {site_api_key}:
copy
curl  https://{site}.chargebee.com/api/v2/credit_notes/__demo_cn__6 \
     -u {site_api_key}:

Sample Response [ JSON ]

Show more...
{"credit_note": { "allocations": [], "amount_allocated": 0, "amount_available": 500, "amount_refunded": 0, "base_currency_code": "USD", "currency_code": "USD", "customer_id": "__test__KyVnJjRnFXv8t5mN", "date": 1517468999, "deleted": false, "exchange_rate": 1, "fractional_correction": 0, "id": "__demo_cn__6", "line_item_discounts": [], "line_item_taxes": [], "line_items": [ { "amount": 500, "customer_id": "__test__KyVnJjRnFXv8t5mN", "date_from": 1517468999, "date_to": 1517468999, "description": "Support Charge", "discount_amount": 0, "entity_type": "adhoc", "id": "li___test__KyVnJjRnFXvC95ma", "is_taxed": false, "item_level_discount_amount": 0, "object": "line_item", "pricing_model": "flat_fee", "quantity": 1, "tax_amount": 0, "tax_exempt_reason": "tax_not_configured", "unit_amount": 500 }, {..} ], "linked_refunds": [], "object": "credit_note", "price_type": "tax_exclusive", "reason_code": "product_unsatisfactory", "reference_invoice_id": "__demo_inv__6", "resource_version": 1517468999000, "round_off_amount": 0, "status": "refund_due", "sub_total": 500, "taxes": [], "total": 500, "type": "refundable", "updated_at": 1517468999 }}

URL Format GET

https://{site}.chargebee.com/api/v2/credit_notes/{credit_note_id}

Returns

credit_note
Resource object representing credit_note.
always returned

Sample admin console URL

https://{site}.chargebee.com/admin-console/credit_notes/123x

Retrieve Credit Note as PDF

Gets the credit note as PDF. The returned URL is secure and allows download. The URL will expire in 60 minutes.
Sample Request 
curl  https://{site}.chargebee.com/api/v2/credit_notes/__demo_cn__4/pdf \
     -X POST  \
     -u {site_api_key}:
copy
curl  https://{site}.chargebee.com/api/v2/credit_notes/__demo_cn__4/pdf \
     -X POST  \
     -u {site_api_key}:

Sample Response [ JSON ]

Show more...
{"download": { "download_url": "https://cb-local-downloads.s3.amazonaws.com/yourapp/credit_note/__test__KyVnJjRnFXuEc5ly.pdf?response-content-disposition=attachment%3Bfilename%3Dyourapp%2Fcredit_note%2F__test__KyVnJjRnFXuEc5ly.pdf&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20200111T070958Z&X-Amz-SignedHeaders=host&X-Amz-Expires=-61257540&X-Amz-Credential=AKIAJI4SN7ONHAOGLOGA%2F20200111%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=e8c7cc3be863799b11adaecb6c60e5da352d67c5c1afd3b7de97eef9b3327701", "object": "download", "valid_till": 1517469058 }}

URL Format POST

https://{site}.chargebee.com/api/v2/credit_notes/{credit_note_id}/pdf

Input Parameters

disposition_type
Determines the pdf should be rendered as inline or attachment in the browser.
optional, enumerated string, default=attachment
Possible values are
attachmentpdf is rendered as attachment in the browser.inlinepdf is rendered as inline in the browser.

Returns

download
Resource object representing download.
always returned

Refund a Credit Note

Sample Request 
curl  https://{site}.chargebee.com/api/v2/credit_notes/__demo_cn__1/refund \
     -u {site_api_key}:\
     -d customer_notes="Refunding as customer canceled the order." \
     -d refund_amount=1000
copy
curl  https://{site}.chargebee.com/api/v2/credit_notes/__demo_cn__1/refund \
     -u {site_api_key}:\
     -d customer_notes="Refunding as customer canceled the order." \
     -d refund_amount=1000

Sample Response [ JSON ]

Show more...
{ "credit_note": { "allocations": [], "amount_allocated": 0, "amount_available": 1000, "amount_refunded": 0, "base_currency_code": "USD", "currency_code": "USD", "customer_id": "__test__XpbT626Rr3LxLRP", "date": 1517497363, "deleted": false, "exchange_rate": 1, "fractional_correction": 0, "id": "__demo_cn__1", "line_item_discounts": [], "line_item_taxes": [], "line_items": [ { "amount": 1000, "customer_id": "__test__XpbT626Rr3LxLRP", "date_from": 1517497363, "date_to": 1517497363, "description": "Support Charge", "discount_amount": 0, "entity_type": "adhoc", "id": "li___test__XpbT626Rr3LxX1c", "is_taxed": false, "item_level_discount_amount": 0, "object": "line_item", "pricing_model": "flat_fee", "quantity": 1, "tax_amount": 0, "tax_exempt_reason": "tax_not_configured", "unit_amount": 1000 }, {..} ], "linked_refunds": [], "object": "credit_note", "price_type": "tax_exclusive", "reason_code": "product_unsatisfactory", "reference_invoice_id": "__demo_inv__1", "resource_version": 1517497363000, "round_off_amount": 0, "status": "refund_due", "sub_total": 1000, "taxes": [], "total": 1000, "type": "refundable", "updated_at": 1517497363 }, "transaction": { "amount": 1000, "base_currency_code": "USD", "currency_code": "USD", "customer_id": "__test__XpbT626Rr3LxLRP", "date": 1517497363, "deleted": false, "exchange_rate": 1, "gateway": "chargebee", "gateway_account_id": "gw___test__3Nl96ntRr3LwZP4", "id": "txn___test__XpbT626Rr3LxcOg", "id_at_gateway": "cb___test__XpbT626Rr3LxSDY", "linked_credit_notes": [ { "applied_amount": 1000, "applied_at": 1517497364, "cn_date": 1517497363, "cn_id": "__demo_cn__1", "cn_reason_code": "product_unsatisfactory", "cn_reference_invoice_id": "__demo_inv__1", "cn_status": "refunded", "cn_total": 1000 }, {..} ], "masked_card_number": "************1111", "object": "transaction", "payment_method": "card", "payment_source_id": "pm___test__XpbT626Rr3LxMQR", "refunded_txn_id": "txn___test__XpbT626Rr3LxS3X", "resource_version": 1517497364000, "status": "success", "type": "refund", "updated_at": 1517497364 } }

URL Format POST

https://{site}.chargebee.com/api/v2/credit_notes/{credit_note_id}/refund

Input Parameters

refund_amount
Amount to be refunded. If not specified, the entire refundable amount for this credit note will be refunded.
optional, integer, min=1
customer_notes
The Customer Notes to be filled in the Credit Notes created.
optional, string, max chars=2000

Returns

credit_note
Resource object representing credit_note.
always returned
transaction
Resource object representing transaction.
always returned

Record refund for a credit note

This API records the refund of credit notes.

Read more about recording refunds here.

Once the full-refund of the credit note has been successfully recorded, the status of the credit note changes to Refunded.

Sample Request 
curl  https://{site}.chargebee.com/api/v2/credit_notes/__demo_cn__5/record_refund \
     -u {site_api_key}:\
     -d comment="Refunding as customer canceled the order." \
     -d transaction[amount]=100 \
     -d transaction[payment_method]="bank_transfer" \
     -d transaction[date]=1517468998
copy
curl  https://{site}.chargebee.com/api/v2/credit_notes/__demo_cn__5/record_refund \
     -u {site_api_key}:\
     -d comment="Refunding as customer canceled the order." \
     -d transaction[amount]=100 \
     -d transaction[payment_method]="bank_transfer" \
     -d transaction[date]=1517468998

Sample Response [ JSON ]

Show more...
{ "credit_note": { "allocations": [], "amount_allocated": 0, "amount_available": 400, "amount_refunded": 100, "base_currency_code": "USD", "currency_code": "USD", "customer_id": "__test__KyVnJjRnFXv2B5lz", "date": 1517468998, "deleted": false, "exchange_rate": 1, "fractional_correction": 0, "id": "__demo_cn__5", "line_item_discounts": [], "line_item_taxes": [], "line_items": [ { "amount": 500, "customer_id": "__test__KyVnJjRnFXv2B5lz", "date_from": 1517468998, "date_to": 1517468998, "description": "Support Charge", "discount_amount": 0, "entity_type": "adhoc", "id": "li___test__KyVnJjRnFXv5N5mC", "is_taxed": false, "item_level_discount_amount": 0, "object": "line_item", "pricing_model": "flat_fee", "quantity": 1, "tax_amount": 0, "tax_exempt_reason": "tax_not_configured", "unit_amount": 500 }, {..} ], "linked_refunds": [ { "applied_amount": 100, "applied_at": 1517468998, "txn_amount": 100, "txn_date": 1517468998, "txn_id": "txn___test__KyVnJjRnFXv6c5mG", "txn_status": "success" }, {..} ], "object": "credit_note", "price_type": "tax_exclusive", "reason_code": "product_unsatisfactory", "reference_invoice_id": "__demo_inv__5", "resource_version": 1517468998000, "round_off_amount": 0, "status": "refund_due", "sub_total": 500, "taxes": [], "total": 500, "type": "refundable", "updated_at": 1517468998 }, "transaction": { "amount": 100, "base_currency_code": "USD", "currency_code": "USD", "customer_id": "__test__KyVnJjRnFXv2B5lz", "date": 1517468998, "deleted": false, "exchange_rate": 1, "gateway": "not_applicable", "id": "txn___test__KyVnJjRnFXv6c5mG", "linked_credit_notes": [ { "applied_amount": 100, "applied_at": 1517468998, "cn_date": 1517468998, "cn_id": "__demo_cn__5", "cn_reason_code": "product_unsatisfactory", "cn_reference_invoice_id": "__demo_inv__5", "cn_status": "refund_due", "cn_total": 500 }, {..} ], "object": "transaction", "payment_method": "bank_transfer", "resource_version": 1517468998000, "status": "success", "type": "refund", "updated_at": 1517468998 } }

URL Format POST

https://{site}.chargebee.com/api/v2/credit_notes/{credit_note_id}/record_refund

Input Parameters

comment
Remarks, if any, on the refund.
optional, string, max chars=300
+
transaction
Parameters for transaction
pass parameters as transaction[<param name>]
transaction[amount]
Amount to be recorded as refunded. If this parameter is not passed then the entire refundable amount will be recorded as refunded.
optional, in cents, min=1
transaction[payment_method]
The Payment Method of this transaction.
required, enumerated string, default=card
Possible values are
cashCash.checkCheck.chargebackChargeback.
bank_transferBank Transfer.otherPayment Methods other than the above types.
Show all values[+]
transaction[reference_number]
The reference number for this transaction. e.g check number in case of 'check' payments.
optional, string, max chars=100
transaction[date]
Indicates when this transaction occurred.
required, timestamp(UTC) in seconds

Returns

credit_note
Resource object representing credit_note.
always returned
transaction
Resource object representing transaction.
always returned

Void a credit note

Use this API to void a credit note. A voided credit is a null entity and cannot be used again. A credit note which has already been voided or refunded cannot be voided. An error message will be displayed when you render such credit notes void.

Note: When adjustment credit notes are voided, the associated invoice will reflect as NOT PAID, and the amount in the invoice will be recalculated to reflect the amount after considering the voided credit note.

Sample Request 
curl  https://{site}.chargebee.com/api/v2/credit_notes/__demo_cn__7/void \
     -X POST  \
     -u {site_api_key}:
copy
curl  https://{site}.chargebee.com/api/v2/credit_notes/__demo_cn__7/void \
     -X POST  \
     -u {site_api_key}:

Sample Response [ JSON ]

Show more...
{ "credit_note": { "allocations": [], "amount_allocated": 0, "amount_available": 500, "amount_refunded": 0, "base_currency_code": "USD", "currency_code": "USD", "customer_id": "__test__KyVnJjRnFXvEe5me", "date": 1517468999, "deleted": false, "exchange_rate": 1, "fractional_correction": 0, "id": "__demo_cn__7", "line_item_discounts": [], "line_item_taxes": [], "line_items": [ { "amount": 500, "customer_id": "__test__KyVnJjRnFXvEe5me", "date_from": 1517468999, "date_to": 1517468999, "description": "Support Charge", "discount_amount": 0, "entity_type": "adhoc", "id": "li___test__KyVnJjRnFXvHm5mr", "is_taxed": false, "item_level_discount_amount": 0, "object": "line_item", "pricing_model": "flat_fee", "quantity": 1, "tax_amount": 0, "tax_exempt_reason": "tax_not_configured", "unit_amount": 500 }, {..} ], "linked_refunds": [], "object": "credit_note", "price_type": "tax_exclusive", "reason_code": "product_unsatisfactory", "reference_invoice_id": "__demo_inv__7", "resource_version": 1517468999000, "round_off_amount": 0, "status": "voided", "sub_total": 500, "taxes": [], "total": 500, "type": "refundable", "updated_at": 1517468999, "voided_at": 1517468999 }, "invoice": { "adjustment_credit_notes": [], "amount_adjusted": 0, "amount_due": 0, "amount_paid": 1000, "amount_to_collect": 0, "applied_credits": [], "base_currency_code": "USD", "billing_address": { "first_name": "Duncan", "last_name": "Walpole", "object": "billing_address", "validation_status": "not_validated" }, "credits_applied": 0, "currency_code": "USD", "customer_id": "__test__KyVnJjRnFXvEe5me", "date": 1517468999, "deleted": false, "due_date": 1517468999, "dunning_attempts": [], "exchange_rate": 1, "first_invoice": true, "has_advance_charges": false, "id": "__demo_inv__7", "is_gifted": false, "issued_credit_notes": [ { "cn_date": 1517468999, "cn_id": "__demo_cn__7", "cn_reason_code": "product_unsatisfactory", "cn_status": "voided", "cn_total": 500 }, {..} ], "line_items": [ { "amount": 1000, "customer_id": "__test__KyVnJjRnFXvEe5me", "date_from": 1517468999, "date_to": 1517468999, "description": "Support Charge", "discount_amount": 0, "entity_type": "adhoc", "id": "li___test__KyVnJjRnFXvGB5ml", "is_taxed": false, "item_level_discount_amount": 0, "object": "line_item", "pricing_model": "flat_fee", "quantity": 1, "tax_amount": 0, "tax_exempt_reason": "tax_not_configured", "unit_amount": 1000 }, {..} ], "linked_orders": [], "linked_payments": [ { "applied_amount": 1000, "applied_at": 1517468999, "txn_amount": 1000, "txn_date": 1517468999, "txn_id": "txn___test__KyVnJjRnFXvGY5mm", "txn_status": "success" }, {..} ], "net_term_days": 0, "new_sales_amount": 1000, "object": "invoice", "paid_at": 1517468999, "price_type": "tax_exclusive", "recurring": false, "resource_version": 1517468999000, "round_off_amount": 0, "status": "paid", "sub_total": 1000, "tax": 0, "term_finalized": true, "total": 1000, "updated_at": 1517468999, "write_off_amount": 0 } }

URL Format POST

https://{site}.chargebee.com/api/v2/credit_notes/{credit_note_id}/void

Input Parameters

comment
Reason for voiding credit note. This comment will be added to the credit note.
optional, string, max chars=300

Returns

credit_note
Resource object representing credit_note.
always returned

List credit notes

Lists all the Credit Notes.

Sample Request 
curl  https://{site}.chargebee.com/api/v2/credit_notes \
     -G  \
     -u {site_api_key}:\
     --data-urlencode limit=3 \
     --data-urlencode type[is]="refundable" \
     --data-urlencode sort_by[asc]="date"
copy
curl  https://{site}.chargebee.com/api/v2/credit_notes \
     -G  \
     -u {site_api_key}:\
     --data-urlencode limit=3 \
     --data-urlencode type[is]="refundable" \
     --data-urlencode sort_by[asc]="date"

Sample Response [ JSON ]

Show more...
{"list": [ {"credit_note": { "allocations": [], "amount_allocated": 0, "amount_available": 500, "amount_refunded": 0, "base_currency_code": "USD", "currency_code": "USD", "customer_id": "__test__KyVnJjRnFXtL45kp", "date": 1517468992, "deleted": false, "exchange_rate": 1, "fractional_correction": 0, "id": "__demo_cn__1", "line_item_discounts": [], "line_item_taxes": [], "line_items": [ { "amount": 500, "customer_id": "__test__KyVnJjRnFXtL45kp", "date_from": 1517468992, "date_to": 1517468992, "description": "Support Charge", "discount_amount": 0, "entity_type": "adhoc", "id": "li___test__KyVnJjRnFXtOZ5l2", "is_taxed": false, "item_level_discount_amount": 0, "object": "line_item", "pricing_model": "flat_fee", "quantity": 1, "tax_amount": 0, "tax_exempt_reason": "tax_not_configured", "unit_amount": 500 }, {..} ], "linked_refunds": [], "object": "credit_note", "price_type": "tax_exclusive", "reason_code": "product_unsatisfactory", "reference_invoice_id": "__demo_inv__1", "resource_version": 1517468992000, "round_off_amount": 0, "status": "refund_due", "sub_total": 500, "taxes": [], "total": 500, "type": "refundable", "updated_at": 1517468992 }}, {..} ]}

URL Format GET

https://{site}.chargebee.com/api/v2/credit_notes

Input Parameters

limit
Limits the number of resources to be returned.
optional, integer, default=10, min=1, max=100
offset
Allows you to fetch the next set of resources. The value used for this parameter must be the value returned for next_offset parameter in the previous API call.
optional, string, max chars=1000
include_deleted
If set to true, includes the deleted resources in the response. For the deleted resources in the response, the 'deleted' attribute will be 'true'.
optional, boolean, default=false
sort_by[<sort-order>]
Sorts based on the specified attribute.
Supported attributes : date
Supported sort-orders : asc, desc

Example → sort_by[asc] = "date"
This will sort the result based on the 'date' attribute in ascending(earliest first) order.
optional, string filter
Filter Params
For operator usages, see the Pagination and Filtering section.
id[<operator>]
To filter based on CreditNote Id.
Supported operators : is, is_not, starts_with, in, not_in

Example → id[is] = "CN_123"
optional, string filter
customer_id[<operator>]
To filter based on CreditNote Customer Id.
Supported operators : is, is_not, starts_with, in, not_in

Example → customer_id[is] = "4gmiXbsjdm"
optional, string filter
subscription_id[<operator>]
To filter based on subscription_id.
NOTE: Not to be used if consolidated invoicing feature is enabled.
Supported operators : is, is_not, starts_with, is_present, in, not_in

Example → subscription_id[is] = "4gmiXbsjdm"
optional, string filter
reference_invoice_id[<operator>]
To filter based on CreditNote Invoice Id.
Supported operators : is, is_not, starts_with, in, not_in

Example → reference_invoice_id[is] = "INVOICE_876"
optional, string filter
type[<operator>]
To filter based on CreditNote Type. Possible values are : adjustment, refundable.
Supported operators : is, is_not, in, not_in

Example → type[is_not] = "adjustment"
optional, enumerated string filter
reason_code[<operator>]
To filter based on CreditNote Reason Code. Possible values are : write_off, subscription_change, subscription_cancellation, subscription_pause, chargeback, product_unsatisfactory, service_unsatisfactory, order_change, order_cancellation, waiver, other, fraudulent.
Supported operators : is, is_not, in, not_in

Example → reason_code[is] = "waiver"
optional, enumerated string filter
status[<operator>]
To filter based on CreditNote Status. Possible values are : adjusted, refunded, refund_due, voided.
Supported operators : is, is_not, in, not_in

Example → status[is] = "adjusted"
optional, enumerated string filter
date[<operator>]
To filter based on CreditNote Date.
Supported operators : after, before, on, between

Example → date[after] = "1435054328"
optional, timestamp(UTC) in seconds filter
total[<operator>]
To filter based on CreditNote Amount.
Supported operators : is, is_not, lt, lte, gt, gte, between

Example → total[is_not] = "1200"
optional, in cents filter
price_type[<operator>]
To filter based on CreditNote Price Type. Possible values are : tax_exclusive, tax_inclusive.
Supported operators : is, is_not, in, not_in

Example → price_type[is] = "tax_exclusive"
optional, enumerated string filter
amount_allocated[<operator>]
To filter based on CreditNote Amount Allocated.
Supported operators : is, is_not, lt, lte, gt, gte, between

Example → amount_allocated[lt] = "1200"
optional, in cents filter
amount_refunded[<operator>]
To filter based on CreditNote Amount Refunded.
Supported operators : is, is_not, lt, lte, gt, gte, between

Example → amount_refunded[is] = "130"
optional, in cents filter
amount_available[<operator>]
To filter based on CreditNote Amount Available.
Supported operators : is, is_not, lt, lte, gt, gte, between

Example → amount_available[gt] = "1400"
optional, in cents filter
voided_at[<operator>]
To filter based on CreditNote Voided At.
Supported operators : after, before, on, between

Example → voided_at[before] = "1435054328"
optional, timestamp(UTC) in seconds filter
updated_at[<operator>]
To filter based on updated at. This attribute will be present only if the resource has been updated after 2016-09-28.
Supported operators : after, before, on, between

Example → updated_at[before] = "1243545465"
optional, timestamp(UTC) in seconds filter

Returns

credit_note
Resource object representing credit_note.
always returned
next_offset
This attribute is returned only if more resources are present. To fetch the next set of resources use this value for the input parameter “offset”.
optional, string, max chars=1000

Delete a credit Note

This API deletes a credit note. A credit note once deleted, is deleted permanently. You cannot delete a credit which has already been deleted or refunded. If you try to delete a refunded or deleted credit note, an error message will be displayed.

Sample Request 
curl  https://{site}.chargebee.com/api/v2/credit_notes/__demo_cn__2/delete \
     -X POST  \
     -u {site_api_key}:
copy
curl  https://{site}.chargebee.com/api/v2/credit_notes/__demo_cn__2/delete \
     -X POST  \
     -u {site_api_key}:

Sample Response [ JSON ]

Show more...
{"credit_note": { "allocations": [], "amount_allocated": 0, "amount_available": 500, "amount_refunded": 0, "base_currency_code": "USD", "currency_code": "USD", "customer_id": "__test__KyVnJjRnFXtRB5l6", "date": 1517468992, "deleted": false, "exchange_rate": 1, "fractional_correction": 0, "id": "__demo_cn__2", "line_item_discounts": [], "line_item_taxes": [], "line_items": [ { "amount": 500, "customer_id": "__test__KyVnJjRnFXtRB5l6", "date_from": 1517468992, "date_to": 1517468992, "description": "Service Charge", "discount_amount": 0, "entity_type": "adhoc", "id": "li___test__KyVnJjRnFXtUY5lJ", "is_taxed": false, "item_level_discount_amount": 0, "object": "line_item", "pricing_model": "flat_fee", "quantity": 1, "tax_amount": 0, "tax_exempt_reason": "tax_not_configured", "unit_amount": 500 }, {..} ], "linked_refunds": [], "object": "credit_note", "price_type": "tax_exclusive", "reason_code": "product_unsatisfactory", "reference_invoice_id": "__demo_inv__2", "resource_version": 1517468992000, "round_off_amount": 0, "status": "refund_due", "sub_total": 500, "taxes": [], "total": 500, "type": "refundable", "updated_at": 1517468992 }}

URL Format POST

https://{site}.chargebee.com/api/v2/credit_notes/{credit_note_id}/delete

Input Parameters

comment
Reason for deleting this credit note. This comment will be added to the associated invoice entity.
optional, string, max chars=300

Returns

credit_note
Resource object representing credit_note.
always returned