Search documentation of tiger_stripe

# Stripe.Params.ProductUpdateParams (tiger_stripe v0.1.1)

Copy Markdown View Source

Parameters for product update.

## Summary

### Types

t()

## Types

# t()

    @type t() :: %Stripe.Params.ProductUpdateParams{
      active: boolean() | nil,
      default_price: String.t() | nil,
      description: map() | nil,
      expand: [String.t()] | nil,
      images: map() | nil,
      marketing_features: map() | nil,
      metadata: map() | nil,
      name: String.t() | nil,
      package_dimensions: map() | nil,
      shippable: boolean() | nil,
      statement_descriptor: String.t() | nil,
      tax_code: map() | nil,
      unit_label: map() | nil,
      url: map() | nil
    }

- `active` - Whether the product is available for purchase.
- `default_price` - The ID of the Price object that is the default price for this product. Max length: 5000.
- `description` - 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` - Specifies which fields in the response should be expanded.
- `images` - A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
- `marketing_features` - A list of up to 15 marketing features for this product. These are displayed in pricing tables.
- `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` - The product's name, meant to be displayable to the customer. Max length: 5000.
- `package_dimensions` - The dimensions of this product for shipping purposes.
- `shippable` - Whether this product is shipped (i.e., physical goods).
- `statement_descriptor` - 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`. Only used for subscription payments. Max length: 22.

- `tax_code` - A tax code ID.
- `unit_label` - A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal. May only be set if `type=service`.
- `url` - A URL of a publicly-accessible webpage for this product.