recurly 4.82.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.
data/openapi/api.yaml CHANGED
@@ -217,186 +217,155 @@ security:
217
217
  x-tagGroups:
218
218
  - name: Customers
219
219
  tags:
220
- - account
221
- - note
222
- - account_acquisition
223
- - billing_info
224
- - billing_infos
225
- - coupon_redemption
226
- - subscription
227
- - subscription_change
228
- - usage
229
- - shipping_address
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
- - purchase
233
- - invoice
234
- - line_item
235
- - credit_payment
236
- - transaction
237
- - revenue_recovery
238
- - gift_cards
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
- - item
242
- - plan
243
- - add-on
244
- - measured_unit
245
- - coupon
246
- - unique_coupon_code
247
- - price_segment
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
- - 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
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
- - external_subscriptions
262
- - external_invoices
263
- - external_products
264
- - external_accounts
265
- - external_product_references
266
- - external_payment_phases
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: account
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: note
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: account_acquisition
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: billing_info
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: billing_infos
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: coupon_redemption
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: subscription
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: subscription_change
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: usage
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: shipping_address
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: purchase
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: invoice
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: line_item
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: credit_payment
336
- x-displayName: Credit Payment
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: revenue_recovery
343
- x-displayName: Revenue Recovery
327
+ - name: Revenue Recovery
344
328
  description: Revenue recovery
345
- - name: gift_cards
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: item
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: plan
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: add-on
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: measured_unit
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: coupon
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: unique_coupon_code
375
- x-displayName: Unique Coupon Code
352
+ - name: Unique Coupon Code
376
353
  description: Unique coupon codes are generated from bulk coupons.
377
- - name: price_segment
378
- x-displayName: Price Segment
379
- - name: site
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: shipping_method
386
- x-displayName: Shipping Method
359
+ - name: Shipping Method
387
360
  description: Shipping methods offered to send products to customers.
388
- - name: dunning_campaigns
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: business_entities
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: automated_exports
396
- x-displayName: Automated Exports
366
+ - name: Automated Exports
397
367
  description: Automated exports of customer data.
398
- - name: general_ledger_account
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: performance_obligations
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: invoice_templates
448
- x-displayName: Invoice Templates
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: external_invoices
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: external_products
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: external_accounts
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: external_product_references
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: external_payment_phases
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
- - site
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
- - site
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
- - account
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
- - account
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
- - account
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
- - account
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
- - account
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
- - account
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
- - account_acquisition
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
- - account_acquisition
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
- - account_acquisition
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
- - account
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
- - account
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
- - billing_info
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
- - billing_info
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
- - billing_info
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
- - billing_info
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
- - billing_info
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
- - billing_infos
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
- - billing_infos
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
- - billing_infos
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
- - billing_infos
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
- - billing_infos
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
- - billing_infos
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
- - billing_infos
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
- - coupon_redemption
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
- - coupon_redemption
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
- - coupon_redemption
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
- - coupon_redemption
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
- - coupon_redemption
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
- - coupon_redemption
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
- - credit_payment
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
- - external_accounts
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
- - external_accounts
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
- - external_accounts
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
- - external_accounts
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
- - external_accounts
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
- - account
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
- - invoice
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
- - invoice
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
- - invoice
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
- - line_item
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
- - line_item
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
- - note
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
- - note
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
- - note
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
- - note
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
- - shipping_address
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
- - shipping_address
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
- - shipping_address
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
- - shipping_address
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
- - shipping_address
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
- - subscription
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
- - transaction
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
- - account
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
- - account_acquisition
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
- - coupon
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
- - coupon
9652
+ - Coupon
9692
9653
  operationId: create_coupon
9693
9654
  summary: Create a new coupon
9694
9655
  requestBody:
@@ -9717,7 +9678,8 @@ paths:
9717
9678
  schema:
9718
9679
  "$ref": "#/components/schemas/Error"
9719
9680
  '422':
9720
- description: Invalid request parameters.
9681
+ description: Invalid request parameters. Check that redeem_by_interval_unit
9682
+ and redeem_by_interval_amount are consistent with the coupon type.
9721
9683
  content:
9722
9684
  application/json:
9723
9685
  schema:
@@ -10049,7 +10011,7 @@ paths:
10049
10011
  "/coupons/{coupon_id}":
10050
10012
  get:
10051
10013
  tags:
10052
- - coupon
10014
+ - Coupon
10053
10015
  operationId: get_coupon
10054
10016
  summary: Fetch a coupon
10055
10017
  parameters:
@@ -10261,7 +10223,7 @@ paths:
10261
10223
  name: Go
10262
10224
  put:
10263
10225
  tags:
10264
- - coupon
10226
+ - Coupon
10265
10227
  operationId: update_coupon
10266
10228
  summary: Update an active coupon
10267
10229
  parameters:
@@ -10292,7 +10254,8 @@ paths:
10292
10254
  schema:
10293
10255
  "$ref": "#/components/schemas/Error"
10294
10256
  '422':
10295
- description: Invalid request parameters
10257
+ description: Invalid request parameters. Check that redeem_by_interval_unit
10258
+ and redeem_by_interval_amount are consistent with the coupon type.
10296
10259
  content:
10297
10260
  application/json:
10298
10261
  schema:
@@ -10531,7 +10494,7 @@ paths:
10531
10494
  name: Go
10532
10495
  delete:
10533
10496
  tags:
10534
- - coupon
10497
+ - Coupon
10535
10498
  operationId: deactivate_coupon
10536
10499
  summary: Expire a coupon
10537
10500
  parameters:
@@ -10726,7 +10689,7 @@ paths:
10726
10689
  "/coupons/{coupon_id}/generate":
10727
10690
  post:
10728
10691
  tags:
10729
- - unique_coupon_code
10692
+ - Unique Coupon Code
10730
10693
  operationId: generate_unique_coupon_codes
10731
10694
  summary: Generate unique coupon codes
10732
10695
  parameters:
@@ -10768,7 +10731,7 @@ paths:
10768
10731
  "/coupons/{coupon_id}/generate_sync":
10769
10732
  post:
10770
10733
  tags:
10771
- - unique_coupon_code
10734
+ - Unique Coupon Code
10772
10735
  operationId: generate_unique_coupon_codes_sync
10773
10736
  summary: Generate unique coupon codes synchronously
10774
10737
  description: Generates up to 200 unique coupon codes for a bulk coupon and returns
@@ -10817,7 +10780,7 @@ paths:
10817
10780
  "/coupons/{coupon_id}/restore":
10818
10781
  put:
10819
10782
  tags:
10820
- - coupon
10783
+ - Coupon
10821
10784
  operationId: restore_coupon
10822
10785
  summary: Restore an inactive coupon
10823
10786
  description: Make an expired coupon redeemable again. You can change editable
@@ -10865,7 +10828,7 @@ paths:
10865
10828
  "/coupons/{coupon_id}/unique_coupon_codes":
10866
10829
  get:
10867
10830
  tags:
