Package com.stripe.param

Class ProductListParams

java.lang.Object
com.stripe.net.ApiRequestParams
com.stripe.param.ProductListParams
public class ProductListParams extends ApiRequestParams

  • Method Details

    • builder

      public static ProductListParams.Builder builder()

    • getActive

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

    • getCreated

      public Object getCreated()
      Only return products that were created during the given date interval.

    • getEndingBefore

      public String getEndingBefore()
      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.

    • getExpand

      public List<String> getExpand()
      Specifies which fields in the response should be expanded.

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

    • getIds

      public List<String> getIds()
      Only return products with the given IDs. Cannot be used with starting_after or ending_before.

    • getLimit

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

    • getShippable

      public Boolean getShippable()
      Only return products that can be shipped (i.e., physical, not digital products).

    • getStartingAfter

      public String getStartingAfter()
      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.

    • getType

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

    • getUrl

      public String getUrl()
      Only return products with the given url.