Package com.stripe.param

Class PlanCreateParams.Product

  • Enclosing class:
    PlanCreateParams
    public static class PlanCreateParams.Product
extends java.lang.Object

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static PlanCreateParams.Product.Builder builder()  
      java.lang.Boolean getActive()
      Whether the product is currently available for purchase.
      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.String getId()
      The identifier for the product.
      java.util.Map<java.lang.String,​java.lang.String> getMetadata()
      Set of key-value pairs that you can attach to an object.
      java.lang.String getName()
      The product's name, meant to be displayable to the customer.
      java.lang.String getStatementDescriptor()
      An arbitrary string to be displayed on your customer's credit card or bank statement.
      java.lang.String getUnitLabel()
      A label that represents units of this product in Stripe and on customers’ receipts and invoices.

      • 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 currently available for purchase. Defaults to true.

      • 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()
        The identifier for the product. Must be unique. If not provided, an identifier will be randomly generated.

      • 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.

      • 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.

      • 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.