Reading from Stripe entities - Amazon Glue
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

Reading from Stripe entities

Prerequisites

  • A Stripe object you would like to read from.

Supported entities

Entity Can be Filtered Supports Limit Supports Order By Supports Select * Supports Partitioning
BalanceNoNoNoYesNo
Balance TransactionsYesYesNoYesYes
ChargesYesYesNoYesYes
DisputesYesYesNoYesYes
File LinksYesYesNoYesYes
PaymentIntentsYesYesNoYesYes
SetupIntentsYesYesNoYesYes
PayoutsYesYesNoYesYes
RefundsYesYesNoYesYes
ProductsYesYesNoYesYes
PricesYesYesNoYesYes
CouponsYesYesNoYesYes
Promotion CodesYesYesNoYesYes
Tax CodesNoYesNoYesNo
Tax RatesYesYesNoYesYes
Shipping RatesYesYesNoYesYes
SessionsYesYesNoYesYes
Credit NotesYesYesNoYesYes
CustomerYesYesNoYesYes
InvoicesYesYesNoYesYes
Invoice ItemsYesYesNoYesNo
PlansYesYesNoYesYes
QuotesYesYesNoYesNo
SubscriptionsYesYesNoYes
Subscription ItemsNoYesNoYesNo
Subscription SchedulesYesYesNoYesYes
AccountsNoYesNoYesYes
Application FeesYesYesNoYesYes
Country SpecsNoYesNoYesNo
TransfersYesYesNoYesYes
Early Fraud WarningsYesYesNoYesYes
Report TypesNoNoNoYesNo

Example

stripe_read = glueContext.create_dynamic_frame.from_options( connection_type="stripe", connection_options={ "connectionName": "connectionName", "ENTITY_NAME": "coupons", "API_VERSION": "v1" } )

Stripe entity and field details

