PriceListParams.Builder (stripe-java 19.32.0 API)

java.lang.Object
- com.stripe.param.PriceListParams.Builder

Enclosing class:: PriceListParams

public static class PriceListParams.Builder
extends java.lang.Object

Constructor Summary

Constructors
Constructor and Description

Builder()

Constructors
Constructor and Description
`Builder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PriceListParams.Builder`	`addAllExpand(java.util.List<java.lang.String> elements)` Add all elements to `expand` list.
`PriceListParams.Builder`	`addAllLookupKeys(java.util.List<java.lang.String> elements)` Add all elements to `lookupKeys` list.
`PriceListParams.Builder`	`addExpand(java.lang.String element)` Add an element to `expand` list.
`PriceListParams.Builder`	`addLookupKeys(java.lang.String element)` Add an element to `lookupKeys` list.
`PriceListParams`	`build()` Finalize and obtain parameter instance from this builder.
`PriceListParams.Builder`	`putAllExtraParam(java.util.Map<java.lang.String,java.lang.Object> map)` Add all map key/value pairs to `extraParams` map.
`PriceListParams.Builder`	`putExtraParam(java.lang.String key, java.lang.Object value)` Add a key/value pair to `extraParams` map.
`PriceListParams.Builder`	`setActive(java.lang.Boolean active)` Only return prices that are active or inactive (e.g., pass `false` to list all inactive prices).
`PriceListParams.Builder`	`setCreated(java.lang.Long created)` A filter on the list, based on the object `created` field.
`PriceListParams.Builder`	`setCreated(PriceListParams.Created created)` A filter on the list, based on the object `created` field.
`PriceListParams.Builder`	`setCurrency(java.lang.String currency)` Only return prices for the given currency.
`PriceListParams.Builder`	`setEndingBefore(java.lang.String endingBefore)` A cursor for use in pagination.
`PriceListParams.Builder`	`setLimit(java.lang.Long limit)` A limit on the number of objects to be returned.
`PriceListParams.Builder`	`setProduct(java.lang.String product)` Only return prices for the given product.
`PriceListParams.Builder`	`setRecurring(PriceListParams.Recurring recurring)` Only return prices with these recurring fields.
`PriceListParams.Builder`	`setStartingAfter(java.lang.String startingAfter)` A cursor for use in pagination.
`PriceListParams.Builder`	`setType(PriceListParams.Type type)` Only return prices of type `recurring` or `one_time`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Builder
```
public Builder()
```
- Method Detail
  - build
```
public PriceListParams build()
```
    Finalize and obtain parameter instance from this builder.
  - setActive
```
public PriceListParams.Builder setActive(java.lang.Boolean active)
```
    Only return prices that are active or inactive (e.g., pass false to list all inactive prices).
  - setCreated
```
public PriceListParams.Builder setCreated(PriceListParams.Created created)
```
    A filter on the list, based on the object created field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.
  - setCreated
```
public PriceListParams.Builder setCreated(java.lang.Long created)
```
    A filter on the list, based on the object created field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.
  - setCurrency
```
public PriceListParams.Builder setCurrency(java.lang.String currency)
```
    Only return prices for the given currency.
  - setEndingBefore
```
public PriceListParams.Builder setEndingBefore(java.lang.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 PriceListParams.Builder addExpand(java.lang.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 PriceListParams.expand for the field documentation.
  - addAllExpand
```
public PriceListParams.Builder addAllExpand(java.util.List<java.lang.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 PriceListParams.expand for the field documentation.
  - putExtraParam
```
public PriceListParams.Builder putExtraParam(java.lang.String key,
                                             java.lang.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 PriceListParams.extraParams for the field documentation.
  - putAllExtraParam
```
public PriceListParams.Builder putAllExtraParam(java.util.Map<java.lang.String,java.lang.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 PriceListParams.extraParams for the field documentation.
  - setLimit
```
public PriceListParams.Builder setLimit(java.lang.Long limit)
```
    A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
  - addLookupKeys
```
public PriceListParams.Builder addLookupKeys(java.lang.String element)
```
    Add an element to `lookupKeys` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See PriceListParams.lookupKeys for the field documentation.
  - addAllLookupKeys
```
public PriceListParams.Builder addAllLookupKeys(java.util.List<java.lang.String> elements)
```
    Add all elements to `lookupKeys` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See PriceListParams.lookupKeys for the field documentation.
  - setProduct
```
public PriceListParams.Builder setProduct(java.lang.String product)
```
    Only return prices for the given product.
  - setRecurring
```
public PriceListParams.Builder setRecurring(PriceListParams.Recurring recurring)
```
    Only return prices with these recurring fields.
  - setStartingAfter
```
public PriceListParams.Builder setStartingAfter(java.lang.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 PriceListParams.Builder setType(PriceListParams.Type type)
```
    Only return prices of type recurring or one_time.

Class PriceListParams.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

build

setActive

setCreated

setCreated

setCurrency

setEndingBefore

addExpand

addAllExpand

putExtraParam

putAllExtraParam

setLimit

addLookupKeys

addAllLookupKeys

setProduct

setRecurring

setStartingAfter

setType