blob: 08946039e300c37e3d4ef90b40639b3bdf8562d0 (
plain)
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
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
|
openapi: 3.0.0
info:
title: solidus_subscriptions
version: '1.0'
servers:
- url: 'http://localhost:3000'
paths:
'/api/orders/{order_id}/line_items':
parameters:
- schema:
type: string
name: order_id
in: path
required: true
post:
summary: Create Subscription Line Item
tags:
- Subscription Line Items
responses: {}
operationId: post-api-orders-order_id-line_items
requestBody:
content:
application/json:
schema:
type: object
properties:
subscription_line_item:
$ref: '#/components/schemas/SubscriptionLineItem'
'/subscriptions/api/v1/line_items/{id}':
parameters:
- schema:
type: string
name: id
in: path
required: true
patch:
summary: Update Subscription Line Item
tags:
- Subscription Line Items
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/SubscriptionLineItemOutput'
operationId: patch-subscriptions-api-v1-line_item-id
requestBody:
content:
application/json:
schema:
type: object
properties:
subscription_line_item:
$ref: '#/components/schemas/SubscriptionLineItem'
delete:
summary: Delete Subscription Line Item
operationId: delete-subscriptions-api-v1-line_item-id
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/SubscriptionLineItemOutput'
description: ''
tags:
- Subscription Line Items
'/subscriptions/api/v1/subscriptions/:id/skip':
post:
summary: Skip Subscription
tags:
- Subscriptions
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/SubscriptionOutput'
operationId: 'post-subscriptions-api-v1-subscriptions-:id-skip'
'/subscriptions/api/v1/subscriptions/{id}/cancel':
parameters:
- schema:
type: string
name: id
in: path
required: true
post:
summary: Cancel Subscription
tags:
- Subscriptions
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/SubscriptionOutput'
operationId: post-subscriptions-api-v1-subscriptions-id-cancel
'/subscriptions/api/v1/subscriptions/{id}':
parameters:
- schema:
type: string
name: id
in: path
required: true
patch:
summary: Update Subscription
tags:
- Subscriptions
responses:
'200':
description: OK
content:
application/json:
schema:
allOf:
- type: object
properties:
line_items:
type: array
items:
$ref: '#/components/schemas/SubscriptionLineItemOutput'
shipping_address:
type: object
billing_address:
type: object
- $ref: '#/components/schemas/SubscriptionOutput'
operationId: patch-subscriptions-api-v1-subscriptions-id
requestBody:
content:
application/json:
schema:
type: object
properties:
subscription:
allOf:
- type: object
properties:
line_items_attributes:
type: array
items:
$ref: '#/components/schemas/SubscriptionLineItem'
shipping_address_attributes:
type: object
billing_address_attributes:
type: object
- $ref: '#/components/schemas/Subscription'
'/subscriptions/api/v1/subscriptions/{id}/activate':
parameters:
- schema:
type: string
name: id
in: path
required: true
post:
summary: Activate Subscription
tags:
- Subscriptions
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/SubscriptionOutput'
operationId: post-subscriptions-api-v1-subscriptions-id-activate
components:
schemas:
SubscriptionLineItem:
title: SubscriptionLineItem
type: object
properties:
quantity:
type: integer
minimum: 1
end_date:
type: string
format: date
interval_length:
type: integer
minimum: 1
interval_units:
type: string
enum:
- day
- week
- month
- year
subscribable_id:
type: integer
required:
- quantity
- end_date
- interval_length
- interval_units
- subscribable_id
x-tags:
- Models
SubscriptionLineItemOutput:
title: SubscriptionLineItemOutput
allOf:
- $ref: '#/components/schemas/SubscriptionLineItem'
- type: object
properties:
id:
type: integer
spree_line_item_id:
type: integer
subscription_id:
type: integer
created_at:
type: string
format: date-time
updated_at:
type: string
format: date-time
required:
- id
- spree_line_item_id
- subscription_id
- created_at
- updated_at
x-tags:
- Models
Subscription:
title: Subscription
type: object
x-tags:
- Models
properties:
actionable_date:
type: string
format: date
interval_units:
type: string
enum:
- day
- week
- month
- year
interval_length:
type: string
end_date:
type: string
format: date
required:
- actionable_date
- interval_units
- interval_length
- end_date
SubscriptionOutput:
title: SubscriptionOutput
allOf:
- $ref: '#/components/schemas/Subscription'
- type: object
properties:
id:
type: integer
created_at:
type: string
format: date-time
updated_at:
type: string
format: date-time
state:
type: string
enum:
- active
- canceled
- pending_cancellation
- inactive
user_id:
type: integer
processing_state:
type: string
enum:
- pending
- success
- failed
required:
- id
- created_at
- updated_at
- state
- user_id
- processing_state
x-tags:
- Models
|