10868
- - unique_coupon_code
10831
+ - Unique Coupon Code
10869
10832
  operationId: list_unique_coupon_codes
10870
10833
  summary: List unique coupon codes associated with a bulk coupon
10871
10834
  description: See the [Pagination Guide](/developers/guides/pagination.html)
@@ -10902,7 +10865,7 @@ paths:
10902
10865
  "/credit_payments":
10903
10866
  get:
10904
10867
  tags:
10905
- - credit_payment
10868
+ - Credit Payment
10906
10869
  operationId: list_credit_payments
10907
10870
  summary: List a site's credit payments
10908
10871
  description: See the [Pagination Guide](/developers/guides/pagination.html)
@@ -11076,7 +11039,7 @@ paths:
11076
11039
  "/credit_payments/{credit_payment_id}":
11077
11040
  get:
11078
11041
  tags:
11079
- - credit_payment
11042
+ - Credit Payment
11080
11043
  operationId: get_credit_payment
11081
11044
  summary: Fetch a credit payment
11082
11045
  parameters:
@@ -11104,7 +11067,7 @@ paths:
11104
11067
  "/custom_field_definitions":
11105
11068
  get:
11106
11069
  tags:
11107
- - custom_field_definition
11070
+ - Custom Field Definition
11108
11071
  operationId: list_custom_field_definitions
11109
11072
  summary: List a site's custom field definitions
11110
11073
  description: See the [Pagination Guide](/developers/guides/pagination.html)
@@ -11285,7 +11248,7 @@ paths:
11285
11248
  "/custom_field_definitions/{custom_field_definition_id}":
11286
11249
  get:
11287
11250
  tags:
11288
- - custom_field_definition
11251
+ - Custom Field Definition
11289
11252
  operationId: get_custom_field_definition
11290
11253
  summary: Fetch an custom field definition
11291
11254
  parameters:
@@ -11498,7 +11461,7 @@ paths:
11498
11461
  "/general_ledger_accounts":
11499
11462
  post:
11500
11463
  tags:
11501
- - general_ledger_account
11464
+ - General Ledger Account
11502
11465
  operationId: create_general_ledger_account
11503
11466
  summary: Create a new general ledger account
11504
11467
  requestBody:
@@ -11523,7 +11486,7 @@ paths:
11523
11486
  x-code-samples: []
11524
11487
  get:
11525
11488
  tags:
11526
- - general_ledger_account
11489
+ - General Ledger Account
11527
11490
  operationId: list_general_ledger_accounts
11528
11491
  summary: List a site's general ledger accounts
11529
11492
  description: See the [Pagination Guide](/developers/guides/pagination.html)
@@ -11551,7 +11514,7 @@ paths:
11551
11514
  "/general_ledger_accounts/{general_ledger_account_id}":
11552
11515
  get:
11553
11516
  tags:
11554
- - general_ledger_account
11517
+ - General Ledger Account
11555
11518
  operationId: get_general_ledger_account
11556
11519
  summary: Fetch a general ledger account
11557
11520
  parameters:
@@ -11572,7 +11535,7 @@ paths:
11572
11535
  x-code-samples: []
11573
11536
  put:
11574
11537
  tags:
11575
- - general_ledger_account
11538
+ - General Ledger Account
11576
11539
  operationId: update_general_ledger_account
11577
11540
  summary: Update a general ledger account
11578
11541
  parameters:
@@ -11600,7 +11563,7 @@ paths:
11600
11563
  "/performance_obligations/{performance_obligation_id}":
11601
11564
  get:
11602
11565
  tags:
11603
- - performance_obligations
11566
+ - Performance Obligations
11604
11567
  operationId: get_performance_obligation
11605
11568
  summary: Get a single Performance Obligation.
11606
11569
  parameters:
@@ -11622,7 +11585,7 @@ paths:
11622
11585
  "/performance_obligations":
11623
11586
  get:
11624
11587
  tags:
11625
- - performance_obligations
11588
+ - Performance Obligations
11626
11589
  operationId: get_performance_obligations
11627
11590
  summary: Get a site's Performance Obligations
11628
11591
  responses:
@@ -11642,7 +11605,7 @@ paths:
11642
11605
  "/invoice_templates/{invoice_template_id}/accounts":
11643
11606
  get:
11644
11607
  tags:
11645
- - account
11608
+ - Account
11646
11609
  operationId: list_invoice_template_accounts
11647
11610
  summary: List an invoice template's associated accounts
11648
11611
  description: See the [Pagination Guide](/developers/guides/pagination.html)
@@ -11687,7 +11650,7 @@ paths:
11687
11650
  "/items":
11688
11651
  get:
11689
11652
  tags:
11690
- - item
11653
+ - Item
11691
11654
  operationId: list_items
11692
11655
  summary: List a site's items
11693
11656
  description: See the [Pagination Guide](/developers/guides/pagination.html)
@@ -11861,7 +11824,7 @@ paths:
11861
11824
  name: Go
11862
11825
  post:
11863
11826
  tags:
11864
- - item
11827
+ - Item
11865
11828
  operationId: create_item
11866
11829
  summary: Create a new item
11867
11830
  requestBody:
@@ -12248,7 +12211,7 @@ paths:
12248
12211
  "/items/{item_id}":
12249
12212
  get:
12250
12213
  tags:
12251
- - item
12214
+ - Item
12252
12215
  operationId: get_item
12253
12216
  summary: Fetch an item
12254
12217
  parameters:
@@ -12460,7 +12423,7 @@ paths:
12460
12423
  name: Go
12461
12424
  put:
12462
12425
  tags:
12463
- - item
12426
+ - Item
12464
12427
  operationId: update_item
12465
12428
  summary: Update an active item
12466
12429
  parameters:
@@ -12756,7 +12719,7 @@ paths:
12756
12719
  name: Go
12757
12720
  delete:
12758
12721
  tags:
12759
- - item
12722
+ - Item
12760
12723
  operationId: deactivate_item
12761
12724
  summary: Deactivate an item
12762
12725
  parameters:
@@ -12971,7 +12934,7 @@ paths:
12971
12934
  - "$ref": "#/components/parameters/item_id"
12972
12935
  put:
12973
12936
  tags:
12974
- - item
12937
+ - Item
12975
12938
  operationId: reactivate_item
12976
12939
  summary: Reactivate an inactive item
12977
12940
  description: Reactivating an item makes it available for new purchases. It will
@@ -13188,7 +13151,7 @@ paths:
13188
13151
  "/measured_units":
13189
13152
  get:
13190
13153
  tags:
13191
- - measured_unit
13154
+ - Measured Unit
13192
13155
  operationId: list_measured_unit
13193
13156
  summary: List a site's measured units
13194
13157
  description: See the [Pagination Guide](/developers/guides/pagination.html)
@@ -13223,7 +13186,7 @@ paths:
13223
13186
  x-code-samples: []
13224
13187
  post:
13225
13188
  tags:
13226
- - measured_unit
13189
+ - Measured Unit
13227
13190
  operationId: create_measured_unit
