Class PlanCreateParams.Product

Enclosing class:

public static class PlanCreateParams.Product extends Object
  • Method Details

    • builder

      public static PlanCreateParams.Product.Builder builder()
    • getActive

      public Boolean getActive()
      Whether the product is currently available for purchase. Defaults to true.
    • 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.
    • getId

      public String getId()
      The identifier for the product. Must be unique. If not provided, an identifier will be randomly generated.
    • getMetadata

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

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

    • getTaxCode

      public String getTaxCode()
      A tax code ID.
    • getUnitLabel

      public String getUnitLabel()
      A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.