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
Balance	No	No	No	Yes	No
Balance Transactions	Yes	Yes	No	Yes	Yes
Charges	Yes	Yes	No	Yes	Yes
Disputes	Yes	Yes	No	Yes	Yes
File Links	Yes	Yes	No	Yes	Yes
PaymentIntents	Yes	Yes	No	Yes	Yes
SetupIntents	Yes	Yes	No	Yes	Yes
Payouts	Yes	Yes	No	Yes	Yes
Refunds	Yes	Yes	No	Yes	Yes
Products	Yes	Yes	No	Yes	Yes
Prices	Yes	Yes	No	Yes	Yes
Coupons	Yes	Yes	No	Yes	Yes
Promotion Codes	Yes	Yes	No	Yes	Yes
Tax Codes	No	Yes	No	Yes	No
Tax Rates	Yes	Yes	No	Yes	Yes
Shipping Rates	Yes	Yes	No	Yes	Yes
Sessions	Yes	Yes	No	Yes	Yes
Credit Notes	Yes	Yes	No	Yes	Yes
Customer	Yes	Yes	No	Yes	Yes
Invoices	Yes	Yes	No	Yes	Yes
Invoice Items	Yes	Yes	No	Yes	No
Plans	Yes	Yes	No	Yes	Yes
Quotes	Yes	Yes	No	Yes	No
Subscriptions	Yes	Yes	No	Yes
Subscription Items	No	Yes	No	Yes	No
Subscription Schedules	Yes	Yes	No	Yes	Yes
Accounts	No	Yes	No	Yes	Yes
Application Fees	Yes	Yes	No	Yes	Yes
Country Specs	No	Yes	No	Yes	No
Transfers	Yes	Yes	No	Yes	Yes
Early Fraud Warnings	Yes	Yes	No	Yes	Yes
Report Types	No	No	No	Yes	No

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
	available	List
	connect_reserved	List
	pending	List
	livemode	Boolean
	object	String
	instant_available	List
	issuing	Struct
Balance Transactions
	id	String
	object	String
	amount	Integer
	available_on	DateTime	=, >=, <=,<,>
	created	DateTime	=, >=, <=,<,>
	currency	String
	description	String
	exchange_rate	BigDecimal
	fee	Integer
	fee_details	List
	net	Integer
	reporting_category	String
	source	String	=
	status	String
	type	String	=
	cross_border_classification	String
Charges
	id	String
	object	String
	amount	Integer	=, <, >
	amount_captured	Integer
	amount_refunded	Integer
	application	String
	application_fee	String
	application_fee_amount	Integer
	balance_transaction	String
	billing_details	Struct
	calculated_statement_descriptor	String
	captured	Boolean
	created	DateTime	=, >=, <=,<,>
	currency	String
	customer	String	=
	description	String
	destination	String
	dispute	String
	disputed	Boolean	=
	failure_balance_transaction	String
	failure_code	String
	failure_message	String
	fraud_details	Struct
	invoice	String
	livemode	Boolean
	metadata	Struct
	on_behalf_of	String
	order	String
	outcome	Struct
	paid	Boolean
	payment_intent	String	=
	payment_method	String
	payment_method_details	Struct
	receipt_email	String
	receipt_number	String
	receipt_url	String
	refunded	Boolean	=
	refunds	Struct
	review	String
	shipping	Struct
	source	Struct
	source_transfer	String
	statement_descriptor	String
	statement_descriptor_suffix	String
	status	String
	transfer	String
	transfer_data	Struct
	transfer_group	String	=
Disputes
	id	String
	object	String
	amount	Integer	=, <, >
	balance_transaction	String
	balance_transactions	List
	charge	String	=
	created	DateTime	=, >=, <=,<,>
	currency	String
	evidence	Struct
	evidence_details	Struct
	is_charge_refundable	Boolean
	livemode	Boolean
	metadata	Struct
	payment_intent	String	=
	reason	String	=
	status	String
	payment_method_details	Struct
