update_customer: Polished Payments API - Update a Customer

View source: R/api_customers.R

update_customerR Documentation

Polished Payments API - Update a Customer

Description

Polished Payments API - Update a Customer

Usage

update_customer(
  customer_uid,
  stripe_subscription_id = NULL,
  free_trial_days_remaining_at_cancel = NULL,
  default_payment_method = NULL,
  cancel_subscription = FALSE,
  is_live = .pp$is_live,
  api_key = polished::get_api_key()
)

Arguments

customer_uid

The polished payments customer UID.

stripe_subscription_id

the Stripe subscription ID.

free_trial_days_remaining_at_cancel

The number of days remaining in the customer's free subscription trial at time of cancelation.

default_payment_method

the Stripe payment method ID for the customer's default payment method.

cancel_subscription

boolean - whether or not to cancel the existing subscription.

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.

See Also

[get_customers()] [add_customer()]


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