Charges

Returns the charges in Stripe, including the amount, currency, customer, payment method, and status of each charge.

Table-Specific Information

In this table only select, insert, and update operations are allowed.

SELECT

The driver uses 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 driver.


Column	Supported Operators
Id	=
Amount	<, >, >=, <=, =, !=
Currency	=, !=
CustomerId	=, !=
BillingDetailsAddressPostalCode	=, !=
Created	<, >, >=, <=, =, !=
Disputed	=, !=
MetadataAggregate	=, !=
PaymentIntent	=
Refunded	=, !=
Status	=, !=
TransferGroup	=
AccountId	=

You can select:

A charge by specifying its Id:

SELECT * FROM Charges WHERE Id = 'ch_12345678'

Charges that belong to a customer:

SELECT * FROM Charges WHERE CustomerId = 'cus_12345678'

Charges created after a specific date:

SELECT * FROM Charges WHERE Created > '2018-01-01'

Created can also be used twice to specify a range:

SELECT * FROM Charges WHERE Created >= '2018-01-01 00:00:00.0' AND Created <= '2018-12-31 23:59:59.0'

INSERT

The Amount, Currency, and CustomerId or SourceId columns are required to charge a credit card:

INSERT INTO Charges (Amount, Currency, CustomerId) VALUES (2000, 'usd', 'cus_12345678')

UPDATE

To modify a charge, provide an Id:

