Skip to main content
Version: Streamsheets 3.0

STRIPE.PRODUCT.UPDATE

Premium

Updates settings for specified product.

Syntax

=STRIPE.PRODUCT.UPDATE(ProductID, [Active], [DefaultPriceID], [Options], [ResponseTarget])

Arguments

NameTypeDescription
ProductIDStringThe unique ID of the product to update.
Active (optional)BooleanOptional new active state for specfied product.
DefaultPriceID (optional)StringID of the new default price for specfied product.
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.PRODUCT.UPDATE("prod_MhD1djepQmTqfQ",FALSE)
JSONDeactivates the product with id "prod_MhD1djepQmTqfQ".
=STRIPE.PRODUCT.UPDATE("prod_MhD1djepQmTqfQ",FALSE)
JSONSame as before but additionally adds an metadata.order_id specified by given JSON object.