13228
13191
  summary: Create a new measured unit
13229
13192
  requestBody:
@@ -13267,7 +13230,7 @@ paths:
13267
13230
  "/measured_units/{measured_unit_id}":
13268
13231
  get:
13269
13232
  tags:
13270
- - measured_unit
13233
+ - Measured Unit
13271
13234
  operationId: get_measured_unit
13272
13235
  summary: Fetch a measured unit
13273
13236
  parameters:
@@ -13294,7 +13257,7 @@ paths:
13294
13257
  x-code-samples: []
13295
13258
  put:
13296
13259
  tags:
13297
- - measured_unit
13260
+ - Measured Unit
13298
13261
  operationId: update_measured_unit
13299
13262
  summary: Update a measured unit
13300
13263
  parameters:
@@ -13339,7 +13302,7 @@ paths:
13339
13302
  x-code-samples: []
13340
13303
  delete:
13341
13304
  tags:
13342
- - measured_unit
13305
+ - Measured Unit
13343
13306
  operationId: remove_measured_unit
13344
13307
  summary: Remove a measured unit
13345
13308
  description: A mesured unit cannot be deleted if it is used by an active plan.
@@ -13368,7 +13331,7 @@ paths:
13368
13331
  "/external_products":
13369
13332
  get:
13370
13333
  tags:
13371
- - external_products
13334
+ - External Product
13372
13335
  operationId: list_external_products
13373
13336
  summary: List a site's external products
13374
13337
  description: See the [Pagination Guide](/developers/guides/pagination.html)
@@ -13397,7 +13360,7 @@ paths:
13397
13360
  x-code-samples: []
13398
13361
  post:
13399
13362
  tags:
13400
- - external_products
13363
+ - External Product
13401
13364
  operationId: create_external_product
13402
13365
  summary: Create an external product
13403
13366
  requestBody:
@@ -13437,7 +13400,7 @@ paths:
13437
13400
  - "$ref": "#/components/parameters/external_product_id"
13438
13401
  get:
13439
13402
  tags:
13440
- - external_products
13403
+ - External Product
13441
13404
  operationId: get_external_product
13442
13405
  summary: Fetch an external product
13443
13406
  responses:
@@ -13462,7 +13425,7 @@ paths:
13462
13425
  x-code-samples: []
13463
13426
  put:
13464
13427
  tags:
13465
- - external_products
13428
+ - External Product
13466
13429
  operationId: update_external_product
13467
13430
  summary: Update an external product
13468
13431
  requestBody:
@@ -13493,7 +13456,7 @@ paths:
13493
13456
  x-code-samples: []
13494
13457
  delete:
13495
13458
  tags:
13496
- - external_products
13459
+ - External Product
13497
13460
  operationId: deactivate_external_products
13498
13461
  summary: Deactivate an external product
13499
13462
  description: Deactivate an external product.
@@ -13522,7 +13485,7 @@ paths:
13522
13485
  - "$ref": "#/components/parameters/external_product_id"
13523
13486
  get:
13524
13487
  tags:
13525
- - external_product_references
13488
+ - External Product Reference
13526
13489
  operationId: list_external_product_external_product_references
13527
13490
  summary: List the external product references for an external product
13528
13491
  description: See the [Pagination Guide](/developers/guides/pagination.html)
@@ -13552,7 +13515,7 @@ paths:
13552
13515
  x-code-samples: []
13553
13516
  post:
13554
13517
  tags:
13555
- - external_product_references
13518
+ - External Product Reference
13556
13519
  operationId: create_external_product_external_product_reference
13557
13520
  summary: Create an external product reference on an external product
13558
13521
  requestBody:
@@ -13587,7 +13550,7 @@ paths:
13587
13550
  - "$ref": "#/components/parameters/external_product_reference_id"
13588
13551
  get:
13589
13552
  tags:
13590
- - external_product_references
13553
+ - External Product Reference
13591
13554
  operationId: get_external_product_external_product_reference
13592
13555
  summary: Fetch an external product reference
13593
13556
  responses:
@@ -13612,7 +13575,7 @@ paths:
13612
13575
  x-code-samples: []
13613
13576
  delete:
13614
13577
  tags:
13615
- - external_product_references
13578
+ - External Product Reference
13616
13579
  operationId: deactivate_external_product_external_product_reference
13617
13580
  summary: Deactivate an external product reference
13618
13581
  responses:
@@ -13638,7 +13601,7 @@ paths:
13638
13601
  "/external_subscriptions":
13639
13602
  post:
13640
13603
  tags:
13641
- - external_subscriptions
13604
+ - External Subscription
13642
13605
  operationId: create_external_subscription
13643
13606
  summary: Create an external subscription
13644
13607
  requestBody:
@@ -13676,7 +13639,7 @@ paths:
13676
13639
  x-code-samples: []
13677
13640
  get:
13678
13641
  tags:
13679
- - external_subscriptions
13642
+ - External Subscription
13680
13643
  operationId: list_external_subscriptions
13681
13644
  summary: List the external subscriptions on a site
13682
13645
  description: See the [Pagination Guide](/developers/guides/pagination.html)
@@ -13708,7 +13671,7 @@ paths:
13708
13671
  parameters:
13709
13672
  - "$ref": "#/components/parameters/external_subscription_id_fetch"
13710
13673
  tags:
13711
- - external_subscriptions
13674
+ - External Subscription
13712
13675
  operationId: get_external_subscription
13713
13676
  summary: Fetch an external subscription
13714
13677
  responses:
@@ -13742,7 +13705,7 @@ paths:
13742
13705
  parameters:
13743
13706
  - "$ref": "#/components/parameters/external_subscription_id"
13744
13707
  tags:
13745
- - external_subscriptions
13708
+ - External Subscription
13746
13709
  operationId: put_external_subscription
13747
13710
  summary: Update an external subscription
13748
13711
  requestBody:
@@ -13789,7 +13752,7 @@ paths:
13789
13752
  - "$ref": "#/components/parameters/external_subscription_id"
13790
13753
  get:
13791
13754
  tags:
13792
- - external_subscriptions
13755
+ - External Subscription
13793
13756
  operationId: list_external_subscription_external_invoices
13794
13757
  summary: List the external invoices on an external subscription
13795
13758
  description: See the [Pagination Guide](/developers/guides/pagination.html)
@@ -13820,7 +13783,7 @@ paths:
13820
13783
  x-code-samples: []
13821
13784
  post:
13822
13785
  tags:
13823
- - external_invoices
13786
+ - External Invoice
13824
13787
  operationId: create_external_invoice
13825
13788
  summary: Create an external invoice
13826
13789
  requestBody:
@@ -13859,7 +13822,7 @@ paths:
13859
13822
  "/invoices":
13860
13823
  get:
13861
13824
  tags:
13862
- - invoice
13825
+ - Invoice
13863
13826
  operationId: list_invoices
13864
13827
  summary: List a site's invoices
13865
13828
  description: See the [Pagination Guide](/developers/guides/pagination.html)
