Reference

Endpoint Retrieve an Upcoming Invoice

Name

get_upcoming_invoice

Description

At any time, you can preview the upcoming invoice for a customer. This will show you all the charges that are pending, including subscription renewal charges, invoice item charges, etc. It will also show you any discounts that are applicable to the invoice. [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
Id	`DT_WSTR`	`nvarchar(100)`	100
LinesObject	`DT_WSTR`	`nvarchar(100)`	100
LinesObject	`DT_BOOL`	`bit`
LinesTotalCount	`DT_I8`	`bigint`
LinesUrl	`DT_WSTR`	`nvarchar(1000)`	1000
AccountCountry	`DT_WSTR`	`nvarchar(100)`	100
AccountName	`DT_WSTR`	`nvarchar(1020)`	1020
AccountTaxIds	`DT_WSTR`	`nvarchar(1020)`	1020
AmountDue	`DT_I8`	`bigint`
AmountPaid	`DT_I8`	`bigint`
AmountRemaining	`DT_I8`	`bigint`
ApplicationFeeAmount	`DT_WSTR`	`nvarchar(1020)`	1020
AttemptCount	`DT_I8`	`bigint`
Attempted	`DT_BOOL`	`bit`
BillingReason	`DT_WSTR`	`nvarchar(100)`	100
Charge	`DT_WSTR`	`nvarchar(1020)`	1020
CollectionMethod	`DT_WSTR`	`nvarchar(100)`	100
CreatedAt	`DT_DBTIMESTAMP`	`datetime`
CustomFields	`DT_WSTR`	`nvarchar(1020)`	1020
Customer	`DT_WSTR`	`nvarchar(100)`	100
CustomerAddressCity	`DT_WSTR`	`nvarchar(1020)`	1020
CustomerAddressCountry	`DT_WSTR`	`nvarchar(1020)`	1020
CustomerAddressLine1	`DT_WSTR`	`nvarchar(1020)`	1020
CustomerAddressLine2	`DT_WSTR`	`nvarchar(100)`	100
CustomerAddressPostalCode	`DT_WSTR`	`nvarchar(1020)`	1020
CustomerAddressState	`DT_WSTR`	`nvarchar(1020)`	1020
CustomerEmail	`DT_WSTR`	`nvarchar(100)`	100
CustomerName	`DT_WSTR`	`nvarchar(100)`	100
CustomerAddressState	`DT_WSTR`	`nvarchar(100)`	100
CustomerShippingAddressCity	`DT_WSTR`	`nvarchar(100)`	100
CustomerShippingAddressCountry	`DT_WSTR`	`nvarchar(100)`	100
CustomerShippingAddressLine1	`DT_WSTR`	`nvarchar(100)`	100
CustomerShippingAddressLine2	`DT_WSTR`	`nvarchar(100)`	100
CustomerShippingAddressPostalCode	`DT_WSTR`	`nvarchar(100)`	100
CustomerShippingAddressState	`DT_WSTR`	`nvarchar(100)`	100
CustomerShippingName	`DT_WSTR`	`nvarchar(100)`	100
CustomerShippingPhone	`DT_WSTR`	`nvarchar(100)`	100
CustomerTaxExempt	`DT_WSTR`	`nvarchar(100)`	100
DefaultPaymentMethod	`DT_WSTR`	`nvarchar(1020)`	1020
DefaultSoure	`DT_WSTR`	`nvarchar(1020)`	1020
Description	`DT_WSTR`	`nvarchar(1020)`	1020
Discount	`DT_WSTR`	`nvarchar(1020)`	1020
DueDate	`DT_DBTIMESTAMP`	`datetime`
EndingBalance	`DT_I8`	`bigint`
Footer	`DT_WSTR`	`nvarchar(100)`	100
LastFinalizationError	`DT_WSTR`	`nvarchar(1020)`	1020
LiveMode	`DT_BOOL`	`bit`
NextPaymentAttempt	`DT_I8`	`bigint`
Number	`DT_WSTR`	`nvarchar(1020)`	1020
Paid	`DT_BOOL`	`bit`
PaymentIntent	`DT_WSTR`	`nvarchar(1020)`	1020
PeriodEnd	`DT_DBTIMESTAMP`	`datetime`
PeriodStart	`DT_DBTIMESTAMP`	`datetime`
PostPaymentCreditNotesAmount	`DT_I8`	`bigint`
PrePaymentCreditNotesAmount	`DT_I8`	`bigint`
ReceiptNumber	`DT_WSTR`	`nvarchar(1020)`	1020
StartingBalance	`DT_I8`	`bigint`
StatementDescriptor	`DT_WSTR`	`nvarchar(1020)`	1020
Status	`DT_WSTR`	`nvarchar(100)`	100
StatusTransitionsFinalizedAt	`DT_DBTIMESTAMP`	`datetime`
StatusTransitionsMarkedUncollectibleAt	`DT_DBTIMESTAMP`	`datetime`
StatusTransitionsPaidAt	`DT_DBTIMESTAMP`	`datetime`
StatusTransitionsVoidedAt	`DT_DBTIMESTAMP`	`datetime`
Subscription	`DT_WSTR`	`nvarchar(100)`	100
Subtotal	`DT_I8`	`bigint`
Tax	`DT_WSTR`	`nvarchar(1020)`	1020
Total	`DT_I8`	`bigint`
TransferData	`DT_WSTR`	`nvarchar(1020)`	1020
WebHooksDeliveredAt	`DT_DBTIMESTAMP`	`datetime`
Object	`DT_WSTR`	`nvarchar(100)`	100
Amount	`DT_I8`	`bigint`
AmountDecimal	`DT_WSTR`	`nvarchar(100)`	100
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`
Quantityp	`DT_I8`	`bigint`
SubscriptionId	`DT_WSTR`	`nvarchar(100)`	100
SubscriptionItem	`DT_WSTR`	`nvarchar(100)`	100
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

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

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

SELECT * FROM get_upcoming_invoice

SQL Server

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

Retrieve an upcoming invoice

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

EXEC (@MyQuery) AT [LS_TO_STRIPE_IN_GATEWAY];