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.
Sample credit note [ JSON ]
{
"id": "TEST-CN-1",
"customer_id": "8avVGOkx8U1MX",
"subscription_id": "8avVGOkx8U1MX",
"reference_invoice_id": "1",
"type": "refundable",
"reason_code": "waiver",
"status": "refund_due",
"date": 1493234299,
"price_type": "tax_exclusive",
"exchange_rate": 1.0,
"total": 100,
"amount_allocated": 0,
"amount_refunded": 0,
"amount_available": 100,
"updated_at": 1493234299,
"resource_version": 1493234299000,
"deleted": false,
"object": "credit_note",
"currency_code": "USD",
"base_currency_code": "USD",
"sub_total": 100,
"line_items": [
{
"id": "li_KyVmylQHvmwUy6H",
"date_from": 1493234299,
"date_to": 1493234299,
"unit_amount": 100,
"quantity": 1,
"is_taxed": false,
"tax_amount": 0,
"object": "line_item",
"amount": 100,
"description": "basic description1",
"entity_type": "plan",
"entity_id": "basic",
"tax_exempt_reason": "tax_not_configured",
"discount_amount": 0,
"item_level_discount_amount": 0,
"subscription_id": "8avVGOkx8U1MX"
},
{..}
],
"taxes": [],
"line_item_taxes": [],
"line_item_discounts": [],
"linked_refunds": [],
"allocations": []
}
API Index URL GET
https://{site}.chargebee.com/api/v2/credit_notes
Credit note attributes¶
id
The Credit Note number. Acts as an identifier fo Credit Note and typically generated sequentially.
string, max chars=50
string, max chars=50
customer_id
The identifier of the customer this Credit Note belongs to.
string, max chars=50
string, max chars=50
subscription_id
The identifier of the subscription this Credit Note belongs to.
optional, string, max chars=50
optional, string, max chars=50
reference_invoice_id
The identifier of the invoice against which this Credit Note is issued.
string, max chars=50
string, max chars=50
type
The Credit Note type. More details here.
enumerated string
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
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.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.
Show all values[+]
status
The status of this Credit Note.
enumerated string
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 canceled.
vat_number
VAT number of the customer for whom this Credit Note is raised.
optional, string, max chars=20
optional, string, max chars=20
date
The date the Credit Note is issued.
optional, timestamp(UTC) in seconds
optional, timestamp(UTC) in seconds
price_type
The price type of the Credit Note.
enumerated string, default=tax_exclusive
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
string, max chars=3
total
Credit Note amount in cents.
optional, in cents, default=0, min=0
optional, in cents, default=0, min=0
amount_allocated
The amount allocated to the invoices.
optional, in cents, default=0, min=0
optional, in cents, default=0, min=0
amount_refunded
The refunds issued from this Credit Note.
optional, in cents, default=0, min=0
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
optional, in cents, default=0, min=0
refunded_at
The time this Credit Note got fully used.
optional, timestamp(UTC) in seconds
optional, timestamp(UTC) in seconds
voided_at
Timestamp indicating the date & time this credit note got voided.
optional, timestamp(UTC) in seconds
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
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
optional, timestamp(UTC) in seconds
sub_total
The Credit Note sub-total.
in cents, min=0
in cents, min=0
deleted
Indicates that this resource has been deleted.
boolean
boolean
line_items
Show attributes[+]
Show attributes[+]
The line items of this Credit Note.
optional, list of line_item
optional, list of line_item
Line item attributes
id
Uniquely identifies a line_item.
optional, string, max chars=40
optional, string, max chars=40
subscription_id
A unique identifier for the subscription this lineitem belongs to.
optional, string, max chars=3
optional, string, max chars=3
date_from
Start date of this lineitem.
timestamp(UTC) in seconds
timestamp(UTC) in seconds
date_to
End date of this lineitem.
timestamp(UTC) in seconds
timestamp(UTC) in seconds
unit_amount
Unit amount of the lineitem.
in cents
in cents
quantity
Quantity of the recurring item which is represented by this lineitem.
optional, integer, default=1
optional, integer, default=1
is_taxed
Specifies whether this line item is taxed or not.
boolean, default=false
boolean, default=false
tax_amount
The tax amount charged for this item.
optional, in cents, default=0, min=0
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
optional, double, min=0.0, max=100.0
amount
Total amount of this lineitem. Typically equals to unit amount x quantity.
in cents
in cents
discount_amount
Total discounts for this line.
optional, in cents, min=0
optional, in cents, min=0
item_level_discount_amount
'Item' level discounts for this line.
optional, in cents, min=0
optional, in cents, min=0
description
Detailed description about this lineitem.
string, max chars=250
string, max chars=250
entity_type
Specifies the modelled entity (plan / addon etc) this lineitem is based on.
enumerated string
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
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 .
entity_id
The identifier of the modelled entity this lineitem is based on. Will be null for 'adhoc' entity type.
optional, string, max chars=50
optional, string, max chars=50
discounts
Show attributes[+]
Show attributes[+]
The list of discounts applied to this Credit Note.
optional, list of discount
optional, list of discount
Discount attributes
amount
Discount amount.
in cents, min=0
in cents, min=0
description
Detailed description of this discount line item.
optional, string, max chars=250
optional, string, max chars=250
entity_type
Type of this Discount lineitem.
enumerated string
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
optional, string, max chars=100
line_item_discounts
Show attributes[+]
Show attributes[+]
The list of discount(s) applied for each line item of this invoice.
optional, list of line_item_discount
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
string, max chars=50
discount_type
Type of this discount line item.
enumerated string
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
optional, string, max chars=50
discount_amount
Discount amount.
in cents, min=0
in cents, min=0
taxes
Show attributes[+]
Show attributes[+]
The tax-lines of this Credit Note.
optional, list of tax
optional, list of tax
Tax attributes
name
The name of the tax applied. E.g. GST.
string, max chars=100
string, max chars=100
amount
The tax amount.
in cents, min=0
in cents, min=0
description
Description of the tax item.
optional, string, max chars=250
optional, string, max chars=250
line_item_taxes
Show attributes[+]
Show attributes[+]
The list of taxes applied on line items.
optional, list of line_item_tax
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
optional, string, max chars=40
tax_name
The name of the tax applied.
string, max chars=100
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
double, default=0.0, min=0.0, max=100.0
tax_amount
The tax amount.
in cents, min=0
in cents, min=0
tax_juris_type
The type of tax jurisdiction.
optional, enumerated string
optional, enumerated string
Possible values are
countryThe tax jurisdiction is a country.stateThe tax jurisdiction is a state.countyThe tax jurisdiction is a county.cityThe tax jurisdiction is a city.specialSpecial tax jurisdiction.otherJurisdictions other than the ones listed above.
tax_juris_name
The name of the tax jurisdiction.
optional, string, max chars=250
optional, string, max chars=250
tax_juris_code
The tax jurisdiction code.
optional, string, max chars=250
optional, string, max chars=250
linked_refunds
Show attributes[+]
Show attributes[+]
Refunds issued from this Credit Note.
optional, list of credit_note_transaction
optional, list of credit_note_transaction
Linked refund attributes
txn_id
Uniquely identifies the transaction.
string, max chars=40
string, max chars=40
applied_amount
The transaction amount applied to this invoice.
in cents, min=0
in cents, min=0
applied_at
timestamp(UTC) in seconds
txn_status
The status of this transaction.
optional, enumerated string
optional, enumerated string
Possible values are
in_progressTransaction is being processed via ACH.successTransaction is sucessful.voidedTransaction got voided.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
optional, timestamp(UTC) in seconds
txn_amount
Total amount of the transaction.
optional, in cents, min=1
optional, in cents, min=1
allocations
Show attributes[+]
Show attributes[+]
Invoice allocations made from this Credit Note.
optional, list of applied_credit
optional, list of applied_credit
Allocation attributes
invoice_id
string, max chars=50
allocated_amount
Amount of this refund transaction.
in cents, min=0
in cents, min=0
allocated_at
Indicates when this refund occured.
timestamp(UTC) in seconds
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
optional, timestamp(UTC) in seconds
invoice_status
Current status of the invoice.
enumerated string
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¶
Sample Request
curl https://{site}.chargebee.com/api/v2/credit_notes \
-u {site_api_key}: \
-d reference_invoice_id="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="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 ]
{
"credit_note": {
"id": "TEST-CN-2",
"customer_id": "8avVGOkx8U1MX",
"subscription_id": "8avVGOkx8U1MX",
"reference_invoice_id": "1",
"type": "refundable",
"reason_code": "product_unsatisfactory",
"status": "refund_due",
"date": 1493234413,
"price_type": "tax_exclusive",
"exchange_rate": 1.0,
"total": 500,
"amount_allocated": 0,
"amount_refunded": 0,
"amount_available": 500,
"updated_at": 1493234413,
"resource_version": 1493234413000,
"deleted": false,
"object": "credit_note",
"currency_code": "USD",
"base_currency_code": "USD",
"sub_total": 500,
"line_items": [
{
"id": "li_3Nl8KYnQHvnQADVZ",
"date_from": 1493234413,
"date_to": 1493234413,
"unit_amount": 500,
"quantity": 1,
"is_taxed": false,
"tax_amount": 0,
"object": "line_item",
"amount": 500,
"description": "Basic",
"entity_type": "plan",
"entity_id": "basic",
"tax_exempt_reason": "tax_not_configured",
"discount_amount": 0,
"item_level_discount_amount": 0,
"subscription_id": "8avVGOkx8U1MX"
},
{..}
],
"taxes": [],
"line_item_taxes": [],
"line_item_discounts": [],
"linked_refunds": [],
"allocations": []
},
"invoice": {
"id": "1",
"customer_id": "8avVGOkx8U1MX",
"subscription_id": "8avVGOkx8U1MX",
"recurring": true,
"status": "paid",
"price_type": "tax_exclusive",
"date": 1414780232,
"due_date": 1414780232,
"net_term_days": 0,
"exchange_rate": 1.0,
"total": 900,
"amount_paid": 900,
"amount_adjusted": 0,
"write_off_amount": 0,
"credits_applied": 0,
"amount_due": 0,
"paid_at": 1414780233,
"updated_at": 1493234413,
"resource_version": 1493234413000,
"deleted": false,
"object": "invoice",
"first_invoice": true,
"has_advance_charges": false,
"currency_code": "USD",
"base_currency_code": "USD",
"tax": 0,
"line_items": [
{
"id": "li_KyVmylQHvml2wN",
"date_from": 1414780232,
"date_to": 1417372232,
"unit_amount": 900,
"quantity": 1,
"is_taxed": false,
"tax_amount": 0,
"object": "line_item",
"amount": 900,
"description": "Basic",
"entity_type": "plan",
"entity_id": "basic",
"tax_exempt_reason": "tax_not_configured",
"discount_amount": 0,
"item_level_discount_amount": 0,
"subscription_id": "8avVGOkx8U1MX"
},
{..}
],
"sub_total": 900,
"linked_payments": [
{
"txn_id": "txn_KyVmylQHvml6vO",
"applied_amount": 900,
"applied_at": 1414780233,
"txn_status": "success",
"txn_date": 1414780233,
"txn_amount": 900
},
{..}
],
"applied_credits": [],
"adjustment_credit_notes": [],
"issued_credit_notes": [
{
"cn_id": "TEST-CN-1",
"cn_reason_code": "waiver",
"cn_date": 1493234299,
"cn_total": 100,
"cn_status": "refund_due"
},
{..}
],
"linked_orders": [
{
"id": "XpbG8t4OvwWgjzM",
"status": "processing",
"reference_id": "1002",
"fulfillment_status": "Awaiting Shipment",
"created_at": 1493234277
},
{..}
],
"billing_address": {
"first_name": "Benjamin",
"last_name": "Ross",
"validation_status": "not_validated",
"object": "billing_address"
}
}
}
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
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
optional, in cents, default=0, min=0
type
The Credit Note type. More details here.
required, enumerated string
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
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
optional, timestamp(UTC) in seconds
customer_notes
The Customer Notes to be filled in the Credit Notes created.
optional, string, max chars=1000
optional, string, max chars=1000
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>]
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
required, string, max chars=40
line_items[unit_amount][0..n]
Unit amount of the lineitem.
required, in cents
required, in cents
line_items[quantity][0..n]
Quantity of the recurring item which is represented by this lineitem.
required, integer, default=1
required, integer, default=1
line_items[description][0..n]
Description for the line item.
optional, string, max chars=250
optional, string, max chars=250
Returns
Resource object representing credit_note.
always returned
always returned
Resource object representing invoice.
always returned
always returned
Retrieve a credit note¶
Sample Request
curl https://{site}.chargebee.com/api/v2/credit_notes/TEST-CN-1 \
-u {site_api_key}:
copy
curl https://{site}.chargebee.com/api/v2/credit_notes/TEST-CN-1 \
-u {site_api_key}:
Sample Response [ JSON ]
{"credit_note": {
"id": "TEST-CN-1",
"customer_id": "8avVGOkx8U1MX",
"subscription_id": "8avVGOkx8U1MX",
"reference_invoice_id": "1",
"type": "refundable",
"reason_code": "waiver",
"status": "refund_due",
"date": 1493234299,
"price_type": "tax_exclusive",
"exchange_rate": 1.0,
"total": 100,
"amount_allocated": 0,
"amount_refunded": 0,
"amount_available": 100,
"updated_at": 1493234299,
"resource_version": 1493234299000,
"deleted": false,
"object": "credit_note",
"currency_code": "USD",
"base_currency_code": "USD",
"sub_total": 100,
"line_items": [
{
"id": "li_KyVmylQHvmwUy6H",
"date_from": 1493234299,
"date_to": 1493234299,
"unit_amount": 100,
"quantity": 1,
"is_taxed": false,
"tax_amount": 0,
"object": "line_item",
"amount": 100,
"description": "basic description1",
"entity_type": "plan",
"entity_id": "basic",
"tax_exempt_reason": "tax_not_configured",
"discount_amount": 0,
"item_level_discount_amount": 0,
"subscription_id": "8avVGOkx8U1MX"
},
{..}
],
"taxes": [],
"line_item_taxes": [],
"line_item_discounts": [],
"linked_refunds": [],
"allocations": []
}}
URL Format GET
https://{site}.chargebee.com/api/v2/credit_notes/{credit_note_id}
Returns
Resource object representing credit_note.
always returned
always returned
Sample admin console URL
https://{site}.chargebee.com/admin-console/credit_notes/TEST-CN-1
Retrieve Credit Note as PDF¶
Sample Request
curl https://{site}.chargebee.com/api/v2/credit_notes/TEST-CN-1/pdf \
-X POST \
-u {site_api_key}:
copy
curl https://{site}.chargebee.com/api/v2/credit_notes/TEST-CN-1/pdf \
-X POST \
-u {site_api_key}:
Sample Response [ JSON ]
{"download": {
"download_url": "https://cb-downloads-dev.s3.amazonaws.com/yourapp/credit_note/3Nl8KYnQHvnS28Vb.pdf?response-content-disposition=attachment%3Bfilename%3Dyourapp%2Fcredit_note%2F3Nl8KYnQHvnS28Vb.pdf&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20170426T192025Z&X-Amz-SignedHeaders=host&X-Amz-Expires=59&X-Amz-Credential=AKIAJ3MOW2V2DPJQTCMQ%2F20170426%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=1706a532f35eb1307d81a312c7b4e29d9d7574e7343ed084fa13a0d4a772fbeb",
"valid_till": 1493234485,
"object": "download"
}}
URL Format POST
https://{site}.chargebee.com/api/v2/credit_notes/{credit_note_id}/pdf
Returns
Resource object representing download.
always returned
always returned
List credit notes¶
Sample Request
curl https://{site}.chargebee.com/api/v2/credit_notes \
-G \
-u {site_api_key}: \
--data-urlencode limit="5" \
--data-urlencode type[is]="adjustment" \
--data-urlencode total[is_not]="1200" \
--data-urlencode sort_by[asc]="date"
copy
curl https://{site}.chargebee.com/api/v2/credit_notes \
-G \
-u {site_api_key}: \
--data-urlencode limit="5" \
--data-urlencode type[is]="adjustment" \
--data-urlencode total[lt]="1200" \
--data-urlencode sort_by[asc]="date"
Sample Response [ JSON ]
{
"list": [
{"credit_note": {
"id": "TEST-CN-2",
"customer_id": "8avVGOkx8U1MX",
"subscription_id": "8avVGOkx8U1MX",
"reference_invoice_id": "1",
"type": "refundable",
"reason_code": "product_unsatisfactory",
"status": "refund_due",
"date": 1493234413,
"price_type": "tax_exclusive",
"exchange_rate": 1.0,
"total": 500,
"amount_allocated": 0,
"amount_refunded": 0,
"amount_available": 500,
"updated_at": 1493234413,
"resource_version": 1493234413000,
"deleted": false,
"object": "credit_note",
"currency_code": "USD",
"base_currency_code": "USD",
"sub_total": 500,
"line_items": [
{
"id": "li_3Nl8KYnQHvnQADVZ",
"date_from": 1493234413,
"date_to": 1493234413,
"unit_amount": 500,
"quantity": 1,
"is_taxed": false,
"tax_amount": 0,
"object": "line_item",
"amount": 500,
"description": "Basic",
"entity_type": "plan",
"entity_id": "basic",
"tax_exempt_reason": "tax_not_configured",
"discount_amount": 0,
"item_level_discount_amount": 0,
"subscription_id": "8avVGOkx8U1MX"
},
{..}
],
"taxes": [],
"line_item_taxes": [],
"line_item_discounts": [],
"linked_refunds": [],
"allocations": []
}},
{..}
],
"next_offset": "[\"1493234413000\",\"145000000084\"]"
}
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
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
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
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
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
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
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 CreditNote Subscription Id.
Supported operators : is, is_not, starts_with, is_present, in, not_in
Example → subscription_id[is] = "4gmiXbsjdm"
optional, string filter
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
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] = "adjustment"
optional, enumerated string filter
Supported operators : is, is_not, in, not_in
Example → type[is] = "adjustment"
optional, enumerated string filter
reason_code[<operator>]
To filter based on CreditNote Reason Code. Possible values are : write_off, subscription_change, subscription_cancellation, chargeback, product_unsatisfactory, service_unsatisfactory, order_change, order_cancellation, waiver, other.
Supported operators : is, is_not, in, not_in
Example → reason_code[is_not] = "waiver"
optional, enumerated string filter
Supported operators : is, is_not, in, not_in
Example → reason_code[is_not] = "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_not] = "adjusted"
optional, enumerated string filter
Supported operators : is, is_not, in, not_in
Example → status[is_not] = "adjusted"
optional, enumerated string filter
date[<operator>]
To filter based on CreditNote Date.
Supported operators : after, before, on, between
Example → date[on] = "1435054328"
optional, timestamp(UTC) in seconds filter
Supported operators : after, before, on, between
Example → date[on] = "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] = "1200"
optional, in cents filter
Supported operators : is, is_not, lt, lte, gt, gte, between
Example → total[is] = "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
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[is_not] = "1200"
optional, in cents filter
Supported operators : is, is_not, lt, lte, gt, gte, between
Example → amount_allocated[is_not] = "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[gte] = "130"
optional, in cents filter
Supported operators : is, is_not, lt, lte, gt, gte, between
Example → amount_refunded[gte] = "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[is] = "1400"
optional, in cents filter
Supported operators : is, is_not, lt, lte, gt, gte, between
Example → amount_available[is] = "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
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[on] = "1243545465"
optional, timestamp(UTC) in seconds filter
Supported operators : after, before, on, between
Example → updated_at[on] = "1243545465"
optional, timestamp(UTC) in seconds filter
Returns
Resource object representing credit_note.
always returned
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
optional, string, max chars=1000