Package com.stripe.param

Class MarginCreateParams.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • build

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

    • setActive

      public MarginCreateParams.Builder setActive(Boolean active)
      Whether the margin can be applied to invoices, invoice items, or invoice line items or not. Defaults to true.

    • addExpand

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

    • addAllExpand

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

    • putExtraParam

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

    • putAllExtraParam

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

    • putMetadata

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

    • putAllMetadata

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

    • setName

      public MarginCreateParams.Builder setName(String name)
      Name of the margin, which is displayed to customers, such as on invoices.

    • setPercentOff

      public MarginCreateParams.Builder setPercentOff(BigDecimal percentOff)
      Required. Percent that will be taken off the subtotal before tax (after all other discounts and promotions) of any invoice to which the margin is applied.