File Links
	id	String
	object	String
	created	DateTime	=, >=, <=,<,>
	expired	Boolean	=
	expires_at	DateTime
	file	String	=
	livemode	Boolean
	metadata	Struct
	url	String
PaymentIntents
	id	String
	object	String
	amount	Integer
	amount_capturable	Integer
	amount_details	Struct
	amount_received	Integer
	application	String
	application_fee_amount	Integer
	automatic_payment_methods	Struct
	canceled_at	DateTime
	cancellation_reason	String
	capture_method	String
	client_secret	String
	confirmation_method	String
	created	DateTime	=, >=, <=,<,>
	currency	String
	customer	String	=
	description	String
	invoice	String
	last_payment_error	Struct
	latest_charge	String
	livemode	Boolean
	metadata	Struct
	next_action	Struct
	on_behalf_of	String
	payment_method	String
	payment_method_options	Struct
	payment_method_types	List
	payment_method_configuration_details	Struct
	processing	Struct
	receipt_email	String
	review	String
	setup_future_usage	String
	shipping	Struct
	source	String
	statement_descriptor	String
	statement_descriptor_suffix	String
	status	String
	transfer_data	Struct
	transfer_group	String
SetupIntents
	id	String
	object	String
	application	String
	cancellation_reason	String
	client_secret	String
	created	DateTime	=, >=, <=,<,>
	customer	String	=
	description	String
	flow_directions	List
	last_setup_error	Struct
	latest_attempt	String
	livemode	Boolean
	mandate	String
	metadata	Struct
	next_action	Struct
	on_behalf_of	String
	payment_method	String
	payment_method_options	Struct
	payment_method_types	List
	single_use_mandate	String
	status	String
	usage	String
	automatic_payment_methods	Struct
Payouts
	id	String
	object	String
	amount	Integer	=, <, >
	arrival_date	DateTime	=, >=, <=,<,>
	automatic	Boolean
	balance_transaction	String
	created	DateTime	=, >=, <=,<,>
	currency	String
	description	String	=
	destination	String
	failure_balance_transaction	String
	failure_code	String
	failure_message	String
	livemode	Boolean
	metadata	Struct
	method	String
	original_payout	String
	reversed_by	String
	reconciliation_status	String
	source_type	String
	statement_descriptor	String
	status	String
	type	String
	application_fee	String
	application_fee_amount	Integer
Refunds
	id	String
	object	String
	amount	Integer
	balance_transaction	String
	charge	String	=
	created	DateTime	=, >=, <=,<,>
	currency	String
	metadata	Struct
	destination_details	Struct
	payment_intent	String	=
	reason	String
	receipt_number	String
	source_transfer_reversal	String
	status	String
	transfer_reversal	String
Products
	id	String
	object	String
	active	Boolean	=
	attributes	List
	created	DateTime	=, >=, <=,<,>
	default_price	String
	description	String
	images	List
	livemode	Boolean
	metadata	Struct
	name	String
	package_dimensions	Struct
	shippable	Boolean
	statement_descriptor	String
	tax_code	String
	type	String	=
	unit_label	String
	updated	DateTime
	url	String
	features	List
Prices
	id	String
	object	String
	active	Boolean	=
	billing_scheme	String
	created	DateTime	=, >=, <=,<,>
	currency	String	=
	custom_unit_amount	Struct
	livemode	Boolean
	lookup_key	String
	metadata	Struct
	nickname	String
	product	String	=
	recurring	Struct
	tax_behavior	String
	tiers_mode	String
	transform_quantity	Struct
	type	String	=
	unit_amount	Integer
	unit_amount_decimal	String
Coupons
	Id	String
	object	String
	amount_off	Integer
	created	DateTime	=, >=, <=,<,>
	currency	String	=
	duration	String	=
	duration_in_months	Integer	=,<,>
	livemode	Boolean
	max_redemptions	Integer	=, <, >
	metadata	Struct
	name	String
	percent_off	Double	=
	redeem_by	DateTime	=, >=, <=, <, >
	times_redeemed	Integer
	valid	Boolean
