Stripe: Terminal schemas

← Terminal operations · All schemas

Create a Configuration — request body — body / wifi / type: enterprise eap peap, enterprise eap tls, personal psk

Field	Type	Presence	Description and constraints
$	object	Root
enterprise_eap_peap	object	Optional
enterprise_eap_peap.ca_certificate_file	string	Optional
enterprise_eap_peap.password	string	Required within parent	Maximum length: 5000
enterprise_eap_peap.ssid	string	Required within parent	Maximum length: 5000
enterprise_eap_peap.username	string	Required within parent	Maximum length: 5000
enterprise_eap_tls	object	Optional
enterprise_eap_tls.ca_certificate_file	string	Optional
enterprise_eap_tls.client_certificate_file	string	Required within parent
enterprise_eap_tls.private_key_file	string	Required within parent
enterprise_eap_tls.private_key_file_password	string	Optional	Maximum length: 5000
enterprise_eap_tls.ssid	string	Required within parent	Maximum length: 5000
personal_psk	object	Optional
personal_psk.password	string	Required within parent	Maximum length: 63
personal_psk.ssid	string	Required within parent	Maximum length: 5000
type	string	Required within parent	One of: enterprise_eap_peap, enterprise_eap_tls, personal_psk

Create a Configuration — request body — body tipping aed, aud, cad, chf, czk, dkk, eur, gbp, gip, hkd, huf, jpy, mxn, myr, nok, nzd, pln, ron, sek, sgd, usd

Field	Type	Presence	Description and constraints
$	object	Root
aed	object	Optional
aed.fixed_amounts	array	Optional
aed.fixed_amounts[]	integer	Each item
aed.percentages	array	Optional
aed.percentages[]	integer	Each item
aed.smart_tip_threshold	integer	Optional
aud	object	Optional
aud.fixed_amounts	array	Optional
aud.fixed_amounts[]	integer	Each item
aud.percentages	array	Optional
aud.percentages[]	integer	Each item
aud.smart_tip_threshold	integer	Optional
cad	object	Optional
cad.fixed_amounts	array	Optional
cad.fixed_amounts[]	integer	Each item
cad.percentages	array	Optional
cad.percentages[]	integer	Each item
cad.smart_tip_threshold	integer	Optional
chf	object	Optional
chf.fixed_amounts	array	Optional
chf.fixed_amounts[]	integer	Each item
chf.percentages	array	Optional
chf.percentages[]	integer	Each item
chf.smart_tip_threshold	integer	Optional
czk	object	Optional
czk.fixed_amounts	array	Optional
czk.fixed_amounts[]	integer	Each item
czk.percentages	array	Optional
czk.percentages[]	integer	Each item
czk.smart_tip_threshold	integer	Optional
dkk	object	Optional
dkk.fixed_amounts	array	Optional
dkk.fixed_amounts[]	integer	Each item
dkk.percentages	array	Optional
dkk.percentages[]	integer	Each item
dkk.smart_tip_threshold	integer	Optional
eur	object	Optional
eur.fixed_amounts	array	Optional
eur.fixed_amounts[]	integer	Each item
eur.percentages	array	Optional
eur.percentages[]	integer	Each item
eur.smart_tip_threshold	integer	Optional
gbp	object	Optional
gbp.fixed_amounts	array	Optional
gbp.fixed_amounts[]	integer	Each item
gbp.percentages	array	Optional
gbp.percentages[]	integer	Each item
gbp.smart_tip_threshold	integer	Optional
gip	object	Optional
gip.fixed_amounts	array	Optional
gip.fixed_amounts[]	integer	Each item
gip.percentages	array	Optional
gip.percentages[]	integer	Each item
gip.smart_tip_threshold	integer	Optional
hkd	object	Optional
hkd.fixed_amounts	array	Optional
hkd.fixed_amounts[]	integer	Each item
hkd.percentages	array	Optional
hkd.percentages[]	integer	Each item
hkd.smart_tip_threshold	integer	Optional
huf	object	Optional
huf.fixed_amounts	array	Optional
huf.fixed_amounts[]	integer	Each item
huf.percentages	array	Optional
huf.percentages[]	integer	Each item
huf.smart_tip_threshold	integer	Optional
jpy	object	Optional
jpy.fixed_amounts	array	Optional
jpy.fixed_amounts[]	integer	Each item
jpy.percentages	array	Optional
jpy.percentages[]	integer	Each item
jpy.smart_tip_threshold	integer	Optional
mxn	object	Optional
mxn.fixed_amounts	array	Optional
mxn.fixed_amounts[]	integer	Each item
mxn.percentages	array	Optional
mxn.percentages[]	integer	Each item
mxn.smart_tip_threshold	integer	Optional
myr	object	Optional
myr.fixed_amounts	array	Optional
myr.fixed_amounts[]	integer	Each item
myr.percentages	array	Optional
myr.percentages[]	integer	Each item
myr.smart_tip_threshold	integer	Optional
nok	object	Optional
nok.fixed_amounts	array	Optional
nok.fixed_amounts[]	integer	Each item
nok.percentages	array	Optional
nok.percentages[]	integer	Each item
nok.smart_tip_threshold	integer	Optional
nzd	object	Optional
nzd.fixed_amounts	array	Optional
nzd.fixed_amounts[]	integer	Each item
nzd.percentages	array	Optional
nzd.percentages[]	integer	Each item
nzd.smart_tip_threshold	integer	Optional
pln	object	Optional
pln.fixed_amounts	array	Optional
pln.fixed_amounts[]	integer	Each item
pln.percentages	array	Optional
pln.percentages[]	integer	Each item
pln.smart_tip_threshold	integer	Optional
ron	object	Optional
ron.fixed_amounts	array	Optional
ron.fixed_amounts[]	integer	Each item
ron.percentages	array	Optional
ron.percentages[]	integer	Each item
ron.smart_tip_threshold	integer	Optional
sek	object	Optional
sek.fixed_amounts	array	Optional
sek.fixed_amounts[]	integer	Each item
sek.percentages	array	Optional
sek.percentages[]	integer	Each item
sek.smart_tip_threshold	integer	Optional
sgd	object	Optional
sgd.fixed_amounts	array	Optional
sgd.fixed_amounts[]	integer	Each item
sgd.percentages	array	Optional
sgd.percentages[]	integer	Each item
sgd.smart_tip_threshold	integer	Optional
usd	object	Optional
usd.fixed_amounts	array	Optional
usd.fixed_amounts[]	integer	Each item
usd.percentages	array	Optional
usd.percentages[]	integer	Each item
usd.smart_tip_threshold	integer	Optional

