stripe_create_plan: Create a Plan

Description Usage Arguments Value Examples

View source: R/plans.R

Description

Create a new plan on your stripe account.

Usage

1

Arguments

api_key

Your Stripe API Key

args

A list which must contain

id

The id of the plan to use. e.g. 'gold'

amount

required The amount in cents to charge.

currency

required 3-letter ISO code for currency.

interval

required Specifies billing frequencey. day, week month, year.

name

required The name of plan. Appears on invoice.

metadata

optional A list which can contain anything to further describe.

trial_period_days

optional Specifies trial period in day.

interval_count

optional intervals in billing. e.g. 3 if interval=month

statement_description

optional String to appear on invoice. Up to 15 characters

Value

A data frame with the new plan info if successful.

Examples

1
2
3
## Not run: stripe_create_plan("sk_test_BQokikJOvBiI2HlWgH4olfQ2",
list(id="example-gold", amount=3000, currency="usd", interval="month"))
## End(Not run)

RStripe documentation built on May 2, 2019, 7:45 a.m.