get_customers: Polished Payments API - Get Customer(s)

In Tychobra/polishedpayments: Easily add a Stripe subscription to your Shiny app

Polished Payments API - Get Customer(s)

Description

Polished Payments API - Get Customer(s)

Usage

get_customers(
  app_uid = NULL,
  user_uid = NULL,
  is_live = .pp$is_live,
  api_key = polished::get_api_key()
)

Arguments

app_uid	an optional app uid.
user_uid	an optional user uid.
is_live	whether or not the Stripe key is live or test mode.
api_key	your Polished API key. Set your polished api key using set_api_key() so that you do not need to supply this argument with each function call.

Details

If both the app_uid and user_uid are NULL, then all the customers in your account will be returned. If only app_uid is not NULL, then all customers for a single app will be returned. If only user_uid is not NULL then all customers for that user will be returned (a user can have multiple customers for multiple apps). If app_uid and user_uid are provided, then one customer will be returned (assuming that customer exists). If the customer does not exists, a zero row tibble will be returned.

Value

an object of class polished_api_res. The "content" of the object is a tibble of app(s) with the following columns: - uid - app_name - app_url - created_at - modified_at

See Also

[add_customer()] [update_customer()]

Tychobra/polishedpayments documentation built on May 13, 2022, 7:15 p.m.