# credit\_note\_line\_item

From **Stripe API**.

- Type: `object`

## Properties

### `amount`

- Required: true
- Type: `integer`

The integer amount in %s representing the gross amount being credited for this line item, excluding (exclusive) tax and discounts.

### `description`

- Required: false
- Type: `string`
- Nullable: true
- maxLength: `5000`

Description of the item being credited.

### `discount_amount`

- Required: true
- Type: `integer`

The integer amount in %s representing the discount being credited for this line item.

### `discount_amounts`

- Required: true
- Type: `array`

The amount of discount calculated per discount for this line item

### `id`

- Required: true
- Type: `string`
- maxLength: `5000`

Unique identifier for the object.

### `invoice_line_item`

- Required: false
- Type: `string`
- maxLength: `5000`

ID of the invoice line item being credited

### `livemode`

- Required: true
- Type: `boolean`

Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.

### `object`

- Required: true
- Type: `string`
- Allowed values: `"credit_note_line_item"`

String representing the object's type. Objects of the same type share the same value.

### `quantity`

- Required: false
- Type: `integer`
- Nullable: true

The number of units of product being credited.

### `tax_amounts`

- Required: true
- Type: `array`

The amount of tax calculated per tax rate for this line item

### `tax_rates`

- Required: true
- Type: `array`

The tax rates which apply to the line item.

### `type`

- Required: true
- Type: `string`
- Allowed values: `"custom_line_item"`, `"invoice_line_item"`

The type of the credit note line item, one of `invoice_line_item` or `custom_line_item`. When the type is `invoice_line_item` there is an additional `invoice_line_item` property on the resource the value of which is the id of the credited line item on the invoice.

### `unit_amount`

- Required: false
- Type: `integer`
- Nullable: true

The cost of each unit of product being credited.

### `unit_amount_decimal`

- Required: false
- Type: `string`
- Format: `decimal`
- Nullable: true

Same as `unit_amount`, but contains a decimal value with at most 12 decimal places.

## JSON Schema

```json
{"properties":{"amount":{"description":"The integer amount in %s representing the gross amount being credited for this line item, excluding (exclusive) tax and discounts.","type":"integer"},"description":{"description":"Description of the item being credited.","maxLength":5000,"nullable":true,"type":"string"},"discount_amount":{"description":"The integer amount in %s representing the discount being credited for this line item.","type":"integer"},"discount_amounts":{"description":"The amount of discount calculated per discount for this line item","items":{"$ref":"#/components/schemas/discounts_resource_discount_amount"},"type":"array"},"id":{"description":"Unique identifier for the object.","maxLength":5000,"type":"string"},"invoice_line_item":{"description":"ID of the invoice line item being credited","maxLength":5000,"type":"string"},"livemode":{"description":"Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.","type":"boolean"},"object":{"description":"String representing the object's type. Objects of the same type share the same value.","enum":["credit_note_line_item"],"type":"string"},"quantity":{"description":"The number of units of product being credited.","nullable":true,"type":"integer"},"tax_amounts":{"description":"The amount of tax calculated per tax rate for this line item","items":{"$ref":"#/components/schemas/credit_note_tax_amount"},"type":"array"},"tax_rates":{"description":"The tax rates which apply to the line item.","items":{"$ref":"#/components/schemas/tax_rate"},"type":"array"},"type":{"description":"The type of the credit note line item, one of `invoice_line_item` or `custom_line_item`. When the type is `invoice_line_item` there is an additional `invoice_line_item` property on the resource the value of which is the id of the credited line item on the invoice.","enum":["custom_line_item","invoice_line_item"],"type":"string"},"unit_amount":{"description":"The cost of each unit of product being credited.","nullable":true,"type":"integer"},"unit_amount_decimal":{"description":"Same as `unit_amount`, but contains a decimal value with at most 12 decimal places.","format":"decimal","nullable":true,"type":"string"}},"required":["amount","discount_amount","discount_amounts","id","livemode","object","tax_amounts","tax_rates","type"],"title":"CreditNoteLineItem","type":"object","x-expandableFields":["discount_amounts","tax_amounts","tax_rates"],"x-resourceId":"credit_note_line_item"}
```