@@ -14035,7 +13998,7 @@ paths:
14035
13998
  "/invoices/{invoice_id}":
14036
13999
  get:
14037
14000
  tags:
14038
- - invoice
14001
+ - Invoice
14039
14002
  operationId: get_invoice
14040
14003
  summary: Fetch an invoice
14041
14004
  parameters:
@@ -14247,7 +14210,7 @@ paths:
14247
14210
  name: Go
14248
14211
  put:
14249
14212
  tags:
14250
- - invoice
14213
+ - Invoice
14251
14214
  operationId: update_invoice
14252
14215
  summary: Update an invoice
14253
14216
  parameters:
@@ -14524,7 +14487,7 @@ paths:
14524
14487
  "/invoices/{invoice_id}.pdf":
14525
14488
  get:
14526
14489
  tags:
14527
- - invoice
14490
+ - Invoice
14528
14491
  operationId: get_invoice_pdf
14529
14492
  summary: Fetch an invoice as a PDF
14530
14493
  parameters:
@@ -14778,7 +14741,7 @@ paths:
14778
14741
  "/invoices/{invoice_id}/apply_credit_balance":
14779
14742
  put:
14780
14743
  tags:
14781
- - invoice
14744
+ - Invoice
14782
14745
  operationId: apply_credit_balance
14783
14746
  summary: Apply available credit to a pending or past due charge invoice
14784
14747
  description: Apply credit payment to the outstanding balance on an existing
@@ -15001,7 +14964,7 @@ paths:
15001
14964
  "/invoices/{invoice_id}/collect":
15002
14965
  put:
15003
14966
  tags:
15004
- - invoice
14967
+ - Invoice
15005
14968
  operationId: collect_invoice
15006
14969
  summary: Collect a pending or past due, automatic invoice
15007
14970
  description: Force a collection attempt using the stored billing information.
@@ -15228,7 +15191,7 @@ paths:
15228
15191
  "/invoices/{invoice_id}/mark_failed":
15229
15192
  put:
15230
15193
  tags:
15231
- - invoice
15194
+ - Invoice
15232
15195
  operationId: mark_invoice_failed
15233
15196
  summary: Mark an open invoice as failed
15234
15197
  description: |
@@ -15451,7 +15414,7 @@ paths:
15451
15414
  "/invoices/{invoice_id}/mark_successful":
15452
15415
  put:
15453
15416
  tags:
15454
- - invoice
15417
+ - Invoice
15455
15418
  operationId: mark_invoice_successful
15456
15419
  summary: Mark an open invoice as successful
15457
15420
  description: |
@@ -15680,7 +15643,7 @@ paths:
15680
15643
  "/invoices/{invoice_id}/reopen":
15681
15644
  put:
15682
15645
  tags:
15683
- - invoice
15646
+ - Invoice
15684
15647
  operationId: reopen_invoice
15685
15648
  summary: Reopen a closed, manual invoice
15686
15649
  parameters:
@@ -15900,7 +15863,7 @@ paths:
15900
15863
  "/invoices/{invoice_id}/void":
15901
15864
  put:
15902
15865
  tags:
15903
- - invoice
15866
+ - Invoice
15904
15867
  operationId: void_invoice
15905
15868
  summary: Void a credit invoice.
15906
15869
  description: Invoice must be a credit invoice (`type=credit`) and cannot be
@@ -16084,7 +16047,7 @@ paths:
16084
16047
  "/invoices/{invoice_id}/transactions":
16085
16048
  post:
16086
16049
  tags:
16087
- - invoice
16050
+ - Invoice
16088
16051
  operationId: record_external_transaction
16089
16052
  summary: Record an external payment for a manual invoices.
16090
16053
  description: This endpoint allows you to record an offline payment that was
@@ -16172,7 +16135,7 @@ paths:
16172
16135
  "/invoices/{invoice_id}/line_items":
16173
16136
  get:
16174
16137
  tags:
16175
- - line_item
16138
+ - Line Item
16176
16139
  operationId: list_invoice_line_items
16177
16140
  summary: List an invoice's line items
16178
16141
  description: See the [Pagination Guide](/developers/guides/pagination.html)
@@ -16357,7 +16320,7 @@ paths:
16357
16320
  "/invoices/{invoice_id}/coupon_redemptions":
16358
16321
  get:
16359
16322
  tags:
16360
- - coupon_redemption
16323
+ - Coupon Redemption
16361
16324
  operationId: list_invoice_coupon_redemptions
16362
16325
  summary: List the coupon redemptions applied to an invoice
16363
16326
  description: See the [Pagination Guide](/developers/guides/pagination.html)
@@ -16520,7 +16483,7 @@ paths:
16520
16483
  "/invoices/{invoice_id}/related_invoices":
16521
16484
  get:
16522
16485
  tags:
16523
- - invoice
16486
+ - Invoice
16524
16487
  operationId: list_related_invoices
16525
16488
  summary: List an invoice's related credit or charge invoices
16526
16489
  description: |
@@ -16680,7 +16643,7 @@ paths:
16680
16643
  "/invoices/{invoice_id}/refund":
16681
16644
  post:
16682
16645
  tags:
16683
- - invoice
16646
+ - Invoice
16684
16647
  operationId: refund_invoice
16685
16648
  summary: Refund an invoice
16686
16649
  description: |
@@ -16976,7 +16939,7 @@ paths:
16976
16939
  "/invoices/recovery":
16977
16940
  post:
16978
16941
  tags:
16979
- - revenue_recovery
16942
+ - Revenue Recovery
16980
16943
  operationId: create_invoice_retry
16981
16944
  summary: Create an invoice for revenue recovery
16982
16945
  requestBody:
@@ -17021,7 +16984,7 @@ paths:
17021
16984
  "/line_items":
17022
16985
  get:
17023
16986
  tags:
17024
- - line_item
16987
+ - Line Item
17025
16988
  operationId: list_line_items
17026
16989
  summary: List a site's line items
17027
16990
  description: See the [Pagination Guide](/developers/guides/pagination.html)
@@ -17202,7 +17165,7 @@ paths:
17202
17165
  "/line_items/{line_item_id}":
17203
17166
  get:
17204
17167
  tags:
17205
- - line_item
17168
+ - Line Item
17206
17169
  operationId: get_line_item
17207
17170
  summary: Fetch a line item
17208
17171
  parameters:
@@ -17414,7 +17377,7 @@ paths:
17414
17377
  name: Go
17415
17378
  delete:
17416
17379
  tags:
17417
- - line_item
17380
+ - Line Item
17418
17381
  operationId: remove_line_item
17419
17382
  summary: Delete an uninvoiced line item
17420
17383
  parameters:
@@ -17629,7 +17592,7 @@ paths:
17629
17592
  "/plans":
17630
17593
  get:
17631
17594
  tags:
17632
- - plan
17595
+ - Plan
17633
17596
  operationId: list_plans
17634
17597
  summary: List a site's plans
17635
17598
  description: See the [Pagination Guide](/developers/guides/pagination.html)
