Reference

Endpoint Retrieve an Upcoming Invoice Line Items


Name

upcoming_invoice_lines

Description

When retrieving an upcoming invoice, you’ll get a lines property containing the total count of line items and the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items. [API reference]

Parameters

Parameter Required Options
Name: customer

Label: Customer Id

The identifier of the customer whose upcoming invoice you’d like to retrieve.
Name: subscription

Label: Subscription Id

The identifier of the subscription for which you’d like to retrieve the upcoming invoice.

Output Columns

Label Data Type (SSIS) Data Type (SQL) Length Description
URL DT_WSTR nvarchar(1020) 1020
Id DT_WSTR nvarchar(100) 100
Object DT_WSTR nvarchar(100) 100
Amount DT_I8 bigint
Currency DT_WSTR nvarchar(100) 100
Description DT_WSTR nvarchar(255) 255
DiscountAmounts DT_WSTR nvarchar(100) 100
Discountable DT_BOOL bit
Discounts DT_WSTR nvarchar(100) 100
LiveMode DT_BOOL bit
PeriodEnd DT_DBTIMESTAMP datetime
PeriodStart DT_DBTIMESTAMP datetime
PlanID DT_WSTR nvarchar(255) 255
PlanObject DT_WSTR nvarchar(100) 100
PlanActive DT_BOOL bit
PlanAggregateUsage DT_WSTR nvarchar(100) 100
PlanAmount DT_I8 bigint
PlanAmountDecimal DT_WSTR nvarchar(100) 100
PlanBillingScheme DT_WSTR nvarchar(100) 100
PlanCreated DT_DBTIMESTAMP datetime
PlanCurrency DT_WSTR nvarchar(100) 100
PlanInterval DT_WSTR nvarchar(100) 100
PlanIntervalCount DT_I8 bigint
PlanLivemode DT_BOOL bit
PlanNickname DT_WSTR nvarchar(100) 100
PlanProductId DT_WSTR nvarchar(100) 100
PlanTiersMode DT_WSTR nvarchar(1020) 1020
PlanTransformUsage DT_WSTR nvarchar(1020) 1020
PlanTrialPeriodDays DT_I8 bigint
PlanUsageType DT_WSTR nvarchar(100) 100
PriceID DT_WSTR nvarchar(255) 255
PriceObject DT_WSTR nvarchar(100) 100
PriceActive DT_BOOL bit
PriceBillingScheme DT_WSTR nvarchar(100) 100
PriceCreated DT_DBTIMESTAMP datetime
PriceCurrency DT_WSTR nvarchar(100) 100
PriceLivemode DT_BOOL bit
PriceLookupKey DT_WSTR nvarchar(1020) 1020
PriceNickname DT_WSTR nvarchar(100) 100
PriceProductId DT_WSTR nvarchar(100) 100
PriceRecurringAggregateUsage DT_WSTR nvarchar(100) 100
PriceRecurringInterval DT_WSTR nvarchar(100) 100
PriceRecurringIntervalCount DT_I8 bigint
PriceRecurringTrialPeriodDays DT_I8 bigint
PriceRecurringUsageType DT_WSTR nvarchar(100) 100
PriceTiersMode DT_WSTR nvarchar(1020) 1020
PriceTransformQuantity DT_WSTR nvarchar(1020) 1020
PriceType DT_WSTR nvarchar(100) 100
PriceUnitAmount DT_I8 bigint
PriceUnitAmountDecimal DT_WSTR nvarchar(100) 100
Proration DT_BOOL bit
Quantity DT_I8 bigint
SubscriptionId DT_WSTR nvarchar(100) 100
SubscriptionItem DT_WSTR nvarchar(1000) 1000
TaxAmounts DT_WSTR nvarchar(100) 100
TaxRates DT_WSTR nvarchar(100) 100
Type DT_WSTR nvarchar(100) 100
If the column you are looking for is missing, consider customizing Stripe Connector.

Input Columns

Label Data Type (SSIS) Data Type (SQL) Length Description
There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime.

Examples

SSIS

Use Stripe Connector in API Source or in API Destination SSIS Data Flow components to read or write data.

API Source

API Source - Stripe
This connector support read/write operations for Stripe APIs
Stripe
Retrieve an Upcoming Invoice Line Items
Optional Parameters
Customer Id
Subscription Id
SSIS API Source - Read from table or endpoint

API Destination

API Destination - Stripe
This connector support read/write operations for Stripe APIs
Stripe
Retrieve an Upcoming Invoice Line Items
Optional Parameters
Customer Id
Subscription Id
SSIS API Destination - Access table or endpoint

ODBC application

Use these SQL queries in your ODBC application data source:

Retrieve an upcoming invoice line items

SELECT * FROM upcoming_invoice_lines

SQL Server

Use these SQL queries in SQL Server after you create a data source in Data Gateway:

Retrieve an upcoming invoice line items

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM upcoming_invoice_lines';

EXEC (@MyQuery) AT [LS_TO_STRIPE_IN_GATEWAY];