Package com.stripe.param

Class ProductCreateParams

    • Method Detail

      • getActive

        public java.lang.Boolean getActive()
        Whether the product is currently available for purchase. Defaults to true.

      • getAttributes

        public java.util.List<java.lang.String> getAttributes()
        A list of up to 5 alphanumeric attributes. Should only be set if type=good.

      • getCaption

        public java.lang.String 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.String 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.

      • getId

        public java.lang.String getId()
        An identifier will be randomly generated by Stripe. You can optionally override this ID, but the ID must be unique across all products in your Stripe account.

      • getImages

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

      • getMetadata

        public java.util.Map<java.lang.String,​java.lang.String> 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.String 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.

      • getShippable

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

      • getStatementDescriptor

        public java.lang.String 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.

      • getTaxCode

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

      • getType

        public ProductCreateParams.Type getType()
        The type of the product. Defaults to service if not explicitly specified, enabling use of this product with Subscriptions and Plans. Set this parameter to good to use this product with Orders and SKUs. On API versions before 2018-02-05, this field defaults to good for compatibility reasons.

      • getUnitLabel

        public java.lang.String 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.

      • getUrl

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