sq_list_customers: List Customers

Description Usage Arguments Details Value Examples

View source: R/customers.R

Description

Lists a business's customers.

Usage

1
sq_list_customers(cursor = NULL, verbose = FALSE)

Arguments

cursor

character; A pagination cursor returned by a previous call to this endpoint. Typically this is not needed because functions in the package will automatically paginate results.

verbose

logical; do you want informative messages?

Details

Required permissions: CUSTOMERS_READ. Note, The ListCustomers endpoint actually doesn't list instant profiles (profiles created via Square, not explicitly by you).

Value

tbl_df of customers

Examples

1
2
3
4
## Not run: 
my_customers <- sq_list_customers()

## End(Not run)

StevenMMortimer/squareupr documentation built on July 12, 2019, 1:45 a.m.