Commerce
setCartSettings
Set Cart Settings
Change how a shop's checkout works: update phone and notes collection, choose accepted payment methods, choose the checkout page, set the shop's sales-tax rate, and switch the checkout tip row on or…
Arguments
checkoutUistringoptionalWHERE buyers pay. "auto" gives a shop with a live payment account Stripe's complete checkout in its storefront. "custom" shows the order and Stripe payment fields together on the shop's own checkout page. "on" uses Stripe's complete…collectDietarybooleanoptionaltrue to show buyers a dietary and allergy picker at checkout. The picks land on the order as structured data and print on the confirmation page and on both order emails. A shop that turns this on without passing dietaryTags offers the…collectNotesbooleanoptionaltrue to show buyers an optional order-notes box.collectPhonebooleanoptionaltrue to ask buyers for a phone number at checkout.dietaryTagsstring[]optionalWHICH of the shared dietary vocabulary this shop offers at checkout. Replaces the whole list; omit to keep the standard one. Allowed: gluten_free, dairy_free, nut_free, peanut_free, tree_nut_free, sesame_free, coconut_free, corn_free,…notesPromptstringoptionalLabel on the notes box, e.g. "Allergies or special requests". Max 50 characters.paymentMethodsstring[]optionalStripe payment methods this shop accepts. Card includes supported card wallets. Pass an empty list to let Stripe decide.spacestringoptionalSpace id or slug (see listPageSpaces) for a Space-owned shop. Omit for your personal shop.taxRateBpsintegeroptionalSales-tax rate in BASIS POINTS, not percent: 100 = 1%, so 6.25% is 625 and 8.25% is 825. 0 means the shop charges no sales tax. Max 10000 (100%). Applies to the storefront, the register, and the receipt; a product or a pickup location…tipAllowCustombooleanoptionalfalse to offer only the preset percentages and no-tip, hiding the type-your-own-amount box. Defaults to true.tipPresetBpsinteger[]optionalWHICH percentages the tip row offers, in BASIS POINTS: 100 = 1%, so 10 / 15 / 20 percent is [1000, 1500, 2000] (the default). Replaces the whole list, up to 4 of them. The row shows whole percentages only, so a preset that is not a whole…tippingEnabledbooleanoptionaltrue to add a tip row to this shop's checkout page. The buyer picks a percentage, a custom amount, or no tip; the tip is never taxed, rides the payment as its own line, and itemizes on the order, the confirmation page and both order…
Returns
The registry does not declare a return shape.
Declared limits
notesPrompt: maximum length 50taxRateBps: minimum 0taxRateBps: maximum 10000tipPresetBps: maximum items 4
Ask for it
The Cloud routes these requests to this verb.
- stop asking customers for a phone number
- accept cards and Cash App Pay
- let Stripe decide payment methods
- keep buyers on my site when they pay
- set my sales tax to 6.25%
- let customers tip on my website
- turn on tipping
- change my tip options to 15, 18 and 20 percent
Pair it with
The verbs that finish the job.