com.stripe.param

Class PromotionCodeListParams

java.lang.Object

com.stripe.net.ApiRequestParams

com.stripe.param.PromotionCodeListParams

public class PromotionCodeListParams
extends ApiRequestParams

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PromotionCodeListParams.Builder
static class	PromotionCodeListParams.Created

Nested classes/interfaces inherited from class com.stripe.net.ApiRequestParams

ApiRequestParams.EnumParam

Field Summary

Fields inherited from class com.stripe.net.ApiRequestParams

EXTRA_PARAMS_KEY

Method Summary

Modifier and Type	Method and Description
static PromotionCodeListParams.Builder	builder()
java.lang.Boolean	getActive() Filter promotion codes by whether they are active.
java.lang.String	getCode() Only return promotion codes that have this case-insensitive code.
java.lang.String	getCoupon() Only return promotion codes for this coupon.
java.lang.Object	getCreated() A filter on the list, based on the object created field.
java.lang.String	getCustomer() Only return promotion codes that are restricted to this customer.
java.lang.String	getEndingBefore() A cursor for use in pagination.
java.util.List<java.lang.String>	getExpand() Specifies which fields in the response should be expanded.
java.util.Map<java.lang.String,java.lang.Object>	getExtraParams() Map of extra parameters for custom features not available in this client library.
java.lang.Long	getLimit() A limit on the number of objects to be returned.
java.lang.String	getStartingAfter() A cursor for use in pagination.

Methods inherited from class com.stripe.net.ApiRequestParams

toMap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static PromotionCodeListParams.Builder builder()

getActive

public java.lang.Boolean getActive()

Filter promotion codes by whether they are active.

getCode

public java.lang.String getCode()

Only return promotion codes that have this case-insensitive code.

getCoupon

public java.lang.String getCoupon()

Only return promotion codes for this coupon.

getCreated

public java.lang.Object getCreated()

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.

getCustomer

public java.lang.String getCustomer()

Only return promotion codes that are restricted to this customer.

getEndingBefore

public java.lang.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 java.util.List<java.lang.String> getExpand()

Specifies which fields in the response should be expanded.

getExtraParams

public java.util.Map<java.lang.String,java.lang.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.

getLimit

public java.lang.Long getLimit()

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

getStartingAfter

public java.lang.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.