Package com.stripe.param

Class PriceUpdateParams.Builder

java.lang.Object
com.stripe.param.PriceUpdateParams.Builder
Enclosing class:
PriceUpdateParams
public static class PriceUpdateParams.Builder extends Object

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • build

      public PriceUpdateParams build()
      Finalize and obtain parameter instance from this builder.

    • setActive

      public PriceUpdateParams.Builder setActive(Boolean active)
      Whether the price can be used for new purchases. Defaults to true.

    • putCurrencyOption

      public PriceUpdateParams.Builder putCurrencyOption(String key, PriceUpdateParams.CurrencyOption value)
      Add a key/value pair to `currencyOptions` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. See PriceUpdateParams.currencyOptions for the field documentation.

    • putAllCurrencyOption

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

    • setCurrencyOptions

      public PriceUpdateParams.Builder setCurrencyOptions(EmptyParam currencyOptions)
      Prices defined in each available currency option. Each key must be a three-letter ISO currency code and a supported currency.

    • setCurrencyOptions

      public PriceUpdateParams.Builder setCurrencyOptions(Map<String,PriceUpdateParams.CurrencyOption> currencyOptions)
      Prices defined in each available currency option. Each key must be a three-letter ISO currency code and a supported currency.

    • addExpand

      public PriceUpdateParams.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 PriceUpdateParams.expand for the field documentation.

    • addAllExpand

      public PriceUpdateParams.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 PriceUpdateParams.expand for the field documentation.

    • putExtraParam

      public PriceUpdateParams.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 PriceUpdateParams.extraParams for the field documentation.

    • putAllExtraParam

      public PriceUpdateParams.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 PriceUpdateParams.extraParams for the field documentation.

    • setLookupKey

      public PriceUpdateParams.Builder setLookupKey(String lookupKey)
      A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.

    • setLookupKey

      public PriceUpdateParams.Builder setLookupKey(EmptyParam lookupKey)
      A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.

    • putMetadata

      public PriceUpdateParams.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 PriceUpdateParams.metadata for the field documentation.

    • putAllMetadata

      public PriceUpdateParams.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 PriceUpdateParams.metadata for the field documentation.

    • setMetadata

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

    • setNickname

      public PriceUpdateParams.Builder setNickname(String nickname)
      A brief description of the price, hidden from customers.

    • setNickname

      public PriceUpdateParams.Builder setNickname(EmptyParam nickname)
      A brief description of the price, hidden from customers.

    • setTaxBehavior

      public PriceUpdateParams.Builder setTaxBehavior(PriceUpdateParams.TaxBehavior taxBehavior)
      Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified. Once specified as either inclusive or exclusive, it cannot be changed.

    • setTransferLookupKey

      public PriceUpdateParams.Builder setTransferLookupKey(Boolean transferLookupKey)
      If set to true, will atomically remove the lookup key from the existing price, and assign it to this price.