@volter/twin-stripe 0.1.2 → 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (219) hide show
  1. package/README.md +64 -27
  2. package/client/dashboard-api.ts +286 -0
  3. package/client/stripe-mirror.css +272 -159
  4. package/client/stripe-mirror.tsx +1384 -541
  5. package/dist/client/dashboard-api.d.ts +107 -0
  6. package/dist/client/dashboard-api.js +238 -0
  7. package/dist/client/dashboard-api.ts +286 -0
  8. package/dist/client/stripe-mirror.bundle.js +236 -0
  9. package/dist/client/stripe-mirror.css +275 -0
  10. package/dist/client/stripe-mirror.d.ts +134 -0
  11. package/dist/client/stripe-mirror.js +823 -0
  12. package/dist/client/stripe-mirror.tsx +1534 -0
  13. package/dist/src/cli.d.ts +2 -0
  14. package/dist/src/cli.js +39 -0
  15. package/dist/src/generated/events.gen.json +1 -0
  16. package/dist/src/generated/surface.gen.json +1 -0
  17. package/dist/src/generated/ui.gen.json +1 -0
  18. package/dist/src/index.d.ts +14 -0
  19. package/dist/src/index.js +73 -0
  20. package/dist/src/manifest.d.ts +2 -0
  21. package/dist/src/manifest.js +1065 -0
  22. package/dist/src/screens/checkout.d.ts +31 -0
  23. package/dist/src/screens/checkout.js +241 -0
  24. package/dist/src/screens/consent-skin.d.ts +4 -0
  25. package/dist/src/screens/consent-skin.js +18 -0
  26. package/dist/src/screens/financial-connections.d.ts +5 -0
  27. package/dist/src/screens/financial-connections.js +90 -0
  28. package/dist/src/screens/identity.d.ts +5 -0
  29. package/dist/src/screens/identity.js +86 -0
  30. package/dist/src/screens/industries.d.ts +1 -0
  31. package/dist/src/screens/industries.js +267 -0
  32. package/dist/src/screens/onboarding.d.ts +13 -0
  33. package/dist/src/screens/onboarding.js +225 -0
  34. package/dist/src/screens/portal.d.ts +5 -0
  35. package/dist/src/screens/portal.js +214 -0
  36. package/dist/src/screens/public-details.d.ts +5 -0
  37. package/dist/src/screens/public-details.js +90 -0
  38. package/dist/src/semantics/after-payment.d.ts +22 -0
  39. package/dist/src/semantics/after-payment.js +93 -0
  40. package/dist/src/semantics/apps-secrets.d.ts +2 -0
  41. package/dist/src/semantics/apps-secrets.js +54 -0
  42. package/dist/src/semantics/balance.d.ts +11 -0
  43. package/dist/src/semantics/balance.js +195 -0
  44. package/dist/src/semantics/billing.d.ts +2 -0
  45. package/dist/src/semantics/billing.js +220 -0
  46. package/dist/src/semantics/charges.d.ts +28 -0
  47. package/dist/src/semantics/charges.js +201 -0
  48. package/dist/src/semantics/checkout.d.ts +15 -0
  49. package/dist/src/semantics/checkout.js +303 -0
  50. package/dist/src/semantics/connect.d.ts +5 -0
  51. package/dist/src/semantics/connect.js +476 -0
  52. package/dist/src/semantics/coupons.d.ts +6 -0
  53. package/dist/src/semantics/coupons.js +92 -0
  54. package/dist/src/semantics/credit-notes.d.ts +2 -0
  55. package/dist/src/semantics/credit-notes.js +172 -0
  56. package/dist/src/semantics/customers.d.ts +6 -0
  57. package/dist/src/semantics/customers.js +429 -0
  58. package/dist/src/semantics/disputes.d.ts +2 -0
  59. package/dist/src/semantics/disputes.js +51 -0
  60. package/dist/src/semantics/entitlements.d.ts +2 -0
  61. package/dist/src/semantics/entitlements.js +95 -0
  62. package/dist/src/semantics/ephemeral-keys.d.ts +2 -0
  63. package/dist/src/semantics/ephemeral-keys.js +34 -0
  64. package/dist/src/semantics/files.d.ts +2 -0
  65. package/dist/src/semantics/files.js +125 -0
  66. package/dist/src/semantics/invoices.d.ts +18 -0
  67. package/dist/src/semantics/invoices.js +541 -0
  68. package/dist/src/semantics/issuing.d.ts +13 -0
  69. package/dist/src/semantics/issuing.js +570 -0
  70. package/dist/src/semantics/ledger.d.ts +54 -0
  71. package/dist/src/semantics/ledger.js +181 -0
  72. package/dist/src/semantics/payment-intents.d.ts +18 -0
  73. package/dist/src/semantics/payment-intents.js +404 -0
  74. package/dist/src/semantics/payment-links.d.ts +2 -0
  75. package/dist/src/semantics/payment-links.js +133 -0
  76. package/dist/src/semantics/payment-methods.d.ts +20 -0
  77. package/dist/src/semantics/payment-methods.js +138 -0
  78. package/dist/src/semantics/plans.d.ts +5 -0
  79. package/dist/src/semantics/plans.js +121 -0
  80. package/dist/src/semantics/platform.d.ts +9 -0
  81. package/dist/src/semantics/platform.js +206 -0
  82. package/dist/src/semantics/products.d.ts +2 -0
  83. package/dist/src/semantics/products.js +140 -0
  84. package/dist/src/semantics/radar.d.ts +2 -0
  85. package/dist/src/semantics/radar.js +83 -0
  86. package/dist/src/semantics/refunds.d.ts +9 -0
  87. package/dist/src/semantics/refunds.js +195 -0
  88. package/dist/src/semantics/renewals.d.ts +47 -0
  89. package/dist/src/semantics/renewals.js +251 -0
  90. package/dist/src/semantics/setup-intents.d.ts +2 -0
  91. package/dist/src/semantics/setup-intents.js +84 -0
  92. package/dist/src/semantics/shared.d.ts +78 -0
  93. package/dist/src/semantics/shared.js +192 -0
  94. package/dist/src/semantics/subscription-schedules.d.ts +2 -0
  95. package/dist/src/semantics/subscription-schedules.js +119 -0
  96. package/dist/src/semantics/subscriptions.d.ts +11 -0
  97. package/dist/src/semantics/subscriptions.js +605 -0
  98. package/dist/src/semantics/tax.d.ts +2 -0
  99. package/dist/src/semantics/tax.js +197 -0
  100. package/dist/src/semantics/terminal.d.ts +5 -0
  101. package/dist/src/semantics/terminal.js +182 -0
  102. package/dist/src/semantics/test-clocks.d.ts +6 -0
  103. package/dist/src/semantics/test-clocks.js +73 -0
  104. package/dist/src/semantics/tokens.d.ts +4 -0
  105. package/dist/src/semantics/tokens.js +44 -0
  106. package/dist/src/semantics/transfers.d.ts +2 -0
  107. package/dist/src/semantics/transfers.js +154 -0
  108. package/dist/src/semantics/treasury.d.ts +2 -0
  109. package/dist/src/semantics/treasury.js +377 -0
  110. package/dist/src/semantics/webhook-endpoints.d.ts +3 -0
  111. package/dist/src/semantics/webhook-endpoints.js +85 -0
  112. package/dist/src/stripe-budget.d.ts +55 -0
  113. package/dist/src/stripe-budget.js +155 -0
  114. package/dist/src/stripe-capabilities.d.ts +3 -0
  115. package/dist/src/stripe-capabilities.js +5052 -0
  116. package/dist/src/stripe-conformance.d.ts +41 -0
  117. package/dist/src/stripe-conformance.js +96 -0
  118. package/dist/src/stripe-connector.d.ts +161 -0
  119. package/dist/src/stripe-connector.js +414 -0
  120. package/dist/src/stripe-emit.d.ts +2 -0
  121. package/dist/src/stripe-emit.js +145 -0
  122. package/dist/src/stripe-events.d.ts +93 -0
  123. package/dist/src/stripe-events.js +388 -0
  124. package/dist/src/stripe-js.d.ts +4 -0
  125. package/dist/src/stripe-js.js +70 -0
  126. package/dist/src/stripe-mirror-ui.d.ts +15 -0
  127. package/dist/src/stripe-mirror-ui.js +87 -0
  128. package/dist/src/stripe-params.d.ts +3 -0
  129. package/dist/src/stripe-params.js +43 -0
  130. package/dist/src/stripe-perform-harness.d.ts +9 -0
  131. package/dist/src/stripe-perform-harness.js +26 -0
  132. package/dist/src/stripe-server.d.ts +33 -0
  133. package/dist/src/stripe-server.js +326 -0
  134. package/dist/src/stripe-shared.d.ts +106 -0
  135. package/dist/src/stripe-shared.js +273 -0
  136. package/dist/src/stripe-twin.d.ts +155 -0
  137. package/dist/src/stripe-twin.js +1226 -0
  138. package/dist/src/stripe-ui-conformance.d.ts +5 -0
  139. package/dist/src/stripe-ui-conformance.js +79 -0
  140. package/dist/src/stripe-ui-structure.d.ts +3 -0
  141. package/dist/src/stripe-ui-structure.js +168 -0
  142. package/dist/src/stripe-version.d.ts +10 -0
  143. package/dist/src/stripe-version.js +285 -0
  144. package/dist/test-fixtures/stripe-known-deviations.json +105 -0
  145. package/dist/test-fixtures/stripe-openapi-operations.SOURCE.md +14 -0
  146. package/dist/test-fixtures/stripe-openapi-operations.json +4717 -0
  147. package/dist/test-fixtures/stripe-schemas.SOURCE.md +35 -0
  148. package/dist/test-fixtures/stripe-schemas.json +3740 -0
  149. package/package.json +18 -10
  150. package/src/cli.ts +7 -7
  151. package/src/generated/events.gen.json +1 -0
  152. package/src/generated/surface.gen.json +1 -0
  153. package/src/generated/ui.gen.json +1 -0
  154. package/src/index.ts +31 -9
  155. package/src/manifest.ts +1097 -0
  156. package/src/screens/checkout.tsx +252 -0
  157. package/src/screens/consent-skin.ts +20 -0
  158. package/src/screens/financial-connections.tsx +101 -0
  159. package/src/screens/identity.tsx +96 -0
  160. package/src/screens/industries.ts +267 -0
  161. package/src/screens/onboarding.tsx +243 -0
  162. package/src/screens/portal.tsx +218 -0
  163. package/src/screens/public-details.tsx +105 -0
  164. package/src/semantics/after-payment.ts +113 -0
  165. package/src/semantics/apps-secrets.ts +58 -0
  166. package/src/semantics/balance.ts +209 -0
  167. package/src/semantics/billing.ts +216 -0
  168. package/src/semantics/charges.ts +211 -0
  169. package/src/semantics/checkout.ts +297 -0
  170. package/src/semantics/connect.ts +471 -0
  171. package/src/semantics/coupons.ts +97 -0
  172. package/src/semantics/credit-notes.ts +168 -0
  173. package/src/semantics/customers.ts +432 -0
  174. package/src/semantics/disputes.ts +62 -0
  175. package/src/semantics/entitlements.ts +94 -0
  176. package/src/semantics/ephemeral-keys.ts +34 -0
  177. package/src/semantics/files.ts +143 -0
  178. package/src/semantics/invoices.ts +541 -0
  179. package/src/semantics/issuing.ts +585 -0
  180. package/src/semantics/ledger.ts +216 -0
  181. package/src/semantics/payment-intents.ts +420 -0
  182. package/src/semantics/payment-links.ts +148 -0
  183. package/src/semantics/payment-methods.ts +143 -0
  184. package/src/semantics/plans.ts +131 -0
  185. package/src/semantics/platform.ts +220 -0
  186. package/src/semantics/products.ts +154 -0
  187. package/src/semantics/radar.ts +85 -0
  188. package/src/semantics/refunds.ts +218 -0
  189. package/src/semantics/renewals.ts +274 -0
  190. package/src/semantics/setup-intents.ts +87 -0
  191. package/src/semantics/shared.ts +215 -0
  192. package/src/semantics/subscription-schedules.ts +129 -0
  193. package/src/semantics/subscriptions.ts +610 -0
  194. package/src/semantics/tax.ts +220 -0
  195. package/src/semantics/terminal.ts +195 -0
  196. package/src/semantics/test-clocks.ts +77 -0
  197. package/src/semantics/tokens.ts +52 -0
  198. package/src/semantics/transfers.ts +174 -0
  199. package/src/semantics/treasury.ts +383 -0
  200. package/src/semantics/webhook-endpoints.ts +87 -0
  201. package/src/stripe-budget.ts +4 -4
  202. package/src/stripe-capabilities.ts +1456 -222
  203. package/src/stripe-conformance.ts +6 -5
  204. package/src/stripe-connector.ts +68 -40
  205. package/src/stripe-emit.ts +14 -7
  206. package/src/stripe-events.ts +94 -36
  207. package/src/stripe-js.ts +70 -0
  208. package/src/stripe-mirror-ui.ts +28 -298
  209. package/src/stripe-params.ts +44 -0
  210. package/src/stripe-perform-harness.ts +29 -0
  211. package/src/stripe-server.ts +263 -38
  212. package/src/stripe-shared.ts +294 -0
  213. package/src/stripe-twin.ts +429 -5325
  214. package/src/stripe-ui-conformance.ts +70 -107
  215. package/src/stripe-ui-structure.ts +124 -348
  216. package/src/stripe-version.ts +278 -0
  217. package/test-fixtures/stripe-known-deviations.json +2 -7
  218. package/test-fixtures/stripe-openapi-operations.json +1188 -2855
  219. package/src/stripe-form.ts +0 -35
