CreditNotePreviewLineItems
Query the available Credit Note preview line items in Stripe.
Table Specific Information
Select
The cmdlet uses the Stripe API to filter the results by the following column and operator:
- InvoiceId supports the = operator.
- AccountId supports the = operator.
The rest of the filter is executed client-side within the cmdlet.
The provider supports the use of all columns as criteria in the WHERE clause of SELECT statements and InvoiceId column is a required column, as long as SupportEnhancedSQL is set to True. If SupportEnhancedSQL property is set to False, you still can retrieve:
SELECT * FROM CreditNotePreviewLineItems where InvoiceId = 'in_1PDhVw2eZvKYlo2C6J4CKKUd'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | ID of the Credit Note Preview LineItem. | |
| InvoiceId | String |
Invoices.Id | ID of the invoice. |
| Amount | Integer | The integer amount in cents representing the total amount of the credit note. | |
| CreditAmount | Integer | The integer amount in cents representing the amount to credit the customer's balance, which will be automatically applied to their next invoice. | |
| AmountShipping | Integer | Amount shipping. | |
| Created | Datetime | Date of creation. | |
| Currency | String | Currency name. | |
| Customer | String | Customer Id. | |
| CustomerBalanceTransaction | String | Customer balance transaction. | |
| DiscountAmounts | String | Discount amounts. | |
| EffectiveAt | Datetime | The date when this credit note is in effect. Same as created unless overwritten. When defined, this value replaces the system-generated Date of issue printed on the credit note PDF. | |
| Lines | String | Line items that make up the credit note. | |
| Livemode | Boolean | Boolean value of Livemode. | |
| Memo | String | The credit note's memo appears on the credit note PDF. | |
| Metadata | String | Set of key-value pairs that you can attach to an object. | |
| Number | String | Number. | |
| OutOfBandAmount | Integer | The integer amount in cents representing the amount that is credited outside of Stripe. | |
| String | Pdf url. | ||
| Reason | String | Reason for issuing this credit note, one of duplicate, fraudulent, order_change, or product_unsatisfactory. | |
| Refund | String | ID of an existing refund to link this credit note to. | |
| RefundAmount | Integer | The integer amount in cents representing the amount to refund. If set, a refund will be created for the charge associated with the invoice. | |
| ShippingCost | String | When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note. | |
| Status | String | Status. | |
| Subtotal | Integer | Subtotal. | |
| SubtotalExcludingTax | Integer | Subtotal excluding tax. | |
| TaxAmounts | String | Tax amounts. | |
| Total | Integer | Total. | |
| TotalExcludingTax | Integer | Total excluding tax. | |
| Type | String | Type. | |
| VoidedAt | Datetime | Voided at. |
Pseudo-Columns
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| AccountId | String | The Id of the connected account to get orders for. |