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	Label	Required	Options	Description
customer	Customer Id	NO		The identifier of the customer whose upcoming invoice you’d like to retrieve.
subscription	Subscription Id	NO		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	Raw
URL	`DT_WSTR`	`nvarchar(1020)`	1020	`False`
Id	`DT_WSTR`	`nvarchar(100)`	100	`False`
Object	`DT_WSTR`	`nvarchar(100)`	100	`False`
Amount	`DT_I8`	`bigint`		`False`
Currency	`DT_WSTR`	`nvarchar(100)`	100	`False`
Description	`DT_WSTR`	`nvarchar(255)`	255	`False`
DiscountAmounts	`DT_WSTR`	`nvarchar(100)`	100	`False`
Discountable	`DT_BOOL`	`bit`		`False`
Discounts	`DT_WSTR`	`nvarchar(100)`	100	`False`
LiveMode	`DT_BOOL`	`bit`		`False`
PeriodEnd	`DT_DBTIMESTAMP`	`datetime`		`False`
PeriodStart	`DT_DBTIMESTAMP`	`datetime`		`False`
PlanID	`DT_WSTR`	`nvarchar(255)`	255	`False`
PlanObject	`DT_WSTR`	`nvarchar(100)`	100	`False`
PlanActive	`DT_BOOL`	`bit`		`False`
PlanAggregateUsage	`DT_WSTR`	`nvarchar(100)`	100	`False`
PlanAmount	`DT_I8`	`bigint`		`False`
PlanAmountDecimal	`DT_WSTR`	`nvarchar(100)`	100	`False`
PlanBillingScheme	`DT_WSTR`	`nvarchar(100)`	100	`False`
PlanCreated	`DT_DBTIMESTAMP`	`datetime`		`False`
PlanCurrency	`DT_WSTR`	`nvarchar(100)`	100	`False`
PlanInterval	`DT_WSTR`	`nvarchar(100)`	100	`False`
PlanIntervalCount	`DT_I8`	`bigint`		`False`
PlanLivemode	`DT_BOOL`	`bit`		`False`
PlanNickname	`DT_WSTR`	`nvarchar(100)`	100	`False`
PlanProductId	`DT_WSTR`	`nvarchar(100)`	100	`False`
PlanTiersMode	`DT_WSTR`	`nvarchar(1020)`	1020	`False`
PlanTransformUsage	`DT_WSTR`	`nvarchar(1020)`	1020	`False`
PlanTrialPeriodDays	`DT_I8`	`bigint`		`False`
PlanUsageType	`DT_WSTR`	`nvarchar(100)`	100	`False`
PriceID	`DT_WSTR`	`nvarchar(255)`	255	`False`
PriceObject	`DT_WSTR`	`nvarchar(100)`	100	`False`
PriceActive	`DT_BOOL`	`bit`		`False`
PriceBillingScheme	`DT_WSTR`	`nvarchar(100)`	100	`False`
PriceCreated	`DT_DBTIMESTAMP`	`datetime`		`False`
PriceCurrency	`DT_WSTR`	`nvarchar(100)`	100	`False`
PriceLivemode	`DT_BOOL`	`bit`		`False`
PriceLookupKey	`DT_WSTR`	`nvarchar(1020)`	1020	`False`
PriceNickname	`DT_WSTR`	`nvarchar(100)`	100	`False`
PriceProductId	`DT_WSTR`	`nvarchar(100)`	100	`False`
PriceRecurringAggregateUsage	`DT_WSTR`	`nvarchar(100)`	100	`False`
PriceRecurringInterval	`DT_WSTR`	`nvarchar(100)`	100	`False`
PriceRecurringIntervalCount	`DT_I8`	`bigint`		`False`
PriceRecurringTrialPeriodDays	`DT_I8`	`bigint`		`False`
PriceRecurringUsageType	`DT_WSTR`	`nvarchar(100)`	100	`False`
PriceTiersMode	`DT_WSTR`	`nvarchar(1020)`	1020	`False`
PriceTransformQuantity	`DT_WSTR`	`nvarchar(1020)`	1020	`False`
PriceType	`DT_WSTR`	`nvarchar(100)`	100	`False`
PriceUnitAmount	`DT_I8`	`bigint`		`False`
PriceUnitAmountDecimal	`DT_WSTR`	`nvarchar(100)`	100	`False`
Proration	`DT_BOOL`	`bit`		`False`
Quantity	`DT_I8`	`bigint`		`False`
SubscriptionId	`DT_WSTR`	`nvarchar(100)`	100	`False`
SubscriptionItem	`DT_WSTR`	`nvarchar(1000)`	1000	`False`
TaxAmounts	`DT_WSTR`	`nvarchar(100)`	100	`False`
TaxRates	`DT_WSTR`	`nvarchar(100)`	100	`False`
Type	`DT_WSTR`	`nvarchar(100)`	100	`False`

Input Columns

Label	Data Type (SSIS)	Data Type (SQL)	Length	Raw	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 component to read data or in API Destination component to read/write data:

Retrieve an Upcoming Invoice Line Items using API Source

Stripe

Retrieve an Upcoming Invoice Line Items

SSIS API Source - Read from table or endpoint

Retrieve an Upcoming Invoice Line Items using API Destination

Stripe

Retrieve an Upcoming Invoice Line Items