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
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
//! Subscriptions API
//!
//! Create and manage subscriptions.
//!
//! Subscriptions enable sellers to generate a reliable cash flow and recurring revenue to grow
//! their businesses. Square offers the Subscriptions API for developers to embed subscription
//! functionality in their applications. You first create a subscription plan using the Catalog API
//! and then use the Subscriptions API to create and manage subscriptions.
use crate::models::{
BulkSwapPlanRequest, BulkSwapPlanResponse, ChangeBillingAnchorDateRequest,
ChangeBillingAnchorDateResponse,
};
use crate::{
SquareClient,
config::Configuration,
http::client::HttpClient,
models::{
CancelSubscriptionResponse, CreateSubscriptionRequest, CreateSubscriptionResponse,
DeleteSubscriptionActionResponse, ListSubscriptionEventsParameters,
ListSubscriptionEventsResponse, PauseSubscriptionRequest, PauseSubscriptionResponse,
ResumeSubscriptionRequest, ResumeSubscriptionResponse, RetrieveSubscriptionParameters,
RetrieveSubscriptionResponse, SearchSubscriptionsRequest, SearchSubscriptionsResponse,
SwapPlanRequest, SwapPlanResponse, UpdateSubscriptionRequest, UpdateSubscriptionResponse,
errors::SquareApiError,
},
};
const DEFAULT_URI: &str = "/subscriptions";
/// Create and manage subscriptions.
pub struct SubscriptionsApi {
/// App config information
config: Configuration,
/// HTTP Client for requests to the Subscriptions API endpoints
http_client: HttpClient,
}
impl SubscriptionsApi {
/// Instantiates a new `SubscriptionsApi`
pub fn new(square_client: SquareClient) -> SubscriptionsApi {
SubscriptionsApi {
config: square_client.config,
http_client: square_client.http_client,
}
}
/// Creates a subscription to a subscription plan by a customer.
///
/// If you provide a card on file in the request, Square charges the card for the subscription.
/// Otherwise, Square bills an invoice to the customer's email address. The subscription starts
/// immediately, unless the request includes the optional `start_date`. Each individual
/// subscription is associated with a particular location.
pub async fn create_subscription(
&self,
body: &CreateSubscriptionRequest,
) -> Result<CreateSubscriptionResponse, SquareApiError> {
let response = self.http_client.post(&self.url(), body).await?;
response.deserialize().await
}
/// Schedules a plan variation change for all active subscriptions under a given plan variation.
pub async fn bulk_swap_plan(
&self,
body: &BulkSwapPlanRequest,
) -> Result<BulkSwapPlanResponse, SquareApiError> {
let url = format!("{}/bulk-swap-plan", &self.url());
let response = self.http_client.post(&url, body).await?;
response.deserialize().await
}
/// Searches for subscriptions.
///
/// Results are ordered chronologically by subscription creation date. If the request specifies
/// more than one location ID, the endpoint orders the result by location ID, and then by
/// creation date within each location. If no locations are given in the query, all locations
/// are searched.
///
/// You can also optionally specify `customer_ids` to search by customer. If left unset, all
/// customers associated with the specified locations are returned. If the request specifies
/// customer IDs, the endpoint orders results first by location, within location by customer ID,
/// and within customer by subscription creation date.
///
/// For more information, see [Retrieve
/// subscriptions](https://developer.squareup.com/docs/subscriptions-api/overview#retrieve-subscriptions).
pub async fn search_subscriptions(
&self,
body: &SearchSubscriptionsRequest,
) -> Result<SearchSubscriptionsResponse, SquareApiError> {
let url = format!("{}/search", &self.url());
let response = self.http_client.post(&url, body).await?;
response.deserialize().await
}
/// Retrieves a subscription.
pub async fn retrieve_subscription(
&self,
subscription_id: impl AsRef<str>,
params: &RetrieveSubscriptionParameters,
) -> Result<RetrieveSubscriptionResponse, SquareApiError> {
let url = format!(
"{}/{}{}",
&self.url(),
subscription_id.as_ref(),
params.to_query_string()
);
let response = self.http_client.get(&url).await?;
response.deserialize().await
}
/// Updates a subscription.
///
/// You can set, modify, and clear the `subscription` field values.
pub async fn update_subscription(
&self,
subscription_id: impl AsRef<str>,
body: &UpdateSubscriptionRequest,
) -> Result<UpdateSubscriptionResponse, SquareApiError> {
let url = format!("{}/{}", &self.url(), subscription_id.as_ref());
let response = self.http_client.put(&url, body).await?;
response.deserialize().await
}
/// Deletes a scheduled action for a subscription.
pub async fn delete_subscription_action(
&self,
subscription_id: impl AsRef<str>,
action_id: impl AsRef<str>,
) -> Result<DeleteSubscriptionActionResponse, SquareApiError> {
let url = format!(
"{}/{}/actions/{}",
&self.url(),
subscription_id.as_ref(),
action_id.as_ref()
);
let response = self.http_client.delete(&url).await?;
response.deserialize().await
}
/// Changes the billing anchor date for a subscription.
pub async fn change_billing_anchor_date(
&self,
subscription_id: impl AsRef<str>,
body: &ChangeBillingAnchorDateRequest,
) -> Result<ChangeBillingAnchorDateResponse, SquareApiError> {
let url = format!(
"{}/{}/billing-anchor",
&self.url(),
subscription_id.as_ref()
);
let response = self.http_client.post(&url, body).await?;
response.deserialize().await
}
/// Schedules a `CANCEL` action to cancel an active subscription by setting the `canceled_date`
/// field to the end of the active billing period and changing the subscription status from
/// ACTIVE to CANCELED after this date.
pub async fn cancel_subscription(
&self,
subscription_id: impl AsRef<str>,
) -> Result<CancelSubscriptionResponse, SquareApiError> {
let url = format!("{}/{}/cancel", &self.url(), subscription_id.as_ref());
let response = self.http_client.empty_post(&url).await?;
response.deserialize().await
}
/// Lists all events for a specific subscription.
pub async fn list_subscription_events(
&self,
subscription_id: impl AsRef<str>,
params: &ListSubscriptionEventsParameters,
) -> Result<ListSubscriptionEventsResponse, SquareApiError> {
let url = format!(
"{}/{}/events{}",
&self.url(),
subscription_id.as_ref(),
params.to_query_string()
);
let response = self.http_client.get(&url).await?;
response.deserialize().await
}
/// Schedules a `PAUSE` action to pause an active subscription.
pub async fn pause_subscription(
&self,
subscription_id: impl AsRef<str>,
body: &PauseSubscriptionRequest,
) -> Result<PauseSubscriptionResponse, SquareApiError> {
let url = format!("{}/{}/pause", &self.url(), subscription_id.as_ref());
let response = self.http_client.post(&url, body).await?;
response.deserialize().await
}
/// Schedules a `RESUME` action to resume a paused or a deactivated subscription.
pub async fn resume_subscription(
&self,
subscription_id: impl AsRef<str>,
body: &ResumeSubscriptionRequest,
) -> Result<ResumeSubscriptionResponse, SquareApiError> {
let url = format!("{}/{}/resume", &self.url(), subscription_id.as_ref());
let response = self.http_client.post(&url, body).await?;
response.deserialize().await
}
/// Schedules a `SWAP_PLAN` action to swap a subscription plan in an existing subscription.
pub async fn swap_plan(
&self,
subscription_id: impl AsRef<str>,
body: &SwapPlanRequest,
) -> Result<SwapPlanResponse, SquareApiError> {
let url = format!("{}/{}/swap-plan", &self.url(), subscription_id.as_ref());
let response = self.http_client.post(&url, body).await?;
response.deserialize().await
}
/// Constructs the basic entity URL including domain and entity path. Any additional path
/// elements (e.g. path parameters) will need to be appended to this URL.
fn url(&self) -> String {
format!("{}{}", &self.config.get_base_url(), DEFAULT_URI)
}
}