Package com.stripe.param

Class ProductUpdateParams

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static ProductUpdateParams.Builder builder()  
      java.lang.Boolean getActive()
      Whether the product is available for purchase.
      java.lang.Object getAttributes()
      A list of up to 5 alphanumeric attributes that each SKU can provide values for (e.g., ["color", "size"]).
      java.lang.Object getCaption()
      A short one-line description of the product, meant to be displayable to the customer.
      java.util.List<java.lang.String> getDeactivateOn()
      An array of Connect application names or identifiers that should not be able to order the SKUs for this product.
      java.lang.Object getDescription()
      The product's description, meant to be displayable to the customer.
      java.util.List<java.lang.String> getExpand()
      Specifies which fields in the response should be expanded.
      java.util.Map<java.lang.String,​java.lang.Object> getExtraParams()
      Map of extra parameters for custom features not available in this client library.
      java.lang.Object getImages()
      A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
      java.lang.Object getMetadata()
      Set of key-value pairs that you can attach to an object.
      java.lang.Object getName()
      The product's name, meant to be displayable to the customer.
      java.lang.Object getPackageDimensions()
      The dimensions of this product for shipping purposes.
      java.lang.Boolean getShippable()
      Whether this product is shipped (i.e., physical goods).
      java.lang.Object getStatementDescriptor()
      An arbitrary string to be displayed on your customer's credit card or bank statement.
      java.lang.Object getTaxCode()
      A tax code ID.
      java.lang.Object getUnitLabel()
      A label that represents units of this product in Stripe and on customers’ receipts and invoices.
      java.lang.Object getUrl()
      A URL of a publicly-accessible webpage for this product.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • getActive

        public java.lang.Boolean getActive()
        Whether the product is available for purchase.

      • getAttributes

        public java.lang.Object getAttributes()
        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.

      • getCaption

        public java.lang.Object getCaption()
        A short one-line description of the product, meant to be displayable to the customer. May only be set if type=good.

      • getDeactivateOn

        public java.util.List<java.lang.String> getDeactivateOn()
        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.

      • getDescription

        public java.lang.Object getDescription()
        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.

      • getExpand

        public java.util.List<java.lang.String> getExpand()
        Specifies which fields in the response should be expanded.

      • getExtraParams

        public java.util.Map<java.lang.String,​java.lang.Object> getExtraParams()
        Map of extra parameters for custom features not available in this client library. The content in this map is not serialized under this field's @SerializedName value. Instead, each key/value pair is serialized as if the key is a root-level field (serialized) name in this param object. Effectively, this map is flattened to its parent instance.

      • getImages

        public java.lang.Object getImages()
        A list of up to 8 URLs of images for this product, meant to be displayable to the customer.

      • getMetadata

        public java.lang.Object getMetadata()
        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.

      • getName

        public java.lang.Object getName()
        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.

      • getPackageDimensions

        public java.lang.Object getPackageDimensions()
        The dimensions of this product for shipping purposes.

      • getShippable

        public java.lang.Boolean getShippable()
        Whether this product is shipped (i.e., physical goods).

      • getStatementDescriptor

        public java.lang.Object getStatementDescriptor()
        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.

      • getTaxCode

        public java.lang.Object getTaxCode()
        A tax code ID.

      • getUnitLabel

        public java.lang.Object getUnitLabel()
        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.

      • getUrl

        public java.lang.Object getUrl()
        A URL of a publicly-accessible webpage for this product.