Struct stripe::UpdateProduct

pub struct UpdateProduct<'a> {
    pub active: Option<bool>,
    pub attributes: Option<Vec<String>>,
    pub caption: Option<&'a str>,
    pub deactivate_on: Option<Vec<String>>,
    pub description: Option<&'a str>,
    pub expand: &'a [&'a str],
    pub images: Option<Vec<String>>,
    pub metadata: Option<Metadata>,
    pub name: Option<&'a str>,
    pub package_dimensions: Option<PackageDimensions>,
    pub shippable: Option<bool>,
    pub statement_descriptor: Option<&'a str>,
    pub unit_label: Option<&'a str>,
    pub url: Option<&'a str>,
}

The parameters for Product::update.

Fields

active: Option<bool>

Whether the product is available for purchase.

attributes: Option<Vec<String>>

A list of up to 5 alphanumeric attributes that each SKU can provide values for (e.g., ["color", "size"]).

If a value for attributes is specified, the list specified will replace the existing attributes list on this product. Any attributes not present after the update will be deleted from the SKUs for this product.

caption: Option<&'a str>

A short one-line description of the product, meant to be displayable to the customer.

May only be set if type=good.

deactivate_on: Option<Vec<String>>

An array of Connect application names or identifiers that should not be able to order the SKUs for this product.

May only be set if type=good.

description: Option<&'a str>

The product's description, meant to be displayable to the customer.

Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.

expand: &'a [&'a str]

Specifies which fields in the response should be expanded.

images: Option<Vec<String>>

A list of up to 8 URLs of images for this product, meant to be displayable to the customer.

metadata: Option<Metadata>

Set of key-value pairs that you can attach to an object.

This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

name: Option<&'a str>

The product's name, meant to be displayable to the customer.

Whenever this product is sold via a subscription, name will show up on associated invoice line item descriptions.

package_dimensions: Option<PackageDimensions>

The dimensions of this product for shipping purposes.

A SKU associated with this product can override this value by having its own package_dimensions. May only be set if type=good.

shippable: Option<bool>

Whether this product is shipped (i.e., physical goods).

Defaults to true. May only be set if type=good.

statement_descriptor: Option<&'a str>

An arbitrary string to be displayed on your customer's credit card or bank statement.

While most banks display this information consistently, some may display it incorrectly or not at all. This may be up to 22 characters. The statement description may not include <, >, \, ", ' characters, and will appear on your customer's statement in capital letters. Non-ASCII characters are automatically stripped. It must contain at least one letter. May only be set if type=service.

unit_label: Option<&'a str>

A label that represents units of this product in Stripe and on customers’ receipts and invoices.

When set, this will be included in associated invoice line item descriptions. May only be set if type=service.

url: Option<&'a str>

A URL of a publicly-accessible webpage for this product.

May only be set if type=good.

Implementations

impl<'a> UpdateProduct<'a>

pub fn new() -> Self

Trait Implementations

impl<'a> Clone for UpdateProduct<'a>

fn clone(&self) -> UpdateProduct<'a>

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Debug for UpdateProduct<'a>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'a> Default for UpdateProduct<'a>

fn default() -> UpdateProduct<'a>

Returns the "default value" for a type.

impl<'a> Serialize for UpdateProduct<'a>

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.