recurly 4.83.0 → 4.84.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.
- checksums.yaml +4 -4
- data/.bumpversion.cfg +1 -1
- data/CHANGELOG.md +11 -0
- data/GETTING_STARTED.md +1 -1
- data/lib/recurly/client/operations.rb +56 -0
- data/lib/recurly/requests/dunning_campaign_create.rb +26 -0
- data/lib/recurly/requests/dunning_campaign_update.rb +30 -0
- data/lib/recurly/requests/dunning_cycle_create.rb +42 -0
- data/lib/recurly/requests/dunning_interval_create.rb +18 -0
- data/lib/recurly/resources/dunning_campaign_email_template.rb +22 -0
- data/lib/recurly/resources/dunning_interval.rb +4 -0
- data/lib/recurly/version.rb +1 -1
- data/openapi/api.yaml +609 -314
- metadata +8 -3
data/openapi/api.yaml
CHANGED
|
@@ -217,186 +217,155 @@ security:
|
|
|
217
217
|
x-tagGroups:
|
|
218
218
|
- name: Customers
|
|
219
219
|
tags:
|
|
220
|
-
-
|
|
221
|
-
-
|
|
222
|
-
-
|
|
223
|
-
-
|
|
224
|
-
-
|
|
225
|
-
-
|
|
226
|
-
-
|
|
227
|
-
-
|
|
228
|
-
-
|
|
229
|
-
-
|
|
220
|
+
- Account
|
|
221
|
+
- Account Note
|
|
222
|
+
- Account Acquisition Info
|
|
223
|
+
- Billing Info
|
|
224
|
+
- Billing Infos
|
|
225
|
+
- Coupon Redemption
|
|
226
|
+
- Subscription
|
|
227
|
+
- Subscription Change
|
|
228
|
+
- Usage
|
|
229
|
+
- Shipping Address
|
|
230
230
|
- name: Invoices and Payments
|
|
231
231
|
tags:
|
|
232
|
-
-
|
|
233
|
-
-
|
|
234
|
-
-
|
|
235
|
-
-
|
|
236
|
-
-
|
|
237
|
-
-
|
|
238
|
-
-
|
|
232
|
+
- Purchase
|
|
233
|
+
- Invoice
|
|
234
|
+
- Line Item
|
|
235
|
+
- Credit Payment
|
|
236
|
+
- Transaction
|
|
237
|
+
- Revenue Recovery
|
|
238
|
+
- Gift Cards
|
|
239
239
|
- name: Products and Promotions
|
|
240
240
|
tags:
|
|
241
|
-
-
|
|
242
|
-
-
|
|
243
|
-
-
|
|
244
|
-
-
|
|
245
|
-
-
|
|
246
|
-
-
|
|
247
|
-
-
|
|
241
|
+
- Item
|
|
242
|
+
- Plan
|
|
243
|
+
- Add-on
|
|
244
|
+
- Measured Unit
|
|
245
|
+
- Coupon
|
|
246
|
+
- Unique Coupon Code
|
|
247
|
+
- Price Segment
|
|
248
248
|
- name: Configuration
|
|
249
249
|
tags:
|
|
250
|
-
-
|
|
251
|
-
-
|
|
252
|
-
-
|
|
253
|
-
-
|
|
254
|
-
-
|
|
255
|
-
-
|
|
256
|
-
-
|
|
257
|
-
-
|
|
258
|
-
-
|
|
250
|
+
- Site
|
|
251
|
+
- Custom Field Definition
|
|
252
|
+
- Shipping Method
|
|
253
|
+
- Dunning Campaigns
|
|
254
|
+
- Business Entities
|
|
255
|
+
- Automated Exports
|
|
256
|
+
- General Ledger Account
|
|
257
|
+
- Performance Obligations
|
|
258
|
+
- Invoice Templates
|
|
259
259
|
- name: App Management
|
|
260
260
|
tags:
|
|
261
|
-
-
|
|
262
|
-
-
|
|
263
|
-
-
|
|
264
|
-
-
|
|
265
|
-
-
|
|
266
|
-
-
|
|
261
|
+
- External Subscription
|
|
262
|
+
- External Invoice
|
|
263
|
+
- External Product
|
|
264
|
+
- External Account
|
|
265
|
+
- External Product Reference
|
|
266
|
+
- External Payment Phase
|
|
267
267
|
tags:
|
|
268
|
-
- name:
|
|
269
|
-
x-displayName: Account
|
|
268
|
+
- name: Account
|
|
270
269
|
description: Accounts are core to managing your customers inside of Recurly. The
|
|
271
270
|
account object stores the entire Recurly history of your customer and acts as
|
|
272
271
|
the entry point for working with a customer's billing information, subscription
|
|
273
272
|
data, transactions, invoices and more.
|
|
274
|
-
- name:
|
|
275
|
-
x-displayName: Account Note
|
|
273
|
+
- name: Account Note
|
|
276
274
|
description: Account notes allow your team to leave notes on an account to add context,
|
|
277
275
|
e.g. the reason for a refund, customer requests, and/or complaints. These notes
|
|
278
276
|
are internal and not exposed to your customers.
|
|
279
|
-
- name:
|
|
280
|
-
x-displayName: Account Acquisition Info
|
|
277
|
+
- name: Account Acquisition Info
|
|
281
278
|
description: Recurly offers the ability to record marketing data on customer accounts
|
|
282
279
|
to match this data with revenue and billing data events in Recurly.
|
|
283
|
-
- name:
|
|
284
|
-
x-displayName: Billing Info
|
|
280
|
+
- name: Billing Info
|
|
285
281
|
description: Without the premium Wallet feature, an account can only have one stored
|
|
286
282
|
payment method at a time. Examples include credit cards, PayPal, or bank accounts.
|
|
287
283
|
Billing info is filled out by the customer upon purchase or when they update their
|
|
288
284
|
information.
|
|
289
|
-
- name:
|
|
290
|
-
x-displayName: Billing Infos
|
|
285
|
+
- name: Billing Infos
|
|
291
286
|
description: If the premium Wallet feature is enabled, an account can have multiple
|
|
292
287
|
payment methods stored. Examples include credit cards, PayPal, or bank accounts.
|
|
293
288
|
Primary or backup billing infos can be designated from these endpoints.
|
|
294
|
-
- name:
|
|
295
|
-
x-displayName: Coupon Redemption
|
|
289
|
+
- name: Coupon Redemption
|
|
296
290
|
description: Coupon redemptions are created when a coupon is applied to an account
|
|
297
291
|
or subscription. This allows you to track your promotions.
|
|
298
|
-
- name:
|
|
299
|
-
x-displayName: Subscription
|
|
292
|
+
- name: Subscription
|
|
300
293
|
description: Subscriptions are created when your customers subscribe to one of your
|
|
301
294
|
plans. The customer's subscription tells Recurly when and how much to bill the
|
|
302
295
|
customer.
|
|
303
|
-
- name:
|
|
304
|
-
x-displayName: Subscription Change
|
|
296
|
+
- name: Subscription Change
|
|
305
297
|
description: Subscription changes alter subscription in a way that might affect
|
|
306
298
|
the invoiced amount, such as changing the plan, add-ons, quantities, or shipping
|
|
307
299
|
address. Changes can be made immediately in the current billing cycle or scheduled
|
|
308
300
|
to take place at the next renewal.
|
|
309
|
-
- name:
|
|
310
|
-
x-displayName: Usage
|
|
301
|
+
- name: Usage
|
|
311
302
|
description: Send Recurly your customer usage and we will automatically bill them
|
|
312
303
|
in arrears at the end of the billing cycle. For more info on usage-based billing,
|
|
313
304
|
[click here](https://docs.recurly.com/docs/usage-based-billing).
|
|
314
|
-
- name:
|
|
315
|
-
x-displayName: Shipping Address
|
|
305
|
+
- name: Shipping Address
|
|
316
306
|
description: Shipping addresses are tied to a customer's account. Each account can
|
|
317
307
|
have up to 20 different shipping addresses, and if you have enabled multiple subscriptions
|
|
318
308
|
per account, you can associate different shipping addresses to each subscription.
|
|
319
|
-
- name:
|
|
320
|
-
x-displayName: Purchase
|
|
309
|
+
- name: Purchase
|
|
321
310
|
description: A purchase is a checkout containing at least one or more subscriptions
|
|
322
311
|
or one-time charges (line items) and supports both coupon and gift card redemptions.
|
|
323
312
|
All items purchased will be on one invoice and paid for with one transaction.
|
|
324
313
|
The purchases endpoint can also be used to immediately create a credit invoice
|
|
325
314
|
on an account, when Credit Invoices is enabled on your site.
|
|
326
|
-
- name:
|
|
327
|
-
x-displayName: Invoice
|
|
315
|
+
- name: Invoice
|
|
328
316
|
description: An invoice relates charges, credits, and payments together. When a
|
|
329
317
|
subscription is created or renewed or a charge is created on the account, Recurly
|
|
330
318
|
will sum the charges, discount or tax as appropriate, and send the invoice out
|
|
331
319
|
for collection.
|
|
332
|
-
- name:
|
|
333
|
-
x-displayName: Line Item
|
|
320
|
+
- name: Line Item
|
|
334
321
|
description: Line items are the charges and credits on your customer's invoices.
|
|
335
|
-
- name:
|
|
336
|
-
|
|
337
|
-
- name: transaction
|
|
338
|
-
x-displayName: Transaction
|
|
322
|
+
- name: Credit Payment
|
|
323
|
+
- name: Transaction
|
|
339
324
|
description: Purchasing information is sent to your payment gateway in an action
|
|
340
325
|
called a transaction. This includes the customer's billing information and the
|
|
341
326
|
amount of money to be charged, voided, or refunded.
|
|
342
|
-
- name:
|
|
343
|
-
x-displayName: Revenue Recovery
|
|
327
|
+
- name: Revenue Recovery
|
|
344
328
|
description: Revenue recovery
|
|
345
|
-
- name:
|
|
346
|
-
x-displayName: Gift Cards
|
|
329
|
+
- name: Gift Cards
|
|
347
330
|
description: Add gift card purchases to your checkout and allow gift card recipients
|
|
348
331
|
to redeem the gift card for credit towards any of your products.
|
|
349
|
-
- name:
|
|
350
|
-
x-displayName: Item
|
|
332
|
+
- name: Item
|
|
351
333
|
description: |-
|
|
352
334
|
For merchants who sell the same things to many customers, documenting those offerings in a catalog allows for faster charge creation, easier management of offerings, and analytics about your offerings across all sales channels. Because your offerings can be physical, digital, or service-oriented, Recurly collectively calls these offerings "Items".
|
|
353
335
|
|
|
354
336
|
Recurly's item catalog requires the Credit Invoices feature to be enabled.
|
|
355
|
-
- name:
|
|
356
|
-
x-displayName: Plan
|
|
337
|
+
- name: Plan
|
|
357
338
|
description: A plan tells Recurly how often and how much to charge your customers.
|
|
358
339
|
Plans can be created with free trials, optional products (called add-ons), setup
|
|
359
340
|
fees, and more.
|
|
360
|
-
- name:
|
|
361
|
-
x-displayName: Add-on
|
|
341
|
+
- name: Add-on
|
|
362
342
|
description: An add-on is a charge billed each billing period in addition to a subscription’s
|
|
363
343
|
base charge. Each plan may have one or more add-ons associated with it.
|
|
364
|
-
- name:
|
|
365
|
-
x-displayName: Measured Unit
|
|
344
|
+
- name: Measured Unit
|
|
366
345
|
description: A measured unit describes a usage-based add-on's usage. If different
|
|
367
346
|
usage-based add-ons share the same measured unit, you can report on customer usage
|
|
368
347
|
for those add-ons at the aggregated measured unit level.
|
|
369
|
-
- name:
|
|
370
|
-
x-displayName: Coupon
|
|
348
|
+
- name: Coupon
|
|
371
349
|
description: Coupons can either be single codes that easily allow mass distribution
|
|
372
350
|
by many customers or bulk coupons that can generate many unique coupons that can
|
|
373
351
|
allow for individual delivery and tracking.
|
|
374
|
-
- name:
|
|
375
|
-
x-displayName: Unique Coupon Code
|
|
352
|
+
- name: Unique Coupon Code
|
|
376
353
|
description: Unique coupon codes are generated from bulk coupons.
|
|
377
|
-
- name:
|
|
378
|
-
|
|
379
|
-
- name:
|
|
380
|
-
x-displayName: Site
|
|
381
|
-
- name: custom_field_definition
|
|
382
|
-
x-displayName: Custom Field Definition
|
|
354
|
+
- name: Price Segment
|
|
355
|
+
- name: Site
|
|
356
|
+
- name: Custom Field Definition
|
|
383
357
|
description: Describes the fields that can be used as custom fields on accounts,
|
|
384
358
|
items, line-items (one time charges), plans, or subscriptions.
|
|
385
|
-
- name:
|
|
386
|
-
x-displayName: Shipping Method
|
|
359
|
+
- name: Shipping Method
|
|
387
360
|
description: Shipping methods offered to send products to customers.
|
|
388
|
-
- name:
|
|
389
|
-
x-displayName: Dunning Campaigns
|
|
361
|
+
- name: Dunning Campaigns
|
|
390
362
|
description: Settings used when attempting to dun customers whose payments are declined.
|
|
391
|
-
- name:
|
|
392
|
-
x-displayName: Business Entities
|
|
363
|
+
- name: Business Entities
|
|
393
364
|
description: Describes the business address that will be used for invoices and taxes
|
|
394
365
|
depending on settings and subscriber location.
|
|
395
|
-
- name:
|
|
396
|
-
x-displayName: Automated Exports
|
|
366
|
+
- name: Automated Exports
|
|
397
367
|
description: Automated exports of customer data.
|
|
398
|
-
- name:
|
|
399
|
-
x-displayName: General Ledger Account
|
|
368
|
+
- name: General Ledger Account
|
|
400
369
|
description: |
|
|
401
370
|
A general ledger account is an account of record used to sort, store
|
|
402
371
|
and summarize a company's transactions. Recurly supports the balance
|
|
@@ -428,8 +397,7 @@ tags:
|
|
|
428
397
|
|
|
429
398
|
If you are interested in Recurly Revenue Recognition features, please
|
|
430
399
|
contact a Recurly customer service representative.
|
|
431
|
-
- name:
|
|
432
|
-
x-displayName: Performance Obligations
|
|
400
|
+
- name: Performance Obligations
|
|
433
401
|
description: |
|
|
434
402
|
A performance obligation is a promise to provide a distinct good or
|
|
435
403
|
service or a series of distinct goods or services as defined by the revenue standard.
|
|
@@ -444,34 +412,27 @@ tags:
|
|
|
444
412
|
- The customer receives and consumes the benefits of the goods or services as they are provided
|
|
445
413
|
by the entity (routine, recurring services like a cleaning service are an example of a series of
|
|
446
414
|
services that are substantially the same and have the same pattern of transfer)
|
|
447
|
-
- name:
|
|
448
|
-
|
|
449
|
-
- name: external_subscriptions
|
|
450
|
-
x-displayName: External Subscription
|
|
415
|
+
- name: Invoice Templates
|
|
416
|
+
- name: External Subscription
|
|
451
417
|
description: A subscription from an external resource that is not managed by the
|
|
452
418
|
Recurly platform and instead is managed by third-party platforms like Apple App
|
|
453
419
|
Store and Google Play Store.
|
|
454
|
-
- name:
|
|
455
|
-
x-displayName: External Invoice
|
|
420
|
+
- name: External Invoice
|
|
456
421
|
description: An invoice from an external resource that is not managed by the Recurly
|
|
457
422
|
platform and instead is managed by third-party platforms like Apple App Store
|
|
458
423
|
and Google Play Store.
|
|
459
|
-
- name:
|
|
460
|
-
x-displayName: External Product
|
|
424
|
+
- name: External Product
|
|
461
425
|
description: A product from an external resource that is not managed by the Recurly
|
|
462
426
|
platform and instead is managed by third-party platforms like Apple App Store
|
|
463
427
|
and Google Play Store.
|
|
464
|
-
- name:
|
|
465
|
-
x-displayName: External Account
|
|
428
|
+
- name: External Account
|
|
466
429
|
description: An account from an external resource that is not managed by the Recurly
|
|
467
430
|
platform and instead is managed by third-party platforms like Apple App Store
|
|
468
431
|
and Google Play Store.
|
|
469
|
-
- name:
|
|
470
|
-
x-displayName: External Product Reference
|
|
432
|
+
- name: External Product Reference
|
|
471
433
|
description: Associates an external product to a corresponding resource on an external
|
|
472
434
|
platform like the Apple App Store or Google Play Store.
|
|
473
|
-
- name:
|
|
474
|
-
x-displayName: External Payment Phase
|
|
435
|
+
- name: External Payment Phase
|
|
475
436
|
description: Details of payments in the lifecycle of a subscription from an external
|
|
476
437
|
resource that is not managed by the Recurly platform, e.g. App Store or Google
|
|
477
438
|
Play Store.
|
|
@@ -485,7 +446,7 @@ paths:
|
|
|
485
446
|
|
|
486
447
|
See the [Pagination Guide](/developers/guides/pagination.html) to learn how to use pagination in the API and Client Libraries.
|
|
487
448
|
tags:
|
|
488
|
-
-
|
|
449
|
+
- Site
|
|
489
450
|
parameters:
|
|
490
451
|
- "$ref": "#/components/parameters/ids"
|
|
491
452
|
- "$ref": "#/components/parameters/limit"
|
|
@@ -650,7 +611,7 @@ paths:
|
|
|
650
611
|
operationId: get_site
|
|
651
612
|
summary: Fetch a site
|
|
652
613
|
tags:
|
|
653
|
-
-
|
|
614
|
+
- Site
|
|
654
615
|
parameters:
|
|
655
616
|
- "$ref": "#/components/parameters/site_id"
|
|
656
617
|
responses:
|
|
@@ -861,7 +822,7 @@ paths:
|
|
|
861
822
|
"/accounts":
|
|
862
823
|
get:
|
|
863
824
|
tags:
|
|
864
|
-
-
|
|
825
|
+
- Account
|
|
865
826
|
operationId: list_accounts
|
|
866
827
|
summary: List a site's accounts
|
|
867
828
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
@@ -1037,7 +998,7 @@ paths:
|
|
|
1037
998
|
name: Go
|
|
1038
999
|
post:
|
|
1039
1000
|
tags:
|
|
1040
|
-
-
|
|
1001
|
+
- Account
|
|
1041
1002
|
operationId: create_account
|
|
1042
1003
|
summary: Create an account
|
|
1043
1004
|
requestBody:
|
|
@@ -1517,7 +1478,7 @@ paths:
|
|
|
1517
1478
|
- "$ref": "#/components/parameters/account_id"
|
|
1518
1479
|
get:
|
|
1519
1480
|
tags:
|
|
1520
|
-
-
|
|
1481
|
+
- Account
|
|
1521
1482
|
operationId: get_account
|
|
1522
1483
|
summary: Fetch an account
|
|
1523
1484
|
responses:
|
|
@@ -1721,7 +1682,7 @@ paths:
|
|
|
1721
1682
|
name: Go
|
|
1722
1683
|
put:
|
|
1723
1684
|
tags:
|
|
1724
|
-
-
|
|
1685
|
+
- Account
|
|
1725
1686
|
operationId: update_account
|
|
1726
1687
|
summary: Update an account
|
|
1727
1688
|
requestBody:
|
|
@@ -2010,7 +1971,7 @@ paths:
|
|
|
2010
1971
|
name: Go
|
|
2011
1972
|
delete:
|
|
2012
1973
|
tags:
|
|
2013
|
-
-
|
|
1974
|
+
- Account
|
|
2014
1975
|
operationId: deactivate_account
|
|
2015
1976
|
summary: Deactivate an account
|
|
2016
1977
|
description: Deactivating an account permanently deletes its billing information
|
|
@@ -2234,7 +2195,7 @@ paths:
|
|
|
2234
2195
|
- "$ref": "#/components/parameters/account_id"
|
|
2235
2196
|
put:
|
|
2236
2197
|
tags:
|
|
2237
|
-
-
|
|
2198
|
+
- Account
|
|
2238
2199
|
operationId: redact_account
|
|
2239
2200
|
summary: Redact an account (GDPR Right to Erasure)
|
|
2240
2201
|
description: Permanently and irreversibly removes all personally identifiable
|
|
@@ -2273,7 +2234,7 @@ paths:
|
|
|
2273
2234
|
- "$ref": "#/components/parameters/account_id"
|
|
2274
2235
|
get:
|
|
2275
2236
|
tags:
|
|
2276
|
-
-
|
|
2237
|
+
- Account Acquisition Info
|
|
2277
2238
|
operationId: get_account_acquisition
|
|
2278
2239
|
summary: Fetch an account's acquisition data
|
|
2279
2240
|
responses:
|
|
@@ -2478,7 +2439,7 @@ paths:
|
|
|
2478
2439
|
name: Go
|
|
2479
2440
|
put:
|
|
2480
2441
|
tags:
|
|
2481
|
-
-
|
|
2442
|
+
- Account Acquisition Info
|
|
2482
2443
|
operationId: update_account_acquisition
|
|
2483
2444
|
summary: Update an account's acquisition data
|
|
2484
2445
|
requestBody:
|
|
@@ -2784,7 +2745,7 @@ paths:
|
|
|
2784
2745
|
name: Go
|
|
2785
2746
|
delete:
|
|
2786
2747
|
tags:
|
|
2787
|
-
-
|
|
2748
|
+
- Account Acquisition Info
|
|
2788
2749
|
operationId: remove_account_acquisition
|
|
2789
2750
|
summary: Remove an account's acquisition data
|
|
2790
2751
|
responses:
|
|
@@ -2983,7 +2944,7 @@ paths:
|
|
|
2983
2944
|
- "$ref": "#/components/parameters/account_id"
|
|
2984
2945
|
put:
|
|
2985
2946
|
tags:
|
|
2986
|
-
-
|
|
2947
|
+
- Account
|
|
2987
2948
|
operationId: reactivate_account
|
|
2988
2949
|
summary: Reactivate an inactive account
|
|
2989
2950
|
description: Reactivating an account will restore its history but the customer
|
|
@@ -3202,7 +3163,7 @@ paths:
|
|
|
3202
3163
|
- "$ref": "#/components/parameters/account_id"
|
|
3203
3164
|
get:
|
|
3204
3165
|
tags:
|
|
3205
|
-
-
|
|
3166
|
+
- Account
|
|
3206
3167
|
operationId: get_account_balance
|
|
3207
3168
|
summary: Fetch an account's balance and past due status
|
|
3208
3169
|
responses:
|
|
@@ -3413,7 +3374,7 @@ paths:
|
|
|
3413
3374
|
"/accounts/{account_id}/billing_info":
|
|
3414
3375
|
get:
|
|
3415
3376
|
tags:
|
|
3416
|
-
-
|
|
3377
|
+
- Billing Info
|
|
3417
3378
|
operationId: get_billing_info
|
|
3418
3379
|
summary: Fetch an account's billing information
|
|
3419
3380
|
parameters:
|
|
@@ -3626,7 +3587,7 @@ paths:
|
|
|
3626
3587
|
name: Go
|
|
3627
3588
|
put:
|
|
3628
3589
|
tags:
|
|
3629
|
-
-
|
|
3590
|
+
- Billing Info
|
|
3630
3591
|
operationId: update_billing_info
|
|
3631
3592
|
summary: Set an account's billing information
|
|
3632
3593
|
description: |
|
|
@@ -3922,7 +3883,7 @@ paths:
|
|
|
3922
3883
|
name: Go
|
|
3923
3884
|
delete:
|
|
3924
3885
|
tags:
|
|
3925
|
-
-
|
|
3886
|
+
- Billing Info
|
|
3926
3887
|
operationId: remove_billing_info
|
|
3927
3888
|
summary: Remove an account's billing information
|
|
3928
3889
|
parameters:
|
|
@@ -4125,7 +4086,7 @@ paths:
|
|
|
4125
4086
|
"/accounts/{account_id}/billing_info/verify":
|
|
4126
4087
|
post:
|
|
4127
4088
|
tags:
|
|
4128
|
-
-
|
|
4089
|
+
- Billing Info
|
|
4129
4090
|
operationId: verify_billing_info
|
|
4130
4091
|
summary: Verify an account's credit card billing information
|
|
4131
4092
|
parameters:
|
|
@@ -4354,7 +4315,7 @@ paths:
|
|
|
4354
4315
|
"/accounts/{account_id}/billing_info/verify_cvv":
|
|
4355
4316
|
post:
|
|
4356
4317
|
tags:
|
|
4357
|
-
-
|
|
4318
|
+
- Billing Info
|
|
4358
4319
|
operationId: verify_billing_info_cvv
|
|
4359
4320
|
summary: Verify an account's credit card billing cvv
|
|
4360
4321
|
parameters:
|
|
@@ -4395,7 +4356,7 @@ paths:
|
|
|
4395
4356
|
"/accounts/{account_id}/billing_infos":
|
|
4396
4357
|
get:
|
|
4397
4358
|
tags:
|
|
4398
|
-
-
|
|
4359
|
+
- Billing Infos
|
|
4399
4360
|
operationId: list_billing_infos
|
|
4400
4361
|
summary: Get the list of billing information associated with an account
|
|
4401
4362
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
@@ -4428,7 +4389,7 @@ paths:
|
|
|
4428
4389
|
x-code-samples: []
|
|
4429
4390
|
post:
|
|
4430
4391
|
tags:
|
|
4431
|
-
-
|
|
4392
|
+
- Billing Infos
|
|
4432
4393
|
operationId: create_billing_info
|
|
4433
4394
|
summary: Add new billing information on an account
|
|
4434
4395
|
description: |
|
|
@@ -4488,7 +4449,7 @@ paths:
|
|
|
4488
4449
|
"/accounts/{account_id}/billing_infos/{billing_info_id}":
|
|
4489
4450
|
get:
|
|
4490
4451
|
tags:
|
|
4491
|
-
-
|
|
4452
|
+
- Billing Infos
|
|
4492
4453
|
operationId: get_a_billing_info
|
|
4493
4454
|
summary: Fetch a billing info
|
|
4494
4455
|
parameters:
|
|
@@ -4510,7 +4471,7 @@ paths:
|
|
|
4510
4471
|
x-code-samples: []
|
|
4511
4472
|
put:
|
|
4512
4473
|
tags:
|
|
4513
|
-
-
|
|
4474
|
+
- Billing Infos
|
|
4514
4475
|
operationId: update_a_billing_info
|
|
4515
4476
|
summary: Update an account's billing information
|
|
4516
4477
|
description: |
|
|
@@ -4570,7 +4531,7 @@ paths:
|
|
|
4570
4531
|
x-code-samples: []
|
|
4571
4532
|
delete:
|
|
4572
4533
|
tags:
|
|
4573
|
-
-
|
|
4534
|
+
- Billing Infos
|
|
4574
4535
|
operationId: remove_a_billing_info
|
|
4575
4536
|
summary: Remove an account's billing information
|
|
4576
4537
|
parameters:
|
|
@@ -4600,7 +4561,7 @@ paths:
|
|
|
4600
4561
|
"/accounts/{account_id}/billing_infos/{billing_info_id}/verify":
|
|
4601
4562
|
post:
|
|
4602
4563
|
tags:
|
|
4603
|
-
-
|
|
4564
|
+
- Billing Infos
|
|
4604
4565
|
operationId: verify_billing_infos
|
|
4605
4566
|
summary: Verify a billing information's credit card
|
|
4606
4567
|
parameters:
|
|
@@ -4643,7 +4604,7 @@ paths:
|
|
|
4643
4604
|
"/accounts/{account_id}/billing_infos/{billing_info_id}/verify_cvv":
|
|
4644
4605
|
post:
|
|
4645
4606
|
tags:
|
|
4646
|
-
-
|
|
4607
|
+
- Billing Infos
|
|
4647
4608
|
operationId: verify_billing_infos_cvv
|
|
4648
4609
|
summary: Verify a billing information's credit card cvv
|
|
4649
4610
|
parameters:
|
|
@@ -4691,7 +4652,7 @@ paths:
|
|
|
4691
4652
|
"/accounts/{account_id}/coupon_redemptions":
|
|
4692
4653
|
get:
|
|
4693
4654
|
tags:
|
|
4694
|
-
-
|
|
4655
|
+
- Coupon Redemption
|
|
4695
4656
|
operationId: list_account_coupon_redemptions
|
|
4696
4657
|
summary: List the coupon redemptions for an account
|
|
4697
4658
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
@@ -4857,7 +4818,7 @@ paths:
|
|
|
4857
4818
|
"/accounts/{account_id}/coupon_redemptions/active":
|
|
4858
4819
|
get:
|
|
4859
4820
|
tags:
|
|
4860
|
-
-
|
|
4821
|
+
- Coupon Redemption
|
|
4861
4822
|
operationId: list_active_coupon_redemptions
|
|
4862
4823
|
summary: List the coupon redemptions that are active on an account
|
|
4863
4824
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
@@ -5003,7 +4964,7 @@ paths:
|
|
|
5003
4964
|
name: PHP
|
|
5004
4965
|
post:
|
|
5005
4966
|
tags:
|
|
5006
|
-
-
|
|
4967
|
+
- Coupon Redemption
|
|
5007
4968
|
operationId: create_coupon_redemption
|
|
5008
4969
|
summary: Generate an active coupon redemption on an account or subscription
|
|
5009
4970
|
parameters:
|
|
@@ -5233,7 +5194,7 @@ paths:
|
|
|
5233
5194
|
name: Go
|
|
5234
5195
|
delete:
|
|
5235
5196
|
tags:
|
|
5236
|
-
-
|
|
5197
|
+
- Coupon Redemption
|
|
5237
5198
|
operationId: remove_coupon_redemption
|
|
5238
5199
|
summary: Delete the active coupon redemption from an account
|
|
5239
5200
|
parameters:
|
|
@@ -5442,7 +5403,7 @@ paths:
|
|
|
5442
5403
|
"/accounts/{account_id}/coupon_redemptions/{coupon_redemption_id}":
|
|
5443
5404
|
get:
|
|
5444
5405
|
tags:
|
|
5445
|
-
-
|
|
5406
|
+
- Coupon Redemption
|
|
5446
5407
|
operationId: get_coupon_redemption
|
|
5447
5408
|
summary: Show the coupon redemption
|
|
5448
5409
|
parameters:
|
|
@@ -5470,7 +5431,7 @@ paths:
|
|
|
5470
5431
|
x-code-samples: []
|
|
5471
5432
|
delete:
|
|
5472
5433
|
tags:
|
|
5473
|
-
-
|
|
5434
|
+
- Coupon Redemption
|
|
5474
5435
|
operationId: remove_coupon_redemption_by_id
|
|
5475
5436
|
summary: Delete the coupon redemption
|
|
5476
5437
|
description: Deactivate the coupon redemption on an account.
|
|
@@ -5506,7 +5467,7 @@ paths:
|
|
|
5506
5467
|
"/accounts/{account_id}/credit_payments":
|
|
5507
5468
|
get:
|
|
5508
5469
|
tags:
|
|
5509
|
-
-
|
|
5470
|
+
- Credit Payment
|
|
5510
5471
|
operationId: list_account_credit_payments
|
|
5511
5472
|
summary: List an account's credit payments
|
|
5512
5473
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
@@ -5690,7 +5651,7 @@ paths:
|
|
|
5690
5651
|
- "$ref": "#/components/parameters/account_id"
|
|
5691
5652
|
get:
|
|
5692
5653
|
tags:
|
|
5693
|
-
-
|
|
5654
|
+
- External Account
|
|
5694
5655
|
operationId: list_account_external_account
|
|
5695
5656
|
summary: List external accounts for an account
|
|
5696
5657
|
responses:
|
|
@@ -5727,7 +5688,7 @@ paths:
|
|
|
5727
5688
|
x-code-samples: []
|
|
5728
5689
|
post:
|
|
5729
5690
|
tags:
|
|
5730
|
-
-
|
|
5691
|
+
- External Account
|
|
5731
5692
|
operationId: create_account_external_account
|
|
5732
5693
|
summary: Create an external account
|
|
5733
5694
|
requestBody:
|
|
@@ -5773,7 +5734,7 @@ paths:
|
|
|
5773
5734
|
- "$ref": "#/components/parameters/external_account_id"
|
|
5774
5735
|
get:
|
|
5775
5736
|
tags:
|
|
5776
|
-
-
|
|
5737
|
+
- External Account
|
|
5777
5738
|
operationId: get_account_external_account
|
|
5778
5739
|
summary: Get an external account for an account
|
|
5779
5740
|
responses:
|
|
@@ -5810,7 +5771,7 @@ paths:
|
|
|
5810
5771
|
x-code-samples: []
|
|
5811
5772
|
put:
|
|
5812
5773
|
tags:
|
|
5813
|
-
-
|
|
5774
|
+
- External Account
|
|
5814
5775
|
operationId: update_account_external_account
|
|
5815
5776
|
summary: Update an external account
|
|
5816
5777
|
requestBody:
|
|
@@ -5852,7 +5813,7 @@ paths:
|
|
|
5852
5813
|
x-code-samples: []
|
|
5853
5814
|
delete:
|
|
5854
5815
|
tags:
|
|
5855
|
-
-
|
|
5816
|
+
- External Account
|
|
5856
5817
|
operationId: delete_account_external_account
|
|
5857
5818
|
summary: Delete an external account for an account
|
|
5858
5819
|
responses:
|
|
@@ -5892,7 +5853,7 @@ paths:
|
|
|
5892
5853
|
- "$ref": "#/components/parameters/account_id"
|
|
5893
5854
|
get:
|
|
5894
5855
|
tags:
|
|
5895
|
-
-
|
|
5856
|
+
- Account
|
|
5896
5857
|
operationId: list_account_external_invoices
|
|
5897
5858
|
summary: List the external invoices on an account
|
|
5898
5859
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
@@ -5924,7 +5885,7 @@ paths:
|
|
|
5924
5885
|
"/accounts/{account_id}/invoices":
|
|
5925
5886
|
get:
|
|
5926
5887
|
tags:
|
|
5927
|
-
-
|
|
5888
|
+
- Invoice
|
|
5928
5889
|
operationId: list_account_invoices
|
|
5929
5890
|
summary: List an account's invoices
|
|
5930
5891
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
@@ -6098,7 +6059,7 @@ paths:
|
|
|
6098
6059
|
name: Go
|
|
6099
6060
|
post:
|
|
6100
6061
|
tags:
|
|
6101
|
-
-
|
|
6062
|
+
- Invoice
|
|
6102
6063
|
operationId: create_invoice
|
|
6103
6064
|
summary: Create an invoice for pending line items
|
|
6104
6065
|
parameters:
|
|
@@ -6400,7 +6361,7 @@ paths:
|
|
|
6400
6361
|
"/accounts/{account_id}/invoices/preview":
|
|
6401
6362
|
post:
|
|
6402
6363
|
tags:
|
|
6403
|
-
-
|
|
6364
|
+
- Invoice
|
|
6404
6365
|
operationId: preview_invoice
|
|
6405
6366
|
summary: Preview new invoice for pending line items
|
|
6406
6367
|
parameters:
|
|
@@ -6701,7 +6662,7 @@ paths:
|
|
|
6701
6662
|
"/accounts/{account_id}/line_items":
|
|
6702
6663
|
get:
|
|
6703
6664
|
tags:
|
|
6704
|
-
-
|
|
6665
|
+
- Line Item
|
|
6705
6666
|
operationId: list_account_line_items
|
|
6706
6667
|
summary: List an account's line items
|
|
6707
6668
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
@@ -6878,7 +6839,7 @@ paths:
|
|
|
6878
6839
|
name: Go
|
|
6879
6840
|
post:
|
|
6880
6841
|
tags:
|
|
6881
|
-
-
|
|
6842
|
+
- Line Item
|
|
6882
6843
|
operationId: create_line_item
|
|
6883
6844
|
summary: Create a new line item for the account
|
|
6884
6845
|
description: When using the Credit Invoices feature, utilize the purchases endpoint
|
|
@@ -7185,7 +7146,7 @@ paths:
|
|
|
7185
7146
|
"/accounts/{account_id}/notes":
|
|
7186
7147
|
get:
|
|
7187
7148
|
tags:
|
|
7188
|
-
-
|
|
7149
|
+
- Account Note
|
|
7189
7150
|
operationId: list_account_notes
|
|
7190
7151
|
summary: List an account's notes
|
|
7191
7152
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
@@ -7336,7 +7297,7 @@ paths:
|
|
|
7336
7297
|
name: Go
|
|
7337
7298
|
post:
|
|
7338
7299
|
tags:
|
|
7339
|
-
-
|
|
7300
|
+
- Account Note
|
|
7340
7301
|
operationId: create_account_note
|
|
7341
7302
|
summary: Create an account note
|
|
7342
7303
|
parameters:
|
|
@@ -7382,7 +7343,7 @@ paths:
|
|
|
7382
7343
|
"/accounts/{account_id}/notes/{account_note_id}":
|
|
7383
7344
|
get:
|
|
7384
7345
|
tags:
|
|
7385
|
-
-
|
|
7346
|
+
- Account Note
|
|
7386
7347
|
operationId: get_account_note
|
|
7387
7348
|
summary: Fetch an account note
|
|
7388
7349
|
parameters:
|
|
@@ -7603,7 +7564,7 @@ paths:
|
|
|
7603
7564
|
name: Go
|
|
7604
7565
|
delete:
|
|
7605
7566
|
tags:
|
|
7606
|
-
-
|
|
7567
|
+
- Account Note
|
|
7607
7568
|
operationId: remove_account_note
|
|
7608
7569
|
summary: Delete an account note
|
|
7609
7570
|
parameters:
|
|
@@ -7628,7 +7589,7 @@ paths:
|
|
|
7628
7589
|
"/accounts/{account_id}/shipping_addresses":
|
|
7629
7590
|
get:
|
|
7630
7591
|
tags:
|
|
7631
|
-
-
|
|
7592
|
+
- Shipping Address
|
|
7632
7593
|
operationId: list_shipping_addresses
|
|
7633
7594
|
summary: Fetch a list of an account's shipping addresses
|
|
7634
7595
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
@@ -7795,7 +7756,7 @@ paths:
|
|
|
7795
7756
|
name: Go
|
|
7796
7757
|
post:
|
|
7797
7758
|
tags:
|
|
7798
|
-
-
|
|
7759
|
+
- Shipping Address
|
|
7799
7760
|
operationId: create_shipping_address
|
|
7800
7761
|
summary: Create a new shipping address for the account
|
|
7801
7762
|
parameters:
|
|
@@ -8142,7 +8103,7 @@ paths:
|
|
|
8142
8103
|
"/accounts/{account_id}/shipping_addresses/{shipping_address_id}":
|
|
8143
8104
|
get:
|
|
8144
8105
|
tags:
|
|
8145
|
-
-
|
|
8106
|
+
- Shipping Address
|
|
8146
8107
|
operationId: get_shipping_address
|
|
8147
8108
|
summary: Fetch an account's shipping address
|
|
8148
8109
|
parameters:
|
|
@@ -8361,7 +8322,7 @@ paths:
|
|
|
8361
8322
|
name: Go
|
|
8362
8323
|
put:
|
|
8363
8324
|
tags:
|
|
8364
|
-
-
|
|
8325
|
+
- Shipping Address
|
|
8365
8326
|
operationId: update_shipping_address
|
|
8366
8327
|
summary: Update an account's shipping address
|
|
8367
8328
|
parameters:
|
|
@@ -8664,7 +8625,7 @@ paths:
|
|
|
8664
8625
|
name: Go
|
|
8665
8626
|
delete:
|
|
8666
8627
|
tags:
|
|
8667
|
-
-
|
|
8628
|
+
- Shipping Address
|
|
8668
8629
|
operationId: remove_shipping_address
|
|
8669
8630
|
summary: Remove an account's shipping address
|
|
8670
8631
|
parameters:
|
|
@@ -8870,7 +8831,7 @@ paths:
|
|
|
8870
8831
|
"/accounts/{account_id}/subscriptions":
|
|
8871
8832
|
get:
|
|
8872
8833
|
tags:
|
|
8873
|
-
-
|
|
8834
|
+
- Subscription
|
|
8874
8835
|
operationId: list_account_subscriptions
|
|
8875
8836
|
summary: List an account's subscriptions
|
|
8876
8837
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
@@ -9044,7 +9005,7 @@ paths:
|
|
|
9044
9005
|
"/accounts/{account_id}/transactions":
|
|
9045
9006
|
get:
|
|
9046
9007
|
tags:
|
|
9047
|
-
-
|
|
9008
|
+
- Transaction
|
|
9048
9009
|
operationId: list_account_transactions
|
|
9049
9010
|
summary: List an account's transactions
|
|
9050
9011
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
@@ -9221,7 +9182,7 @@ paths:
|
|
|
9221
9182
|
"/accounts/{account_id}/accounts":
|
|
9222
9183
|
get:
|
|
9223
9184
|
tags:
|
|
9224
|
-
-
|
|
9185
|
+
- Account
|
|
9225
9186
|
operationId: list_child_accounts
|
|
9226
9187
|
summary: List an account's child accounts
|
|
9227
9188
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
@@ -9348,7 +9309,7 @@ paths:
|
|
|
9348
9309
|
"/acquisitions":
|
|
9349
9310
|
get:
|
|
9350
9311
|
tags:
|
|
9351
|
-
-
|
|
9312
|
+
- Account Acquisition Info
|
|
9352
9313
|
operationId: list_account_acquisition
|
|
9353
9314
|
summary: List a site's account acquisition data
|
|
9354
9315
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
@@ -9515,7 +9476,7 @@ paths:
|
|
|
9515
9476
|
"/coupons":
|
|
9516
9477
|
get:
|
|
9517
9478
|
tags:
|
|
9518
|
-
-
|
|
9479
|
+
- Coupon
|
|
9519
9480
|
operationId: list_coupons
|
|
9520
9481
|
summary: List a site's coupons
|
|
9521
9482
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
@@ -9688,7 +9649,7 @@ paths:
|
|
|
9688
9649
|
name: Go
|
|
9689
9650
|
post:
|
|
9690
9651
|
tags:
|
|
9691
|
-
-
|
|
9652
|
+
- Coupon
|
|
9692
9653
|
operationId: create_coupon
|
|
9693
9654
|
summary: Create a new coupon
|
|
9694
9655
|
requestBody:
|
|
@@ -10050,7 +10011,7 @@ paths:
|
|
|
10050
10011
|
"/coupons/{coupon_id}":
|
|
10051
10012
|
get:
|
|
10052
10013
|
tags:
|
|
10053
|
-
-
|
|
10014
|
+
- Coupon
|
|
10054
10015
|
operationId: get_coupon
|
|
10055
10016
|
summary: Fetch a coupon
|
|
10056
10017
|
parameters:
|
|
@@ -10262,7 +10223,7 @@ paths:
|
|
|
10262
10223
|
name: Go
|
|
10263
10224
|
put:
|
|
10264
10225
|
tags:
|
|
10265
|
-
-
|
|
10226
|
+
- Coupon
|
|
10266
10227
|
operationId: update_coupon
|
|
10267
10228
|
summary: Update an active coupon
|
|
10268
10229
|
parameters:
|
|
@@ -10533,7 +10494,7 @@ paths:
|
|
|
10533
10494
|
name: Go
|
|
10534
10495
|
delete:
|
|
10535
10496
|
tags:
|
|
10536
|
-
-
|
|
10497
|
+
- Coupon
|
|
10537
10498
|
operationId: deactivate_coupon
|
|
10538
10499
|
summary: Expire a coupon
|
|
10539
10500
|
parameters:
|
|
@@ -10728,7 +10689,7 @@ paths:
|
|
|
10728
10689
|
"/coupons/{coupon_id}/generate":
|
|
10729
10690
|
post:
|
|
10730
10691
|
tags:
|
|
10731
|
-
-
|
|
10692
|
+
- Unique Coupon Code
|
|
10732
10693
|
operationId: generate_unique_coupon_codes
|
|
10733
10694
|
summary: Generate unique coupon codes
|
|
10734
10695
|
parameters:
|
|
@@ -10770,7 +10731,7 @@ paths:
|
|
|
10770
10731
|
"/coupons/{coupon_id}/generate_sync":
|
|
10771
10732
|
post:
|
|
10772
10733
|
tags:
|
|
10773
|
-
-
|
|
10734
|
+
- Unique Coupon Code
|
|
10774
10735
|
operationId: generate_unique_coupon_codes_sync
|
|
10775
10736
|
summary: Generate unique coupon codes synchronously
|
|
10776
10737
|
description: Generates up to 200 unique coupon codes for a bulk coupon and returns
|
|
@@ -10819,7 +10780,7 @@ paths:
|
|
|
10819
10780
|
"/coupons/{coupon_id}/restore":
|
|
10820
10781
|
put:
|
|
10821
10782
|
tags:
|
|
10822
|
-
-
|
|
10783
|
+
- Coupon
|
|
10823
10784
|
operationId: restore_coupon
|
|
10824
10785
|
summary: Restore an inactive coupon
|
|
10825
10786
|
description: Make an expired coupon redeemable again. You can change editable
|
|
@@ -10867,7 +10828,7 @@ paths:
|
|
|
10867
10828
|
"/coupons/{coupon_id}/unique_coupon_codes":
|
|
10868
10829
|
get:
|
|
10869
10830
|
tags:
|
|
10870
|
-
-
|
|
10831
|
+
- Unique Coupon Code
|
|
10871
10832
|
operationId: list_unique_coupon_codes
|
|
10872
10833
|
summary: List unique coupon codes associated with a bulk coupon
|
|
10873
10834
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
@@ -10904,7 +10865,7 @@ paths:
|
|
|
10904
10865
|
"/credit_payments":
|
|
10905
10866
|
get:
|
|
10906
10867
|
tags:
|
|
10907
|
-
-
|
|
10868
|
+
- Credit Payment
|
|
10908
10869
|
operationId: list_credit_payments
|
|
10909
10870
|
summary: List a site's credit payments
|
|
10910
10871
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
@@ -11078,7 +11039,7 @@ paths:
|
|
|
11078
11039
|
"/credit_payments/{credit_payment_id}":
|
|
11079
11040
|
get:
|
|
11080
11041
|
tags:
|
|
11081
|
-
-
|
|
11042
|
+
- Credit Payment
|
|
11082
11043
|
operationId: get_credit_payment
|
|
11083
11044
|
summary: Fetch a credit payment
|
|
11084
11045
|
parameters:
|
|
@@ -11106,7 +11067,7 @@ paths:
|
|
|
11106
11067
|
"/custom_field_definitions":
|
|
11107
11068
|
get:
|
|
11108
11069
|
tags:
|
|
11109
|
-
-
|
|
11070
|
+
- Custom Field Definition
|
|
11110
11071
|
operationId: list_custom_field_definitions
|
|
11111
11072
|
summary: List a site's custom field definitions
|
|
11112
11073
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
@@ -11287,7 +11248,7 @@ paths:
|
|
|
11287
11248
|
"/custom_field_definitions/{custom_field_definition_id}":
|
|
11288
11249
|
get:
|
|
11289
11250
|
tags:
|
|
11290
|
-
-
|
|
11251
|
+
- Custom Field Definition
|
|
11291
11252
|
operationId: get_custom_field_definition
|
|
11292
11253
|
summary: Fetch an custom field definition
|
|
11293
11254
|
parameters:
|
|
@@ -11500,7 +11461,7 @@ paths:
|
|
|
11500
11461
|
"/general_ledger_accounts":
|
|
11501
11462
|
post:
|
|
11502
11463
|
tags:
|
|
11503
|
-
-
|
|
11464
|
+
- General Ledger Account
|
|
11504
11465
|
operationId: create_general_ledger_account
|
|
11505
11466
|
summary: Create a new general ledger account
|
|
11506
11467
|
requestBody:
|
|
@@ -11525,7 +11486,7 @@ paths:
|
|
|
11525
11486
|
x-code-samples: []
|
|
11526
11487
|
get:
|
|
11527
11488
|
tags:
|
|
11528
|
-
-
|
|
11489
|
+
- General Ledger Account
|
|
11529
11490
|
operationId: list_general_ledger_accounts
|
|
11530
11491
|
summary: List a site's general ledger accounts
|
|
11531
11492
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
@@ -11553,7 +11514,7 @@ paths:
|
|
|
11553
11514
|
"/general_ledger_accounts/{general_ledger_account_id}":
|
|
11554
11515
|
get:
|
|
11555
11516
|
tags:
|
|
11556
|
-
-
|
|
11517
|
+
- General Ledger Account
|
|
11557
11518
|
operationId: get_general_ledger_account
|
|
11558
11519
|
summary: Fetch a general ledger account
|
|
11559
11520
|
parameters:
|
|
@@ -11574,7 +11535,7 @@ paths:
|
|
|
11574
11535
|
x-code-samples: []
|
|
11575
11536
|
put:
|
|
11576
11537
|
tags:
|
|
11577
|
-
-
|
|
11538
|
+
- General Ledger Account
|
|
11578
11539
|
operationId: update_general_ledger_account
|
|
11579
11540
|
summary: Update a general ledger account
|
|
11580
11541
|
parameters:
|
|
@@ -11602,7 +11563,7 @@ paths:
|
|
|
11602
11563
|
"/performance_obligations/{performance_obligation_id}":
|
|
11603
11564
|
get:
|
|
11604
11565
|
tags:
|
|
11605
|
-
-
|
|
11566
|
+
- Performance Obligations
|
|
11606
11567
|
operationId: get_performance_obligation
|
|
11607
11568
|
summary: Get a single Performance Obligation.
|
|
11608
11569
|
parameters:
|
|
@@ -11624,7 +11585,7 @@ paths:
|
|
|
11624
11585
|
"/performance_obligations":
|
|
11625
11586
|
get:
|
|
11626
11587
|
tags:
|
|
11627
|
-
-
|
|
11588
|
+
- Performance Obligations
|
|
11628
11589
|
operationId: get_performance_obligations
|
|
11629
11590
|
summary: Get a site's Performance Obligations
|
|
11630
11591
|
responses:
|
|
@@ -11644,7 +11605,7 @@ paths:
|
|
|
11644
11605
|
"/invoice_templates/{invoice_template_id}/accounts":
|
|
11645
11606
|
get:
|
|
11646
11607
|
tags:
|
|
11647
|
-
-
|
|
11608
|
+
- Account
|
|
11648
11609
|
operationId: list_invoice_template_accounts
|
|
11649
11610
|
summary: List an invoice template's associated accounts
|
|
11650
11611
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
@@ -11689,7 +11650,7 @@ paths:
|
|
|
11689
11650
|
"/items":
|
|
11690
11651
|
get:
|
|
11691
11652
|
tags:
|
|
11692
|
-
-
|
|
11653
|
+
- Item
|
|
11693
11654
|
operationId: list_items
|
|
11694
11655
|
summary: List a site's items
|
|
11695
11656
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
@@ -11863,7 +11824,7 @@ paths:
|
|
|
11863
11824
|
name: Go
|
|
11864
11825
|
post:
|
|
11865
11826
|
tags:
|
|
11866
|
-
-
|
|
11827
|
+
- Item
|
|
11867
11828
|
operationId: create_item
|
|
11868
11829
|
summary: Create a new item
|
|
11869
11830
|
requestBody:
|
|
@@ -12250,7 +12211,7 @@ paths:
|
|
|
12250
12211
|
"/items/{item_id}":
|
|
12251
12212
|
get:
|
|
12252
12213
|
tags:
|
|
12253
|
-
-
|
|
12214
|
+
- Item
|
|
12254
12215
|
operationId: get_item
|
|
12255
12216
|
summary: Fetch an item
|
|
12256
12217
|
parameters:
|
|
@@ -12462,7 +12423,7 @@ paths:
|
|
|
12462
12423
|
name: Go
|
|
12463
12424
|
put:
|
|
12464
12425
|
tags:
|
|
12465
|
-
-
|
|
12426
|
+
- Item
|
|
12466
12427
|
operationId: update_item
|
|
12467
12428
|
summary: Update an active item
|
|
12468
12429
|
parameters:
|
|
@@ -12758,7 +12719,7 @@ paths:
|
|
|
12758
12719
|
name: Go
|
|
12759
12720
|
delete:
|
|
12760
12721
|
tags:
|
|
12761
|
-
-
|
|
12722
|
+
- Item
|
|
12762
12723
|
operationId: deactivate_item
|
|
12763
12724
|
summary: Deactivate an item
|
|
12764
12725
|
parameters:
|
|
@@ -12973,7 +12934,7 @@ paths:
|
|
|
12973
12934
|
- "$ref": "#/components/parameters/item_id"
|
|
12974
12935
|
put:
|
|
12975
12936
|
tags:
|
|
12976
|
-
-
|
|
12937
|
+
- Item
|
|
12977
12938
|
operationId: reactivate_item
|
|
12978
12939
|
summary: Reactivate an inactive item
|
|
12979
12940
|
description: Reactivating an item makes it available for new purchases. It will
|
|
@@ -13190,7 +13151,7 @@ paths:
|
|
|
13190
13151
|
"/measured_units":
|
|
13191
13152
|
get:
|
|
13192
13153
|
tags:
|
|
13193
|
-
-
|
|
13154
|
+
- Measured Unit
|
|
13194
13155
|
operationId: list_measured_unit
|
|
13195
13156
|
summary: List a site's measured units
|
|
13196
13157
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
@@ -13225,7 +13186,7 @@ paths:
|
|
|
13225
13186
|
x-code-samples: []
|
|
13226
13187
|
post:
|
|
13227
13188
|
tags:
|
|
13228
|
-
-
|
|
13189
|
+
- Measured Unit
|
|
13229
13190
|
operationId: create_measured_unit
|
|
13230
13191
|
summary: Create a new measured unit
|
|
13231
13192
|
requestBody:
|
|
@@ -13269,7 +13230,7 @@ paths:
|
|
|
13269
13230
|
"/measured_units/{measured_unit_id}":
|
|
13270
13231
|
get:
|
|
13271
13232
|
tags:
|
|
13272
|
-
-
|
|
13233
|
+
- Measured Unit
|
|
13273
13234
|
operationId: get_measured_unit
|
|
13274
13235
|
summary: Fetch a measured unit
|
|
13275
13236
|
parameters:
|
|
@@ -13296,7 +13257,7 @@ paths:
|
|
|
13296
13257
|
x-code-samples: []
|
|
13297
13258
|
put:
|
|
13298
13259
|
tags:
|
|
13299
|
-
-
|
|
13260
|
+
- Measured Unit
|
|
13300
13261
|
operationId: update_measured_unit
|
|
13301
13262
|
summary: Update a measured unit
|
|
13302
13263
|
parameters:
|
|
@@ -13341,7 +13302,7 @@ paths:
|
|
|
13341
13302
|
x-code-samples: []
|
|
13342
13303
|
delete:
|
|
13343
13304
|
tags:
|
|
13344
|
-
-
|
|
13305
|
+
- Measured Unit
|
|
13345
13306
|
operationId: remove_measured_unit
|
|
13346
13307
|
summary: Remove a measured unit
|
|
13347
13308
|
description: A mesured unit cannot be deleted if it is used by an active plan.
|
|
@@ -13370,7 +13331,7 @@ paths:
|
|
|
13370
13331
|
"/external_products":
|
|
13371
13332
|
get:
|
|
13372
13333
|
tags:
|
|
13373
|
-
-
|
|
13334
|
+
- External Product
|
|
13374
13335
|
operationId: list_external_products
|
|
13375
13336
|
summary: List a site's external products
|
|
13376
13337
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
@@ -13399,7 +13360,7 @@ paths:
|
|
|
13399
13360
|
x-code-samples: []
|
|
13400
13361
|
post:
|
|
13401
13362
|
tags:
|
|
13402
|
-
-
|
|
13363
|
+
- External Product
|
|
13403
13364
|
operationId: create_external_product
|
|
13404
13365
|
summary: Create an external product
|
|
13405
13366
|
requestBody:
|
|
@@ -13439,7 +13400,7 @@ paths:
|
|
|
13439
13400
|
- "$ref": "#/components/parameters/external_product_id"
|
|
13440
13401
|
get:
|
|
13441
13402
|
tags:
|
|
13442
|
-
-
|
|
13403
|
+
- External Product
|
|
13443
13404
|
operationId: get_external_product
|
|
13444
13405
|
summary: Fetch an external product
|
|
13445
13406
|
responses:
|
|
@@ -13464,7 +13425,7 @@ paths:
|
|
|
13464
13425
|
x-code-samples: []
|
|
13465
13426
|
put:
|
|
13466
13427
|
tags:
|
|
13467
|
-
-
|
|
13428
|
+
- External Product
|
|
13468
13429
|
operationId: update_external_product
|
|
13469
13430
|
summary: Update an external product
|
|
13470
13431
|
requestBody:
|
|
@@ -13495,7 +13456,7 @@ paths:
|
|
|
13495
13456
|
x-code-samples: []
|
|
13496
13457
|
delete:
|
|
13497
13458
|
tags:
|
|
13498
|
-
-
|
|
13459
|
+
- External Product
|
|
13499
13460
|
operationId: deactivate_external_products
|
|
13500
13461
|
summary: Deactivate an external product
|
|
13501
13462
|
description: Deactivate an external product.
|
|
@@ -13524,7 +13485,7 @@ paths:
|
|
|
13524
13485
|
- "$ref": "#/components/parameters/external_product_id"
|
|
13525
13486
|
get:
|
|
13526
13487
|
tags:
|
|
13527
|
-
-
|
|
13488
|
+
- External Product Reference
|
|
13528
13489
|
operationId: list_external_product_external_product_references
|
|
13529
13490
|
summary: List the external product references for an external product
|
|
13530
13491
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
@@ -13554,7 +13515,7 @@ paths:
|
|
|
13554
13515
|
x-code-samples: []
|
|
13555
13516
|
post:
|
|
13556
13517
|
tags:
|
|
13557
|
-
-
|
|
13518
|
+
- External Product Reference
|
|
13558
13519
|
operationId: create_external_product_external_product_reference
|
|
13559
13520
|
summary: Create an external product reference on an external product
|
|
13560
13521
|
requestBody:
|
|
@@ -13589,7 +13550,7 @@ paths:
|
|
|
13589
13550
|
- "$ref": "#/components/parameters/external_product_reference_id"
|
|
13590
13551
|
get:
|
|
13591
13552
|
tags:
|
|
13592
|
-
-
|
|
13553
|
+
- External Product Reference
|
|
13593
13554
|
operationId: get_external_product_external_product_reference
|
|
13594
13555
|
summary: Fetch an external product reference
|
|
13595
13556
|
responses:
|
|
@@ -13614,7 +13575,7 @@ paths:
|
|
|
13614
13575
|
x-code-samples: []
|
|
13615
13576
|
delete:
|
|
13616
13577
|
tags:
|
|
13617
|
-
-
|
|
13578
|
+
- External Product Reference
|
|
13618
13579
|
operationId: deactivate_external_product_external_product_reference
|
|
13619
13580
|
summary: Deactivate an external product reference
|
|
13620
13581
|
responses:
|
|
@@ -13640,7 +13601,7 @@ paths:
|
|
|
13640
13601
|
"/external_subscriptions":
|
|
13641
13602
|
post:
|
|
13642
13603
|
tags:
|
|
13643
|
-
-
|
|
13604
|
+
- External Subscription
|
|
13644
13605
|
operationId: create_external_subscription
|
|
13645
13606
|
summary: Create an external subscription
|
|
13646
13607
|
requestBody:
|
|
@@ -13678,7 +13639,7 @@ paths:
|
|
|
13678
13639
|
x-code-samples: []
|
|
13679
13640
|
get:
|
|
13680
13641
|
tags:
|
|
13681
|
-
-
|
|
13642
|
+
- External Subscription
|
|
13682
13643
|
operationId: list_external_subscriptions
|
|
13683
13644
|
summary: List the external subscriptions on a site
|
|
13684
13645
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
@@ -13710,7 +13671,7 @@ paths:
|
|
|
13710
13671
|
parameters:
|
|
13711
13672
|
- "$ref": "#/components/parameters/external_subscription_id_fetch"
|
|
13712
13673
|
tags:
|
|
13713
|
-
-
|
|
13674
|
+
- External Subscription
|
|
13714
13675
|
operationId: get_external_subscription
|
|
13715
13676
|
summary: Fetch an external subscription
|
|
13716
13677
|
responses:
|
|
@@ -13744,7 +13705,7 @@ paths:
|
|
|
13744
13705
|
parameters:
|
|
13745
13706
|
- "$ref": "#/components/parameters/external_subscription_id"
|
|
13746
13707
|
tags:
|
|
13747
|
-
-
|
|
13708
|
+
- External Subscription
|
|
13748
13709
|
operationId: put_external_subscription
|
|
13749
13710
|
summary: Update an external subscription
|
|
13750
13711
|
requestBody:
|
|
@@ -13791,7 +13752,7 @@ paths:
|
|
|
13791
13752
|
- "$ref": "#/components/parameters/external_subscription_id"
|
|
13792
13753
|
get:
|
|
13793
13754
|
tags:
|
|
13794
|
-
-
|
|
13755
|
+
- External Subscription
|
|
13795
13756
|
operationId: list_external_subscription_external_invoices
|
|
13796
13757
|
summary: List the external invoices on an external subscription
|
|
13797
13758
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
@@ -13822,7 +13783,7 @@ paths:
|
|
|
13822
13783
|
x-code-samples: []
|
|
13823
13784
|
post:
|
|
13824
13785
|
tags:
|
|
13825
|
-
-
|
|
13786
|
+
- External Invoice
|
|
13826
13787
|
operationId: create_external_invoice
|
|
13827
13788
|
summary: Create an external invoice
|
|
13828
13789
|
requestBody:
|
|
@@ -13861,7 +13822,7 @@ paths:
|
|
|
13861
13822
|
"/invoices":
|
|
13862
13823
|
get:
|
|
13863
13824
|
tags:
|
|
13864
|
-
-
|
|
13825
|
+
- Invoice
|
|
13865
13826
|
operationId: list_invoices
|
|
13866
13827
|
summary: List a site's invoices
|
|
13867
13828
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
@@ -14037,7 +13998,7 @@ paths:
|
|
|
14037
13998
|
"/invoices/{invoice_id}":
|
|
14038
13999
|
get:
|
|
14039
14000
|
tags:
|
|
14040
|
-
-
|
|
14001
|
+
- Invoice
|
|
14041
14002
|
operationId: get_invoice
|
|
14042
14003
|
summary: Fetch an invoice
|
|
14043
14004
|
parameters:
|
|
@@ -14249,7 +14210,7 @@ paths:
|
|
|
14249
14210
|
name: Go
|
|
14250
14211
|
put:
|
|
14251
14212
|
tags:
|
|
14252
|
-
-
|
|
14213
|
+
- Invoice
|
|
14253
14214
|
operationId: update_invoice
|
|
14254
14215
|
summary: Update an invoice
|
|
14255
14216
|
parameters:
|
|
@@ -14526,7 +14487,7 @@ paths:
|
|
|
14526
14487
|
"/invoices/{invoice_id}.pdf":
|
|
14527
14488
|
get:
|
|
14528
14489
|
tags:
|
|
14529
|
-
-
|
|
14490
|
+
- Invoice
|
|
14530
14491
|
operationId: get_invoice_pdf
|
|
14531
14492
|
summary: Fetch an invoice as a PDF
|
|
14532
14493
|
parameters:
|
|
@@ -14780,7 +14741,7 @@ paths:
|
|
|
14780
14741
|
"/invoices/{invoice_id}/apply_credit_balance":
|
|
14781
14742
|
put:
|
|
14782
14743
|
tags:
|
|
14783
|
-
-
|
|
14744
|
+
- Invoice
|
|
14784
14745
|
operationId: apply_credit_balance
|
|
14785
14746
|
summary: Apply available credit to a pending or past due charge invoice
|
|
14786
14747
|
description: Apply credit payment to the outstanding balance on an existing
|
|
@@ -15003,7 +14964,7 @@ paths:
|
|
|
15003
14964
|
"/invoices/{invoice_id}/collect":
|
|
15004
14965
|
put:
|
|
15005
14966
|
tags:
|
|
15006
|
-
-
|
|
14967
|
+
- Invoice
|
|
15007
14968
|
operationId: collect_invoice
|
|
15008
14969
|
summary: Collect a pending or past due, automatic invoice
|
|
15009
14970
|
description: Force a collection attempt using the stored billing information.
|
|
@@ -15230,7 +15191,7 @@ paths:
|
|
|
15230
15191
|
"/invoices/{invoice_id}/mark_failed":
|
|
15231
15192
|
put:
|
|
15232
15193
|
tags:
|
|
15233
|
-
-
|
|
15194
|
+
- Invoice
|
|
15234
15195
|
operationId: mark_invoice_failed
|
|
15235
15196
|
summary: Mark an open invoice as failed
|
|
15236
15197
|
description: |
|
|
@@ -15453,7 +15414,7 @@ paths:
|
|
|
15453
15414
|
"/invoices/{invoice_id}/mark_successful":
|
|
15454
15415
|
put:
|
|
15455
15416
|
tags:
|
|
15456
|
-
-
|
|
15417
|
+
- Invoice
|
|
15457
15418
|
operationId: mark_invoice_successful
|
|
15458
15419
|
summary: Mark an open invoice as successful
|
|
15459
15420
|
description: |
|
|
@@ -15682,7 +15643,7 @@ paths:
|
|
|
15682
15643
|
"/invoices/{invoice_id}/reopen":
|
|
15683
15644
|
put:
|
|
15684
15645
|
tags:
|
|
15685
|
-
-
|
|
15646
|
+
- Invoice
|
|
15686
15647
|
operationId: reopen_invoice
|
|
15687
15648
|
summary: Reopen a closed, manual invoice
|
|
15688
15649
|
parameters:
|
|
@@ -15902,7 +15863,7 @@ paths:
|
|
|
15902
15863
|
"/invoices/{invoice_id}/void":
|
|
15903
15864
|
put:
|
|
15904
15865
|
tags:
|
|
15905
|
-
-
|
|
15866
|
+
- Invoice
|
|
15906
15867
|
operationId: void_invoice
|
|
15907
15868
|
summary: Void a credit invoice.
|
|
15908
15869
|
description: Invoice must be a credit invoice (`type=credit`) and cannot be
|
|
@@ -16086,7 +16047,7 @@ paths:
|
|
|
16086
16047
|
"/invoices/{invoice_id}/transactions":
|
|
16087
16048
|
post:
|
|
16088
16049
|
tags:
|
|
16089
|
-
-
|
|
16050
|
+
- Invoice
|
|
16090
16051
|
operationId: record_external_transaction
|
|
16091
16052
|
summary: Record an external payment for a manual invoices.
|
|
16092
16053
|
description: This endpoint allows you to record an offline payment that was
|
|
@@ -16174,7 +16135,7 @@ paths:
|
|
|
16174
16135
|
"/invoices/{invoice_id}/line_items":
|
|
16175
16136
|
get:
|
|
16176
16137
|
tags:
|
|
16177
|
-
-
|
|
16138
|
+
- Line Item
|
|
16178
16139
|
operationId: list_invoice_line_items
|
|
16179
16140
|
summary: List an invoice's line items
|
|
16180
16141
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
@@ -16359,7 +16320,7 @@ paths:
|
|
|
16359
16320
|
"/invoices/{invoice_id}/coupon_redemptions":
|
|
16360
16321
|
get:
|
|
16361
16322
|
tags:
|
|
16362
|
-
-
|
|
16323
|
+
- Coupon Redemption
|
|
16363
16324
|
operationId: list_invoice_coupon_redemptions
|
|
16364
16325
|
summary: List the coupon redemptions applied to an invoice
|
|
16365
16326
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
@@ -16522,7 +16483,7 @@ paths:
|
|
|
16522
16483
|
"/invoices/{invoice_id}/related_invoices":
|
|
16523
16484
|
get:
|
|
16524
16485
|
tags:
|
|
16525
|
-
-
|
|
16486
|
+
- Invoice
|
|
16526
16487
|
operationId: list_related_invoices
|
|
16527
16488
|
summary: List an invoice's related credit or charge invoices
|
|
16528
16489
|
description: |
|
|
@@ -16682,7 +16643,7 @@ paths:
|
|
|
16682
16643
|
"/invoices/{invoice_id}/refund":
|
|
16683
16644
|
post:
|
|
16684
16645
|
tags:
|
|
16685
|
-
-
|
|
16646
|
+
- Invoice
|
|
16686
16647
|
operationId: refund_invoice
|
|
16687
16648
|
summary: Refund an invoice
|
|
16688
16649
|
description: |
|
|
@@ -16978,7 +16939,7 @@ paths:
|
|
|
16978
16939
|
"/invoices/recovery":
|
|
16979
16940
|
post:
|
|
16980
16941
|
tags:
|
|
16981
|
-
-
|
|
16942
|
+
- Revenue Recovery
|
|
16982
16943
|
operationId: create_invoice_retry
|
|
16983
16944
|
summary: Create an invoice for revenue recovery
|
|
16984
16945
|
requestBody:
|
|
@@ -17023,7 +16984,7 @@ paths:
|
|
|
17023
16984
|
"/line_items":
|
|
17024
16985
|
get:
|
|
17025
16986
|
tags:
|
|
17026
|
-
-
|
|
16987
|
+
- Line Item
|
|
17027
16988
|
operationId: list_line_items
|
|
17028
16989
|
summary: List a site's line items
|
|
17029
16990
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
@@ -17204,7 +17165,7 @@ paths:
|
|
|
17204
17165
|
"/line_items/{line_item_id}":
|
|
17205
17166
|
get:
|
|
17206
17167
|
tags:
|
|
17207
|
-
-
|
|
17168
|
+
- Line Item
|
|
17208
17169
|
operationId: get_line_item
|
|
17209
17170
|
summary: Fetch a line item
|
|
17210
17171
|
parameters:
|
|
@@ -17416,7 +17377,7 @@ paths:
|
|
|
17416
17377
|
name: Go
|
|
17417
17378
|
delete:
|
|
17418
17379
|
tags:
|
|
17419
|
-
-
|
|
17380
|
+
- Line Item
|
|
17420
17381
|
operationId: remove_line_item
|
|
17421
17382
|
summary: Delete an uninvoiced line item
|
|
17422
17383
|
parameters:
|
|
@@ -17631,7 +17592,7 @@ paths:
|
|
|
17631
17592
|
"/plans":
|
|
17632
17593
|
get:
|
|
17633
17594
|
tags:
|
|
17634
|
-
-
|
|
17595
|
+
- Plan
|
|
17635
17596
|
operationId: list_plans
|
|
17636
17597
|
summary: List a site's plans
|
|
17637
17598
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
@@ -17805,7 +17766,7 @@ paths:
|
|
|
17805
17766
|
name: Go
|
|
17806
17767
|
post:
|
|
17807
17768
|
tags:
|
|
17808
|
-
-
|
|
17769
|
+
- Plan
|
|
17809
17770
|
operationId: create_plan
|
|
17810
17771
|
summary: Create a plan
|
|
17811
17772
|
requestBody:
|
|
@@ -18170,7 +18131,7 @@ paths:
|
|
|
18170
18131
|
"/plans/{plan_id}":
|
|
18171
18132
|
get:
|
|
18172
18133
|
tags:
|
|
18173
|
-
-
|
|
18134
|
+
- Plan
|
|
18174
18135
|
operationId: get_plan
|
|
18175
18136
|
summary: Fetch a plan
|
|
18176
18137
|
parameters:
|
|
@@ -18382,7 +18343,7 @@ paths:
|
|
|
18382
18343
|
name: Go
|
|
18383
18344
|
put:
|
|
18384
18345
|
tags:
|
|
18385
|
-
-
|
|
18346
|
+
- Plan
|
|
18386
18347
|
operationId: update_plan
|
|
18387
18348
|
summary: Update a plan
|
|
18388
18349
|
parameters:
|
|
@@ -18644,7 +18605,7 @@ paths:
|
|
|
18644
18605
|
name: Go
|
|
18645
18606
|
delete:
|
|
18646
18607
|
tags:
|
|
18647
|
-
-
|
|
18608
|
+
- Plan
|
|
18648
18609
|
operationId: remove_plan
|
|
18649
18610
|
summary: Remove a plan
|
|
18650
18611
|
parameters:
|
|
@@ -18847,7 +18808,7 @@ paths:
|
|
|
18847
18808
|
"/plans/{plan_id}/add_ons":
|
|
18848
18809
|
get:
|
|
18849
18810
|
tags:
|
|
18850
|
-
-
|
|
18811
|
+
- Add-on
|
|
18851
18812
|
operationId: list_plan_add_ons
|
|
18852
18813
|
summary: List a plan's add-ons
|
|
18853
18814
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
@@ -19020,7 +18981,7 @@ paths:
|
|
|
19020
18981
|
name: Go
|
|
19021
18982
|
post:
|
|
19022
18983
|
tags:
|
|
19023
|
-
-
|
|
18984
|
+
- Add-on
|
|
19024
18985
|
operationId: create_plan_add_on
|
|
19025
18986
|
summary: Create an add-on
|
|
19026
18987
|
parameters:
|
|
@@ -19383,7 +19344,7 @@ paths:
|
|
|
19383
19344
|
"/plans/{plan_id}/add_ons/{add_on_id}":
|
|
19384
19345
|
get:
|
|
19385
19346
|
tags:
|
|
19386
|
-
-
|
|
19347
|
+
- Add-on
|
|
19387
19348
|
operationId: get_plan_add_on
|
|
19388
19349
|
summary: Fetch a plan's add-on
|
|
19389
19350
|
parameters:
|
|
@@ -19600,7 +19561,7 @@ paths:
|
|
|
19600
19561
|
name: Go
|
|
19601
19562
|
put:
|
|
19602
19563
|
tags:
|
|
19603
|
-
-
|
|
19564
|
+
- Add-on
|
|
19604
19565
|
operationId: update_plan_add_on
|
|
19605
19566
|
summary: Update an add-on
|
|
19606
19567
|
parameters:
|
|
@@ -19853,7 +19814,7 @@ paths:
|
|
|
19853
19814
|
name: Go
|
|
19854
19815
|
delete:
|
|
19855
19816
|
tags:
|
|
19856
|
-
-
|
|
19817
|
+
- Add-on
|
|
19857
19818
|
operationId: remove_plan_add_on
|
|
19858
19819
|
summary: Remove an add-on
|
|
19859
19820
|
parameters:
|
|
@@ -20052,7 +20013,7 @@ paths:
|
|
|
20052
20013
|
"/price_segments":
|
|
20053
20014
|
get:
|
|
20054
20015
|
tags:
|
|
20055
|
-
-
|
|
20016
|
+
- Price Segment
|
|
20056
20017
|
operationId: list_price_segments
|
|
20057
20018
|
summary: List a site's price segments
|
|
20058
20019
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
@@ -20090,7 +20051,7 @@ paths:
|
|
|
20090
20051
|
"/price_segments/{price_segment_id}":
|
|
20091
20052
|
get:
|
|
20092
20053
|
tags:
|
|
20093
|
-
-
|
|
20054
|
+
- Price Segment
|
|
20094
20055
|
operationId: get_price_segment
|
|
20095
20056
|
summary: Fetch a price segment
|
|
20096
20057
|
parameters:
|
|
@@ -20118,7 +20079,7 @@ paths:
|
|
|
20118
20079
|
"/add_ons":
|
|
20119
20080
|
get:
|
|
20120
20081
|
tags:
|
|
20121
|
-
-
|
|
20082
|
+
- Add-on
|
|
20122
20083
|
operationId: list_add_ons
|
|
20123
20084
|
summary: List a site's add-ons
|
|
20124
20085
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
@@ -20289,7 +20250,7 @@ paths:
|
|
|
20289
20250
|
"/add_ons/{add_on_id}":
|
|
20290
20251
|
get:
|
|
20291
20252
|
tags:
|
|
20292
|
-
-
|
|
20253
|
+
- Add-on
|
|
20293
20254
|
operationId: get_add_on
|
|
20294
20255
|
summary: Fetch an add-on
|
|
20295
20256
|
parameters:
|
|
@@ -20502,7 +20463,7 @@ paths:
|
|
|
20502
20463
|
"/shipping_methods":
|
|
20503
20464
|
get:
|
|
20504
20465
|
tags:
|
|
20505
|
-
-
|
|
20466
|
+
- Shipping Method
|
|
20506
20467
|
operationId: list_shipping_methods
|
|
20507
20468
|
summary: List a site's shipping methods
|
|
20508
20469
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
@@ -20671,7 +20632,7 @@ paths:
|
|
|
20671
20632
|
name: Go
|
|
20672
20633
|
post:
|
|
20673
20634
|
tags:
|
|
20674
|
-
-
|
|
20635
|
+
- Shipping Method
|
|
20675
20636
|
operationId: create_shipping_method
|
|
20676
20637
|
summary: Create a new shipping method
|
|
20677
20638
|
requestBody:
|
|
@@ -20715,7 +20676,7 @@ paths:
|
|
|
20715
20676
|
"/shipping_methods/{shipping_method_id}":
|
|
20716
20677
|
get:
|
|
20717
20678
|
tags:
|
|
20718
|
-
-
|
|
20679
|
+
- Shipping Method
|
|
20719
20680
|
operationId: get_shipping_method
|
|
20720
20681
|
summary: Fetch a shipping method
|
|
20721
20682
|
parameters:
|
|
@@ -20742,7 +20703,7 @@ paths:
|
|
|
20742
20703
|
x-code-samples: []
|
|
20743
20704
|
put:
|
|
20744
20705
|
tags:
|
|
20745
|
-
-
|
|
20706
|
+
- Shipping Method
|
|
20746
20707
|
operationId: update_shipping_method
|
|
20747
20708
|
summary: Update an active Shipping Method
|
|
20748
20709
|
parameters:
|
|
@@ -20787,7 +20748,7 @@ paths:
|
|
|
20787
20748
|
x-code-samples: []
|
|
20788
20749
|
delete:
|
|
20789
20750
|
tags:
|
|
20790
|
-
-
|
|
20751
|
+
- Shipping Method
|
|
20791
20752
|
operationId: deactivate_shipping_method
|
|
20792
20753
|
summary: Deactivate a shipping method
|
|
20793
20754
|
parameters:
|
|
@@ -20817,7 +20778,7 @@ paths:
|
|
|
20817
20778
|
"/subscriptions":
|
|
20818
20779
|
get:
|
|
20819
20780
|
tags:
|
|
20820
|
-
-
|
|
20781
|
+
- Subscription
|
|
20821
20782
|
operationId: list_subscriptions
|
|
20822
20783
|
summary: List a site's subscriptions
|
|
20823
20784
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
@@ -20991,7 +20952,7 @@ paths:
|
|
|
20991
20952
|
name: Go
|
|
20992
20953
|
post:
|
|
20993
20954
|
tags:
|
|
20994
|
-
-
|
|
20955
|
+
- Subscription
|
|
20995
20956
|
operationId: create_subscription
|
|
20996
20957
|
summary: Create a new subscription
|
|
20997
20958
|
requestBody:
|
|
@@ -21315,7 +21276,7 @@ paths:
|
|
|
21315
21276
|
"/subscriptions/{subscription_id}":
|
|
21316
21277
|
get:
|
|
21317
21278
|
tags:
|
|
21318
|
-
-
|
|
21279
|
+
- Subscription
|
|
21319
21280
|
operationId: get_subscription
|
|
21320
21281
|
summary: Fetch a subscription
|
|
21321
21282
|
parameters:
|
|
@@ -21531,7 +21492,7 @@ paths:
|
|
|
21531
21492
|
name: Go
|
|
21532
21493
|
put:
|
|
21533
21494
|
tags:
|
|
21534
|
-
-
|
|
21495
|
+
- Subscription
|
|
21535
21496
|
operationId: update_subscription
|
|
21536
21497
|
summary: Update a subscription
|
|
21537
21498
|
description: This only lets you change the subscription settings that have no
|
|
@@ -21804,7 +21765,7 @@ paths:
|
|
|
21804
21765
|
name: Go
|
|
21805
21766
|
delete:
|
|
21806
21767
|
tags:
|
|
21807
|
-
-
|
|
21768
|
+
- Subscription
|
|
21808
21769
|
operationId: terminate_subscription
|
|
21809
21770
|
summary: Terminate a subscription
|
|
21810
21771
|
description: |
|
|
@@ -22071,7 +22032,7 @@ paths:
|
|
|
22071
22032
|
"/subscriptions/{subscription_id}/cancel":
|
|
22072
22033
|
put:
|
|
22073
22034
|
tags:
|
|
22074
|
-
-
|
|
22035
|
+
- Subscription
|
|
22075
22036
|
operationId: cancel_subscription
|
|
22076
22037
|
summary: Cancel a subscription
|
|
22077
22038
|
description: A canceled subscription will continue through its current billing
|
|
@@ -22309,7 +22270,7 @@ paths:
|
|
|
22309
22270
|
"/subscriptions/{subscription_id}/reactivate":
|
|
22310
22271
|
put:
|
|
22311
22272
|
tags:
|
|
22312
|
-
-
|
|
22273
|
+
- Subscription
|
|
22313
22274
|
operationId: reactivate_subscription
|
|
22314
22275
|
summary: Reactivate a canceled subscription
|
|
22315
22276
|
description: |
|
|
@@ -22539,7 +22500,7 @@ paths:
|
|
|
22539
22500
|
"/subscriptions/{subscription_id}/pause":
|
|
22540
22501
|
put:
|
|
22541
22502
|
tags:
|
|
22542
|
-
-
|
|
22503
|
+
- Subscription
|
|
22543
22504
|
operationId: pause_subscription
|
|
22544
22505
|
summary: Pause subscription
|
|
22545
22506
|
description: |
|
|
@@ -22809,7 +22770,7 @@ paths:
|
|
|
22809
22770
|
"/subscriptions/{subscription_id}/resume":
|
|
22810
22771
|
put:
|
|
22811
22772
|
tags:
|
|
22812
|
-
-
|
|
22773
|
+
- Subscription
|
|
22813
22774
|
operationId: resume_subscription
|
|
22814
22775
|
summary: Resume subscription
|
|
22815
22776
|
description: |
|
|
@@ -23040,7 +23001,7 @@ paths:
|
|
|
23040
23001
|
"/subscriptions/{subscription_id}/convert_trial":
|
|
23041
23002
|
put:
|
|
23042
23003
|
tags:
|
|
23043
|
-
-
|
|
23004
|
+
- Subscription
|
|
23044
23005
|
operationId: convert_trial
|
|
23045
23006
|
summary: Convert trial subscription
|
|
23046
23007
|
description: This will immediately convert a trial subscription to a fully active
|
|
@@ -23080,7 +23041,7 @@ paths:
|
|
|
23080
23041
|
"/subscriptions/{subscription_id}/preview_renewal":
|
|
23081
23042
|
get:
|
|
23082
23043
|
tags:
|
|
23083
|
-
-
|
|
23044
|
+
- Subscription
|
|
23084
23045
|
operationId: get_preview_renewal
|
|
23085
23046
|
summary: Fetch a preview of a subscription's renewal invoice(s)
|
|
23086
23047
|
description: The subscriptions's renewal invoice(s) will be returned if they
|
|
@@ -23306,7 +23267,7 @@ paths:
|
|
|
23306
23267
|
"/subscriptions/{subscription_id}/change":
|
|
23307
23268
|
get:
|
|
23308
23269
|
tags:
|
|
23309
|
-
-
|
|
23270
|
+
- Subscription Change
|
|
23310
23271
|
operationId: get_subscription_change
|
|
23311
23272
|
summary: Fetch a subscription's pending change
|
|
23312
23273
|
parameters:
|
|
@@ -23535,7 +23496,7 @@ paths:
|
|
|
23535
23496
|
name: Go
|
|
23536
23497
|
post:
|
|
23537
23498
|
tags:
|
|
23538
|
-
-
|
|
23499
|
+
- Subscription Change
|
|
23539
23500
|
operationId: create_subscription_change
|
|
23540
23501
|
summary: Create a new subscription change
|
|
23541
23502
|
description: |
|
|
@@ -23830,7 +23791,7 @@ paths:
|
|
|
23830
23791
|
name: Go
|
|
23831
23792
|
delete:
|
|
23832
23793
|
tags:
|
|
23833
|
-
-
|
|
23794
|
+
- Subscription Change
|
|
23834
23795
|
operationId: remove_subscription_change
|
|
23835
23796
|
summary: Delete the pending subscription change
|
|
23836
23797
|
parameters:
|
|
@@ -24041,7 +24002,7 @@ paths:
|
|
|
24041
24002
|
"/subscriptions/{subscription_id}/change/preview":
|
|
24042
24003
|
post:
|
|
24043
24004
|
tags:
|
|
24044
|
-
-
|
|
24005
|
+
- Subscription Change
|
|
24045
24006
|
operationId: preview_subscription_change
|
|
24046
24007
|
summary: Preview a new subscription change
|
|
24047
24008
|
description: Calling this will not save the subscription change or overwrite
|
|
@@ -24084,7 +24045,7 @@ paths:
|
|
|
24084
24045
|
"/subscriptions/{subscription_id}/invoices":
|
|
24085
24046
|
get:
|
|
24086
24047
|
tags:
|
|
24087
|
-
-
|
|
24048
|
+
- Invoice
|
|
24088
24049
|
operationId: list_subscription_invoices
|
|
24089
24050
|
summary: List a subscription's invoices
|
|
24090
24051
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
@@ -24260,7 +24221,7 @@ paths:
|
|
|
24260
24221
|
"/subscriptions/{subscription_id}/line_items":
|
|
24261
24222
|
get:
|
|
24262
24223
|
tags:
|
|
24263
|
-
-
|
|
24224
|
+
- Line Item
|
|
24264
24225
|
operationId: list_subscription_line_items
|
|
24265
24226
|
summary: List a subscription's line items
|
|
24266
24227
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
@@ -24438,7 +24399,7 @@ paths:
|
|
|
24438
24399
|
"/subscriptions/{subscription_id}/coupon_redemptions":
|
|
24439
24400
|
get:
|
|
24440
24401
|
tags:
|
|
24441
|
-
-
|
|
24402
|
+
- Coupon Redemption
|
|
24442
24403
|
operationId: list_subscription_coupon_redemptions
|
|
24443
24404
|
summary: List the coupon redemptions for a subscription
|
|
24444
24405
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
@@ -24605,7 +24566,7 @@ paths:
|
|
|
24605
24566
|
"/subscriptions/{subscription_id}/coupon_redemptions/{coupon_redemption_id}":
|
|
24606
24567
|
get:
|
|
24607
24568
|
tags:
|
|
24608
|
-
-
|
|
24569
|
+
- Coupon Redemption
|
|
24609
24570
|
operationId: get_subscription_coupon_redemption
|
|
24610
24571
|
summary: Show the coupon redemption for a subscription
|
|
24611
24572
|
parameters:
|
|
@@ -24633,7 +24594,7 @@ paths:
|
|
|
24633
24594
|
x-code-samples: []
|
|
24634
24595
|
delete:
|
|
24635
24596
|
tags:
|
|
24636
|
-
-
|
|
24597
|
+
- Coupon Redemption
|
|
24637
24598
|
operationId: remove_subscription_coupon_redemption
|
|
24638
24599
|
summary: Delete the coupon redemption from a subscription
|
|
24639
24600
|
description: Deactivate the coupon redemption on a subscription.
|
|
@@ -24669,7 +24630,7 @@ paths:
|
|
|
24669
24630
|
"/subscriptions/{subscription_id}/add_ons/{add_on_id}/usage":
|
|
24670
24631
|
get:
|
|
24671
24632
|
tags:
|
|
24672
|
-
-
|
|
24633
|
+
- Usage
|
|
24673
24634
|
operationId: list_usage
|
|
24674
24635
|
summary: List a subscription add-on's usage records
|
|
24675
24636
|
parameters:
|
|
@@ -24710,7 +24671,7 @@ paths:
|
|
|
24710
24671
|
x-code-samples: []
|
|
24711
24672
|
post:
|
|
24712
24673
|
tags:
|
|
24713
|
-
-
|
|
24674
|
+
- Usage
|
|
24714
24675
|
operationId: create_usage
|
|
24715
24676
|
summary: Log a usage record on this subscription add-on
|
|
24716
24677
|
parameters:
|
|
@@ -24757,7 +24718,7 @@ paths:
|
|
|
24757
24718
|
"/usage/{usage_id}":
|
|
24758
24719
|
get:
|
|
24759
24720
|
tags:
|
|
24760
|
-
-
|
|
24721
|
+
- Usage
|
|
24761
24722
|
operationId: get_usage
|
|
24762
24723
|
summary: Get a usage record
|
|
24763
24724
|
parameters:
|
|
@@ -24790,7 +24751,7 @@ paths:
|
|
|
24790
24751
|
x-code-samples: []
|
|
24791
24752
|
put:
|
|
24792
24753
|
tags:
|
|
24793
|
-
-
|
|
24754
|
+
- Usage
|
|
24794
24755
|
operationId: update_usage
|
|
24795
24756
|
summary: Update a usage record
|
|
24796
24757
|
parameters:
|
|
@@ -24835,7 +24796,7 @@ paths:
|
|
|
24835
24796
|
x-code-samples: []
|
|
24836
24797
|
delete:
|
|
24837
24798
|
tags:
|
|
24838
|
-
-
|
|
24799
|
+
- Usage
|
|
24839
24800
|
operationId: remove_usage
|
|
24840
24801
|
summary: Delete a usage record.
|
|
24841
24802
|
parameters:
|
|
@@ -24871,7 +24832,7 @@ paths:
|
|
|
24871
24832
|
"/transactions":
|
|
24872
24833
|
get:
|
|
24873
24834
|
tags:
|
|
24874
|
-
-
|
|
24835
|
+
- Transaction
|
|
24875
24836
|
operationId: list_transactions
|
|
24876
24837
|
summary: List a site's transactions
|
|
24877
24838
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
@@ -25047,7 +25008,7 @@ paths:
|
|
|
25047
25008
|
"/transactions/{transaction_id}":
|
|
25048
25009
|
get:
|
|
25049
25010
|
tags:
|
|
25050
|
-
-
|
|
25011
|
+
- Transaction
|
|
25051
25012
|
operationId: get_transaction
|
|
25052
25013
|
summary: Fetch a transaction
|
|
25053
25014
|
parameters:
|
|
@@ -25262,7 +25223,7 @@ paths:
|
|
|
25262
25223
|
- "$ref": "#/components/parameters/unique_coupon_code_id"
|
|
25263
25224
|
get:
|
|
25264
25225
|
tags:
|
|
25265
|
-
-
|
|
25226
|
+
- Unique Coupon Code
|
|
25266
25227
|
operationId: get_unique_coupon_code
|
|
25267
25228
|
summary: Fetch a unique coupon code
|
|
25268
25229
|
responses:
|
|
@@ -25287,7 +25248,7 @@ paths:
|
|
|
25287
25248
|
x-code-samples: []
|
|
25288
25249
|
delete:
|
|
25289
25250
|
tags:
|
|
25290
|
-
-
|
|
25251
|
+
- Unique Coupon Code
|
|
25291
25252
|
operationId: deactivate_unique_coupon_code
|
|
25292
25253
|
summary: Deactivate a unique coupon code
|
|
25293
25254
|
description: Expire a unique code, making that specific code no longer redeemable.
|
|
@@ -25323,7 +25284,7 @@ paths:
|
|
|
25323
25284
|
- "$ref": "#/components/parameters/unique_coupon_code_id"
|
|
25324
25285
|
put:
|
|
25325
25286
|
tags:
|
|
25326
|
-
-
|
|
25287
|
+
- Unique Coupon Code
|
|
25327
25288
|
operationId: reactivate_unique_coupon_code
|
|
25328
25289
|
summary: Restore a unique coupon code
|
|
25329
25290
|
responses:
|
|
@@ -25355,7 +25316,7 @@ paths:
|
|
|
25355
25316
|
"/purchases":
|
|
25356
25317
|
post:
|
|
25357
25318
|
tags:
|
|
25358
|
-
-
|
|
25319
|
+
- Purchase
|
|
25359
25320
|
operationId: create_purchase
|
|
25360
25321
|
summary: Create a new purchase
|
|
25361
25322
|
description: A purchase is a checkout containing at least one or more subscriptions
|
|
@@ -25801,7 +25762,7 @@ paths:
|
|
|
25801
25762
|
"/purchases/preview":
|
|
25802
25763
|
post:
|
|
25803
25764
|
tags:
|
|
25804
|
-
-
|
|
25765
|
+
- Purchase
|
|
25805
25766
|
operationId: preview_purchase
|
|
25806
25767
|
summary: Preview a new purchase
|
|
25807
25768
|
description: A purchase is a checkout containing at least one or more subscriptions
|
|
@@ -26237,7 +26198,7 @@ paths:
|
|
|
26237
26198
|
"/purchases/pending":
|
|
26238
26199
|
post:
|
|
26239
26200
|
tags:
|
|
26240
|
-
-
|
|
26201
|
+
- Purchase
|
|
26241
26202
|
operationId: create_pending_purchase
|
|
26242
26203
|
summary: Create a pending purchase
|
|
26243
26204
|
description: |-
|
|
@@ -26742,7 +26703,7 @@ paths:
|
|
|
26742
26703
|
"/purchases/authorize":
|
|
26743
26704
|
post:
|
|
26744
26705
|
tags:
|
|
26745
|
-
-
|
|
26706
|
+
- Purchase
|
|
26746
26707
|
operationId: create_authorize_purchase
|
|
26747
26708
|
summary: Authorize a purchase
|
|
26748
26709
|
description: |-
|
|
@@ -26786,7 +26747,7 @@ paths:
|
|
|
26786
26747
|
"/purchases/{transaction_id}/capture":
|
|
26787
26748
|
post:
|
|
26788
26749
|
tags:
|
|
26789
|
-
-
|
|
26750
|
+
- Purchase
|
|
26790
26751
|
parameters:
|
|
26791
26752
|
- "$ref": "#/components/parameters/transaction_id"
|
|
26792
26753
|
operationId: create_capture_purchase
|
|
@@ -26837,7 +26798,7 @@ paths:
|
|
|
26837
26798
|
|
|
26838
26799
|
Cancel an open Authorization request
|
|
26839
26800
|
tags:
|
|
26840
|
-
-
|
|
26801
|
+
- Purchase
|
|
26841
26802
|
operationId: cancelPurchase
|
|
26842
26803
|
responses:
|
|
26843
26804
|
'200':
|
|
@@ -26868,7 +26829,7 @@ paths:
|
|
|
26868
26829
|
"/export_dates":
|
|
26869
26830
|
get:
|
|
26870
26831
|
tags:
|
|
26871
|
-
-
|
|
26832
|
+
- Automated Exports
|
|
26872
26833
|
operationId: get_export_dates
|
|
26873
26834
|
summary: List the dates that have an available export to download.
|
|
26874
26835
|
description: Returns a list of dates for which export files are available for
|
|
@@ -27065,7 +27026,7 @@ paths:
|
|
|
27065
27026
|
- "$ref": "#/components/parameters/export_date"
|
|
27066
27027
|
get:
|
|
27067
27028
|
tags:
|
|
27068
|
-
-
|
|
27029
|
+
- Automated Exports
|
|
27069
27030
|
operationId: get_export_files
|
|
27070
27031
|
summary: List of the export files that are available to download.
|
|
27071
27032
|
description: Returns a list of presigned URLs to download export files for the
|
|
@@ -27260,7 +27221,7 @@ paths:
|
|
|
27260
27221
|
"/dunning_campaigns":
|
|
27261
27222
|
get:
|
|
27262
27223
|
tags:
|
|
27263
|
-
-
|
|
27224
|
+
- Dunning Campaigns
|
|
27264
27225
|
operationId: list_dunning_campaigns
|
|
27265
27226
|
summary: List the dunning campaigns for a site
|
|
27266
27227
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
@@ -27287,12 +27248,68 @@ paths:
|
|
|
27287
27248
|
schema:
|
|
27288
27249
|
"$ref": "#/components/schemas/Error"
|
|
27289
27250
|
x-code-samples: []
|
|
27251
|
+
post:
|
|
27252
|
+
tags:
|
|
27253
|
+
- Dunning Campaigns
|
|
27254
|
+
operationId: create_dunning_campaign
|
|
27255
|
+
summary: Create a new dunning campaign
|
|
27256
|
+
requestBody:
|
|
27257
|
+
content:
|
|
27258
|
+
application/json:
|
|
27259
|
+
schema:
|
|
27260
|
+
"$ref": "#/components/schemas/DunningCampaignCreate"
|
|
27261
|
+
required: true
|
|
27262
|
+
responses:
|
|
27263
|
+
'201':
|
|
27264
|
+
description: A new dunning campaign.
|
|
27265
|
+
content:
|
|
27266
|
+
application/json:
|
|
27267
|
+
schema:
|
|
27268
|
+
"$ref": "#/components/schemas/DunningCampaign"
|
|
27269
|
+
'400':
|
|
27270
|
+
description: Bad request; perhaps missing or invalid parameters.
|
|
27271
|
+
content:
|
|
27272
|
+
application/json:
|
|
27273
|
+
schema:
|
|
27274
|
+
"$ref": "#/components/schemas/Error"
|
|
27275
|
+
'403':
|
|
27276
|
+
description: Upgrade your plan to unlock multiple dunning campaigns.
|
|
27277
|
+
content:
|
|
27278
|
+
application/json:
|
|
27279
|
+
schema:
|
|
27280
|
+
"$ref": "#/components/schemas/Error"
|
|
27281
|
+
'404':
|
|
27282
|
+
description: Incorrect site.
|
|
27283
|
+
content:
|
|
27284
|
+
application/json:
|
|
27285
|
+
schema:
|
|
27286
|
+
"$ref": "#/components/schemas/Error"
|
|
27287
|
+
'422':
|
|
27288
|
+
description: Invalid request parameters.
|
|
27289
|
+
content:
|
|
27290
|
+
application/json:
|
|
27291
|
+
schema:
|
|
27292
|
+
"$ref": "#/components/schemas/Error"
|
|
27293
|
+
'503':
|
|
27294
|
+
description: The email template service is temporarily unavailable; retry
|
|
27295
|
+
the request.
|
|
27296
|
+
content:
|
|
27297
|
+
application/json:
|
|
27298
|
+
schema:
|
|
27299
|
+
"$ref": "#/components/schemas/Error"
|
|
27300
|
+
default:
|
|
27301
|
+
description: Unexpected error.
|
|
27302
|
+
content:
|
|
27303
|
+
application/json:
|
|
27304
|
+
schema:
|
|
27305
|
+
"$ref": "#/components/schemas/Error"
|
|
27306
|
+
x-code-samples: []
|
|
27290
27307
|
"/dunning_campaigns/{dunning_campaign_id}":
|
|
27291
27308
|
parameters:
|
|
27292
27309
|
- "$ref": "#/components/parameters/dunning_campaign_id"
|
|
27293
27310
|
get:
|
|
27294
27311
|
tags:
|
|
27295
|
-
-
|
|
27312
|
+
- Dunning Campaigns
|
|
27296
27313
|
operationId: get_dunning_campaign
|
|
27297
27314
|
summary: Fetch a dunning campaign
|
|
27298
27315
|
responses:
|
|
@@ -27321,12 +27338,141 @@ paths:
|
|
|
27321
27338
|
schema:
|
|
27322
27339
|
"$ref": "#/components/schemas/Error"
|
|
27323
27340
|
x-code-samples: []
|
|
27341
|
+
put:
|
|
27342
|
+
tags:
|
|
27343
|
+
- Dunning Campaigns
|
|
27344
|
+
operationId: update_dunning_campaign
|
|
27345
|
+
summary: Update a dunning campaign
|
|
27346
|
+
description: Each cycle write is a full replacement of that cycle's settings;
|
|
27347
|
+
omitted scalars fall back to the model default rather than the prior version.
|
|
27348
|
+
requestBody:
|
|
27349
|
+
content:
|
|
27350
|
+
application/json:
|
|
27351
|
+
schema:
|
|
27352
|
+
"$ref": "#/components/schemas/DunningCampaignUpdate"
|
|
27353
|
+
required: true
|
|
27354
|
+
responses:
|
|
27355
|
+
'200':
|
|
27356
|
+
description: The updated dunning campaign.
|
|
27357
|
+
content:
|
|
27358
|
+
application/json:
|
|
27359
|
+
schema:
|
|
27360
|
+
"$ref": "#/components/schemas/DunningCampaign"
|
|
27361
|
+
'400':
|
|
27362
|
+
description: Bad request; perhaps missing or invalid parameters.
|
|
27363
|
+
content:
|
|
27364
|
+
application/json:
|
|
27365
|
+
schema:
|
|
27366
|
+
"$ref": "#/components/schemas/Error"
|
|
27367
|
+
'403':
|
|
27368
|
+
description: Upgrade your plan to unlock multiple dunning campaigns.
|
|
27369
|
+
content:
|
|
27370
|
+
application/json:
|
|
27371
|
+
schema:
|
|
27372
|
+
"$ref": "#/components/schemas/Error"
|
|
27373
|
+
'404':
|
|
27374
|
+
description: Incorrect site or campaign ID.
|
|
27375
|
+
content:
|
|
27376
|
+
application/json:
|
|
27377
|
+
schema:
|
|
27378
|
+
"$ref": "#/components/schemas/Error"
|
|
27379
|
+
'422':
|
|
27380
|
+
description: Invalid request parameters.
|
|
27381
|
+
content:
|
|
27382
|
+
application/json:
|
|
27383
|
+
schema:
|
|
27384
|
+
"$ref": "#/components/schemas/Error"
|
|
27385
|
+
'503':
|
|
27386
|
+
description: The email template service is temporarily unavailable; retry
|
|
27387
|
+
the request.
|
|
27388
|
+
content:
|
|
27389
|
+
application/json:
|
|
27390
|
+
schema:
|
|
27391
|
+
"$ref": "#/components/schemas/Error"
|
|
27392
|
+
default:
|
|
27393
|
+
description: Unexpected error.
|
|
27394
|
+
content:
|
|
27395
|
+
application/json:
|
|
27396
|
+
schema:
|
|
27397
|
+
"$ref": "#/components/schemas/Error"
|
|
27398
|
+
x-code-samples: []
|
|
27399
|
+
delete:
|
|
27400
|
+
tags:
|
|
27401
|
+
- Dunning Campaigns
|
|
27402
|
+
operationId: deactivate_dunning_campaign
|
|
27403
|
+
summary: Deactivate a dunning campaign
|
|
27404
|
+
description: The default dunning campaign cannot be deactivated.
|
|
27405
|
+
responses:
|
|
27406
|
+
'200':
|
|
27407
|
+
description: The deactivated dunning campaign.
|
|
27408
|
+
content:
|
|
27409
|
+
application/json:
|
|
27410
|
+
schema:
|
|
27411
|
+
"$ref": "#/components/schemas/DunningCampaign"
|
|
27412
|
+
'403':
|
|
27413
|
+
description: Upgrade your plan to unlock multiple dunning campaigns.
|
|
27414
|
+
content:
|
|
27415
|
+
application/json:
|
|
27416
|
+
schema:
|
|
27417
|
+
"$ref": "#/components/schemas/Error"
|
|
27418
|
+
'404':
|
|
27419
|
+
description: Incorrect site or campaign ID.
|
|
27420
|
+
content:
|
|
27421
|
+
application/json:
|
|
27422
|
+
schema:
|
|
27423
|
+
"$ref": "#/components/schemas/Error"
|
|
27424
|
+
'422':
|
|
27425
|
+
description: Campaign is already inactive, or is the default campaign.
|
|
27426
|
+
content:
|
|
27427
|
+
application/json:
|
|
27428
|
+
schema:
|
|
27429
|
+
"$ref": "#/components/schemas/Error"
|
|
27430
|
+
default:
|
|
27431
|
+
description: Unexpected error.
|
|
27432
|
+
content:
|
|
27433
|
+
application/json:
|
|
27434
|
+
schema:
|
|
27435
|
+
"$ref": "#/components/schemas/Error"
|
|
27436
|
+
x-code-samples: []
|
|
27437
|
+
"/dunning_campaigns/email_templates":
|
|
27438
|
+
get:
|
|
27439
|
+
tags:
|
|
27440
|
+
- Dunning Campaigns
|
|
27441
|
+
operationId: list_dunning_campaign_email_templates
|
|
27442
|
+
summary: List the custom email templates assignable to a dunning campaign interval
|
|
27443
|
+
responses:
|
|
27444
|
+
'200':
|
|
27445
|
+
description: A list of the site's assignable custom email templates.
|
|
27446
|
+
content:
|
|
27447
|
+
application/json:
|
|
27448
|
+
schema:
|
|
27449
|
+
"$ref": "#/components/schemas/DunningCampaignEmailTemplateList"
|
|
27450
|
+
'404':
|
|
27451
|
+
description: Incorrect site.
|
|
27452
|
+
content:
|
|
27453
|
+
application/json:
|
|
27454
|
+
schema:
|
|
27455
|
+
"$ref": "#/components/schemas/Error"
|
|
27456
|
+
'503':
|
|
27457
|
+
description: The email template service is temporarily unavailable; retry
|
|
27458
|
+
the request.
|
|
27459
|
+
content:
|
|
27460
|
+
application/json:
|
|
27461
|
+
schema:
|
|
27462
|
+
"$ref": "#/components/schemas/Error"
|
|
27463
|
+
default:
|
|
27464
|
+
description: Unexpected error.
|
|
27465
|
+
content:
|
|
27466
|
+
application/json:
|
|
27467
|
+
schema:
|
|
27468
|
+
"$ref": "#/components/schemas/Error"
|
|
27469
|
+
x-code-samples: []
|
|
27324
27470
|
"/dunning_campaigns/{dunning_campaign_id}/bulk_update":
|
|
27325
27471
|
parameters:
|
|
27326
27472
|
- "$ref": "#/components/parameters/dunning_campaign_id"
|
|
27327
27473
|
put:
|
|
27328
27474
|
tags:
|
|
27329
|
-
-
|
|
27475
|
+
- Dunning Campaigns
|
|
27330
27476
|
operationId: put_dunning_campaign_bulk_update
|
|
27331
27477
|
summary: Assign a dunning campaign to multiple plans
|
|
27332
27478
|
requestBody:
|
|
@@ -27363,7 +27509,7 @@ paths:
|
|
|
27363
27509
|
"/invoice_templates":
|
|
27364
27510
|
get:
|
|
27365
27511
|
tags:
|
|
27366
|
-
-
|
|
27512
|
+
- Invoice Templates
|
|
27367
27513
|
operationId: list_invoice_templates
|
|
27368
27514
|
summary: Show the invoice templates for a site
|
|
27369
27515
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
@@ -27395,7 +27541,7 @@ paths:
|
|
|
27395
27541
|
- "$ref": "#/components/parameters/invoice_template_id"
|
|
27396
27542
|
get:
|
|
27397
27543
|
tags:
|
|
27398
|
-
-
|
|
27544
|
+
- Invoice Templates
|
|
27399
27545
|
operationId: get_invoice_template
|
|
27400
27546
|
summary: Fetch an invoice template
|
|
27401
27547
|
responses:
|
|
@@ -27427,7 +27573,7 @@ paths:
|
|
|
27427
27573
|
"/external_invoices":
|
|
27428
27574
|
get:
|
|
27429
27575
|
tags:
|
|
27430
|
-
-
|
|
27576
|
+
- External Invoice
|
|
27431
27577
|
operationId: list_external_invoices
|
|
27432
27578
|
summary: List the external invoices on a site
|
|
27433
27579
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
@@ -27461,7 +27607,7 @@ paths:
|
|
|
27461
27607
|
- "$ref": "#/components/parameters/external_invoice_id"
|
|
27462
27608
|
get:
|
|
27463
27609
|
tags:
|
|
27464
|
-
-
|
|
27610
|
+
- External Invoice
|
|
27465
27611
|
operationId: show_external_invoice
|
|
27466
27612
|
summary: Fetch an external invoice
|
|
27467
27613
|
responses:
|
|
@@ -27495,7 +27641,7 @@ paths:
|
|
|
27495
27641
|
- "$ref": "#/components/parameters/external_subscription_id"
|
|
27496
27642
|
get:
|
|
27497
27643
|
tags:
|
|
27498
|
-
-
|
|
27644
|
+
- External Subscription
|
|
27499
27645
|
operationId: list_external_subscription_external_payment_phases
|
|
27500
27646
|
summary: List the external payment phases on an external subscription
|
|
27501
27647
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
@@ -27530,7 +27676,7 @@ paths:
|
|
|
27530
27676
|
- "$ref": "#/components/parameters/external_payment_phase_id"
|
|
27531
27677
|
get:
|
|
27532
27678
|
tags:
|
|
27533
|
-
-
|
|
27679
|
+
- External Payment Phase
|
|
27534
27680
|
operationId: get_external_subscription_external_payment_phase
|
|
27535
27681
|
summary: Fetch an external payment phase
|
|
27536
27682
|
responses:
|
|
@@ -27559,7 +27705,7 @@ paths:
|
|
|
27559
27705
|
- "$ref": "#/components/parameters/filter_limited_subscription_state"
|
|
27560
27706
|
get:
|
|
27561
27707
|
tags:
|
|
27562
|
-
-
|
|
27708
|
+
- Account
|
|
27563
27709
|
operationId: list_entitlements
|
|
27564
27710
|
summary: List entitlements granted to an account
|
|
27565
27711
|
responses:
|
|
@@ -27587,7 +27733,7 @@ paths:
|
|
|
27587
27733
|
- "$ref": "#/components/parameters/account_id"
|
|
27588
27734
|
get:
|
|
27589
27735
|
tags:
|
|
27590
|
-
-
|
|
27736
|
+
- Account
|
|
27591
27737
|
operationId: list_account_external_subscriptions
|
|
27592
27738
|
summary: List an account's external subscriptions
|
|
27593
27739
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
@@ -27619,7 +27765,7 @@ paths:
|
|
|
27619
27765
|
- "$ref": "#/components/parameters/business_entity_id"
|
|
27620
27766
|
get:
|
|
27621
27767
|
tags:
|
|
27622
|
-
-
|
|
27768
|
+
- Business Entities
|
|
27623
27769
|
operationId: get_business_entity
|
|
27624
27770
|
summary: Fetch a business entity
|
|
27625
27771
|
responses:
|
|
@@ -27645,7 +27791,7 @@ paths:
|
|
|
27645
27791
|
"/business_entities":
|
|
27646
27792
|
get:
|
|
27647
27793
|
tags:
|
|
27648
|
-
-
|
|
27794
|
+
- Business Entities
|
|
27649
27795
|
operationId: list_business_entities
|
|
27650
27796
|
summary: List business entities
|
|
27651
27797
|
responses:
|
|
@@ -27671,7 +27817,7 @@ paths:
|
|
|
27671
27817
|
"/gift_cards":
|
|
27672
27818
|
get:
|
|
27673
27819
|
tags:
|
|
27674
|
-
-
|
|
27820
|
+
- Gift Cards
|
|
27675
27821
|
operationId: list_gift_cards
|
|
27676
27822
|
summary: List gift cards
|
|
27677
27823
|
responses:
|
|
@@ -27696,7 +27842,7 @@ paths:
|
|
|
27696
27842
|
x-code-samples: []
|
|
27697
27843
|
post:
|
|
27698
27844
|
tags:
|
|
27699
|
-
-
|
|
27845
|
+
- Gift Cards
|
|
27700
27846
|
operationId: create_gift_card
|
|
27701
27847
|
summary: Create gift card
|
|
27702
27848
|
requestBody:
|
|
@@ -27736,7 +27882,7 @@ paths:
|
|
|
27736
27882
|
- "$ref": "#/components/parameters/gift_card_id"
|
|
27737
27883
|
get:
|
|
27738
27884
|
tags:
|
|
27739
|
-
-
|
|
27885
|
+
- Gift Cards
|
|
27740
27886
|
operationId: get_gift_card
|
|
27741
27887
|
summary: Fetch a gift card
|
|
27742
27888
|
responses:
|
|
@@ -27762,7 +27908,7 @@ paths:
|
|
|
27762
27908
|
"/gift_cards/preview":
|
|
27763
27909
|
post:
|
|
27764
27910
|
tags:
|
|
27765
|
-
-
|
|
27911
|
+
- Gift Cards
|
|
27766
27912
|
operationId: preview_gift_card
|
|
27767
27913
|
summary: Preview gift card
|
|
27768
27914
|
requestBody:
|
|
@@ -27802,7 +27948,7 @@ paths:
|
|
|
27802
27948
|
- "$ref": "#/components/parameters/redemption_code"
|
|
27803
27949
|
post:
|
|
27804
27950
|
tags:
|
|
27805
|
-
-
|
|
27951
|
+
- Gift Cards
|
|
27806
27952
|
operationId: redeem_gift_card
|
|
27807
27953
|
summary: Redeem gift card
|
|
27808
27954
|
requestBody:
|
|
@@ -27840,7 +27986,7 @@ paths:
|
|
|
27840
27986
|
"/business_entities/{business_entity_id}/invoices":
|
|
27841
27987
|
get:
|
|
27842
27988
|
tags:
|
|
27843
|
-
-
|
|
27989
|
+
- Invoice
|
|
27844
27990
|
operationId: list_business_entity_invoices
|
|
27845
27991
|
summary: List a business entity's invoices
|
|
27846
27992
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
@@ -36745,6 +36891,155 @@ components:
|
|
|
36745
36891
|
email_template:
|
|
36746
36892
|
type: string
|
|
36747
36893
|
description: Email template being used.
|
|
36894
|
+
email_template_id:
|
|
36895
|
+
type: string
|
|
36896
|
+
nullable: true
|
|
36897
|
+
description: The id of the custom email template assigned to this interval,
|
|
36898
|
+
from `GET /dunning_campaigns/email_templates`. `null` means the system
|
|
36899
|
+
default template for this interval. Accepted on write; round-tripped on
|
|
36900
|
+
read.
|
|
36901
|
+
DunningCampaignCreate:
|
|
36902
|
+
type: object
|
|
36903
|
+
properties:
|
|
36904
|
+
name:
|
|
36905
|
+
type: string
|
|
36906
|
+
title: Name
|
|
36907
|
+
description: Campaign name.
|
|
36908
|
+
maxLength: 255
|
|
36909
|
+
code:
|
|
36910
|
+
type: string
|
|
36911
|
+
title: Code
|
|
36912
|
+
description: Campaign code.
|
|
36913
|
+
maxLength: 50
|
|
36914
|
+
description:
|
|
36915
|
+
type: string
|
|
36916
|
+
title: Description
|
|
36917
|
+
description: Campaign description.
|
|
36918
|
+
maxLength: 255
|
|
36919
|
+
dunning_cycles:
|
|
36920
|
+
type: array
|
|
36921
|
+
description: Dunning Cycle settings. One entry per collection method (`automatic`,
|
|
36922
|
+
`manual`, `trial`); each type may appear at most once.
|
|
36923
|
+
items:
|
|
36924
|
+
"$ref": "#/components/schemas/DunningCycleCreate"
|
|
36925
|
+
required:
|
|
36926
|
+
- name
|
|
36927
|
+
- code
|
|
36928
|
+
DunningCampaignUpdate:
|
|
36929
|
+
type: object
|
|
36930
|
+
properties:
|
|
36931
|
+
name:
|
|
36932
|
+
type: string
|
|
36933
|
+
title: Name
|
|
36934
|
+
description: Campaign name.
|
|
36935
|
+
maxLength: 255
|
|
36936
|
+
code:
|
|
36937
|
+
type: string
|
|
36938
|
+
title: Code
|
|
36939
|
+
description: Campaign code.
|
|
36940
|
+
maxLength: 50
|
|
36941
|
+
description:
|
|
36942
|
+
type: string
|
|
36943
|
+
title: Description
|
|
36944
|
+
description: Campaign description.
|
|
36945
|
+
maxLength: 255
|
|
36946
|
+
default_campaign:
|
|
36947
|
+
type: boolean
|
|
36948
|
+
title: Default Campaign
|
|
36949
|
+
description: Set to `true` to make this the default campaign for accounts
|
|
36950
|
+
or plans without an assigned dunning campaign. Cannot be set on an inactive
|
|
36951
|
+
campaign, and cannot be unset directly—assign a different campaign as
|
|
36952
|
+
the default instead.
|
|
36953
|
+
dunning_cycles:
|
|
36954
|
+
type: array
|
|
36955
|
+
description: Dunning Cycle settings. One entry per collection method (`automatic`,
|
|
36956
|
+
`manual`, `trial`); each type may appear at most once. Each cycle write
|
|
36957
|
+
fully replaces that cycle's current settings version.
|
|
36958
|
+
items:
|
|
36959
|
+
"$ref": "#/components/schemas/DunningCycleCreate"
|
|
36960
|
+
DunningCycleCreate:
|
|
36961
|
+
type: object
|
|
36962
|
+
description: Write shape for a single dunning cycle, shared by campaign create
|
|
36963
|
+
and update.
|
|
36964
|
+
properties:
|
|
36965
|
+
type:
|
|
36966
|
+
"$ref": "#/components/schemas/DunningCycleTypeEnum"
|
|
36967
|
+
active:
|
|
36968
|
+
type: boolean
|
|
36969
|
+
description: Only meaningful on the `trial` cycle, where sending `false`
|
|
36970
|
+
removes it. Other cycle types cannot be deactivated.
|
|
36971
|
+
applies_to_manual_trial:
|
|
36972
|
+
type: boolean
|
|
36973
|
+
description: Whether the dunning settings will be applied to manual trials.
|
|
36974
|
+
Only applies to trial cycles.
|
|
36975
|
+
expire_subscription:
|
|
36976
|
+
type: boolean
|
|
36977
|
+
description: Whether the subscription(s) should be cancelled at the end
|
|
36978
|
+
of the dunning cycle.
|
|
36979
|
+
fail_invoice:
|
|
36980
|
+
type: boolean
|
|
36981
|
+
description: Whether the invoice should be failed at the end of the dunning
|
|
36982
|
+
cycle.
|
|
36983
|
+
send_immediately_on_hard_decline:
|
|
36984
|
+
type: boolean
|
|
36985
|
+
description: Whether or not to send an extra email immediately to customers
|
|
36986
|
+
whose initial payment attempt fails with either a hard decline or invalid
|
|
36987
|
+
billing info.
|
|
36988
|
+
external_payment_recovery_extension_days:
|
|
36989
|
+
type: integer
|
|
36990
|
+
description: Number of days to extend external payment recovery. Only available
|
|
36991
|
+
when the site has external payment retries enabled.
|
|
36992
|
+
intervals:
|
|
36993
|
+
type: array
|
|
36994
|
+
description: Dunning intervals. Required unless `active` is `false`.
|
|
36995
|
+
items:
|
|
36996
|
+
"$ref": "#/components/schemas/DunningIntervalCreate"
|
|
36997
|
+
required:
|
|
36998
|
+
- type
|
|
36999
|
+
DunningIntervalCreate:
|
|
37000
|
+
type: object
|
|
37001
|
+
description: Write shape for a dunning interval. Unlike the read `DunningInterval`,
|
|
37002
|
+
the resolved `email_template` name is not accepted on write.
|
|
37003
|
+
properties:
|
|
37004
|
+
days:
|
|
37005
|
+
type: integer
|
|
37006
|
+
description: Number of days before sending the next email.
|
|
37007
|
+
email_template_id:
|
|
37008
|
+
type: string
|
|
37009
|
+
nullable: true
|
|
37010
|
+
description: The id of the custom email template to assign to this interval,
|
|
37011
|
+
from `GET /dunning_campaigns/email_templates`. `null` uses the system
|
|
37012
|
+
default template for this interval.
|
|
37013
|
+
DunningCampaignEmailTemplate:
|
|
37014
|
+
type: object
|
|
37015
|
+
properties:
|
|
37016
|
+
id:
|
|
37017
|
+
type: string
|
|
37018
|
+
description: The id to assign under `intervals[].email_template_id`.
|
|
37019
|
+
name:
|
|
37020
|
+
type: string
|
|
37021
|
+
description: Template name.
|
|
37022
|
+
type:
|
|
37023
|
+
type: string
|
|
37024
|
+
description: The root template this custom template replaces, e.g. `payment_declined`,
|
|
37025
|
+
`invoice_past_due`, `post_trial_payment_declined`, `subscription_canceled_nonpayment`.
|
|
37026
|
+
DunningCampaignEmailTemplateList:
|
|
37027
|
+
type: object
|
|
37028
|
+
properties:
|
|
37029
|
+
object:
|
|
37030
|
+
type: string
|
|
37031
|
+
title: Object type
|
|
37032
|
+
description: Will always be List.
|
|
37033
|
+
has_more:
|
|
37034
|
+
type: boolean
|
|
37035
|
+
description: Indicates there are more results on subsequent pages.
|
|
37036
|
+
next:
|
|
37037
|
+
type: string
|
|
37038
|
+
description: Path to subsequent page of results.
|
|
37039
|
+
data:
|
|
37040
|
+
type: array
|
|
37041
|
+
items:
|
|
37042
|
+
"$ref": "#/components/schemas/DunningCampaignEmailTemplate"
|
|
36748
37043
|
DunningCampaignsBulkUpdate:
|
|
36749
37044
|
properties:
|
|
36750
37045
|
plan_codes:
|