Skip to main content
Version: Streamsheets 3.0

STRIPE.CHARGE.UPDATE

Premium

Updates settings for specified charge.

Syntax

=STRIPE.CHARGE.UPDATE(ChargeID, [CustomerID], [Description], [Options], [ResponseTarget])

Arguments

NameTypeDescription
ChargeIDStringThe unique ID of the charge to update.
CustomerID (optional)StringAssociate this charge to customer specified by given ID.
Description (optional)StringUpdate charge description.
Options (optional)JSONJSON which defines additional options as key value pairs. See Stripe API for supported options and their values.
ResponseTarget (optional)TargetSpecify inbox, outbox, cell or cell-range to write any response to

Return

TypeDescription
Boolean,Result,ErrorRequest result if no target is specified otherwise TRUE. In case of an error the corresponding error-code is returned.

Examples

AB
1metadata[order_id]6735
FormulaResultComment
=STRIPE.CHARGE.UPDATE("ch_3Lxoal2eZvKYlo2C01xfKOA1",,"Updated description")
JSONUpdates the description of charge with id "ch_3Lxoal2eZvKYlo2C01xfKOA1".
=STRIPE.CHARGE.UPDATE("ch_3Lxoal2eZvKYlo2C01xfKOA1",,"Updated description",JSON(A1:B1))
JSONSame as before but additionally updates order_id specified by given JSON object.