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
Output Columns
Label | Data Type (SSIS) | Data Type (SQL) | Length | Raw | Description |
---|---|---|---|---|---|
Id |
DT_WSTR
|
nvarchar(100)
|
100 | False |
|
LinesObject |
DT_WSTR
|
nvarchar(100)
|
100 | False |
|
LinesObject |
DT_BOOL
|
bit
|
False |
||
LinesTotalCount |
DT_I8
|
bigint
|
False |
||
LinesUrl |
DT_WSTR
|
nvarchar(1000)
|
1000 | False |
|
AccountCountry |
DT_WSTR
|
nvarchar(100)
|
100 | False |
|
AccountName |
DT_WSTR
|
nvarchar(1020)
|
1020 | False |
|
AccountTaxIds |
DT_WSTR
|
nvarchar(1020)
|
1020 | False |
|
AmountDue |
DT_I8
|
bigint
|
False |
||
AmountPaid |
DT_I8
|
bigint
|
False |
||
AmountRemaining |
DT_I8
|
bigint
|
False |
||
ApplicationFeeAmount |
DT_WSTR
|
nvarchar(1020)
|
1020 | False |
|
AttemptCount |
DT_I8
|
bigint
|
False |
||
Attempted |
DT_BOOL
|
bit
|
False |
||
BillingReason |
DT_WSTR
|
nvarchar(100)
|
100 | False |
|
Charge |
DT_WSTR
|
nvarchar(1020)
|
1020 | False |
|
CollectionMethod |
DT_WSTR
|
nvarchar(100)
|
100 | False |
|
CreatedAt |
DT_DBTIMESTAMP
|
datetime
|
False |
||
CustomFields |
DT_WSTR
|
nvarchar(1020)
|
1020 | False |
|
Customer |
DT_WSTR
|
nvarchar(100)
|
100 | False |
|
CustomerAddressCity |
DT_WSTR
|
nvarchar(1020)
|
1020 | False |
|
CustomerAddressCountry |
DT_WSTR
|
nvarchar(1020)
|
1020 | False |
|
CustomerAddressLine1 |
DT_WSTR
|
nvarchar(1020)
|
1020 | False |
|
CustomerAddressLine2 |
DT_WSTR
|
nvarchar(100)
|
100 | False |
|
CustomerAddressPostalCode |
DT_WSTR
|
nvarchar(1020)
|
1020 | False |
|
CustomerAddressState |
DT_WSTR
|
nvarchar(1020)
|
1020 | False |
|
CustomerEmail |
DT_WSTR
|
nvarchar(100)
|
100 | False |
|
CustomerName |
DT_WSTR
|
nvarchar(100)
|
100 | False |
|
CustomerAddressState |
DT_WSTR
|
nvarchar(100)
|
100 | False |
|
CustomerShippingAddressCity |
DT_WSTR
|
nvarchar(100)
|
100 | False |
|
CustomerShippingAddressCountry |
DT_WSTR
|
nvarchar(100)
|
100 | False |
|
CustomerShippingAddressLine1 |
DT_WSTR
|
nvarchar(100)
|
100 | False |
|
CustomerShippingAddressLine2 |
DT_WSTR
|
nvarchar(100)
|
100 | False |
|
CustomerShippingAddressPostalCode |
DT_WSTR
|
nvarchar(100)
|
100 | False |
|
CustomerShippingAddressState |
DT_WSTR
|
nvarchar(100)
|
100 | False |
|
CustomerShippingName |
DT_WSTR
|
nvarchar(100)
|
100 | False |
|
CustomerShippingPhone |
DT_WSTR
|
nvarchar(100)
|
100 | False |
|
CustomerTaxExempt |
DT_WSTR
|
nvarchar(100)
|
100 | False |
|
DefaultPaymentMethod |
DT_WSTR
|
nvarchar(1020)
|
1020 | False |
|
DefaultSoure |
DT_WSTR
|
nvarchar(1020)
|
1020 | False |
|
Description |
DT_WSTR
|
nvarchar(1020)
|
1020 | False |
|
Discount |
DT_WSTR
|
nvarchar(1020)
|
1020 | False |
|
DueDate |
DT_DBTIMESTAMP
|
datetime
|
False |
||
EndingBalance |
DT_I8
|
bigint
|
False |
||
Footer |
DT_WSTR
|
nvarchar(100)
|
100 | False |
|
LastFinalizationError |
DT_WSTR
|
nvarchar(1020)
|
1020 | False |
|
LiveMode |
DT_BOOL
|
bit
|
False |
||
NextPaymentAttempt |
DT_I8
|
bigint
|
False |
||
Number |
DT_WSTR
|
nvarchar(1020)
|
1020 | False |
|
Paid |
DT_BOOL
|
bit
|
False |
||
PaymentIntent |
DT_WSTR
|
nvarchar(1020)
|
1020 | False |
|
PeriodEnd |
DT_DBTIMESTAMP
|
datetime
|
False |
||
PeriodStart |
DT_DBTIMESTAMP
|
datetime
|
False |
||
PostPaymentCreditNotesAmount |
DT_I8
|
bigint
|
False |
||
PrePaymentCreditNotesAmount |
DT_I8
|
bigint
|
False |
||
ReceiptNumber |
DT_WSTR
|
nvarchar(1020)
|
1020 | False |
|
StartingBalance |
DT_I8
|
bigint
|
False |
||
StatementDescriptor |
DT_WSTR
|
nvarchar(1020)
|
1020 | False |
|
Status |
DT_WSTR
|
nvarchar(100)
|
100 | False |
|
StatusTransitionsFinalizedAt |
DT_DBTIMESTAMP
|
datetime
|
False |
||
StatusTransitionsMarkedUncollectibleAt |
DT_DBTIMESTAMP
|
datetime
|
False |
||
StatusTransitionsPaidAt |
DT_DBTIMESTAMP
|
datetime
|
False |
||
StatusTransitionsVoidedAt |
DT_DBTIMESTAMP
|
datetime
|
False |
||
Subscription |
DT_WSTR
|
nvarchar(100)
|
100 | False |
|
Subtotal |
DT_I8
|
bigint
|
False |
||
Tax |
DT_WSTR
|
nvarchar(1020)
|
1020 | False |
|
Total |
DT_I8
|
bigint
|
False |
||
TransferData |
DT_WSTR
|
nvarchar(1020)
|
1020 | False |
|
WebHooksDeliveredAt |
DT_DBTIMESTAMP
|
datetime
|
False |
||
Object |
DT_WSTR
|
nvarchar(100)
|
100 | False |
|
Amount |
DT_I8
|
bigint
|
False |
||
AmountDecimal |
DT_WSTR
|
nvarchar(100)
|
100 | 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 |
||
Quantityp |
DT_I8
|
bigint
|
False |
||
SubscriptionId |
DT_WSTR
|
nvarchar(100)
|
100 | False |
|
SubscriptionItem |
DT_WSTR
|
nvarchar(100)
|
100 | False |
|
TaxAmounts |
DT_WSTR
|
nvarchar(100)
|
100 | False |
|
TaxRates |
DT_WSTR
|
nvarchar(100)
|
100 | False |
|
Type |
DT_WSTR
|
nvarchar(100)
|
100 | False |
If the column you are looking for is missing, consider customizing Stripe Connector.
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 using API Source
Stripe
Retrieve an Upcoming Invoice

Retrieve an Upcoming Invoice using API Destination
Stripe
Retrieve an Upcoming Invoice
