com.stripe.param

Class InvoiceListParams

java.lang.Object

com.stripe.net.ApiRequestParams

com.stripe.param.InvoiceListParams

public class InvoiceListParams
extends ApiRequestParams

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	InvoiceListParams.Builder
static class	InvoiceListParams.CollectionMethod Maximum value to filter by (inclusive).
static class	InvoiceListParams.Created
static class	InvoiceListParams.DueDate Maximum value to filter by (inclusive).
static class	InvoiceListParams.Status

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 InvoiceListParams.Builder	builder()
InvoiceListParams.CollectionMethod	getCollectionMethod() The collection method of the invoice to retrieve.
java.lang.Object	getCreated()
java.lang.String	getCustomer() Only return invoices for the customer specified by this customer ID.
java.lang.Object	getDueDate()
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.
InvoiceListParams.Status	getStatus() The status of the invoice, one of `draft`, `open`, `paid`, `uncollectible`, or `void`.
java.lang.String	getSubscription() Only return invoices for the subscription specified by this subscription ID.

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 InvoiceListParams.Builder builder()

getCollectionMethod

public InvoiceListParams.CollectionMethod getCollectionMethod()

The collection method of the invoice to retrieve. Either `charge_automatically` or `send_invoice`.

getCreated

public java.lang.Object getCreated()

getCustomer

public java.lang.String getCustomer()

Only return invoices for the customer specified by this customer ID.

getDueDate

public java.lang.Object getDueDate()

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.

getStatus

public InvoiceListParams.Status getStatus()

The status of the invoice, one of `draft`, `open`, `paid`, `uncollectible`, or `void`. [Learn more](https://stripe.com/docs/billing/invoices/workflow#workflow-overview)

getSubscription

public java.lang.String getSubscription()

Only return invoices for the subscription specified by this subscription ID.