@@ -0,0 +1,4717 @@
1
+ {
2
+ "openapi": "3.0.3",
3
+ "info": {
4
+ "title": "Stripe API (spec-census scoped subset)",
5
+ "version": "2026-08-26.dahlia",
6
+ "description": "A scope-filtered SUBSET of the upstream spec (https://github.com/stripe/openapi), derived by scripts/spec-census-bootstrap.ts: every operation under the committed scopePaths, operation metadata only (operationId, summary, tags) \u2014 schemas AND response codes dropped, which makes this an operation INVENTORY in OpenAPI's shape rather than a valid OpenAPI document: it says which operations exist and nothing about what they answer. It carried the FIRST response code per operation, which reads as the whole set \u2014 diff status codes against the freshly fetched spec instead. It is ONLY the operation-inventory denominator for ../stripe-spec-census.json; see stripe-openapi-operations.SOURCE.md for provenance."
7
+ },
8
+ "x-source": {
9
+ "vendor": "stripe",
10
+ "upstream": "https://github.com/stripe/openapi",
11
+ "upstreamFile": "openapi/spec3.json",
12
+ "vendored": "derived by scripts/spec-census-bootstrap.ts from openapi/spec3.json fetched 2026-09-01 \u2014 scope-filtered to scopePaths, schemas and response codes dropped",
13
+ "curatedOn": "2026-09-01",
14
+ "scope": "/v1/account, /v1/account_links, /v1/account_sessions, /v1/accounts, /v1/application_fees, /v1/balance, /v1/balance_transactions, /v1/billing, /v1/billing_portal, /v1/charges, /v1/checkout, /v1/climate, /v1/coupons, /v1/credit_notes, /v1/crypto, /v1/customer_balance_transactions, /v1/customers, /v1/disputes, /v1/entitlements, /v1/ephemeral_keys, /v1/events, /v1/file_links, /v1/files, /v1/financial_connections, /v1/forwarding, /v1/identity, /v1/invoiceitems, /v1/invoices, /v1/mandates, /v1/payment_intents, /v1/payment_links, /v1/payment_methods, /v1/payouts, /v1/prices, /v1/products, /v1/promotion_codes, /v1/quotes, /v1/radar, /v1/refunds, /v1/reporting, /v1/reviews, /v1/setup_intents, /v1/sources, /v1/subscription_items, /v1/subscription_schedules, /v1/subscriptions, /v1/tax, /v1/tax_ids, /v1/tax_rates, /v1/test_helpers, /v1/tokens, /v1/topups, /v1/transfers, /v1/treasury, /v1/webhook_endpoints"
15
+ },
16
+ "paths": {
17
+ "/v1/account": {
18
+ "get": {
19
+ "operationId": "GetAccount",
20
+ "summary": "Retrieve account",
21
+ "tags": [
22
+ "account"
23
+ ]
24
+ }
25
+ },
26
+ "/v1/account_links": {
27
+ "post": {
28
+ "operationId": "PostAccountLinks",
29
+ "summary": "Create an account link",
30
+ "tags": [
31
+ "account_links"
32
+ ]
33
+ }
34
+ },
35
+ "/v1/account_sessions": {
36
+ "post": {
37
+ "operationId": "PostAccountSessions",
38
+ "summary": "Create an Account Session",
39
+ "tags": [
40
+ "account_sessions"
41
+ ]
42
+ }
43
+ },
44
+ "/v1/accounts": {
45
+ "get": {
46
+ "operationId": "GetAccounts",
47
+ "summary": "List all connected accounts",
48
+ "tags": [
49
+ "accounts"
50
+ ]
51
+ },
52
+ "post": {
53
+ "operationId": "PostAccounts",
54
+ "summary": "Create an account",
55
+ "tags": [
56
+ "accounts"
57
+ ]
58
+ }
59
+ },
60
+ "/v1/accounts/{account}": {
61
+ "delete": {
62
+ "operationId": "DeleteAccountsAccount",
63
+ "summary": "Delete an account",
64
+ "tags": [
65
+ "accounts"
66
+ ]
67
+ },
68
+ "get": {
69
+ "operationId": "GetAccountsAccount",
70
+ "summary": "Retrieve account",
71
+ "tags": [
72
+ "accounts"
73
+ ]
74
+ },
75
+ "post": {
76
+ "operationId": "PostAccountsAccount",
77
+ "summary": "Update an account",
78
+ "tags": [
79
+ "accounts"
80
+ ]
81
+ }
82
+ },
83
+ "/v1/accounts/{account}/bank_accounts": {
84
+ "post": {
85
+ "operationId": "PostAccountsAccountBankAccounts",
86
+ "summary": "Create an external account",
87
+ "tags": [
88
+ "accounts"
89
+ ]
90
+ }
91
+ },
92
+ "/v1/accounts/{account}/bank_accounts/{id}": {
93
+ "delete": {
94
+ "operationId": "DeleteAccountsAccountBankAccountsId",
95
+ "summary": "Delete an external account",
96
+ "tags": [
97
+ "accounts"
98
+ ]
99
+ },
100
+ "get": {
101
+ "operationId": "GetAccountsAccountBankAccountsId",
102
+ "summary": "Retrieve an external account",
103
+ "tags": [
104
+ "accounts"
105
+ ]
106
+ },
107
+ "post": {
108
+ "operationId": "PostAccountsAccountBankAccountsId",
109
+ "summary": "Update a bank account",
110
+ "tags": [
111
+ "accounts"
112
+ ]
113
+ }
114
+ },
115
+ "/v1/accounts/{account}/capabilities": {
116
+ "get": {
117
+ "operationId": "GetAccountsAccountCapabilities",
118
+ "summary": "List all account capabilities",
119
+ "tags": [
120
+ "accounts"
121
+ ]
122
+ }
123
+ },
124
+ "/v1/accounts/{account}/capabilities/{capability}": {
125
+ "get": {
126
+ "operationId": "GetAccountsAccountCapabilitiesCapability",
127
+ "summary": "Retrieve an Account Capability",
128
+ "tags": [
129
+ "accounts"
130
+ ]
131
+ },
132
+ "post": {
133
+ "operationId": "PostAccountsAccountCapabilitiesCapability",
134
+ "summary": "Update an Account Capability",
135
+ "tags": [
136
+ "accounts"
137
+ ]
138
+ }
139
+ },
140
+ "/v1/accounts/{account}/external_accounts": {
141
+ "get": {
142
+ "operationId": "GetAccountsAccountExternalAccounts",
143
+ "summary": "List all external accounts",
144
+ "tags": [
145
+ "accounts"
146
+ ]
147
+ },
148
+ "post": {
149
+ "operationId": "PostAccountsAccountExternalAccounts",
150
+ "summary": "Create an external account",
151
+ "tags": [
152
+ "accounts"
153
+ ]
154
+ }
155
+ },
156
+ "/v1/accounts/{account}/external_accounts/{id}": {
157
+ "delete": {
158
+ "operationId": "DeleteAccountsAccountExternalAccountsId",
159
+ "summary": "Delete an external account",
160
+ "tags": [
161
+ "accounts"
162
+ ]
163
+ },
164
+ "get": {
165
+ "operationId": "GetAccountsAccountExternalAccountsId",
166
+ "summary": "Retrieve an external account",
167
+ "tags": [
168
+ "accounts"
169
+ ]
170
+ },
171
+ "post": {
172
+ "operationId": "PostAccountsAccountExternalAccountsId",
173
+ "summary": "Update a bank account",
174
+ "tags": [
175
+ "accounts"
176
+ ]
177
+ }
178
+ },
179
+ "/v1/accounts/{account}/login_links": {
180
+ "post": {
181
+ "operationId": "PostAccountsAccountLoginLinks",
182
+ "summary": "Create a login link",
183
+ "tags": [
184
+ "accounts"
185
+ ]
186
+ }
187
+ },
188
+ "/v1/accounts/{account}/people": {
189
+ "get": {
190
+ "operationId": "GetAccountsAccountPeople",
191
+ "summary": "List all persons",
192
+ "tags": [
193
+ "accounts"
194
+ ]
195
+ },
196
+ "post": {
197
+ "operationId": "PostAccountsAccountPeople",
198
+ "summary": "Create a person",
199
+ "tags": [
200
+ "accounts"
201
+ ]
202
+ }
203
+ },
204
+ "/v1/accounts/{account}/people/{person}": {
205
+ "delete": {
206
+ "operationId": "DeleteAccountsAccountPeoplePerson",
207
+ "summary": "Delete a person",
208
+ "tags": [
209
+ "accounts"
210
+ ]
211
+ },
212
+ "get": {
213
+ "operationId": "GetAccountsAccountPeoplePerson",
214
+ "summary": "Retrieve a person",
215
+ "tags": [
216
+ "accounts"
217
+ ]
218
+ },
219
+ "post": {
220
+ "operationId": "PostAccountsAccountPeoplePerson",
221
+ "summary": "Update a person",
222
+ "tags": [
223
+ "accounts"
224
+ ]
225
+ }
226
+ },
227
+ "/v1/accounts/{account}/persons": {
228
+ "get": {
229
+ "operationId": "GetAccountsAccountPersons",
230
+ "summary": "List all persons",
231
+ "tags": [
232
+ "accounts"
233
+ ]
234
+ },
235
+ "post": {
236
+ "operationId": "PostAccountsAccountPersons",
237
+ "summary": "Create a person",
238
+ "tags": [
239
+ "accounts"
240
+ ]
241
+ }
242
+ },
243
+ "/v1/accounts/{account}/persons/{person}": {
244
+ "delete": {
245
+ "operationId": "DeleteAccountsAccountPersonsPerson",
246
+ "summary": "Delete a person",
247
+ "tags": [
248
+ "accounts"
249
+ ]
250
+ },
251
+ "get": {
252
+ "operationId": "GetAccountsAccountPersonsPerson",
253
+ "summary": "Retrieve a person",
254
+ "tags": [
255
+ "accounts"
256
+ ]
257
+ },
258
+ "post": {
259
+ "operationId": "PostAccountsAccountPersonsPerson",
260
+ "summary": "Update a person",
261
+ "tags": [
262
+ "accounts"
263
+ ]
264
+ }
265
+ },
266
+ "/v1/accounts/{account}/reject": {
267
+ "post": {
268
+ "operationId": "PostAccountsAccountReject",
269
+ "summary": "Reject an account",
270
+ "tags": [
271
+ "accounts"
272
+ ]
273
+ }
274
+ },
275
+ "/v1/accounts/{account}/unreject": {
276
+ "post": {
277
+ "operationId": "PostAccountsAccountUnreject",
278
+ "summary": "Unreject an account",
279
+ "tags": [
280
+ "accounts"
281
+ ]
282
+ }
283
+ },
284
+ "/v1/application_fees": {
285
+ "get": {
286
+ "operationId": "GetApplicationFees",
287
+ "summary": "List all application fees",
288
+ "tags": [
289
+ "application_fees"
290
+ ]
291
+ }
292
+ },
293
+ "/v1/application_fees/{fee}/refunds/{id}": {
294
+ "get": {
295
+ "operationId": "GetApplicationFeesFeeRefundsId",
296
+ "summary": "Retrieve an application fee refund",
297
+ "tags": [
298
+ "application_fees"
299
+ ]
300
+ },
301
+ "post": {
302
+ "operationId": "PostApplicationFeesFeeRefundsId",
303
+ "summary": "Update an application fee refund",
304
+ "tags": [
305
+ "application_fees"
306
+ ]
307
+ }
308
+ },
309
+ "/v1/application_fees/{id}": {
310
+ "get": {
311
+ "operationId": "GetApplicationFeesId",
312
+ "summary": "Retrieve an application fee",
313
+ "tags": [
314
+ "application_fees"
315
+ ]
316
+ }
317
+ },
318
+ "/v1/application_fees/{id}/refund": {
319
+ "post": {
320
+ "operationId": "PostApplicationFeesIdRefund",
321
+ "summary": "",
322
+ "tags": [
323
+ "application_fees"
324
+ ]
325
+ }
326
+ },
327
+ "/v1/application_fees/{id}/refunds": {
328
+ "get": {
329
+ "operationId": "GetApplicationFeesIdRefunds",
330
+ "summary": "List all application fee refunds",
331
+ "tags": [
332
+ "application_fees"
333
+ ]
334
+ },
335
+ "post": {
336
+ "operationId": "PostApplicationFeesIdRefunds",
337
+ "summary": "Create an application fee refund",
338
+ "tags": [
339
+ "application_fees"
340
+ ]
341
+ }
342
+ },
343
+ "/v1/balance": {
344
+ "get": {
345
+ "operationId": "GetBalance",
346
+ "summary": "Retrieve balance",
347
+ "tags": [
348
+ "balance"
349
+ ]
350
+ }
351
+ },
352
+ "/v1/balance_settings": {
353
+ "get": {
354
+ "operationId": "GetBalanceSettings",
355
+ "summary": "Retrieve balance settings",
356
+ "tags": [
357
+ "balance_settings"
358
+ ]
359
+ },
360
+ "post": {
361
+ "operationId": "PostBalanceSettings",
362
+ "summary": "Update balance settings",
363
+ "tags": [
364
+ "balance_settings"
365
+ ]
366
+ }
367
+ },
368
+ "/v1/balance_transactions": {
369
+ "get": {
370
+ "operationId": "GetBalanceTransactions",
371
+ "summary": "List all balance transactions",
372
+ "tags": [
373
+ "balance_transactions"
374
+ ]
375
+ }
376
+ },
377
+ "/v1/balance_transactions/{id}": {
378
+ "get": {
379
+ "operationId": "GetBalanceTransactionsId",
380
+ "summary": "Retrieve a balance transaction",
381
+ "tags": [
382
+ "balance_transactions"
383
+ ]
384
+ }
385
+ },
386
+ "/v1/balance/history": {
387
+ "get": {
388
+ "operationId": "GetBalanceHistory",
389
+ "summary": "List all balance transactions",
390
+ "tags": [
391
+ "balance"
392
+ ]
393
+ }
394
+ },
395
+ "/v1/balance/history/{id}": {
396
+ "get": {
397
+ "operationId": "GetBalanceHistoryId",
398
+ "summary": "Retrieve a balance transaction",
399
+ "tags": [
400
+ "balance"
401
+ ]
402
+ }
403
+ },
404
+ "/v1/billing_portal/configurations": {
405
+ "get": {
406
+ "operationId": "GetBillingPortalConfigurations",
407
+ "summary": "List portal configurations",
408
+ "tags": [
409
+ "billing_portal"
410
+ ]
411
+ },
412
+ "post": {
413
+ "operationId": "PostBillingPortalConfigurations",
414
+ "summary": "Create a portal configuration",
415
+ "tags": [
416
+ "billing_portal"
417
+ ]
418
+ }
419
+ },
420
+ "/v1/billing_portal/configurations/{configuration}": {
421
+ "get": {
422
+ "operationId": "GetBillingPortalConfigurationsConfiguration",
423
+ "summary": "Retrieve a portal configuration",
424
+ "tags": [
425
+ "billing_portal"
426
+ ]
427
+ },
428
+ "post": {
429
+ "operationId": "PostBillingPortalConfigurationsConfiguration",
430
+ "summary": "Update a portal configuration",
431
+ "tags": [
432
+ "billing_portal"
433
+ ]
434
+ }
435
+ },
436
+ "/v1/billing_portal/sessions": {
437
+ "post": {
438
+ "operationId": "PostBillingPortalSessions",
439
+ "summary": "Create a portal session",
440
+ "tags": [
441
+ "billing_portal"
442
+ ]
443
+ }
444
+ },
445
+ "/v1/billing/alerts": {
446
+ "get": {
447
+ "operationId": "GetBillingAlerts",
448
+ "summary": "List billing alerts",
449
+ "tags": [
450
+ "billing"
451
+ ]
452
+ },
453
+ "post": {
454
+ "operationId": "PostBillingAlerts",
455
+ "summary": "Create a billing alert",
456
+ "tags": [
457
+ "billing"
458
+ ]
459
+ }
460
+ },
461
+ "/v1/billing/alerts/{id}": {
462
+ "get": {
463
+ "operationId": "GetBillingAlertsId",
464
+ "summary": "Retrieve a billing alert",
465
+ "tags": [
466
+ "billing"
467
+ ]
468
+ }
469
+ },
470
+ "/v1/billing/alerts/{id}/activate": {
471
+ "post": {
472
+ "operationId": "PostBillingAlertsIdActivate",
473
+ "summary": "Activate a billing alert",
474
+ "tags": [
475
+ "billing"
476
+ ]
477
+ }
478
+ },
479
+ "/v1/billing/alerts/{id}/archive": {
480
+ "post": {
481
+ "operationId": "PostBillingAlertsIdArchive",
482
+ "summary": "Archive a billing alert",
483
+ "tags": [
484
+ "billing"
485
+ ]
486
+ }
487
+ },
488
+ "/v1/billing/alerts/{id}/deactivate": {
489
+ "post": {
490
+ "operationId": "PostBillingAlertsIdDeactivate",
491
+ "summary": "Deactivate a billing alert",
492
+ "tags": [
493
+ "billing"
494
+ ]
495
+ }
496
+ },
497
+ "/v1/billing/credit_balance_summary": {
498
+ "get": {
499
+ "operationId": "GetBillingCreditBalanceSummary",
500
+ "summary": "Retrieve the credit balance summary for a customer",
501
+ "tags": [
502
+ "billing"
503
+ ]
504
+ }
505
+ },
506
+ "/v1/billing/credit_balance_transactions": {
507
+ "get": {
508
+ "operationId": "GetBillingCreditBalanceTransactions",
509
+ "summary": "List credit balance transactions",
510
+ "tags": [
511
+ "billing"
512
+ ]
513
+ }
514
+ },
515
+ "/v1/billing/credit_balance_transactions/{id}": {
516
+ "get": {
517
+ "operationId": "GetBillingCreditBalanceTransactionsId",
518
+ "summary": "Retrieve a credit balance transaction",
519
+ "tags": [
520
+ "billing"
521
+ ]
522
+ }
523
+ },
524
+ "/v1/billing/credit_grants": {
525
+ "get": {
526
+ "operationId": "GetBillingCreditGrants",
527
+ "summary": "List credit grants",
528
+ "tags": [
529
+ "billing"
530
+ ]
531
+ },
532
+ "post": {
533
+ "operationId": "PostBillingCreditGrants",
534
+ "summary": "Create a credit grant",
535
+ "tags": [
536
+ "billing"
537
+ ]
538
+ }
539
+ },
540
+ "/v1/billing/credit_grants/{id}": {
541
+ "get": {
542
+ "operationId": "GetBillingCreditGrantsId",
543
+ "summary": "Retrieve a credit grant",
544
+ "tags": [
545
+ "billing"
546
+ ]
547
+ },
548
+ "post": {
549
+ "operationId": "PostBillingCreditGrantsId",
550
+ "summary": "Update a credit grant",
551
+ "tags": [
552
+ "billing"
553
+ ]
554
+ }
555
+ },
556
+ "/v1/billing/credit_grants/{id}/expire": {
557
+ "post": {
558
+ "operationId": "PostBillingCreditGrantsIdExpire",
559
+ "summary": "Expire a credit grant",
560
+ "tags": [
561
+ "billing"
562
+ ]
563
+ }
564
+ },
565
+ "/v1/billing/credit_grants/{id}/void": {
566
+ "post": {
567
+ "operationId": "PostBillingCreditGrantsIdVoid",
568
+ "summary": "Void a credit grant",
569
+ "tags": [
570
+ "billing"
571
+ ]
572
+ }
573
+ },
574
+ "/v1/billing/feedback_options": {
575
+ "get": {
576
+ "operationId": "GetBillingFeedbackOptions",
577
+ "summary": "Feedback Options List API Method",
578
+ "tags": [
579
+ "billing"
580
+ ]
581
+ },
582
+ "post": {
583
+ "operationId": "PostBillingFeedbackOptions",
584
+ "summary": "Create a feedback option",
585
+ "tags": [
586
+ "billing"
587
+ ]
588
+ }
589
+ },
590
+ "/v1/billing/feedback_options/{id}": {
591
+ "get": {
592
+ "operationId": "GetBillingFeedbackOptionsId",
593
+ "summary": "Retrieve a feedback option",
594
+ "tags": [
595
+ "billing"
596
+ ]
597
+ },
598
+ "post": {
599
+ "operationId": "PostBillingFeedbackOptionsId",
600
+ "summary": "Update a feedback option",
601
+ "tags": [
602
+ "billing"
603
+ ]
604
+ }
605
+ },
606
+ "/v1/billing/feedback_options/{id}/deactivate": {
607
+ "post": {
608
+ "operationId": "PostBillingFeedbackOptionsIdDeactivate",
609
+ "summary": "Deactivate a feedback option",
610
+ "tags": [
611
+ "billing"
612
+ ]
613
+ }
614
+ },
615
+ "/v1/billing/meter_event_adjustments": {
616
+ "post": {
617
+ "operationId": "PostBillingMeterEventAdjustments",
618
+ "summary": "Create a billing meter event adjustment",
619
+ "tags": [
620
+ "billing"
621
+ ]
622
+ }
623
+ },
624
+ "/v1/billing/meter_events": {
625
+ "post": {
626
+ "operationId": "PostBillingMeterEvents",
627
+ "summary": "Create a billing meter event",
628
+ "tags": [
629
+ "billing"
630
+ ]
631
+ }
632
+ },
633
+ "/v1/billing/meters": {
634
+ "get": {
635
+ "operationId": "GetBillingMeters",
636
+ "summary": "List billing meters",
637
+ "tags": [
638
+ "billing"
639
+ ]
640
+ },
641
+ "post": {
642
+ "operationId": "PostBillingMeters",
643
+ "summary": "Create a billing meter",
644
+ "tags": [
645
+ "billing"
646
+ ]
647
+ }
648
+ },
649
+ "/v1/billing/meters/{id}": {
650
+ "get": {
651
+ "operationId": "GetBillingMetersId",
652
+ "summary": "Retrieve a billing meter",
653
+ "tags": [
654
+ "billing"
655
+ ]
656
+ },
657
+ "post": {
658
+ "operationId": "PostBillingMetersId",
659
+ "summary": "Update a billing meter",
660
+ "tags": [
661
+ "billing"
662
+ ]
663
+ }
664
+ },
665
+ "/v1/billing/meters/{id}/deactivate": {
666
+ "post": {
667
+ "operationId": "PostBillingMetersIdDeactivate",
668
+ "summary": "Deactivate a billing meter",
669
+ "tags": [
670
+ "billing"
671
+ ]
672
+ }
673
+ },
674
+ "/v1/billing/meters/{id}/event_summaries": {
675
+ "get": {
676
+ "operationId": "GetBillingMetersIdEventSummaries",
677
+ "summary": "List billing meter event summaries",
678
+ "tags": [
679
+ "billing"
680
+ ]
681
+ }
682
+ },
683
+ "/v1/billing/meters/{id}/reactivate": {
684
+ "post": {
685
+ "operationId": "PostBillingMetersIdReactivate",
686
+ "summary": "Reactivate a billing meter",
687
+ "tags": [
688
+ "billing"
689
+ ]
690
+ }
691
+ },
692
+ "/v1/charges": {
693
+ "get": {
694
+ "operationId": "GetCharges",
695
+ "summary": "List all charges",
696
+ "tags": [
697
+ "charges"
698
+ ]
699
+ },
700
+ "post": {
701
+ "operationId": "PostCharges",
702
+ "summary": "Create a charge",
703
+ "tags": [
704
+ "charges"
705
+ ]
706
+ }
707
+ },
708
+ "/v1/charges/{charge}": {
709
+ "get": {
710
+ "operationId": "GetChargesCharge",
711
+ "summary": "Retrieve a charge",
712
+ "tags": [
713
+ "charges"
714
+ ]
715
+ },
716
+ "post": {
717
+ "operationId": "PostChargesCharge",
718
+ "summary": "Update a charge",
719
+ "tags": [
720
+ "charges"
721
+ ]
722
+ }
723
+ },
724
+ "/v1/charges/{charge}/capture": {
725
+ "post": {
726
+ "operationId": "PostChargesChargeCapture",
727
+ "summary": "Capture a charge",
728
+ "tags": [
729
+ "charges"
730
+ ]
731
+ }
732
+ },
733
+ "/v1/charges/{charge}/dispute": {
734
+ "get": {
735
+ "operationId": "GetChargesChargeDispute",
736
+ "summary": "<p>Retrieve a dispute for a specified charge.</p>",
737
+ "tags": [
738
+ "charges"
739
+ ]
740
+ },
741
+ "post": {
742
+ "operationId": "PostChargesChargeDispute",
743
+ "summary": "",
744
+ "tags": [
745
+ "charges"
746
+ ]
747
+ }
748
+ },
749
+ "/v1/charges/{charge}/dispute/close": {
750
+ "post": {
751
+ "operationId": "PostChargesChargeDisputeClose",
752
+ "summary": "",
753
+ "tags": [
754
+ "charges"
755
+ ]
756
+ }
757
+ },
758
+ "/v1/charges/{charge}/refund": {
759
+ "post": {
760
+ "operationId": "PostChargesChargeRefund",
761
+ "summary": "Create a refund",
762
+ "tags": [
763
+ "charges"
764
+ ]
765
+ }
766
+ },
767
+ "/v1/charges/{charge}/refunds": {
768
+ "get": {
769
+ "operationId": "GetChargesChargeRefunds",
770
+ "summary": "List all refunds",
771
+ "tags": [
772
+ "charges"
773
+ ]
774
+ },
775
+ "post": {
776
+ "operationId": "PostChargesChargeRefunds",
777
+ "summary": "Create a refund",
778
+ "tags": [
779
+ "charges"
780
+ ]
781
+ }
782
+ },
783
+ "/v1/charges/{charge}/refunds/{refund}": {
784
+ "get": {
785
+ "operationId": "GetChargesChargeRefundsRefund",
786
+ "summary": "<p>Retrieves the details of an existing refund.</p>",
787
+ "tags": [
788
+ "charges"
789
+ ]
790
+ },
791
+ "post": {
792
+ "operationId": "PostChargesChargeRefundsRefund",
793
+ "summary": "<p>Update a specified refund.</p>",
794
+ "tags": [
795
+ "charges"
796
+ ]
797
+ }
798
+ },
799
+ "/v1/charges/search": {
800
+ "get": {
801
+ "operationId": "GetChargesSearch",
802
+ "summary": "Search charges",
803
+ "tags": [
804
+ "charges"
805
+ ]
806
+ }
807
+ },
808
+ "/v1/checkout/sessions": {
809
+ "get": {
810
+ "operationId": "GetCheckoutSessions",
811
+ "summary": "List all Checkout Sessions",
812
+ "tags": [
813
+ "checkout"
814
+ ]
815
+ },
816
+ "post": {
817
+ "operationId": "PostCheckoutSessions",
818
+ "summary": "Create a Checkout Session",
819
+ "tags": [
820
+ "checkout"
821
+ ]
822
+ }
823
+ },
824
+ "/v1/checkout/sessions/{session}": {
825
+ "get": {
826
+ "operationId": "GetCheckoutSessionsSession",
827
+ "summary": "Retrieve a Checkout Session",
828
+ "tags": [
829
+ "checkout"
830
+ ]
831
+ },
832
+ "post": {
833
+ "operationId": "PostCheckoutSessionsSession",
834
+ "summary": "Update a Checkout Session",
835
+ "tags": [
836
+ "checkout"
837
+ ]
838
+ }
839
+ },
840
+ "/v1/checkout/sessions/{session}/expire": {
841
+ "post": {
842
+ "operationId": "PostCheckoutSessionsSessionExpire",
843
+ "summary": "Expire a Checkout Session",
844
+ "tags": [
845
+ "checkout"
846
+ ]
847
+ }
848
+ },
849
+ "/v1/checkout/sessions/{session}/line_items": {
850
+ "get": {
851
+ "operationId": "GetCheckoutSessionsSessionLineItems",
852
+ "summary": "Retrieve a Checkout Session's line items",
853
+ "tags": [
854
+ "checkout"
855
+ ]
856
+ }
857
+ },
858
+ "/v1/climate/orders": {
859
+ "get": {
860
+ "operationId": "GetClimateOrders",
861
+ "summary": "List orders",
862
+ "tags": [
863
+ "climate"
864
+ ]
865
+ },
866
+ "post": {
867
+ "operationId": "PostClimateOrders",
868
+ "summary": "Create an order",
869
+ "tags": [
870
+ "climate"
871
+ ]
872
+ }
873
+ },
874
+ "/v1/climate/orders/{order}": {
875
+ "get": {
876
+ "operationId": "GetClimateOrdersOrder",
877
+ "summary": "Retrieve an order",
878
+ "tags": [
879
+ "climate"
880
+ ]
881
+ },
882
+ "post": {
883
+ "operationId": "PostClimateOrdersOrder",
884
+ "summary": "Update an order",
885
+ "tags": [
886
+ "climate"
887
+ ]
888
+ }
889
+ },
890
+ "/v1/climate/orders/{order}/cancel": {
891
+ "post": {
892
+ "operationId": "PostClimateOrdersOrderCancel",
893
+ "summary": "Cancel an order",
894
+ "tags": [
895
+ "climate"
896
+ ]
897
+ }
898
+ },
899
+ "/v1/climate/products": {
900
+ "get": {
901
+ "operationId": "GetClimateProducts",
902
+ "summary": "List products",
903
+ "tags": [
904
+ "climate"
905
+ ]
906
+ }
907
+ },
908
+ "/v1/climate/products/{product}": {
909
+ "get": {
910
+ "operationId": "GetClimateProductsProduct",
911
+ "summary": "Retrieve a product",
912
+ "tags": [
913
+ "climate"
914
+ ]
915
+ }
916
+ },
917
+ "/v1/climate/suppliers": {
918
+ "get": {
919
+ "operationId": "GetClimateSuppliers",
920
+ "summary": "List suppliers",
921
+ "tags": [
922
+ "climate"
923
+ ]
924
+ }
925
+ },
926
+ "/v1/climate/suppliers/{supplier}": {
927
+ "get": {
928
+ "operationId": "GetClimateSuppliersSupplier",
929
+ "summary": "Retrieve a supplier",
930
+ "tags": [
931
+ "climate"
932
+ ]
933
+ }
934
+ },
935
+ "/v1/coupons": {
936
+ "get": {
937
+ "operationId": "GetCoupons",
938
+ "summary": "List all coupons",
939
+ "tags": [
940
+ "coupons"
941
+ ]
942
+ },
943
+ "post": {
944
+ "operationId": "PostCoupons",
945
+ "summary": "Create a coupon",
946
+ "tags": [
947
+ "coupons"
948
+ ]
949
+ }
950
+ },
951
+ "/v1/coupons/{coupon}": {
952
+ "delete": {
953
+ "operationId": "DeleteCouponsCoupon",
954
+ "summary": "Delete a coupon",
955
+ "tags": [
956
+ "coupons"
957
+ ]
958
+ },
959
+ "get": {
960
+ "operationId": "GetCouponsCoupon",
961
+ "summary": "Retrieve a coupon",
962
+ "tags": [
963
+ "coupons"
964
+ ]
965
+ },
966
+ "post": {
967
+ "operationId": "PostCouponsCoupon",
968
+ "summary": "Update a coupon",
969
+ "tags": [
970
+ "coupons"
971
+ ]
972
+ }
973
+ },
974
+ "/v1/credit_notes": {
975
+ "get": {
976
+ "operationId": "GetCreditNotes",
977
+ "summary": "List all credit notes",
978
+ "tags": [
979
+ "credit_notes"
980
+ ]
981
+ },
982
+ "post": {
983
+ "operationId": "PostCreditNotes",
984
+ "summary": "Create a credit note",
985
+ "tags": [
986
+ "credit_notes"
987
+ ]
988
+ }
989
+ },
990
+ "/v1/credit_notes/{credit_note}/lines": {
991
+ "get": {
992
+ "operationId": "GetCreditNotesCreditNoteLines",
993
+ "summary": "Retrieve a credit note's line items",
994
+ "tags": [
995
+ "credit_notes"
996
+ ]
997
+ }
998
+ },
999
+ "/v1/credit_notes/{id}": {
1000
+ "get": {
1001
+ "operationId": "GetCreditNotesId",
1002
+ "summary": "Retrieve a credit note",
1003
+ "tags": [
1004
+ "credit_notes"
1005
+ ]
1006
+ },
1007
+ "post": {
1008
+ "operationId": "PostCreditNotesId",
1009
+ "summary": "Update a credit note",
1010
+ "tags": [
1011
+ "credit_notes"
1012
+ ]
1013
+ }
1014
+ },
1015
+ "/v1/credit_notes/{id}/void": {
1016
+ "post": {
1017
+ "operationId": "PostCreditNotesIdVoid",
1018
+ "summary": "Void a credit note",
1019
+ "tags": [
1020
+ "credit_notes"
1021
+ ]
1022
+ }
1023
+ },
1024
+ "/v1/credit_notes/preview": {
1025
+ "get": {
1026
+ "operationId": "GetCreditNotesPreview",
1027
+ "summary": "Preview a credit note",
1028
+ "tags": [
1029
+ "credit_notes"
1030
+ ]
1031
+ }
1032
+ },
1033
+ "/v1/credit_notes/preview/lines": {
1034
+ "get": {
1035
+ "operationId": "GetCreditNotesPreviewLines",
1036
+ "summary": "Retrieve a credit note preview's line items",
1037
+ "tags": [
1038
+ "credit_notes"
1039
+ ]
1040
+ }
1041
+ },
1042
+ "/v1/customers": {
1043
+ "get": {
1044
+ "operationId": "GetCustomers",
1045
+ "summary": "List all customers",
1046
+ "tags": [
1047
+ "customers"
1048
+ ]
1049
+ },
1050
+ "post": {
1051
+ "operationId": "PostCustomers",
1052
+ "summary": "Create a customer",
1053
+ "tags": [
1054
+ "customers"
1055
+ ]
1056
+ }
1057
+ },
1058
+ "/v1/customers/{customer}": {
1059
+ "delete": {
1060
+ "operationId": "DeleteCustomersCustomer",
1061
+ "summary": "Delete a customer",
1062
+ "tags": [
1063
+ "customers"
1064
+ ]
1065
+ },
1066
+ "get": {
1067
+ "operationId": "GetCustomersCustomer",
1068
+ "summary": "Retrieve a customer",
1069
+ "tags": [
1070
+ "customers"
1071
+ ]
1072
+ },
1073
+ "post": {
1074
+ "operationId": "PostCustomersCustomer",
1075
+ "summary": "Update a customer",
1076
+ "tags": [
1077
+ "customers"
1078
+ ]
1079
+ }
1080
+ },
1081
+ "/v1/customers/{customer}/balance_transactions": {
1082
+ "get": {
1083
+ "operationId": "GetCustomersCustomerBalanceTransactions",
1084
+ "summary": "List customer balance transactions",
1085
+ "tags": [
1086
+ "customers"
1087
+ ]
1088
+ },
1089
+ "post": {
1090
+ "operationId": "PostCustomersCustomerBalanceTransactions",
1091
+ "summary": "Create a customer balance transaction",
1092
+ "tags": [
1093
+ "customers"
1094
+ ]
1095
+ }
1096
+ },
1097
+ "/v1/customers/{customer}/balance_transactions/{transaction}": {
1098
+ "get": {
1099
+ "operationId": "GetCustomersCustomerBalanceTransactionsTransaction",
1100
+ "summary": "Retrieve a customer balance transaction",
1101
+ "tags": [
1102
+ "customers"
1103
+ ]
1104
+ },
1105
+ "post": {
1106
+ "operationId": "PostCustomersCustomerBalanceTransactionsTransaction",
1107
+ "summary": "Update a customer credit balance transaction",
1108
+ "tags": [
1109
+ "customers"
1110
+ ]
1111
+ }
1112
+ },
1113
+ "/v1/customers/{customer}/bank_accounts": {
1114
+ "get": {
1115
+ "operationId": "GetCustomersCustomerBankAccounts",
1116
+ "summary": "List all bank accounts",
1117
+ "tags": [
1118
+ "customers"
1119
+ ]
1120
+ },
1121
+ "post": {
1122
+ "operationId": "PostCustomersCustomerBankAccounts",
1123
+ "summary": "Create a card",
1124
+ "tags": [
1125
+ "customers"
1126
+ ]
1127
+ }
1128
+ },
1129
+ "/v1/customers/{customer}/bank_accounts/{id}": {
1130
+ "delete": {
1131
+ "operationId": "DeleteCustomersCustomerBankAccountsId",
1132
+ "summary": "Delete a customer source",
1133
+ "tags": [
1134
+ "customers"
1135
+ ]
1136
+ },
1137
+ "get": {
1138
+ "operationId": "GetCustomersCustomerBankAccountsId",
1139
+ "summary": "Retrieve a bank account",
1140
+ "tags": [
1141
+ "customers"
1142
+ ]
1143
+ },
1144
+ "post": {
1145
+ "operationId": "PostCustomersCustomerBankAccountsId",
1146
+ "summary": "Update a card",
1147
+ "tags": [
1148
+ "customers"
1149
+ ]
1150
+ }
1151
+ },
1152
+ "/v1/customers/{customer}/bank_accounts/{id}/verify": {
1153
+ "post": {
1154
+ "operationId": "PostCustomersCustomerBankAccountsIdVerify",
1155
+ "summary": "Verify a bank account",
1156
+ "tags": [
1157
+ "customers"
1158
+ ]
1159
+ }
1160
+ },
1161
+ "/v1/customers/{customer}/cards": {
1162
+ "get": {
1163
+ "operationId": "GetCustomersCustomerCards",
1164
+ "summary": "List all cards",
1165
+ "tags": [
1166
+ "customers"
1167
+ ]
1168
+ },
1169
+ "post": {
1170
+ "operationId": "PostCustomersCustomerCards",
1171
+ "summary": "Create a card",
1172
+ "tags": [
1173
+ "customers"
1174
+ ]
1175
+ }
1176
+ },
1177
+ "/v1/customers/{customer}/cards/{id}": {
1178
+ "delete": {
1179
+ "operationId": "DeleteCustomersCustomerCardsId",
1180
+ "summary": "Delete a customer source",
1181
+ "tags": [
1182
+ "customers"
1183
+ ]
1184
+ },
1185
+ "get": {
1186
+ "operationId": "GetCustomersCustomerCardsId",
1187
+ "summary": "Retrieve a card",
1188
+ "tags": [
1189
+ "customers"
1190
+ ]
1191
+ },
1192
+ "post": {
1193
+ "operationId": "PostCustomersCustomerCardsId",
1194
+ "summary": "Update a card",
1195
+ "tags": [
1196
+ "customers"
1197
+ ]
1198
+ }
1199
+ },
1200
+ "/v1/customers/{customer}/cash_balance": {
1201
+ "get": {
1202
+ "operationId": "GetCustomersCustomerCashBalance",
1203
+ "summary": "Retrieve a cash balance",
1204
+ "tags": [
1205
+ "customers"
1206
+ ]
1207
+ },
1208
+ "post": {
1209
+ "operationId": "PostCustomersCustomerCashBalance",
1210
+ "summary": "Update a cash balance's settings",
1211
+ "tags": [
1212
+ "customers"
1213
+ ]
1214
+ }
1215
+ },
1216
+ "/v1/customers/{customer}/cash_balance_transactions": {
1217
+ "get": {
1218
+ "operationId": "GetCustomersCustomerCashBalanceTransactions",
1219
+ "summary": "List cash balance transactions",
1220
+ "tags": [
1221
+ "customers"
1222
+ ]
1223
+ }
1224
+ },
1225
+ "/v1/customers/{customer}/cash_balance_transactions/{transaction}": {
1226
+ "get": {
1227
+ "operationId": "GetCustomersCustomerCashBalanceTransactionsTransaction",
1228
+ "summary": "Retrieve a cash balance transaction",
1229
+ "tags": [
1230
+ "customers"
1231
+ ]
1232
+ }
1233
+ },
1234
+ "/v1/customers/{customer}/discount": {
1235
+ "delete": {
1236
+ "operationId": "DeleteCustomersCustomerDiscount",
1237
+ "summary": "Delete a customer discount",
1238
+ "tags": [
1239
+ "customers"
1240
+ ]
1241
+ },
1242
+ "get": {
1243
+ "operationId": "GetCustomersCustomerDiscount",
1244
+ "summary": "",
1245
+ "tags": [
1246
+ "customers"
1247
+ ]
1248
+ }
1249
+ },
1250
+ "/v1/customers/{customer}/funding_instructions": {
1251
+ "post": {
1252
+ "operationId": "PostCustomersCustomerFundingInstructions",
1253
+ "summary": "Create or retrieve funding instructions for a customer cash balance",
1254
+ "tags": [
1255
+ "customers"
1256
+ ]
1257
+ }
1258
+ },
1259
+ "/v1/customers/{customer}/payment_methods": {
1260
+ "get": {
1261
+ "operationId": "GetCustomersCustomerPaymentMethods",
1262
+ "summary": "List a Customer's PaymentMethods",
1263
+ "tags": [
1264
+ "customers"
1265
+ ]
1266
+ }
1267
+ },
1268
+ "/v1/customers/{customer}/payment_methods/{payment_method}": {
1269
+ "get": {
1270
+ "operationId": "GetCustomersCustomerPaymentMethodsPaymentMethod",
1271
+ "summary": "Retrieve a Customer's PaymentMethod",
1272
+ "tags": [
1273
+ "customers"
1274
+ ]
1275
+ }
1276
+ },
1277
+ "/v1/customers/{customer}/sources": {
1278
+ "get": {
1279
+ "operationId": "GetCustomersCustomerSources",
1280
+ "summary": "<p>List sources for a specified customer.</p>",
1281
+ "tags": [
1282
+ "customers"
1283
+ ]
1284
+ },
1285
+ "post": {
1286
+ "operationId": "PostCustomersCustomerSources",
1287
+ "summary": "Create a card",
1288
+ "tags": [
1289
+ "customers"
1290
+ ]
1291
+ }
1292
+ },
1293
+ "/v1/customers/{customer}/sources/{id}": {
1294
+ "delete": {
1295
+ "operationId": "DeleteCustomersCustomerSourcesId",
1296
+ "summary": "Delete a customer source",
1297
+ "tags": [
1298
+ "customers"
1299
+ ]
1300
+ },
1301
+ "get": {
1302
+ "operationId": "GetCustomersCustomerSourcesId",
1303
+ "summary": "<p>Retrieve a specified source for a given customer.</p>",
1304
+ "tags": [
1305
+ "customers"
1306
+ ]
1307
+ },
1308
+ "post": {
1309
+ "operationId": "PostCustomersCustomerSourcesId",
1310
+ "summary": "Update a card",
1311
+ "tags": [
1312
+ "customers"
1313
+ ]
1314
+ }
1315
+ },
1316
+ "/v1/customers/{customer}/sources/{id}/verify": {
1317
+ "post": {
1318
+ "operationId": "PostCustomersCustomerSourcesIdVerify",
1319
+ "summary": "Verify a bank account",
1320
+ "tags": [
1321
+ "customers"
1322
+ ]
1323
+ }
1324
+ },
1325
+ "/v1/customers/{customer}/subscriptions": {
1326
+ "get": {
1327
+ "operationId": "GetCustomersCustomerSubscriptions",
1328
+ "summary": "List active subscriptions",
1329
+ "tags": [
1330
+ "customers"
1331
+ ]
1332
+ },
1333
+ "post": {
1334
+ "operationId": "PostCustomersCustomerSubscriptions",
1335
+ "summary": "Create a subscription",
1336
+ "tags": [
1337
+ "customers"
1338
+ ]
1339
+ }
1340
+ },
1341
+ "/v1/customers/{customer}/subscriptions/{subscription_exposed_id}": {
1342
+ "delete": {
1343
+ "operationId": "DeleteCustomersCustomerSubscriptionsSubscriptionExposedId",
1344
+ "summary": "Cancel a subscription",
1345
+ "tags": [
1346
+ "customers"
1347
+ ]
1348
+ },
1349
+ "get": {
1350
+ "operationId": "GetCustomersCustomerSubscriptionsSubscriptionExposedId",
1351
+ "summary": "Retrieve a subscription",
1352
+ "tags": [
1353
+ "customers"
1354
+ ]
1355
+ },
1356
+ "post": {
1357
+ "operationId": "PostCustomersCustomerSubscriptionsSubscriptionExposedId",
1358
+ "summary": "Update a subscription on a customer",
1359
+ "tags": [
1360
+ "customers"
1361
+ ]
1362
+ }
1363
+ },
1364
+ "/v1/customers/{customer}/subscriptions/{subscription_exposed_id}/discount": {
1365
+ "delete": {
1366
+ "operationId": "DeleteCustomersCustomerSubscriptionsSubscriptionExposedIdDiscount",
1367
+ "summary": "Delete a customer discount",
1368
+ "tags": [
1369
+ "customers"
1370
+ ]
1371
+ },
1372
+ "get": {
1373
+ "operationId": "GetCustomersCustomerSubscriptionsSubscriptionExposedIdDiscount",
1374
+ "summary": "",
1375
+ "tags": [
1376
+ "customers"
1377
+ ]
1378
+ }
1379
+ },
1380
+ "/v1/customers/{customer}/tax_ids": {
1381
+ "get": {
1382
+ "operationId": "GetCustomersCustomerTaxIds",
1383
+ "summary": "List all Customer tax IDs",
1384
+ "tags": [
1385
+ "customers"
1386
+ ]
1387
+ },
1388
+ "post": {
1389
+ "operationId": "PostCustomersCustomerTaxIds",
1390
+ "summary": "Create a Customer tax ID",
1391
+ "tags": [
1392
+ "customers"
1393
+ ]
1394
+ }
1395
+ },
1396
+ "/v1/customers/{customer}/tax_ids/{id}": {
1397
+ "delete": {
1398
+ "operationId": "DeleteCustomersCustomerTaxIdsId",
1399
+ "summary": "Delete a Customer tax ID",
1400
+ "tags": [
1401
+ "customers"
1402
+ ]
1403
+ },
1404
+ "get": {
1405
+ "operationId": "GetCustomersCustomerTaxIdsId",
1406
+ "summary": "Retrieve a Customer tax ID",
1407
+ "tags": [
1408
+ "customers"
1409
+ ]
1410
+ }
1411
+ },
1412
+ "/v1/customers/search": {
1413
+ "get": {
1414
+ "operationId": "GetCustomersSearch",
1415
+ "summary": "Search customers",
1416
+ "tags": [
1417
+ "customers"
1418
+ ]
1419
+ }
1420
+ },
1421
+ "/v1/disputes": {
1422
+ "get": {
1423
+ "operationId": "GetDisputes",
1424
+ "summary": "List all disputes",
1425
+ "tags": [
1426
+ "disputes"
1427
+ ]
1428
+ }
1429
+ },
1430
+ "/v1/disputes/{dispute}": {
1431
+ "get": {
1432
+ "operationId": "GetDisputesDispute",
1433
+ "summary": "Retrieve a dispute",
1434
+ "tags": [
1435
+ "disputes"
1436
+ ]
1437
+ },
1438
+ "post": {
1439
+ "operationId": "PostDisputesDispute",
1440
+ "summary": "Update a dispute",
1441
+ "tags": [
1442
+ "disputes"
1443
+ ]
1444
+ }
1445
+ },
1446
+ "/v1/disputes/{dispute}/close": {
1447
+ "post": {
1448
+ "operationId": "PostDisputesDisputeClose",
1449
+ "summary": "Close a dispute",
1450
+ "tags": [
1451
+ "disputes"
1452
+ ]
1453
+ }
1454
+ },
1455
+ "/v1/entitlements/active_entitlements": {
1456
+ "get": {
1457
+ "operationId": "GetEntitlementsActiveEntitlements",
1458
+ "summary": "List all active entitlements",
1459
+ "tags": [
1460
+ "entitlements"
1461
+ ]
1462
+ }
1463
+ },
1464
+ "/v1/entitlements/active_entitlements/{id}": {
1465
+ "get": {
1466
+ "operationId": "GetEntitlementsActiveEntitlementsId",
1467
+ "summary": "Retrieve an active entitlement",
1468
+ "tags": [
1469
+ "entitlements"
1470
+ ]
1471
+ }
1472
+ },
1473
+ "/v1/entitlements/features": {
1474
+ "get": {
1475
+ "operationId": "GetEntitlementsFeatures",
1476
+ "summary": "List all features",
1477
+ "tags": [
1478
+ "entitlements"
1479
+ ]
1480
+ },
1481
+ "post": {
1482
+ "operationId": "PostEntitlementsFeatures",
1483
+ "summary": "Create a feature",
1484
+ "tags": [
1485
+ "entitlements"
1486
+ ]
1487
+ }
1488
+ },
1489
+ "/v1/entitlements/features/{id}": {
1490
+ "get": {
1491
+ "operationId": "GetEntitlementsFeaturesId",
1492
+ "summary": "Retrieve a feature",
1493
+ "tags": [
1494
+ "entitlements"
1495
+ ]
1496
+ },
1497
+ "post": {
1498
+ "operationId": "PostEntitlementsFeaturesId",
1499
+ "summary": "Updates a feature",
1500
+ "tags": [
1501
+ "entitlements"
1502
+ ]
1503
+ }
1504
+ },
1505
+ "/v1/ephemeral_keys": {
1506
+ "post": {
1507
+ "operationId": "PostEphemeralKeys",
1508
+ "summary": "Create an ephemeral key",
1509
+ "tags": [
1510
+ "ephemeral_keys"
1511
+ ]
1512
+ }
1513
+ },
1514
+ "/v1/ephemeral_keys/{key}": {
1515
+ "delete": {
1516
+ "operationId": "DeleteEphemeralKeysKey",
1517
+ "summary": "Immediately invalidate an ephemeral key",
1518
+ "tags": [
1519
+ "ephemeral_keys"
1520
+ ]
1521
+ }
1522
+ },
1523
+ "/v1/events": {
1524
+ "get": {
1525
+ "operationId": "GetEvents",
1526
+ "summary": "List all events",
1527
+ "tags": [
1528
+ "events"
1529
+ ]
1530
+ }
1531
+ },
1532
+ "/v1/events/{id}": {
1533
+ "get": {
1534
+ "operationId": "GetEventsId",
1535
+ "summary": "Retrieve an event",
1536
+ "tags": [
1537
+ "events"
1538
+ ]
1539
+ }
1540
+ },
1541
+ "/v1/file_links": {
1542
+ "get": {
1543
+ "operationId": "GetFileLinks",
1544
+ "summary": "List all file links",
1545
+ "tags": [
1546
+ "file_links"
1547
+ ]
1548
+ },
1549
+ "post": {
1550
+ "operationId": "PostFileLinks",
1551
+ "summary": "Create a file link",
1552
+ "tags": [
1553
+ "file_links"
1554
+ ]
1555
+ }
1556
+ },
1557
+ "/v1/file_links/{link}": {
1558
+ "get": {
1559
+ "operationId": "GetFileLinksLink",
1560
+ "summary": "Retrieve a file link",
1561
+ "tags": [
1562
+ "file_links"
1563
+ ]
1564
+ },
1565
+ "post": {
1566
+ "operationId": "PostFileLinksLink",
1567
+ "summary": "Update a file link",
1568
+ "tags": [
1569
+ "file_links"
1570
+ ]
1571
+ }
1572
+ },
1573
+ "/v1/files": {
1574
+ "get": {
1575
+ "operationId": "GetFiles",
1576
+ "summary": "List all files",
1577
+ "tags": [
1578
+ "files"
1579
+ ]
1580
+ },
1581
+ "post": {
1582
+ "operationId": "PostFiles",
1583
+ "summary": "Create a file",
1584
+ "tags": [
1585
+ "files"
1586
+ ]
1587
+ }
1588
+ },
1589
+ "/v1/files/{file}": {
1590
+ "get": {
1591
+ "operationId": "GetFilesFile",
1592
+ "summary": "Retrieve a file",
1593
+ "tags": [
1594
+ "files"
1595
+ ]
1596
+ }
1597
+ },
1598
+ "/v1/financial_connections/accounts": {
1599
+ "get": {
1600
+ "operationId": "GetFinancialConnectionsAccounts",
1601
+ "summary": "List Accounts",
1602
+ "tags": [
1603
+ "financial_connections"
1604
+ ]
1605
+ }
1606
+ },
1607
+ "/v1/financial_connections/accounts/{account}": {
1608
+ "get": {
1609
+ "operationId": "GetFinancialConnectionsAccountsAccount",
1610
+ "summary": "Retrieve an Account",
1611
+ "tags": [
1612
+ "financial_connections"
1613
+ ]
1614
+ }
1615
+ },
1616
+ "/v1/financial_connections/accounts/{account}/disconnect": {
1617
+ "post": {
1618
+ "operationId": "PostFinancialConnectionsAccountsAccountDisconnect",
1619
+ "summary": "Disconnect an Account",
1620
+ "tags": [
1621
+ "financial_connections"
1622
+ ]
1623
+ }
1624
+ },
1625
+ "/v1/financial_connections/accounts/{account}/owners": {
1626
+ "get": {
1627
+ "operationId": "GetFinancialConnectionsAccountsAccountOwners",
1628
+ "summary": "List Account Owners",
1629
+ "tags": [
1630
+ "financial_connections"
1631
+ ]
1632
+ }
1633
+ },
1634
+ "/v1/financial_connections/accounts/{account}/refresh": {
1635
+ "post": {
1636
+ "operationId": "PostFinancialConnectionsAccountsAccountRefresh",
1637
+ "summary": "Refresh Account data",
1638
+ "tags": [
1639
+ "financial_connections"
1640
+ ]
1641
+ }
1642
+ },
1643
+ "/v1/financial_connections/accounts/{account}/subscribe": {
1644
+ "post": {
1645
+ "operationId": "PostFinancialConnectionsAccountsAccountSubscribe",
1646
+ "summary": "Subscribe to data refreshes for an Account",
1647
+ "tags": [
1648
+ "financial_connections"
1649
+ ]
1650
+ }
1651
+ },
1652
+ "/v1/financial_connections/accounts/{account}/unsubscribe": {
1653
+ "post": {
1654
+ "operationId": "PostFinancialConnectionsAccountsAccountUnsubscribe",
1655
+ "summary": "Unsubscribe from data refreshes for an Account",
1656
+ "tags": [
1657
+ "financial_connections"
1658
+ ]
1659
+ }
1660
+ },
1661
+ "/v1/financial_connections/sessions": {
1662
+ "post": {
1663
+ "operationId": "PostFinancialConnectionsSessions",
1664
+ "summary": "Create a Session",
1665
+ "tags": [
1666
+ "financial_connections"
1667
+ ]
1668
+ }
1669
+ },
1670
+ "/v1/financial_connections/sessions/{session}": {
1671
+ "get": {
1672
+ "operationId": "GetFinancialConnectionsSessionsSession",
1673
+ "summary": "Retrieve a Session",
1674
+ "tags": [
1675
+ "financial_connections"
1676
+ ]
1677
+ }
1678
+ },
1679
+ "/v1/financial_connections/transactions": {
1680
+ "get": {
1681
+ "operationId": "GetFinancialConnectionsTransactions",
1682
+ "summary": "List Transactions",
1683
+ "tags": [
1684
+ "financial_connections"
1685
+ ]
1686
+ }
1687
+ },
1688
+ "/v1/financial_connections/transactions/{transaction}": {
1689
+ "get": {
1690
+ "operationId": "GetFinancialConnectionsTransactionsTransaction",
1691
+ "summary": "Retrieve a Transaction",
1692
+ "tags": [
1693
+ "financial_connections"
1694
+ ]
1695
+ }
1696
+ },
1697
+ "/v1/forwarding/requests": {
1698
+ "get": {
1699
+ "operationId": "GetForwardingRequests",
1700
+ "summary": "List all ForwardingRequests",
1701
+ "tags": [
1702
+ "forwarding"
1703
+ ]
1704
+ },
1705
+ "post": {
1706
+ "operationId": "PostForwardingRequests",
1707
+ "summary": "Create a ForwardingRequest",
1708
+ "tags": [
1709
+ "forwarding"
1710
+ ]
1711
+ }
1712
+ },
1713
+ "/v1/forwarding/requests/{id}": {
1714
+ "get": {
1715
+ "operationId": "GetForwardingRequestsId",
1716
+ "summary": "Retrieve a ForwardingRequest",
1717
+ "tags": [
1718
+ "forwarding"
1719
+ ]
1720
+ }
1721
+ },
1722
+ "/v1/identity/verification_reports": {
1723
+ "get": {
1724
+ "operationId": "GetIdentityVerificationReports",
1725
+ "summary": "List VerificationReports",
1726
+ "tags": [
1727
+ "identity"
1728
+ ]
1729
+ }
1730
+ },
1731
+ "/v1/identity/verification_reports/{report}": {
1732
+ "get": {
1733
+ "operationId": "GetIdentityVerificationReportsReport",
1734
+ "summary": "Retrieve a VerificationReport",
1735
+ "tags": [
1736
+ "identity"
1737
+ ]
1738
+ }
1739
+ },
1740
+ "/v1/identity/verification_sessions": {
1741
+ "get": {
1742
+ "operationId": "GetIdentityVerificationSessions",
1743
+ "summary": "List VerificationSessions",
1744
+ "tags": [
1745
+ "identity"
1746
+ ]
1747
+ },
1748
+ "post": {
1749
+ "operationId": "PostIdentityVerificationSessions",
1750
+ "summary": "Create a VerificationSession",
1751
+ "tags": [
1752
+ "identity"
1753
+ ]
1754
+ }
1755
+ },
1756
+ "/v1/identity/verification_sessions/{session}": {
1757
+ "get": {
1758
+ "operationId": "GetIdentityVerificationSessionsSession",
1759
+ "summary": "Retrieve a VerificationSession",
1760
+ "tags": [
1761
+ "identity"
1762
+ ]
1763
+ },
1764
+ "post": {
1765
+ "operationId": "PostIdentityVerificationSessionsSession",
1766
+ "summary": "Update a VerificationSession",
1767
+ "tags": [
1768
+ "identity"
1769
+ ]
1770
+ }
1771
+ },
1772
+ "/v1/identity/verification_sessions/{session}/cancel": {
1773
+ "post": {
1774
+ "operationId": "PostIdentityVerificationSessionsSessionCancel",
1775
+ "summary": "Cancel a VerificationSession",
1776
+ "tags": [
1777
+ "identity"
1778
+ ]
1779
+ }
1780
+ },
1781
+ "/v1/identity/verification_sessions/{session}/redact": {
1782
+ "post": {
1783
+ "operationId": "PostIdentityVerificationSessionsSessionRedact",
1784
+ "summary": "Redact a VerificationSession",
1785
+ "tags": [
1786
+ "identity"
1787
+ ]
1788
+ }
1789
+ },
1790
+ "/v1/invoiceitems": {
1791
+ "get": {
1792
+ "operationId": "GetInvoiceitems",
1793
+ "summary": "List all invoice items",
1794
+ "tags": [
1795
+ "invoiceitems"
1796
+ ]
1797
+ },
1798
+ "post": {
1799
+ "operationId": "PostInvoiceitems",
1800
+ "summary": "Create an invoice item",
1801
+ "tags": [
1802
+ "invoiceitems"
1803
+ ]
1804
+ }
1805
+ },
1806
+ "/v1/invoiceitems/{invoiceitem}": {
1807
+ "delete": {
1808
+ "operationId": "DeleteInvoiceitemsInvoiceitem",
1809
+ "summary": "Delete an invoice item",
1810
+ "tags": [
1811
+ "invoiceitems"
1812
+ ]
1813
+ },
1814
+ "get": {
1815
+ "operationId": "GetInvoiceitemsInvoiceitem",
1816
+ "summary": "Retrieve an invoice item",
1817
+ "tags": [
1818
+ "invoiceitems"
1819
+ ]
1820
+ },
1821
+ "post": {
1822
+ "operationId": "PostInvoiceitemsInvoiceitem",
1823
+ "summary": "Update an invoice item",
1824
+ "tags": [
1825
+ "invoiceitems"
1826
+ ]
1827
+ }
1828
+ },
1829
+ "/v1/invoices": {
1830
+ "get": {
1831
+ "operationId": "GetInvoices",
1832
+ "summary": "List all invoices",
1833
+ "tags": [
1834
+ "invoices"
1835
+ ]
1836
+ },
1837
+ "post": {
1838
+ "operationId": "PostInvoices",
1839
+ "summary": "Create an invoice",
1840
+ "tags": [
1841
+ "invoices"
1842
+ ]
1843
+ }
1844
+ },
1845
+ "/v1/invoices/{invoice}": {
1846
+ "delete": {
1847
+ "operationId": "DeleteInvoicesInvoice",
1848
+ "summary": "Delete a draft invoice",
1849
+ "tags": [
1850
+ "invoices"
1851
+ ]
1852
+ },
1853
+ "get": {
1854
+ "operationId": "GetInvoicesInvoice",
1855
+ "summary": "Retrieve an invoice",
1856
+ "tags": [
1857
+ "invoices"
1858
+ ]
1859
+ },
1860
+ "post": {
1861
+ "operationId": "PostInvoicesInvoice",
1862
+ "summary": "Update an invoice",
1863
+ "tags": [
1864
+ "invoices"
1865
+ ]
1866
+ }
1867
+ },
1868
+ "/v1/invoices/{invoice}/add_lines": {
1869
+ "post": {
1870
+ "operationId": "PostInvoicesInvoiceAddLines",
1871
+ "summary": "Bulk add invoice line items",
1872
+ "tags": [
1873
+ "invoices"
1874
+ ]
1875
+ }
1876
+ },
1877
+ "/v1/invoices/{invoice}/attach_payment": {
1878
+ "post": {
1879
+ "operationId": "PostInvoicesInvoiceAttachPayment",
1880
+ "summary": "Attach a payment to an Invoice",
1881
+ "tags": [
1882
+ "invoices"
1883
+ ]
1884
+ }
1885
+ },
1886
+ "/v1/invoices/{invoice}/finalize": {
1887
+ "post": {
1888
+ "operationId": "PostInvoicesInvoiceFinalize",
1889
+ "summary": "Finalize an invoice",
1890
+ "tags": [
1891
+ "invoices"
1892
+ ]
1893
+ }
1894
+ },
1895
+ "/v1/invoices/{invoice}/lines": {
1896
+ "get": {
1897
+ "operationId": "GetInvoicesInvoiceLines",
1898
+ "summary": "Retrieve an invoice's line items",
1899
+ "tags": [
1900
+ "invoices"
1901
+ ]
1902
+ }
1903
+ },
1904
+ "/v1/invoices/{invoice}/lines/{line_item_id}": {
1905
+ "post": {
1906
+ "operationId": "PostInvoicesInvoiceLinesLineItemId",
1907
+ "summary": "Update an invoice's line item",
1908
+ "tags": [
1909
+ "invoices"
1910
+ ]
1911
+ }
1912
+ },
1913
+ "/v1/invoices/{invoice}/mark_uncollectible": {
1914
+ "post": {
1915
+ "operationId": "PostInvoicesInvoiceMarkUncollectible",
1916
+ "summary": "Mark an invoice as uncollectible",
1917
+ "tags": [
1918
+ "invoices"
1919
+ ]
1920
+ }
1921
+ },
1922
+ "/v1/invoices/{invoice}/pay": {
1923
+ "post": {
1924
+ "operationId": "PostInvoicesInvoicePay",
1925
+ "summary": "Pay an invoice",
1926
+ "tags": [
1927
+ "invoices"
1928
+ ]
1929
+ }
1930
+ },
1931
+ "/v1/invoices/{invoice}/remove_lines": {
1932
+ "post": {
1933
+ "operationId": "PostInvoicesInvoiceRemoveLines",
1934
+ "summary": "Bulk remove invoice line items",
1935
+ "tags": [
1936
+ "invoices"
1937
+ ]
1938
+ }
1939
+ },
1940
+ "/v1/invoices/{invoice}/send": {
1941
+ "post": {
1942
+ "operationId": "PostInvoicesInvoiceSend",
1943
+ "summary": "Send an invoice for manual payment",
1944
+ "tags": [
1945
+ "invoices"
1946
+ ]
1947
+ }
1948
+ },
1949
+ "/v1/invoices/{invoice}/update_lines": {
1950
+ "post": {
1951
+ "operationId": "PostInvoicesInvoiceUpdateLines",
1952
+ "summary": "Bulk update invoice line items",
1953
+ "tags": [
1954
+ "invoices"
1955
+ ]
1956
+ }
1957
+ },
1958
+ "/v1/invoices/{invoice}/void": {
1959
+ "post": {
1960
+ "operationId": "PostInvoicesInvoiceVoid",
1961
+ "summary": "Void an invoice",
1962
+ "tags": [
1963
+ "invoices"
1964
+ ]
1965
+ }
1966
+ },
1967
+ "/v1/invoices/create_preview": {
1968
+ "post": {
1969
+ "operationId": "PostInvoicesCreatePreview",
1970
+ "summary": "Create a preview invoice",
1971
+ "tags": [
1972
+ "invoices"
1973
+ ]
1974
+ }
1975
+ },
1976
+ "/v1/invoices/search": {
1977
+ "get": {
1978
+ "operationId": "GetInvoicesSearch",
1979
+ "summary": "Search invoices",
1980
+ "tags": [
1981
+ "invoices"
1982
+ ]
1983
+ }
1984
+ },
1985
+ "/v1/mandates/{mandate}": {
1986
+ "get": {
1987
+ "operationId": "GetMandatesMandate",
1988
+ "summary": "Retrieve a Mandate",
1989
+ "tags": [
1990
+ "mandates"
1991
+ ]
1992
+ }
1993
+ },
1994
+ "/v1/payment_intents": {
1995
+ "get": {
1996
+ "operationId": "GetPaymentIntents",
1997
+ "summary": "List all PaymentIntents",
1998
+ "tags": [
1999
+ "payment_intents"
2000
+ ]
2001
+ },
2002
+ "post": {
2003
+ "operationId": "PostPaymentIntents",
2004
+ "summary": "Create a PaymentIntent",
2005
+ "tags": [
2006
+ "payment_intents"
2007
+ ]
2008
+ }
2009
+ },
2010
+ "/v1/payment_intents/{intent}": {
2011
+ "get": {
2012
+ "operationId": "GetPaymentIntentsIntent",
2013
+ "summary": "Retrieve a PaymentIntent",
2014
+ "tags": [
2015
+ "payment_intents"
2016
+ ]
2017
+ },
2018
+ "post": {
2019
+ "operationId": "PostPaymentIntentsIntent",
2020
+ "summary": "Update a PaymentIntent",
2021
+ "tags": [
2022
+ "payment_intents"
2023
+ ]
2024
+ }
2025
+ },
2026
+ "/v1/payment_intents/{intent}/amount_details_line_items": {
2027
+ "get": {
2028
+ "operationId": "GetPaymentIntentsIntentAmountDetailsLineItems",
2029
+ "summary": "List all PaymentIntent LineItems",
2030
+ "tags": [
2031
+ "payment_intents"
2032
+ ]
2033
+ }
2034
+ },
2035
+ "/v1/payment_intents/{intent}/apply_customer_balance": {
2036
+ "post": {
2037
+ "operationId": "PostPaymentIntentsIntentApplyCustomerBalance",
2038
+ "summary": "Reconcile a customer_balance PaymentIntent",
2039
+ "tags": [
2040
+ "payment_intents"
2041
+ ]
2042
+ }
2043
+ },
2044
+ "/v1/payment_intents/{intent}/cancel": {
2045
+ "post": {
2046
+ "operationId": "PostPaymentIntentsIntentCancel",
2047
+ "summary": "Cancel a PaymentIntent",
2048
+ "tags": [
2049
+ "payment_intents"
2050
+ ]
2051
+ }
2052
+ },
2053
+ "/v1/payment_intents/{intent}/capture": {
2054
+ "post": {
2055
+ "operationId": "PostPaymentIntentsIntentCapture",
2056
+ "summary": "Capture a PaymentIntent",
2057
+ "tags": [
2058
+ "payment_intents"
2059
+ ]
2060
+ }
2061
+ },
2062
+ "/v1/payment_intents/{intent}/confirm": {
2063
+ "post": {
2064
+ "operationId": "PostPaymentIntentsIntentConfirm",
2065
+ "summary": "Confirm a PaymentIntent",
2066
+ "tags": [
2067
+ "payment_intents"
2068
+ ]
2069
+ }
2070
+ },
2071
+ "/v1/payment_intents/{intent}/increment_authorization": {
2072
+ "post": {
2073
+ "operationId": "PostPaymentIntentsIntentIncrementAuthorization",
2074
+ "summary": "Increment an authorization",
2075
+ "tags": [
2076
+ "payment_intents"
2077
+ ]
2078
+ }
2079
+ },
2080
+ "/v1/payment_intents/{intent}/verify_microdeposits": {
2081
+ "post": {
2082
+ "operationId": "PostPaymentIntentsIntentVerifyMicrodeposits",
2083
+ "summary": "Verify microdeposits on a PaymentIntent",
2084
+ "tags": [
2085
+ "payment_intents"
2086
+ ]
2087
+ }
2088
+ },
2089
+ "/v1/payment_intents/search": {
2090
+ "get": {
2091
+ "operationId": "GetPaymentIntentsSearch",
2092
+ "summary": "Search PaymentIntents",
2093
+ "tags": [
2094
+ "payment_intents"
2095
+ ]
2096
+ }
2097
+ },
2098
+ "/v1/payment_links": {
2099
+ "get": {
2100
+ "operationId": "GetPaymentLinks",
2101
+ "summary": "List all payment links",
2102
+ "tags": [
2103
+ "payment_links"
2104
+ ]
2105
+ },
2106
+ "post": {
2107
+ "operationId": "PostPaymentLinks",
2108
+ "summary": "Create a payment link",
2109
+ "tags": [
2110
+ "payment_links"
2111
+ ]
2112
+ }
2113
+ },
2114
+ "/v1/payment_links/{payment_link}": {
2115
+ "get": {
2116
+ "operationId": "GetPaymentLinksPaymentLink",
2117
+ "summary": "Retrieve payment link",
2118
+ "tags": [
2119
+ "payment_links"
2120
+ ]
2121
+ },
2122
+ "post": {
2123
+ "operationId": "PostPaymentLinksPaymentLink",
2124
+ "summary": "Update a payment link",
2125
+ "tags": [
2126
+ "payment_links"
2127
+ ]
2128
+ }
2129
+ },
2130
+ "/v1/payment_links/{payment_link}/line_items": {
2131
+ "get": {
2132
+ "operationId": "GetPaymentLinksPaymentLinkLineItems",
2133
+ "summary": "Retrieve a payment link's line items",
2134
+ "tags": [
2135
+ "payment_links"
2136
+ ]
2137
+ }
2138
+ },
2139
+ "/v1/payment_methods": {
2140
+ "get": {
2141
+ "operationId": "GetPaymentMethods",
2142
+ "summary": "List PaymentMethods",
2143
+ "tags": [
2144
+ "payment_methods"
2145
+ ]
2146
+ },
2147
+ "post": {
2148
+ "operationId": "PostPaymentMethods",
2149
+ "summary": "Create a PaymentMethod",
2150
+ "tags": [
2151
+ "payment_methods"
2152
+ ]
2153
+ }
2154
+ },
2155
+ "/v1/payment_methods/{payment_method}": {
2156
+ "get": {
2157
+ "operationId": "GetPaymentMethodsPaymentMethod",
2158
+ "summary": "Retrieve a PaymentMethod",
2159
+ "tags": [
2160
+ "payment_methods"
2161
+ ]
2162
+ },
2163
+ "post": {
2164
+ "operationId": "PostPaymentMethodsPaymentMethod",
2165
+ "summary": "Update a PaymentMethod",
2166
+ "tags": [
2167
+ "payment_methods"
2168
+ ]
2169
+ }
2170
+ },
2171
+ "/v1/payment_methods/{payment_method}/attach": {
2172
+ "post": {
2173
+ "operationId": "PostPaymentMethodsPaymentMethodAttach",
2174
+ "summary": "Attach a PaymentMethod to a Customer",
2175
+ "tags": [
2176
+ "payment_methods"
2177
+ ]
2178
+ }
2179
+ },
2180
+ "/v1/payment_methods/{payment_method}/detach": {
2181
+ "post": {
2182
+ "operationId": "PostPaymentMethodsPaymentMethodDetach",
2183
+ "summary": "Detach a PaymentMethod from a Customer",
2184
+ "tags": [
2185
+ "payment_methods"
2186
+ ]
2187
+ }
2188
+ },
2189
+ "/v1/payouts": {
2190
+ "get": {
2191
+ "operationId": "GetPayouts",
2192
+ "summary": "List all payouts",
2193
+ "tags": [
2194
+ "payouts"
2195
+ ]
2196
+ },
2197
+ "post": {
2198
+ "operationId": "PostPayouts",
2199
+ "summary": "Create a payout",
2200
+ "tags": [
2201
+ "payouts"
2202
+ ]
2203
+ }
2204
+ },
2205
+ "/v1/payouts/{payout}": {
2206
+ "get": {
2207
+ "operationId": "GetPayoutsPayout",
2208
+ "summary": "Retrieve a payout",
2209
+ "tags": [
2210
+ "payouts"
2211
+ ]
2212
+ },
2213
+ "post": {
2214
+ "operationId": "PostPayoutsPayout",
2215
+ "summary": "Update a payout",
2216
+ "tags": [
2217
+ "payouts"
2218
+ ]
2219
+ }
2220
+ },
2221
+ "/v1/payouts/{payout}/cancel": {
2222
+ "post": {
2223
+ "operationId": "PostPayoutsPayoutCancel",
2224
+ "summary": "Cancel a payout",
2225
+ "tags": [
2226
+ "payouts"
2227
+ ]
2228
+ }
2229
+ },
2230
+ "/v1/payouts/{payout}/reverse": {
2231
+ "post": {
2232
+ "operationId": "PostPayoutsPayoutReverse",
2233
+ "summary": "Reverse a payout",
2234
+ "tags": [
2235
+ "payouts"
2236
+ ]
2237
+ }
2238
+ },
2239
+ "/v1/plans": {
2240
+ "get": {
2241
+ "description": "<p>Returns a list of your plans.</p>",
2242
+ "operationId": "GetPlans",
2243
+ "parameters": [
2244
+ {
2245
+ "description": "Only return plans that are active or inactive (e.g., pass `false` to list all inactive plans).",
2246
+ "in": "query",
2247
+ "name": "active",
2248
+ "required": false,
2249
+ "schema": {
2250
+ "type": "boolean"
2251
+ },
2252
+ "style": "form"
2253
+ },
2254
+ {
2255
+ "description": "A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.",
2256
+ "explode": true,
2257
+ "in": "query",
2258
+ "name": "created",
2259
+ "required": false,
2260
+ "schema": {
2261
+ "anyOf": [
2262
+ {
2263
+ "properties": {
2264
+ "gt": {
2265
+ "type": "integer"
2266
+ },
2267
+ "gte": {
2268
+ "type": "integer"
2269
+ },
2270
+ "lt": {
2271
+ "type": "integer"
2272
+ },
2273
+ "lte": {
2274
+ "type": "integer"
2275
+ }
2276
+ },
2277
+ "title": "range_query_specs",
2278
+ "type": "object"
2279
+ },
2280
+ {
2281
+ "type": "integer"
2282
+ }
2283
+ ]
2284
+ },
2285
+ "style": "deepObject"
2286
+ },
2287
+ {
2288
+ "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
2289
+ "in": "query",
2290
+ "name": "ending_before",
2291
+ "required": false,
2292
+ "schema": {
2293
+ "maxLength": 5000,
2294
+ "type": "string"
2295
+ },
2296
+ "style": "form"
2297
+ },
2298
+ {
2299
+ "description": "Specifies which fields in the response should be expanded.",
2300
+ "explode": true,
2301
+ "in": "query",
2302
+ "name": "expand",
2303
+ "required": false,
2304
+ "schema": {
2305
+ "items": {
2306
+ "maxLength": 5000,
2307
+ "type": "string"
2308
+ },
2309
+ "type": "array"
2310
+ },
2311
+ "style": "deepObject"
2312
+ },
2313
+ {
2314
+ "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
2315
+ "in": "query",
2316
+ "name": "limit",
2317
+ "required": false,
2318
+ "schema": {
2319
+ "type": "integer"
2320
+ },
2321
+ "style": "form"
2322
+ },
2323
+ {
2324
+ "description": "Only return plans for the given product.",
2325
+ "in": "query",
2326
+ "name": "product",
2327
+ "required": false,
2328
+ "schema": {
2329
+ "maxLength": 5000,
2330
+ "type": "string"
2331
+ },
2332
+ "style": "form"
2333
+ },
2334
+ {
2335
+ "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
2336
+ "in": "query",
2337
+ "name": "starting_after",
2338
+ "required": false,
2339
+ "schema": {
2340
+ "maxLength": 5000,
2341
+ "type": "string"
2342
+ },
2343
+ "style": "form"
2344
+ }
2345
+ ],
2346
+ "requestBody": {
2347
+ "content": {
2348
+ "application/x-www-form-urlencoded": {
2349
+ "encoding": {},
2350
+ "schema": {
2351
+ "additionalProperties": false,
2352
+ "properties": {},
2353
+ "type": "object"
2354
+ }
2355
+ }
2356
+ },
2357
+ "required": false
2358
+ },
2359
+ "responses": {
2360
+ "200": {
2361
+ "content": {
2362
+ "application/json": {
2363
+ "schema": {
2364
+ "description": "",
2365
+ "properties": {
2366
+ "data": {
2367
+ "description": "Details about each object.",
2368
+ "items": {
2369
+ "$ref": "#/components/schemas/plan"
2370
+ },
2371
+ "type": "array"
2372
+ },
2373
+ "has_more": {
2374
+ "description": "True if this list has another page of items after this one that can be fetched.",
2375
+ "type": "boolean"
2376
+ },
2377
+ "object": {
2378
+ "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
2379
+ "enum": [
2380
+ "list"
2381
+ ],
2382
+ "type": "string"
2383
+ },
2384
+ "url": {
2385
+ "description": "The URL where this list can be accessed.",
2386
+ "maxLength": 5000,
2387
+ "pattern": "^/v1/plans",
2388
+ "type": "string"
2389
+ }
2390
+ },
2391
+ "required": [
2392
+ "data",
2393
+ "has_more",
2394
+ "object",
2395
+ "url"
2396
+ ],
2397
+ "title": "PlanList",
2398
+ "type": "object",
2399
+ "x-expandableFields": [
2400
+ "data"
2401
+ ]
2402
+ }
2403
+ }
2404
+ },
2405
+ "description": "Successful response."
2406
+ },
2407
+ "default": {
2408
+ "content": {
2409
+ "application/json": {
2410
+ "schema": {
2411
+ "$ref": "#/components/schemas/error"
2412
+ }
2413
+ }
2414
+ },
2415
+ "description": "Error response."
2416
+ }
2417
+ },
2418
+ "summary": "List all plans"
2419
+ },
2420
+ "post": {
2421
+ "description": "<p>You can now model subscriptions more flexibly using the <a href=\"#prices\">Prices API</a>. It replaces the Plans API and is backwards compatible to simplify your migration.</p>",
2422
+ "operationId": "PostPlans",
2423
+ "requestBody": {
2424
+ "content": {
2425
+ "application/x-www-form-urlencoded": {
2426
+ "encoding": {
2427
+ "expand": {
2428
+ "explode": true,
2429
+ "style": "deepObject"
2430
+ },
2431
+ "metadata": {
2432
+ "explode": true,
2433
+ "style": "deepObject"
2434
+ },
2435
+ "product": {
2436
+ "explode": true,
2437
+ "style": "deepObject"
2438
+ },
2439
+ "tiers": {
2440
+ "explode": true,
2441
+ "style": "deepObject"
2442
+ },
2443
+ "transform_usage": {
2444
+ "explode": true,
2445
+ "style": "deepObject"
2446
+ }
2447
+ },
2448
+ "schema": {
2449
+ "additionalProperties": false,
2450
+ "properties": {
2451
+ "active": {
2452
+ "description": "Whether the plan is currently available for new subscriptions. Defaults to `true`.",
2453
+ "type": "boolean"
2454
+ },
2455
+ "amount": {
2456
+ "description": "A positive integer in cents (or local equivalent) (or 0 for a free plan) representing how much to charge on a recurring basis.",
2457
+ "type": "integer"
2458
+ },
2459
+ "amount_decimal": {
2460
+ "description": "Same as `amount`, but accepts a decimal value with at most 12 decimal places. Only one of `amount` and `amount_decimal` can be set.",
2461
+ "format": "decimal",
2462
+ "type": "string"
2463
+ },
2464
+ "billing_scheme": {
2465
+ "description": "Describes how to compute the price per period. Either `per_unit` or `tiered`. `per_unit` indicates that the fixed amount (specified in `amount`) will be charged per unit in `quantity` (for plans with `usage_type=licensed`), or per unit of total usage (for plans with `usage_type=metered`). `tiered` indicates that the unit pricing will be computed using a tiering strategy as defined using the `tiers` and `tiers_mode` attributes.",
2466
+ "enum": [
2467
+ "per_unit",
2468
+ "tiered"
2469
+ ],
2470
+ "type": "string"
2471
+ },
2472
+ "currency": {
2473
+ "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
2474
+ "format": "currency",
2475
+ "type": "string"
2476
+ },
2477
+ "expand": {
2478
+ "description": "Specifies which fields in the response should be expanded.",
2479
+ "items": {
2480
+ "maxLength": 5000,
2481
+ "type": "string"
2482
+ },
2483
+ "type": "array"
2484
+ },
2485
+ "id": {
2486
+ "description": "An identifier randomly generated by Stripe. Used to identify this plan when subscribing a customer. You can optionally override this ID, but the ID must be unique across all plans in your Stripe account. You can, however, use the same plan ID in both live and test modes.",
2487
+ "maxLength": 5000,
2488
+ "type": "string"
2489
+ },
2490
+ "interval": {
2491
+ "description": "Specifies billing frequency. Either `day`, `week`, `month` or `year`.",
2492
+ "enum": [
2493
+ "day",
2494
+ "month",
2495
+ "week",
2496
+ "year"
2497
+ ],
2498
+ "type": "string"
2499
+ },
2500
+ "interval_count": {
2501
+ "description": "The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).",
2502
+ "type": "integer"
2503
+ },
2504
+ "metadata": {
2505
+ "anyOf": [
2506
+ {
2507
+ "additionalProperties": {
2508
+ "type": "string"
2509
+ },
2510
+ "type": "object"
2511
+ },
2512
+ {
2513
+ "enum": [
2514
+ ""
2515
+ ],
2516
+ "type": "string"
2517
+ }
2518
+ ],
2519
+ "description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
2520
+ },
2521
+ "meter": {
2522
+ "description": "The meter tracking the usage of a metered price",
2523
+ "maxLength": 5000,
2524
+ "type": "string"
2525
+ },
2526
+ "nickname": {
2527
+ "description": "A brief description of the plan, hidden from customers.",
2528
+ "maxLength": 5000,
2529
+ "type": "string"
2530
+ },
2531
+ "product": {
2532
+ "anyOf": [
2533
+ {
2534
+ "description": "The product whose pricing the created plan will represent. This can either be the ID of an existing product, or a dictionary containing fields used to create a [service product](https://docs.stripe.com/api#product_object-type).",
2535
+ "properties": {
2536
+ "active": {
2537
+ "type": "boolean"
2538
+ },
2539
+ "id": {
2540
+ "deprecated": true,
2541
+ "maxLength": 5000,
2542
+ "type": "string"
2543
+ },
2544
+ "metadata": {
2545
+ "additionalProperties": {
2546
+ "type": "string"
2547
+ },
2548
+ "type": "object"
2549
+ },
2550
+ "name": {
2551
+ "maxLength": 5000,
2552
+ "type": "string"
2553
+ },
2554
+ "statement_descriptor": {
2555
+ "maxLength": 22,
2556
+ "type": "string"
2557
+ },
2558
+ "tax_code": {
2559
+ "maxLength": 5000,
2560
+ "type": "string"
2561
+ },
2562
+ "tax_details": {
2563
+ "properties": {
2564
+ "performance_location": {
2565
+ "maxLength": 5000,
2566
+ "type": "string"
2567
+ },
2568
+ "tax_code": {
2569
+ "anyOf": [
2570
+ {
2571
+ "type": "string"
2572
+ },
2573
+ {
2574
+ "enum": [
2575
+ ""
2576
+ ],
2577
+ "type": "string"
2578
+ }
2579
+ ]
2580
+ }
2581
+ },
2582
+ "title": "tax_details",
2583
+ "type": "object"
2584
+ },
2585
+ "unit_label": {
2586
+ "maxLength": 12,
2587
+ "type": "string"
2588
+ }
2589
+ },
2590
+ "required": [
2591
+ "name"
2592
+ ],
2593
+ "title": "inline_product_params",
2594
+ "type": "object"
2595
+ },
2596
+ {
2597
+ "description": "The ID of the product whose pricing the created plan will represent.",
2598
+ "maxLength": 5000,
2599
+ "type": "string"
2600
+ }
2601
+ ]
2602
+ },
2603
+ "tiers": {
2604
+ "description": "Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.",
2605
+ "items": {
2606
+ "properties": {
2607
+ "flat_amount": {
2608
+ "type": "integer"
2609
+ },
2610
+ "flat_amount_decimal": {
2611
+ "format": "decimal",
2612
+ "type": "string"
2613
+ },
2614
+ "unit_amount": {
2615
+ "type": "integer"
2616
+ },
2617
+ "unit_amount_decimal": {
2618
+ "format": "decimal",
2619
+ "type": "string"
2620
+ },
2621
+ "up_to": {
2622
+ "anyOf": [
2623
+ {
2624
+ "enum": [
2625
+ "inf"
2626
+ ],
2627
+ "maxLength": 5000,
2628
+ "type": "string"
2629
+ },
2630
+ {
2631
+ "type": "integer"
2632
+ }
2633
+ ]
2634
+ }
2635
+ },
2636
+ "required": [
2637
+ "up_to"
2638
+ ],
2639
+ "title": "tier",
2640
+ "type": "object"
2641
+ },
2642
+ "type": "array"
2643
+ },
2644
+ "tiers_mode": {
2645
+ "description": "Defines if the tiering price should be `graduated` or `volume` based. In `volume`-based tiering, the maximum quantity within a period determines the per unit price, in `graduated` tiering pricing can successively change as the quantity grows.",
2646
+ "enum": [
2647
+ "graduated",
2648
+ "volume"
2649
+ ],
2650
+ "type": "string"
2651
+ },
2652
+ "transform_usage": {
2653
+ "description": "Apply a transformation to the reported usage or set quantity before computing the billed price. Cannot be combined with `tiers`.",
2654
+ "properties": {
2655
+ "divide_by": {
2656
+ "type": "integer"
2657
+ },
2658
+ "round": {
2659
+ "enum": [
2660
+ "down",
2661
+ "up"
2662
+ ],
2663
+ "type": "string"
2664
+ }
2665
+ },
2666
+ "required": [
2667
+ "divide_by",
2668
+ "round"
2669
+ ],
2670
+ "title": "transform_usage_param",
2671
+ "type": "object"
2672
+ },
2673
+ "trial_period_days": {
2674
+ "description": "Default number of trial days when subscribing a customer to this plan using [`trial_from_plan=true`](https://docs.stripe.com/api#create_subscription-trial_from_plan).",
2675
+ "type": "integer"
2676
+ },
2677
+ "usage_type": {
2678
+ "description": "Configures how the quantity per period should be determined. Can be either `metered` or `licensed`. `licensed` automatically bills the `quantity` set when adding it to a subscription. `metered` aggregates the total usage based on usage records. Defaults to `licensed`.",
2679
+ "enum": [
2680
+ "licensed",
2681
+ "metered"
2682
+ ],
2683
+ "type": "string"
2684
+ }
2685
+ },
2686
+ "required": [
2687
+ "currency",
2688
+ "interval"
2689
+ ],
2690
+ "type": "object"
2691
+ }
2692
+ }
2693
+ },
2694
+ "required": true
2695
+ },
2696
+ "responses": {
2697
+ "200": {
2698
+ "content": {
2699
+ "application/json": {
2700
+ "schema": {
2701
+ "$ref": "#/components/schemas/plan"
2702
+ }
2703
+ }
2704
+ },
2705
+ "description": "Successful response."
2706
+ },
2707
+ "default": {
2708
+ "content": {
2709
+ "application/json": {
2710
+ "schema": {
2711
+ "$ref": "#/components/schemas/error"
2712
+ }
2713
+ }
2714
+ },
2715
+ "description": "Error response."
2716
+ }
2717
+ },
2718
+ "summary": "Create a plan"
2719
+ }
2720
+ },
2721
+ "/v1/plans/{plan}": {
2722
+ "delete": {
2723
+ "description": "<p>Deleting plans means new subscribers can\u2019t be added. Existing subscribers aren\u2019t affected.</p>",
2724
+ "operationId": "DeletePlansPlan",
2725
+ "parameters": [
2726
+ {
2727
+ "in": "path",
2728
+ "name": "plan",
2729
+ "required": true,
2730
+ "schema": {
2731
+ "maxLength": 5000,
2732
+ "type": "string"
2733
+ },
2734
+ "style": "simple"
2735
+ }
2736
+ ],
2737
+ "requestBody": {
2738
+ "content": {
2739
+ "application/x-www-form-urlencoded": {
2740
+ "encoding": {},
2741
+ "schema": {
2742
+ "additionalProperties": false,
2743
+ "properties": {},
2744
+ "type": "object"
2745
+ }
2746
+ }
2747
+ },
2748
+ "required": false
2749
+ },
2750
+ "responses": {
2751
+ "200": {
2752
+ "content": {
2753
+ "application/json": {
2754
+ "schema": {
2755
+ "$ref": "#/components/schemas/deleted_plan"
2756
+ }
2757
+ }
2758
+ },
2759
+ "description": "Successful response."
2760
+ },
2761
+ "default": {
2762
+ "content": {
2763
+ "application/json": {
2764
+ "schema": {
2765
+ "$ref": "#/components/schemas/error"
2766
+ }
2767
+ }
2768
+ },
2769
+ "description": "Error response."
2770
+ }
2771
+ },
2772
+ "summary": "Delete a plan"
2773
+ },
2774
+ "get": {
2775
+ "description": "<p>Retrieves the plan with the given ID.</p>",
2776
+ "operationId": "GetPlansPlan",
2777
+ "parameters": [
2778
+ {
2779
+ "description": "Specifies which fields in the response should be expanded.",
2780
+ "explode": true,
2781
+ "in": "query",
2782
+ "name": "expand",
2783
+ "required": false,
2784
+ "schema": {
2785
+ "items": {
2786
+ "maxLength": 5000,
2787
+ "type": "string"
2788
+ },
2789
+ "type": "array"
2790
+ },
2791
+ "style": "deepObject"
2792
+ },
2793
+ {
2794
+ "in": "path",
2795
+ "name": "plan",
2796
+ "required": true,
2797
+ "schema": {
2798
+ "maxLength": 5000,
2799
+ "type": "string"
2800
+ },
2801
+ "style": "simple"
2802
+ }
2803
+ ],
2804
+ "requestBody": {
2805
+ "content": {
2806
+ "application/x-www-form-urlencoded": {
2807
+ "encoding": {},
2808
+ "schema": {
2809
+ "additionalProperties": false,
2810
+ "properties": {},
2811
+ "type": "object"
2812
+ }
2813
+ }
2814
+ },
2815
+ "required": false
2816
+ },
2817
+ "responses": {
2818
+ "200": {
2819
+ "content": {
2820
+ "application/json": {
2821
+ "schema": {
2822
+ "$ref": "#/components/schemas/plan"
2823
+ }
2824
+ }
2825
+ },
2826
+ "description": "Successful response."
2827
+ },
2828
+ "default": {
2829
+ "content": {
2830
+ "application/json": {
2831
+ "schema": {
2832
+ "$ref": "#/components/schemas/error"
2833
+ }
2834
+ }
2835
+ },
2836
+ "description": "Error response."
2837
+ }
2838
+ },
2839
+ "summary": "Retrieve a plan"
2840
+ },
2841
+ "post": {
2842
+ "description": "<p>Updates the specified plan by setting the values of the parameters passed. Any parameters not provided are left unchanged. By design, you cannot change a plan\u2019s ID, amount, currency, or billing cycle.</p>",
2843
+ "operationId": "PostPlansPlan",
2844
+ "parameters": [
2845
+ {
2846
+ "in": "path",
2847
+ "name": "plan",
2848
+ "required": true,
2849
+ "schema": {
2850
+ "maxLength": 5000,
2851
+ "type": "string"
2852
+ },
2853
+ "style": "simple"
2854
+ }
2855
+ ],
2856
+ "requestBody": {
2857
+ "content": {
2858
+ "application/x-www-form-urlencoded": {
2859
+ "encoding": {
2860
+ "expand": {
2861
+ "explode": true,
2862
+ "style": "deepObject"
2863
+ },
2864
+ "metadata": {
2865
+ "explode": true,
2866
+ "style": "deepObject"
2867
+ }
2868
+ },
2869
+ "schema": {
2870
+ "additionalProperties": false,
2871
+ "properties": {
2872
+ "active": {
2873
+ "description": "Whether the plan is currently available for new subscriptions.",
2874
+ "type": "boolean"
2875
+ },
2876
+ "expand": {
2877
+ "description": "Specifies which fields in the response should be expanded.",
2878
+ "items": {
2879
+ "maxLength": 5000,
2880
+ "type": "string"
2881
+ },
2882
+ "type": "array"
2883
+ },
2884
+ "metadata": {
2885
+ "anyOf": [
2886
+ {
2887
+ "additionalProperties": {
2888
+ "type": "string"
2889
+ },
2890
+ "type": "object"
2891
+ },
2892
+ {
2893
+ "enum": [
2894
+ ""
2895
+ ],
2896
+ "type": "string"
2897
+ }
2898
+ ],
2899
+ "description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
2900
+ },
2901
+ "nickname": {
2902
+ "description": "A brief description of the plan, hidden from customers.",
2903
+ "maxLength": 5000,
2904
+ "type": "string"
2905
+ },
2906
+ "product": {
2907
+ "description": "The product the plan belongs to. This cannot be changed once it has been used in a subscription or subscription schedule.",
2908
+ "maxLength": 5000,
2909
+ "type": "string"
2910
+ },
2911
+ "trial_period_days": {
2912
+ "description": "Default number of trial days when subscribing a customer to this plan using [`trial_from_plan=true`](https://docs.stripe.com/api#create_subscription-trial_from_plan).",
2913
+ "type": "integer"
2914
+ }
2915
+ },
2916
+ "type": "object"
2917
+ }
2918
+ }
2919
+ },
2920
+ "required": false
2921
+ },
2922
+ "responses": {
2923
+ "200": {
2924
+ "content": {
2925
+ "application/json": {
2926
+ "schema": {
2927
+ "$ref": "#/components/schemas/plan"
2928
+ }
2929
+ }
2930
+ },
2931
+ "description": "Successful response."
2932
+ },
2933
+ "default": {
2934
+ "content": {
2935
+ "application/json": {
2936
+ "schema": {
2937
+ "$ref": "#/components/schemas/error"
2938
+ }
2939
+ }
2940
+ },
2941
+ "description": "Error response."
2942
+ }
2943
+ },
2944
+ "summary": "Update a plan"
2945
+ }
2946
+ },
2947
+ "/v1/prices": {
2948
+ "get": {
2949
+ "operationId": "GetPrices",
2950
+ "summary": "List all prices",
2951
+ "tags": [
2952
+ "prices"
2953
+ ]
2954
+ },
2955
+ "post": {
2956
+ "operationId": "PostPrices",
2957
+ "summary": "Create a price",
2958
+ "tags": [
2959
+ "prices"
2960
+ ]
2961
+ }
2962
+ },
2963
+ "/v1/prices/{price}": {
2964
+ "get": {
2965
+ "operationId": "GetPricesPrice",
2966
+ "summary": "Retrieve a price",
2967
+ "tags": [
2968
+ "prices"
2969
+ ]
2970
+ },
2971
+ "post": {
2972
+ "operationId": "PostPricesPrice",
2973
+ "summary": "Update a price",
2974
+ "tags": [
2975
+ "prices"
2976
+ ]
2977
+ }
2978
+ },
2979
+ "/v1/prices/search": {
2980
+ "get": {
2981
+ "operationId": "GetPricesSearch",
2982
+ "summary": "Search prices",
2983
+ "tags": [
2984
+ "prices"
2985
+ ]
2986
+ }
2987
+ },
2988
+ "/v1/products": {
2989
+ "get": {
2990
+ "operationId": "GetProducts",
2991
+ "summary": "List all products",
2992
+ "tags": [
2993
+ "products"
2994
+ ]
2995
+ },
2996
+ "post": {
2997
+ "operationId": "PostProducts",
2998
+ "summary": "Create a product",
2999
+ "tags": [
3000
+ "products"
3001
+ ]
3002
+ }
3003
+ },
3004
+ "/v1/products/{id}": {
3005
+ "delete": {
3006
+ "operationId": "DeleteProductsId",
3007
+ "summary": "Delete a product",
3008
+ "tags": [
3009
+ "products"
3010
+ ]
3011
+ },
3012
+ "get": {
3013
+ "operationId": "GetProductsId",
3014
+ "summary": "Retrieve a product",
3015
+ "tags": [
3016
+ "products"
3017
+ ]
3018
+ },
3019
+ "post": {
3020
+ "operationId": "PostProductsId",
3021
+ "summary": "Update a product",
3022
+ "tags": [
3023
+ "products"
3024
+ ]
3025
+ }
3026
+ },
3027
+ "/v1/products/{product}/features": {
3028
+ "get": {
3029
+ "operationId": "GetProductsProductFeatures",
3030
+ "summary": "List all features attached to a product",
3031
+ "tags": [
3032
+ "products"
3033
+ ]
3034
+ },
3035
+ "post": {
3036
+ "operationId": "PostProductsProductFeatures",
3037
+ "summary": "Attach a feature to a product",
3038
+ "tags": [
3039
+ "products"
3040
+ ]
3041
+ }
3042
+ },
3043
+ "/v1/products/{product}/features/{id}": {
3044
+ "delete": {
3045
+ "operationId": "DeleteProductsProductFeaturesId",
3046
+ "summary": "Remove a feature from a product",
3047
+ "tags": [
3048
+ "products"
3049
+ ]
3050
+ },
3051
+ "get": {
3052
+ "operationId": "GetProductsProductFeaturesId",
3053
+ "summary": "Retrieve a product_feature",
3054
+ "tags": [
3055
+ "products"
3056
+ ]
3057
+ }
3058
+ },
3059
+ "/v1/products/search": {
3060
+ "get": {
3061
+ "operationId": "GetProductsSearch",
3062
+ "summary": "Search products",
3063
+ "tags": [
3064
+ "products"
3065
+ ]
3066
+ }
3067
+ },
3068
+ "/v1/promotion_codes": {
3069
+ "get": {
3070
+ "operationId": "GetPromotionCodes",
3071
+ "summary": "List all promotion codes",
3072
+ "tags": [
3073
+ "promotion_codes"
3074
+ ]
3075
+ },
3076
+ "post": {
3077
+ "operationId": "PostPromotionCodes",
3078
+ "summary": "Create a promotion code",
3079
+ "tags": [
3080
+ "promotion_codes"
3081
+ ]
3082
+ }
3083
+ },
3084
+ "/v1/promotion_codes/{promotion_code}": {
3085
+ "get": {
3086
+ "operationId": "GetPromotionCodesPromotionCode",
3087
+ "summary": "Retrieve a promotion code",
3088
+ "tags": [
3089
+ "promotion_codes"
3090
+ ]
3091
+ },
3092
+ "post": {
3093
+ "operationId": "PostPromotionCodesPromotionCode",
3094
+ "summary": "Update a promotion code",
3095
+ "tags": [
3096
+ "promotion_codes"
3097
+ ]
3098
+ }
3099
+ },
3100
+ "/v1/quotes": {
3101
+ "get": {
3102
+ "operationId": "GetQuotes",
3103
+ "summary": "List all quotes",
3104
+ "tags": [
3105
+ "quotes"
3106
+ ]
3107
+ },
3108
+ "post": {
3109
+ "operationId": "PostQuotes",
3110
+ "summary": "Create a quote",
3111
+ "tags": [
3112
+ "quotes"
3113
+ ]
3114
+ }
3115
+ },
3116
+ "/v1/quotes/{quote}": {
3117
+ "get": {
3118
+ "operationId": "GetQuotesQuote",
3119
+ "summary": "Retrieve a quote",
3120
+ "tags": [
3121
+ "quotes"
3122
+ ]
3123
+ },
3124
+ "post": {
3125
+ "operationId": "PostQuotesQuote",
3126
+ "summary": "Update a quote",
3127
+ "tags": [
3128
+ "quotes"
3129
+ ]
3130
+ }
3131
+ },
3132
+ "/v1/quotes/{quote}/accept": {
3133
+ "post": {
3134
+ "operationId": "PostQuotesQuoteAccept",
3135
+ "summary": "Accept a quote",
3136
+ "tags": [
3137
+ "quotes"
3138
+ ]
3139
+ }
3140
+ },
3141
+ "/v1/quotes/{quote}/cancel": {
3142
+ "post": {
3143
+ "operationId": "PostQuotesQuoteCancel",
3144
+ "summary": "Cancel a quote",
3145
+ "tags": [
3146
+ "quotes"
3147
+ ]
3148
+ }
3149
+ },
3150
+ "/v1/quotes/{quote}/computed_upfront_line_items": {
3151
+ "get": {
3152
+ "operationId": "GetQuotesQuoteComputedUpfrontLineItems",
3153
+ "summary": "Retrieve a quote's upfront line items",
3154
+ "tags": [
3155
+ "quotes"
3156
+ ]
3157
+ }
3158
+ },
3159
+ "/v1/quotes/{quote}/finalize": {
3160
+ "post": {
3161
+ "operationId": "PostQuotesQuoteFinalize",
3162
+ "summary": "Finalize a quote",
3163
+ "tags": [
3164
+ "quotes"
3165
+ ]
3166
+ }
3167
+ },
3168
+ "/v1/quotes/{quote}/line_items": {
3169
+ "get": {
3170
+ "operationId": "GetQuotesQuoteLineItems",
3171
+ "summary": "Retrieve a quote's line items",
3172
+ "tags": [
3173
+ "quotes"
3174
+ ]
3175
+ }
3176
+ },
3177
+ "/v1/quotes/{quote}/pdf": {
3178
+ "get": {
3179
+ "operationId": "GetQuotesQuotePdf",
3180
+ "summary": "Download quote PDF",
3181
+ "tags": [
3182
+ "quotes"
3183
+ ]
3184
+ }
3185
+ },
3186
+ "/v1/radar/early_fraud_warnings": {
3187
+ "get": {
3188
+ "operationId": "GetRadarEarlyFraudWarnings",
3189
+ "summary": "List all early fraud warnings",
3190
+ "tags": [
3191
+ "radar"
3192
+ ]
3193
+ }
3194
+ },
3195
+ "/v1/radar/early_fraud_warnings/{early_fraud_warning}": {
3196
+ "get": {
3197
+ "operationId": "GetRadarEarlyFraudWarningsEarlyFraudWarning",
3198
+ "summary": "Retrieve an early fraud warning",
3199
+ "tags": [
3200
+ "radar"
3201
+ ]
3202
+ }
3203
+ },
3204
+ "/v1/radar/payment_evaluations": {
3205
+ "post": {
3206
+ "operationId": "PostRadarPaymentEvaluations",
3207
+ "summary": "Create a Payment Evaluation",
3208
+ "tags": [
3209
+ "radar"
3210
+ ]
3211
+ }
3212
+ },
3213
+ "/v1/radar/value_list_items": {
3214
+ "get": {
3215
+ "operationId": "GetRadarValueListItems",
3216
+ "summary": "List all value list items",
3217
+ "tags": [
3218
+ "radar"
3219
+ ]
3220
+ },
3221
+ "post": {
3222
+ "operationId": "PostRadarValueListItems",
3223
+ "summary": "Create a value list item",
3224
+ "tags": [
3225
+ "radar"
3226
+ ]
3227
+ }
3228
+ },
3229
+ "/v1/radar/value_list_items/{item}": {
3230
+ "delete": {
3231
+ "operationId": "DeleteRadarValueListItemsItem",
3232
+ "summary": "Delete a value list item",
3233
+ "tags": [
3234
+ "radar"
3235
+ ]
3236
+ },
3237
+ "get": {
3238
+ "operationId": "GetRadarValueListItemsItem",
3239
+ "summary": "Retrieve a value list item",
3240
+ "tags": [
3241
+ "radar"
3242
+ ]
3243
+ }
3244
+ },
3245
+ "/v1/radar/value_lists": {
3246
+ "get": {
3247
+ "operationId": "GetRadarValueLists",
3248
+ "summary": "List all value lists",
3249
+ "tags": [
3250
+ "radar"
3251
+ ]
3252
+ },
3253
+ "post": {
3254
+ "operationId": "PostRadarValueLists",
3255
+ "summary": "Create a value list",
3256
+ "tags": [
3257
+ "radar"
3258
+ ]
3259
+ }
3260
+ },
3261
+ "/v1/radar/value_lists/{value_list}": {
3262
+ "delete": {
3263
+ "operationId": "DeleteRadarValueListsValueList",
3264
+ "summary": "Delete a value list",
3265
+ "tags": [
3266
+ "radar"
3267
+ ]
3268
+ },
3269
+ "get": {
3270
+ "operationId": "GetRadarValueListsValueList",
3271
+ "summary": "Retrieve a value list",
3272
+ "tags": [
3273
+ "radar"
3274
+ ]
3275
+ },
3276
+ "post": {
3277
+ "operationId": "PostRadarValueListsValueList",
3278
+ "summary": "Update a value list",
3279
+ "tags": [
3280
+ "radar"
3281
+ ]
3282
+ }
3283
+ },
3284
+ "/v1/refunds": {
3285
+ "get": {
3286
+ "operationId": "GetRefunds",
3287
+ "summary": "List all refunds",
3288
+ "tags": [
3289
+ "refunds"
3290
+ ]
3291
+ },
3292
+ "post": {
3293
+ "operationId": "PostRefunds",
3294
+ "summary": "Create a refund",
3295
+ "tags": [
3296
+ "refunds"
3297
+ ]
3298
+ }
3299
+ },
3300
+ "/v1/refunds/{refund}": {
3301
+ "get": {
3302
+ "operationId": "GetRefundsRefund",
3303
+ "summary": "Retrieve a refund",
3304
+ "tags": [
3305
+ "refunds"
3306
+ ]
3307
+ },
3308
+ "post": {
3309
+ "operationId": "PostRefundsRefund",
3310
+ "summary": "Update a refund",
3311
+ "tags": [
3312
+ "refunds"
3313
+ ]
3314
+ }
3315
+ },
3316
+ "/v1/refunds/{refund}/cancel": {
3317
+ "post": {
3318
+ "operationId": "PostRefundsRefundCancel",
3319
+ "summary": "Cancel a refund",
3320
+ "tags": [
3321
+ "refunds"
3322
+ ]
3323
+ }
3324
+ },
3325
+ "/v1/reporting/report_runs": {
3326
+ "get": {
3327
+ "operationId": "GetReportingReportRuns",
3328
+ "summary": "List all Report Runs",
3329
+ "tags": [
3330
+ "reporting"
3331
+ ]
3332
+ },
3333
+ "post": {
3334
+ "operationId": "PostReportingReportRuns",
3335
+ "summary": "Create a Report Run",
3336
+ "tags": [
3337
+ "reporting"
3338
+ ]
3339
+ }
3340
+ },
3341
+ "/v1/reporting/report_runs/{report_run}": {
3342
+ "get": {
3343
+ "operationId": "GetReportingReportRunsReportRun",
3344
+ "summary": "Retrieve a Report Run",
3345
+ "tags": [
3346
+ "reporting"
3347
+ ]
3348
+ }
3349
+ },
3350
+ "/v1/reporting/report_types": {
3351
+ "get": {
3352
+ "operationId": "GetReportingReportTypes",
3353
+ "summary": "List all Report Types",
3354
+ "tags": [
3355
+ "reporting"
3356
+ ]
3357
+ }
3358
+ },
3359
+ "/v1/reporting/report_types/{report_type}": {
3360
+ "get": {
3361
+ "operationId": "GetReportingReportTypesReportType",
3362
+ "summary": "Retrieve a Report Type",
3363
+ "tags": [
3364
+ "reporting"
3365
+ ]
3366
+ }
3367
+ },
3368
+ "/v1/reviews": {
3369
+ "get": {
3370
+ "operationId": "GetReviews",
3371
+ "summary": "List all open reviews",
3372
+ "tags": [
3373
+ "reviews"
3374
+ ]
3375
+ }
3376
+ },
3377
+ "/v1/reviews/{review}": {
3378
+ "get": {
3379
+ "operationId": "GetReviewsReview",
3380
+ "summary": "Retrieve a review",
3381
+ "tags": [
3382
+ "reviews"
3383
+ ]
3384
+ }
3385
+ },
3386
+ "/v1/reviews/{review}/approve": {
3387
+ "post": {
3388
+ "operationId": "PostReviewsReviewApprove",
3389
+ "summary": "Approve a review",
3390
+ "tags": [
3391
+ "reviews"
3392
+ ]
3393
+ }
3394
+ },
3395
+ "/v1/setup_intents": {
3396
+ "get": {
3397
+ "operationId": "GetSetupIntents",
3398
+ "summary": "List all SetupIntents",
3399
+ "tags": [
3400
+ "setup_intents"
3401
+ ]
3402
+ },
3403
+ "post": {
3404
+ "operationId": "PostSetupIntents",
3405
+ "summary": "Create a SetupIntent",
3406
+ "tags": [
3407
+ "setup_intents"
3408
+ ]
3409
+ }
3410
+ },
3411
+ "/v1/setup_intents/{intent}": {
3412
+ "get": {
3413
+ "operationId": "GetSetupIntentsIntent",
3414
+ "summary": "Retrieve a SetupIntent",
3415
+ "tags": [
3416
+ "setup_intents"
3417
+ ]
3418
+ },
3419
+ "post": {
3420
+ "operationId": "PostSetupIntentsIntent",
3421
+ "summary": "Update a SetupIntent",
3422
+ "tags": [
3423
+ "setup_intents"
3424
+ ]
3425
+ }
3426
+ },
3427
+ "/v1/setup_intents/{intent}/cancel": {
3428
+ "post": {
3429
+ "operationId": "PostSetupIntentsIntentCancel",
3430
+ "summary": "Cancel a SetupIntent",
3431
+ "tags": [
3432
+ "setup_intents"
3433
+ ]
3434
+ }
3435
+ },
3436
+ "/v1/setup_intents/{intent}/confirm": {
3437
+ "post": {
3438
+ "operationId": "PostSetupIntentsIntentConfirm",
3439
+ "summary": "Confirm a SetupIntent",
3440
+ "tags": [
3441
+ "setup_intents"
3442
+ ]
3443
+ }
3444
+ },
3445
+ "/v1/setup_intents/{intent}/verify_microdeposits": {
3446
+ "post": {
3447
+ "operationId": "PostSetupIntentsIntentVerifyMicrodeposits",
3448
+ "summary": "Verify microdeposits on a SetupIntent",
3449
+ "tags": [
3450
+ "setup_intents"
3451
+ ]
3452
+ }
3453
+ },
3454
+ "/v1/sources": {
3455
+ "post": {
3456
+ "operationId": "PostSources",
3457
+ "summary": "Create a source",
3458
+ "tags": [
3459
+ "sources"
3460
+ ]
3461
+ }
3462
+ },
3463
+ "/v1/sources/{source}": {
3464
+ "get": {
3465
+ "operationId": "GetSourcesSource",
3466
+ "summary": "Retrieve a source",
3467
+ "tags": [
3468
+ "sources"
3469
+ ]
3470
+ },
3471
+ "post": {
3472
+ "operationId": "PostSourcesSource",
3473
+ "summary": "Update a source",
3474
+ "tags": [
3475
+ "sources"
3476
+ ]
3477
+ }
3478
+ },
3479
+ "/v1/sources/{source}/mandate_notifications/{mandate_notification}": {
3480
+ "get": {
3481
+ "operationId": "GetSourcesSourceMandateNotificationsMandateNotification",
3482
+ "summary": "Retrieve a Source MandateNotification",
3483
+ "tags": [
3484
+ "sources"
3485
+ ]
3486
+ }
3487
+ },
3488
+ "/v1/sources/{source}/source_transactions": {
3489
+ "get": {
3490
+ "operationId": "GetSourcesSourceSourceTransactions",
3491
+ "summary": "<p>List source transactions for a given source.</p>",
3492
+ "tags": [
3493
+ "sources"
3494
+ ]
3495
+ }
3496
+ },
3497
+ "/v1/sources/{source}/source_transactions/{source_transaction}": {
3498
+ "get": {
3499
+ "operationId": "GetSourcesSourceSourceTransactionsSourceTransaction",
3500
+ "summary": "Retrieve a source transaction",
3501
+ "tags": [
3502
+ "sources"
3503
+ ]
3504
+ }
3505
+ },
3506
+ "/v1/sources/{source}/verify": {
3507
+ "post": {
3508
+ "operationId": "PostSourcesSourceVerify",
3509
+ "summary": "<p>Verify a given source.</p>",
3510
+ "tags": [
3511
+ "sources"
3512
+ ]
3513
+ }
3514
+ },
3515
+ "/v1/subscription_items": {
3516
+ "get": {
3517
+ "operationId": "GetSubscriptionItems",
3518
+ "summary": "List all subscription items",
3519
+ "tags": [
3520
+ "subscription_items"
3521
+ ]
3522
+ },
3523
+ "post": {
3524
+ "operationId": "PostSubscriptionItems",
3525
+ "summary": "Create a subscription item",
3526
+ "tags": [
3527
+ "subscription_items"
3528
+ ]
3529
+ }
3530
+ },
3531
+ "/v1/subscription_items/{item}": {
3532
+ "delete": {
3533
+ "operationId": "DeleteSubscriptionItemsItem",
3534
+ "summary": "Delete a subscription item",
3535
+ "tags": [
3536
+ "subscription_items"
3537
+ ]
3538
+ },
3539
+ "get": {
3540
+ "operationId": "GetSubscriptionItemsItem",
3541
+ "summary": "Retrieve a subscription item",
3542
+ "tags": [
3543
+ "subscription_items"
3544
+ ]
3545
+ },
3546
+ "post": {
3547
+ "operationId": "PostSubscriptionItemsItem",
3548
+ "summary": "Update a subscription item",
3549
+ "tags": [
3550
+ "subscription_items"
3551
+ ]
3552
+ }
3553
+ },
3554
+ "/v1/subscription_schedules": {
3555
+ "get": {
3556
+ "operationId": "GetSubscriptionSchedules",
3557
+ "summary": "List all schedules",
3558
+ "tags": [
3559
+ "subscription_schedules"
3560
+ ]
3561
+ },
3562
+ "post": {
3563
+ "operationId": "PostSubscriptionSchedules",
3564
+ "summary": "Create a schedule",
3565
+ "tags": [
3566
+ "subscription_schedules"
3567
+ ]
3568
+ }
3569
+ },
3570
+ "/v1/subscription_schedules/{schedule}": {
3571
+ "get": {
3572
+ "operationId": "GetSubscriptionSchedulesSchedule",
3573
+ "summary": "Retrieve a schedule",
3574
+ "tags": [
3575
+ "subscription_schedules"
3576
+ ]
3577
+ },
3578
+ "post": {
3579
+ "operationId": "PostSubscriptionSchedulesSchedule",
3580
+ "summary": "Update a schedule",
3581
+ "tags": [
3582
+ "subscription_schedules"
3583
+ ]
3584
+ }
3585
+ },
3586
+ "/v1/subscription_schedules/{schedule}/cancel": {
3587
+ "post": {
3588
+ "operationId": "PostSubscriptionSchedulesScheduleCancel",
3589
+ "summary": "Cancel a schedule",
3590
+ "tags": [
3591
+ "subscription_schedules"
3592
+ ]
3593
+ }
3594
+ },
3595
+ "/v1/subscription_schedules/{schedule}/release": {
3596
+ "post": {
3597
+ "operationId": "PostSubscriptionSchedulesScheduleRelease",
3598
+ "summary": "Release a schedule",
3599
+ "tags": [
3600
+ "subscription_schedules"
3601
+ ]
3602
+ }
3603
+ },
3604
+ "/v1/subscriptions": {
3605
+ "get": {
3606
+ "operationId": "GetSubscriptions",
3607
+ "summary": "List subscriptions",
3608
+ "tags": [
3609
+ "subscriptions"
3610
+ ]
3611
+ },
3612
+ "post": {
3613
+ "operationId": "PostSubscriptions",
3614
+ "summary": "Create a subscription",
3615
+ "tags": [
3616
+ "subscriptions"
3617
+ ]
3618
+ }
3619
+ },
3620
+ "/v1/subscriptions/{subscription_exposed_id}": {
3621
+ "delete": {
3622
+ "operationId": "DeleteSubscriptionsSubscriptionExposedId",
3623
+ "summary": "Cancel a subscription",
3624
+ "tags": [
3625
+ "subscriptions"
3626
+ ]
3627
+ },
3628
+ "get": {
3629
+ "operationId": "GetSubscriptionsSubscriptionExposedId",
3630
+ "summary": "Retrieve a subscription",
3631
+ "tags": [
3632
+ "subscriptions"
3633
+ ]
3634
+ },
3635
+ "post": {
3636
+ "operationId": "PostSubscriptionsSubscriptionExposedId",
3637
+ "summary": "Update a subscription",
3638
+ "tags": [
3639
+ "subscriptions"
3640
+ ]
3641
+ }
3642
+ },
3643
+ "/v1/subscriptions/{subscription_exposed_id}/discount": {
3644
+ "delete": {
3645
+ "operationId": "DeleteSubscriptionsSubscriptionExposedIdDiscount",
3646
+ "summary": "Delete a subscription discount",
3647
+ "tags": [
3648
+ "subscriptions"
3649
+ ]
3650
+ }
3651
+ },
3652
+ "/v1/subscriptions/{subscription}/migrate": {
3653
+ "post": {
3654
+ "operationId": "PostSubscriptionsSubscriptionMigrate",
3655
+ "summary": "Migrate a subscription",
3656
+ "tags": [
3657
+ "subscriptions"
3658
+ ]
3659
+ }
3660
+ },
3661
+ "/v1/subscriptions/{subscription}/resume": {
3662
+ "post": {
3663
+ "operationId": "PostSubscriptionsSubscriptionResume",
3664
+ "summary": "Resume a subscription",
3665
+ "tags": [
3666
+ "subscriptions"
3667
+ ]
3668
+ }
3669
+ },
3670
+ "/v1/subscriptions/search": {
3671
+ "get": {
3672
+ "operationId": "GetSubscriptionsSearch",
3673
+ "summary": "Search subscriptions",
3674
+ "tags": [
3675
+ "subscriptions"
3676
+ ]
3677
+ }
3678
+ },
3679
+ "/v1/tax_codes": {
3680
+ "get": {
3681
+ "operationId": "GetTaxCodes",
3682
+ "summary": "List all tax codes",
3683
+ "tags": [
3684
+ "tax_codes"
3685
+ ]
3686
+ }
3687
+ },
3688
+ "/v1/tax_codes/{id}": {
3689
+ "get": {
3690
+ "operationId": "GetTaxCodesId",
3691
+ "summary": "Retrieve a tax code",
3692
+ "tags": [
3693
+ "tax_codes"
3694
+ ]
3695
+ }
3696
+ },
3697
+ "/v1/tax_ids": {
3698
+ "get": {
3699
+ "operationId": "GetTaxIds",
3700
+ "summary": "List all tax IDs",
3701
+ "tags": [
3702
+ "tax_ids"
3703
+ ]
3704
+ },
3705
+ "post": {
3706
+ "operationId": "PostTaxIds",
3707
+ "summary": "Create a tax ID",
3708
+ "tags": [
3709
+ "tax_ids"
3710
+ ]
3711
+ }
3712
+ },
3713
+ "/v1/tax_ids/{id}": {
3714
+ "delete": {
3715
+ "operationId": "DeleteTaxIdsId",
3716
+ "summary": "Delete a tax ID",
3717
+ "tags": [
3718
+ "tax_ids"
3719
+ ]
3720
+ },
3721
+ "get": {
3722
+ "operationId": "GetTaxIdsId",
3723
+ "summary": "Retrieve a tax ID",
3724
+ "tags": [
3725
+ "tax_ids"
3726
+ ]
3727
+ }
3728
+ },
3729
+ "/v1/tax_rates": {
3730
+ "get": {
3731
+ "operationId": "GetTaxRates",
3732
+ "summary": "List all tax rates",
3733
+ "tags": [
3734
+ "tax_rates"
3735
+ ]
3736
+ },
3737
+ "post": {
3738
+ "operationId": "PostTaxRates",
3739
+ "summary": "Create a tax rate",
3740
+ "tags": [
3741
+ "tax_rates"
3742
+ ]
3743
+ }
3744
+ },
3745
+ "/v1/tax_rates/{tax_rate}": {
3746
+ "get": {
3747
+ "operationId": "GetTaxRatesTaxRate",
3748
+ "summary": "Retrieve a tax rate",
3749
+ "tags": [
3750
+ "tax_rates"
3751
+ ]
3752
+ },
3753
+ "post": {
3754
+ "operationId": "PostTaxRatesTaxRate",
3755
+ "summary": "Update a tax rate",
3756
+ "tags": [
3757
+ "tax_rates"
3758
+ ]
3759
+ }
3760
+ },
3761
+ "/v1/tax/associations/find": {
3762
+ "get": {
3763
+ "operationId": "GetTaxAssociationsFind",
3764
+ "summary": "Find a Tax Association",
3765
+ "tags": [
3766
+ "tax"
3767
+ ]
3768
+ }
3769
+ },
3770
+ "/v1/tax/calculations": {
3771
+ "post": {
3772
+ "operationId": "PostTaxCalculations",
3773
+ "summary": "Create a Calculation",
3774
+ "tags": [
3775
+ "tax"
3776
+ ]
3777
+ }
3778
+ },
3779
+ "/v1/tax/calculations/{calculation}": {
3780
+ "get": {
3781
+ "operationId": "GetTaxCalculationsCalculation",
3782
+ "summary": "Retrieve a Calculation",
3783
+ "tags": [
3784
+ "tax"
3785
+ ]
3786
+ }
3787
+ },
3788
+ "/v1/tax/calculations/{calculation}/line_items": {
3789
+ "get": {
3790
+ "operationId": "GetTaxCalculationsCalculationLineItems",
3791
+ "summary": "Retrieve a Calculation's line items",
3792
+ "tags": [
3793
+ "tax"
3794
+ ]
3795
+ }
3796
+ },
3797
+ "/v1/tax/registrations": {
3798
+ "get": {
3799
+ "operationId": "GetTaxRegistrations",
3800
+ "summary": "List registrations",
3801
+ "tags": [
3802
+ "tax"
3803
+ ]
3804
+ },
3805
+ "post": {
3806
+ "operationId": "PostTaxRegistrations",
3807
+ "summary": "Create a registration",
3808
+ "tags": [
3809
+ "tax"
3810
+ ]
3811
+ }
3812
+ },
3813
+ "/v1/tax/registrations/{id}": {
3814
+ "get": {
3815
+ "operationId": "GetTaxRegistrationsId",
3816
+ "summary": "Retrieve a registration",
3817
+ "tags": [
3818
+ "tax"
3819
+ ]
3820
+ },
3821
+ "post": {
3822
+ "operationId": "PostTaxRegistrationsId",
3823
+ "summary": "Update a registration",
3824
+ "tags": [
3825
+ "tax"
3826
+ ]
3827
+ }
3828
+ },
3829
+ "/v1/tax/settings": {
3830
+ "get": {
3831
+ "operationId": "GetTaxSettings",
3832
+ "summary": "Retrieve settings",
3833
+ "tags": [
3834
+ "tax"
3835
+ ]
3836
+ },
3837
+ "post": {
3838
+ "operationId": "PostTaxSettings",
3839
+ "summary": "Update settings",
3840
+ "tags": [
3841
+ "tax"
3842
+ ]
3843
+ }
3844
+ },
3845
+ "/v1/tax/transactions/{transaction}": {
3846
+ "get": {
3847
+ "operationId": "GetTaxTransactionsTransaction",
3848
+ "summary": "Retrieve a Transaction",
3849
+ "tags": [
3850
+ "tax"
3851
+ ]
3852
+ }
3853
+ },
3854
+ "/v1/tax/transactions/{transaction}/line_items": {
3855
+ "get": {
3856
+ "operationId": "GetTaxTransactionsTransactionLineItems",
3857
+ "summary": "Retrieve a Transaction's line items",
3858
+ "tags": [
3859
+ "tax"
3860
+ ]
3861
+ }
3862
+ },
3863
+ "/v1/tax/transactions/create_from_calculation": {
3864
+ "post": {
3865
+ "operationId": "PostTaxTransactionsCreateFromCalculation",
3866
+ "summary": "Create a Transaction from a Calculation",
3867
+ "tags": [
3868
+ "tax"
3869
+ ]
3870
+ }
3871
+ },
3872
+ "/v1/tax/transactions/create_reversal": {
3873
+ "post": {
3874
+ "operationId": "PostTaxTransactionsCreateReversal",
3875
+ "summary": "Create a reversal Transaction",
3876
+ "tags": [
3877
+ "tax"
3878
+ ]
3879
+ }
3880
+ },
3881
+ "/v1/test_helpers/confirmation_tokens": {
3882
+ "post": {
3883
+ "operationId": "PostTestHelpersConfirmationTokens",
3884
+ "summary": "Create a test Confirmation Token",
3885
+ "tags": [
3886
+ "test_helpers"
3887
+ ]
3888
+ }
3889
+ },
3890
+ "/v1/test_helpers/customers/{customer}/fund_cash_balance": {
3891
+ "post": {
3892
+ "operationId": "PostTestHelpersCustomersCustomerFundCashBalance",
3893
+ "summary": "Fund a test mode cash balance",
3894
+ "tags": [
3895
+ "test_helpers"
3896
+ ]
3897
+ }
3898
+ },
3899
+ "/v1/test_helpers/issuing/authorizations": {
3900
+ "post": {
3901
+ "operationId": "PostTestHelpersIssuingAuthorizations",
3902
+ "summary": "Create a test-mode authorization",
3903
+ "tags": [
3904
+ "test_helpers"
3905
+ ]
3906
+ }
3907
+ },
3908
+ "/v1/test_helpers/issuing/authorizations/{authorization}/capture": {
3909
+ "post": {
3910
+ "operationId": "PostTestHelpersIssuingAuthorizationsAuthorizationCapture",
3911
+ "summary": "Capture a test-mode authorization",
3912
+ "tags": [
3913
+ "test_helpers"
3914
+ ]
3915
+ }
3916
+ },
3917
+ "/v1/test_helpers/issuing/authorizations/{authorization}/expire": {
3918
+ "post": {
3919
+ "operationId": "PostTestHelpersIssuingAuthorizationsAuthorizationExpire",
3920
+ "summary": "Expire a test-mode authorization",
3921
+ "tags": [
3922
+ "test_helpers"
3923
+ ]
3924
+ }
3925
+ },
3926
+ "/v1/test_helpers/issuing/authorizations/{authorization}/finalize_amount": {
3927
+ "post": {
3928
+ "operationId": "PostTestHelpersIssuingAuthorizationsAuthorizationFinalizeAmount",
3929
+ "summary": "Finalize a test-mode authorization's amount",
3930
+ "tags": [
3931
+ "test_helpers"
3932
+ ]
3933
+ }
3934
+ },
3935
+ "/v1/test_helpers/issuing/authorizations/{authorization}/fraud_challenges/respond": {
3936
+ "post": {
3937
+ "operationId": "PostTestHelpersIssuingAuthorizationsAuthorizationFraudChallengesRespond",
3938
+ "summary": "Respond to fraud challenge",
3939
+ "tags": [
3940
+ "test_helpers"
3941
+ ]
3942
+ }
3943
+ },
3944
+ "/v1/test_helpers/issuing/authorizations/{authorization}/increment": {
3945
+ "post": {
3946
+ "operationId": "PostTestHelpersIssuingAuthorizationsAuthorizationIncrement",
3947
+ "summary": "Increment a test-mode authorization",
3948
+ "tags": [
3949
+ "test_helpers"
3950
+ ]
3951
+ }
3952
+ },
3953
+ "/v1/test_helpers/issuing/authorizations/{authorization}/reverse": {
3954
+ "post": {
3955
+ "operationId": "PostTestHelpersIssuingAuthorizationsAuthorizationReverse",
3956
+ "summary": "Reverse a test-mode authorization",
3957
+ "tags": [
3958
+ "test_helpers"
3959
+ ]
3960
+ }
3961
+ },
3962
+ "/v1/test_helpers/issuing/cards/{card}/shipping/deliver": {
3963
+ "post": {
3964
+ "operationId": "PostTestHelpersIssuingCardsCardShippingDeliver",
3965
+ "summary": "Deliver a testmode card",
3966
+ "tags": [
3967
+ "test_helpers"
3968
+ ]
3969
+ }
3970
+ },
3971
+ "/v1/test_helpers/issuing/cards/{card}/shipping/fail": {
3972
+ "post": {
3973
+ "operationId": "PostTestHelpersIssuingCardsCardShippingFail",
3974
+ "summary": "Fail a testmode card",
3975
+ "tags": [
3976
+ "test_helpers"
3977
+ ]
3978
+ }
3979
+ },
3980
+ "/v1/test_helpers/issuing/cards/{card}/shipping/return": {
3981
+ "post": {
3982
+ "operationId": "PostTestHelpersIssuingCardsCardShippingReturn",
3983
+ "summary": "Return a testmode card",
3984
+ "tags": [
3985
+ "test_helpers"
3986
+ ]
3987
+ }
3988
+ },
3989
+ "/v1/test_helpers/issuing/cards/{card}/shipping/ship": {
3990
+ "post": {
3991
+ "operationId": "PostTestHelpersIssuingCardsCardShippingShip",
3992
+ "summary": "Ship a testmode card",
3993
+ "tags": [
3994
+ "test_helpers"
3995
+ ]
3996
+ }
3997
+ },
3998
+ "/v1/test_helpers/issuing/cards/{card}/shipping/submit": {
3999
+ "post": {
4000
+ "operationId": "PostTestHelpersIssuingCardsCardShippingSubmit",
4001
+ "summary": "Submit a testmode card",
4002
+ "tags": [
4003
+ "test_helpers"
4004
+ ]
4005
+ }
4006
+ },
4007
+ "/v1/test_helpers/issuing/personalization_designs/{personalization_design}/activate": {
4008
+ "post": {
4009
+ "operationId": "PostTestHelpersIssuingPersonalizationDesignsPersonalizationDesignActivate",
4010
+ "summary": "Activate a testmode personalization design",
4011
+ "tags": [
4012
+ "test_helpers"
4013
+ ]
4014
+ }
4015
+ },
4016
+ "/v1/test_helpers/issuing/personalization_designs/{personalization_design}/deactivate": {
4017
+ "post": {
4018
+ "operationId": "PostTestHelpersIssuingPersonalizationDesignsPersonalizationDesignDeactivate",
4019
+ "summary": "Deactivate a testmode personalization design",
4020
+ "tags": [
4021
+ "test_helpers"
4022
+ ]
4023
+ }
4024
+ },
4025
+ "/v1/test_helpers/issuing/personalization_designs/{personalization_design}/reject": {
4026
+ "post": {
4027
+ "operationId": "PostTestHelpersIssuingPersonalizationDesignsPersonalizationDesignReject",
4028
+ "summary": "Reject a testmode personalization design",
4029
+ "tags": [
4030
+ "test_helpers"
4031
+ ]
4032
+ }
4033
+ },
4034
+ "/v1/test_helpers/issuing/settlements": {
4035
+ "post": {
4036
+ "operationId": "PostTestHelpersIssuingSettlements",
4037
+ "summary": "Create a test-mode settlement",
4038
+ "tags": [
4039
+ "test_helpers"
4040
+ ]
4041
+ }
4042
+ },
4043
+ "/v1/test_helpers/issuing/settlements/{settlement}/complete": {
4044
+ "post": {
4045
+ "operationId": "PostTestHelpersIssuingSettlementsSettlementComplete",
4046
+ "summary": "Complete a test-mode settlement",
4047
+ "tags": [
4048
+ "test_helpers"
4049
+ ]
4050
+ }
4051
+ },
4052
+ "/v1/test_helpers/issuing/transactions/{transaction}/refund": {
4053
+ "post": {
4054
+ "operationId": "PostTestHelpersIssuingTransactionsTransactionRefund",
4055
+ "summary": "Refund a test-mode transaction",
4056
+ "tags": [
4057
+ "test_helpers"
4058
+ ]
4059
+ }
4060
+ },
4061
+ "/v1/test_helpers/issuing/transactions/create_force_capture": {
4062
+ "post": {
4063
+ "operationId": "PostTestHelpersIssuingTransactionsCreateForceCapture",
4064
+ "summary": "Create a test-mode force capture",
4065
+ "tags": [
4066
+ "test_helpers"
4067
+ ]
4068
+ }
4069
+ },
4070
+ "/v1/test_helpers/issuing/transactions/create_unlinked_refund": {
4071
+ "post": {
4072
+ "operationId": "PostTestHelpersIssuingTransactionsCreateUnlinkedRefund",
4073
+ "summary": "Create a test-mode unlinked refund",
4074
+ "tags": [
4075
+ "test_helpers"
4076
+ ]
4077
+ }
4078
+ },
4079
+ "/v1/test_helpers/refunds/{refund}/expire": {
4080
+ "post": {
4081
+ "operationId": "PostTestHelpersRefundsRefundExpire",
4082
+ "summary": "Expire a pending refund.",
4083
+ "tags": [
4084
+ "test_helpers"
4085
+ ]
4086
+ }
4087
+ },
4088
+ "/v1/test_helpers/terminal/readers/{reader}/present_payment_method": {
4089
+ "post": {
4090
+ "operationId": "PostTestHelpersTerminalReadersReaderPresentPaymentMethod",
4091
+ "summary": "Simulate presenting a payment method",
4092
+ "tags": [
4093
+ "test_helpers"
4094
+ ]
4095
+ }
4096
+ },
4097
+ "/v1/test_helpers/terminal/readers/{reader}/succeed_input_collection": {
4098
+ "post": {
4099
+ "operationId": "PostTestHelpersTerminalReadersReaderSucceedInputCollection",
4100
+ "summary": "Simulate a successful input collection",
4101
+ "tags": [
4102
+ "test_helpers"
4103
+ ]
4104
+ }
4105
+ },
4106
+ "/v1/test_helpers/terminal/readers/{reader}/timeout_input_collection": {
4107
+ "post": {
4108
+ "operationId": "PostTestHelpersTerminalReadersReaderTimeoutInputCollection",
4109
+ "summary": "Simulate an input collection timeout",
4110
+ "tags": [
4111
+ "test_helpers"
4112
+ ]
4113
+ }
4114
+ },
4115
+ "/v1/test_helpers/test_clocks": {
4116
+ "get": {
4117
+ "operationId": "GetTestHelpersTestClocks",
4118
+ "summary": "List all test clocks",
4119
+ "tags": [
4120
+ "test_helpers"
4121
+ ]
4122
+ },
4123
+ "post": {
4124
+ "operationId": "PostTestHelpersTestClocks",
4125
+ "summary": "Create a test clock",
4126
+ "tags": [
4127
+ "test_helpers"
4128
+ ]
4129
+ }
4130
+ },
4131
+ "/v1/test_helpers/test_clocks/{test_clock}": {
4132
+ "delete": {
4133
+ "operationId": "DeleteTestHelpersTestClocksTestClock",
4134
+ "summary": "Delete a test clock",
4135
+ "tags": [
4136
+ "test_helpers"
4137
+ ]
4138
+ },
4139
+ "get": {
4140
+ "operationId": "GetTestHelpersTestClocksTestClock",
4141
+ "summary": "Retrieve a test clock",
4142
+ "tags": [
4143
+ "test_helpers"
4144
+ ]
4145
+ }
4146
+ },
4147
+ "/v1/test_helpers/test_clocks/{test_clock}/advance": {
4148
+ "post": {
4149
+ "operationId": "PostTestHelpersTestClocksTestClockAdvance",
4150
+ "summary": "Advance a test clock",
4151
+ "tags": [
4152
+ "test_helpers"
4153
+ ]
4154
+ }
4155
+ },
4156
+ "/v1/test_helpers/treasury/inbound_transfers/{id}/fail": {
4157
+ "post": {
4158
+ "operationId": "PostTestHelpersTreasuryInboundTransfersIdFail",
4159
+ "summary": "Test mode: Fail an InboundTransfer",
4160
+ "tags": [
4161
+ "test_helpers"
4162
+ ]
4163
+ }
4164
+ },
4165
+ "/v1/test_helpers/treasury/inbound_transfers/{id}/return": {
4166
+ "post": {
4167
+ "operationId": "PostTestHelpersTreasuryInboundTransfersIdReturn",
4168
+ "summary": "Test mode: Return an InboundTransfer",
4169
+ "tags": [
4170
+ "test_helpers"
4171
+ ]
4172
+ }
4173
+ },
4174
+ "/v1/test_helpers/treasury/inbound_transfers/{id}/succeed": {
4175
+ "post": {
4176
+ "operationId": "PostTestHelpersTreasuryInboundTransfersIdSucceed",
4177
+ "summary": "Test mode: Succeed an InboundTransfer",
4178
+ "tags": [
4179
+ "test_helpers"
4180
+ ]
4181
+ }
4182
+ },
4183
+ "/v1/test_helpers/treasury/outbound_payments/{id}": {
4184
+ "post": {
4185
+ "operationId": "PostTestHelpersTreasuryOutboundPaymentsId",
4186
+ "summary": "Test mode: Update an OutboundPayment",
4187
+ "tags": [
4188
+ "test_helpers"
4189
+ ]
4190
+ }
4191
+ },
4192
+ "/v1/test_helpers/treasury/outbound_payments/{id}/fail": {
4193
+ "post": {
4194
+ "operationId": "PostTestHelpersTreasuryOutboundPaymentsIdFail",
4195
+ "summary": "Test mode: Fail an OutboundPayment",
4196
+ "tags": [
4197
+ "test_helpers"
4198
+ ]
4199
+ }
4200
+ },
4201
+ "/v1/test_helpers/treasury/outbound_payments/{id}/post": {
4202
+ "post": {
4203
+ "operationId": "PostTestHelpersTreasuryOutboundPaymentsIdPost",
4204
+ "summary": "Test mode: Post an OutboundPayment",
4205
+ "tags": [
4206
+ "test_helpers"
4207
+ ]
4208
+ }
4209
+ },
4210
+ "/v1/test_helpers/treasury/outbound_payments/{id}/return": {
4211
+ "post": {
4212
+ "operationId": "PostTestHelpersTreasuryOutboundPaymentsIdReturn",
4213
+ "summary": "Test mode: Return an OutboundPayment",
4214
+ "tags": [
4215
+ "test_helpers"
4216
+ ]
4217
+ }
4218
+ },
4219
+ "/v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}": {
4220
+ "post": {
4221
+ "operationId": "PostTestHelpersTreasuryOutboundTransfersOutboundTransfer",
4222
+ "summary": "Test mode: Update an OutboundTransfer",
4223
+ "tags": [
4224
+ "test_helpers"
4225
+ ]
4226
+ }
4227
+ },
4228
+ "/v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}/fail": {
4229
+ "post": {
4230
+ "operationId": "PostTestHelpersTreasuryOutboundTransfersOutboundTransferFail",
4231
+ "summary": "Test mode: Fail an OutboundTransfer",
4232
+ "tags": [
4233
+ "test_helpers"
4234
+ ]
4235
+ }
4236
+ },
4237
+ "/v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}/post": {
4238
+ "post": {
4239
+ "operationId": "PostTestHelpersTreasuryOutboundTransfersOutboundTransferPost",
4240
+ "summary": "Test mode: Post an OutboundTransfer",
4241
+ "tags": [
4242
+ "test_helpers"
4243
+ ]
4244
+ }
4245
+ },
4246
+ "/v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}/return": {
4247
+ "post": {
4248
+ "operationId": "PostTestHelpersTreasuryOutboundTransfersOutboundTransferReturn",
4249
+ "summary": "Test mode: Return an OutboundTransfer",
4250
+ "tags": [
4251
+ "test_helpers"
4252
+ ]
4253
+ }
4254
+ },
4255
+ "/v1/test_helpers/treasury/received_credits": {
4256
+ "post": {
4257
+ "operationId": "PostTestHelpersTreasuryReceivedCredits",
4258
+ "summary": "Test mode: Create a ReceivedCredit",
4259
+ "tags": [
4260
+ "test_helpers"
4261
+ ]
4262
+ }
4263
+ },
4264
+ "/v1/test_helpers/treasury/received_debits": {
4265
+ "post": {
4266
+ "operationId": "PostTestHelpersTreasuryReceivedDebits",
4267
+ "summary": "Test mode: Create a ReceivedDebit",
4268
+ "tags": [
4269
+ "test_helpers"
4270
+ ]
4271
+ }
4272
+ },
4273
+ "/v1/tokens": {
4274
+ "post": {
4275
+ "operationId": "PostTokens",
4276
+ "summary": "Create a bank account token",
4277
+ "tags": [
4278
+ "tokens"
4279
+ ]
4280
+ }
4281
+ },
4282
+ "/v1/tokens/{token}": {
4283
+ "get": {
4284
+ "operationId": "GetTokensToken",
4285
+ "summary": "Retrieve a token",
4286
+ "tags": [
4287
+ "tokens"
4288
+ ]
4289
+ }
4290
+ },
4291
+ "/v1/topups": {
4292
+ "get": {
4293
+ "operationId": "GetTopups",
4294
+ "summary": "List all top-ups",
4295
+ "tags": [
4296
+ "topups"
4297
+ ]
4298
+ },
4299
+ "post": {
4300
+ "operationId": "PostTopups",
4301
+ "summary": "Create a top-up",
4302
+ "tags": [
4303
+ "topups"
4304
+ ]
4305
+ }
4306
+ },
4307
+ "/v1/topups/{topup}": {
4308
+ "get": {
4309
+ "operationId": "GetTopupsTopup",
4310
+ "summary": "Retrieve a top-up",
4311
+ "tags": [
4312
+ "topups"
4313
+ ]
4314
+ },
4315
+ "post": {
4316
+ "operationId": "PostTopupsTopup",
4317
+ "summary": "Update a top-up",
4318
+ "tags": [
4319
+ "topups"
4320
+ ]
4321
+ }
4322
+ },
4323
+ "/v1/topups/{topup}/cancel": {
4324
+ "post": {
4325
+ "operationId": "PostTopupsTopupCancel",
4326
+ "summary": "Cancel a top-up",
4327
+ "tags": [
4328
+ "topups"
4329
+ ]
4330
+ }
4331
+ },
4332
+ "/v1/transfers": {
4333
+ "get": {
4334
+ "operationId": "GetTransfers",
4335
+ "summary": "List all transfers",
4336
+ "tags": [
4337
+ "transfers"
4338
+ ]
4339
+ },
4340
+ "post": {
4341
+ "operationId": "PostTransfers",
4342
+ "summary": "Create a transfer",
4343
+ "tags": [
4344
+ "transfers"
4345
+ ]
4346
+ }
4347
+ },
4348
+ "/v1/transfers/{id}/reversals": {
4349
+ "get": {
4350
+ "operationId": "GetTransfersIdReversals",
4351
+ "summary": "List all reversals",
4352
+ "tags": [
4353
+ "transfers"
4354
+ ]
4355
+ },
4356
+ "post": {
4357
+ "operationId": "PostTransfersIdReversals",
4358
+ "summary": "Create a transfer reversal",
4359
+ "tags": [
4360
+ "transfers"
4361
+ ]
4362
+ }
4363
+ },
4364
+ "/v1/transfers/{transfer}": {
4365
+ "get": {
4366
+ "operationId": "GetTransfersTransfer",
4367
+ "summary": "Retrieve a transfer",
4368
+ "tags": [
4369
+ "transfers"
4370
+ ]
4371
+ },
4372
+ "post": {
4373
+ "operationId": "PostTransfersTransfer",
4374
+ "summary": "Update a transfer",
4375
+ "tags": [
4376
+ "transfers"
4377
+ ]
4378
+ }
4379
+ },
4380
+ "/v1/transfers/{transfer}/reversals/{id}": {
4381
+ "get": {
4382
+ "operationId": "GetTransfersTransferReversalsId",
4383
+ "summary": "Retrieve a reversal",
4384
+ "tags": [
4385
+ "transfers"
4386
+ ]
4387
+ },
4388
+ "post": {
4389
+ "operationId": "PostTransfersTransferReversalsId",
4390
+ "summary": "Update a reversal",
4391
+ "tags": [
4392
+ "transfers"
4393
+ ]
4394
+ }
4395
+ },
4396
+ "/v1/treasury/credit_reversals": {
4397
+ "get": {
4398
+ "operationId": "GetTreasuryCreditReversals",
4399
+ "summary": "List all CreditReversals",
4400
+ "tags": [
4401
+ "treasury"
4402
+ ]
4403
+ },
4404
+ "post": {
4405
+ "operationId": "PostTreasuryCreditReversals",
4406
+ "summary": "Create a CreditReversal",
4407
+ "tags": [
4408
+ "treasury"
4409
+ ]
4410
+ }
4411
+ },
4412
+ "/v1/treasury/credit_reversals/{credit_reversal}": {
4413
+ "get": {
4414
+ "operationId": "GetTreasuryCreditReversalsCreditReversal",
4415
+ "summary": "Retrieve a CreditReversal",
4416
+ "tags": [
4417
+ "treasury"
4418
+ ]
4419
+ }
4420
+ },
4421
+ "/v1/treasury/debit_reversals": {
4422
+ "get": {
4423
+ "operationId": "GetTreasuryDebitReversals",
4424
+ "summary": "List all DebitReversals",
4425
+ "tags": [
4426
+ "treasury"
4427
+ ]
4428
+ },
4429
+ "post": {
4430
+ "operationId": "PostTreasuryDebitReversals",
4431
+ "summary": "Create a DebitReversal",
4432
+ "tags": [
4433
+ "treasury"
4434
+ ]
4435
+ }
4436
+ },
4437
+ "/v1/treasury/debit_reversals/{debit_reversal}": {
4438
+ "get": {
4439
+ "operationId": "GetTreasuryDebitReversalsDebitReversal",
4440
+ "summary": "Retrieve a DebitReversal",
4441
+ "tags": [
4442
+ "treasury"
4443
+ ]
4444
+ }
4445
+ },
4446
+ "/v1/treasury/financial_accounts": {
4447
+ "get": {
4448
+ "operationId": "GetTreasuryFinancialAccounts",
4449
+ "summary": "List all FinancialAccounts",
4450
+ "tags": [
4451
+ "treasury"
4452
+ ]
4453
+ },
4454
+ "post": {
4455
+ "operationId": "PostTreasuryFinancialAccounts",
4456
+ "summary": "Create a FinancialAccount",
4457
+ "tags": [
4458
+ "treasury"
4459
+ ]
4460
+ }
4461
+ },
4462
+ "/v1/treasury/financial_accounts/{financial_account}": {
4463
+ "get": {
4464
+ "operationId": "GetTreasuryFinancialAccountsFinancialAccount",
4465
+ "summary": "Retrieve a FinancialAccount",
4466
+ "tags": [
4467
+ "treasury"
4468
+ ]
4469
+ },
4470
+ "post": {
4471
+ "operationId": "PostTreasuryFinancialAccountsFinancialAccount",
4472
+ "summary": "Update a FinancialAccount",
4473
+ "tags": [
4474
+ "treasury"
4475
+ ]
4476
+ }
4477
+ },
4478
+ "/v1/treasury/financial_accounts/{financial_account}/close": {
4479
+ "post": {
4480
+ "operationId": "PostTreasuryFinancialAccountsFinancialAccountClose",
4481
+ "summary": "Close a FinancialAccount",
4482
+ "tags": [
4483
+ "treasury"
4484
+ ]
4485
+ }
4486
+ },
4487
+ "/v1/treasury/financial_accounts/{financial_account}/features": {
4488
+ "get": {
4489
+ "operationId": "GetTreasuryFinancialAccountsFinancialAccountFeatures",
4490
+ "summary": "Retrieve FinancialAccount Features",
4491
+ "tags": [
4492
+ "treasury"
4493
+ ]
4494
+ },
4495
+ "post": {
4496
+ "operationId": "PostTreasuryFinancialAccountsFinancialAccountFeatures",
4497
+ "summary": "Update FinancialAccount Features",
4498
+ "tags": [
4499
+ "treasury"
4500
+ ]
4501
+ }
4502
+ },
4503
+ "/v1/treasury/inbound_transfers": {
4504
+ "get": {
4505
+ "operationId": "GetTreasuryInboundTransfers",
4506
+ "summary": "List all InboundTransfers",
4507
+ "tags": [
4508
+ "treasury"
4509
+ ]
4510
+ },
4511
+ "post": {
4512
+ "operationId": "PostTreasuryInboundTransfers",
4513
+ "summary": "Create an InboundTransfer",
4514
+ "tags": [
4515
+ "treasury"
4516
+ ]
4517
+ }
4518
+ },
4519
+ "/v1/treasury/inbound_transfers/{id}": {
4520
+ "get": {
4521
+ "operationId": "GetTreasuryInboundTransfersId",
4522
+ "summary": "Retrieve an InboundTransfer",
4523
+ "tags": [
4524
+ "treasury"
4525
+ ]
4526
+ }
4527
+ },
4528
+ "/v1/treasury/inbound_transfers/{inbound_transfer}/cancel": {
4529
+ "post": {
4530
+ "operationId": "PostTreasuryInboundTransfersInboundTransferCancel",
4531
+ "summary": "Cancel an InboundTransfer",
4532
+ "tags": [
4533
+ "treasury"
4534
+ ]
4535
+ }
4536
+ },
4537
+ "/v1/treasury/outbound_payments": {
4538
+ "get": {
4539
+ "operationId": "GetTreasuryOutboundPayments",
4540
+ "summary": "List all OutboundPayments",
4541
+ "tags": [
4542
+ "treasury"
4543
+ ]
4544
+ },
4545
+ "post": {
4546
+ "operationId": "PostTreasuryOutboundPayments",
4547
+ "summary": "Create an OutboundPayment",
4548
+ "tags": [
4549
+ "treasury"
4550
+ ]
4551
+ }
4552
+ },
4553
+ "/v1/treasury/outbound_payments/{id}": {
4554
+ "get": {
4555
+ "operationId": "GetTreasuryOutboundPaymentsId",
4556
+ "summary": "Retrieve an OutboundPayment",
4557
+ "tags": [
4558
+ "treasury"
4559
+ ]
4560
+ }
4561
+ },
4562
+ "/v1/treasury/outbound_payments/{id}/cancel": {
4563
+ "post": {
4564
+ "operationId": "PostTreasuryOutboundPaymentsIdCancel",
4565
+ "summary": "Cancel an OutboundPayment",
4566
+ "tags": [
4567
+ "treasury"
4568
+ ]
4569
+ }
4570
+ },
4571
+ "/v1/treasury/outbound_transfers": {
4572
+ "get": {
4573
+ "operationId": "GetTreasuryOutboundTransfers",
4574
+ "summary": "List all OutboundTransfers",
4575
+ "tags": [
4576
+ "treasury"
4577
+ ]
4578
+ },
4579
+ "post": {
4580
+ "operationId": "PostTreasuryOutboundTransfers",
4581
+ "summary": "Create an OutboundTransfer",
4582
+ "tags": [
4583
+ "treasury"
4584
+ ]
4585
+ }
4586
+ },
4587
+ "/v1/treasury/outbound_transfers/{outbound_transfer}": {
4588
+ "get": {
4589
+ "operationId": "GetTreasuryOutboundTransfersOutboundTransfer",
4590
+ "summary": "Retrieve an OutboundTransfer",
4591
+ "tags": [
4592
+ "treasury"
4593
+ ]
4594
+ }
4595
+ },
4596
+ "/v1/treasury/outbound_transfers/{outbound_transfer}/cancel": {
4597
+ "post": {
4598
+ "operationId": "PostTreasuryOutboundTransfersOutboundTransferCancel",
4599
+ "summary": "Cancel an OutboundTransfer",
4600
+ "tags": [
4601
+ "treasury"
4602
+ ]
4603
+ }
4604
+ },
4605
+ "/v1/treasury/received_credits": {
4606
+ "get": {
4607
+ "operationId": "GetTreasuryReceivedCredits",
4608
+ "summary": "List all ReceivedCredits",
4609
+ "tags": [
4610
+ "treasury"
4611
+ ]
4612
+ }
4613
+ },
4614
+ "/v1/treasury/received_credits/{id}": {
4615
+ "get": {
4616
+ "operationId": "GetTreasuryReceivedCreditsId",
4617
+ "summary": "Retrieve a ReceivedCredit",
4618
+ "tags": [
4619
+ "treasury"
4620
+ ]
4621
+ }
4622
+ },
4623
+ "/v1/treasury/received_debits": {
4624
+ "get": {
4625
+ "operationId": "GetTreasuryReceivedDebits",
4626
+ "summary": "List all ReceivedDebits",
4627
+ "tags": [
4628
+ "treasury"
4629
+ ]
4630
+ }
4631
+ },
4632
+ "/v1/treasury/received_debits/{id}": {
4633
+ "get": {
4634
+ "operationId": "GetTreasuryReceivedDebitsId",
4635
+ "summary": "Retrieve a ReceivedDebit",
4636
+ "tags": [
4637
+ "treasury"
4638
+ ]
4639
+ }
4640
+ },
4641
+ "/v1/treasury/transaction_entries": {
4642
+ "get": {
4643
+ "operationId": "GetTreasuryTransactionEntries",
4644
+ "summary": "List all TransactionEntries",
4645
+ "tags": [
4646
+ "treasury"
4647
+ ]
4648
+ }
4649
+ },
4650
+ "/v1/treasury/transaction_entries/{id}": {
4651
+ "get": {
4652
+ "operationId": "GetTreasuryTransactionEntriesId",
4653
+ "summary": "Retrieve a TransactionEntry",
4654
+ "tags": [
4655
+ "treasury"
4656
+ ]
4657
+ }
4658
+ },
4659
+ "/v1/treasury/transactions": {
4660
+ "get": {
4661
+ "operationId": "GetTreasuryTransactions",
4662
+ "summary": "List all Transactions",
4663
+ "tags": [
4664
+ "treasury"
4665
+ ]
4666
+ }
4667
+ },
4668
+ "/v1/treasury/transactions/{id}": {
4669
+ "get": {
4670
+ "operationId": "GetTreasuryTransactionsId",
4671
+ "summary": "Retrieve a Transaction",
4672
+ "tags": [
4673
+ "treasury"
4674
+ ]
4675
+ }
4676
+ },
4677
+ "/v1/webhook_endpoints": {
4678
+ "get": {
4679
+ "operationId": "GetWebhookEndpoints",
4680
+ "summary": "List all webhook endpoints",
4681
+ "tags": [
4682
+ "webhook_endpoints"
4683
+ ]
4684
+ },
4685
+ "post": {
4686
+ "operationId": "PostWebhookEndpoints",
4687
+ "summary": "Create a webhook endpoint",
4688
+ "tags": [
4689
+ "webhook_endpoints"
4690
+ ]
4691
+ }
4692
+ },
4693
+ "/v1/webhook_endpoints/{webhook_endpoint}": {
4694
+ "delete": {
4695
+ "operationId": "DeleteWebhookEndpointsWebhookEndpoint",
4696
+ "summary": "Delete a webhook endpoint",
4697
+ "tags": [
4698
+ "webhook_endpoints"
4699
+ ]
4700
+ },
4701
+ "get": {
4702
+ "operationId": "GetWebhookEndpointsWebhookEndpoint",
4703
+ "summary": "Retrieve a webhook endpoint",
4704
+ "tags": [
4705
+ "webhook_endpoints"
4706
+ ]
4707
+ },
4708
+ "post": {
4709
+ "operationId": "PostWebhookEndpointsWebhookEndpoint",
4710
+ "summary": "Update a webhook endpoint",
4711
+ "tags": [
4712
+ "webhook_endpoints"
4713
+ ]
4714
+ }
4715
+ }
4716
+ }
4717
+ }