Stripe Connector
Documentation
Version: 2
Documentation

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 Help]

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 DataType Length Raw Description
Id DT_WSTR 100 False
LinesObject DT_WSTR 100 False
LinesObject DT_BOOL 0 False
LinesTotalCount DT_I8 0 False
LinesUrl DT_WSTR 1000 False
AccountCountry DT_WSTR 100 False
AccountName DT_WSTR 1020 False
AccountTaxIds DT_WSTR 1020 False
AmountDue DT_I8 0 False
AmountPaid DT_I8 0 False
AmountRemaining DT_I8 0 False
ApplicationFeeAmount DT_WSTR 1020 False
AttemptCount DT_I8 0 False
Attempted DT_BOOL 0 False
BillingReason DT_WSTR 100 False
Charge DT_WSTR 1020 False
CollectionMethod DT_WSTR 100 False
CreatedAt DT_DBTIMESTAMP 0 False
CustomFields DT_WSTR 1020 False
Customer DT_WSTR 100 False
CustomerAddressCity DT_WSTR 1020 False
CustomerAddressCountry DT_WSTR 1020 False
CustomerAddressLine1 DT_WSTR 1020 False
CustomerAddressLine2 DT_WSTR 100 False
CustomerAddressPostalCode DT_WSTR 1020 False
CustomerAddressState DT_WSTR 1020 False
CustomerEmail DT_WSTR 100 False
CustomerName DT_WSTR 100 False
CustomerAddressState DT_WSTR 100 False
CustomerShippingAddressCity DT_WSTR 100 False
CustomerShippingAddressCountry DT_WSTR 100 False
CustomerShippingAddressLine1 DT_WSTR 100 False
CustomerShippingAddressLine2 DT_WSTR 100 False
CustomerShippingAddressPostalCode DT_WSTR 100 False
CustomerShippingAddressState DT_WSTR 100 False
CustomerShippingName DT_WSTR 100 False
CustomerShippingPhone DT_WSTR 100 False
CustomerTaxExempt DT_WSTR 100 False
DefaultPaymentMethod DT_WSTR 1020 False
DefaultSoure DT_WSTR 1020 False
Description DT_WSTR 1020 False
Discount DT_WSTR 1020 False
DueDate DT_DBTIMESTAMP 0 False
EndingBalance DT_I8 0 False
Footer DT_WSTR 100 False
LastFinalizationError DT_WSTR 1020 False
LiveMode DT_BOOL 0 False
NextPaymentAttempt DT_I8 0 False
Number DT_WSTR 1020 False
Paid DT_BOOL 0 False
PaymentIntent DT_WSTR 1020 False
PeriodEnd DT_DBTIMESTAMP 0 False
PeriodStart DT_DBTIMESTAMP 0 False
PostPaymentCreditNotesAmount DT_I8 0 False
PrePaymentCreditNotesAmount DT_I8 0 False
ReceiptNumber DT_WSTR 1020 False
StartingBalance DT_I8 0 False
StatementDescriptor DT_WSTR 1020 False
Status DT_WSTR 100 False
StatusTransitionsFinalizedAt DT_DBTIMESTAMP 0 False
StatusTransitionsMarkedUncollectibleAt DT_DBTIMESTAMP 0 False
StatusTransitionsPaidAt DT_DBTIMESTAMP 0 False
StatusTransitionsVoidedAt DT_DBTIMESTAMP 0 False
Subscription DT_WSTR 100 False
Subtotal DT_I8 0 False
Tax DT_WSTR 1020 False
Total DT_I8 0 False
TransferData DT_WSTR 1020 False
WebHooksDeliveredAt DT_DBTIMESTAMP 0 False
Object DT_WSTR 100 False
Amount DT_I8 0 False
AmountDecimal DT_WSTR 100 False
Currency DT_WSTR 100 False
Description DT_WSTR 255 False
DiscountAmounts DT_WSTR 100 False
Discountable DT_BOOL 0 False
Discounts DT_WSTR 100 False
LiveMode DT_BOOL 0 False
PeriodEnd DT_DBTIMESTAMP 0 False
PeriodStart DT_DBTIMESTAMP 0 False
PlanId DT_WSTR 255 False
PlanObject DT_WSTR 100 False
PlanActive DT_BOOL 0 False
PlanAggregateUsage DT_WSTR 100 False
PlanAmount DT_I8 0 False
PlanAmountDecimal DT_WSTR 100 False
PlanBillingScheme DT_WSTR 100 False
PlanCreated DT_DBTIMESTAMP 0 False
PlanCurrency DT_WSTR 100 False
PlanInterval DT_WSTR 100 False
PlanIntervalCount DT_I8 0 False
PlanLiveMode DT_BOOL 0 False
PlanNickname DT_WSTR 100 False
PlanProductId DT_WSTR 100 False
PlanTiersMode DT_WSTR 1020 False
PlanTransformUsage DT_WSTR 1020 False
PlanTrialPeriodDays DT_I8 0 False
PlanUsageType DT_WSTR 100 False
PriceId DT_WSTR 255 False
PriceObject DT_WSTR 100 False
PriceActive DT_BOOL 0 False
PriceBillingScheme DT_WSTR 100 False
PriceCreated DT_DBTIMESTAMP 0 False
PriceCurrency DT_WSTR 100 False
PriceLiveMode DT_BOOL 0 False
PriceLookupKey DT_WSTR 1020 False
PriceNickname DT_WSTR 100 False
PriceProductId DT_WSTR 100 False
PriceRecurringAggregateUsage DT_WSTR 100 False
PriceRecurringInterval DT_WSTR 100 False
PriceRecurringIntervalCount DT_I8 0 False
PriceRecurringTrialPeriodDays DT_I8 0 False
PriceRecurringUsageType DT_WSTR 100 False
PriceTiersMode DT_WSTR 1020 False
PriceTransformQuantity DT_WSTR 1020 False
PriceType DT_WSTR 100 False
PriceUnitAmount DT_I8 0 False
PriceUnitAmountDecimal DT_WSTR 100 False
Proration DT_BOOL 0 False
Quantityp DT_I8 0 False
SubscriptionId DT_WSTR 100 False
SubscriptionItem DT_WSTR 100 False
TaxAmounts DT_WSTR 100 False
TaxRates DT_WSTR 100 False
Type DT_WSTR 100 False

Input Columns

Label DataType Length Raw Description
There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime.