Struct ListCustomer

pub struct ListCustomer { /* private fields */ }

Returns a list of your customers. The customers are returned sorted by creation date, with the most recent customers appearing first.

Implementations

impl ListCustomer

pub fn new() -> Self

Construct a new ListCustomer.

pub fn created(self, created: impl Into<RangeQueryTs>) -> Self

Only return customers that were created during the given date interval.

pub fn email(self, email: impl Into<String>) -> Self

A case-sensitive filter on the list based on the customer’s email field. The value must be a string.

pub fn ending_before(self, ending_before: impl Into<String>) -> Self

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.

pub fn expand(self, expand: impl Into<Vec<String>>) -> Self

Specifies which fields in the response should be expanded.

pub fn limit(self, limit: impl Into<i64>) -> Self

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

pub fn starting_after(self, starting_after: impl Into<String>) -> Self

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.

pub fn test_clock(self, test_clock: impl Into<String>) -> Self

Provides a list of customers that are associated with the specified test clock. The response will not include customers with test clocks if this parameter is not set.

impl ListCustomer

pub async fn send<C: StripeClient>( &self, client: &C, ) -> Result<<Self as StripeRequest>::Output, C::Err>

Send the request and return the deserialized response.

pub fn send_blocking<C: StripeBlockingClient>( &self, client: &C, ) -> Result<<Self as StripeRequest>::Output, C::Err>

Send the request and return the deserialized response, blocking until completion.

pub fn paginate(&self) -> ListPaginator<List<Customer>>

Trait Implementations

impl Clone for ListCustomer

fn clone(&self) -> ListCustomer

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ListCustomer

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ListCustomer

fn default() -> Self

Returns the “default value” for a type.

impl Serialize for ListCustomer

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StripeRequest for ListCustomer

type Output = List<Customer>

The data returned from the eventual API call.

fn build(&self) -> RequestBuilder

Convert the struct into library-agnostic data that can be used by compatible clients to make API calls.

fn customize(&self) -> CustomizableStripeRequest<Self::Output>

Convert to a builder allowing per-request customization.