BrianC - Checkout Description | Stripe Developers | Page 1

manic ridge Mar 31, 2022, 10:37 PM

#

Hello! Are you asking about this property when creating a Checkout Session in setup mode?https://stripe.com/docs/api/checkout/sessions/create#create_checkout_session-setup_intent_data-description

valid oriole Mar 31, 2022, 10:39 PM

#

Yes

#

"An arbitrary string attached to the object. Often useful for displaying to users." Where does it display?

manic ridge Mar 31, 2022, 10:43 PM

#

Checkout does not display that description. You can display it in your own interface if you wish.

valid oriole Mar 31, 2022, 10:43 PM

#

So it is for Stripe Elements?

manic ridge Mar 31, 2022, 10:44 PM

#

It corresponds to the description on the Setup Intent: https://stripe.com/docs/api/setup_intents/object#setup_intent_object-description

#

No, Stripe Elements does not display it either. To my knowledge no customer-facing Stripe UI displays it. It's something you can display if you wish, and shows up in the Dashboard.

valid oriole Mar 31, 2022, 10:44 PM

#

I'm still not sure what the purpose of it is.

#

Ah! the Dashboard. got it

#

IMHO that should be explained in the docs. Wasted a little time on this

manic ridge Mar 31, 2022, 10:47 PM

#

The docs explain it's often useful for displaying to users, but doing so is up to you, we don't indicate anywhere that Stripe will display it to users (if we do please let me know so I can get that corrected!). 🙂

valid oriole Mar 31, 2022, 10:50 PM

#

Right. But it is not clear at all where it is/can be displayed. From the viewpoint of a dev that does not have his head in this every day, it's not obvious. Just sayin. Thanks for the clarity

#BrianC - Checkout Description