@@ -17803,7 +17766,7 @@ paths:
17803
17766
  name: Go
17804
17767
  post:
17805
17768
  tags:
17806
- - plan
17769
+ - Plan
17807
17770
  operationId: create_plan
17808
17771
  summary: Create a plan
17809
17772
  requestBody:
@@ -18168,7 +18131,7 @@ paths:
18168
18131
  "/plans/{plan_id}":
18169
18132
  get:
18170
18133
  tags:
18171
- - plan
18134
+ - Plan
18172
18135
  operationId: get_plan
18173
18136
  summary: Fetch a plan
18174
18137
  parameters:
@@ -18380,7 +18343,7 @@ paths:
18380
18343
  name: Go
18381
18344
  put:
18382
18345
  tags:
18383
- - plan
18346
+ - Plan
18384
18347
  operationId: update_plan
18385
18348
  summary: Update a plan
18386
18349
  parameters:
@@ -18642,7 +18605,7 @@ paths:
18642
18605
  name: Go
18643
18606
  delete:
18644
18607
  tags:
18645
- - plan
18608
+ - Plan
18646
18609
  operationId: remove_plan
18647
18610
  summary: Remove a plan
18648
18611
  parameters:
@@ -18845,7 +18808,7 @@ paths:
18845
18808
  "/plans/{plan_id}/add_ons":
18846
18809
  get:
18847
18810
  tags:
18848
- - add-on
18811
+ - Add-on
18849
18812
  operationId: list_plan_add_ons
18850
18813
  summary: List a plan's add-ons
18851
18814
  description: See the [Pagination Guide](/developers/guides/pagination.html)
@@ -19018,7 +18981,7 @@ paths:
19018
18981
  name: Go
19019
18982
  post:
19020
18983
  tags:
19021
- - add-on
18984
+ - Add-on
19022
18985
  operationId: create_plan_add_on
19023
18986
  summary: Create an add-on
19024
18987
  parameters:
@@ -19381,7 +19344,7 @@ paths:
19381
19344
  "/plans/{plan_id}/add_ons/{add_on_id}":
19382
19345
  get:
19383
19346
  tags:
19384
- - add-on
19347
+ - Add-on
19385
19348
  operationId: get_plan_add_on
19386
19349
  summary: Fetch a plan's add-on
19387
19350
  parameters:
@@ -19598,7 +19561,7 @@ paths:
19598
19561
  name: Go
19599
19562
  put:
19600
19563
  tags:
19601
- - add-on
19564
+ - Add-on
19602
19565
  operationId: update_plan_add_on
19603
19566
  summary: Update an add-on
19604
19567
  parameters:
@@ -19851,7 +19814,7 @@ paths:
19851
19814
  name: Go
19852
19815
  delete:
19853
19816
  tags:
19854
- - add-on
19817
+ - Add-on
19855
19818
  operationId: remove_plan_add_on
19856
19819
  summary: Remove an add-on
19857
19820
  parameters:
@@ -20050,7 +20013,7 @@ paths:
20050
20013
  "/price_segments":
20051
20014
  get:
20052
20015
  tags:
20053
- - price_segment
20016
+ - Price Segment
20054
20017
  operationId: list_price_segments
20055
20018
  summary: List a site's price segments
20056
20019
  description: See the [Pagination Guide](/developers/guides/pagination.html)
@@ -20088,7 +20051,7 @@ paths:
20088
20051
  "/price_segments/{price_segment_id}":
20089
20052
  get:
20090
20053
  tags:
20091
- - price_segment
20054
+ - Price Segment
20092
20055
  operationId: get_price_segment
20093
20056
  summary: Fetch a price segment
20094
20057
  parameters:
@@ -20116,7 +20079,7 @@ paths:
20116
20079
  "/add_ons":
20117
20080
  get:
20118
20081
  tags:
20119
- - add-on
20082
+ - Add-on
20120
20083
  operationId: list_add_ons
20121
20084
  summary: List a site's add-ons
20122
20085
  description: See the [Pagination Guide](/developers/guides/pagination.html)
@@ -20287,7 +20250,7 @@ paths:
20287
20250
  "/add_ons/{add_on_id}":
20288
20251
  get:
20289
20252
  tags:
20290
- - add-on
20253
+ - Add-on
20291
20254
  operationId: get_add_on
20292
20255
  summary: Fetch an add-on
20293
20256
  parameters:
@@ -20500,7 +20463,7 @@ paths:
20500
20463
  "/shipping_methods":
20501
20464
  get:
20502
20465
  tags:
20503
- - shipping_method
20466
+ - Shipping Method
20504
20467
  operationId: list_shipping_methods
20505
20468
  summary: List a site's shipping methods
20506
20469
  description: See the [Pagination Guide](/developers/guides/pagination.html)
@@ -20669,7 +20632,7 @@ paths:
20669
20632
  name: Go
20670
20633
  post:
20671
20634
  tags:
20672
- - shipping_method
20635
+ - Shipping Method
20673
20636
  operationId: create_shipping_method
20674
20637
  summary: Create a new shipping method
20675
20638
  requestBody:
@@ -20713,7 +20676,7 @@ paths:
20713
20676
  "/shipping_methods/{shipping_method_id}":
20714
20677
  get:
20715
20678
  tags:
20716
- - shipping_method
20679
+ - Shipping Method
20717
20680
  operationId: get_shipping_method
20718
20681
  summary: Fetch a shipping method
20719
20682
  parameters:
@@ -20740,7 +20703,7 @@ paths:
20740
20703
  x-code-samples: []
20741
20704
  put:
20742
20705
  tags:
20743
- - shipping_method
20706
+ - Shipping Method
20744
20707
  operationId: update_shipping_method
20745
20708
  summary: Update an active Shipping Method
20746
20709
  parameters:
@@ -20785,7 +20748,7 @@ paths:
20785
20748
  x-code-samples: []
20786
20749
  delete:
20787
20750
  tags:
20788
- - shipping_method
20751
+ - Shipping Method
20789
20752
  operationId: deactivate_shipping_method
20790
20753
  summary: Deactivate a shipping method
20791
20754
  parameters:
@@ -20815,7 +20778,7 @@ paths:
20815
20778
  "/subscriptions":
20816
20779
  get:
20817
20780
  tags:
20818
- - subscription
20781
+ - Subscription
20819
20782
  operationId: list_subscriptions
20820
20783
  summary: List a site's subscriptions
20821
20784
  description: See the [Pagination Guide](/developers/guides/pagination.html)
@@ -20989,7 +20952,7 @@ paths:
20989
20952
  name: Go
20990
20953
  post:
20991
20954
  tags:
20992
- - subscription
20955
+ - Subscription
20993
20956
  operationId: create_subscription
20994
20957
  summary: Create a new subscription
20995
20958
  requestBody:
@@ -21313,7 +21276,7 @@ paths:
21313
21276
  "/subscriptions/{subscription_id}":
21314
21277
  get:
21315
21278
  tags:
