Sample - Stripe API
GET/v1/mandates/{mandate}

Retrieve a Mandate

Retrieves a Mandate by its identifier. Use mandate to select the payment permission record and expand to request expanded fields such as payment method details or customer acceptance information.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

2 parameters
mandatestringrequired
The unique identifier of the Mandate.
expandarray<string>optional
Fields to expand in the response; each value can contain up to 5000 characters.

2 status codes
200Returns the Mandate, including its customer acceptance details, payment method, type, status, live-mode state, and optional single-use or multi-use terms.
customer_acceptanceobjectrequired
idstringrequired
Unique identifier for the object.
livemodebooleanrequired
If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
multi_useobjectoptional
objectstringrequired
String representing the object's type. Objects of the same type share the same value.
Allowed:mandate
on_behalf_ofstringoptional
The account (if any) that the mandate is intended for.
payment_methodstringrequired
ID of the payment method associated with this mandate.
payment_method_detailsobjectrequired
single_useobjectoptional
statusstringrequired
The mandate status indicates whether or not you can use it to initiate a payment.
Allowed:activeinactivepending
typestringrequired
The type of the mandate.
Allowed:multi_usesingle_use
defaultReturned when the API reports an error; the response contains an `error` object with a `type` field.
errorobjectrequired

Error handling

mandate must identify the Mandate to retrieve. Each value in expand must be a string no longer than 5000 characters.