Tableau Connector for Stripe

Build 21.0.7930

Invoices

Create, update, delete, and query the available Invoices in Stripe.

Table Specific Information

Select

Server-Side Query Support

The connector will use the Stripe API to filter the results by the following columns and operators while the rest of the filter is executed client side within the connector.

  • Id, CustomerId, Closed, Date, DueDate, Subscription support the following operators:<,>>=, <, <=, =.

The provider supports all columns to be used as criteria in the Where clause of Select statement, as long as SupportEnhancedSQL is set to True. If SupportEnhancedSQL property is set to False, you still can retreive:

-an All Invoices:

SELECT * FROM Invoices 

-an Invoices by specifying its Id:

SELECT * FROM Invoices WHERE Id='or_12345678'

-Invoices for a given Customer:

SELECT * FROM Invoices WHERE CustomerId='cus_12345678'

-Invoices by Closed :

SELECT * FROM Invoices WHERE Closed=True

-Invoices by Subscription :

SELECT * FROM Invoices WHERE Subscription='sub_12345678'

Columns

Name Type ReadOnly References Description
Id [KEY] String True

The Id of the invoice.

CustomerId String False

Customers.Id

The Id of the invoice holder.

AmountDue Int True

The amount, in cents, that was paid.

AmountPaid Int True

The amount remaining, in cents, that is due.

AmountRemaining Int True

The fee in cents that will be applied to the invoice and transferred to the application owner's Stripe account when the invoice is paid.

ApplicationFee Int False

Number of payment attempts made for this invoice, from the perspective of the payment retry schedule. Any payment attempt counts as the first attempt, and subsequently only automatic retries increment the attempt count. In other words, manual payment attempts after the first attempt do not affect the retry schedule.

AttemptCount Int True

The creation date.

Attempted Boolean True

End of the current period that the subscription has been invoiced for. At the end of this period, a new invoice will be created.

Billing String True

Start of the current period that the subscription has been invoiced for.

Charge String True

The id of the discount.

Closed Boolean False

If the subscription has ended (either because it was canceled or because the customer was switched to a subscription to a new plan), the date the subscription ended.

Currency String True

The quantity of the plan to which the customer should be subscribed. For example, if your plan is $10/user/month, and your customer has 5 users, you could pass 5 as the quantity to have the customer charged $50 (5 x $10) monthly.

Date Datetime True

Date the most recent update to this subscription started.

Description String False

The status of the subscription

The allowed values are trialing, active, past_due, canceled, unpaid.

DiscountName String True

Name of the coupon.

DiscountAmount String True

If provided, each invoice created by this subscription will apply the tax rate, increasing the amount billed to the customer.

CouponId String True

Id of the coupon.

DueDate Datetime False

If the subscription has a trial, the end of that trial.

EndingBalance Int True

If the subscription has a trial, the beginning of that trial.

Forgiven Boolean False

The set of key/value pairs that you can attach to a subscription object.

InvoicePdf String True

The link to download the PDF for the invoice. If the invoice has not been finalized yet, this will be null.

Livemode Boolean True

The status of the subscription

The allowed values are trialing, active, past_due, canceled, unpaid.

MetadataAggregate String False

The set of key/value pairs that you can attach to a subscription object.

NextPaymentAttempt Datetime True

If the subscription has a trial, the end of that trial.

Number String True

If the subscription has a trial, the beginning of that trial.

Paid String False

The status of the subscription

The allowed values are trialing, active, past_due, canceled, unpaid.

PeriodEnd Datetime True

If provided, each invoice created by this subscription will apply the tax rate, increasing the amount billed to the customer.

PeriodStart Datetime True

If the subscription has a trial, the end of that trial.

ReceiptNumber String True

If the subscription has a trial, the beginning of that trial.

StartingBalance Int True

The status of the subscription

The allowed values are trialing, active, past_due, canceled, unpaid.

StatementDescriptor String False

If provided, each invoice created by this subscription will apply the tax rate, increasing the amount billed to the customer.

Subscription String True

If the subscription has a trial, the end of that trial.

Subtotal Int True

If the subscription has a trial, the beginning of that trial.

Tax Int True

The status of the subscription

The allowed values are trialing, active, past_due, canceled, unpaid.

TaxPercent Decimal False

If provided, each invoice created by this subscription will apply the tax rate, increasing the amount billed to the customer.

Total Int True

If the subscription has a trial, the end of that trial.

WebhooksDeliveredAt Datetime True

If the subscription has a trial, the beginning of that trial.

CustomerAddress String True

The customers address.

CustomerEmail String True

The customers email.

CustomerName String True

The customers name.

CustomerPhone String True

The customers phone number.

CustomerShipping String True

The customers shipping information.

CustomerTaxExempt String True

The customers tax exempt status.

CustomerTaxIds String True

The customers tax IDs.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
Upcoming Boolean

Determines if the select is for upcoming invoices.

DaysUntilDue Int

The number of days from which the invoice is created until it is due. Only valid for invoices where billing=send_invoice.

Forgive Boolean

Determines if invoice should be forgiven if source has insufficient funds to fully pay the invoice.

Source String

A payment source to be charged. The source must be the ID of a source belonging to the customer associated with the invoice being paid.

AccountId String

The Id of the connected account to get invoices for

Copyright (c) 2021 CData Software, Inc. - All rights reserved.
Build 21.0.7930