TDV Adapter for Stripe

Build 24.0.9060

InvoiceLineItems

Query the available invoices line items in Stripe.

Table Specific Information

Select

Server-Side Query Support

The adapter uses 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 adapter.

  • InvoiceId support the following operator: =.
  • AccountId support the following operator: =.

You can select from InvoiceLineItems with the following queries:

    SELECT * FROM InvoiceLineItems WHERE Id = 'lineitem_1GhPzLJXTn'
    SELECT * FROM InvoiceLineItems WHERE InvoiceId = 'in_123456'
    SELECT * FROM InvoiceLineItems WHERE AccountId = 'acct_1Gqj58Ly0qyl5A'
    SELECT * FROM InvoiceLineItems WHERE Amount > 10000
    SELECT * FROM InvoiceLineItems WHERE Currency = 'usd'

Columns

Name Type References Description
Id [KEY] String Unique identifier for the object.
InvoiceId String The Id of the invoice.
Amount Integer The amount, in cents.
AmountExcludingTax Integer The integer amount in cents representing the amount for this line item, excluding all tax and discounts.
Currency String Three-letter ISO currency code, in lowercase. Must be a supported currency.
Description String An arbitrary string attached to the object. Often useful for displaying to users.
Discountable Boolean If true, discounts will apply to this line item. Always false for prorations.
InvoiceItem String The Id of the invoice item associated with this line item if any.
LiveMode Boolean Has the value true if the object exists in live mode or the value false if the object exists in test mode.
Metadata String The metadata object.
Object String String representing the object's type. Objects of the same type share the same value.
PeriodEnd Datetime The end of the period, which must be greater than or equal to the start.
PeriodStart Datetime The start of the period.
PriceId String Unique identifier for the price.
PriceObject String String representing the object's type. Objects of the same type share the same value.
PriceActive Boolean Whether the price can be used for new purchases.
PriceBillingScheme String Describes how to compute the price per period.
PriceCreated Datetime Time at which the object was created. Measured in seconds since the Unix epoch.
PriceCurrency String Three-letter ISO currency code, in lowercase. Must be a supported currency.
PriceCustomUnitAmount String When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
PriceLiveMode Boolean Has the value true if the object exists in live mode or the value false if the object exists in test mode.
PriceLookupKey String A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.
PriceMetadata String Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
PriceNickname String A brief description of the price, hidden from customers.
PriceProduct String The Id of the product this price is associated with.
PriceRecurring String The recurring components of a price such as interval and usage_type.
PriceTaxBehavior String Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified. Once specified as either inclusive or exclusive, it cannot be changed.
PriceTiersMode String Defines if the tiering price should be graduated or volume based. In volume-based tiering, the maximum quantity within a period determines the per unit price. In graduated tiering, pricing can change as the quantity grows.
PriceTransformQuantity String Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with tiers.
PriceType String One of one_time or recurring depending on whether the price is for a one-time purchase or a recurring (subscription) purchase.
PriceUnitAmount Integer The unit amount in cents to be charged, represented as a whole integer if possible. Only set if billing_scheme=per_unit.
PriceUnitAmountDecimal Float The unit amount in cents to be charged, represented as a decimal string with at most 12 decimal places. Only set if billing_scheme=per_unit.
Proration Boolean Whether this is a proration.
ProrationDetails String Additional details for proration line items.
Quantity Integer The quantity of the subscription, if the line item is a subscription or a proration.
Subscription String The subscription that the invoice item pertains to, if any.
SubscriptionItems String The subscription item that generated this invoice item. Left empty if the line item is not an explicit result of a subscription.
Type String A string identifying the type of the source of this line item, either an invoiceitem or a subscription.
UnitAmountExcludingTax String The amount in cents representing the unit amount for this line item, excluding all tax and discounts.
DiscountAmountsAggregate String The amount of discount calculated per discount for this line item.
TaxAmountsAggregate String The amount of tax calculated per tax rate for this line item.
TaxRatesAggregate String The tax rates which apply to the line item.
DiscountsAggregate String The discounts which apply to the invoice item.
PlanActive Boolean Active.
PlanAggregateUsage String Aggregate Usage.
PlanAmount Integer Amount.
PlanAmountDecimal String Amount in decimal.
PlanBillingScheme String Billing scheme.
PlanCreated Datetime Created timestamp.
PlanCurrency String Currency code.
PlanId String Id of the plan.
PlanInterval String Interval.
PlanIntervalCount Integer Interval count.
PlanLivemode Boolean Livemode.
PlanMetadata String Metadata of the Plan.
PlanMeter String Meter.
PlanNickname String Nickname.
PlanObject String Object.
PlanProduct String Product.
PlanTiersMode String Tiers mode.
PlanTransformUsage String Transform usage.
PlanTrialPeriodDays Integer Trial period days.
PlanUsageType String Usage type.

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.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060