Class ProductUpdateParams


public class ProductUpdateParams extends ApiRequestParams
  • Method Details

    • builder

      public static ProductUpdateParams.Builder builder()
    • getActive

      public Boolean getActive()
      Whether the product is available for purchase.
    • getDefaultPrice

      public Object getDefaultPrice()
      The ID of the Price object that is the default price for this product.
    • getDescription

      public 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 List<String> getExpand()
      Specifies which fields in the response should be expanded.
    • getExtraParams

      public Map<String,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.
    • getFeatures

      public Object getFeatures()
      A list of up to 15 features for this product. These are displayed in pricing tables.
    • getImages

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

      public 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 Object getName()
      The product's name, meant to be displayable to the customer.
    • getPackageDimensions

      public Object getPackageDimensions()
      The dimensions of this product for shipping purposes.
    • getShippable

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

      public 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 Object getTaxCode()
      A tax code ID.
    • getUnitLabel

      public Object getUnitLabel()
      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.
    • getUrl

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