21316
- - subscription
21279
+ - Subscription
21317
21280
  operationId: get_subscription
21318
21281
  summary: Fetch a subscription
21319
21282
  parameters:
@@ -21529,7 +21492,7 @@ paths:
21529
21492
  name: Go
21530
21493
  put:
21531
21494
  tags:
21532
- - subscription
21495
+ - Subscription
21533
21496
  operationId: update_subscription
21534
21497
  summary: Update a subscription
21535
21498
  description: This only lets you change the subscription settings that have no
@@ -21802,7 +21765,7 @@ paths:
21802
21765
  name: Go
21803
21766
  delete:
21804
21767
  tags:
21805
- - subscription
21768
+ - Subscription
21806
21769
  operationId: terminate_subscription
21807
21770
  summary: Terminate a subscription
21808
21771
  description: |
@@ -22069,7 +22032,7 @@ paths:
22069
22032
  "/subscriptions/{subscription_id}/cancel":
22070
22033
  put:
22071
22034
  tags:
22072
- - subscription
22035
+ - Subscription
22073
22036
  operationId: cancel_subscription
22074
22037
  summary: Cancel a subscription
22075
22038
  description: A canceled subscription will continue through its current billing
@@ -22307,7 +22270,7 @@ paths:
22307
22270
  "/subscriptions/{subscription_id}/reactivate":
22308
22271
  put:
22309
22272
  tags:
22310
- - subscription
22273
+ - Subscription
22311
22274
  operationId: reactivate_subscription
22312
22275
  summary: Reactivate a canceled subscription
22313
22276
  description: |
@@ -22537,7 +22500,7 @@ paths:
22537
22500
  "/subscriptions/{subscription_id}/pause":
22538
22501
  put:
22539
22502
  tags:
22540
- - subscription
22503
+ - Subscription
22541
22504
  operationId: pause_subscription
22542
22505
  summary: Pause subscription
22543
22506
  description: |
@@ -22807,7 +22770,7 @@ paths:
22807
22770
  "/subscriptions/{subscription_id}/resume":
22808
22771
  put:
22809
22772
  tags:
22810
- - subscription
22773
+ - Subscription
22811
22774
  operationId: resume_subscription
22812
22775
  summary: Resume subscription
22813
22776
  description: |
@@ -23038,7 +23001,7 @@ paths:
23038
23001
  "/subscriptions/{subscription_id}/convert_trial":
23039
23002
  put:
23040
23003
  tags:
23041
- - subscription
23004
+ - Subscription
23042
23005
  operationId: convert_trial
23043
23006
  summary: Convert trial subscription
23044
23007
  description: This will immediately convert a trial subscription to a fully active
@@ -23078,7 +23041,7 @@ paths:
23078
23041
  "/subscriptions/{subscription_id}/preview_renewal":
23079
23042
  get:
23080
23043
  tags:
23081
- - subscription
23044
+ - Subscription
23082
23045
  operationId: get_preview_renewal
23083
23046
  summary: Fetch a preview of a subscription's renewal invoice(s)
23084
23047
  description: The subscriptions's renewal invoice(s) will be returned if they
@@ -23304,7 +23267,7 @@ paths:
23304
23267
  "/subscriptions/{subscription_id}/change":
23305
23268
  get:
23306
23269
  tags:
23307
- - subscription_change
23270
+ - Subscription Change
23308
23271
  operationId: get_subscription_change
23309
23272
  summary: Fetch a subscription's pending change
23310
23273
  parameters:
@@ -23533,7 +23496,7 @@ paths:
23533
23496
  name: Go
23534
23497
  post:
23535
23498
  tags:
23536
- - subscription_change
23499
+ - Subscription Change
23537
23500
  operationId: create_subscription_change
23538
23501
  summary: Create a new subscription change
23539
23502
  description: |
@@ -23828,7 +23791,7 @@ paths:
23828
23791
  name: Go
23829
23792
  delete:
23830
23793
  tags:
23831
- - subscription_change
23794
+ - Subscription Change
23832
23795
  operationId: remove_subscription_change
23833
23796
  summary: Delete the pending subscription change
23834
23797
  parameters:
@@ -24039,7 +24002,7 @@ paths:
24039
24002
  "/subscriptions/{subscription_id}/change/preview":
24040
24003
  post:
24041
24004
  tags:
24042
- - subscription_change
24005
+ - Subscription Change
24043
24006
  operationId: preview_subscription_change
24044
24007
  summary: Preview a new subscription change
24045
24008
  description: Calling this will not save the subscription change or overwrite
@@ -24082,7 +24045,7 @@ paths:
24082
24045
  "/subscriptions/{subscription_id}/invoices":
24083
24046
  get:
24084
24047
  tags:
24085
- - invoice
24048
+ - Invoice
24086
24049
  operationId: list_subscription_invoices
24087
24050
  summary: List a subscription's invoices
24088
24051
  description: See the [Pagination Guide](/developers/guides/pagination.html)
@@ -24258,7 +24221,7 @@ paths:
24258
24221
  "/subscriptions/{subscription_id}/line_items":
24259
24222
  get:
24260
24223
  tags:
24261
- - line_item
24224
+ - Line Item
24262
24225
  operationId: list_subscription_line_items
24263
24226
  summary: List a subscription's line items
24264
24227
  description: See the [Pagination Guide](/developers/guides/pagination.html)
@@ -24436,7 +24399,7 @@ paths:
24436
24399
  "/subscriptions/{subscription_id}/coupon_redemptions":
24437
24400
  get:
24438
24401
  tags:
24439
- - coupon_redemption
24402
+ - Coupon Redemption
24440
24403
  operationId: list_subscription_coupon_redemptions
24441
24404
  summary: List the coupon redemptions for a subscription
24442
24405
  description: See the [Pagination Guide](/developers/guides/pagination.html)
@@ -24603,7 +24566,7 @@ paths:
24603
24566
  "/subscriptions/{subscription_id}/coupon_redemptions/{coupon_redemption_id}":
24604
24567
  get:
24605
24568
  tags:
24606
- - coupon_redemption
24569
+ - Coupon Redemption
24607
24570
  operationId: get_subscription_coupon_redemption
24608
24571
  summary: Show the coupon redemption for a subscription
24609
24572
  parameters:
@@ -24631,7 +24594,7 @@ paths:
24631
24594
  x-code-samples: []
24632
24595
  delete:
24633
24596
  tags:
24634
- - coupon_redemption
24597
+ - Coupon Redemption
24635
24598
  operationId: remove_subscription_coupon_redemption
24636
24599
  summary: Delete the coupon redemption from a subscription
24637
24600
  description: Deactivate the coupon redemption on a subscription.
@@ -24667,7 +24630,7 @@ paths:
24667
24630
  "/subscriptions/{subscription_id}/add_ons/{add_on_id}/usage":
24668
24631
  get:
24669
24632
  tags:
24670
- - usage
24633
+ - Usage
24671
24634
  operationId: list_usage