Create a Configuration — response body

Field	Type	Presence	Description and constraints
$	object	Root	A Configurations object represents how features should be configured for terminal readers. For information about how to use it, see the [Terminal configurations documentation](https://docs.stripe.com/terminal/fleet/configurations-overview).
bbpos_wisepad3	Model	Optional	Expand Create a Configuration — response body — stripe s700
bbpos_wisepos_e	Model	Optional	Expand Create a Configuration — response body — stripe s700
cellular	Model	Optional	Expand Create a Configuration — response body — cellular
id	string	Required within parent	Unique identifier for the object. Maximum length: 5000
is_account_default	JSON	Optional
is_account_default (anyOf 1)	boolean	Alternative	Whether this Configuration is the default for your account
is_account_default (anyOf 2)	null	Alternative
livemode	boolean	Required within parent	If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
name	JSON	Optional
name (anyOf 1)	string	Alternative	String indicating the name of the Configuration object, set by the user Maximum length: 5000
name (anyOf 2)	null	Alternative
object	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: terminal.configuration
offline	Model	Optional	Expand Create a Configuration — response body — offline
reboot_window	Model	Optional	Expand Create a Configuration — response body — reboot window
stripe_s700	Model	Optional	Expand Create a Configuration — response body — stripe s700
stripe_s710	Model	Optional	Expand Create a Configuration — response body — stripe s700
tipping	Model	Optional	Expand Create a Configuration — response body — tipping
verifone_m425	Model	Optional	Expand Create a Configuration — response body — stripe s700
verifone_p400	Model	Optional	Expand Create a Configuration — response body — stripe s700
verifone_p630	Model	Optional	Expand Create a Configuration — response body — stripe s700
verifone_ux700	Model	Optional	Expand Create a Configuration — response body — stripe s700
verifone_v660p	Model	Optional	Expand Create a Configuration — response body — stripe s700
wifi	Model	Optional	Expand Create a Configuration — response body — wifi

Referenced models: Create a Configuration — response body — cellular, Create a Configuration — response body — stripe s700, Create a Configuration — response body — offline, Create a Configuration — response body — reboot window, Create a Configuration — response body — tipping, Create a Configuration — response body — wifi

Create a Configuration — response body — cellular

Field	Type	Presence	Description and constraints
$	object	Root
enabled	boolean	Required within parent	Whether a cellular-capable reader can connect to the internet over cellular.

Create a Configuration — response body — offline

Field	Type	Presence	Description and constraints
$	object	Root
enabled	JSON	Optional
enabled (anyOf 1)	boolean	Alternative	Determines whether to allow transactions to be collected while reader is offline. Defaults to false.
enabled (anyOf 2)	null	Alternative

Create a Configuration — response body — reboot window

Field	Type	Presence	Description and constraints
$	object	Root
end_hour	JSON	Required within parent
end_hour (anyOf 1)	integer	Alternative	Integer between 0 to 23 that represents the end hour of the reboot time window. The value must be different than the start_hour.
end_hour (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
start_hour	JSON	Required within parent
start_hour (anyOf 1)	integer	Alternative	Integer between 0 to 23 that represents the start hour of the reboot time window.
start_hour (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Create a Configuration — response body — stripe s700

Field	Type	Presence	Description and constraints
$	object	Root
splashscreen	JSON	Optional	A File ID representing an image to display on the reader
splashscreen (anyOf 1)	string	Alternative	Maximum length: 5000
splashscreen (anyOf 2)	Model	Alternative	Expand Create a file — response body

Referenced models: Create a file — response body

Create a Configuration — response body — tipping

Field	Type	Presence	Description and constraints
$	object	Root
aed	Model	Optional	Expand Create a Configuration — response body — tipping aed
aud	Model	Optional	Expand Create a Configuration — response body — tipping aed
cad	Model	Optional	Expand Create a Configuration — response body — tipping aed
chf	Model	Optional	Expand Create a Configuration — response body — tipping aed
czk	Model	Optional	Expand Create a Configuration — response body — tipping aed
dkk	Model	Optional	Expand Create a Configuration — response body — tipping aed
eur	Model	Optional	Expand Create a Configuration — response body — tipping aed
gbp	Model	Optional	Expand Create a Configuration — response body — tipping aed
gip	Model	Optional	Expand Create a Configuration — response body — tipping aed
hkd	Model	Optional	Expand Create a Configuration — response body — tipping aed
huf	Model	Optional	Expand Create a Configuration — response body — tipping aed
jpy	Model	Optional	Expand Create a Configuration — response body — tipping aed
mxn	Model	Optional	Expand Create a Configuration — response body — tipping aed
myr	Model	Optional	Expand Create a Configuration — response body — tipping aed
nok	Model	Optional	Expand Create a Configuration — response body — tipping aed
nzd	Model	Optional	Expand Create a Configuration — response body — tipping aed
pln	Model	Optional	Expand Create a Configuration — response body — tipping aed
ron	Model	Optional	Expand Create a Configuration — response body — tipping aed
sek	Model	Optional	Expand Create a Configuration — response body — tipping aed
sgd	Model	Optional	Expand Create a Configuration — response body — tipping aed
usd	Model	Optional	Expand Create a Configuration — response body — tipping aed

Referenced models: Create a Configuration — response body — tipping aed

Create a Configuration — response body — tipping aed

Field	Type	Presence	Description and constraints
$	object	Root
fixed_amounts	JSON	Optional
fixed_amounts (anyOf 1)	array	Alternative	Fixed amounts displayed when collecting a tip
fixed_amounts (anyOf 1)[]	JSON	Each item
fixed_amounts (anyOf 1)[] (anyOf 1)	integer	Alternative
fixed_amounts (anyOf 1)[] (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
fixed_amounts (anyOf 2)	null	Alternative
percentages	JSON	Optional
percentages (anyOf 1)	array	Alternative	Percentages displayed when collecting a tip
percentages (anyOf 1)[]	JSON	Each item
percentages (anyOf 1)[] (anyOf 1)	integer	Alternative
percentages (anyOf 1)[] (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
percentages (anyOf 2)	null	Alternative
smart_tip_threshold	JSON	Optional
smart_tip_threshold (anyOf 1)	integer	Alternative	Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
smart_tip_threshold (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Create a Configuration — response body — wifi

Field	Type	Presence	Description and constraints
$	object	Root
enterprise_eap_peap	Model	Optional	Expand Create a Configuration — response body — wifi enterprise eap peap
enterprise_eap_tls	Model	Optional	Expand Create a Configuration — response body — wifi enterprise eap tls
personal_psk	Model	Optional	Expand Create a Configuration — response body — wifi personal psk
type	string	Required within parent	Security type of the WiFi network. The hash with the corresponding name contains the credentials for this security type. Known values: enterprise_eap_peap, enterprise_eap_tls, personal_psk

Referenced models: Create a Configuration — response body — wifi enterprise eap peap, Create a Configuration — response body — wifi enterprise eap tls, Create a Configuration — response body — wifi personal psk

Create a Configuration — response body — wifi enterprise eap peap

Field	Type	Presence	Description and constraints
$	object	Root
ca_certificate_file	string	Optional	A File ID representing a PEM file containing the server certificate Maximum length: 5000
password	string	Required within parent	Password for connecting to the WiFi network Maximum length: 5000
ssid	string	Required within parent	Name of the WiFi network Maximum length: 5000
username	string	Required within parent	Username for connecting to the WiFi network Maximum length: 5000

Create a Configuration — response body — wifi enterprise eap tls

Field	Type	Presence	Description and constraints
$	object	Root
ca_certificate_file	string	Optional	A File ID representing a PEM file containing the server certificate Maximum length: 5000
client_certificate_file	string	Required within parent	A File ID representing a PEM file containing the client certificate Maximum length: 5000
private_key_file	string	Required within parent	A File ID representing a PEM file containing the client RSA private key Maximum length: 5000
private_key_file_password	string	Optional	Password for the private key file Maximum length: 5000
ssid	string	Required within parent	Name of the WiFi network Maximum length: 5000

Create a Configuration — response body — wifi personal psk

Field	Type	Presence	Description and constraints
$	object	Root
password	string	Required within parent	Password for connecting to the WiFi network Maximum length: 5000
ssid	string	Required within parent	Name of the WiFi network Maximum length: 5000

Create a Connection Token — response body

Field	Type	Presence	Description and constraints
$	object	Root	A Connection Token is used by the Stripe Terminal SDK to connect to a reader. Related guide: [Fleet management](https://docs.stripe.com/terminal/fleet/locations)
location	string	Optional	The id of the location that this connection token is scoped to. Note that location scoping only applies to internet-connected readers. For more details, see [the docs on scoping connection tokens](https://docs.stripe.com/terminal/fleet/locations-and-zones?dashboard-or-api=api#connection-tokens). Maximum length: 5000
object	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: terminal.connection_token
secret	string	Required within parent	Your application should pass this token to the Stripe Terminal SDK. Maximum length: 5000

Create a Location — response body

Field	Type	Presence	Description and constraints
$	object	Root	A Location represents a grouping of readers. Related guide: [Fleet management](https://docs.stripe.com/terminal/fleet/locations)
address	Model	Required within parent	Expand Create a Location — response body — address
address_kana	Model	Optional	Expand Create a Location — response body — address kana
address_kanji	Model	Optional	Expand Create a Location — response body — address kana
configuration_overrides	string	Optional	The ID of a configuration that will be used to customize all readers in this location. Maximum length: 5000
display_name	string	Required within parent	The display name of the location. Maximum length: 5000
display_name_kana	string	Optional	The Kana variation of the display name of the location. Maximum length: 5000
display_name_kanji	string	Optional	The Kanji variation of the display name of the location. Maximum length: 5000
id	string	Required within parent	Unique identifier for the object. Maximum length: 5000
livemode	boolean	Required within parent	If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
metadata	object	Required within parent	Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Additional keys: see wildcard field
metadata.*	string	Additional keys	Maximum length: 500
object	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: terminal.location
phone	string	Optional	The phone number of the location. Maximum length: 5000

Referenced models: Create a Location — response body — address, Create a Location — response body — address kana

Create a Location — response body — address

Field	Type	Presence	Description and constraints
$	object	Root
city	JSON	Optional
city (anyOf 1)	string	Alternative	City, district, suburb, town, or village. Maximum length: 5000
city (anyOf 2)	null	Alternative
country	JSON	Optional
country (anyOf 1)	string	Alternative	Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). Maximum length: 5000
country (anyOf 2)	null	Alternative
line1	JSON	Optional
line1 (anyOf 1)	string	Alternative	Address line 1, such as the street, PO Box, or company name. Maximum length: 5000
line1 (anyOf 2)	null	Alternative
line2	JSON	Optional
line2 (anyOf 1)	string	Alternative	Address line 2, such as the apartment, suite, unit, or building. Maximum length: 5000
line2 (anyOf 2)	null	Alternative
postal_code	JSON	Optional
postal_code (anyOf 1)	string	Alternative	ZIP or postal code. Maximum length: 5000
postal_code (anyOf 2)	null	Alternative
state	JSON	Optional
state (anyOf 1)	string	Alternative	State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). Maximum length: 5000
state (anyOf 2)	null	Alternative

Create a Location — response body — address kana

Field	Type	Presence	Description and constraints
$	object	Root
city	JSON	Optional
city (anyOf 1)	string	Alternative	City/Ward. Maximum length: 5000
city (anyOf 2)	null	Alternative
country	JSON	Optional
country (anyOf 1)	string	Alternative	Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). Maximum length: 5000
country (anyOf 2)	null	Alternative
line1	JSON	Optional
line1 (anyOf 1)	string	Alternative	Block/Building number. Maximum length: 5000
line1 (anyOf 2)	null	Alternative
line2	JSON	Optional
line2 (anyOf 1)	string	Alternative	Building details. Maximum length: 5000
line2 (anyOf 2)	null	Alternative
postal_code	JSON	Optional
postal_code (anyOf 1)	string	Alternative	ZIP or postal code. Maximum length: 5000
postal_code (anyOf 2)	null	Alternative
state	JSON	Optional
state (anyOf 1)	string	Alternative	Prefecture. Maximum length: 5000
state (anyOf 2)	null	Alternative
town	JSON	Optional
town (anyOf 1)	string	Alternative	Town/cho-me. Maximum length: 5000
town (anyOf 2)	null	Alternative

Create a Reader — response body

Field	Type	Presence	Description and constraints
$	object	Root	A Reader represents a physical device for accepting payment details. Related guide: [Connecting to a reader](https://docs.stripe.com/terminal/payments/connect-reader)
action	JSON	Optional
action (anyOf 1)	JSON	Alternative	The most recent action performed by the reader.
action (anyOf 1) (anyOf 1)	Model	Alternative	Expand Create a Reader — response body — action / The most recent action performed by the reader / status: failed, in progress, succeeded
action (anyOf 2)	null	Alternative
device_sw_version	JSON	Optional
device_sw_version (anyOf 1)	string	Alternative	The current software version of the reader. Maximum length: 5000
device_sw_version (anyOf 2)	null	Alternative
device_type	string	Required within parent	Device type of the reader. Known values: bbpos_chipper2x, bbpos_wisepad3, bbpos_wisepos_e, mobile_phone_reader, simulated_stripe_s700, simulated_stripe_s710, simulated_verifone_m425, simulated_verifone_p630, simulated_verifone_ux700, simulated_verifone_v660p, simulated_wisepos_e, stripe_m2, stripe_s700, stripe_s710, verifone_P400, verifone_m425, verifone_p630, verifone_ux700, verifone_v660p
id	string	Required within parent	Unique identifier for the object. Maximum length: 5000
ip_address	JSON	Optional
ip_address (anyOf 1)	string	Alternative	The local IP address of the reader. Maximum length: 5000
ip_address (anyOf 2)	null	Alternative
label	string	Required within parent	Custom label given to the reader for easier identification. Maximum length: 5000
last_seen_at	JSON	Optional
last_seen_at (anyOf 1)	JSON	Alternative
last_seen_at (anyOf 1) (anyOf 1)	integer	Alternative	The last time this reader reported to Stripe backend. Timestamp is measured in milliseconds since the Unix epoch. Unlike most other Stripe timestamp fields which use seconds, this field uses milliseconds. Format: unix-time
last_seen_at (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
last_seen_at (anyOf 2)	null	Alternative
livemode	boolean	Required within parent	If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
location	JSON	Optional
location (anyOf 1)	JSON	Alternative	The location identifier of the reader.
location (anyOf 1) (anyOf 1)	string	Alternative	Maximum length: 5000
location (anyOf 1) (anyOf 2)	Model	Alternative	Expand Create a Location — response body
location (anyOf 2)	null	Alternative
metadata	object	Required within parent	Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Additional keys: see wildcard field
metadata.*	string	Additional keys	Maximum length: 500
object	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: terminal.reader
serial_number	string	Required within parent	Serial number of the reader. Maximum length: 5000
status	JSON	Optional
status (anyOf 1)	string	Alternative	The networking status of the reader. This value is `null` for mobile readers. We do not recommend using this field in flows that may block taking payments. Known values: offline, online
status (anyOf 2)	null	Alternative

Referenced models: Create a Location — response body, Create a Reader — response body — action / The most recent action performed by the reader / status: failed, in progress, succeeded

Create a Reader — response body — action / The most recent action performed by the reader / status: failed, in progress, succeeded

Field	Type	Presence	Description and constraints
$	object	Root	Represents an action performed by the reader
api_error	JSON	Optional
api_error (anyOf 1)	JSON	Alternative	The reader action failed due to an [API error](https://docs.stripe.com/api/errors). Only present when `status` is `failed` and the underlying failure was an API error. Avoid parsing the `message` field for programmatic logic; use `type` or `code` instead. The `message` field is for display to humans only and may be updated at anytime. Requires [reader version](https://docs.stripe.com/terminal/readers/stripe-reader-s700-s710#reader-software-version) 2.42 or later. Readers on older versions always return null.
api_error (anyOf 1) (anyOf 1)	Model	Alternative	Expand Cancel a SetupIntent — response body — last_setup_error / value / type: api error, card error, idempotency error, invalid request error
api_error (anyOf 2)	null	Alternative
collect_inputs	Model	Optional	Expand Create a Reader — response body — action / The most recent action performed by the reader / status: failed, in progress, succeeded collect inputs
collect_payment_method	Model	Optional	Expand Create a Reader — response body — action / The most recent action performed by the reader / status: failed, in progress, succeeded collect payment method
confirm_payment_intent	Model	Optional	Expand Create a Reader — response body — action / The most recent action performed by the reader / status: failed, in progress, succeeded confirm payment intent
failure_code	JSON	Optional
failure_code (anyOf 1)	string	Alternative	Failure code, only set if status is `failed`. Maximum length: 5000
failure_code (anyOf 2)	null	Alternative
failure_message	JSON	Optional
failure_message (anyOf 1)	string	Alternative	Detailed failure message, only set if status is `failed`. Maximum length: 5000
failure_message (anyOf 2)	null	Alternative
print_content	Model	Optional	Expand Create a Reader — response body — action / The most recent action performed by the reader / status: failed, in progress, succeeded print content
process_payment_intent	Model	Optional	Expand Create a Reader — response body — action / The most recent action performed by the reader / status: failed, in progress, succeeded process payment intent
process_setup_intent	Model	Optional	Expand Create a Reader — response body — action / The most recent action performed by the reader / status: failed, in progress, succeeded process setup intent
refund_payment	Model	Optional	Expand Create a Reader — response body — action / The most recent action performed by the reader / status: failed, in progress, succeeded refund payment
set_reader_display	Model	Optional	Expand Create a Reader — response body — action / The most recent action performed by the reader / status: failed, in progress, succeeded set reader display
status	string	Required within parent	Status of the action performed by the reader. Known values: failed, in_progress, succeeded
type	string	Required within parent	Type of action performed by the reader. Known values: collect_inputs, collect_payment_method, confirm_payment_intent, print_content, process_payment_intent, process_setup_intent, refund_payment, set_reader_display

Referenced models: Cancel a SetupIntent — response body — last_setup_error / value / type: api error, card error, idempotency error, invalid request error, Create a Reader — response body — action / The most recent action performed by the reader / status: failed, in progress, succeeded collect inputs, Create a Reader — response body — action / The most recent action performed by the reader / status: failed, in progress, succeeded collect payment method, Create a Reader — response body — action / The most recent action performed by the reader / status: failed, in progress, succeeded confirm payment intent, Create a Reader — response body — action / The most recent action performed by the reader / status: failed, in progress, succeeded print content, Create a Reader — response body — action / The most recent action performed by the reader / status: failed, in progress, succeeded process payment intent, Create a Reader — response body — action / The most recent action performed by the reader / status: failed, in progress, succeeded process setup intent, Create a Reader — response body — action / The most recent action performed by the reader / status: failed, in progress, succeeded refund payment, Create a Reader — response body — action / The most recent action performed by the reader / status: failed, in progress, succeeded set reader display

Create a Reader — response body — action / The most recent action performed by the reader / status: failed, in progress, succeeded collect inputs

Field	Type	Presence	Description and constraints
$	object	Root	Represents a reader action to collect customer inputs
inputs	array	Required within parent	List of inputs to be collected.
inputs[]	Model	Each item	Expand Create a Reader — response body — action / The most recent action performed by the reader / status: failed, in progress, succeeded collect inputs inputs item
metadata	JSON	Optional
metadata (anyOf 1)	object	Alternative	Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Additional keys: see wildcard field
metadata (anyOf 1).*	string	Additional keys	Maximum length: 500
metadata (anyOf 2)	null	Alternative

Referenced models: Create a Reader — response body — action / The most recent action performed by the reader / status: failed, in progress, succeeded collect inputs inputs item

Create a Reader — response body — action / The most recent action performed by the reader / status: failed, in progress, succeeded collect inputs inputs item

Field	Type	Presence	Description and constraints
$	object	Root	Represents an input to be collected using the reader
custom_text	JSON	Optional
custom_text (anyOf 1)	JSON	Alternative	Default text of input being collected.
custom_text (anyOf 1) (anyOf 1)	Model	Alternative	Expand Create a Reader — response body — action / The most recent action performed by the reader / status: failed, in progress, succeeded collect inputs inputs item custom text Default text of input being collected description, skip button, submit button, title
custom_text (anyOf 2)	null	Alternative
email	Model	Optional	Expand Create a Reader — response body — action / The most recent action performed by the reader / status: failed, in progress, succeeded collect inputs inputs item email
numeric	Model	Optional	Expand Create a Reader — response body — action / The most recent action performed by the reader / status: failed, in progress, succeeded collect inputs inputs item numeric
phone	Model	Optional	Expand Create a Reader — response body — action / The most recent action performed by the reader / status: failed, in progress, succeeded collect inputs inputs item phone
required	JSON	Optional
required (anyOf 1)	boolean	Alternative	Indicate that this input is required, disabling the skip button.
required (anyOf 2)	null	Alternative
selection	Model	Optional	Expand Create a Reader — response body — action / The most recent action performed by the reader / status: failed, in progress, succeeded collect inputs inputs item selection
signature	Model	Optional	Expand Create a Reader — response body — action / The most recent action performed by the reader / status: failed, in progress, succeeded collect inputs inputs item signature
skipped	boolean	Optional	Indicate that this input was skipped by the user.
text	Model	Optional	Expand Create a Reader — response body — action / The most recent action performed by the reader / status: failed, in progress, succeeded collect inputs inputs item text
toggles	JSON	Optional
toggles (anyOf 1)	array	Alternative	List of toggles being collected. Values are present if collection is complete.
toggles (anyOf 1)[]	Model	Each item	Expand Create a Reader — response body — action / The most recent action performed by the reader / status: failed, in progress, succeeded collect inputs inputs item toggles array item
toggles (anyOf 2)	null	Alternative
type	string	Required within parent	Type of input being collected. Known values: email, numeric, phone, selection, signature, text

Referenced models: Create a Reader — response body — action / The most recent action performed by the reader / status: failed, in progress, succeeded collect inputs inputs item custom text Default text of input being collected description, skip button, submit button, title, Create a Reader — response body — action / The most recent action performed by the reader / status: failed, in progress, succeeded collect inputs inputs item email, Create a Reader — response body — action / The most recent action performed by the reader / status: failed, in progress, succeeded collect inputs inputs item numeric, Create a Reader — response body — action / The most recent action performed by the reader / status: failed, in progress, succeeded collect inputs inputs item phone, Create a Reader — response body — action / The most recent action performed by the reader / status: failed, in progress, succeeded collect inputs inputs item selection, Create a Reader — response body — action / The most recent action performed by the reader / status: failed, in progress, succeeded collect inputs inputs item signature, Create a Reader — response body — action / The most recent action performed by the reader / status: failed, in progress, succeeded collect inputs inputs item text, Create a Reader — response body — action / The most recent action performed by the reader / status: failed, in progress, succeeded collect inputs inputs item toggles array item

Create a Reader — response body — action / The most recent action performed by the reader / status: failed, in progress, succeeded collect inputs inputs item custom text Default text of input being collected description, skip button, submit button, title

Field	Type	Presence	Description and constraints
$	object	Root	Represents custom text to be displayed when collecting the input using a reader
description	JSON	Optional
description (anyOf 1)	string	Alternative	Customize the default description for this input Maximum length: 5000
description (anyOf 2)	null	Alternative
skip_button	JSON	Optional
skip_button (anyOf 1)	string	Alternative	Customize the default label for this input's skip button Maximum length: 5000
skip_button (anyOf 2)	null	Alternative
submit_button	JSON	Optional
submit_button (anyOf 1)	string	Alternative	Customize the default label for this input's submit button Maximum length: 5000
submit_button (anyOf 2)	null	Alternative
title	JSON	Optional
title (anyOf 1)	string	Alternative	Customize the default title for this input Maximum length: 5000
title (anyOf 2)	null	Alternative

Create a Reader — response body — action / The most recent action performed by the reader / status: failed, in progress, succeeded collect inputs inputs item email

Field	Type	Presence	Description and constraints
$	object	Root	Information about a email being collected using a reader
value	JSON	Optional
value (anyOf 1)	string	Alternative	The collected email address Maximum length: 5000
value (anyOf 2)	null	Alternative

Create a Reader — response body — action / The most recent action performed by the reader / status: failed, in progress, succeeded collect inputs inputs item numeric

Field	Type	Presence	Description and constraints
$	object	Root	Information about a number being collected using a reader
value	JSON	Optional
value (anyOf 1)	string	Alternative	The collected number Maximum length: 5000
value (anyOf 2)	null	Alternative

Create a Reader — response body — action / The most recent action performed by the reader / status: failed, in progress, succeeded collect inputs inputs item phone

Field	Type	Presence	Description and constraints
$	object	Root	Information about a phone number being collected using a reader
value	JSON	Optional
value (anyOf 1)	string	Alternative	The collected phone number Maximum length: 5000
value (anyOf 2)	null	Alternative

Create a Reader — response body — action / The most recent action performed by the reader / status: failed, in progress, succeeded collect inputs inputs item selection

Field	Type	Presence	Description and constraints
$	object	Root	Information about a selection being collected using a reader
choices	array	Required within parent	List of possible choices to be selected
choices[]	Model	Each item	Expand Create a Reader — response body — action / The most recent action performed by the reader / status: failed, in progress, succeeded collect inputs inputs item selection choices item
id	JSON	Optional
id (anyOf 1)	string	Alternative	The id of the selected choice Maximum length: 5000
id (anyOf 2)	null	Alternative
text	JSON	Optional
text (anyOf 1)	string	Alternative	The text of the selected choice Maximum length: 5000
text (anyOf 2)	null	Alternative

Referenced models: Create a Reader — response body — action / The most recent action performed by the reader / status: failed, in progress, succeeded collect inputs inputs item selection choices item

Create a Reader — response body — action / The most recent action performed by the reader / status: failed, in progress, succeeded collect inputs inputs item selection choices item

Field	Type	Presence	Description and constraints
$	object	Root	Choice to be selected on a Reader
id	JSON	Optional
id (anyOf 1)	string	Alternative	The identifier for the selected choice. Maximum 50 characters. Maximum length: 5000
id (anyOf 2)	null	Alternative
style	JSON	Optional
style (anyOf 1)	string	Alternative	The button style for the choice. Can be `primary` or `secondary`. Known values: primary, secondary
style (anyOf 2)	null	Alternative
text	string	Required within parent	The text to be selected. Maximum 30 characters. Maximum length: 5000

Create a Reader — response body — action / The most recent action performed by the reader / status: failed, in progress, succeeded collect inputs inputs item signature

Field	Type	Presence	Description and constraints
$	object	Root	Information about a signature being collected using a reader
value	JSON	Optional
value (anyOf 1)	string	Alternative	The File ID of a collected signature image Maximum length: 5000
value (anyOf 2)	null	Alternative

Create a Reader — response body — action / The most recent action performed by the reader / status: failed, in progress, succeeded collect inputs inputs item text

Field	Type	Presence	Description and constraints
$	object	Root	Information about text being collected using a reader
value	JSON	Optional
value (anyOf 1)	string	Alternative	The collected text value Maximum length: 5000
value (anyOf 2)	null	Alternative

Create a Reader — response body — action / The most recent action performed by the reader / status: failed, in progress, succeeded collect inputs inputs item toggles array item

Field	Type	Presence	Description and constraints
$	object	Root	Information about an input's toggle
default_value	JSON	Optional
default_value (anyOf 1)	string	Alternative	The toggle's default value. Can be `enabled` or `disabled`. Known values: disabled, enabled
default_value (anyOf 2)	null	Alternative
description	JSON	Optional
description (anyOf 1)	string	Alternative	The toggle's description text. Maximum 50 characters. Maximum length: 5000
description (anyOf 2)	null	Alternative
title	JSON	Optional
title (anyOf 1)	string	Alternative	The toggle's title text. Maximum 50 characters. Maximum length: 5000
title (anyOf 2)	null	Alternative
value	JSON	Optional
value (anyOf 1)	string	Alternative	The toggle's collected value. Can be `enabled` or `disabled`. Known values: disabled, enabled
value (anyOf 2)	null	Alternative

Create a Reader — response body — action / The most recent action performed by the reader / status: failed, in progress, succeeded collect payment method

Field	Type	Presence	Description and constraints
$	object	Root	Represents a reader action to collect a payment method
collect_config	Model	Optional	Expand Create a Reader — response body — action / The most recent action performed by the reader / status: failed, in progress, succeeded collect payment method collect config
payment_intent	JSON	Required within parent	Most recent PaymentIntent processed by the reader.
payment_intent (anyOf 1)	string	Alternative	Maximum length: 5000
payment_intent (anyOf 2)	Model	Alternative	Expand Cancel a Payment Intent — response body
payment_method	Model	Optional	Expand Create a Payment Method — response body

Referenced models: Cancel a Payment Intent — response body, Create a Payment Method — response body, Create a Reader — response body — action / The most recent action performed by the reader / status: failed, in progress, succeeded collect payment method collect config

Create a Reader — response body — action / The most recent action performed by the reader / status: failed, in progress, succeeded collect payment method collect config

Field	Type	Presence	Description and constraints
$	object	Root	Represents a per-transaction override of a reader configuration
enable_customer_cancellation	boolean	Optional	Enable customer-initiated cancellation when processing this payment.
skip_tipping	boolean	Optional	Override showing a tipping selection screen on this transaction.
tipping	Model	Optional	Expand Create a Reader — response body — action / The most recent action performed by the reader / status: failed, in progress, succeeded collect payment method collect config tipping

Referenced models: Create a Reader — response body — action / The most recent action performed by the reader / status: failed, in progress, succeeded collect payment method collect config tipping

Create a Reader — response body — action / The most recent action performed by the reader / status: failed, in progress, succeeded collect payment method collect config tipping

Field	Type	Presence	Description and constraints
$	object	Root	Represents a per-transaction tipping configuration
amount_eligible	JSON	Optional
amount_eligible (anyOf 1)	integer	Alternative	Amount used to calculate tip suggestions on tipping selection screen for this transaction. Must be a positive integer in the smallest currency unit (e.g., 100 cents to represent $1.00 or 100 to represent ¥100, a zero-decimal currency).
amount_eligible (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Create a Reader — response body — action / The most recent action performed by the reader / status: failed, in progress, succeeded confirm payment intent

Field	Type	Presence	Description and constraints
$	object	Root	Represents a reader action to confirm a payment
confirm_config	Model	Optional	Expand Create a Reader — response body — action / The most recent action performed by the reader / status: failed, in progress, succeeded confirm payment intent confirm config
payment_intent	JSON	Required within parent	Most recent PaymentIntent processed by the reader.
payment_intent (anyOf 1)	string	Alternative	Maximum length: 5000
payment_intent (anyOf 2)	Model	Alternative	Expand Cancel a Payment Intent — response body

Referenced models: Cancel a Payment Intent — response body, Create a Reader — response body — action / The most recent action performed by the reader / status: failed, in progress, succeeded confirm payment intent confirm config

Create a Reader — response body — action / The most recent action performed by the reader / status: failed, in progress, succeeded confirm payment intent confirm config

Field	Type	Presence	Description and constraints
$	object	Root	Represents a per-transaction override of a reader configuration
return_url	string	Optional	If the customer doesn't abandon authenticating the payment, they're redirected to this URL after completion. Maximum length: 5000

Create a Reader — response body — action / The most recent action performed by the reader / status: failed, in progress, succeeded print content

Field	Type	Presence	Description and constraints
$	object	Root	Represents a reader action to print content
image	Model	Optional	Expand Create a Reader — response body — action / The most recent action performed by the reader / status: failed, in progress, succeeded print content image
type	string	Required within parent	The type of content to print. Currently supports `image`. Known values: image

Referenced models: Create a Reader — response body — action / The most recent action performed by the reader / status: failed, in progress, succeeded print content image

Create a Reader — response body — action / The most recent action performed by the reader / status: failed, in progress, succeeded print content image

Field	Type	Presence	Description and constraints
$	object	Root	Metadata of an uploaded file
created_at	JSON	Required within parent
created_at (anyOf 1)	integer	Alternative	Creation time of the object (in seconds since the Unix epoch). Format: unix-time
created_at (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
filename	string	Required within parent	The original name of the uploaded file (e.g. `receipt.png`). Maximum length: 5000
size	JSON	Required within parent
size (anyOf 1)	integer	Alternative	The size (in bytes) of the uploaded file.
size (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
type	string	Required within parent	The format of the uploaded file. Maximum length: 5000

Create a Reader — response body — action / The most recent action performed by the reader / status: failed, in progress, succeeded process payment intent

Field	Type	Presence	Description and constraints
$	object	Root	Represents a reader action to process a payment intent
payment_intent	JSON	Required within parent	Most recent PaymentIntent processed by the reader.
payment_intent (anyOf 1)	string	Alternative	Maximum length: 5000
payment_intent (anyOf 2)	Model	Alternative	Expand Cancel a Payment Intent — response body
process_config	Model	Optional	Expand Create a Reader — response body — action / The most recent action performed by the reader / status: failed, in progress, succeeded process payment intent process config

Referenced models: Cancel a Payment Intent — response body, Create a Reader — response body — action / The most recent action performed by the reader / status: failed, in progress, succeeded process payment intent process config

Create a Reader — response body — action / The most recent action performed by the reader / status: failed, in progress, succeeded process payment intent process config

Field	Type	Presence	Description and constraints
$	object	Root	Represents a per-transaction override of a reader configuration
enable_customer_cancellation	boolean	Optional	Enable customer-initiated cancellation when processing this payment.
return_url	string	Optional	If the customer doesn't abandon authenticating the payment, they're redirected to this URL after completion. Maximum length: 5000
skip_tipping	boolean	Optional	Override showing a tipping selection screen on this transaction.
tipping	Model	Optional	Expand Create a Reader — response body — action / The most recent action performed by the reader / status: failed, in progress, succeeded collect payment method collect config tipping

Referenced models: Create a Reader — response body — action / The most recent action performed by the reader / status: failed, in progress, succeeded collect payment method collect config tipping

Create a Reader — response body — action / The most recent action performed by the reader / status: failed, in progress, succeeded process setup intent

Field	Type	Presence	Description and constraints
$	object	Root	Represents a reader action to process a setup intent
generated_card	string	Optional	ID of a card PaymentMethod generated from the card_present PaymentMethod that may be attached to a Customer for future transactions. Only present if it was possible to generate a card PaymentMethod. Maximum length: 5000
process_config	Model	Optional	Expand Create a Reader — response body — action / The most recent action performed by the reader / status: failed, in progress, succeeded process setup intent process config
setup_intent	JSON	Required within parent	Most recent SetupIntent processed by the reader.
setup_intent (anyOf 1)	string	Alternative	Maximum length: 5000
setup_intent (anyOf 2)	Model	Alternative	Expand Cancel a Setup Intent — response body

Referenced models: Cancel a Setup Intent — response body, Create a Reader — response body — action / The most recent action performed by the reader / status: failed, in progress, succeeded process setup intent process config

Create a Reader — response body — action / The most recent action performed by the reader / status: failed, in progress, succeeded process setup intent process config

Field	Type	Presence	Description and constraints
$	object	Root	Represents a per-setup override of a reader configuration
enable_customer_cancellation	boolean	Optional	Enable customer-initiated cancellation when processing this SetupIntent.

Create a Reader — response body — action / The most recent action performed by the reader / status: failed, in progress, succeeded refund payment

Field	Type	Presence	Description and constraints
$	object	Root	Represents a reader action to refund a payment
amount	JSON	Optional
amount (anyOf 1)	integer	Alternative	The amount being refunded.
amount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
charge	JSON	Optional	Charge that is being refunded.
charge (anyOf 1)	string	Alternative	Maximum length: 5000
charge (anyOf 2)	Model	Alternative	Expand Create a charge — response body
metadata	object	Optional	Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Additional keys: see wildcard field
metadata.*	string	Additional keys	Maximum length: 500
payment_intent	JSON	Optional	Payment intent that is being refunded.
payment_intent (anyOf 1)	string	Alternative	Maximum length: 5000
payment_intent (anyOf 2)	Model	Alternative	Expand Cancel a Payment Intent — response body
reason	string	Optional	The reason for the refund. Known values: duplicate, fraudulent, requested_by_customer
refund	JSON	Optional	Unique identifier for the refund object.
refund (anyOf 1)	string	Alternative	Maximum length: 5000
refund (anyOf 2)	Model	Alternative	Expand Cancel a refund — response body
refund_application_fee	boolean	Optional	Boolean indicating whether the application fee should be refunded when refunding this charge. If a full charge refund is given, the full application fee will be refunded. Otherwise, the application fee will be refunded in an amount proportional to the amount of the charge refunded. An application fee can be refunded only by the application that created the charge.
refund_payment_config	Model	Optional	Expand Create a Reader — response body — action / The most recent action performed by the reader / status: failed, in progress, succeeded refund payment refund payment config
reverse_transfer	boolean	Optional	Boolean indicating whether the transfer should be reversed when refunding this charge. The transfer will be reversed proportionally to the amount being refunded (either the entire or partial amount). A transfer can be reversed only by the application that created the charge.

Referenced models: Create a charge — response body, Cancel a Payment Intent — response body, Cancel a refund — response body, Create a Reader — response body — action / The most recent action performed by the reader / status: failed, in progress, succeeded refund payment refund payment config

Create a Reader — response body — action / The most recent action performed by the reader / status: failed, in progress, succeeded refund payment refund payment config

Field	Type	Presence	Description and constraints
$	object	Root	Represents a per-transaction override of a reader configuration
enable_customer_cancellation	boolean	Optional	Enable customer-initiated cancellation when refunding this payment.

Create a Reader — response body — action / The most recent action performed by the reader / status: failed, in progress, succeeded set reader display

Field	Type	Presence	Description and constraints
$	object	Root	Represents a reader action to set the reader display
cart	JSON	Optional
cart (anyOf 1)	JSON	Alternative	Cart object to be displayed by the reader, including line items, amounts, and currency.
cart (anyOf 1) (anyOf 1)	Model	Alternative	Expand Create a Reader — response body — action / The most recent action performed by the reader / status: failed, in progress, succeeded set reader display cart value Represents a cart to be displayed on the reader
cart (anyOf 2)	null	Alternative
type	string	Required within parent	Type of information to be displayed by the reader. Only `cart` is currently supported. Known values: cart

Referenced models: Create a Reader — response body — action / The most recent action performed by the reader / status: failed, in progress, succeeded set reader display cart value Represents a cart to be displayed on the reader

Create a Reader — response body — action / The most recent action performed by the reader / status: failed, in progress, succeeded set reader display cart value Represents a cart to be displayed on the reader

Field	Type	Presence	Description and constraints
$	object	Root	Represents a cart to be displayed on the reader
currency	string	Required within parent	Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Format: currency
line_items	array	Required within parent	List of line items in the cart.
line_items[]	Model	Each item	Expand Create a Reader — response body — action / The most recent action performed by the reader / status: failed, in progress, succeeded set reader display cart value Represents a cart to be displayed on the reader line items item
tax	JSON	Optional
tax (anyOf 1)	JSON	Alternative
tax (anyOf 1) (anyOf 1)	integer	Alternative	Tax amount for the entire cart. A positive integer in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
tax (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
tax (anyOf 2)	null	Alternative
total	JSON	Required within parent
total (anyOf 1)	integer	Alternative	Total amount for the entire cart, including tax. A positive integer in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Create a Reader — response body — action / The most recent action performed by the reader / status: failed, in progress, succeeded set reader display cart value Represents a cart to be displayed on the reader line items item

Create a Reader — response body — action / The most recent action performed by the reader / status: failed, in progress, succeeded set reader display cart value Represents a cart to be displayed on the reader line items item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a line item to be displayed on the reader
amount	JSON	Required within parent
amount (anyOf 1)	integer	Alternative	The amount of the line item. A positive integer in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
amount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
description	string	Required within parent	Description of the line item. Maximum length: 5000
quantity	JSON	Required within parent
quantity (anyOf 1)	integer	Alternative	The quantity of the line item.
quantity (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Create a refund using a Terminal-supported device — response body

Field	Type	Presence	Description and constraints
$	object	Root	A Refund object returned by the Terminal refunds API.

Create an Onboarding Link — response body

Field	Type	Presence	Description and constraints
$	object	Root	Returns redirect links used for onboarding onto Tap to Pay on iPhone.
link_options	Model	Required within parent	Expand Create an Onboarding Link — response body — link options
link_type	string	Required within parent	The type of link being generated. Known values: apple_terms_and_conditions
object	string	Required within parent	Known values: terminal.onboarding_link
on_behalf_of	JSON	Optional
on_behalf_of (anyOf 1)	string	Alternative	Stripe account ID to generate the link for. Maximum length: 5000
on_behalf_of (anyOf 2)	null	Alternative
redirect_url	string	Required within parent	The link passed back to the user for their onboarding. Maximum length: 5000

Referenced models: Create an Onboarding Link — response body — link options

Create an Onboarding Link — response body — link options

Field	Type	Presence	Description and constraints
$	object	Root	Link type options associated with the current onboarding link object.
apple_terms_and_conditions	JSON	Optional
apple_terms_and_conditions (anyOf 1)	JSON	Alternative	The options associated with the Apple Terms and Conditions link type.
apple_terms_and_conditions (anyOf 1) (anyOf 1)	Model	Alternative	Expand Create an Onboarding Link — response body — link options apple terms and conditions value allow relinking, merchant display name
apple_terms_and_conditions (anyOf 2)	null	Alternative

Referenced models: Create an Onboarding Link — response body — link options apple terms and conditions value allow relinking, merchant display name

Create an Onboarding Link — response body — link options apple terms and conditions value allow relinking, merchant display name

Field	Type	Presence	Description and constraints
$	object	Root	Options associated with the Apple Terms and Conditions link type.
allow_relinking	JSON	Optional
allow_relinking (anyOf 1)	boolean	Alternative	Whether the link should also support users relinking their Apple account.
allow_relinking (anyOf 2)	null	Alternative
merchant_display_name	string	Required within parent	The business name of the merchant accepting Apple's Terms and Conditions. Maximum length: 5000

Delete a Configuration — response body

Field	Type	Presence	Description and constraints
$	object	Root
deleted	boolean	Required within parent	Always true for a deleted object Known values: True
id	string	Required within parent	Unique identifier for the object. Maximum length: 5000
object	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: terminal.configuration

Delete a Location — response body

Field	Type	Presence	Description and constraints
$	object	Root
deleted	boolean	Required within parent	Always true for a deleted object Known values: True
id	string	Required within parent	Unique identifier for the object. Maximum length: 5000
object	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: terminal.location

Delete a Reader — response body

Field	Type	Presence	Description and constraints
$	object	Root
deleted	boolean	Required within parent	Always true for a deleted object Known values: True
device_type	string	Required within parent	Device type of the reader. Known values: bbpos_chipper2x, bbpos_wisepad3, bbpos_wisepos_e, mobile_phone_reader, simulated_stripe_s700, simulated_stripe_s710, simulated_verifone_m425, simulated_verifone_p630, simulated_verifone_ux700, simulated_verifone_v660p, simulated_wisepos_e, stripe_m2, stripe_s700, stripe_s710, verifone_P400, verifone_m425, verifone_p630, verifone_ux700, verifone_v660p
id	string	Required within parent	Unique identifier for the object. Maximum length: 5000
object	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: terminal.reader
serial_number	string	Required within parent	Serial number of the reader. Maximum length: 5000