Entity Field Data Type Supported Operators
Balance
availableList
connect_reservedList
pendingList
livemodeBoolean
objectString
instant_availableList
issuingStruct
Balance Transactions
idString
objectString
amountInteger
available_onDateTime=, >=, <=,<,>
createdDateTime=, >=, <=,<,>
currencyString
descriptionString
exchange_rateBigDecimal
feeInteger
fee_detailsList
netInteger
reporting_categoryString
sourceString=
statusString
typeString=
cross_border_classificationString
Charges
idString
objectString
amountInteger=, <, >
amount_capturedInteger
amount_refundedInteger
applicationString
application_feeString
application_fee_amountInteger
balance_transactionString
billing_detailsStruct
calculated_statement_descriptorString
capturedBoolean
createdDateTime=, >=, <=,<,>
currencyString
customerString=
descriptionString
destinationString
disputeString
disputedBoolean=
failure_balance_transactionString
failure_codeString
failure_messageString
fraud_detailsStruct
invoiceString
livemodeBoolean
metadataStruct
on_behalf_ofString
orderString
outcomeStruct
paidBoolean
payment_intentString=
payment_methodString
payment_method_detailsStruct
receipt_emailString
receipt_numberString
receipt_urlString
refundedBoolean=
refundsStruct
reviewString
shippingStruct
sourceStruct
source_transferString
statement_descriptorString
statement_descriptor_suffixString
statusString
transferString
transfer_dataStruct
transfer_groupString=
Disputes
idString
objectString
amountInteger=, <, >
balance_transactionString
balance_transactionsList
chargeString=
createdDateTime=, >=, <=,<,>
currencyString
evidenceStruct
evidence_detailsStruct
is_charge_refundableBoolean
livemodeBoolean
metadataStruct
payment_intentString=
reasonString=
statusString
payment_method_detailsStruct
File Links
idString
objectString
createdDateTime=, >=, <=,<,>
expiredBoolean=
expires_atDateTime
fileString=
livemodeBoolean
metadataStruct
urlString
PaymentIntents
idString
objectString
amountInteger
amount_capturableInteger
amount_detailsStruct
amount_receivedInteger
applicationString
application_fee_amountInteger
automatic_payment_methodsStruct
canceled_atDateTime
cancellation_reasonString
capture_methodString
client_secretString
confirmation_methodString
createdDateTime=, >=, <=,<,>
currencyString
customerString=
descriptionString
invoiceString
last_payment_errorStruct
latest_chargeString
livemodeBoolean
metadataStruct
next_actionStruct
on_behalf_ofString
payment_methodString
payment_method_optionsStruct
payment_method_typesList
payment_method_configuration_detailsStruct
processingStruct
receipt_emailString
reviewString
setup_future_usageString
shippingStruct
sourceString
statement_descriptorString
statement_descriptor_suffixString
statusString
transfer_dataStruct
transfer_groupString
SetupIntents
idString
objectString
applicationString
cancellation_reasonString
client_secretString
createdDateTime=, >=, <=,<,>
customerString=
descriptionString
flow_directionsList
last_setup_errorStruct
latest_attemptString
livemodeBoolean
mandateString
metadataStruct
next_actionStruct
on_behalf_ofString
payment_methodString
payment_method_optionsStruct
payment_method_typesList
single_use_mandateString
statusString
usageString
automatic_payment_methodsStruct
Payouts
idString
objectString
amountInteger=, <, >
arrival_dateDateTime=, >=, <=,<,>
automaticBoolean
balance_transactionString
createdDateTime=, >=, <=,<,>
currencyString
descriptionString=
destinationString
failure_balance_transactionString
failure_codeString
failure_messageString
livemodeBoolean
metadataStruct
methodString
original_payoutString
reversed_byString
reconciliation_statusString
source_typeString
statement_descriptorString
statusString
typeString
application_feeString
application_fee_amountInteger
Refunds
idString
objectString
amountInteger
balance_transactionString
chargeString=
createdDateTime=, >=, <=,<,>
currencyString
metadataStruct
destination_detailsStruct
payment_intentString=
reasonString
receipt_numberString
source_transfer_reversalString
statusString
transfer_reversalString
Products
idString
objectString
activeBoolean=
attributesList
createdDateTime=, >=, <=,<,>
default_priceString
descriptionString
imagesList
livemodeBoolean
metadataStruct
nameString
package_dimensionsStruct
shippableBoolean
statement_descriptorString
tax_codeString
typeString=
unit_labelString
updatedDateTime
urlString
featuresList
Prices
idString
objectString
activeBoolean=
billing_schemeString
createdDateTime=, >=, <=,<,>
currencyString=
custom_unit_amountStruct
livemodeBoolean
lookup_keyString
metadataStruct
nicknameString
productString=
recurringStruct
tax_behaviorString
tiers_modeString
transform_quantityStruct
typeString=
unit_amountInteger
unit_amount_decimalString
Coupons
IdString
objectString
amount_offInteger
createdDateTime=, >=, <=,<,>
currencyString=
durationString=
duration_in_monthsInteger=,<,>
livemodeBoolean
max_redemptionsInteger=, <, >
metadataStruct
nameString
percent_offDouble=
redeem_byDateTime=, >=, <=, <, >
times_redeemedInteger
validBoolean
Promotion Codes
IdString
objectString
activeBoolean=
codeString=
couponStruct
createdDateTime=,>=,<=,<,>
customerString
expires_atDateTime
livemodeBoolean
max_redemptionsInteger
metadataStruct
restrictionsStruct
times_redeemedInteger
Tax Codes
IdString
objectString
descriptionString
nameString
Tax Rates
IdString
objectString
activeBoolean=
countryString
createdDateTime=, >=, <=, <, >
descriptionString
display_nameString
inclusiveBoolean=
jurisdictionString
jurisdiction_levelString
livemodeBoolean
metadataStruct
percentageDouble
effective_percentageDouble
stateString
tax_typeString
Shipping Rates
IdString
objectString
activeBoolean=
createdDateTime=, >=, <=, <, >
delivery_estimateStruct
display_nameString
fixed_amountStruct
livemodeBoolean
metadataStruct
tax_behaviorString
tax_codeString
typeString
Sessions
idString
objectString
after_expirationStruct
allow_promotion_codesBoolean
amount_subtotalInteger
amount_totalInteger
automatic_taxStruct
billing_address_collectionString
cancel_urlString
client_reference_idString
consentStruct
consent_collectionStruct
createdDateTime=, >=, <=, <, >
currencyString
custom_textStruct
customerString
customer_creationString
customer_detailsStruct
customer_emailString
expires_atDateTime
invoiceString
invoice_creationStruct
livemodeBoolean
localeString
metadataStruct
modeString
payment_intentString=
payment_linkString
payment_method_collectionString
payment_method_optionsStruct
payment_method_typesList
payment_statusString
phone_number_collectionStruct
recovered_fromString
setup_intentString
shipping_address_collectionStruct
shipping_costStruct
shipping_detailsStruct
shipping_optionsList
statusString
submit_typeString
subscriptionString
success_urlString
tax_id_collectionStruct
total_detailsStruct
urlString
ui_modeString
Credit Notes
idString
objectString
amountInteger
createdDateTime=, >=, <=, <, >
currencyString
customerString=
customer_balance_transactionString
discount_amountInteger
discount_amountsList
invoiceString=
linesStruct
livemodeBoolean
memoString
metadataStruct
numberString
out_of_band_amountInteger
pdfString
reasonString
refundString
statusString
subtotalInteger
subtotal_excluding_taxInteger
tax_amountsList
totalInteger
total_excluding_taxInteger
typeString
voided_atDateTime
amount_shippingInteger
effective_atDateTime
shipping_costStruct
Customer
idString
objectString
addressStruct
balanceInteger
createdDateTime
currencyString=, >=, <=, <, >
default_sourceString
delinquentBoolean=
descriptionString
discountStruct
emailString=
invoice_prefixString
invoice_settingsStruct
livemodeBoolean
metadataStruct
nameString
next_invoice_sequenceInteger
phoneString
preferred_localesList
shippingStruct
tax_exemptString
test_clockString
Invoices
idString
objectString
account_countryString
account_nameString
account_tax_idsList
amount_dueInteger
amount_paidInteger
amount_remainingInteger
applicationString
application_fee_amountInteger
attempt_countInteger
attemptedBoolean=
auto_advanceBoolean=
automatic_taxStruct
billing_reasonString
chargeString
collection_methodString=
createdDateTime=, >=, <=, <, >
currencyString
custom_fieldsList
customerString=
customer_addressStruct
customer_emailString
customer_nameString
customer_phoneString
customer_shippingStruct
customer_tax_exemptString
customer_tax_idsList
default_payment_methodString
default_sourceString
default_tax_ratesList
descriptionString
discountStruct
discountsList
due_dateDateTime=, >=, <=, <, >
ending_balanceInteger
footerString
from_invoiceStruct
hosted_invoice_urlString
invoice_pdfString
last_finalization_errorStruct
latest_revisionString
linesStruct
livemodeBoolean
metadataStruct
next_payment_attemptDateTime
numberString
on_behalf_ofString
paidBoolean=
paid_out_of_bandBoolean
payment_intentString
payment_settingsStruct
period_endDateTime=, >=, <=, <, >
period_startDateTime=, >=, <=, <, >
post_payment_credit_notes_amountInteger
pre_payment_credit_notes_amountInteger
quoteString
receipt_numberString
renderingStruct
rendering_optionsStruct
starting_balanceInteger
statement_descriptorString
statusString=
status_transitionsStruct
subscriptionString
subscription_detailsStruct
subtotalInteger=, <, >
subtotal_excluding_taxInteger
taxInteger
test_clockString
totalInteger=, <, >
total_discount_amountsList
total_excluding_taxInteger
total_tax_amountsList
transfer_dataStruct
webhooks_delivered_atDateTime
automatically_finalizes_atDateTime
effective_atDateTime
issuerStruct
Invoice Items
idString
objectString
amountInteger=, <, >
currencyString
customerString=
dateDateTime
descriptionString
discountableBoolean
discountsList
invoiceString=
livemodeBoolean
metadataStruct
periodStruct
planStruct
priceStruct
prorationBoolean=
quantityInteger
subscriptionString
subscription_itemString
tax_ratesList
test_clockString
unit_amountInteger
unit_amount_decimalString
Plans
idString
objectString
activeBoolean=
aggregate_usageString
amountInteger
amount_decimalString
billing_schemeString
createdDateTime=, >=, <=, <, >
currencyString=
intervalString=
interval_countInteger
livemodeBoolean
metadataStruct
nicknameString
productString=
tiers_modeString
transform_usageStruct
trial_period_daysInteger=, <, >
usage_typeString
meterString
Quotes
idString
objectString
amount_subtotalInteger
amount_totalInteger
applicationString
application_fee_amountInteger
application_fee_percentDouble
automatic_taxStruct
collection_methodString
computedStruct
createdDateTime
currencyString
customerString=
default_tax_ratesList
descriptionString
discountsList
expires_atDateTime
footerString
from_quoteStruct
headerString
invoiceString
invoice_settingsStruct
livemodeBoolean
metadataStruct
numberString
on_behalf_ofString
statusString=
status_transitionsStruct
subscriptionString
subscription_dataStruct
subscription_scheduleString
test_clockString
total_detailsStruct
transfer_dataStruct
Subscriptions
idString
objectString
applicationString
application_fee_percentDouble
automatic_taxStruct
billing_cycle_anchorDateTime
billing_thresholdsStruct
cancel_atDateTime
cancel_at_period_endBoolean
canceled_atDateTime
collection_methodString=
createdDateTime=, >=, <=,<,>
currencyString
current_period_endDateTime=, >=, <=
current_period_startDateTime=, >=, <=
customerString=
days_until_dueInteger
default_payment_methodString
default_sourceString
default_tax_ratesList
descriptionString
discountStruct
ended_atDateTime
itemsStruct
latest_invoiceString
livemodeBoolean
metadataStruct
next_pending_invoice_item_invoiceDateTime
pause_collectionStruct
payment_settingsStruct
pending_invoice_item_intervalStruct
pending_setup_intentString
pending_updateStruct
planStruct
quantityInteger
scheduleString
start_dateDateTime
statusString=
test_clockString
transfer_dataStruct
trial_endDateTime
trial_startDateTime
Subscription Items
IdString
objectString
billing_thresholdsStruct
createdDateTime=, >=, <=, <, >
metadataStruct
planStruct
priceStruct
subscriptionString
tax_ratesList
discountsList
Subscription Schedules
objectString
applicationString
canceled_atDateTime
completed_atDateTime
createdDateTime
current_phaseStruct
customerString=
default_settingsStruct
end_behaviorString
livemodeBoolean
metadataStruct
phasesList
released_atDateTime
released_subscriptionString
renewal_intervalString
statusString
subscriptionString
test_clockString
Accounts
details_submittedBoolean
tos_acceptanceStruct
typeString
metadataStruct
idString
objectString
default_currencyString
capabilitiesStruct
charges_enabledBoolean
settingsStruct
requirementsStruct
payouts_enabledBoolean
future_requirementsStruct
external_accountsStruct
controllerStruct
countryString
emailString
createdDateTime=, >=, <=, <, >
business_profileStruct
business_typeString
companyStruct
Application Fees
idString
objectString
accountString
amountInteger=, <, >
amount_refundedInteger=, <, >
applicationString
balance_transactionString
chargeString=
createdDateTime
currencyString
livemodeBoolean
originating_transactionString
refundedBoolean=
refundsStruct
fee_sourceStruct
Country Specs
idString
objectString
default_currencyString
supported_bank_account_currenciesStruct
supported_payment_currenciesList
supported_payment_methodsList
supported_transfer_countriesList
verification_fieldsStruct
Transfers
idString
objectString
amountInteger=, <, >
amount_reversedInteger
balance_transactionString
createdDateTime=, >=, <=, <, >
currencyString=
descriptionString
destinationString=
destination_paymentString
livemodeBoolean
metadataStruct
reversalsStruct
reversedBoolean
source_transactionString
source_typeString
transfer_groupString=
Early Fraud Warnings
idString
objectString
actionableBoolean
chargeString=
createdDateTime=, >=, <=, <, >
fraud_typeString
livemodeBoolean
payment_intentString=
Report Types
idString
objectString
data_available_endDateTime
data_available_startDateTime
default_columnsList
livemodeBoolean
nameString
updatedDateTime
versionInteger

Partitioning queries

Additional spark options PARTITION_FIELD, LOWER_BOUND, UPPER_BOUND, NUM_PARTITIONS can be provided if you want to utilize concurrency in Spark. With these parameters, the original query would be split into NUM_PARTITIONS number of sub-queries that can be executed by spark tasks concurrently.

  • PARTITION_FIELD: the name of the field to be used to partition query.

  • LOWER_BOUND: an inclusive lower bound value of the chosen partition field.

    For date, we accept the Spark date format used in Spark SQL queries. Example of valid value: "2024-07-01T00:00:00.000Z".

  • UPPER_BOUND: an exclusive upper bound value of the chosen partition field.

  • NUM_PARTITIONS: number of partitions.

Entity wise partitioning field support details are captured in below table.

Entity Name Partitioning Field Data Type
Balance TransactionscreatedDateTime
ChargescreatedDateTime
DisputescreatedDateTime
File LinkscreatedDateTime
PaymentIntentscreatedDateTime
SetupIntentscreatedDateTime
PayoutscreatedDateTime
RefundscreatedDateTime
ProductscreatedDateTime
PricescreatedDateTime
CouponscreatedDateTime
Promotion CodescreatedDateTime
Tax RatescreatedDateTime
Shipping RatescreatedDateTime
SessionscreatedDateTime
Credit NotescreatedDateTime
CustomercreatedDateTime
InvoicescreatedDateTime
PlanscreatedDateTime
SubscriptionscreatedDateTime
Subscription SchedulescreatedDateTime
AccountscreatedDateTime
Application FeescreatedDateTime
TransferscreatedDateTime
Early Fraud WarningscreatedDateTime

Example

stripe_read = glueContext.create_dynamic_frame.from_options( connection_type="stripe", connection_options={ "connectionName": "connectionName", "ENTITY_NAME": "coupons", "API_VERSION": "v1", "PARTITION_FIELD": "created" "LOWER_BOUND": "2024-05-01T20:55:02.000Z" "UPPER_BOUND": "2024-07-11T20:55:02.000Z" "NUM_PARTITIONS": "10" } )