Package com.stripe.param

Class ProductListParams.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • build

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

    • setActive

      public ProductListParams.Builder setActive(Boolean active)
      Only return products that are active or inactive (e.g., pass false to list all inactive products).

    • setCreated

      public ProductListParams.Builder setCreated(ProductListParams.Created created)
      Only return products that were created during the given date interval.

    • setCreated

      public ProductListParams.Builder setCreated(Long created)
      Only return products that were created during the given date interval.

    • setEndingBefore

      public ProductListParams.Builder setEndingBefore(String endingBefore)
      A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.

    • addExpand

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

    • addAllExpand

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

    • putExtraParam

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

    • putAllExtraParam

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

    • addId

      public ProductListParams.Builder addId(String element)
      Add an element to `ids` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See ProductListParams.ids for the field documentation.

    • addAllId

      public ProductListParams.Builder addAllId(List<String> elements)
      Add all elements to `ids` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See ProductListParams.ids for the field documentation.

    • setLimit

      public ProductListParams.Builder setLimit(Long limit)
      A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

    • setShippable

      public ProductListParams.Builder setShippable(Boolean shippable)
      Only return products that can be shipped (i.e., physical, not digital products).

    • setStartingAfter

      public ProductListParams.Builder setStartingAfter(String startingAfter)
      A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

    • setType

      public ProductListParams.Builder setType(ProductListParams.Type type)
      Only return products of this type.

    • setUrl

      public ProductListParams.Builder setUrl(String url)
      Only return products with the given url.