stripe_update_subscription: Update a subscription.

Description Usage Arguments Value

View source: R/subscriptions.R

Description

Update the information for a subscription on a customer.

Usage

1
stripe_update_subscription(api_key, customer_id, subscription_id, args)

Arguments

api_key

Your Stripe API Key

customer_id

The id of the customer with the subscription.

subscription_id

The id of the subscription you want to update.

args

which includes:

plan

required The plan id

coupon

optional A coupon to apply to this subscription.

prorate

optional Flag whether to prorate plan when switched. defaults: true.

trial_end

optional When the trial ends. Unix timestamp to override plan. You can use now to make it end now.

card

optional A token or card dictionary to use instead of default. required if customer has no card.

quantity

optional Quantity to place in subscription.

application_fee_percent

optional A decimal 1 to 100 for percentage of amount.

metadata

optional A list which can contain anything to further describe.

Value

A data frame with the updated subscription info if successful.


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