24672
24635
  summary: List a subscription add-on's usage records
24673
24636
  parameters:
@@ -24708,7 +24671,7 @@ paths:
24708
24671
  x-code-samples: []
24709
24672
  post:
24710
24673
  tags:
24711
- - usage
24674
+ - Usage
24712
24675
  operationId: create_usage
24713
24676
  summary: Log a usage record on this subscription add-on
24714
24677
  parameters:
@@ -24755,7 +24718,7 @@ paths:
24755
24718
  "/usage/{usage_id}":
24756
24719
  get:
24757
24720
  tags:
24758
- - usage
24721
+ - Usage
24759
24722
  operationId: get_usage
24760
24723
  summary: Get a usage record
24761
24724
  parameters:
@@ -24788,7 +24751,7 @@ paths:
24788
24751
  x-code-samples: []
24789
24752
  put:
24790
24753
  tags:
24791
- - usage
24754
+ - Usage
24792
24755
  operationId: update_usage
24793
24756
  summary: Update a usage record
24794
24757
  parameters:
@@ -24833,7 +24796,7 @@ paths:
24833
24796
  x-code-samples: []
24834
24797
  delete:
24835
24798
  tags:
24836
- - usage
24799
+ - Usage
24837
24800
  operationId: remove_usage
24838
24801
  summary: Delete a usage record.
24839
24802
  parameters:
@@ -24869,7 +24832,7 @@ paths:
24869
24832
  "/transactions":
24870
24833
  get:
24871
24834
  tags:
24872
- - transaction
24835
+ - Transaction
24873
24836
  operationId: list_transactions
24874
24837
  summary: List a site's transactions
24875
24838
  description: See the [Pagination Guide](/developers/guides/pagination.html)
@@ -25045,7 +25008,7 @@ paths:
25045
25008
  "/transactions/{transaction_id}":
25046
25009
  get:
25047
25010
  tags:
25048
- - transaction
25011
+ - Transaction
25049
25012
  operationId: get_transaction
25050
25013
  summary: Fetch a transaction
25051
25014
  parameters:
@@ -25260,7 +25223,7 @@ paths:
25260
25223
  - "$ref": "#/components/parameters/unique_coupon_code_id"
25261
25224
  get:
25262
25225
  tags:
25263
- - unique_coupon_code
25226
+ - Unique Coupon Code
25264
25227
  operationId: get_unique_coupon_code
25265
25228
  summary: Fetch a unique coupon code
25266
25229
  responses:
@@ -25285,7 +25248,7 @@ paths:
25285
25248
  x-code-samples: []
25286
25249
  delete:
25287
25250
  tags:
25288
- - unique_coupon_code
25251
+ - Unique Coupon Code
25289
25252
  operationId: deactivate_unique_coupon_code
25290
25253
  summary: Deactivate a unique coupon code
25291
25254
  description: Expire a unique code, making that specific code no longer redeemable.
@@ -25321,7 +25284,7 @@ paths:
25321
25284
  - "$ref": "#/components/parameters/unique_coupon_code_id"
25322
25285
  put:
25323
25286
  tags:
25324
- - unique_coupon_code
25287
+ - Unique Coupon Code
25325
25288
  operationId: reactivate_unique_coupon_code
25326
25289
  summary: Restore a unique coupon code
25327
25290
  responses:
@@ -25353,7 +25316,7 @@ paths:
25353
25316
  "/purchases":
25354
25317
  post:
25355
25318
  tags:
25356
- - purchase
25319
+ - Purchase
25357
25320
  operationId: create_purchase
25358
25321
  summary: Create a new purchase
25359
25322
  description: A purchase is a checkout containing at least one or more subscriptions
@@ -25799,7 +25762,7 @@ paths:
25799
25762
  "/purchases/preview":
25800
25763
  post:
25801
25764
  tags:
25802
- - purchase
25765
+ - Purchase
25803
25766
  operationId: preview_purchase
25804
25767
  summary: Preview a new purchase
25805
25768
  description: A purchase is a checkout containing at least one or more subscriptions
@@ -26235,7 +26198,7 @@ paths:
26235
26198
  "/purchases/pending":
26236
26199
  post:
26237
26200
  tags:
26238
- - purchase
26201
+ - Purchase
26239
26202
  operationId: create_pending_purchase
26240
26203
  summary: Create a pending purchase
26241
26204
  description: |-
@@ -26740,7 +26703,7 @@ paths:
26740
26703
  "/purchases/authorize":
26741
26704
  post:
26742
26705
  tags:
26743
- - purchase
26706
+ - Purchase
26744
26707
  operationId: create_authorize_purchase
26745
26708
  summary: Authorize a purchase
26746
26709
  description: |-
@@ -26784,7 +26747,7 @@ paths:
26784
26747
  "/purchases/{transaction_id}/capture":
26785
26748
  post:
26786
26749
  tags:
26787
- - purchase
26750
+ - Purchase
26788
26751
  parameters:
26789
26752
  - "$ref": "#/components/parameters/transaction_id"
26790
26753
  operationId: create_capture_purchase
@@ -26835,7 +26798,7 @@ paths:
26835
26798
 
26836
26799
  Cancel an open Authorization request
26837
26800
  tags:
26838
- - purchase
26801
+ - Purchase
26839
26802
  operationId: cancelPurchase
26840
26803
  responses:
26841
26804
  '200':
@@ -26866,7 +26829,7 @@ paths:
26866
26829
  "/export_dates":
26867
26830
  get:
26868
26831
  tags:
26869
- - automated_exports
26832
+ - Automated Exports
26870
26833
  operationId: get_export_dates
26871
26834
  summary: List the dates that have an available export to download.
26872
26835
  description: Returns a list of dates for which export files are available for
@@ -27063,7 +27026,7 @@ paths:
27063
27026
  - "$ref": "#/components/parameters/export_date"
27064
27027
  get:
27065
27028
  tags:
27066
- - automated_exports
27029
+ - Automated Exports
27067
27030
  operationId: get_export_files
27068
27031
  summary: List of the export files that are available to download.
27069
27032
  description: Returns a list of presigned URLs to download export files for the
@@ -27258,7 +27221,7 @@ paths:
27258
27221
  "/dunning_campaigns":
27259
27222
  get:
27260
27223
  tags:
27261
- - dunning_campaigns
27224
+ - Dunning Campaigns
27262
27225
  operationId: list_dunning_campaigns
27263
27226
  summary: List the dunning campaigns for a site
27264
27227
  description: See the [Pagination Guide](/developers/guides/pagination.html)
@@ -27285,12 +27248,68 @@ paths:
27285
27248
  schema:
27286
27249
  "$ref": "#/components/schemas/Error"
27287
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: []
27288
27307
  "/dunning_campaigns/{dunning_campaign_id}":
27289
27308
  parameters:
27290
27309
  - "$ref": "#/components/parameters/dunning_campaign_id"
27291
27310
  get:
27292
27311
  tags:
27293
- - dunning_campaigns
27312
+ - Dunning Campaigns
27294
27313
  operationId: get_dunning_campaign