UPDATE Charges SET Description = 'updated charge' WHERE Id = 'ch_17rPMOATXQzBWNrliIRnfI5B'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		The Id of the charge.
Amount	Integer	False		The amount of the charge.
Currency	String	False		The currency of the charge.
CustomerId	String	False	Customers.Id	The Id of the customer associated with the charge.
AmountRefunded	Integer	True		The amount, in cents, refunded.
ApplicationFee	String	True		The Id of the application fee for the charge, if any.
ApplicationFeeAmount	Integer	False		The amount of the application fee for the charge, if any.
BalanceTransaction	String	True		The Id of the balance transaction that describes the impact of this charge on your account balance.
BillingDetailsAddressCity	String	True		The city of the billing address associated with the payment method at the time of the transaction.
BillingDetailsAddressCountry	String	True		The country of the billing address associated with the payment method at the time of the transaction.
BillingDetailsAddressLine1	String	True		The first line of the billing address associated with the payment method at the time of the transaction.
BillingDetailsAddressLine2	String	True		The second line of the billing address associated with the payment method at the time of the transaction.
BillingDetailsAddressPostalCode	String	True		The ZIP or postal code of the billing address associated with the payment method at the time of the transaction.
BillingDetailsAddressState	String	True		The state of the billing address associated with the payment method at the time of the transaction.
BillingDetailsEmail	String	True		The email address associated with the payment method at the time of the transaction.
BillingDetailsName	String	True		The full name associated with the payment method at the time of the transaction.
BillingDetailsPhone	String	True		The phone number associated with the payment method at the time of the transaction.
Captured	Boolean	False		Indicates whether the charge was created without capturing.
CalculatedStatementDescriptor	String	True		The full statement descriptor that is passed to card networks, and that is displayed on your customers' credit card and bank statements. Allows you to see what the statement descriptor looks like after the static and dynamic portions are combined.
Created	Datetime	True		The date and time at which the charge was created.
Description	String	False		The description of the charge.
Disputed	Boolean	True		Indicates whether the charge has been disputed.
DisputeId	String	True	Disputes.Id	DEPRECATED. The Id of the associated dispute.
FailureCode	String	True		The error code explaining the reason for the charge failure if available.
FailureMessage	String	True		The message to the user further explaining the reason for the charge failure if available.
FraudDetailsStripeReport	String	True		The fraud assessment for the charge reported by Stripe.
FraudDetailsUserReport	String	False		The fraud assessment for the charge reported by the user.
Livemode	Boolean	True		Indicates whether the object exists in live mode. Returns false if the object exists in test mode.
MetadataAggregate	String	False		The charge metadata object.
Order	String	True		DEPRECATED. The Id of the order this charge is for if one exists.
OutcomeAggregate	String	True		Details about whether the payment was accepted, and why. See understanding declines for details.
Paid	Boolean	True		Indicates whether the charge succeeded or was successfully authorized for later capture.
PaymentIntent	String	True	PaymentIntent.Id	The Id of the payment intent associated with this charge, if one exists.
PaymentMethod	String	True		The Id of the payment method used in this charge.
PaymentMethodDetailsAggregate	String	True		Details about the payment method at the time of the transaction.
ReceiptEmail	String	False		The email address that the receipt for this charge was sent to.
ReceiptNumber	String	True		The transaction number that appears on email receipts sent for this charge.
ReceiptURL	String	True		The URL to view the receipt for this charge. The receipt is kept up to date with the latest state of the charge, including any refunds. If the charge is for an invoice, the receipt is stylized as an invoice receipt.
Refunded	Boolean	True		Indicates whether the charge has been fully refunded. Returns false if the charge is only partially refunded.
RefundsAggregate	String	True		The list of refunds that have been applied to the charge.
Review	String	True		The Id of the review associated with this charge, if one exists.
ShippingAddressCity	String	False		The city, district, suburb, town, or village of the shipping address for the charge.
ShippingAddressCountry	String	False		The two-letter country code (ISO 3166-1 alpha-2) of the shipping address for the charge.
ShippingAddressLine1	String	False		The first line of the shipping address for the charge, such as street, PO Box, or company name.
ShippingAddressLine2	String	False		The second line of the shipping address for the charge, such as apartment, suite, unit, or building.
ShippingAddressPostalCode	String	False		The ZIP or postal code of the shipping address for the charge.
ShippingAddressState	String	False		The state, county, province, or region of the shipping address for the charge.
ShippingCarrier	String	False		The delivery service that shipped a physical product, such as Fedex, UPS, or USPS.
ShippingName	String	False		The recipient name for the shipping information of the charge.
ShippingPhone	String	False		The recipient phone number, including extension, for the shipping information of the charge.
ShippingTrackingNumber	String	False		The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, separate them with commas.
SourceId	String	False		The Id of the source of the charge. The source of every charge is a credit or debit card.
SourceAddressCity	String	True		The city of the source address for the charge.
SourceAddressCountry	String	True		The country of the source address for the charge.
SourceAddressLine1	String	True		The first line of the source address for the charge.
SourceAddressLine2	String	True		The second line of the source address for the charge.
SourceAddressState	String	True		The state of the source address for the charge.
SourceAddressZip	String	True		The ZIP or postal code of the source address for the charge.
SourceAddressZipCheck	String	True		The result of checking the source address ZIP or postal code.
SourceBrand	String	True		The brand of the source card for the charge.
SourceCountry	String	True		The country of the source card for the charge.
SourceCustomer	String	True		The Id of the customer associated with the source for the charge.
SourceCvcCheck	String	True		The result of checking the source card CVC.
SourceDynamicLast4	String	True		The last four digits of the device account number for the source card.
SourceExpMonth	Integer	True		The expiration month of the source card for the charge.
SourceExpYear	Integer	True		The expiration year of the source card for the charge.
SourceFingerprint	String	True		A unique identifier for the source card, which you can use to check whether two cards are the same.
SourceFunding	String	True		The funding type of the source card for the charge.
SourceLast4	Integer	True		The last 4 digits of the source card number for the charge.
SourceMetadata	String	True		The set of key-value pairs attached to the source for the charge.
SourceName	String	True		The cardholder name on the source card for the charge.
SourceObject	String	True		The string representing the source object's type for the charge.
SourceTokenizationMethod	String	True		The tokenization method used for the source card, if the card number is tokenized.
SourceWallet	String	True		The wallet details for the source card, if the charge was made using a digital wallet.
SourceTransfer	String	True		The Id of the transfer that created this charge.
StatementDescriptor	String	False		The statement descriptor that appears on the customer's statement for this charge.
Status	String	True		The status of the payment. One of succeeded, pending, or failed.
Transfer	String	True	Transfers.Id	The Id of the transfer to the destination account.
TransferDataAmount	Integer	False		The amount transferred to the destination account as part of a destination charge.
TransferDataDestination	String	False		The Id of the account to automatically transfer funds to as part of a destination charge.
TransferGroup	String	False		A string that identifies this transaction as part of a group.
StatementDescriptorSuffix	String	False		Provides information about the charge that customers see on their statements.
Object	String	True		The string representing the object's type. Objects of the same type share the same value.
CustomerAccount	String	True		DEPRECATED. The Id of the account representing the customer for this charge.
ExpectedDebitDate	Date	True		DEPRECATED. Expected debit date for ACH/SEPA payments.
NetworkTransactionId	String	True		The network-level transaction Id from the card network.
PresentmentDetailsCurrency	String	True		The currency the customer was charged in.
PresentmentDetailsAmount	Integer	True		The amount the customer was charged in the presentment currency.
AmountCaptured	Integer	True		The amount, in cents, captured.
Application	String	True		The Id of the Connect application that created the charge.
FailureBalanceTransaction	String	True		The Id of the balance transaction that describes the reversal of the balance on your account due to payment failure.
OnBehalfOf	String	False		The account (if any) the charge was made on behalf of without triggering an automatic transfer.
RadarOptionsSession	String	False		Options to configure Radar. A Radar Session is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.

Pseudocolumns

Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.


Name	Type	Description
AccountId	String	The Id of the connected account for which to retrieve charges.