stripe_customer: Customer object

In MrDAndersen/stRipe: Wrapper for Stripe API

Customer object

Description

The stripe_customer object represents the data that is required to manage customers at Stripe. This object allows you to perform recurring charges and track multiple charges that are associated with the same customer. You can use this object to create, delete, and update customers.

Format

An R6 object class

Methods

• create: Create a new customer

• update: Update customer information

• retrieve: Retrieve information on existing customer.

• delete: Delete a customer

Methods

Public methods

• stripe_customer$new()

• stripe_customer$create()

• stripe_customer$retrieve()

• stripe_customer$update()

• stripe_customer$delete()

• stripe_customer$clone()

---

Method new()

Usage

stripe_customer$new(
  ...,
  metadata = NULL,
  discount = NULL,
  shipping = NULL,
  sources = NULL,
  subscriptions = NULL
)

---

Method create()

Usage

stripe_customer$create(
  account_balance = NULL,
  business_vat_id = NULL,
  description = NULL,
  email = NULL,
  plan = NULL,
  quantity = NULL,
  tax_percent = NULL,
  trial_end = NULL,
  coupon = NULL,
  metadata = list(),
  ship_name = NULL,
  ship_city = NULL,
  ship_country = NULL,
  ship_line1 = NULL,
  ship_line2 = NULL,
  ship_state = NULL,
  ship_zip = NULL,
  ship_phone = NULL,
  card_token = NULL,
  exp_month = NULL,
  exp_year = NULL,
  number = NULL,
  cvc = NULL,
  name = NULL,
  address_city = NULL,
  address_country = NULL,
  address_line1 = NULL,
  address_line2 = NULL,
  address_state = NULL,
  address_zip = NULL,
  currency = NULL,
  default_for_currency = NULL,
  card_metadata = list(),
  idempotency_key = NULL
)

---

Method retrieve()

Usage

stripe_customer$retrieve(customer_id)

---

Method update()

Usage

stripe_customer$update(
  account_balance = NULL,
  business_vat_id = NULL,
  metadata = list(),
  default_source = NULL,
  coupon = NULL,
  description = NULL,
  email = NULL,
  ship_name = NULL,
  ship_city = NULL,
  ship_country = NULL,
  ship_line1 = NULL,
  ship_line2 = NULL,
  ship_state = NULL,
  ship_zip = NULL,
  ship_phone = NULL,
  token = NULL,
  exp_month = NULL,
  exp_year = NULL,
  number = NULL,
  cvc = NULL,
  name = NULL,
  address_city = NULL,
  address_country = NULL,
  address_line1 = NULL,
  address_line2 = NULL,
  address_state = NULL,
  address_zip = NULL,
  currency = NULL,
  default_for_currency = NULL,
  card_metadata = list()
)

---

Method delete()

Usage

stripe_customer$delete(customer_id)

---

Method clone()

The objects of this class are cloneable with this method.

Usage

stripe_customer$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

MrDAndersen/stRipe documentation built on March 17, 2024, 7:25 p.m.