stripe_checkout_session: Checkout Session Object

In MrDAndersen/stRipe: Wrapper for Stripe API

Checkout Session Object

Description

The stripe_checkout_session represents your customer's session as they pay for one-time purchases or subscriptions through Checkout or Payment Links. We recommend creating a new Session each time your customer attempts to pay.

Format

An R6 Class object

Methods

• create: Creates a checkout_session on Stripe.

• retrieve: Retrieves checkout_session information from Stripe based on the id passed to the method.

Methods

Public methods

• stripe_checkout_session$new()

• stripe_checkout_session$create()

• stripe_checkout_session$retrieve()

• stripe_checkout_session$clone()

---

Method new()

Usage

stripe_checkout_session$new(..., metadata = list())

---

Method create()

Usage

stripe_checkout_session$create(
  client_reference_id = NULL,
  customer = NULL,
  customer_email = NULL,
  currency = NULL,
  price = NULL,
  quantity = NULL,
  metadata = list(),
  mode = NULL,
  success_url = NULL
)

---

Method retrieve()

Usage

stripe_checkout_session$retrieve(checkout_session_id)

---

Method clone()

The objects of this class are cloneable with this method.

Usage

stripe_checkout_session$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

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