Class PlanCreateParams.Product.Builder

  • Enclosing class:
    PlanCreateParams.Product

    public static class PlanCreateParams.Product.Builder
    extends java.lang.Object
    • Constructor Detail

      • Builder

        public Builder()
    • Method Detail

      • setActive

        public PlanCreateParams.Product.Builder setActive​(java.lang.Boolean active)
        Whether the product is currently available for purchase. Defaults to true.
      • putExtraParam

        public PlanCreateParams.Product.Builder putExtraParam​(java.lang.String key,
                                                              java.lang.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 PlanCreateParams.Product.extraParams for the field documentation.
      • putAllExtraParam

        public PlanCreateParams.Product.Builder putAllExtraParam​(java.util.Map<java.lang.String,​java.lang.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 PlanCreateParams.Product.extraParams for the field documentation.
      • setId

        public PlanCreateParams.Product.Builder setId​(java.lang.String id)
        The identifier for the product. Must be unique. If not provided, an identifier will be randomly generated.
      • putMetadata

        public PlanCreateParams.Product.Builder putMetadata​(java.lang.String key,
                                                            java.lang.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 PlanCreateParams.Product.metadata for the field documentation.
      • putAllMetadata

        public PlanCreateParams.Product.Builder putAllMetadata​(java.util.Map<java.lang.String,​java.lang.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 PlanCreateParams.Product.metadata for the field documentation.
      • setName

        public PlanCreateParams.Product.Builder setName​(java.lang.String name)
        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.
      • setStatementDescriptor

        public PlanCreateParams.Product.Builder setStatementDescriptor​(java.lang.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.