27295
27314
  summary: Fetch a dunning campaign
27296
27315
  responses:
@@ -27319,12 +27338,141 @@ paths:
27319
27338
  schema:
27320
27339
  "$ref": "#/components/schemas/Error"
27321
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: []
27322
27470
  "/dunning_campaigns/{dunning_campaign_id}/bulk_update":
27323
27471
  parameters:
27324
27472
  - "$ref": "#/components/parameters/dunning_campaign_id"
27325
27473
  put:
27326
27474
  tags:
27327
- - dunning_campaigns
27475
+ - Dunning Campaigns
27328
27476
  operationId: put_dunning_campaign_bulk_update
27329
27477
  summary: Assign a dunning campaign to multiple plans
27330
27478
  requestBody:
@@ -27361,7 +27509,7 @@ paths:
27361
27509
  "/invoice_templates":
27362
27510
  get:
27363
27511
  tags:
27364
- - invoice_templates
27512
+ - Invoice Templates
27365
27513
  operationId: list_invoice_templates
27366
27514
  summary: Show the invoice templates for a site
27367
27515
  description: See the [Pagination Guide](/developers/guides/pagination.html)
@@ -27393,7 +27541,7 @@ paths:
27393
27541
  - "$ref": "#/components/parameters/invoice_template_id"
27394
27542
  get:
27395
27543
  tags:
27396
- - invoice_templates
27544
+ - Invoice Templates
27397
27545
  operationId: get_invoice_template
27398
27546
  summary: Fetch an invoice template
27399
27547
  responses:
@@ -27425,7 +27573,7 @@ paths:
27425
27573
  "/external_invoices":
27426
27574
  get:
27427
27575
  tags:
27428
- - external_invoices
27576
+ - External Invoice
27429
27577
  operationId: list_external_invoices
27430
27578
  summary: List the external invoices on a site
27431
27579
  description: See the [Pagination Guide](/developers/guides/pagination.html)
@@ -27459,7 +27607,7 @@ paths:
27459
27607
  - "$ref": "#/components/parameters/external_invoice_id"
27460
27608
  get:
27461
27609
  tags:
27462
- - external_invoices
27610
+ - External Invoice
27463
27611
  operationId: show_external_invoice
27464
27612
  summary: Fetch an external invoice
27465
27613
  responses:
@@ -27493,7 +27641,7 @@ paths:
27493
27641
  - "$ref": "#/components/parameters/external_subscription_id"
27494
27642
  get:
27495
27643
  tags:
27496
- - external_subscriptions
27644
+ - External Subscription
27497
27645
  operationId: list_external_subscription_external_payment_phases
27498
27646
  summary: List the external payment phases on an external subscription
27499
27647
  description: See the [Pagination Guide](/developers/guides/pagination.html)
@@ -27528,7 +27676,7 @@ paths:
27528
27676
  - "$ref": "#/components/parameters/external_payment_phase_id"
27529
27677
  get:
27530
27678
  tags:
27531
- - external_payment_phases
27679
+ - External Payment Phase
27532
27680
  operationId: get_external_subscription_external_payment_phase
27533
27681
  summary: Fetch an external payment phase
27534
27682
  responses:
@@ -27557,7 +27705,7 @@ paths:
27557
27705
  - "$ref": "#/components/parameters/filter_limited_subscription_state"
27558
27706
  get:
27559
27707
  tags:
27560
- - account
27708
+ - Account
27561
27709
  operationId: list_entitlements
27562
27710
  summary: List entitlements granted to an account
27563
27711
  responses:
@@ -27585,7 +27733,7 @@ paths:
27585
27733
  - "$ref": "#/components/parameters/account_id"
27586
27734
  get:
27587
27735
  tags:
27588
- - account
27736
+ - Account
27589
27737
  operationId: list_account_external_subscriptions
27590
27738
  summary: List an account's external subscriptions
27591
27739
  description: See the [Pagination Guide](/developers/guides/pagination.html)
@@ -27617,7 +27765,7 @@ paths:
27617
27765
  - "$ref": "#/components/parameters/business_entity_id"
27618
27766
  get:
27619
27767
  tags:
27620
- - business_entities
27768
+ - Business Entities
27621
27769
  operationId: get_business_entity
27622
27770
  summary: Fetch a business entity
27623
27771
  responses:
@@ -27643,7 +27791,7 @@ paths:
27643
27791
  "/business_entities":
27644
27792
  get:
27645
27793
  tags:
27646
- - business_entities
27794
+ - Business Entities
27647
27795
  operationId: list_business_entities
27648
27796
  summary: List business entities
27649
27797
  responses:
@@ -27669,7 +27817,7 @@ paths:
27669
27817
  "/gift_cards":
27670
27818
  get:
27671
27819
  tags:
27672
- - gift_cards
27820
+ - Gift Cards
27673
27821
  operationId: list_gift_cards
27674
27822
  summary: List gift cards
27675
27823
  responses:
@@ -27694,7 +27842,7 @@ paths:
27694
27842
  x-code-samples: []
27695
27843
  post:
27696
27844
  tags:
27697
- - gift_cards
27845
+ - Gift Cards
27698
27846
  operationId: create_gift_card
27699
27847
  summary: Create gift card
27700
27848
  requestBody:
@@ -27734,7 +27882,7 @@ paths:
27734
27882
  - "$ref": "#/components/parameters/gift_card_id"
27735
27883
  get:
27736
27884
  tags:
27737
- - gift_cards
27885
+ - Gift Cards
27738
27886
  operationId: get_gift_card
27739
27887
  summary: Fetch a gift card
27740
27888
  responses:
@@ -27760,7 +27908,7 @@ paths:
27760
27908
  "/gift_cards/preview":
27761
27909
  post:
27762
27910
  tags:
27763
- - gift_cards
27911
+ - Gift Cards
27764
27912
  operationId: preview_gift_card
27765
27913
  summary: Preview gift card
27766
27914
  requestBody:
@@ -27800,7 +27948,7 @@ paths:
27800
27948
  - "$ref": "#/components/parameters/redemption_code"
27801
27949
  post:
27802
27950
  tags:
27803
- - gift_cards
27951
+ - Gift Cards
27804
27952
  operationId: redeem_gift_card
27805
27953
  summary: Redeem gift card
27806
27954
  requestBody:
@@ -27838,7 +27986,7 @@ paths:
27838
27986
  "/business_entities/{business_entity_id}/invoices":
27839
27987
  get:
27840
27988
  tags:
27841
- - invoice
27989
+ - Invoice
27842
27990
  operationId: list_business_entity_invoices
27843
27991
  summary: List a business entity's invoices
27844
27992
  description: See the [Pagination Guide](/developers/guides/pagination.html)
@@ -36743,6 +36891,155 @@ components:
36743
36891
  email_template:
36744
36892
  type: string
36745
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"
36746
37043
  DunningCampaignsBulkUpdate:
36747
37044
  properties:
36748
37045
  plan_codes: