Class ProductUpdateParams.Builder

java.lang.Object
com.stripe.param.ProductUpdateParams.Builder
Enclosing class:
ProductUpdateParams

public static class ProductUpdateParams.Builder extends Object
  • Constructor Details

    • Builder

      public Builder()
  • Method Details

    • build

      public ProductUpdateParams build()
      Finalize and obtain parameter instance from this builder.
    • setActive

      public ProductUpdateParams.Builder setActive(Boolean active)
      Whether the product is available for purchase.
    • addAttribute

      public ProductUpdateParams.Builder addAttribute(String element)
      Add an element to `attributes` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See ProductUpdateParams.attributes for the field documentation.
    • addAllAttribute

      public ProductUpdateParams.Builder addAllAttribute(List<String> elements)
      Add all elements to `attributes` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See ProductUpdateParams.attributes for the field documentation.
    • setAttributes

      public ProductUpdateParams.Builder setAttributes(EmptyParam attributes)
      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.
    • setAttributes

      public ProductUpdateParams.Builder setAttributes(List<String> attributes)
      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.
    • setCaption

      public ProductUpdateParams.Builder setCaption(String caption)
      A short one-line description of the product, meant to be displayable to the customer. May only be set if type=good.
    • setCaption

      public ProductUpdateParams.Builder setCaption(EmptyParam caption)
      A short one-line description of the product, meant to be displayable to the customer. May only be set if type=good.
    • addDeactivateOn

      public ProductUpdateParams.Builder addDeactivateOn(String element)
      Add an element to `deactivateOn` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See ProductUpdateParams.deactivateOn for the field documentation.
    • addAllDeactivateOn

      public ProductUpdateParams.Builder addAllDeactivateOn(List<String> elements)
      Add all elements to `deactivateOn` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See ProductUpdateParams.deactivateOn for the field documentation.
    • setDefaultPrice

      public ProductUpdateParams.Builder setDefaultPrice(String defaultPrice)
      The ID of the Price object that is the default price for this product.
    • setDefaultPrice

      public ProductUpdateParams.Builder setDefaultPrice(EmptyParam defaultPrice)
      The ID of the Price object that is the default price for this product.
    • setDescription

      public ProductUpdateParams.Builder setDescription(String 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.
    • setDescription

      public ProductUpdateParams.Builder setDescription(EmptyParam 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.
    • addExpand

      public ProductUpdateParams.Builder addExpand(String element)
      Add an element to `expand` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See ProductUpdateParams.expand for the field documentation.
    • addAllExpand

      public ProductUpdateParams.Builder addAllExpand(List<String> elements)
      Add all elements to `expand` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See ProductUpdateParams.expand for the field documentation.
    • putExtraParam

      public ProductUpdateParams.Builder putExtraParam(String key, Object value)
      Add a key/value pair to `extraParams` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. See ProductUpdateParams.extraParams for the field documentation.
    • putAllExtraParam

      public ProductUpdateParams.Builder putAllExtraParam(Map<String,Object> map)
      Add all map key/value pairs to `extraParams` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. See ProductUpdateParams.extraParams for the field documentation.
    • addImage

      public ProductUpdateParams.Builder addImage(String element)
      Add an element to `images` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See ProductUpdateParams.images for the field documentation.
    • addAllImage

      public ProductUpdateParams.Builder addAllImage(List<String> elements)
      Add all elements to `images` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See ProductUpdateParams.images for the field documentation.
    • setImages

      public ProductUpdateParams.Builder setImages(EmptyParam images)
      A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
    • setImages

      public ProductUpdateParams.Builder setImages(List<String> images)
      A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
    • putMetadata

      public ProductUpdateParams.Builder putMetadata(String key, String value)
      Add a key/value pair to `metadata` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. See ProductUpdateParams.metadata for the field documentation.
    • putAllMetadata

      public ProductUpdateParams.Builder putAllMetadata(Map<String,String> map)
      Add all map key/value pairs to `metadata` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. See ProductUpdateParams.metadata for the field documentation.
    • setMetadata

      public ProductUpdateParams.Builder setMetadata(EmptyParam 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.
    • setMetadata

      public ProductUpdateParams.Builder setMetadata(Map<String,String> 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.
    • setName

      public ProductUpdateParams.Builder setName(String name)
      The product's name, meant to be displayable to the customer.
    • setName

      public ProductUpdateParams.Builder setName(EmptyParam name)
      The product's name, meant to be displayable to the customer.
    • setPackageDimensions

      public ProductUpdateParams.Builder setPackageDimensions(ProductUpdateParams.PackageDimensions packageDimensions)
      The dimensions of this product for shipping purposes.
    • setPackageDimensions

      public ProductUpdateParams.Builder setPackageDimensions(EmptyParam packageDimensions)
      The dimensions of this product for shipping purposes.
    • setShippable

      public ProductUpdateParams.Builder setShippable(Boolean shippable)
      Whether this product is shipped (i.e., physical goods).
    • setStatementDescriptor

      public ProductUpdateParams.Builder setStatementDescriptor(String statementDescriptor)
      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.

    • setStatementDescriptor

      public ProductUpdateParams.Builder setStatementDescriptor(EmptyParam statementDescriptor)
      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.

    • setTaxCode

      public ProductUpdateParams.Builder setTaxCode(String taxCode)
      A tax code ID.
    • setTaxCode

      public ProductUpdateParams.Builder setTaxCode(EmptyParam taxCode)
      A tax code ID.
    • setUnitLabel

      public ProductUpdateParams.Builder setUnitLabel(String unitLabel)
      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.
    • setUnitLabel

      public ProductUpdateParams.Builder setUnitLabel(EmptyParam unitLabel)
      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.
    • setUrl

      public ProductUpdateParams.Builder setUrl(String url)
      A URL of a publicly-accessible webpage for this product.
    • setUrl

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