InvoiceItems
Create, update, delete, and query the available invoices items in Stripe.
Table Specific Information
Select
Server-Side Query Support
The driver will use the Stripe API to filter the results by the following columns and operators while the rest of the filter is executed client side within the driver.
- Id, InvoiceId, and Customer support the following operator: =.
The provider supports all columns to be used as criteria in the WHERE clause of Select statement, as long as SupportEnhancedSQL is set to True. If SupportEnhancedSQL property is set to False, you still can retrieve:
-an All InvoiceLineItems:
SELECT * FROM InvoiceItems
-an InvoiceLineItems by specifying its Id:
SELECT * FROM InvoiceItems WHERE Id = 'or_12345678'
-InvoiceLineItems for a given Customer:
SELECT * FROM InvoiceItems WHERE Customer = 'cus_12345678'
Columns
Name | Type | ReadOnly | References | Description |
Id [KEY] | String | True |
The Id of the invoice item. | |
InvoiceId | String | False |
Invoices.Id |
The Id of the invoice. |
Amount | Int | False |
The amount, in cents. | |
Customer | String | False |
Customers.Id |
Three-letter ISO currency code, in lowercase. Must be a supported currency. |
Currency | String | False |
Three-letter ISO currency code, in lowercase. Must be a supported currency. | |
Date | Datetime | False |
Time at which the object was created. | |
Description | String | False |
An arbitrary string attached to the object. Often useful for displaying to users. The description field on invoice line items has a maximum character length limit of 500 | |
Discountable | Boolean | False |
If true, discounts will apply to this line item. Always false for prorations. | |
LiveMode | Boolean | False |
Has the value true if the object exists in live mode or the value false if the object exists in test mode. | |
PeriodStart | Datetime | False |
The start of the period.. | |
PeriodEnd | Datetime | False |
The end of the period, which must be greater than or equal to the start. | |
PlanId | String | False |
Unique identifier for the plan. | |
PlanAggregate | String | True |
The plan of the subscription, if the line item is a subscription or a proration. | |
PriceId | String | False |
Unique identifier for the price. | |
PriceAggregate | String | True |
The price of the invoice item. | |
Proration | Boolean | True |
Whether this is a proration. | |
Quantity | Int | False |
The quantity of the subscription, if the line item is a subscription or a proration. | |
Subscription | String | False |
The id of the subscription the item pertains to. | |
SubscriptionItems | String | False |
The subscription item that this invoice item has been created for, if any. | |
TestClock | String | False |
ID of the test clock this invoice item belongs to. | |
UnitAmount | Integer | False |
Unit amount (in the currency specified) of the invoice item. | |
UnitAmountDecimal | Decimal | False |
Decimal value of Unit amount (in the currency specified) of the invoice item. | |
MetadataAggregate | String | False |
The metadata object. | |
DiscountsAggregate | String | False |
The discounts which apply to the invoice item. | |
TaxRatesAggregate | String | False |
The tax rates which apply to the invoice item. When set, the default_tax_rates on the invoice do not apply to this invoice item. |
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 invoice line items for |