Public Stripe Connector API Reference
The public API procedures may call the internal procedures which should not be used directly as they can be changed without any explicit notification in the newer versions of the connector. Internal procedures can be recognized by the prefix internal_
in their names. Public API procedures do not have such prefix in their names.
DownloadBalanceTransactionsPerPayout
Balance transactions per payout
Parameter
<payouts_table> (required): Table containing the payouts list
<target_table> (optional):
<preview> (optional):
<label> (optional):
Attribute | Type | Description |
---|---|---|
payout_id | string | For automatic Stripe payouts only, transactions were payed out on this payout ID |
id | string | Unique identifier for the object |
object | string | String representing the object's type |
amount | integer | Gross amount of the transaction, in cents |
available_on | timestamp | The date the transaction's net funds will become available in the Stripe balance |
created | timestamp | Time at which the object was created |
currency | string | Three-letter ISO currency code, in lowercase |
description | string | An arbitrary string attached to the object. Often useful for displaying to users |
exchange_rate | bigdecimal | Exchange rate |
fee | integer | Fees (in cents) paid for this transaction |
net | integer | Net amount of the transaction, in cents |
source | string | The Stripe object to which this transaction is related |
status | string | If the transaction's net funds are available in the Stripe balance yet. Either available or pending |
type | string | Transaction type |
DownloadBankAccounts
All customers bank accounts
Parameter
<customers_table> (required): Table containing the customers list
<target_table> (optional):
<preview> (optional):
<label> (optional):
Attribute | Type | Description |
---|---|---|
id | string | Unique identifier for the object |
object | string | String representing the object's type. Objects of the same type share the same value |
account | string | The account |
account_holder_name | string | The name of the person or business that owns the bank account |
account_holder_type | string | The type of entity that holds the account. This can be either individual or company |
bank_name | string | Name of the bank associated with the routing number, e.g. WELLS FARGO |
country | string | Two-letter ISO code representing the country the bank account is located in |
currency | string | Three-letter ISO code for the currency paid out to the bank account |
customer | string | The customer |
default_for_currency | boolean | Whether this external account is the default account for its currency |
fingerprint | string | Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same |
last4 | string | Last 4 digits |
metadata | clob | Set of key/value pairs that you can attach to an object. It can be useful for storing additional information about the object in a structured format |
routing_number | string | The routing transit number for the bank account |
status | string | Possible values are new, validated, verified, verification_failed, or errored. A bank account that hasn't had any activity or validation performed is new. If Stripe can determine that the bank account exists, its status will be validated. Note that there often isn't enough information to know (e.g. for smaller credit unions), and the validation is not always run. If customer bank account verification has succeeded, the bank account status will be verified. If the verification failed for any reason, such as microdeposit failure, the status will be verification_failed. If a transfer sent to this bank account fails, we'll set the status to errored and will not continue to send transfers until the bank details are updated |
DownloadCards
All customers cards
Parameter
<customers_table> (required): Table containing the customers list
<target_table> (optional):
<preview> (optional):
<label> (optional):
Attribute | Type | Description |
---|---|---|
id | string | Unique identifier for the object |
object | string | String representing the object's type. Objects of the same type share the same value |
account | string | The account this card belongs to. This attribute will not be in the card object if the card belongs to a customer or recipient instead |
address_city | string | City/District/Suburb/Town/Village |
address_country | string | Billing address country, if provided when creating card |
address_line1 | string | Address line 1 (Street address/PO Box/Company name) |
address_line1_check | string | If address_line1 was provided, results of the check: pass, fail, unavailable, or unchecked |
address_line2 | string | Address line 2 (Apartment/Suite/Unit/Building) |
address_state | string | State/County/Province/Region |
address_zip | string | Zip/Postal Code |
address_zip_check | string | If address_zip was provided, results of the check: pass, fail, unavailable, or unchecked |
available_payout_methods | string | A set of available payout methods for this card. Will be either "standard" or "standard", "instant". Only values from this set should be passed as the method when creating a transfer |
brand | string | Card brand. Can be Visa, American Express, MasterCard, Discover, JCB, Diners Club, or Unknown |
country | string | Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected |
currency | string | Three-letter ISO code for currency. Only applicable on accounts (not customers or recipients). The card can be used as a transfer destination for funds in this currency |
customer | string | The customer that this card belongs to. This attribute will not be in the card object if the card belongs to an account or recipient instead |
cvc_check | string | If a CVC was provided, results of the check: pass, fail, unavailable, or unchecked |
default_for_currency | boolean | Only applicable on accounts (not customers or recipients). This indicates whether or not this card is the default external account for its currency |
dynamic_last4 | string | (For tokenized numbers only.) The last four digits of the device account number |
exp_month | integer | Two digit number representing the card's expiration month |
exp_year | integer | Four digit number representing the card's expiration year |
fingerprint | string | Uniquely identifies this particular card number. You can use this attribute to check whether two customers who've signed up with you are using the same card number, for example |
funding | string | Card funding type. Can be credit, debit, prepaid, or unknown |
last4 | string | The last 4 digits of the card |
metadata | clob | Set of key/value pairs that you can attach to an object. It can be useful for storing additional information about the object in a structured format |
name | string | Cardholder name |
recipient | string | The recipient that this card belongs to. This attribute will not be in the card object if the card belongs to a customer or account instead |
tokenization_method | string | If the card number is tokenized, this is the method that was used. Can be apple_pay or android_pay |
ListAccounts
Accounts connected to your platform via Connect. If you're not a platform, the list will be empty
Parameter
<target_table> (optional):
<limitCalls> (optional):
<label> (optional):
Attribute | Type | Description |
---|---|---|
id | string | Unique identifier for the object |
object | string | String representing the object's type. Objects of the same type share the same value |
business_name | string | The publicly visible name of the business |
business_url | string | The publicly visible website of the business |
charges_enabled | boolean | Whether or not the account can create live charges |
country | string | The country of the account |
debit_negative_balances | boolean | Whether or not Stripe will attempt to reclaim negative account balances from this account's bank account |
decline_charge_on_avs_failure | boolean | Whether or not Stripe should automatically decline charges with an incorrect zip/postal code. This setting only applies if a card includes a zip code and the bank specifically marks it as failed |
decline_charge_on_cvc_failure | boolean | Whether or not Stripe should automatically decline charges with an incorrect CVC. This setting only applies if a card includes a CVC and the bank specifically marks it as failed |
default_currency | string | The currency this account has chosen to use as the default |
details_submitted | boolean | Whether or not account details have been submitted yet. Standard accounts cannot receive transfers before this is true |
display_name | string | The display name for this account. This is used on the Stripe dashboard to help you differentiate between accounts |
string | The primary user's email address | |
legal_entity_additional_owners | clob | An array of any owners with at least 25% ownership of the company, excluding the individual responsible for the account |
legal_entity_address_city | string | The primary address of the legal entity: City/District/Suburb/Town/Village |
legal_entity_address_country | string | 2-letter country code |
legal_entity_address_line1 | string | Address line 1 (Street address/PO Box/Company name) |
legal_entity_address_line2 | string | Address line 2 (Apartment/Suite/Unit/Building) |
legal_entity_address_postal_code | string | Zip/Postal Code |
legal_entity_address_state | string | State/County/Province/Region |
legal_entity_business_name | string | The legal name of the company |
legal_entity_business_tax_id_provided | boolean | Whether the business ID number of the legal entity has been provided |
legal_entity_business_vat_id_provided | boolean | Whether the business VAT number of the legal entity has been provided |
legal_entity_dob_day | integer | The day of birth of the individual responsible for the account |
legal_entity_dob_month | integer | The month of birth, between 1 and 12 |
legal_entity_dob_year | integer | The 4-digit year of birth |
legal_entity_first_name | string | The first name of the individual responsible for the account |
legal_entity_gender | string | The gender of the individual responsible for the account (International regulations require either "male" or "female") |
legal_entity_last_name | string | The last name of the individual responsible for the account |
legal_entity_maiden_name | string | The maiden name of the individual responsible for the account |
legal_entity_personal_address_city | string | The primary address of the individual responsible for the account: City/District/Suburb/Town/Village |
legal_entity_personal_address_country | string | 2-letter country code |
legal_entity_personal_address_line1 | string | Address line 1 (Street address/PO Box/Company name) |
legal_entity_personal_address_line2 | string | Address line 2 (Apartment/Suite/Unit/Building) |
legal_entity_personal_address_postal_code | string | Zip/Postal Code |
legal_entity_personal_address_state | string | State/County/Province/Region |
legal_entity_personal_id_number_provided | boolean | Whether the personal id number of the individual responsible for the account has been provided |
legal_entity_phone_number | string | The phone number of the company, used for verification |
legal_entity_ssn_last_4_provided | boolean | Whether the last 4 ssn digits of the individual responsible for the account have been provided |
legal_entity_tax_id_registrar | string | The tax ID registrar |
legal_entity_type | string | Either "individual" or "company", for what kind of legal entity the account owner is for |
legal_entity_verification_details | string | The verification status of this business and responsible individual: A user-displayable string describing the verification state for this legal entity. For example, if a document is uploaded and the picture is too fuzzy, this may say "Identity document is too unclear to read" |
legal_entity_verification_details_code | string | One of scan_corrupt, scan_not_readable, scan_failed_greyscale, scan_not_uploaded, scan_id_type_not_supported, scan_id_country_not_supported, scan_name_mismatch, scan_failed_other, failed_keyed_identity, or failed_other. A machine-readable code specifying the verification state for this legal entity |
legal_entity_verification_document | string | (ID of a file upload) A photo (jpg or png) of an identifying document, either a passport or local ID card |
legal_entity_verification_status | string | The state of verification for this legal entity. Possible values are unverified, pending, or verified |
metadata | clob | Set of key/value pairs that you can attach to an object. It can be useful for storing additional information about the object in a structured format |
payout_schedule_delay_days | integer | When payments collected will be automatically paid out to the account holder's bank account: The number of days charges for the account will be held before being paid out |
payout_schedule_interval | string | How frequently funds will be paid out. One of manual (transfers only created via API call), daily, weekly, or monthly |
payout_schedule_monthly_anchor | integer | The day of the month funds will be paid out. Only shown if interval is monthly |
payout_schedule_weekly_anchor | string | The day of the week funds will be paid out, of the style 'monday', 'tuesday', etc. Only shown if interval is weekly |
payout_statement_descriptor | string | The text that will appear on the account's bank account statement for payouts. If not set, this will default to your platform's bank descriptor set on the Dashboard |
payouts_enabled | boolean | Whether or not Stripe will send automatic transfers for this account. This is only false when Stripe is waiting for additional information from the account holder |
product_description | string | An internal-only description of the product or service provided. This is used by Stripe in the event the account gets flagged for potential fraud |
statement_descriptor | string | The text that will appear on credit card statements |
support_email | string | A publicly shareable email address that can be reached for support for this account |
support_phone | string | The publicly visible support phone number for the business |
timezone | string | The time zone used in the Stripe dashboard for this account. A list of possible time zone values is maintained at the IANA Time Zone Database |
tos_acceptance_date | timestamp | Who accepted the Stripe terms of service, and when they accepted it: The timestamp when the account owner accepted Stripe's terms |
tos_acceptance_ip | string | The IP address from which the account owner accepted Stripe's terms |
tos_acceptance_user_agent | string | The user agent of the browser from which the user accepted Stripe's terms |
type | string | The type of the Stripe account. Can be 'standard', 'express', or 'custom' |
verification_disabled_reason | string | The state of the account's information requests, including what information is needed and by when it must be provided: A string describing the reason for this account being unable to charge and/or transfer, if that is the case. Possible values are rejected.fraud, rejected.terms_of_service, rejected.listed, rejected.other, fields_needed, listed, under_review, or other |
verification_due_by | timestamp | At what time the fields_needed must be provided. If this date is in the past, the account is already in bad standing, and providing fields_needed is necessary to re-enable transfers and prevent other consequences. If this date is in the future, fields_needed must be provided to ensure the account remains in good standing |
verification_fields_needed | string | Field names that need to be provided for the account to remain in good standing. Nested fields are separated by "." (for example, "legal_entity.first_name") |
Example
CREATE VIEW stripe_examples.example_ListAccounts AS SELECT * FROM (CALL stripe.ListAccounts(limitCalls => 1))x
ListApplicationFeeRefunds
Refunds belonging to a specific application fee
Parameter
<fee> (required): The ID of the application fee whose refunds will be retrieved
<target_table> (optional):
<limitCalls> (optional):
<sourceColumns> (optional):
<targetColumns> (optional):
<label> (optional):
Attribute | Type | Description |
---|---|---|
id | string | Unique identifier for the object |
object | string | String representing the object's type. Objects of the same type share the same value |
amount | long | Amount, in cents |
balance_transaction | string | Balance transaction that describes the impact on your account balance |
created | timestamp | Time at which the object was created |
currency | string | Three-letter ISO currency code, in lowercase |
fee | string | ID of the application fee that was refunded |
metadata | clob | Set of key/value pairs that you can attach to an object. It can be useful for storing additional information about the object in a structured format |
ListApplicationFees
Your Application Fees
Parameter
<target_table> (optional):
<requestInitialLoad> (optional):
<limitCalls> (optional):
<label> (optional):
Attribute | Type | Description |
---|---|---|
id | string | Unique identifier for the object |
object | string | String representing the object's type. Objects of the same type share the same value |
account | string | ID of the Stripe account this fee was taken from |
amount | long | Amount earned, in cents |
amount_refunded | integer | The amount refunded |
application | string | ID of the Connect Application that earned the fee |
balance_transaction | string | Balance transaction that describes the impact of this collected application fee on your account balance (not including refunds) |
charge | string | ID of the charge that the application fee was taken from |
created | timestamp | Time at which the object was created |
currency | string | Three-letter ISO currency code, in lowercase |
livemode | boolean | Flag indicating whether the object exists in live mode or test mode |
originating_transaction | string | ID of the corresponding charge on the platform account, if this fee was the result of a charge using the destination parameter |
refunded | boolean | Whether or not the fee has been fully refunded. If the fee is only partially refunded, this attribute will still be false |
refunds_total_count | integer | The total number |
Example
CREATE VIEW stripe_examples.example_ListApplicationFees AS SELECT * FROM (CALL stripe.ListApplicationFees(limitCalls => 1))x
ListBalanceTransactions
All balance transactions
Parameter
<payout_id> (optional):
<target_table> (optional):
<requestInitialLoad> (optional):
<limitCalls> (optional):
<sourceColumns> (optional):
<targetColumns> (optional):
<target_table_fees> (optional):
<label> (optional):
Attribute | Type | Description |
---|---|---|
payout_id | string | For automatic Stripe payouts only, transactions were payed out on this payout ID |
id | string | Unique identifier for the object |
object | string | String representing the object's type |
amount | integer | Gross amount of the transaction, in cents |
available_on | timestamp | The date the transaction's net funds will become available in the Stripe balance |
created | timestamp | Time at which the object was created |
currency | string | Three-letter ISO currency code, in lowercase |
description | string | An arbitrary string attached to the object. Often useful for displaying to users |
exchange_rate | bigdecimal | Exchange rate |
fee | integer | Fees (in cents) paid for this transaction |
net | integer | Net amount of the transaction, in cents |
source | string | The Stripe object to which this transaction is related |
status | string | If the transaction's net funds are available in the Stripe balance yet. Either available or pending |
type | string | Transaction type |
Example
CREATE VIEW stripe_examples.example_ListBalanceTransactions AS SELECT * FROM (CALL stripe.ListBalanceTransactions(limitCalls => 1))x
ListBankAccounts
Bank accounts belonging to a Customer
Parameter
<customer> (required): The ID of the customer whose bank accounts will be retrieved
<target_table> (optional):
<limitCalls> (optional):
<sourceColumns> (optional):
<targetColumns> (optional):
<label> (optional):
Attribute | Type | Description |
---|---|---|
id | string | Unique identifier for the object |
object | string | String representing the object's type. Objects of the same type share the same value |
account | string | The account |
account_holder_name | string | The name of the person or business that owns the bank account |
account_holder_type | string | The type of entity that holds the account. This can be either individual or company |
bank_name | string | Name of the bank associated with the routing number, e.g. WELLS FARGO |
country | string | Two-letter ISO code representing the country the bank account is located in |
currency | string | Three-letter ISO code for the currency paid out to the bank account |
customer | string | The customer |
default_for_currency | boolean | Whether this external account is the default account for its currency |
fingerprint | string | Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same |
last4 | string | Last 4 digits |
metadata | clob | Set of key/value pairs that you can attach to an object. It can be useful for storing additional information about the object in a structured format |
routing_number | string | The routing transit number for the bank account |
status | string | Possible values are new, validated, verified, verification_failed, or errored. A bank account that hasn't had any activity or validation performed is new. If Stripe can determine that the bank account exists, its status will be validated. Note that there often isn't enough information to know (e.g. for smaller credit unions), and the validation is not always run. If customer bank account verification has succeeded, the bank account status will be verified. If the verification failed for any reason, such as microdeposit failure, the status will be verification_failed. If a transfer sent to this bank account fails, we'll set the status to errored and will not continue to send transfers until the bank details are updated |
ListCards
Cards belonging to a customer or recipient
Parameter
<customer> (required): The ID of the customer whose cards will be retrieved
<target_table> (optional):
<limitCalls> (optional):
<sourceColumns> (optional):
<targetColumns> (optional):
<label> (optional):
Attribute | Type | Description |
---|---|---|
id | string | Unique identifier for the object |
object | string | String representing the object's type. Objects of the same type share the same value |
account | string | The account this card belongs to. This attribute will not be in the card object if the card belongs to a customer or recipient instead |
address_city | string | City/District/Suburb/Town/Village |
address_country | string | Billing address country, if provided when creating card |
address_line1 | string | Address line 1 (Street address/PO Box/Company name) |
address_line1_check | string | If address_line1 was provided, results of the check: pass, fail, unavailable, or unchecked |
address_line2 | string | Address line 2 (Apartment/Suite/Unit/Building) |
address_state | string | State/County/Province/Region |
address_zip | string | Zip/Postal Code |
address_zip_check | string | If address_zip was provided, results of the check: pass, fail, unavailable, or unchecked |
available_payout_methods | string | A set of available payout methods for this card. Will be either "standard" or "standard", "instant". Only values from this set should be passed as the method when creating a transfer |
brand | string | Card brand. Can be Visa, American Express, MasterCard, Discover, JCB, Diners Club, or Unknown |
country | string | Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected |
currency | string | Three-letter ISO code for currency. Only applicable on accounts (not customers or recipients). The card can be used as a transfer destination for funds in this currency |
customer | string | The customer that this card belongs to. This attribute will not be in the card object if the card belongs to an account or recipient instead |
cvc_check | string | If a CVC was provided, results of the check: pass, fail, unavailable, or unchecked |
default_for_currency | boolean | Only applicable on accounts (not customers or recipients). This indicates whether or not this card is the default external account for its currency |
dynamic_last4 | string | (For tokenized numbers only.) The last four digits of the device account number |
exp_month | integer | Two digit number representing the card's expiration month |
exp_year | integer | Four digit number representing the card's expiration year |
fingerprint | string | Uniquely identifies this particular card number. You can use this attribute to check whether two customers who've signed up with you are using the same card number, for example |
funding | string | Card funding type. Can be credit, debit, prepaid, or unknown |
last4 | string | The last 4 digits of the card |
metadata | clob | Set of key/value pairs that you can attach to an object. It can be useful for storing additional information about the object in a structured format |
name | string | Cardholder name |
recipient | string | The recipient that this card belongs to. This attribute will not be in the card object if the card belongs to a customer or account instead |
tokenization_method | string | If the card number is tokenized, this is the method that was used. Can be apple_pay or android_pay |
ListCharges
Charges you've previously created
Parameter
<target_table> (optional):
<requestInitialLoad> (optional):
<limitCalls> (optional):
<label> (optional):
Attribute | Type | Description |
---|---|---|
id | string | Unique identifier for the object |
object | string | String representing the object's type. Objects of the same type share the same value |
amount | long | A positive integer in the smallest currency unit |
amount_refunded | integer | Amount in cents refunded (can be less than the amount attribute on the charge if a partial refund was issued) |
application | string | ID of the Connect application that created the charge |
application_fee | string | The application fee (if any) for the charge. See the Connect documentation for details |
balance_transaction | string | ID of the balance transaction that describes the impact of this charge on your account balance (not including refunds or disputes) |
captured | boolean | If the charge was created without capturing, this boolean represents whether or not it is still uncaptured or has since been captured |
created | timestamp | Time at which the object was created. Measured in seconds since the Unix epoch |
currency | string | Three-letter ISO currency code, in lowercase |
customer | string | ID of the customer this charge is for if one exists |
description | string | An arbitrary string attached to the object. Often useful for displaying to users |
destination | string | The account (if any) the charge was made on behalf of, with an automatic transfer |
dispute | string | Details about the dispute if the charge has been disputed |
failure_code | string | Error code explaining reason for charge failure if available (see the errors section for a list of codes) |
failure_message | string | Message to user further explaining reason for charge failure if available |
fraud_details_user_report | string | Information on fraud assessments for the charge reported by you |
fraud_details_stripe_report | string | Information on fraud assessments for the charge from Stripe |
invoice | string | ID of the invoice this charge is for if one exists |
livemode | boolean | Flag indicating whether the object exists in live mode or test mode |
metadata | clob | Set of key/value pairs that you can attach to an object. It can be useful for storing additional information about the object in a structured format |
on_behalf_of | string | The account (if any) the charge was made on behalf of without triggering an automatic transfer |
order | string | ID of the order this charge is for if one exists |
outcome_network_status | string | Details about whether or not the payment was accepted, and why. Possible values are approved_by_network, declined_by_network, not_sent_to_network, and reversed_after_approval. The value reversed_after_approval indicates the payment was blocked by Stripe after bank authorization, and may temporarily appear as "pending" on a cardholder's statement |
outcome_reason | string | An enumerated value indicating a more detailed explanation of the outcome's type |
outcome_risk_level | string | Stripe's evaluation of the riskiness of the payment. Possible values for evaluated payments are normal, elevated, highest. For non-card payments, and card-based payments predating the public assignment of risk levels, this field will have the value not_assessed. In the event of an error in the evaluation, this field will have the value unknown |
outcome_rule | string | The ID of the Radar rule that matched the payment |
outcome_seller_message | string | A human-readable description of the outcome type and reason, designed for you (the recipient of the payment), not your customer |
outcome_type | string | Possible values are authorized, manual_review, issuer_declined, blocked, and invalid |
paid | boolean | true if the charge succeeded, or was successfully authorized for later capture |
receipt_email | string | This is the email address that the receipt for this charge was sent to |
receipt_number | string | This is the transaction number that appears on email receipts sent for this charge. This attribute will be null until a receipt has been sent |
refunded | boolean | Whether or not the charge has been fully refunded. If the charge is only partially refunded, this attribute will still be false |
refunds_total_count | integer | The total number of refunds that have been applied to the charge |
review | string | ID of the review associated with this charge if one exists |
shipping_address_city | string | Shipping City/District/Suburb/Town/Village |
shipping_address_country | string | 2-letter country code |
shipping_address_line1 | string | Address line 1 (Street address/PO Box/Company name) |
shipping_address_line2 | string | Address line 2 (Apartment/Suite/Unit/Building) |
shipping_address_postal_code | string | Zip/Postal Code |
shipping_address_state | string | State/County/Province/Region |
shipping_carrier | string | The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc |
shipping_name | string | Recipient name |
shipping_phone | string | Recipient phone (including extension) |
shipping_tracking_number | string | The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas |
source_id | string | For most Stripe users, the source of every charge is a credit or debit card. This is then the card object describing that card. Unique identifier for the object |
source_object | string | String representing the object's type. Objects of the same type share the same value |
source_account | string | The account this card belongs to. This attribute will not be in the card object if the card belongs to a customer or recipient instead |
source_address_city | string | City/District/Suburb/Town/Village |
source_address_country | string | Billing address country, if provided when creating card |
source_address_line1 | string | Address line 1 (Street address/PO Box/Company name) |
source_address_line1_check | string | If address_line1 was provided, results of the check: pass, fail, unavailable, or unchecked |
source_address_line2 | string | Address line 2 (Apartment/Suite/Unit/Building) |
source_address_state | string | State/County/Province/Region |
source_address_zip | string | Zip/Postal Code |
source_address_zip_check | string | If address_zip was provided, results of the check: pass, fail, unavailable, or unchecked |
source_available_payout_methods | string | A set of available payout methods for this card. Will be either "standard" or "standard", "instant" |
source_brand | string | Card brand. Can be Visa, American Express, MasterCard, Discover, JCB, Diners Club, or Unknown |
source_country | string | Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected |
source_currency | string | Three-letter ISO code for currency. Only applicable on accounts (not customers or recipients). The card can be used as a transfer destination for funds in this currency |
source_customer | string | The customer that this card belongs to. This attribute will not be in the card object if the card belongs to an account or recipient instead |
source_cvc_check | string | If a CVC was provided, results of the check: pass, fail, unavailable, or unchecked |
source_default_for_currency | boolean | Only applicable on accounts (not customers or recipients). This indicates whether or not this card is the default external account for its currency |
source_dynamic_last4 | string | (For tokenized numbers only.) The last four digits of the device account number |
source_exp_month | integer | Two digit number representing the card's expiration month |
source_exp_year | integer | Four digit number representing the card's expiration year. |
source_fingerprint | string | Uniquely identifies this particular card number. You can use this attribute to check whether two customers who've signed up with you are using the same card number, for example |
source_funding | string | Card funding type. Can be credit, debit, prepaid, or unknown |
source_last4 | string | The last 4 digits of the card |
source_metadata | clob | Set of key/value pairs that you can attach to an object. It can be useful for storing additional information about the object in a structured format |
source_name | string | Cardholder name |
source_recipient | string | The recipient that this card belongs to. This attribute will not be in the card object if the card belongs to a customer or account instead |
source_tokenization_method | string | If the card number is tokenized, this is the method that was used. Can be apple_pay or android_pay |
source_transfer | string | The transfer ID which created this charge. Only present if the charge came from another Stripe account. See the Connect documentation for details |
statement_descriptor | string | Extra information about a charge. This will appear on your customer's credit card statement |
status | string | The status of the payment is either succeeded, pending, or failed |
transfer | string | ID of the transfer to the destination account (only applicable if the charge was created using the destination parameter) |
transfer_group | string | A string that identifies this transaction as part of a group. See the Connect documentation for details |
Example
CREATE VIEW stripe_examples.example_ListCharges AS SELECT * FROM (CALL stripe.ListCharges(limitCalls => 1))x
ListCoupons
Your coupons
Parameter
<target_table> (optional):
<requestInitialLoad> (optional):
<limitCalls> (optional):
<label> (optional):
Attribute | Type | Description |
---|---|---|
id | string | Unique identifier for the object |
object | string | String representing the object's type. Objects of the same type share the same value |
amount_off | integer | Amount (in the currency specified) that will be taken off the subtotal of any invoices for this customer |
created | timestamp | Time at which the object was created |
currency | string | If amount_off has been set, the three-letter ISO code for the currency of the amount to take off |
duration | string | One of forever, once, and repeating. Describes how long a customer who applies this coupon will get the discount |
duration_in_months | integer | If duration is repeating, the number of months the coupon applies. Null if coupon duration is forever or once |
livemode | boolean | Flag indicating whether the object exists in live mode or test mode |
max_redemptions | integer | Maximum number of times this coupon can be redeemed, in total, before it is no longer valid |
metadata | clob | Set of key/value pairs that you can attach to an object. It can be useful for storing additional information about the object in a structured format |
percent_off | integer | Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon. For example, a coupon with percent_off of 50 will make a $100 invoice $50 instead |
redeem_by | timestamp | Date after which the coupon can no longer be redeemed |
times_redeemed | integer | Number of times this coupon has been applied to a customer |
valid | boolean | Taking account of the above properties, whether this coupon can still be applied to a customer |
Example
CREATE VIEW stripe_examples.example_ListCoupons AS SELECT * FROM (CALL stripe.ListCoupons(limitCalls => 1))x
ListCustomers
Your customers
Parameter
<target_table> (optional):
<requestInitialLoad> (optional):
<limitCalls> (optional):
<label> (optional):
Attribute | Type | Description |
---|---|---|
id | string | Unique identifier for the object |
object | string | String representing the object's type. Objects of the same type share the same value |
account_balance | integer | Current balance, if any, being stored on the customer's account. If negative, the customer has credit to apply to the next invoice. If positive, the customer has an amount owed that will be added to the next invoice. The balance does not refer to any unpaid invoices; it solely takes into account amounts that have yet to be successfully applied to any invoice. This balance is only taken into account for recurring billing purposes (i.e., subscriptions, invoices, invoice items) |
business_vat_id | string | The customer's VAT identification number |
created | timestamp | Time at which the object was created |
currency | string | Three-letter ISO code for the currency the customer can be charged in for recurring billing purposes |
default_source | string | ID of the default source attached to this customer |
delinquent | boolean | Whether or not the latest charge for the customer's latest invoice has failed |
description | string | An arbitrary string attached to the object. Often useful for displaying to users |
discount_object | string | The discount object. String representing the object's type. Objects of the same type share the same value |
discount_coupon_id | string | ID of the coupon applied to create this discount |
discount_coupon_object | string | The coupon object. String representing the object's type. Objects of the same type share the same value |
discount_coupon_amount_off | integer | Amount (in the currency specified) that will be taken off the subtotal of any invoices for this customer |
discount_coupon_created | timestamp | Time at which the object was created |
discount_coupon_currency | string | If amount_off has been set, the three-letter ISO code for the currency of the amount to take off |
discount_coupon_duration | string | One of forever, once, and repeating. Describes how long a customer who applies this coupon will get the discount |
discount_coupon_duration_in_months | integer | If duration is repeating, the number of months the coupon applies. Null if coupon duration is forever or once |
discount_coupon_livemode | boolean | Flag indicating whether the object exists in live mode or test mode |
discount_coupon_max_redemptions | integer | Maximum number of times this coupon can be redeemed, in total, before it is no longer valid |
discount_coupon_metadata | clob | Set of key/value pairs that you can attach to an object. It can be useful for storing additional information about the object in a structured format |
discount_coupon_percent_off | integer | Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon |
discount_coupon_redeem_by | timestamp | Date after which the coupon can no longer be redeemed |
discount_coupon_times_redeemed | integer | Number of times this coupon has been applied to a customer |
discount_coupon_valid | boolean | Taking account of the above properties, whether this coupon can still be applied to a customer |
discount_customer | string | The discount customer |
discount_end | timestamp | If the coupon has a duration of repeating, the date that this discount will end. If the coupon has a duration of once or forever, this attribute will be null |
discount_start | timestamp | Date that the coupon was applied |
discount_subscription | string | The subscription that this coupon is applied to, if it is applied to a particular subscription |
string | The customer's email address | |
invoice_prefix | string | The prefix for the customer used to generate unique invoice numbers |
livemode | boolean | Flag indicating whether the object exists in live mode or test mode |
metadata | clob | Set of key/value pairs that you can attach to an object. It can be useful for storing additional information about the object in a structured format |
shipping_address_city | string | Shipping City/District/Suburb/Town/Village |
shipping_address_country | string | 2-letter country code |
shipping_address_line1 | string | Address line 1 (Street address/PO Box/Company name) |
shipping_address_line2 | string | Address line 2 (Apartment/Suite/Unit/Building) |
shipping_address_postal_code | string | Zip/Postal Code |
shipping_address_state | string | State/County/Province/Region |
shipping_name | string | Recipient name |
shipping_phone | string | Recipient phone (including extension) |
sources_total_count | integer | The total number of the customer's payment sources, if any |
subscriptions_total_count | integer | The total number of the customer's current subscriptions, if any |
Example
CREATE VIEW stripe_examples.example_ListCustomers AS SELECT * FROM (CALL stripe.ListCustomers(limitCalls => 1))x
ListDisputes
Your disputes
Parameter
<target_table> (optional):
<requestInitialLoad> (optional):
<limitCalls> (optional):
<label> (optional):
Attribute | Type | Description |
---|---|---|
id | string | Unique identifier for the object |
object | string | String representing the object's type. Objects of the same type share the same value |
amount | long | Disputed amount. Usually the amount of the charge, but can differ (usually because of currency fluctuation or because only part of the order is disputed) |
charge | string | ID of the charge that was disputed |
created | timestamp | Time at which the object was created |
currency | string | Three-letter ISO currency code, in lowercase |
evidence_access_activity_log | string | Evidence provided to respond to a dispute: Any server or activity logs showing proof that the customer accessed or downloaded the purchased digital product. This information should include IP addresses, corresponding timestamps, and any detailed recorded activity |
evidence_billing_address | string | The billing address provided by the customer |
evidence_cancellation_policy | string | (ID of a file upload) Your subscription cancellation policy, as shown to the customer |
evidence_cancellation_policy_disclosure | string | An explanation of how and when the customer was shown your refund policy prior to purchase |
evidence_cancellation_rebuttal | string | A justification for why the customer's subscription was not canceled |
evidence_customer_communication | string | (ID of a file upload) Any communication with the customer that you feel is relevant to your case (for example emails proving that they received the product or service, or demonstrating their use of or satisfaction with the product or service) |
evidence_customer_email_address | string | The email address of the customer |
evidence_customer_name | string | The name of the customer |
evidence_customer_purchase_ip | string | The IP address that the customer used when making the purchase |
evidence_customer_signature | string | (ID of a file upload) A relevant document or contract showing the customer's signature |
evidence_duplicate_charge_documentation | string | (ID of a file upload) Documentation for the prior charge that can uniquely identify the charge, such as a receipt, shipping label, work order, etc. This document should be paired with a similar document from the disputed payment that proves the two payments are separate |
evidence_duplicate_charge_explanation | string | An explanation of the difference between the disputed charge and the prior charge that appears to be a duplicate |
evidence_duplicate_charge_id | string | The Stripe ID for the prior charge which appears to be a duplicate of the disputed charge |
evidence_product_description | string | A description of the product or service which was sold |
evidence_receipt | string | (ID of a file upload) Any receipt or message sent to the customer notifying them of the charge |
evidence_refund_policy | string | (ID of a file upload) Your refund policy, as shown to the customer |
evidence_refund_policy_disclosure | string | Documentation demonstrating that the customer was shown your refund policy prior to purchase |
evidence_refund_refusal_explanation | string | A justification for why the customer is not entitled to a refund |
evidence_service_date | string | The date on which the customer received or began receiving the purchased service, in a clear human-readable format |
evidence_service_documentation | string | (ID of a file upload) Documentation showing proof that a service was provided to the customer. This could include a copy of a signed contract, work order, or other form of written agreement |
evidence_shipping_address | string | The address to which a physical product was shipped. You should try to include as much complete address information as possible |
evidence_shipping_carrier | string | The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc. If multiple carriers were used for this purchase, please separate them with commas |
evidence_shipping_date | string | The date on which a physical product began its route to the shipping address, in a clear human-readable format |
evidence_shipping_documentation | string | (ID of a file upload) Documentation showing proof that a product was shipped to the customer at the same address the customer provided to you. This could include a copy of the shipment receipt, shipping label, etc, and should show the full shipping address of the customer, if possible |
evidence_shipping_tracking_number | string | The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas |
evidence_uncategorized_file | string | (ID of a file upload) Any additional evidence or statements |
evidence_uncategorized_text | string | Any additional evidence or statements |
evidence_details_due_by | timestamp | Information about the evidence submission: Date by which evidence must be submitted in order to successfully challenge dispute. Will be null if the customer's bank or credit card company doesn't allow a response for this particular dispute |
evidence_details_has_evidence | boolean | Whether or not evidence has been staged for this dispute |
evidence_details_past_due | boolean | Whether or not the last evidence submission was submitted past the due date. Defaults to false if no evidence submissions have occurred. If true, then delivery of the latest evidence is not guaranteed |
evidence_details_submission_count | integer | The number of times evidence has been submitted. Typically, you may only submit evidence once |
is_charge_refundable | boolean | If true, it is still possible to refund the disputed payment. Once the payment has been fully refunded, no further funds will be withdrawn from your Stripe account as a result of this dispute |
livemode | boolean | Flag indicating whether the object exists in live mode or test mode |
metadata | clob | Set of key/value pairs that you can attach to an object. It can be useful for storing additional information about the object in a structured format |
reason | string | Reason given by cardholder for dispute |
status | string | Current status of dispute |
Example
CREATE VIEW stripe_examples.example_ListDisputes AS SELECT * FROM (CALL stripe.ListDisputes(limitCalls => 1))x
ListEvents
Events, going back up to 30 days
Parameter
<target_table> (optional):
<requestInitialLoad> (optional):
<limitCalls> (optional):
<label> (optional):
Attribute | Type | Description |
---|---|---|
id | string | Unique identifier for the object |
object | string | String representing the object's type. Objects of the same type share the same value |
api_version | string | The Stripe API version used to render data. Note: this property is populated for events on or after October 31, 2014 |
created | timestamp | Time at which the object was created |
data_total_count | integer | The total number of The objects containing data associated with the event |
livemode | boolean | Flag indicating whether the object exists in live mode or test mode |
pending_webhooks | integer | Number of webhooks yet to be delivered successfully (return a 20x response) to the URLs you've specified |
request_id | string | ID of the API request that caused the event. If null, the event was automatic (e.g. Stripe's automatic subscription handling). Request logs are available in the dashboard but currently not in the API. |
request_idempotency_key | string | The idempotency key transmitted during the request, if any. Note: this proprety is only populated for events on or after May 23, 2017 |
type | string | Description of the event: e.g. invoice.created, charge.refunded, etc. |
Example
CREATE VIEW stripe_examples.example_ListEvents AS SELECT * FROM (CALL stripe.ListEvents(limitCalls => 1))x
ListExternalBankAccounts
Bank accounts as transfer destinations on Account objects for Custom accounts
Parameter
<account> (required): The ID of the account
<target_table> (optional):
<limitCalls> (optional):
<sourceColumns> (optional):
<targetColumns> (optional):
<label> (optional):
Attribute | Type | Description |
---|---|---|
id | string | Unique identifier for the object |
object | string | String representing the object's type. Objects of the same type share the same value |
account | string | The account |
account_holder_name | string | The name of the person or business that owns the bank account |
account_holder_type | string | The type of entity that holds the account. This can be either individual or company |
bank_name | string | Name of the bank associated with the routing number, e.g. WELLS FARGO |
country | string | Two-letter ISO code representing the country the bank account is located in |
currency | string | Three-letter ISO code for the currency paid out to the bank account |
customer | string | The customer |
default_for_currency | boolean | Whether this external account is the default account for its currency |
fingerprint | string | Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same |
last4 | string | The last four digits |
metadata | clob | Set of key/value pairs that you can attach to an object. It can be useful for storing additional information about the object in a structured format |
routing_number | string | The routing transit number for the bank account |
status | string | Possible values are new, validated, verified, verification_failed, or errored. A bank account that hasn't had any activity or validation performed is new. If Stripe can determine that the bank account exists, its status will be validated. Note that there often isn't enough information to know (e.g. for smaller credit unions), and the validation is not always run. If customer bank account verification has succeeded, the bank account status will be verified. If the verification failed for any reason, such as microdeposit failure, the status will be verification_failed. If a transfer sent to this bank account fails, we'll set the status to errored and will not continue to send transfers until the bank details are updated |
ListExternalCards
Cards as transfer destinations on Account objects for Custom accounts
Parameter
<account> (required): The ID of the account
<target_table> (optional):
<limitCalls> (optional):
<sourceColumns> (optional):
<targetColumns> (optional):
<label> (optional):
Attribute | Type | Description |
---|---|---|
id | string | Unique identifier for the object |
object | string | String representing the object's type. Objects of the same type share the same value |
account | string | The account this card belongs to. This attribute will not be in the card object if the card belongs to a customer or recipient instead |
address_city | string | City/District/Suburb/Town/Village |
address_country | string | Billing address country, if provided when creating card |
address_line1 | string | Address line 1 (Street address/PO Box/Company name) |
address_line1_check | string | If address_line1 was provided, results of the check: pass, fail, unavailable, or unchecked |
address_line2 | string | Address line 2 (Apartment/Suite/Unit/Building) |
address_state | string | State/County/Province/Region |
address_zip | string | Zip/Postal Code |
address_zip_check | string | If address_zip was provided, results of the check: pass, fail, unavailable, or unchecked |
available_payout_methods | string | A set of available payout methods for this card. Will be either "standard" or "standard", "instant". Only values from this set should be passed as the method when creating a transfer |
brand | string | Card brand. Can be Visa, American Express, MasterCard, Discover, JCB, Diners Club, or Unknown |
country | string | Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected |
currency | string | Three-letter ISO code for currency. Only applicable on accounts (not customers or recipients). The card can be used as a transfer destination for funds in this currency |
customer | string | The customer that this card belongs to. This attribute will not be in the card object if the card belongs to an account or recipient instead |
cvc_check | string | If a CVC was provided, results of the check: pass, fail, unavailable, or unchecked |
default_for_currency | boolean | Only applicable on accounts (not customers or recipients). This indicates whether or not this card is the default external account for its currency |
dynamic_last4 | string | (For tokenized numbers only.) The last four digits of the device account number |
exp_month | integer | Two digit number representing the card's expiration month |
exp_year | integer | Four digit number representing the card's expiration year |
fingerprint | string | Uniquely identifies this particular card number. You can use this attribute to check whether two customers who've signed up with you are using the same card number, for example |
funding | string | Card funding type. Can be credit, debit, prepaid, or unknown |
last4 | string | The last 4 digits of the card |
metadata | clob | Set of key/value pairs that you can attach to an object. It can be useful for storing additional information about the object in a structured format |
name | string | Cardholder name |
recipient | string | The recipient that this card belongs to. This attribute will not be in the card object if the card belongs to a customer or account instead |
tokenization_method | string | If the card number is tokenized, this is the method that was used. Can be apple_pay or android_pay |
ListFileUploads
Files that you have uploaded to Stripe
Parameter
<target_table> (optional):
<requestInitialLoad> (optional):
<limitCalls> (optional):
<label> (optional):
Attribute | Type | Description |
---|---|---|
id | string | Unique identifier for the object |
object | string | String representing the object's type. Objects of the same type share the same value |
created | timestamp | Time at which the object was created |
purpose | string | The purpose of the uploaded file |
size | integer | The size in bytes of the file upload object |
type | string | The type of the file returned |
url | string | A read-only URL where the uploaded file can be accessed. Will be nil unless the uploaded file has one of the following purposes: business_logo, dispute_evidence, incorporation_document, invoice_statement, payment_provider_transfer, or product_feed. Also nil if retrieved with the publishable API key |
ListInvoiceItems
All invoice items
Parameter
<target_table> (optional):
<requestInitialLoad> (optional):
<limitCalls> (optional):
<label> (optional):
Attribute | Type | Description |
---|---|---|
id | string | Unique identifier for the object |
object | string | String representing the object's type. Objects of the same type share the same value |
amount | long | Amount (in the currency specified) of the invoice item |
currency | string | Three-letter ISO currency code, in lowercase. Must be a supported currency |
customer | string | The ID of the customer who will be billed when this invoice item is billed |
date | timestamp | The date |
description | string | An arbitrary string attached to the object. Often useful for displaying to users |
discountable | boolean | If true, discounts will apply to this invoice item. Always false for prorations |
invoice | string | The ID of the invoice this invoice item belongs to |
livemode | boolean | Flag indicating whether the object exists in live mode or test mode |
metadata | clob | Set of key/value pairs that you can attach to an object. It can be useful for storing additional information about the object in a structured format |
period_start | timestamp | The start of period |
period_end | timestamp | The end of period |
plan_id | string | If the invoice item is a proration, the plan id of the subscription that the proration was computed for |
plan_object | string | String representing the object's type. Objects of the same type share the same value |
plan_amount | long | The amount in cents to be charged on the interval specified |
plan_created | integer | Time at which the object was created |
plan_currency | string | Three-letter ISO currency code, in lowercase. Must be a supported currency |
plan_interval | string | One of day, week, month or year. The frequency with which a subscription should be billed |
plan_interval_count | integer | The number of intervals (specified in the interval property) between each subscription billing. For example, interval=month and interval_count=3 bills every 3 months |
plan_livemode | boolean | Flag indicating whether the object exists in live mode or test mode |
plan_metadata | clob | Set of key/value pairs that you can attach to an object. It can be useful for storing additional information about the object in a structured format |
plan_name | string | Display name of the plan |
plan_statement_descriptor | string | Extra information about a charge for the customer's credit card statement |
plan_trial_period_days | string | Number of trial period days granted when subscribing a customer to this plan. Null if the plan has no trial period |
proration | boolean | Whether or not the invoice item was created automatically as a proration adjustment when the customer switched plans |
quantity | integer | If the invoice item is a proration, the quantity of the subscription that the proration was computed for |
subscription | string | The subscription that this invoice item has been created for, if any |
subscription_item | string | The subscription item |
Example
CREATE VIEW stripe_examples.example_ListInvoiceItems AS SELECT * FROM (CALL stripe.ListInvoiceItems(limitCalls => 1))x
ListInvoices
All invoices
Parameter
<target_table> (optional):
<requestInitialLoad> (optional):
<limitCalls> (optional):
<label> (optional):
Attribute | Type | Description |
---|---|---|
id | string | Unique identifier for the object |
object | string | String representing the object's type. Objects of the same type share the same value |
amount_due | integer | Final amount due at this time for this invoice |
amount_paid | integer | The amount, in cents, that was paid |
amount_remaining | integer | The amount remaining, in cents, that is due |
application_fee | integer | 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 |
attempt_count | integer | Number of payment attempts made for this invoice, from the perspective of the payment retry schedule |
attempted | boolean | Whether or not an attempt has been made to pay the invoice |
charge | string | ID of the latest charge generated for this invoice, if any |
closed | boolean | Whether or not the invoice is still trying to collect payment |
currency | string | Three-letter ISO currency code |
customer | string | The customer |
date | timestamp | Time at which the object was created |
description | string | An arbitrary string attached to the object. Often useful for displaying to users |
discount_object | string | The discount object. String representing the object's type. Objects of the same type share the same value |
discount_coupon_id | string | ID of the coupon applied to create this discount |
discount_coupon_object | string | The coupon object. String representing the object's type. Objects of the same type share the same value |
discount_coupon_amount_off | integer | Amount (in the currency specified) that will be taken off the subtotal of any invoices for this customer |
discount_coupon_created | timestamp | Time at which the object was created |
discount_coupon_currency | string | If amount_off has been set, the three-letter ISO code for the currency of the amount to take off |
discount_coupon_duration | string | One of forever, once, and repeating. Describes how long a customer who applies this coupon will get the discount |
discount_coupon_duration_in_months | integer | If duration is repeating, the number of months the coupon applies. Null if coupon duration is forever or once |
discount_coupon_livemode | boolean | Flag indicating whether the object exists in live mode or test mode |
discount_coupon_max_redemptions | integer | Maximum number of times this coupon can be redeemed, in total, before it is no longer valid |
discount_coupon_metadata | clob | Set of key/value pairs that you can attach to an object. It can be useful for storing additional information about the object in a structured format |
discount_coupon_percent_off | integer | Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon |
discount_coupon_redeem_by | timestamp | Date after which the coupon can no longer be redeemed |
discount_coupon_times_redeemed | integer | Number of times this coupon has been applied to a customer |
discount_coupon_valid | boolean | Taking account of the above properties, whether this coupon can still be applied to a customer |
discount_customer | string | The discount customer |
discount_end | timestamp | If the coupon has a duration of repeating, the date that this discount will end. If the coupon has a duration of once or forever, this attribute will be null |
discount_start | timestamp | Date that the coupon was applied |
discount_subscription | string | The subscription that this coupon is applied to, if it is applied to a particular subscription |
ending_balance | integer | Ending customer balance after attempting to pay invoice. If the invoice has not been attempted yet, this will be null |
forgiven | boolean | Whether or not the invoice has been forgiven. Forgiving an invoice instructs us to update the subscription status as if the invoice were successfully paid. Once an invoice has been forgiven, it cannot be unforgiven or reopened |
lines_total_count | integer | The total number of the individual line items that make up the invoice |
livemode | boolean | Flag indicating whether the object exists in live mode or test mode |
metadata | clob | Set of key/value pairs that you can attach to an object. It can be useful for storing additional information about the object in a structured format |
next_payment_attempt | timestamp | The time at which payment will next be attempted |
paid | boolean | Whether or not payment was successfully collected for this invoice. An invoice can be paid (most commonly) with a charge or with credit from the customer's account balance |
period_end | timestamp | End of the usage period during which invoice items were added to this invoice |
period_start | timestamp | Start of the usage period during which invoice items were added to this invoice |
receipt_number | string | This is the transaction number that appears on email receipts sent for this invoice |
starting_balance | integer | Starting customer balance before attempting to pay invoice. If the invoice has not been attempted yet, this will be the current customer balance |
status | string | Status of the invoice |
status_transitions_finalized_at | timestamp | Invoice finalized at |
status_transitions_marked_uncollectible_at | timestamp | Invoice marked uncollectible at |
status_transitions_paid_at | timestamp | Invoice paid at |
status_transitions_voided_at | timestamp | Invoice voided at |
statement_descriptor | string | Extra information about an invoice for the customer's credit card statement |
subscription | string | The subscription that this invoice was prepared for, if any |
subscription_proration_date | timestamp | Only set for upcoming invoices that preview prorations. The time used to calculate prorations |
subtotal | integer | Total of all subscriptions, invoice items, and prorations on the invoice before any discount is applied |
tax | integer | The amount of tax included in the total, calculated from tax_percent and the subtotal. If no tax_percent is defined, this value will be null |
tax_percent | bigdecimal | This percentage of the subtotal has been added to the total amount of the invoice, including invoice line items and discounts. This field is inherited from the subscription's tax_percent field, but can be changed before the invoice is paid. This field defaults to null |
total | integer | Total after discount |
webhooks_delivered_at | timestamp | The time at which webhooks for this invoice were successfully delivered (if the invoice had no webhooks to deliver, this will match date). Invoice payment is delayed until webhooks are delivered, or until all webhook delivery attempts have been exhausted |
Example
CREATE VIEW stripe_examples.example_ListInvoices AS SELECT * FROM (CALL stripe.ListInvoices(limitCalls => 1))x
ListOrders
Orders
Parameter
<target_table> (optional):
<requestInitialLoad> (optional):
<limitCalls> (optional):
<label> (optional):
Attribute | Type | Description |
---|---|---|
id | string | Unique identifier for the object |
object | string | String representing the object's type. Objects of the same type share the same value |
amount | long | A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for 1 Japanese Yen being a zero-decimal currency) representing the total amount for the order |
amount_returned | integer | The returned amount |
application | string | ID of the Connect Application that created the order |
application_fee | integer | The application fee |
charge | string | The ID of the payment used to pay for the order. Present if the order status is paid, fulfilled, or refunded |
created | timestamp | Time at which the object was created |
currency | string | Three-letter ISO currency code, in lowercase |
customer | string | The customer used for the order |
string | The email address of the customer placing the order | |
external_coupon_code | string | The external coupon code |
livemode | boolean | Flag indicating whether the object exists in live mode or test mode |
metadata | clob | Set of key/value pairs that you can attach to an object. It can be useful for storing additional information about the object in a structured format |
returns_total_count | integer | The total number of returns |
selected_shipping_method | string | The shipping method that is currently selected for this order, if any. If present, it is equal to one of the ids of shipping methods in the shipping_methods array. At order creation time, if there are multiple shipping methods, Stripe will automatically selected the first method |
shipping_address_city | string | Shipping City/District/Suburb/Town/Village |
shipping_address_country | string | 2-letter country code |
shipping_address_line1 | string | Address line 1 (Street address/PO Box/Company name) |
shipping_address_line2 | string | Address line 2 (Apartment/Suite/Unit/Building) |
shipping_address_postal_code | string | Zip/Postal Code |
shipping_address_state | string | State/County/Province/Region |
shipping_carrier | string | The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc |
shipping_name | string | Recipient name |
shipping_phone | string | Recipient phone (including extension) |
shipping_tracking_number | string | The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas |
status | string | Current order status. One of created, paid, canceled, fulfilled, or returned |
status_transitions_canceled | timestamp | The timestamp at which the order was canceled |
status_transitions_fulfiled | timestamp | The timestamp at which the order was fulfiled |
status_transitions_paid | timestamp | The timestamp at which the order was paid |
status_transitions_returned | timestamp | The timestamp at which the order was returned |
updated | timestamp | The updated timestamp |
upstream_id | string | The merchant's order ID if it is different from the Stripe order ID |
Example
CREATE VIEW stripe_examples.example_ListOrders AS SELECT * FROM (CALL stripe.ListOrders(limitCalls => 1))x
ListPaymentIntents
Payment Intents
Parameter
<requestInitialLoad> (optional):
<target_table> (optional):
<limitCalls> (optional):
<label> (optional):
Attribute | Type | Description |
---|---|---|
id | string | Unique identifier for the object |
amount | integer | Amount intended to be collected by this PaymentIntent |
client_secret | string | The client secret of this PaymentIntent. Used for client-side retrieval using a publishable key |
currency | string | Three-letter ISO currency code |
customer | string | ID of the Customer this PaymentIntent belongs to, if one exists |
description | string | An arbitrary string attached to the object. Often useful for displaying to users |
last_payment_error | string | The payment error encountered in the previous PaymentIntent confirmation. It will be cleared if the PaymentIntent is later updated for any reason |
metadata | clob | Set of key/value pairs that you can attach to an object. It can be useful for storing additional information about the object in a structured format |
next_action | string | If present, this property tells you what actions you need to take in order for your customer to fulfill a payment using the provided source |
payment_method | string | ID of the payment method used in this PaymentIntent |
payment_method_types | string | The list of payment method types (e.g. card) that this PaymentIntent is allowed to use |
receipt_email | string | Email address that the receipt for the resulting payment will be sent to |
setup_future_usage | string | Indicates that you intend to make future payments with this PaymentIntent’s payment method |
shipping | string | Shipping information for this PaymentIntent |
statement_descriptor | string | For non-card charges, you can use this value as the complete description that appears on your customers’ statements |
statement_descriptor_suffix | string | Provides information about a card payment that customers see on their statements |
status | string | Status of this PaymentIntent |
object | string | String representing the object’s type |
amount_capturable | integer | Amount that can be captured from this PaymentIntent |
amount_received | integer | Amount that was collected by this PaymentIntent |
application | string | ID of the Connect application that created the PaymentIntent |
application_fee_amount | integer | The amount of the application fee (if any) requested for the resulting payment |
canceled_at | timestamp | Populated when status is canceled, this is the time at which the PaymentIntent was canceled |
cancellation_reason | string | Reason for cancellation of this PaymentIntent |
capture_method | string | Controls when the funds will be captured from the customer’s account |
confirmation_method | string | Confirmation method |
created | timestamp | Time at which the object was created |
invoice | string | ID of the invoice that created this PaymentIntent, if it exists |
livemode | boolean | Has the value true if the object exists in live mode or the value false if the object exists in test mode |
on_behalf_of | string | The account (if any) for which the funds of the PaymentIntent are intended |
payment_method_options | string | Payment-method-specific configuration for this PaymentIntent |
review | string | ID of the review associated with this PaymentIntent, if any |
transfer_data | string | The data with which to automatically create a Transfer when the payment is finalized |
transfer_group | string | A string that identifies the resulting payment as part of a group |
ListPayouts
Payouts
Parameter
<target_table> (optional):
<requestInitialLoad> (optional):
<limitCalls> (optional):
<label> (optional):
Attribute | Type | Description |
---|---|---|
id | string | Unique identifier for the object |
object | string | String representing the object's type. Objects of the same type share the same value |
amount | long | Amount (in cents) to be transferred to your bank account or debit card |
arrival_date | timestamp | Date the payout is expected to arrive in the bank. This factors in delays like weekends or bank holidays |
automatic | boolean | Returns true if the payout was created by an automated payout schedule, and false if it was requested manually |
balance_transaction | string | ID of the balance transaction that describes the impact of this payout on your account balance |
created | timestamp | Time at which the object was created |
currency | string | Three-letter ISO currency code, in lowercase |
description | string | An arbitrary string attached to the object. Often useful for displaying to users |
destination | string | ID of the bank account or card the payout was sent to |
failure_balance_transaction | string | If the payout failed or was canceled, this will be the ID of the balance transaction that reversed the initial balance transaction, and puts the funds from the failed payout back in your balance |
failure_code | string | Error code explaining reason for payout failure if available |
failure_message | string | Message to user further explaining reason for payout failure if available |
livemode | boolean | Flag indicating whether the object exists in live mode or test mode |
metadata | clob | Set of key/value pairs that you can attach to an object. It can be useful for storing additional information about the object in a structured format |
method | string | The method used to send this payout, which can be standard or instant. instant is only supported for payouts to debit cards |
source_type | string | The source balance this payout came from. One of card, bank_account, bitcoin_receiver, or alipay_account |
statement_descriptor | string | Extra information about a payout to be displayed on the user's bank statement |
status | string | Current status of the payout (paid, pending, in_transit, canceled or failed). A payout will be pending until it is submitted to the bank, at which point it becomes in_transit. It will then change to paid if the transaction goes through. If it does not go through successfully, its status will change to failed or canceled |
type | string | Can be bank_account or card |
Example
CREATE VIEW stripe_examples.example_ListPayouts AS SELECT * FROM (CALL stripe.ListPayouts(limitCalls => 1))x
ListPlans
Plans
Parameter
<requestInitialLoad> (optional):
<target_table> (optional):
<limitCalls> (optional):
<label> (optional):
Attribute | Type | Description |
---|---|---|
id | string | Unique identifier for the object |
object | string | String representing the object's type. Objects of the same type share the same value |
aggregate_usage | string | Specifies a usage aggregation strategy for plans of usage_type=metered |
amount | long | The amount in cents to be charged on the interval specified |
billing_scheme | string | Describes how to compute the price per period |
created | timestamp | Time at which the object was created |
currency | string | Three-letter ISO currency code, in lowercase |
interval | string | One of day, week, month or year. The frequency with which a subscription should be billed |
interval_count | integer | The number of intervals (specified in the interval property) between each subscription billing. For example, interval=month and interval_count=3 bills every 3 months |
livemode | boolean | Flag indicating whether the object exists in live mode or test mode |
metadata | clob | Set of key/value pairs that you can attach to an object. It can be useful for storing additional information about the object in a structured format |
nickname | string | A brief description of the plan, hidden from customers |
product | string | The product whose pricing this plan determines |
name | string | Display name of the plan |
tiers_mode | string | Defines if the tiering price should be graduated or volume based |
statement_descriptor | string | Extra information about a charge for the customer's credit card statement |
trial_period_days | integer | Number of trial period days granted when subscribing a customer to this plan. Null if the plan has no trial period |
usage_type | string | Configures how the quantity per period should be determined |
Example
CREATE VIEW stripe_examples.example_ListPlans AS SELECT * FROM (CALL stripe.ListPlans(limitCalls => 1))x
ListProducts
Products
Parameter
<target_table> (optional):
<requestInitialLoad> (optional):
<limitCalls> (optional):
<label> (optional):
Attribute | Type | Description |
---|---|---|
id | string | Unique identifier for the object |
object | string | String representing the object's type. Objects of the same type share the same value |
active | boolean | Whether or not the product is currently available for purchase |
attributes | string | A list of up to 5 attributes that each SKU can provide values for |
caption | string | A short one-line description of the product, meant to be displayable to the customer |
created | timestamp | Time at which the object was created |
deactivate_on | string | Connect application identifiers that cannot purchase this product |
description | string | The product's description, meant to be displayable to the customer |
images | string | A list of up to 8 URLs of images for this product, meant to be displayable to the customer |
livemode | boolean | Flag indicating whether the object exists in live mode or test mode |
metadata | clob | Set of key/value pairs that you can attach to an object. It can be useful for storing additional information about the object in a structured format |
name | string | The product's name, meant to be displayable to the customer |
package_height | bigdecimal | The dimensions of this SKU for shipping purposes: Height, in inches |
package_length | bigdecimal | The dimensions of this SKU for shipping purposes: Length, in inches |
package_weight | bigdecimal | The dimensions of this SKU for shipping purposes: Weight, in ounces |
package_width | bigdecimal | The dimensions of this SKU for shipping purposes: Width, in inches |
shippable | boolean | Whether this product is a shipped good |
skus_total_count | integer | The total number of active SKUs associated with this product |
statement_descriptor | string | Extra information about a product which will appear on your customer's credit card statement |
type | string | The type of the product |
unit_label | string | A label that represents units of this product |
updated | timestamp | The updated timestamp |
url | string | A URL of a publicly-accessible webpage for this product |
Example
CREATE VIEW stripe_examples.example_ListProducts AS SELECT * FROM (CALL stripe.ListProducts(limitCalls => 1))x
ListRefunds
Refunds you've previously created
Parameter
<target_table> (optional):
<requestInitialLoad> (optional):
<limitCalls> (optional):
<label> (optional):
Attribute | Type | Description |
---|---|---|
id | string | Unique identifier for the object |
object | string | String representing the object's type. Objects of the same type share the same value |
amount | long | Amount, in cents |
balance_transaction | string | Balance transaction that describes the impact on your account balance |
charge | string | ID of the charge that was refunded |
created | timestamp | Time at which the object was created |
currency | string | Three-letter ISO currency code, in lowercase |
description | string | An arbitrary string attached to the object. Often useful for displaying to users |
metadata | clob | Set of key/value pairs that you can attach to an object. It can be useful for storing additional information about the object in a structured format |
reason | string | Reason for the refund. If set, possible values are duplicate, fraudulent, and requested_by_customer |
receipt_number | string | This is the transaction number that appears on email receipts sent for this refund |
status | string | Status of the refund. For credit card refunds, this will always be succeeded. For other types of refunds, it can be pending, succeeded, failed, or cancelled |
Example
CREATE VIEW stripe_examples.example_ListRefunds AS SELECT * FROM (CALL stripe.ListRefunds(limitCalls => 1))x
ListReturns
Order returns
Parameter
<target_table> (optional):
<requestInitialLoad> (optional):
<limitCalls> (optional):
<label> (optional):
Attribute | Type | Description |
---|---|---|
id | string | Unique identifier for the object |
object | string | String representing the object's type. Objects of the same type share the same value |
amount | long | A positive integer in the smallest currency unit |
created | timestamp | Time at which the object was created |
currency | string | Three-letter ISO currency code, in lowercase |
livemode | boolean | Flag indicating whether the object exists in live mode or test mode |
order | string | The order that this return includes items from |
refund | string | The ID of the refund issued for this return |
Example
CREATE VIEW stripe_examples.example_ListReturns AS SELECT * FROM (CALL stripe.ListReturns(limitCalls => 1))x
ListSKUs
SKUs
Parameter
<target_table> (optional):
<requestInitialLoad> (optional):
<limitCalls> (optional):
<label> (optional):
Attribute | Type | Description |
---|---|---|
id | string | Unique identifier for the object |
object | string | String representing the object's type. Objects of the same type share the same value |
active | boolean | Whether or not the SKU is available for purchase |
created | timestamp | Time at which the object was created |
currency | string | Three-letter ISO currency code, in lowercase |
image | string | The URL of an image for this SKU, meant to be displayable to the customer |
inventory_quantity | integer | The count of inventory available. Will be present if and only if type is finite |
inventory_type | string | Inventory type. Possible values are finite, bucket (not quantified), and infinite |
inventory_value | string | An indicator of the inventory available. Possible values are in_stock, limited, and out_of_stock. Will be present if and only if type is bucket |
livemode | boolean | Flag indicating whether the object exists in live mode or test mode |
metadata | clob | Set of key/value pairs that you can attach to an object. It can be useful for storing additional information about the object in a structured format |
package_height | bigdecimal | The dimensions of this SKU for shipping purposes: Height, in inches |
package_length | bigdecimal | The dimensions of this SKU for shipping purposes: Length, in inches |
package_weight | bigdecimal | The dimensions of this SKU for shipping purposes: Weight, in ounces |
package_width | bigdecimal | The dimensions of this SKU for shipping purposes: Width, in inches |
price | integer | The cost of the item as a positive integer in the smallest currency unit |
product | string | The ID of the product this SKU is associated with. The product must be currently active |
updated | timestamp | The updated timestamp |
Example
CREATE VIEW stripe_examples.example_ListSKUs AS SELECT * FROM (CALL stripe.ListSKUs(limitCalls => 1))x
ListSubscriptions
Subscriptions that have not been canceled
Parameter
<target_table> (optional):
<requestInitialLoad> (optional):
<limitCalls> (optional):
<label> (optional):
Attribute | Type | Description |
---|---|---|
id | string | Unique identifier for the object |
object | string | String representing the object's type. Objects of the same type share the same value |
application_fee_percent | bigdecimal | A non-negative decimal (with at most two decimal places) between 0 and 100. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account |
cancel_at_period_end | boolean | If the subscription has been canceled with the at_period_end flag set to true, cancel_at_period_end on the subscription will be true. You can use this attribute to determine whether a subscription that has a status of active is scheduled to be canceled at the end of the current period |
canceled_at | timestamp | If the subscription has been canceled, the date of that cancellation. If the subscription was canceled with cancel_at_period_end, canceled_at will still reflect the date of the initial cancellation request, not the end of the subscription period when the subscription is automatically moved to a canceled state |
created | timestamp | Time at which the object was created. Measured in seconds since the Unix epoch |
current_period_end | timestamp | End of the current period that the subscription has been invoiced for. At the end of this period, a new invoice will be created |
current_period_start | timestamp | Start of the current period that the subscription has been invoiced for |
customer | string | ID of the customer who owns the subscription |
discount_object | string | The discount object. String representing the object's type. Objects of the same type share the same value |
discount_coupon_id | string | ID of the coupon applied to create this discount |
discount_coupon_object | string | The coupon object. String representing the object's type. Objects of the same type share the same value |
discount_coupon_amount_off | integer | Amount (in the currency specified) that will be taken off the subtotal of any invoices for this customer |
discount_coupon_created | timestamp | Time at which the object was created |
discount_coupon_currency | string | If amount_off has been set, the three-letter ISO code for the currency of the amount to take off |
discount_coupon_duration | string | One of forever, once, and repeating. Describes how long a customer who applies this coupon will get the discount |
discount_coupon_duration_in_months | integer | If duration is repeating, the number of months the coupon applies. Null if coupon duration is forever or once |
discount_coupon_livemode | boolean | Flag indicating whether the object exists in live mode or test mode |
discount_coupon_max_redemptions | integer | Maximum number of times this coupon can be redeemed, in total, before it is no longer valid |
discount_coupon_metadata | clob | Set of key/value pairs that you can attach to an object. It can be useful for storing additional information about the object in a structured format |
discount_coupon_percent_off | integer | Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon |
discount_coupon_redeem_by | timestamp | Date after which the coupon can no longer be redeemed |
discount_coupon_times_redeemed | integer | Number of times this coupon has been applied to a customer |
discount_coupon_valid | boolean | Taking account of the above properties, whether this coupon can still be applied to a customer |
discount_customer | string | The discount customer |
discount_end | timestamp | If the coupon has a duration of repeating, the date that this discount will end. If the coupon has a duration of once or forever, this attribute will be null |
discount_start | timestamp | Date that the coupon was applied |
discount_subscription | string | The subscription that this coupon is applied to, if it is applied to a particular subscription |
ended_at | timestamp | 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 |
livemode | boolean | Flag indicating whether the object exists in live mode or test mode |
metadata | clob | Set of key/value pairs that you can attach to an object. It can be useful for storing additional information about the object in a structured format |
plan_id | string | If the invoice item is a proration, the plan id of the subscription that the proration was computed for |
plan_object | string | String representing the object's type. Objects of the same type share the same value |
plan_amount | long | The amount in cents to be charged on the interval specified |
plan_created | timestamp | Time at which the object was created |
plan_currency | string | Three-letter ISO currency code, in lowercase. Must be a supported currency |
plan_interval | string | One of day, week, month or year. The frequency with which a subscription should be billed |
plan_interval_count | integer | The number of intervals (specified in the interval property) between each subscription billing. For example, interval=month and interval_count=3 bills every 3 months |
plan_livemode | boolean | Flag indicating whether the object exists in live mode or test mode |
plan_metadata | clob | Set of key/value pairs that you can attach to an object. It can be useful for storing additional information about the object in a structured format |
plan_name | string | Display name of the plan |
plan_statement_descriptor | string | Extra information about a charge for the customer's credit card statement |
plan_trial_period_days | string | Number of trial period days granted when subscribing a customer to this plan. Null if the plan has no trial period |
quantity | integer | 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 |
start | timestamp | Date the most recent update to this subscription started |
status | string | Possible values are trialing, active, past_due, canceled, or unpaid. A subscription still in its trial period is trialing and moves to active when the trial period is over. When payment to renew the subscription fails, the subscription becomes past_due. After Stripe has exhausted all payment retry attempts, the subscription ends up with a status of either canceled or unpaid depending on your retry settings. Note that when a subscription has a status of unpaid, no subsequent invoices will be attempted (invoices will be created, but then immediately automatically closed. Additionally, updating customer card details will not lead to Stripe retrying the latest invoice.). After receiving updated card details from a customer, you may choose to reopen and pay their closed invoices |
tax_percent | bigdecimal | If provided, each invoice created by this subscription will apply the tax rate, increasing the amount billed to the customer |
trial_end | timestamp | If the subscription has a trial, the end of that trial |
trial_start | timestamp | If the subscription has a trial, the beginning of that trial |
Example
CREATE VIEW stripe_examples.example_ListSubscriptions AS SELECT * FROM (CALL stripe.ListSubscriptions(limitCalls => 1))x
ListTransferReversals
Reversals belonging to a specific transfer
Parameter
<transfer> (required): The ID of the transfer whose reversals will be retrieved
<target_table> (optional):
<limitCalls> (optional):
<sourceColumns> (optional):
<targetColumns> (optional):
<label> (optional):
Attribute | Type | Description |
---|---|---|
id | string | Unique identifier for the object |
object | string | String representing the object's type. Objects of the same type share the same value |
amount | long | Amount, in cents |
balance_transaction | string | Balance transaction that describes the impact on your account balance |
created | timestamp | Time at which the object was created |
currency | string | Three-letter ISO currency code, in lowercase |
metadata | clob | Set of key/value pairs that you can attach to an object. It can be useful for storing additional information about the object in a structured format |
transfer | string | ID of the transfer that was reversed |
ListTransfers
Transfers
Parameter
<target_table> (optional):
<requestInitialLoad> (optional):
<limitCalls> (optional):
<label> (optional):
Attribute | Type | Description |
---|---|---|
id | string | Unique identifier for the object |
object | string | String representing the object's type. Objects of the same type share the same value |
amount | long | Amount in cents to be transferred |
amount_reversed | integer | Amount in cents reversed (can be less than the amount attribute on the transfer if a partial reversal was issued) |
balance_transaction | string | Balance transaction that describes the impact of this transfer on your account balance |
created | timestamp | Time that this record of the transfer was first created |
currency | string | Three-letter ISO currency code, in lowercase |
description | string | An arbitrary string attached to the object. Often useful for displaying to users |
destination | string | ID of the Stripe account the transfer was sent to |
destination_payment | string | If the destination is a Stripe account, this will be the ID of the payment that the destination account received for the transfer |
livemode | boolean | Flag indicating whether the object exists in live mode or test mode |
metadata | clob | A set of key/value pairs that you can attach to a transfer object. It can be useful for storing additional information about the transfer in a structured format |
reversals_total_count | integer | The total number of reversals that have been applied to the transfer |
reversed | boolean | Whether or not the transfer has been fully reversed. If the transfer is only partially reversed, this attribute will still be false |
source_transaction | string | ID of the charge or payment that was used to fund the transfer. If null, the transfer was funded from the available balance |
source_type | string | The source type |
transfer_group | string | A string that identifies this transaction as part of a group |
Example
CREATE VIEW stripe_examples.example_ListTransfers AS SELECT * FROM (CALL stripe.ListTransfers(limitCalls => 1))x