Promotion Codes
	Id	String
	object	String
	active	Boolean	=
	code	String	=
	coupon	Struct
	created	DateTime	=,>=,<=,<,>
	customer	String
	expires_at	DateTime
	livemode	Boolean
	max_redemptions	Integer
	metadata	Struct
	restrictions	Struct
	times_redeemed	Integer
Tax Codes
	Id	String
	object	String
	description	String
	name	String
Tax Rates
	Id	String
	object	String
	active	Boolean	=
	country	String
	created	DateTime	=, >=, <=, <, >
	description	String
	display_name	String
	inclusive	Boolean	=
	jurisdiction	String
	jurisdiction_level	String
	livemode	Boolean
	metadata	Struct
	percentage	Double
	effective_percentage	Double
	state	String
	tax_type	String
Shipping Rates
	Id	String
	object	String
	active	Boolean	=
	created	DateTime	=, >=, <=, <, >
	delivery_estimate	Struct
	display_name	String
	fixed_amount	Struct
	livemode	Boolean
	metadata	Struct
	tax_behavior	String
	tax_code	String
	type	String
Sessions
	id	String
	object	String
	after_expiration	Struct
	allow_promotion_codes	Boolean
	amount_subtotal	Integer
	amount_total	Integer
	automatic_tax	Struct
	billing_address_collection	String
	cancel_url	String
	client_reference_id	String
	consent	Struct
	consent_collection	Struct
	created	DateTime	=, >=, <=, <, >
	currency	String
	custom_text	Struct
	customer	String
	customer_creation	String
	customer_details	Struct
	customer_email	String
	expires_at	DateTime
	invoice	String
	invoice_creation	Struct
	livemode	Boolean
	locale	String
	metadata	Struct
	mode	String
	payment_intent	String	=
	payment_link	String
	payment_method_collection	String
	payment_method_options	Struct
	payment_method_types	List
	payment_status	String
	phone_number_collection	Struct
	recovered_from	String
	setup_intent	String
	shipping_address_collection	Struct
	shipping_cost	Struct
	shipping_details	Struct
	shipping_options	List
	status	String
	submit_type	String
	subscription	String
	success_url	String
	tax_id_collection	Struct
	total_details	Struct
	url	String
	ui_mode	String
Credit Notes
	id	String
	object	String
	amount	Integer
	created	DateTime	=, >=, <=, <, >
	currency	String
	customer	String	=
	customer_balance_transaction	String
	discount_amount	Integer
	discount_amounts	List
	invoice	String	=
	lines	Struct
	livemode	Boolean
	memo	String
	metadata	Struct
	number	String
	out_of_band_amount	Integer
	pdf	String
	reason	String
	refund	String
	status	String
	subtotal	Integer
	subtotal_excluding_tax	Integer
	tax_amounts	List
	total	Integer
	total_excluding_tax	Integer
	type	String
	voided_at	DateTime
	amount_shipping	Integer
	effective_at	DateTime
	shipping_cost	Struct
Customer
	id	String
	object	String
	address	Struct
	balance	Integer
	created	DateTime
	currency	String	=, >=, <=, <, >
	default_source	String
	delinquent	Boolean	=
	description	String
	discount	Struct
	email	String	=
	invoice_prefix	String
	invoice_settings	Struct
	livemode	Boolean
	metadata	Struct
	name	String
	next_invoice_sequence	Integer
	phone	String
	preferred_locales	List
	shipping	Struct
	tax_exempt	String
	test_clock	String
Invoices
	id	String
	object	String
	account_country	String
	account_name	String
	account_tax_ids	List
	amount_due	Integer
	amount_paid	Integer
	amount_remaining	Integer
	application	String
	application_fee_amount	Integer
	attempt_count	Integer
	attempted	Boolean	=
	auto_advance	Boolean	=
	automatic_tax	Struct
	billing_reason	String
	charge	String
	collection_method	String	=
	created	DateTime	=, >=, <=, <, >
	currency	String
	custom_fields	List
	customer	String	=
	customer_address	Struct
	customer_email	String
	customer_name	String
	customer_phone	String
	customer_shipping	Struct
	customer_tax_exempt	String
	customer_tax_ids	List
	default_payment_method	String
	default_source	String
	default_tax_rates	List
	description	String
	discount	Struct
	discounts	List
	due_date	DateTime	=, >=, <=, <, >
	ending_balance	Integer
	footer	String
	from_invoice	Struct
	hosted_invoice_url	String
	invoice_pdf	String
	last_finalization_error	Struct
	latest_revision	String
	lines	Struct
	livemode	Boolean
	metadata	Struct
	next_payment_attempt	DateTime
	number	String
	on_behalf_of	String
	paid	Boolean	=
	paid_out_of_band	Boolean
	payment_intent	String
	payment_settings	Struct
	period_end	DateTime	=, >=, <=, <, >
	period_start	DateTime	=, >=, <=, <, >
	post_payment_credit_notes_amount	Integer
	pre_payment_credit_notes_amount	Integer
	quote	String
	receipt_number	String
	rendering	Struct
	rendering_options	Struct
	starting_balance	Integer
	statement_descriptor	String
	status	String	=
	status_transitions	Struct
	subscription	String
	subscription_details	Struct
	subtotal	Integer	=, <, >
	subtotal_excluding_tax	Integer
	tax	Integer
	test_clock	String
	total	Integer	=, <, >
	total_discount_amounts	List
	total_excluding_tax	Integer
	total_tax_amounts	List
	transfer_data	Struct
	webhooks_delivered_at	DateTime
	automatically_finalizes_at	DateTime
	effective_at	DateTime
	issuer	Struct
Invoice Items
	id	String
	object	String
	amount	Integer	=, <, >
	currency	String
	customer	String	=
	date	DateTime
	description	String
	discountable	Boolean
	discounts	List
	invoice	String	=
	livemode	Boolean
	metadata	Struct
	period	Struct
	plan	Struct
	price	Struct
	proration	Boolean	=
	quantity	Integer
	subscription	String
	subscription_item	String
	tax_rates	List
	test_clock	String
	unit_amount	Integer
	unit_amount_decimal	String
Plans
	id	String
	object	String
	active	Boolean	=
	aggregate_usage	String
	amount	Integer
	amount_decimal	String
	billing_scheme	String
	created	DateTime	=, >=, <=, <, >
	currency	String	=
	interval	String	=
	interval_count	Integer
	livemode	Boolean
	metadata	Struct
	nickname	String
	product	String	=
	tiers_mode	String
	transform_usage	Struct
	trial_period_days	Integer	=, <, >
	usage_type	String
	meter	String
Quotes
	id	String
	object	String
	amount_subtotal	Integer
	amount_total	Integer
	application	String
	application_fee_amount	Integer
	application_fee_percent	Double
	automatic_tax	Struct
	collection_method	String
	computed	Struct
	created	DateTime
	currency	String
	customer	String	=
	default_tax_rates	List
	description	String
	discounts	List
	expires_at	DateTime
	footer	String
	from_quote	Struct
	header	String
	invoice	String
	invoice_settings	Struct
	livemode	Boolean
	metadata	Struct
	number	String
	on_behalf_of	String
	status	String	=
	status_transitions	Struct
	subscription	String
	subscription_data	Struct
	subscription_schedule	String
	test_clock	String
	total_details	Struct
	transfer_data	Struct
Subscriptions
	id	String
	object	String
	application	String
	application_fee_percent	Double
	automatic_tax	Struct
	billing_cycle_anchor	DateTime
	billing_thresholds	Struct
	cancel_at	DateTime
	cancel_at_period_end	Boolean
	canceled_at	DateTime
	collection_method	String	=
	created	DateTime	=, >=, <=,<,>
	currency	String
	current_period_end	DateTime	=, >=, <=
	current_period_start	DateTime	=, >=, <=
	customer	String	=
	days_until_due	Integer
	default_payment_method	String
	default_source	String
	default_tax_rates	List
	description	String
	discount	Struct
	ended_at	DateTime
	items	Struct
	latest_invoice	String
	livemode	Boolean
	metadata	Struct
	next_pending_invoice_item_invoice	DateTime
	pause_collection	Struct
	payment_settings	Struct
	pending_invoice_item_interval	Struct
	pending_setup_intent	String
	pending_update	Struct
	plan	Struct
	quantity	Integer
	schedule	String
	start_date	DateTime
	status	String	=
	test_clock	String
	transfer_data	Struct
	trial_end	DateTime
	trial_start	DateTime
Subscription Items
	Id	String
	object	String
	billing_thresholds	Struct
	created	DateTime	=, >=, <=, <, >
	metadata	Struct
	plan	Struct
	price	Struct
	subscription	String
	tax_rates	List
	discounts	List
Subscription Schedules
	object	String
	application	String
	canceled_at	DateTime
	completed_at	DateTime
	created	DateTime
	current_phase	Struct
	customer	String	=
	default_settings	Struct
	end_behavior	String
	livemode	Boolean
	metadata	Struct
	phases	List
	released_at	DateTime
	released_subscription	String
	renewal_interval	String
	status	String
	subscription	String
	test_clock	String
Accounts
	details_submitted	Boolean
	tos_acceptance	Struct
	type	String
	metadata	Struct
	id	String
	object	String
	default_currency	String
	capabilities	Struct
	charges_enabled	Boolean
	settings	Struct
	requirements	Struct
	payouts_enabled	Boolean
	future_requirements	Struct
	external_accounts	Struct
	controller	Struct
	country	String
	email	String
	created	DateTime	=, >=, <=, <, >
	business_profile	Struct
	business_type	String
	company	Struct
Application Fees
	id	String
	object	String
	account	String
	amount	Integer	=, <, >
	amount_refunded	Integer	=, <, >
	application	String
	balance_transaction	String
	charge	String	=
	created	DateTime
	currency	String
	livemode	Boolean
	originating_transaction	String
	refunded	Boolean	=
	refunds	Struct
	fee_source	Struct
Country Specs
	id	String
	object	String
	default_currency	String
	supported_bank_account_currencies	Struct
	supported_payment_currencies	List
	supported_payment_methods	List
	supported_transfer_countries	List
	verification_fields	Struct
Transfers
	id	String
	object	String
	amount	Integer	=, <, >
	amount_reversed	Integer
	balance_transaction	String
	created	DateTime	=, >=, <=, <, >
	currency	String	=
	description	String
	destination	String	=
	destination_payment	String
	livemode	Boolean
	metadata	Struct
	reversals	Struct
	reversed	Boolean
	source_transaction	String
	source_type	String
	transfer_group	String	=
Early Fraud Warnings
	id	String
	object	String
	actionable	Boolean
	charge	String	=
	created	DateTime	=, >=, <=, <, >
	fraud_type	String
	livemode	Boolean
	payment_intent	String	=
Report Types
	id	String
	object	String
	data_available_end	DateTime
	data_available_start	DateTime
	default_columns	List
	livemode	Boolean
	name	String
	updated	DateTime
	version	Integer

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 Transactions	created	DateTime
Charges	created	DateTime
Disputes	created	DateTime
File Links	created	DateTime
PaymentIntents	created	DateTime
SetupIntents	created	DateTime
Payouts	created	DateTime
Refunds	created	DateTime
Products	created	DateTime
Prices	created	DateTime
Coupons	created	DateTime
Promotion Codes	created	DateTime
Tax Rates	created	DateTime
Shipping Rates	created	DateTime
Sessions	created	DateTime
Credit Notes	created	DateTime
Customer	created	DateTime
Invoices	created	DateTime
Plans	created	DateTime
Subscriptions	created	DateTime
Subscription Schedules	created	DateTime
Accounts	created	DateTime
Application Fees	created	DateTime
Transfers	created	DateTime
Early Fraud Warnings	created	DateTime

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"
    }
)

Javascript is disabled or is unavailable in your browser.

To use the Amazon Web Services Documentation, Javascript must be enabled. Please refer to your browser's Help pages for instructions.

Configuring Stripe connections

Stripe connection options