Stripe: Mandates schemas

← Mandates operations · All schemas

Retrieve a Mandate — response body

Field	Type	Presence	Description and constraints
$	object	Root	A Mandate is a record of the permission that your customer gives you to debit their payment method.
customer_acceptance	Model	Required within parent	Expand Retrieve a Mandate — response body — customer acceptance
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`.
multi_use	Model	Optional	Expand Retrieve a Mandate — response body — multi use
object	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: mandate
on_behalf_of	string	Optional	The account (if any) that the mandate is intended for. Maximum length: 5000
payment_method	JSON	Required within parent	ID of the payment method associated with this mandate.
payment_method (anyOf 1)	string	Alternative	Maximum length: 5000
payment_method (anyOf 2)	Model	Alternative	Expand Create a Payment Method — response body
payment_method_details	Model	Required within parent	Expand Retrieve a Mandate — response body — payment method details
single_use	Model	Optional	Expand Retrieve a Mandate — response body — single use
status	string	Required within parent	The mandate status indicates whether or not you can use it to initiate a payment. Known values: active, inactive, pending
type	string	Required within parent	The type of the mandate. Known values: multi_use, single_use

Referenced models: Retrieve a Mandate — response body — customer acceptance, Retrieve a Mandate — response body — multi use, Retrieve a Mandate — response body — payment method details, Retrieve a Mandate — response body — single use, Create a Payment Method — response body

Retrieve a Mandate — response body — customer acceptance

Field	Type	Presence	Description and constraints
$	object	Root
accepted_at	JSON	Optional
accepted_at (anyOf 1)	JSON	Alternative
accepted_at (anyOf 1) (anyOf 1)	integer	Alternative	The time that the customer accepts the mandate. Format: unix-time
accepted_at (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
accepted_at (anyOf 2)	null	Alternative
offline	Model	Optional	Expand Create a Payment Method — response body — zip
online	Model	Optional	Expand Retrieve a Mandate — response body — customer acceptance online
type	string	Required within parent	The mandate includes the type of customer acceptance information, such as: `online` or `offline`. Known values: offline, online

Referenced models: Create a Payment Method — response body — zip, Retrieve a Mandate — response body — customer acceptance online

Retrieve a Mandate — response body — customer acceptance online

Field	Type	Presence	Description and constraints
$	object	Root
ip_address	JSON	Optional
ip_address (anyOf 1)	string	Alternative	The customer accepts the mandate from this IP address. Maximum length: 5000
ip_address (anyOf 2)	null	Alternative
user_agent	JSON	Optional
user_agent (anyOf 1)	string	Alternative	The customer accepts the mandate using the user agent of the browser. Maximum length: 5000
user_agent (anyOf 2)	null	Alternative

Retrieve a Mandate — response body — multi use

Field	Type	Presence	Description and constraints
$	object	Root
amount	JSON	Optional
amount (anyOf 1)	integer	Alternative	The amount of the payment on a multi use mandate.
amount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
currency	string	Optional	The currency of the payment on a multi use mandate. Format: currency

Retrieve a Mandate — response body — payment method details

Field	Type	Presence	Description and constraints
$	object	Root
acss_debit	Model	Optional	Expand Retrieve a Mandate — response body — payment method details acss debit
amazon_pay	Model	Optional	Expand Create a Payment Method — response body — zip
au_becs_debit	Model	Optional	Expand Retrieve a Mandate — response body — payment method details au becs debit
bacs_debit	Model	Optional	Expand Retrieve a Mandate — response body — payment method details bacs debit
blik	Model	Optional	Expand Retrieve a Mandate — response body — payment method details blik
card	Model	Optional	Expand Retrieve a Mandate — response body — payment method details card
cashapp	Model	Optional	Expand Create a Payment Method — response body — zip
kakao_pay	Model	Optional	Expand Create a Payment Method — response body — zip
klarna	Model	Optional	Expand Create a Payment Method — response body — zip
kr_card	Model	Optional	Expand Create a Payment Method — response body — zip
link	Model	Optional	Expand Create a Payment Method — response body — zip
naver_pay	Model	Optional	Expand Create a Payment Method — response body — zip
nz_bank_account	Model	Optional	Expand Create a Payment Method — response body — zip
paypal	Model	Optional	Expand Retrieve a Mandate — response body — payment method details paypal
payto	Model	Optional	Expand Retrieve a Mandate — response body — payment method details payto
pix	Model	Optional	Expand Retrieve a Mandate — response body — payment method details pix
revolut_pay	Model	Optional	Expand Create a Payment Method — response body — zip
sepa_debit	Model	Optional	Expand Retrieve a Mandate — response body — payment method details sepa debit
twint	Model	Optional	Expand Create a Payment Method — response body — zip
type	string	Required within parent	This mandate corresponds with a specific payment method type. The `payment_method_details` includes an additional hash with the same name and contains mandate information that's specific to that payment method. Maximum length: 5000
upi	Model	Optional	Expand Retrieve a Mandate — response body — payment method details upi
us_bank_account	Model	Optional	Expand Retrieve a Mandate — response body — payment method details us bank account

Referenced models: Create a Payment Method — response body — zip, Retrieve a Mandate — response body — payment method details card, Retrieve a Mandate — response body — payment method details upi, Retrieve a Mandate — response body — payment method details acss debit, Retrieve a Mandate — response body — payment method details au becs debit, Retrieve a Mandate — response body — payment method details bacs debit, Retrieve a Mandate — response body — payment method details blik, Retrieve a Mandate — response body — payment method details paypal, Retrieve a Mandate — response body — payment method details payto, Retrieve a Mandate — response body — payment method details pix, Retrieve a Mandate — response body — payment method details sepa debit, Retrieve a Mandate — response body — payment method details us bank account

Retrieve a Mandate — response body — payment method details acss debit

Field	Type	Presence	Description and constraints
$	object	Root
default_for	array	Optional	List of Stripe products where this mandate can be selected automatically.
default_for[]	string	Each item	Known values: invoice, subscription
interval_description	JSON	Optional
interval_description (anyOf 1)	string	Alternative	Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'. Maximum length: 5000
interval_description (anyOf 2)	null	Alternative
payment_schedule	string	Required within parent	Payment schedule for the mandate. Known values: combined, interval, sporadic
transaction_type	string	Required within parent	Transaction type of the mandate. Known values: business, personal

Retrieve a Mandate — response body — payment method details au becs debit

Field	Type	Presence	Description and constraints
$	object	Root
url	string	Required within parent	The URL of the mandate. This URL generally contains sensitive information about the customer and should be shared with them exclusively. Maximum length: 5000

Retrieve a Mandate — response body — payment method details bacs debit

Field	Type	Presence	Description and constraints
$	object	Root
display_name	JSON	Optional
display_name (anyOf 1)	string	Alternative	The display name for the account on this mandate. Maximum length: 5000
display_name (anyOf 2)	null	Alternative
network_status	string	Required within parent	The status of the mandate on the Bacs network. Can be one of `pending`, `revoked`, `refused`, or `accepted`. Known values: accepted, pending, refused, revoked
reference	string	Required within parent	The unique reference identifying the mandate on the Bacs network. Maximum length: 5000
revocation_reason	JSON	Optional
revocation_reason (anyOf 1)	string	Alternative	When the mandate is revoked on the Bacs network this field displays the reason for the revocation. Known values: account_closed, bank_account_restricted, bank_ownership_changed, could_not_process, debit_not_authorized
revocation_reason (anyOf 2)	null	Alternative
service_user_number	JSON	Optional
service_user_number (anyOf 1)	string	Alternative	The service user number for the account on this mandate. Maximum length: 5000
service_user_number (anyOf 2)	null	Alternative
url	string	Required within parent	The URL that will contain the mandate that the customer has signed. Maximum length: 5000

Retrieve a Mandate — response body — payment method details blik

Field	Type	Presence	Description and constraints
$	object	Root
expires_at	JSON	Optional
expires_at (anyOf 1)	JSON	Alternative
expires_at (anyOf 1) (anyOf 1)	integer	Alternative	Date at which the mandate expires. Format: unix-time
expires_at (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
expires_at (anyOf 2)	null	Alternative
type	string	Required within parent	Type of the mandate. Known values: off_session

Retrieve a Mandate — response body — payment method details card

Field	Type	Presence	Description and constraints
$	object	Root
india	Model	Optional	Expand Retrieve a Mandate — response body — payment method details card india

Referenced models: Retrieve a Mandate — response body — payment method details card india

Retrieve a Mandate — response body — payment method details card india

Field	Type	Presence	Description and constraints
$	object	Root
inactive_reason	JSON	Optional
inactive_reason (anyOf 1)	string	Alternative	The reason why the mandate has an `inactive` status. This field is only populated if the mandate is inactive. Known values: canceled, card_not_supported, currency_not_supported, expired, issuer_not_supported, processing_error, undetermined
inactive_reason (anyOf 2)	null	Alternative

Retrieve a Mandate — response body — payment method details paypal

Field	Type	Presence	Description and constraints
$	object	Root
billing_agreement_id	JSON	Optional
billing_agreement_id (anyOf 1)	string	Alternative	The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer. Maximum length: 5000
billing_agreement_id (anyOf 2)	null	Alternative
payer_id	JSON	Optional
payer_id (anyOf 1)	string	Alternative	PayPal account PayerID. This identifier uniquely identifies the PayPal customer. Maximum length: 5000
payer_id (anyOf 2)	null	Alternative

Retrieve a Mandate — response body — payment method details payto

Field	Type	Presence	Description and constraints
$	object	Root
amount	JSON	Optional
amount (anyOf 1)	JSON	Alternative
amount (anyOf 1) (anyOf 1)	integer	Alternative	Amount that will be collected. It is required when `amount_type` is `fixed`.
amount (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
amount (anyOf 2)	null	Alternative
amount_type	string	Required within parent	The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively. Defaults to `maximum`. Known values: fixed, maximum
end_date	JSON	Optional
end_date (anyOf 1)	string	Alternative	Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date. Maximum length: 5000
end_date (anyOf 2)	null	Alternative
payment_schedule	string	Required within parent	The periodicity at which payments will be collected. Defaults to `adhoc`. Known values: adhoc, annual, daily, fortnightly, monthly, quarterly, semi_annual, weekly
payments_per_period	JSON	Optional
payments_per_period (anyOf 1)	JSON	Alternative
payments_per_period (anyOf 1) (anyOf 1)	integer	Alternative	The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit.
payments_per_period (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
payments_per_period (anyOf 2)	null	Alternative
purpose	JSON	Optional
purpose (anyOf 1)	string	Alternative	The purpose for which payments are made. Has a default value based on your merchant category code. Known values: dependant_support, government, loan, mortgage, other, pension, personal, retail, salary, tax, utility
purpose (anyOf 2)	null	Alternative
start_date	JSON	Optional
start_date (anyOf 1)	string	Alternative	Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time. Maximum length: 5000
start_date (anyOf 2)	null	Alternative

Retrieve a Mandate — response body — payment method details pix

Field	Type	Presence	Description and constraints
$	object	Root
amount_includes_iof	string	Optional	Determines if the amount includes the IOF tax. Known values: always, never
amount_type	string	Optional	Type of amount. Known values: fixed, maximum
end_date	string	Optional	Date when the mandate expires and no further payments will be charged, in `YYYY-MM-DD`. Maximum length: 5000
payment_schedule	string	Optional	Schedule at which the future payments will be charged. Known values: halfyearly, monthly, quarterly, weekly, yearly
reference	string	Optional	Subscription name displayed to buyers in their bank app. Maximum length: 5000
start_date	string	Optional	Start date of the mandate, in `YYYY-MM-DD`. Maximum length: 5000

Retrieve a Mandate — response body — payment method details sepa debit

Field	Type	Presence	Description and constraints
$	object	Root
reference	string	Required within parent	The unique reference of the mandate. Maximum length: 5000
url	string	Required within parent	The URL of the mandate. This URL generally contains sensitive information about the customer and should be shared with them exclusively. Maximum length: 5000

Retrieve a Mandate — response body — payment method details upi

Field	Type	Presence	Description and constraints
$	object	Root
amount	JSON	Optional
amount (anyOf 1)	JSON	Alternative
amount (anyOf 1) (anyOf 1)	integer	Alternative	Amount to be charged for future payments.
amount (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
amount (anyOf 2)	null	Alternative
amount_type	JSON	Optional
amount_type (anyOf 1)	string	Alternative	One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param. Known values: fixed, maximum
amount_type (anyOf 2)	null	Alternative
description	JSON	Optional
description (anyOf 1)	string	Alternative	A description of the mandate or subscription that is meant to be displayed to the customer. Maximum length: 20
description (anyOf 2)	null	Alternative
end_date	JSON	Optional
end_date (anyOf 1)	JSON	Alternative
end_date (anyOf 1) (anyOf 1)	integer	Alternative	End date of the mandate or subscription. Format: unix-time
end_date (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
end_date (anyOf 2)	null	Alternative

Retrieve a Mandate — response body — payment method details us bank account

Field	Type	Presence	Description and constraints
$	object	Root
collection_method	string	Optional	Mandate collection method Known values: paper

Retrieve a Mandate — response body — single use

Field	Type	Presence	Description and constraints
$	object	Root
amount	JSON	Required within parent
amount (anyOf 1)	integer	Alternative	The amount of the payment on a single use mandate.
amount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
currency	string	Required within parent	The currency of the payment on a single use mandate. Format: currency