/
subscriptions.R
198 lines (158 loc) · 5.16 KB
/
subscriptions.R
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
## https://stripe.com/docs/api/curl#subscriptions
#' Create a subscription for a customer
#'
#' @param customerId The ID of the customer
#' @param plan ID of the plan to subscribe customer to
#' @param coupon A discount on recurring charges
#' @param source A token from \link{get_token}
#' @param quantity Default is 1
#' @param metadata A named list
#' @param tax_percent Postive decimal
#' @param trial_end Unix timestamp or 'now'
#'
#' @details
#' Not implemented: application_fee_percent
#'
#' @return List object
#'
#' @family subscriptions
#' @export
create_subscription <- function(customerId,
plan,
coupon=NULL,
source=NULL,
quantity=NULL,
metadata=NULL,
tax_percent=NULL,
trial_end=NULL
){
url <- sprintf("https://api.stripe.com/v1/customers/%s/subscriptions", customerId)
the_body <- list(plan=plan,
coupon=coupon,
source=source,
quantity=quantity,
metadata=metadata,
tax_percent=tax_percent,
trial_end=trial_end)
if(!is.null(metadata)){
the_body <- c(the_body, make_meta(metadata))
}
req <- do_request(url,
request_type="POST",
the_body = the_body)
req
}
#' Retrieve a subscription
#'
#' @param customerId The ID of the customer
#' @param subscriptionId The ID of the subscription
#'
#' @return List object
#'
#' @family subscriptions
#' @export
get_subscription <- function(customerId, subscriptionId){
url <- sprintf("https://api.stripe.com/v1/customers/%s/subscriptions/%s",
customerId,
subscriptionId)
req <- do_request(url, "GET")
req
}
#' Update a subscription for a customer
#'
#' @param subscriptionId The ID of the subscription
#' @param customerId The ID of the customer
#' @param plan ID of the plan to subscribe customer to
#' @param prorate Whether to prorate switching plans during billing cycle
#' @param proration_date Timestamp of proration effective. Default current time
#' @param coupon A discount on recurring charges
#' @param source A token from \link{get_token}
#' @param quantity Default is 1
#' @param metadata A named list
#' @param tax_percent Postive decimal
#' @param trial_end Unix timestamp or 'now'
#'
#' @details
#' Not implemented: application_fee_percent
#'
#' @return List object
#'
#' @family subscriptions
#' @export
update_subscription <- function(subscriptionId,
customerId,
plan=NULL,
prorate=TRUE,
proration_date=NULL,
coupon=NULL,
source=NULL,
quantity=NULL,
metadata=NULL,
tax_percent=NULL,
trial_end=NULL
){
prorate <- ifelse(prorate, "true", "false")
url <- sprintf("https://api.stripe.com/v1/customers/%s/subscriptions/%s",
customerId,
subscriptionId)
the_body <- list(plan=plan,
prorate=prorate,
proration_date=proration_date,
coupon=coupon,
source=source,
quantity=quantity,
metadata=metadata,
tax_percent=tax_percent,
trial_end=trial_end)
if(!is.null(metadata)){
the_body <- c(the_body, make_meta(metadata))
}
req <- do_request(url,
request_type="POST",
the_body = the_body)
req
}
#' Cancel a subscription
#'
#' @param customerId The ID of the customer
#' @param subscriptionId The ID of the subscription
#' @param at_period_end Default FALSE. Delay cancellation to end of billing period.
#'
#' @return List object
#'
#' @family subscriptions
#' @export
cancel_subscription <- function(customerId, subscriptionId, at_period_end=FALSE){
at_period_end <- ifelse(at_period_end, "true", "false")
url <- sprintf("https://api.stripe.com/v1/customers/%s/subscriptions/%s",
customerId,
subscriptionId)
req <- do_request(url, "DELETE")
req
}
#' List a customer's subscriptions
#'
#' @param customerId The ID of the customer
#' @param ending_before filter for pagination
#' @param limit Between 1 and 100
#' @param starting_before filter for pagination
#'
#' @return List object
#'
#' @family subscriptions
#' @export
list_subscriptions <- function(customerId,
ending_before=NULL,
limit=10,
starting_before=NULL){
params <- list(
ending_before=ending_before,
limit=limit,
starting_before=starting_before
)
url <- sprintf("https://api.stripe.com/v1/customers/%s/subscriptions", customerId)
url <- httr::modify_url(url,
query = params)
req <- do_request(url, "GET")
req
}