Package com.stripe.param
Class PromotionCodeListParams.Builder
java.lang.Object
com.stripe.param.PromotionCodeListParams.Builder
- Enclosing class:
- PromotionCodeListParams
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddAllExpand
(List<String> elements) Add all elements to `expand` list.Add an element to `expand` list.build()
Finalize and obtain parameter instance from this builder.putAllExtraParam
(Map<String, Object> map) Add all map key/value pairs to `extraParams` map.putExtraParam
(String key, Object value) Add a key/value pair to `extraParams` map.Filter promotion codes by whether they are active.Only return promotion codes that have this case-insensitive code.Only return promotion codes for this coupon.A filter on the list, based on the objectcreated
field.setCreated
(Long created) A filter on the list, based on the objectcreated
field.setCustomer
(String customer) Only return promotion codes that are restricted to this customer.setCustomerAccount
(String customerAccount) Only return promotion codes that are restricted to this account.setEndingBefore
(String endingBefore) A cursor for use in pagination.A limit on the number of objects to be returned.setStartingAfter
(String startingAfter) A cursor for use in pagination.
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
build
Finalize and obtain parameter instance from this builder. -
setActive
Filter promotion codes by whether they are active. -
setCode
Only return promotion codes that have this case-insensitive code. -
setCoupon
Only return promotion codes for this coupon. -
setCreated
A filter on the list, based on the objectcreated
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
A filter on the list, based on the objectcreated
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. -
setCustomer
Only return promotion codes that are restricted to this customer. -
setCustomerAccount
Only return promotion codes that are restricted to this account. -
setEndingBefore
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 withobj_bar
, your subsequent call can includeending_before=obj_bar
in order to fetch the previous page of the list. -
addExpand
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. SeePromotionCodeListParams.expand
for the field documentation. -
addAllExpand
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. SeePromotionCodeListParams.expand
for the field documentation. -
putExtraParam
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. SeePromotionCodeListParams.extraParams
for the field documentation. -
putAllExtraParam
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. SeePromotionCodeListParams.extraParams
for the field documentation. -
setLimit
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. -
setStartingAfter
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 withobj_foo
, your subsequent call can includestarting_after=obj_foo
in order to fetch the next page of the list.
-