recurly 4.85.0 → 4.86.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/.github/workflows/ci.yml +2 -2
- data/.github/workflows/docs.yml +1 -1
- data/CHANGELOG.md +366 -0
- data/GETTING_STARTED.md +1 -1
- data/lib/data/ca-certificates.crt +0 -40
- data/lib/recurly/requests/billing_info_create.rb +8 -0
- data/lib/recurly/requests/payment_gateway_references.rb +1 -1
- data/lib/recurly/resources/payment_gateway_references.rb +1 -1
- data/lib/recurly/resources/subscription_change.rb +4 -0
- data/lib/recurly/version.rb +1 -1
- data/openapi/api.yaml +317 -2
- metadata +3 -3
data/openapi/api.yaml
CHANGED
|
@@ -448,6 +448,7 @@ paths:
|
|
|
448
448
|
tags:
|
|
449
449
|
- Site
|
|
450
450
|
parameters:
|
|
451
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
451
452
|
- "$ref": "#/components/parameters/ids"
|
|
452
453
|
- "$ref": "#/components/parameters/limit"
|
|
453
454
|
- "$ref": "#/components/parameters/order"
|
|
@@ -613,6 +614,7 @@ paths:
|
|
|
613
614
|
tags:
|
|
614
615
|
- Site
|
|
615
616
|
parameters:
|
|
617
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
616
618
|
- "$ref": "#/components/parameters/site_id"
|
|
617
619
|
responses:
|
|
618
620
|
'200':
|
|
@@ -824,10 +826,13 @@ paths:
|
|
|
824
826
|
tags:
|
|
825
827
|
- Account
|
|
826
828
|
operationId: list_accounts
|
|
829
|
+
x-product:
|
|
830
|
+
- recover
|
|
827
831
|
summary: List a site's accounts
|
|
828
832
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
829
833
|
to learn how to use pagination in the API and Client Libraries.
|
|
830
834
|
parameters:
|
|
835
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
831
836
|
- "$ref": "#/components/parameters/ids"
|
|
832
837
|
- "$ref": "#/components/parameters/limit"
|
|
833
838
|
- "$ref": "#/components/parameters/order"
|
|
@@ -1001,6 +1006,8 @@ paths:
|
|
|
1001
1006
|
- Account
|
|
1002
1007
|
operationId: create_account
|
|
1003
1008
|
summary: Create an account
|
|
1009
|
+
parameters:
|
|
1010
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
1004
1011
|
requestBody:
|
|
1005
1012
|
content:
|
|
1006
1013
|
application/json:
|
|
@@ -1480,7 +1487,11 @@ paths:
|
|
|
1480
1487
|
tags:
|
|
1481
1488
|
- Account
|
|
1482
1489
|
operationId: get_account
|
|
1490
|
+
x-product:
|
|
1491
|
+
- recover
|
|
1483
1492
|
summary: Fetch an account
|
|
1493
|
+
parameters:
|
|
1494
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
1484
1495
|
responses:
|
|
1485
1496
|
'200':
|
|
1486
1497
|
description: An account.
|
|
@@ -1685,6 +1696,8 @@ paths:
|
|
|
1685
1696
|
- Account
|
|
1686
1697
|
operationId: update_account
|
|
1687
1698
|
summary: Update an account
|
|
1699
|
+
parameters:
|
|
1700
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
1688
1701
|
requestBody:
|
|
1689
1702
|
content:
|
|
1690
1703
|
application/json:
|
|
@@ -1979,6 +1992,7 @@ paths:
|
|
|
1979
1992
|
until the end of the current billing cycle before expiring). We recommend
|
|
1980
1993
|
closing accounts only when all business is concluded with a customer.
|
|
1981
1994
|
parameters:
|
|
1995
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
1982
1996
|
- in: query
|
|
1983
1997
|
name: redact
|
|
1984
1998
|
schema:
|
|
@@ -2197,6 +2211,8 @@ paths:
|
|
|
2197
2211
|
tags:
|
|
2198
2212
|
- Account
|
|
2199
2213
|
operationId: redact_account
|
|
2214
|
+
x-product:
|
|
2215
|
+
- recover
|
|
2200
2216
|
summary: Redact an account (GDPR Right to Erasure)
|
|
2201
2217
|
description: Permanently and irreversibly removes all personally identifiable
|
|
2202
2218
|
information (PII) from an account to fulfill a data subject's right to erasure
|
|
@@ -2207,6 +2223,8 @@ paths:
|
|
|
2207
2223
|
are cleared. The account must have no active subscriptions, uninvoiced charges,
|
|
2208
2224
|
or partially paid invoices before it can be redacted. Redaction is processed
|
|
2209
2225
|
asynchronously and cannot be undone.
|
|
2226
|
+
parameters:
|
|
2227
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
2210
2228
|
responses:
|
|
2211
2229
|
'200':
|
|
2212
2230
|
description: Account has been accepted for redaction and will be processed
|
|
@@ -2237,6 +2255,8 @@ paths:
|
|
|
2237
2255
|
- Account Acquisition Info
|
|
2238
2256
|
operationId: get_account_acquisition
|
|
2239
2257
|
summary: Fetch an account's acquisition data
|
|
2258
|
+
parameters:
|
|
2259
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
2240
2260
|
responses:
|
|
2241
2261
|
'200':
|
|
2242
2262
|
description: An account's acquisition data.
|
|
@@ -2442,6 +2462,8 @@ paths:
|
|
|
2442
2462
|
- Account Acquisition Info
|
|
2443
2463
|
operationId: update_account_acquisition
|
|
2444
2464
|
summary: Update an account's acquisition data
|
|
2465
|
+
parameters:
|
|
2466
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
2445
2467
|
requestBody:
|
|
2446
2468
|
content:
|
|
2447
2469
|
application/json:
|
|
@@ -2748,6 +2770,8 @@ paths:
|
|
|
2748
2770
|
- Account Acquisition Info
|
|
2749
2771
|
operationId: remove_account_acquisition
|
|
2750
2772
|
summary: Remove an account's acquisition data
|
|
2773
|
+
parameters:
|
|
2774
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
2751
2775
|
responses:
|
|
2752
2776
|
'204':
|
|
2753
2777
|
description: Acquisition data was succesfully deleted.
|
|
@@ -2949,6 +2973,8 @@ paths:
|
|
|
2949
2973
|
summary: Reactivate an inactive account
|
|
2950
2974
|
description: Reactivating an account will restore its history but the customer
|
|
2951
2975
|
will need to provide new billing information to continue billing.
|
|
2976
|
+
parameters:
|
|
2977
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
2952
2978
|
responses:
|
|
2953
2979
|
'200':
|
|
2954
2980
|
description: An account.
|
|
@@ -3166,6 +3192,8 @@ paths:
|
|
|
3166
3192
|
- Account
|
|
3167
3193
|
operationId: get_account_balance
|
|
3168
3194
|
summary: Fetch an account's balance and past due status
|
|
3195
|
+
parameters:
|
|
3196
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
3169
3197
|
responses:
|
|
3170
3198
|
'200':
|
|
3171
3199
|
description: An account's balance.
|
|
@@ -3378,6 +3406,7 @@ paths:
|
|
|
3378
3406
|
operationId: get_billing_info
|
|
3379
3407
|
summary: Fetch an account's billing information
|
|
3380
3408
|
parameters:
|
|
3409
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
3381
3410
|
- "$ref": "#/components/parameters/account_id"
|
|
3382
3411
|
responses:
|
|
3383
3412
|
'200':
|
|
@@ -3610,6 +3639,7 @@ paths:
|
|
|
3610
3639
|
- gateway_token
|
|
3611
3640
|
- gateway_code
|
|
3612
3641
|
parameters:
|
|
3642
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
3613
3643
|
- "$ref": "#/components/parameters/account_id"
|
|
3614
3644
|
requestBody:
|
|
3615
3645
|
content:
|
|
@@ -3887,6 +3917,7 @@ paths:
|
|
|
3887
3917
|
operationId: remove_billing_info
|
|
3888
3918
|
summary: Remove an account's billing information
|
|
3889
3919
|
parameters:
|
|
3920
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
3890
3921
|
- "$ref": "#/components/parameters/account_id"
|
|
3891
3922
|
description: You may remove any stored billing information for an account. If
|
|
3892
3923
|
the account has a subscription, the renewal will go into dunning unless the
|
|
@@ -4090,6 +4121,7 @@ paths:
|
|
|
4090
4121
|
operationId: verify_billing_info
|
|
4091
4122
|
summary: Verify an account's credit card billing information
|
|
4092
4123
|
parameters:
|
|
4124
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
4093
4125
|
- "$ref": "#/components/parameters/account_id"
|
|
4094
4126
|
requestBody:
|
|
4095
4127
|
content:
|
|
@@ -4319,6 +4351,7 @@ paths:
|
|
|
4319
4351
|
operationId: verify_billing_info_cvv
|
|
4320
4352
|
summary: Verify an account's credit card billing cvv
|
|
4321
4353
|
parameters:
|
|
4354
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
4322
4355
|
- "$ref": "#/components/parameters/account_id"
|
|
4323
4356
|
requestBody:
|
|
4324
4357
|
content:
|
|
@@ -4362,6 +4395,7 @@ paths:
|
|
|
4362
4395
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
4363
4396
|
to learn how to use pagination in the API and Client Libraries.
|
|
4364
4397
|
parameters:
|
|
4398
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
4365
4399
|
- "$ref": "#/components/parameters/account_id"
|
|
4366
4400
|
- "$ref": "#/components/parameters/ids"
|
|
4367
4401
|
- "$ref": "#/components/parameters/sort_dates"
|
|
@@ -4412,6 +4446,7 @@ paths:
|
|
|
4412
4446
|
- gateway_token
|
|
4413
4447
|
- gateway_code
|
|
4414
4448
|
parameters:
|
|
4449
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
4415
4450
|
- "$ref": "#/components/parameters/account_id"
|
|
4416
4451
|
requestBody:
|
|
4417
4452
|
content:
|
|
@@ -4453,6 +4488,7 @@ paths:
|
|
|
4453
4488
|
operationId: get_a_billing_info
|
|
4454
4489
|
summary: Fetch a billing info
|
|
4455
4490
|
parameters:
|
|
4491
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
4456
4492
|
- "$ref": "#/components/parameters/account_id"
|
|
4457
4493
|
- "$ref": "#/components/parameters/billing_info_id"
|
|
4458
4494
|
responses:
|
|
@@ -4494,6 +4530,7 @@ paths:
|
|
|
4494
4530
|
- gateway_token
|
|
4495
4531
|
- gateway_code
|
|
4496
4532
|
parameters:
|
|
4533
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
4497
4534
|
- "$ref": "#/components/parameters/account_id"
|
|
4498
4535
|
- "$ref": "#/components/parameters/billing_info_id"
|
|
4499
4536
|
requestBody:
|
|
@@ -4535,6 +4572,7 @@ paths:
|
|
|
4535
4572
|
operationId: remove_a_billing_info
|
|
4536
4573
|
summary: Remove an account's billing information
|
|
4537
4574
|
parameters:
|
|
4575
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
4538
4576
|
- "$ref": "#/components/parameters/account_id"
|
|
4539
4577
|
- "$ref": "#/components/parameters/billing_info_id"
|
|
4540
4578
|
description: You may remove any stored billing information for an account. If
|
|
@@ -4565,6 +4603,7 @@ paths:
|
|
|
4565
4603
|
operationId: verify_billing_infos
|
|
4566
4604
|
summary: Verify a billing information's credit card
|
|
4567
4605
|
parameters:
|
|
4606
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
4568
4607
|
- "$ref": "#/components/parameters/account_id"
|
|
4569
4608
|
- "$ref": "#/components/parameters/billing_info_id"
|
|
4570
4609
|
requestBody:
|
|
@@ -4608,6 +4647,7 @@ paths:
|
|
|
4608
4647
|
operationId: verify_billing_infos_cvv
|
|
4609
4648
|
summary: Verify a billing information's credit card cvv
|
|
4610
4649
|
parameters:
|
|
4650
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
4611
4651
|
- "$ref": "#/components/parameters/account_id"
|
|
4612
4652
|
- "$ref": "#/components/parameters/billing_info_id"
|
|
4613
4653
|
requestBody:
|
|
@@ -4658,6 +4698,7 @@ paths:
|
|
|
4658
4698
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
4659
4699
|
to learn how to use pagination in the API and Client Libraries.
|
|
4660
4700
|
parameters:
|
|
4701
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
4661
4702
|
- "$ref": "#/components/parameters/account_id"
|
|
4662
4703
|
- "$ref": "#/components/parameters/ids"
|
|
4663
4704
|
- "$ref": "#/components/parameters/sort_dates"
|
|
@@ -4824,6 +4865,7 @@ paths:
|
|
|
4824
4865
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
4825
4866
|
to learn how to use pagination in the API and Client Libraries.
|
|
4826
4867
|
parameters:
|
|
4868
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
4827
4869
|
- "$ref": "#/components/parameters/account_id"
|
|
4828
4870
|
responses:
|
|
4829
4871
|
'200':
|
|
@@ -4968,6 +5010,7 @@ paths:
|
|
|
4968
5010
|
operationId: create_coupon_redemption
|
|
4969
5011
|
summary: Generate an active coupon redemption on an account or subscription
|
|
4970
5012
|
parameters:
|
|
5013
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
4971
5014
|
- "$ref": "#/components/parameters/account_id"
|
|
4972
5015
|
requestBody:
|
|
4973
5016
|
content:
|
|
@@ -5198,6 +5241,7 @@ paths:
|
|
|
5198
5241
|
operationId: remove_coupon_redemption
|
|
5199
5242
|
summary: Delete the active coupon redemption from an account
|
|
5200
5243
|
parameters:
|
|
5244
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
5201
5245
|
- "$ref": "#/components/parameters/account_id"
|
|
5202
5246
|
responses:
|
|
5203
5247
|
'200':
|
|
@@ -5407,6 +5451,7 @@ paths:
|
|
|
5407
5451
|
operationId: get_coupon_redemption
|
|
5408
5452
|
summary: Show the coupon redemption
|
|
5409
5453
|
parameters:
|
|
5454
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
5410
5455
|
- "$ref": "#/components/parameters/account_id"
|
|
5411
5456
|
- "$ref": "#/components/parameters/coupon_redemption_id"
|
|
5412
5457
|
responses:
|
|
@@ -5436,6 +5481,7 @@ paths:
|
|
|
5436
5481
|
summary: Delete the coupon redemption
|
|
5437
5482
|
description: Deactivate the coupon redemption on an account.
|
|
5438
5483
|
parameters:
|
|
5484
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
5439
5485
|
- "$ref": "#/components/parameters/account_id"
|
|
5440
5486
|
- "$ref": "#/components/parameters/coupon_redemption_id"
|
|
5441
5487
|
responses:
|
|
@@ -5473,6 +5519,7 @@ paths:
|
|
|
5473
5519
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
5474
5520
|
to learn how to use pagination in the API and Client Libraries.
|
|
5475
5521
|
parameters:
|
|
5522
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
5476
5523
|
- "$ref": "#/components/parameters/account_id"
|
|
5477
5524
|
- "$ref": "#/components/parameters/limit"
|
|
5478
5525
|
- "$ref": "#/components/parameters/order"
|
|
@@ -5654,6 +5701,8 @@ paths:
|
|
|
5654
5701
|
- External Account
|
|
5655
5702
|
operationId: list_account_external_account
|
|
5656
5703
|
summary: List external accounts for an account
|
|
5704
|
+
parameters:
|
|
5705
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
5657
5706
|
responses:
|
|
5658
5707
|
'200':
|
|
5659
5708
|
description: A list of external accounts on an account.
|
|
@@ -5691,6 +5740,8 @@ paths:
|
|
|
5691
5740
|
- External Account
|
|
5692
5741
|
operationId: create_account_external_account
|
|
5693
5742
|
summary: Create an external account
|
|
5743
|
+
parameters:
|
|
5744
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
5694
5745
|
requestBody:
|
|
5695
5746
|
content:
|
|
5696
5747
|
application/json:
|
|
@@ -5737,6 +5788,8 @@ paths:
|
|
|
5737
5788
|
- External Account
|
|
5738
5789
|
operationId: get_account_external_account
|
|
5739
5790
|
summary: Get an external account for an account
|
|
5791
|
+
parameters:
|
|
5792
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
5740
5793
|
responses:
|
|
5741
5794
|
'200':
|
|
5742
5795
|
description: A external account on an account.
|
|
@@ -5774,6 +5827,8 @@ paths:
|
|
|
5774
5827
|
- External Account
|
|
5775
5828
|
operationId: update_account_external_account
|
|
5776
5829
|
summary: Update an external account
|
|
5830
|
+
parameters:
|
|
5831
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
5777
5832
|
requestBody:
|
|
5778
5833
|
content:
|
|
5779
5834
|
application/json:
|
|
@@ -5816,6 +5871,8 @@ paths:
|
|
|
5816
5871
|
- External Account
|
|
5817
5872
|
operationId: delete_account_external_account
|
|
5818
5873
|
summary: Delete an external account for an account
|
|
5874
|
+
parameters:
|
|
5875
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
5819
5876
|
responses:
|
|
5820
5877
|
'200':
|
|
5821
5878
|
description: Successful Delete
|
|
@@ -5859,6 +5916,7 @@ paths:
|
|
|
5859
5916
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
5860
5917
|
to learn how to use pagination in the API and Client Libraries.
|
|
5861
5918
|
parameters:
|
|
5919
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
5862
5920
|
- "$ref": "#/components/parameters/sort_dates"
|
|
5863
5921
|
- "$ref": "#/components/parameters/limit"
|
|
5864
5922
|
- "$ref": "#/components/parameters/order"
|
|
@@ -5887,10 +5945,13 @@ paths:
|
|
|
5887
5945
|
tags:
|
|
5888
5946
|
- Invoice
|
|
5889
5947
|
operationId: list_account_invoices
|
|
5948
|
+
x-product:
|
|
5949
|
+
- recover
|
|
5890
5950
|
summary: List an account's invoices
|
|
5891
5951
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
5892
5952
|
to learn how to use pagination in the API and Client Libraries.
|
|
5893
5953
|
parameters:
|
|
5954
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
5894
5955
|
- "$ref": "#/components/parameters/account_id"
|
|
5895
5956
|
- "$ref": "#/components/parameters/ids"
|
|
5896
5957
|
- "$ref": "#/components/parameters/invoice_state"
|
|
@@ -6063,6 +6124,7 @@ paths:
|
|
|
6063
6124
|
operationId: create_invoice
|
|
6064
6125
|
summary: Create an invoice for pending line items
|
|
6065
6126
|
parameters:
|
|
6127
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
6066
6128
|
- "$ref": "#/components/parameters/account_id"
|
|
6067
6129
|
requestBody:
|
|
6068
6130
|
content:
|
|
@@ -6365,6 +6427,7 @@ paths:
|
|
|
6365
6427
|
operationId: preview_invoice
|
|
6366
6428
|
summary: Preview new invoice for pending line items
|
|
6367
6429
|
parameters:
|
|
6430
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
6368
6431
|
- "$ref": "#/components/parameters/account_id"
|
|
6369
6432
|
requestBody:
|
|
6370
6433
|
content:
|
|
@@ -6668,6 +6731,7 @@ paths:
|
|
|
6668
6731
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
6669
6732
|
to learn how to use pagination in the API and Client Libraries.
|
|
6670
6733
|
parameters:
|
|
6734
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
6671
6735
|
- "$ref": "#/components/parameters/account_id"
|
|
6672
6736
|
- "$ref": "#/components/parameters/ids"
|
|
6673
6737
|
- "$ref": "#/components/parameters/limit"
|
|
@@ -6845,6 +6909,7 @@ paths:
|
|
|
6845
6909
|
description: When using the Credit Invoices feature, utilize the purchases endpoint
|
|
6846
6910
|
in order to immediately post credit to a credit invoice.
|
|
6847
6911
|
parameters:
|
|
6912
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
6848
6913
|
- "$ref": "#/components/parameters/account_id"
|
|
6849
6914
|
requestBody:
|
|
6850
6915
|
content:
|
|
@@ -7152,6 +7217,7 @@ paths:
|
|
|
7152
7217
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
7153
7218
|
to learn how to use pagination in the API and Client Libraries.
|
|
7154
7219
|
parameters:
|
|
7220
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
7155
7221
|
- "$ref": "#/components/parameters/account_id"
|
|
7156
7222
|
- "$ref": "#/components/parameters/ids"
|
|
7157
7223
|
responses:
|
|
@@ -7301,6 +7367,7 @@ paths:
|
|
|
7301
7367
|
operationId: create_account_note
|
|
7302
7368
|
summary: Create an account note
|
|
7303
7369
|
parameters:
|
|
7370
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
7304
7371
|
- "$ref": "#/components/parameters/account_id"
|
|
7305
7372
|
requestBody:
|
|
7306
7373
|
content:
|
|
@@ -7347,6 +7414,7 @@ paths:
|
|
|
7347
7414
|
operationId: get_account_note
|
|
7348
7415
|
summary: Fetch an account note
|
|
7349
7416
|
parameters:
|
|
7417
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
7350
7418
|
- "$ref": "#/components/parameters/account_id"
|
|
7351
7419
|
- "$ref": "#/components/parameters/account_note_id"
|
|
7352
7420
|
responses:
|
|
@@ -7568,6 +7636,7 @@ paths:
|
|
|
7568
7636
|
operationId: remove_account_note
|
|
7569
7637
|
summary: Delete an account note
|
|
7570
7638
|
parameters:
|
|
7639
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
7571
7640
|
- "$ref": "#/components/parameters/account_id"
|
|
7572
7641
|
- "$ref": "#/components/parameters/account_note_id"
|
|
7573
7642
|
responses:
|
|
@@ -7595,6 +7664,7 @@ paths:
|
|
|
7595
7664
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
7596
7665
|
to learn how to use pagination in the API and Client Libraries.
|
|
7597
7666
|
parameters:
|
|
7667
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
7598
7668
|
- "$ref": "#/components/parameters/account_id"
|
|
7599
7669
|
- "$ref": "#/components/parameters/ids"
|
|
7600
7670
|
- "$ref": "#/components/parameters/limit"
|
|
@@ -7760,6 +7830,7 @@ paths:
|
|
|
7760
7830
|
operationId: create_shipping_address
|
|
7761
7831
|
summary: Create a new shipping address for the account
|
|
7762
7832
|
parameters:
|
|
7833
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
7763
7834
|
- "$ref": "#/components/parameters/account_id"
|
|
7764
7835
|
requestBody:
|
|
7765
7836
|
content:
|
|
@@ -8107,6 +8178,7 @@ paths:
|
|
|
8107
8178
|
operationId: get_shipping_address
|
|
8108
8179
|
summary: Fetch an account's shipping address
|
|
8109
8180
|
parameters:
|
|
8181
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
8110
8182
|
- "$ref": "#/components/parameters/account_id"
|
|
8111
8183
|
- "$ref": "#/components/parameters/shipping_address_id"
|
|
8112
8184
|
responses:
|
|
@@ -8326,6 +8398,7 @@ paths:
|
|
|
8326
8398
|
operationId: update_shipping_address
|
|
8327
8399
|
summary: Update an account's shipping address
|
|
8328
8400
|
parameters:
|
|
8401
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
8329
8402
|
- "$ref": "#/components/parameters/account_id"
|
|
8330
8403
|
- "$ref": "#/components/parameters/shipping_address_id"
|
|
8331
8404
|
requestBody:
|
|
@@ -8629,6 +8702,7 @@ paths:
|
|
|
8629
8702
|
operationId: remove_shipping_address
|
|
8630
8703
|
summary: Remove an account's shipping address
|
|
8631
8704
|
parameters:
|
|
8705
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
8632
8706
|
- "$ref": "#/components/parameters/account_id"
|
|
8633
8707
|
- "$ref": "#/components/parameters/shipping_address_id"
|
|
8634
8708
|
responses:
|
|
@@ -8837,6 +8911,7 @@ paths:
|
|
|
8837
8911
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
8838
8912
|
to learn how to use pagination in the API and Client Libraries.
|
|
8839
8913
|
parameters:
|
|
8914
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
8840
8915
|
- "$ref": "#/components/parameters/account_id"
|
|
8841
8916
|
- "$ref": "#/components/parameters/ids"
|
|
8842
8917
|
- "$ref": "#/components/parameters/limit"
|
|
@@ -9007,10 +9082,13 @@ paths:
|
|
|
9007
9082
|
tags:
|
|
9008
9083
|
- Transaction
|
|
9009
9084
|
operationId: list_account_transactions
|
|
9085
|
+
x-product:
|
|
9086
|
+
- recover
|
|
9010
9087
|
summary: List an account's transactions
|
|
9011
9088
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
9012
9089
|
to learn how to use pagination in the API and Client Libraries.
|
|
9013
9090
|
parameters:
|
|
9091
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
9014
9092
|
- "$ref": "#/components/parameters/account_id"
|
|
9015
9093
|
- "$ref": "#/components/parameters/ids"
|
|
9016
9094
|
- "$ref": "#/components/parameters/limit"
|
|
@@ -9188,6 +9266,7 @@ paths:
|
|
|
9188
9266
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
9189
9267
|
to learn how to use pagination in the API and Client Libraries.
|
|
9190
9268
|
parameters:
|
|
9269
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
9191
9270
|
- "$ref": "#/components/parameters/account_id"
|
|
9192
9271
|
- "$ref": "#/components/parameters/ids"
|
|
9193
9272
|
- "$ref": "#/components/parameters/limit"
|
|
@@ -9315,6 +9394,7 @@ paths:
|
|
|
9315
9394
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
9316
9395
|
to learn how to use pagination in the API and Client Libraries.
|
|
9317
9396
|
parameters:
|
|
9397
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
9318
9398
|
- "$ref": "#/components/parameters/ids"
|
|
9319
9399
|
- "$ref": "#/components/parameters/limit"
|
|
9320
9400
|
- "$ref": "#/components/parameters/order"
|
|
@@ -9482,6 +9562,7 @@ paths:
|
|
|
9482
9562
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
9483
9563
|
to learn how to use pagination in the API and Client Libraries.
|
|
9484
9564
|
parameters:
|
|
9565
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
9485
9566
|
- "$ref": "#/components/parameters/ids"
|
|
9486
9567
|
- "$ref": "#/components/parameters/limit"
|
|
9487
9568
|
- "$ref": "#/components/parameters/order"
|
|
@@ -9652,6 +9733,8 @@ paths:
|
|
|
9652
9733
|
- Coupon
|
|
9653
9734
|
operationId: create_coupon
|
|
9654
9735
|
summary: Create a new coupon
|
|
9736
|
+
parameters:
|
|
9737
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
9655
9738
|
requestBody:
|
|
9656
9739
|
content:
|
|
9657
9740
|
application/json:
|
|
@@ -10015,6 +10098,7 @@ paths:
|
|
|
10015
10098
|
operationId: get_coupon
|
|
10016
10099
|
summary: Fetch a coupon
|
|
10017
10100
|
parameters:
|
|
10101
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
10018
10102
|
- "$ref": "#/components/parameters/coupon_id"
|
|
10019
10103
|
responses:
|
|
10020
10104
|
'200':
|
|
@@ -10227,6 +10311,7 @@ paths:
|
|
|
10227
10311
|
operationId: update_coupon
|
|
10228
10312
|
summary: Update an active coupon
|
|
10229
10313
|
parameters:
|
|
10314
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
10230
10315
|
- "$ref": "#/components/parameters/coupon_id"
|
|
10231
10316
|
requestBody:
|
|
10232
10317
|
content:
|
|
@@ -10498,6 +10583,7 @@ paths:
|
|
|
10498
10583
|
operationId: deactivate_coupon
|
|
10499
10584
|
summary: Expire a coupon
|
|
10500
10585
|
parameters:
|
|
10586
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
10501
10587
|
- "$ref": "#/components/parameters/coupon_id"
|
|
10502
10588
|
description: Mark an existing Coupon as expired
|
|
10503
10589
|
responses:
|
|
@@ -10693,6 +10779,7 @@ paths:
|
|
|
10693
10779
|
operationId: generate_unique_coupon_codes
|
|
10694
10780
|
summary: Generate unique coupon codes
|
|
10695
10781
|
parameters:
|
|
10782
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
10696
10783
|
- "$ref": "#/components/parameters/coupon_id"
|
|
10697
10784
|
requestBody:
|
|
10698
10785
|
content:
|
|
@@ -10738,6 +10825,7 @@ paths:
|
|
|
10738
10825
|
them directly in the response. For larger batches, use the asynchronous generate
|
|
10739
10826
|
endpoint instead.
|
|
10740
10827
|
parameters:
|
|
10828
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
10741
10829
|
- "$ref": "#/components/parameters/coupon_id"
|
|
10742
10830
|
requestBody:
|
|
10743
10831
|
content:
|
|
@@ -10786,6 +10874,7 @@ paths:
|
|
|
10786
10874
|
description: Make an expired coupon redeemable again. You can change editable
|
|
10787
10875
|
fields in this call.
|
|
10788
10876
|
parameters:
|
|
10877
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
10789
10878
|
- "$ref": "#/components/parameters/coupon_id"
|
|
10790
10879
|
requestBody:
|
|
10791
10880
|
content:
|
|
@@ -10834,6 +10923,7 @@ paths:
|
|
|
10834
10923
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
10835
10924
|
to learn how to use pagination in the API and Client Libraries.
|
|
10836
10925
|
parameters:
|
|
10926
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
10837
10927
|
- "$ref": "#/components/parameters/coupon_id"
|
|
10838
10928
|
- "$ref": "#/components/parameters/ids"
|
|
10839
10929
|
- "$ref": "#/components/parameters/limit"
|
|
@@ -10871,6 +10961,7 @@ paths:
|
|
|
10871
10961
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
10872
10962
|
to learn how to use pagination in the API and Client Libraries.
|
|
10873
10963
|
parameters:
|
|
10964
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
10874
10965
|
- "$ref": "#/components/parameters/limit"
|
|
10875
10966
|
- "$ref": "#/components/parameters/order"
|
|
10876
10967
|
- "$ref": "#/components/parameters/sort_dates"
|
|
@@ -11043,6 +11134,7 @@ paths:
|
|
|
11043
11134
|
operationId: get_credit_payment
|
|
11044
11135
|
summary: Fetch a credit payment
|
|
11045
11136
|
parameters:
|
|
11137
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
11046
11138
|
- "$ref": "#/components/parameters/credit_payment_id"
|
|
11047
11139
|
responses:
|
|
11048
11140
|
'200':
|
|
@@ -11073,6 +11165,7 @@ paths:
|
|
|
11073
11165
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
11074
11166
|
to learn how to use pagination in the API and Client Libraries.
|
|
11075
11167
|
parameters:
|
|
11168
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
11076
11169
|
- "$ref": "#/components/parameters/ids"
|
|
11077
11170
|
- "$ref": "#/components/parameters/limit"
|
|
11078
11171
|
- "$ref": "#/components/parameters/order"
|
|
@@ -11252,6 +11345,7 @@ paths:
|
|
|
11252
11345
|
operationId: get_custom_field_definition
|
|
11253
11346
|
summary: Fetch an custom field definition
|
|
11254
11347
|
parameters:
|
|
11348
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
11255
11349
|
- "$ref": "#/components/parameters/custom_field_definition_id"
|
|
11256
11350
|
responses:
|
|
11257
11351
|
'200':
|
|
@@ -11464,6 +11558,8 @@ paths:
|
|
|
11464
11558
|
- General Ledger Account
|
|
11465
11559
|
operationId: create_general_ledger_account
|
|
11466
11560
|
summary: Create a new general ledger account
|
|
11561
|
+
parameters:
|
|
11562
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
11467
11563
|
requestBody:
|
|
11468
11564
|
content:
|
|
11469
11565
|
application/json:
|
|
@@ -11492,6 +11588,7 @@ paths:
|
|
|
11492
11588
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
11493
11589
|
to learn how to use pagination in the API and Client Libraries.
|
|
11494
11590
|
parameters:
|
|
11591
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
11495
11592
|
- "$ref": "#/components/parameters/ids"
|
|
11496
11593
|
- "$ref": "#/components/parameters/limit"
|
|
11497
11594
|
- "$ref": "#/components/parameters/order"
|
|
@@ -11518,6 +11615,7 @@ paths:
|
|
|
11518
11615
|
operationId: get_general_ledger_account
|
|
11519
11616
|
summary: Fetch a general ledger account
|
|
11520
11617
|
parameters:
|
|
11618
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
11521
11619
|
- "$ref": "#/components/parameters/general_ledger_account_id"
|
|
11522
11620
|
responses:
|
|
11523
11621
|
'200':
|
|
@@ -11539,6 +11637,7 @@ paths:
|
|
|
11539
11637
|
operationId: update_general_ledger_account
|
|
11540
11638
|
summary: Update a general ledger account
|
|
11541
11639
|
parameters:
|
|
11640
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
11542
11641
|
- "$ref": "#/components/parameters/general_ledger_account_id"
|
|
11543
11642
|
requestBody:
|
|
11544
11643
|
content:
|
|
@@ -11567,6 +11666,7 @@ paths:
|
|
|
11567
11666
|
operationId: get_performance_obligation
|
|
11568
11667
|
summary: Get a single Performance Obligation.
|
|
11569
11668
|
parameters:
|
|
11669
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
11570
11670
|
- "$ref": "#/components/parameters/performance_obligation_id"
|
|
11571
11671
|
responses:
|
|
11572
11672
|
'200':
|
|
@@ -11588,6 +11688,8 @@ paths:
|
|
|
11588
11688
|
- Performance Obligations
|
|
11589
11689
|
operationId: get_performance_obligations
|
|
11590
11690
|
summary: Get a site's Performance Obligations
|
|
11691
|
+
parameters:
|
|
11692
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
11591
11693
|
responses:
|
|
11592
11694
|
'200':
|
|
11593
11695
|
description: A list of Performance Obligations.
|
|
@@ -11611,6 +11713,7 @@ paths:
|
|
|
11611
11713
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
11612
11714
|
to learn how to use pagination in the API and Client Libraries.
|
|
11613
11715
|
parameters:
|
|
11716
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
11614
11717
|
- "$ref": "#/components/parameters/invoice_template_id"
|
|
11615
11718
|
- "$ref": "#/components/parameters/ids"
|
|
11616
11719
|
- "$ref": "#/components/parameters/limit"
|
|
@@ -11656,6 +11759,7 @@ paths:
|
|
|
11656
11759
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
11657
11760
|
to learn how to use pagination in the API and Client Libraries.
|
|
11658
11761
|
parameters:
|
|
11762
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
11659
11763
|
- "$ref": "#/components/parameters/ids"
|
|
11660
11764
|
- "$ref": "#/components/parameters/limit"
|
|
11661
11765
|
- "$ref": "#/components/parameters/order"
|
|
@@ -11827,6 +11931,8 @@ paths:
|
|
|
11827
11931
|
- Item
|
|
11828
11932
|
operationId: create_item
|
|
11829
11933
|
summary: Create a new item
|
|
11934
|
+
parameters:
|
|
11935
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
11830
11936
|
requestBody:
|
|
11831
11937
|
content:
|
|
11832
11938
|
application/json:
|
|
@@ -12215,6 +12321,7 @@ paths:
|
|
|
12215
12321
|
operationId: get_item
|
|
12216
12322
|
summary: Fetch an item
|
|
12217
12323
|
parameters:
|
|
12324
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
12218
12325
|
- "$ref": "#/components/parameters/item_id"
|
|
12219
12326
|
responses:
|
|
12220
12327
|
'200':
|
|
@@ -12427,6 +12534,7 @@ paths:
|
|
|
12427
12534
|
operationId: update_item
|
|
12428
12535
|
summary: Update an active item
|
|
12429
12536
|
parameters:
|
|
12537
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
12430
12538
|
- "$ref": "#/components/parameters/item_id"
|
|
12431
12539
|
requestBody:
|
|
12432
12540
|
content:
|
|
@@ -12723,6 +12831,7 @@ paths:
|
|
|
12723
12831
|
operationId: deactivate_item
|
|
12724
12832
|
summary: Deactivate an item
|
|
12725
12833
|
parameters:
|
|
12834
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
12726
12835
|
- "$ref": "#/components/parameters/item_id"
|
|
12727
12836
|
description: Deactivating an item makes it unavailable for new purchases. It
|
|
12728
12837
|
will not affect existing line items.
|
|
@@ -12939,6 +13048,8 @@ paths:
|
|
|
12939
13048
|
summary: Reactivate an inactive item
|
|
12940
13049
|
description: Reactivating an item makes it available for new purchases. It will
|
|
12941
13050
|
not affect existing line items.
|
|
13051
|
+
parameters:
|
|
13052
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
12942
13053
|
responses:
|
|
12943
13054
|
'200':
|
|
12944
13055
|
description: An item.
|
|
@@ -13157,6 +13268,7 @@ paths:
|
|
|
13157
13268
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
13158
13269
|
to learn how to use pagination in the API and Client Libraries.
|
|
13159
13270
|
parameters:
|
|
13271
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
13160
13272
|
- "$ref": "#/components/parameters/ids"
|
|
13161
13273
|
- "$ref": "#/components/parameters/limit"
|
|
13162
13274
|
- "$ref": "#/components/parameters/order"
|
|
@@ -13189,6 +13301,8 @@ paths:
|
|
|
13189
13301
|
- Measured Unit
|
|
13190
13302
|
operationId: create_measured_unit
|
|
13191
13303
|
summary: Create a new measured unit
|
|
13304
|
+
parameters:
|
|
13305
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
13192
13306
|
requestBody:
|
|
13193
13307
|
content:
|
|
13194
13308
|
application/json:
|
|
@@ -13234,6 +13348,7 @@ paths:
|
|
|
13234
13348
|
operationId: get_measured_unit
|
|
13235
13349
|
summary: Fetch a measured unit
|
|
13236
13350
|
parameters:
|
|
13351
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
13237
13352
|
- "$ref": "#/components/parameters/measured_unit_id"
|
|
13238
13353
|
responses:
|
|
13239
13354
|
'200':
|
|
@@ -13261,6 +13376,7 @@ paths:
|
|
|
13261
13376
|
operationId: update_measured_unit
|
|
13262
13377
|
summary: Update a measured unit
|
|
13263
13378
|
parameters:
|
|
13379
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
13264
13380
|
- "$ref": "#/components/parameters/measured_unit_id"
|
|
13265
13381
|
requestBody:
|
|
13266
13382
|
content:
|
|
@@ -13307,6 +13423,7 @@ paths:
|
|
|
13307
13423
|
summary: Remove a measured unit
|
|
13308
13424
|
description: A mesured unit cannot be deleted if it is used by an active plan.
|
|
13309
13425
|
parameters:
|
|
13426
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
13310
13427
|
- "$ref": "#/components/parameters/measured_unit_id"
|
|
13311
13428
|
responses:
|
|
13312
13429
|
'200':
|
|
@@ -13337,6 +13454,7 @@ paths:
|
|
|
13337
13454
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
13338
13455
|
to learn how to use pagination in the API and Client Libraries.
|
|
13339
13456
|
parameters:
|
|
13457
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
13340
13458
|
- "$ref": "#/components/parameters/sort_dates"
|
|
13341
13459
|
responses:
|
|
13342
13460
|
'200':
|
|
@@ -13363,6 +13481,8 @@ paths:
|
|
|
13363
13481
|
- External Product
|
|
13364
13482
|
operationId: create_external_product
|
|
13365
13483
|
summary: Create an external product
|
|
13484
|
+
parameters:
|
|
13485
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
13366
13486
|
requestBody:
|
|
13367
13487
|
content:
|
|
13368
13488
|
application/json:
|
|
@@ -13403,6 +13523,8 @@ paths:
|
|
|
13403
13523
|
- External Product
|
|
13404
13524
|
operationId: get_external_product
|
|
13405
13525
|
summary: Fetch an external product
|
|
13526
|
+
parameters:
|
|
13527
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
13406
13528
|
responses:
|
|
13407
13529
|
'200':
|
|
13408
13530
|
description: Settings for an external product.
|
|
@@ -13428,6 +13550,8 @@ paths:
|
|
|
13428
13550
|
- External Product
|
|
13429
13551
|
operationId: update_external_product
|
|
13430
13552
|
summary: Update an external product
|
|
13553
|
+
parameters:
|
|
13554
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
13431
13555
|
requestBody:
|
|
13432
13556
|
content:
|
|
13433
13557
|
application/json:
|
|
@@ -13460,6 +13584,8 @@ paths:
|
|
|
13460
13584
|
operationId: deactivate_external_products
|
|
13461
13585
|
summary: Deactivate an external product
|
|
13462
13586
|
description: Deactivate an external product.
|
|
13587
|
+
parameters:
|
|
13588
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
13463
13589
|
responses:
|
|
13464
13590
|
'200':
|
|
13465
13591
|
description: Deactivated external product.
|
|
@@ -13491,6 +13617,7 @@ paths:
|
|
|
13491
13617
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
13492
13618
|
to learn how to use pagination in the API and Client Libraries.
|
|
13493
13619
|
parameters:
|
|
13620
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
13494
13621
|
- "$ref": "#/components/parameters/sort_dates"
|
|
13495
13622
|
responses:
|
|
13496
13623
|
'200':
|
|
@@ -13518,6 +13645,8 @@ paths:
|
|
|
13518
13645
|
- External Product Reference
|
|
13519
13646
|
operationId: create_external_product_external_product_reference
|
|
13520
13647
|
summary: Create an external product reference on an external product
|
|
13648
|
+
parameters:
|
|
13649
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
13521
13650
|
requestBody:
|
|
13522
13651
|
content:
|
|
13523
13652
|
application/json:
|
|
@@ -13553,6 +13682,8 @@ paths:
|
|
|
13553
13682
|
- External Product Reference
|
|
13554
13683
|
operationId: get_external_product_external_product_reference
|
|
13555
13684
|
summary: Fetch an external product reference
|
|
13685
|
+
parameters:
|
|
13686
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
13556
13687
|
responses:
|
|
13557
13688
|
'200':
|
|
13558
13689
|
description: Details for an external product reference.
|
|
@@ -13578,6 +13709,8 @@ paths:
|
|
|
13578
13709
|
- External Product Reference
|
|
13579
13710
|
operationId: deactivate_external_product_external_product_reference
|
|
13580
13711
|
summary: Deactivate an external product reference
|
|
13712
|
+
parameters:
|
|
13713
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
13581
13714
|
responses:
|
|
13582
13715
|
'200':
|
|
13583
13716
|
description: Details for an external product reference.
|
|
@@ -13604,6 +13737,8 @@ paths:
|
|
|
13604
13737
|
- External Subscription
|
|
13605
13738
|
operationId: create_external_subscription
|
|
13606
13739
|
summary: Create an external subscription
|
|
13740
|
+
parameters:
|
|
13741
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
13607
13742
|
requestBody:
|
|
13608
13743
|
content:
|
|
13609
13744
|
application/json:
|
|
@@ -13645,6 +13780,7 @@ paths:
|
|
|
13645
13780
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
13646
13781
|
to learn how to use pagination in the API and Client Libraries.
|
|
13647
13782
|
parameters:
|
|
13783
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
13648
13784
|
- "$ref": "#/components/parameters/sort_dates"
|
|
13649
13785
|
responses:
|
|
13650
13786
|
'200':
|
|
@@ -13669,6 +13805,7 @@ paths:
|
|
|
13669
13805
|
"/external_subscriptions/{external_subscription_id}":
|
|
13670
13806
|
get:
|
|
13671
13807
|
parameters:
|
|
13808
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
13672
13809
|
- "$ref": "#/components/parameters/external_subscription_id_fetch"
|
|
13673
13810
|
tags:
|
|
13674
13811
|
- External Subscription
|
|
@@ -13703,6 +13840,7 @@ paths:
|
|
|
13703
13840
|
x-code-samples: []
|
|
13704
13841
|
put:
|
|
13705
13842
|
parameters:
|
|
13843
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
13706
13844
|
- "$ref": "#/components/parameters/external_subscription_id"
|
|
13707
13845
|
tags:
|
|
13708
13846
|
- External Subscription
|
|
@@ -13758,6 +13896,7 @@ paths:
|
|
|
13758
13896
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
13759
13897
|
to learn how to use pagination in the API and Client Libraries.
|
|
13760
13898
|
parameters:
|
|
13899
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
13761
13900
|
- "$ref": "#/components/parameters/sort_dates"
|
|
13762
13901
|
- "$ref": "#/components/parameters/limit"
|
|
13763
13902
|
- "$ref": "#/components/parameters/order"
|
|
@@ -13786,6 +13925,8 @@ paths:
|
|
|
13786
13925
|
- External Invoice
|
|
13787
13926
|
operationId: create_external_invoice
|
|
13788
13927
|
summary: Create an external invoice
|
|
13928
|
+
parameters:
|
|
13929
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
13789
13930
|
requestBody:
|
|
13790
13931
|
content:
|
|
13791
13932
|
application/json:
|
|
@@ -13824,10 +13965,13 @@ paths:
|
|
|
13824
13965
|
tags:
|
|
13825
13966
|
- Invoice
|
|
13826
13967
|
operationId: list_invoices
|
|
13968
|
+
x-product:
|
|
13969
|
+
- recover
|
|
13827
13970
|
summary: List a site's invoices
|
|
13828
13971
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
13829
13972
|
to learn how to use pagination in the API and Client Libraries.
|
|
13830
13973
|
parameters:
|
|
13974
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
13831
13975
|
- "$ref": "#/components/parameters/ids"
|
|
13832
13976
|
- "$ref": "#/components/parameters/invoice_state"
|
|
13833
13977
|
- "$ref": "#/components/parameters/limit"
|
|
@@ -14000,8 +14144,11 @@ paths:
|
|
|
14000
14144
|
tags:
|
|
14001
14145
|
- Invoice
|
|
14002
14146
|
operationId: get_invoice
|
|
14147
|
+
x-product:
|
|
14148
|
+
- recover
|
|
14003
14149
|
summary: Fetch an invoice
|
|
14004
14150
|
parameters:
|
|
14151
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
14005
14152
|
- "$ref": "#/components/parameters/invoice_id"
|
|
14006
14153
|
responses:
|
|
14007
14154
|
'200':
|
|
@@ -14214,6 +14361,7 @@ paths:
|
|
|
14214
14361
|
operationId: update_invoice
|
|
14215
14362
|
summary: Update an invoice
|
|
14216
14363
|
parameters:
|
|
14364
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
14217
14365
|
- "$ref": "#/components/parameters/invoice_id"
|
|
14218
14366
|
requestBody:
|
|
14219
14367
|
content:
|
|
@@ -14491,6 +14639,7 @@ paths:
|
|
|
14491
14639
|
operationId: get_invoice_pdf
|
|
14492
14640
|
summary: Fetch an invoice as a PDF
|
|
14493
14641
|
parameters:
|
|
14642
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
14494
14643
|
- "$ref": "#/components/parameters/invoice_id"
|
|
14495
14644
|
responses:
|
|
14496
14645
|
'200':
|
|
@@ -14747,6 +14896,7 @@ paths:
|
|
|
14747
14896
|
description: Apply credit payment to the outstanding balance on an existing
|
|
14748
14897
|
charge invoice from an account’s available balance from existing credit invoices.
|
|
14749
14898
|
parameters:
|
|
14899
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
14750
14900
|
- "$ref": "#/components/parameters/invoice_id"
|
|
14751
14901
|
responses:
|
|
14752
14902
|
'200':
|
|
@@ -14970,6 +15120,7 @@ paths:
|
|
|
14970
15120
|
description: Force a collection attempt using the stored billing information.
|
|
14971
15121
|
This will trigger a transaction outside of Recurly's normal retry logic.
|
|
14972
15122
|
parameters:
|
|
15123
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
14973
15124
|
- "$ref": "#/components/parameters/invoice_id"
|
|
14974
15125
|
requestBody:
|
|
14975
15126
|
content:
|
|
@@ -15193,12 +15344,15 @@ paths:
|
|
|
15193
15344
|
tags:
|
|
15194
15345
|
- Invoice
|
|
15195
15346
|
operationId: mark_invoice_failed
|
|
15347
|
+
x-product:
|
|
15348
|
+
- recover
|
|
15196
15349
|
summary: Mark an open invoice as failed
|
|
15197
15350
|
description: |
|
|
15198
15351
|
Indicates that the invoice was not successfully paid for and that collection attempts should stop. This functionality is mostly used to halt the dunning procedures for an invoice.
|
|
15199
15352
|
|
|
15200
15353
|
Only invoices with the `pending`, `processing` or `past_due` states can be marked as failed.
|
|
15201
15354
|
parameters:
|
|
15355
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
15202
15356
|
- "$ref": "#/components/parameters/invoice_id"
|
|
15203
15357
|
responses:
|
|
15204
15358
|
'200':
|
|
@@ -15416,12 +15570,15 @@ paths:
|
|
|
15416
15570
|
tags:
|
|
15417
15571
|
- Invoice
|
|
15418
15572
|
operationId: mark_invoice_successful
|
|
15573
|
+
x-product:
|
|
15574
|
+
- recover
|
|
15419
15575
|
summary: Mark an open invoice as successful
|
|
15420
15576
|
description: |
|
|
15421
15577
|
Indicates that the invoice was successfully paid for and that automated collection attempts should stop - this functionality is typically used to indicate that payment was received via another method and that revenue should be recognized.
|
|
15422
15578
|
|
|
15423
15579
|
Only invoices with the `pending`, `processing`, `past_due` or `failed` states can be marked as paid.
|
|
15424
15580
|
parameters:
|
|
15581
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
15425
15582
|
- "$ref": "#/components/parameters/invoice_id"
|
|
15426
15583
|
responses:
|
|
15427
15584
|
'200':
|
|
@@ -15647,6 +15804,7 @@ paths:
|
|
|
15647
15804
|
operationId: reopen_invoice
|
|
15648
15805
|
summary: Reopen a closed, manual invoice
|
|
15649
15806
|
parameters:
|
|
15807
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
15650
15808
|
- "$ref": "#/components/parameters/invoice_id"
|
|
15651
15809
|
responses:
|
|
15652
15810
|
'200':
|
|
@@ -15869,6 +16027,7 @@ paths:
|
|
|
15869
16027
|
description: Invoice must be a credit invoice (`type=credit`) and cannot be
|
|
15870
16028
|
closed (`state=closed`), processing (`state=processing`), or already voided.
|
|
15871
16029
|
parameters:
|
|
16030
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
15872
16031
|
- "$ref": "#/components/parameters/invoice_id"
|
|
15873
16032
|
responses:
|
|
15874
16033
|
'200':
|
|
@@ -16054,6 +16213,7 @@ paths:
|
|
|
16054
16213
|
not captured through your gateway. It will throw an error for an auto-collecting
|
|
16055
16214
|
invoice.
|
|
16056
16215
|
parameters:
|
|
16216
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
16057
16217
|
- "$ref": "#/components/parameters/invoice_id"
|
|
16058
16218
|
requestBody:
|
|
16059
16219
|
content:
|
|
@@ -16141,6 +16301,7 @@ paths:
|
|
|
16141
16301
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
16142
16302
|
to learn how to use pagination in the API and Client Libraries.
|
|
16143
16303
|
parameters:
|
|
16304
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
16144
16305
|
- "$ref": "#/components/parameters/invoice_id"
|
|
16145
16306
|
- "$ref": "#/components/parameters/ids"
|
|
16146
16307
|
- "$ref": "#/components/parameters/limit"
|
|
@@ -16326,6 +16487,7 @@ paths:
|
|
|
16326
16487
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
16327
16488
|
to learn how to use pagination in the API and Client Libraries.
|
|
16328
16489
|
parameters:
|
|
16490
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
16329
16491
|
- "$ref": "#/components/parameters/invoice_id"
|
|
16330
16492
|
- "$ref": "#/components/parameters/ids"
|
|
16331
16493
|
- "$ref": "#/components/parameters/sort_dates"
|
|
@@ -16493,6 +16655,7 @@ paths:
|
|
|
16493
16655
|
|
|
16494
16656
|
See the [Pagination Guide](/developers/guides/pagination.html) to learn how to use pagination in the API and Client Libraries.
|
|
16495
16657
|
parameters:
|
|
16658
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
16496
16659
|
- "$ref": "#/components/parameters/invoice_id"
|
|
16497
16660
|
responses:
|
|
16498
16661
|
'200':
|
|
@@ -16654,6 +16817,7 @@ paths:
|
|
|
16654
16817
|
* Apply a refund to one or more individual line items on an invoice. A line item can be refunded by a quantity amount, a specific dollar/cent amount, or a percentage amount and will only apply to the specific line item you are aiming to refund.
|
|
16655
16818
|
* Note: You must have the Credit Memos feature flag enabled on your site to utilize specific dollar/cent amount and percentage amount refunds on line items.
|
|
16656
16819
|
parameters:
|
|
16820
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
16657
16821
|
- "$ref": "#/components/parameters/invoice_id"
|
|
16658
16822
|
requestBody:
|
|
16659
16823
|
content:
|
|
@@ -16941,7 +17105,11 @@ paths:
|
|
|
16941
17105
|
tags:
|
|
16942
17106
|
- Revenue Recovery
|
|
16943
17107
|
operationId: create_invoice_retry
|
|
17108
|
+
x-product:
|
|
17109
|
+
- recover
|
|
16944
17110
|
summary: Create an invoice for revenue recovery
|
|
17111
|
+
parameters:
|
|
17112
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
16945
17113
|
requestBody:
|
|
16946
17114
|
content:
|
|
16947
17115
|
application/json:
|
|
@@ -16990,6 +17158,7 @@ paths:
|
|
|
16990
17158
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
16991
17159
|
to learn how to use pagination in the API and Client Libraries.
|
|
16992
17160
|
parameters:
|
|
17161
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
16993
17162
|
- "$ref": "#/components/parameters/ids"
|
|
16994
17163
|
- "$ref": "#/components/parameters/limit"
|
|
16995
17164
|
- "$ref": "#/components/parameters/order"
|
|
@@ -17169,6 +17338,7 @@ paths:
|
|
|
17169
17338
|
operationId: get_line_item
|
|
17170
17339
|
summary: Fetch a line item
|
|
17171
17340
|
parameters:
|
|
17341
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
17172
17342
|
- "$ref": "#/components/parameters/line_item_id"
|
|
17173
17343
|
responses:
|
|
17174
17344
|
'200':
|
|
@@ -17381,6 +17551,7 @@ paths:
|
|
|
17381
17551
|
operationId: remove_line_item
|
|
17382
17552
|
summary: Delete an uninvoiced line item
|
|
17383
17553
|
parameters:
|
|
17554
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
17384
17555
|
- "$ref": "#/components/parameters/line_item_id"
|
|
17385
17556
|
responses:
|
|
17386
17557
|
'204':
|
|
@@ -17598,6 +17769,7 @@ paths:
|
|
|
17598
17769
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
17599
17770
|
to learn how to use pagination in the API and Client Libraries.
|
|
17600
17771
|
parameters:
|
|
17772
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
17601
17773
|
- "$ref": "#/components/parameters/ids"
|
|
17602
17774
|
- "$ref": "#/components/parameters/limit"
|
|
17603
17775
|
- "$ref": "#/components/parameters/order"
|
|
@@ -17769,6 +17941,8 @@ paths:
|
|
|
17769
17941
|
- Plan
|
|
17770
17942
|
operationId: create_plan
|
|
17771
17943
|
summary: Create a plan
|
|
17944
|
+
parameters:
|
|
17945
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
17772
17946
|
requestBody:
|
|
17773
17947
|
content:
|
|
17774
17948
|
application/json:
|
|
@@ -18135,6 +18309,7 @@ paths:
|
|
|
18135
18309
|
operationId: get_plan
|
|
18136
18310
|
summary: Fetch a plan
|
|
18137
18311
|
parameters:
|
|
18312
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
18138
18313
|
- "$ref": "#/components/parameters/plan_id"
|
|
18139
18314
|
responses:
|
|
18140
18315
|
'200':
|
|
@@ -18347,6 +18522,7 @@ paths:
|
|
|
18347
18522
|
operationId: update_plan
|
|
18348
18523
|
summary: Update a plan
|
|
18349
18524
|
parameters:
|
|
18525
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
18350
18526
|
- "$ref": "#/components/parameters/plan_id"
|
|
18351
18527
|
requestBody:
|
|
18352
18528
|
content:
|
|
@@ -18609,6 +18785,7 @@ paths:
|
|
|
18609
18785
|
operationId: remove_plan
|
|
18610
18786
|
summary: Remove a plan
|
|
18611
18787
|
parameters:
|
|
18788
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
18612
18789
|
- "$ref": "#/components/parameters/plan_id"
|
|
18613
18790
|
responses:
|
|
18614
18791
|
'200':
|
|
@@ -18814,6 +18991,7 @@ paths:
|
|
|
18814
18991
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
18815
18992
|
to learn how to use pagination in the API and Client Libraries.
|
|
18816
18993
|
parameters:
|
|
18994
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
18817
18995
|
- "$ref": "#/components/parameters/plan_id"
|
|
18818
18996
|
- "$ref": "#/components/parameters/ids"
|
|
18819
18997
|
- "$ref": "#/components/parameters/limit"
|
|
@@ -18985,6 +19163,7 @@ paths:
|
|
|
18985
19163
|
operationId: create_plan_add_on
|
|
18986
19164
|
summary: Create an add-on
|
|
18987
19165
|
parameters:
|
|
19166
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
18988
19167
|
- "$ref": "#/components/parameters/plan_id"
|
|
18989
19168
|
requestBody:
|
|
18990
19169
|
content:
|
|
@@ -19348,6 +19527,7 @@ paths:
|
|
|
19348
19527
|
operationId: get_plan_add_on
|
|
19349
19528
|
summary: Fetch a plan's add-on
|
|
19350
19529
|
parameters:
|
|
19530
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
19351
19531
|
- "$ref": "#/components/parameters/plan_id"
|
|
19352
19532
|
- "$ref": "#/components/parameters/add_on_id"
|
|
19353
19533
|
responses:
|
|
@@ -19565,6 +19745,7 @@ paths:
|
|
|
19565
19745
|
operationId: update_plan_add_on
|
|
19566
19746
|
summary: Update an add-on
|
|
19567
19747
|
parameters:
|
|
19748
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
19568
19749
|
- "$ref": "#/components/parameters/plan_id"
|
|
19569
19750
|
- "$ref": "#/components/parameters/add_on_id"
|
|
19570
19751
|
requestBody:
|
|
@@ -19818,6 +19999,7 @@ paths:
|
|
|
19818
19999
|
operationId: remove_plan_add_on
|
|
19819
20000
|
summary: Remove an add-on
|
|
19820
20001
|
parameters:
|
|
20002
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
19821
20003
|
- "$ref": "#/components/parameters/plan_id"
|
|
19822
20004
|
- "$ref": "#/components/parameters/add_on_id"
|
|
19823
20005
|
responses:
|
|
@@ -20019,6 +20201,7 @@ paths:
|
|
|
20019
20201
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
20020
20202
|
to learn how to use pagination in the API and Client Libraries.
|
|
20021
20203
|
parameters:
|
|
20204
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
20022
20205
|
- "$ref": "#/components/parameters/ids"
|
|
20023
20206
|
- "$ref": "#/components/parameters/limit"
|
|
20024
20207
|
- "$ref": "#/components/parameters/order"
|
|
@@ -20055,6 +20238,7 @@ paths:
|
|
|
20055
20238
|
operationId: get_price_segment
|
|
20056
20239
|
summary: Fetch a price segment
|
|
20057
20240
|
parameters:
|
|
20241
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
20058
20242
|
- "$ref": "#/components/parameters/price_segment_id"
|
|
20059
20243
|
responses:
|
|
20060
20244
|
'200':
|
|
@@ -20085,6 +20269,7 @@ paths:
|
|
|
20085
20269
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
20086
20270
|
to learn how to use pagination in the API and Client Libraries.
|
|
20087
20271
|
parameters:
|
|
20272
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
20088
20273
|
- "$ref": "#/components/parameters/ids"
|
|
20089
20274
|
- "$ref": "#/components/parameters/limit"
|
|
20090
20275
|
- "$ref": "#/components/parameters/order"
|
|
@@ -20254,6 +20439,7 @@ paths:
|
|
|
20254
20439
|
operationId: get_add_on
|
|
20255
20440
|
summary: Fetch an add-on
|
|
20256
20441
|
parameters:
|
|
20442
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
20257
20443
|
- "$ref": "#/components/parameters/add_on_id"
|
|
20258
20444
|
responses:
|
|
20259
20445
|
'200':
|
|
@@ -20469,6 +20655,7 @@ paths:
|
|
|
20469
20655
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
20470
20656
|
to learn how to use pagination in the API and Client Libraries.
|
|
20471
20657
|
parameters:
|
|
20658
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
20472
20659
|
- "$ref": "#/components/parameters/ids"
|
|
20473
20660
|
- "$ref": "#/components/parameters/limit"
|
|
20474
20661
|
- "$ref": "#/components/parameters/order"
|
|
@@ -20635,6 +20822,8 @@ paths:
|
|
|
20635
20822
|
- Shipping Method
|
|
20636
20823
|
operationId: create_shipping_method
|
|
20637
20824
|
summary: Create a new shipping method
|
|
20825
|
+
parameters:
|
|
20826
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
20638
20827
|
requestBody:
|
|
20639
20828
|
content:
|
|
20640
20829
|
application/json:
|
|
@@ -20680,6 +20869,7 @@ paths:
|
|
|
20680
20869
|
operationId: get_shipping_method
|
|
20681
20870
|
summary: Fetch a shipping method
|
|
20682
20871
|
parameters:
|
|
20872
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
20683
20873
|
- "$ref": "#/components/parameters/shipping_method_id"
|
|
20684
20874
|
responses:
|
|
20685
20875
|
'200':
|
|
@@ -20707,6 +20897,7 @@ paths:
|
|
|
20707
20897
|
operationId: update_shipping_method
|
|
20708
20898
|
summary: Update an active Shipping Method
|
|
20709
20899
|
parameters:
|
|
20900
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
20710
20901
|
- "$ref": "#/components/parameters/shipping_method_id"
|
|
20711
20902
|
requestBody:
|
|
20712
20903
|
content:
|
|
@@ -20752,6 +20943,7 @@ paths:
|
|
|
20752
20943
|
operationId: deactivate_shipping_method
|
|
20753
20944
|
summary: Deactivate a shipping method
|
|
20754
20945
|
parameters:
|
|
20946
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
20755
20947
|
- "$ref": "#/components/parameters/shipping_method_id"
|
|
20756
20948
|
description: Deactivating a shipping method makes it unavailable for new subscriptions
|
|
20757
20949
|
or purchases. It will not affect existing subscriptions.
|
|
@@ -20784,6 +20976,7 @@ paths:
|
|
|
20784
20976
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
20785
20977
|
to learn how to use pagination in the API and Client Libraries.
|
|
20786
20978
|
parameters:
|
|
20979
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
20787
20980
|
- "$ref": "#/components/parameters/ids"
|
|
20788
20981
|
- "$ref": "#/components/parameters/limit"
|
|
20789
20982
|
- "$ref": "#/components/parameters/order"
|
|
@@ -20955,6 +21148,8 @@ paths:
|
|
|
20955
21148
|
- Subscription
|
|
20956
21149
|
operationId: create_subscription
|
|
20957
21150
|
summary: Create a new subscription
|
|
21151
|
+
parameters:
|
|
21152
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
20958
21153
|
requestBody:
|
|
20959
21154
|
content:
|
|
20960
21155
|
application/json:
|
|
@@ -21280,6 +21475,7 @@ paths:
|
|
|
21280
21475
|
operationId: get_subscription
|
|
21281
21476
|
summary: Fetch a subscription
|
|
21282
21477
|
parameters:
|
|
21478
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
21283
21479
|
- "$ref": "#/components/parameters/subscription_id"
|
|
21284
21480
|
responses:
|
|
21285
21481
|
'200':
|
|
@@ -21499,6 +21695,7 @@ paths:
|
|
|
21499
21695
|
impact on the billed amount. Use the [Create Subscription Change](#operation/create_subscription_change)
|
|
21500
21696
|
endpoint to make those changes.
|
|
21501
21697
|
parameters:
|
|
21698
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
21502
21699
|
- "$ref": "#/components/parameters/subscription_id"
|
|
21503
21700
|
requestBody:
|
|
21504
21701
|
content:
|
|
@@ -21773,6 +21970,7 @@ paths:
|
|
|
21773
21970
|
|
|
21774
21971
|
If the subscription has a paid invoice you may choose to refund all, part or none of last invoice's amount.
|
|
21775
21972
|
parameters:
|
|
21973
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
21776
21974
|
- "$ref": "#/components/parameters/subscription_id"
|
|
21777
21975
|
- name: refund
|
|
21778
21976
|
in: query
|
|
@@ -22041,6 +22239,7 @@ paths:
|
|
|
22041
22239
|
until the end of the billing cycle. When a future subscription (`state=future`)
|
|
22042
22240
|
is canceled it becomes failed `state=failed` and cannot be reactivated.
|
|
22043
22241
|
parameters:
|
|
22242
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
22044
22243
|
- "$ref": "#/components/parameters/subscription_id"
|
|
22045
22244
|
requestBody:
|
|
22046
22245
|
content:
|
|
@@ -22278,6 +22477,7 @@ paths:
|
|
|
22278
22477
|
|
|
22279
22478
|
Expired or failed subscriptions cannot be reactivated; instead a new subscription plan will need to be applied to the account.
|
|
22280
22479
|
parameters:
|
|
22480
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
22281
22481
|
- "$ref": "#/components/parameters/subscription_id"
|
|
22282
22482
|
responses:
|
|
22283
22483
|
'200':
|
|
@@ -22511,6 +22711,7 @@ paths:
|
|
|
22511
22711
|
|
|
22512
22712
|
Expired, cancelled, or failed subscriptions cannot be paused.
|
|
22513
22713
|
parameters:
|
|
22714
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
22514
22715
|
- "$ref": "#/components/parameters/subscription_id"
|
|
22515
22716
|
requestBody:
|
|
22516
22717
|
content:
|
|
@@ -22780,6 +22981,7 @@ paths:
|
|
|
22780
22981
|
The subscription must be in the paused state. Active, expired, cancelled,
|
|
22781
22982
|
or failed subscriptions cannot be resumed.
|
|
22782
22983
|
parameters:
|
|
22984
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
22783
22985
|
- "$ref": "#/components/parameters/subscription_id"
|
|
22784
22986
|
responses:
|
|
22785
22987
|
'200':
|
|
@@ -23010,6 +23212,7 @@ paths:
|
|
|
23010
23212
|
in trial. The subscription must be in a trial. Active, paused, expired, cancelled,
|
|
23011
23213
|
or failed subscriptions cannot be converted.
|
|
23012
23214
|
parameters:
|
|
23215
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
23013
23216
|
- "$ref": "#/components/parameters/subscription_id"
|
|
23014
23217
|
responses:
|
|
23015
23218
|
'200':
|
|
@@ -23048,6 +23251,7 @@ paths:
|
|
|
23048
23251
|
exist; if they don't (for example, if the subscription is not set to renew),
|
|
23049
23252
|
it will return an result with no invoices.
|
|
23050
23253
|
parameters:
|
|
23254
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
23051
23255
|
- "$ref": "#/components/parameters/subscription_id"
|
|
23052
23256
|
responses:
|
|
23053
23257
|
'200':
|
|
@@ -23271,6 +23475,7 @@ paths:
|
|
|
23271
23475
|
operationId: get_subscription_change
|
|
23272
23476
|
summary: Fetch a subscription's pending change
|
|
23273
23477
|
parameters:
|
|
23478
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
23274
23479
|
- "$ref": "#/components/parameters/subscription_id"
|
|
23275
23480
|
responses:
|
|
23276
23481
|
'200':
|
|
@@ -23510,6 +23715,7 @@ paths:
|
|
|
23510
23715
|
change, and a change is submitted which matches the subscription as it currently
|
|
23511
23716
|
exists, a 422 Unprocessable Entity validation error will be returned.
|
|
23512
23717
|
parameters:
|
|
23718
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
23513
23719
|
- "$ref": "#/components/parameters/subscription_id"
|
|
23514
23720
|
requestBody:
|
|
23515
23721
|
content:
|
|
@@ -23795,6 +24001,7 @@ paths:
|
|
|
23795
24001
|
operationId: remove_subscription_change
|
|
23796
24002
|
summary: Delete the pending subscription change
|
|
23797
24003
|
parameters:
|
|
24004
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
23798
24005
|
- "$ref": "#/components/parameters/subscription_id"
|
|
23799
24006
|
description: Deleting the pending subscription change will cause the current
|
|
23800
24007
|
subscription settings to be used on the next renewal.
|
|
@@ -24008,6 +24215,7 @@ paths:
|
|
|
24008
24215
|
description: Calling this will not save the subscription change or overwrite
|
|
24009
24216
|
an existing change.
|
|
24010
24217
|
parameters:
|
|
24218
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
24011
24219
|
- "$ref": "#/components/parameters/subscription_id"
|
|
24012
24220
|
requestBody:
|
|
24013
24221
|
content:
|
|
@@ -24051,6 +24259,7 @@ paths:
|
|
|
24051
24259
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
24052
24260
|
to learn how to use pagination in the API and Client Libraries.
|
|
24053
24261
|
parameters:
|
|
24262
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
24054
24263
|
- "$ref": "#/components/parameters/subscription_id"
|
|
24055
24264
|
- "$ref": "#/components/parameters/ids"
|
|
24056
24265
|
- "$ref": "#/components/parameters/invoice_state"
|
|
@@ -24227,6 +24436,7 @@ paths:
|
|
|
24227
24436
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
24228
24437
|
to learn how to use pagination in the API and Client Libraries.
|
|
24229
24438
|
parameters:
|
|
24439
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
24230
24440
|
- "$ref": "#/components/parameters/subscription_id"
|
|
24231
24441
|
- "$ref": "#/components/parameters/ids"
|
|
24232
24442
|
- "$ref": "#/components/parameters/limit"
|
|
@@ -24405,6 +24615,7 @@ paths:
|
|
|
24405
24615
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
24406
24616
|
to learn how to use pagination in the API and Client Libraries.
|
|
24407
24617
|
parameters:
|
|
24618
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
24408
24619
|
- "$ref": "#/components/parameters/subscription_id"
|
|
24409
24620
|
- "$ref": "#/components/parameters/ids"
|
|
24410
24621
|
- "$ref": "#/components/parameters/sort_dates"
|
|
@@ -24570,6 +24781,7 @@ paths:
|
|
|
24570
24781
|
operationId: get_subscription_coupon_redemption
|
|
24571
24782
|
summary: Show the coupon redemption for a subscription
|
|
24572
24783
|
parameters:
|
|
24784
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
24573
24785
|
- "$ref": "#/components/parameters/subscription_id"
|
|
24574
24786
|
- "$ref": "#/components/parameters/coupon_redemption_id"
|
|
24575
24787
|
responses:
|
|
@@ -24599,6 +24811,7 @@ paths:
|
|
|
24599
24811
|
summary: Delete the coupon redemption from a subscription
|
|
24600
24812
|
description: Deactivate the coupon redemption on a subscription.
|
|
24601
24813
|
parameters:
|
|
24814
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
24602
24815
|
- "$ref": "#/components/parameters/subscription_id"
|
|
24603
24816
|
- "$ref": "#/components/parameters/coupon_redemption_id"
|
|
24604
24817
|
responses:
|
|
@@ -24634,6 +24847,7 @@ paths:
|
|
|
24634
24847
|
operationId: list_usage
|
|
24635
24848
|
summary: List a subscription add-on's usage records
|
|
24636
24849
|
parameters:
|
|
24850
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
24637
24851
|
- "$ref": "#/components/parameters/subscription_id"
|
|
24638
24852
|
- "$ref": "#/components/parameters/add_on_id"
|
|
24639
24853
|
- "$ref": "#/components/parameters/ids"
|
|
@@ -24675,6 +24889,7 @@ paths:
|
|
|
24675
24889
|
operationId: create_usage
|
|
24676
24890
|
summary: Log a usage record on this subscription add-on
|
|
24677
24891
|
parameters:
|
|
24892
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
24678
24893
|
- "$ref": "#/components/parameters/subscription_id"
|
|
24679
24894
|
- "$ref": "#/components/parameters/add_on_id"
|
|
24680
24895
|
requestBody:
|
|
@@ -24722,6 +24937,7 @@ paths:
|
|
|
24722
24937
|
operationId: get_usage
|
|
24723
24938
|
summary: Get a usage record
|
|
24724
24939
|
parameters:
|
|
24940
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
24725
24941
|
- "$ref": "#/components/parameters/usage_id"
|
|
24726
24942
|
responses:
|
|
24727
24943
|
'200':
|
|
@@ -24755,6 +24971,7 @@ paths:
|
|
|
24755
24971
|
operationId: update_usage
|
|
24756
24972
|
summary: Update a usage record
|
|
24757
24973
|
parameters:
|
|
24974
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
24758
24975
|
- "$ref": "#/components/parameters/usage_id"
|
|
24759
24976
|
requestBody:
|
|
24760
24977
|
content:
|
|
@@ -24800,6 +25017,7 @@ paths:
|
|
|
24800
25017
|
operationId: remove_usage
|
|
24801
25018
|
summary: Delete a usage record.
|
|
24802
25019
|
parameters:
|
|
25020
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
24803
25021
|
- "$ref": "#/components/parameters/usage_id"
|
|
24804
25022
|
responses:
|
|
24805
25023
|
'204':
|
|
@@ -24834,10 +25052,13 @@ paths:
|
|
|
24834
25052
|
tags:
|
|
24835
25053
|
- Transaction
|
|
24836
25054
|
operationId: list_transactions
|
|
25055
|
+
x-product:
|
|
25056
|
+
- recover
|
|
24837
25057
|
summary: List a site's transactions
|
|
24838
25058
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
24839
25059
|
to learn how to use pagination in the API and Client Libraries.
|
|
24840
25060
|
parameters:
|
|
25061
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
24841
25062
|
- "$ref": "#/components/parameters/ids"
|
|
24842
25063
|
- "$ref": "#/components/parameters/limit"
|
|
24843
25064
|
- "$ref": "#/components/parameters/order"
|
|
@@ -25010,8 +25231,11 @@ paths:
|
|
|
25010
25231
|
tags:
|
|
25011
25232
|
- Transaction
|
|
25012
25233
|
operationId: get_transaction
|
|
25234
|
+
x-product:
|
|
25235
|
+
- recover
|
|
25013
25236
|
summary: Fetch a transaction
|
|
25014
25237
|
parameters:
|
|
25238
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
25015
25239
|
- "$ref": "#/components/parameters/transaction_id"
|
|
25016
25240
|
responses:
|
|
25017
25241
|
'200':
|
|
@@ -25226,6 +25450,8 @@ paths:
|
|
|
25226
25450
|
- Unique Coupon Code
|
|
25227
25451
|
operationId: get_unique_coupon_code
|
|
25228
25452
|
summary: Fetch a unique coupon code
|
|
25453
|
+
parameters:
|
|
25454
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
25229
25455
|
responses:
|
|
25230
25456
|
'200':
|
|
25231
25457
|
description: A unique coupon code.
|
|
@@ -25253,6 +25479,8 @@ paths:
|
|
|
25253
25479
|
summary: Deactivate a unique coupon code
|
|
25254
25480
|
description: Expire a unique code, making that specific code no longer redeemable.
|
|
25255
25481
|
The parent bulk coupon will not be affected.
|
|
25482
|
+
parameters:
|
|
25483
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
25256
25484
|
responses:
|
|
25257
25485
|
'200':
|
|
25258
25486
|
description: A unique coupon code.
|
|
@@ -25287,6 +25515,8 @@ paths:
|
|
|
25287
25515
|
- Unique Coupon Code
|
|
25288
25516
|
operationId: reactivate_unique_coupon_code
|
|
25289
25517
|
summary: Restore a unique coupon code
|
|
25518
|
+
parameters:
|
|
25519
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
25290
25520
|
responses:
|
|
25291
25521
|
'200':
|
|
25292
25522
|
description: A unique coupon code.
|
|
@@ -25322,6 +25552,8 @@ paths:
|
|
|
25322
25552
|
description: A purchase is a checkout containing at least one or more subscriptions
|
|
25323
25553
|
or one-time charges (line items) and supports both coupon and gift card redemptions.
|
|
25324
25554
|
All items purchased will be on one invoice and paid for with one transaction.
|
|
25555
|
+
parameters:
|
|
25556
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
25325
25557
|
requestBody:
|
|
25326
25558
|
content:
|
|
25327
25559
|
application/json:
|
|
@@ -25768,6 +26000,8 @@ paths:
|
|
|
25768
26000
|
description: A purchase is a checkout containing at least one or more subscriptions
|
|
25769
26001
|
or one-time charges (line items) and supports both coupon and gift card redemptions.
|
|
25770
26002
|
All items purchased will be on one invoice and paid for with one transaction.
|
|
26003
|
+
parameters:
|
|
26004
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
25771
26005
|
requestBody:
|
|
25772
26006
|
content:
|
|
25773
26007
|
application/json:
|
|
@@ -26211,6 +26445,8 @@ paths:
|
|
|
26211
26445
|
For additional information regarding shipping fees, please see https://docs.recurly.com/docs/shipping
|
|
26212
26446
|
|
|
26213
26447
|
Note: an email address is required on the account for a Pending Purchase.
|
|
26448
|
+
parameters:
|
|
26449
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
26214
26450
|
requestBody:
|
|
26215
26451
|
content:
|
|
26216
26452
|
application/json:
|
|
@@ -26712,6 +26948,8 @@ paths:
|
|
|
26712
26948
|
The authorize endpoint will create a pending purchase that can be activated at a later time once payment has been completed on an external source.
|
|
26713
26949
|
|
|
26714
26950
|
For additional information regarding shipping fees, please see https://docs.recurly.com/docs/shipping
|
|
26951
|
+
parameters:
|
|
26952
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
26715
26953
|
requestBody:
|
|
26716
26954
|
content:
|
|
26717
26955
|
application/json:
|
|
@@ -26749,6 +26987,7 @@ paths:
|
|
|
26749
26987
|
tags:
|
|
26750
26988
|
- Purchase
|
|
26751
26989
|
parameters:
|
|
26990
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
26752
26991
|
- "$ref": "#/components/parameters/transaction_id"
|
|
26753
26992
|
operationId: create_capture_purchase
|
|
26754
26993
|
summary: Capture a purchase
|
|
@@ -26800,6 +27039,8 @@ paths:
|
|
|
26800
27039
|
tags:
|
|
26801
27040
|
- Purchase
|
|
26802
27041
|
operationId: cancelPurchase
|
|
27042
|
+
parameters:
|
|
27043
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
26803
27044
|
responses:
|
|
26804
27045
|
'200':
|
|
26805
27046
|
description: Returns the cancelled invoice
|
|
@@ -26834,6 +27075,8 @@ paths:
|
|
|
26834
27075
|
summary: List the dates that have an available export to download.
|
|
26835
27076
|
description: Returns a list of dates for which export files are available for
|
|
26836
27077
|
download.
|
|
27078
|
+
parameters:
|
|
27079
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
26837
27080
|
responses:
|
|
26838
27081
|
'200':
|
|
26839
27082
|
description: Returns a list of dates.
|
|
@@ -27031,6 +27274,8 @@ paths:
|
|
|
27031
27274
|
summary: List of the export files that are available to download.
|
|
27032
27275
|
description: Returns a list of presigned URLs to download export files for the
|
|
27033
27276
|
given date, with their MD5 sums.
|
|
27277
|
+
parameters:
|
|
27278
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
27034
27279
|
responses:
|
|
27035
27280
|
'200':
|
|
27036
27281
|
description: Returns a list of export files to download.
|
|
@@ -27223,10 +27468,13 @@ paths:
|
|
|
27223
27468
|
tags:
|
|
27224
27469
|
- Dunning Campaigns
|
|
27225
27470
|
operationId: list_dunning_campaigns
|
|
27471
|
+
x-product:
|
|
27472
|
+
- recover
|
|
27226
27473
|
summary: List the dunning campaigns for a site
|
|
27227
27474
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
27228
27475
|
to learn how to use pagination in the API and Client Libraries.
|
|
27229
27476
|
parameters:
|
|
27477
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
27230
27478
|
- "$ref": "#/components/parameters/sort_dates"
|
|
27231
27479
|
responses:
|
|
27232
27480
|
'200':
|
|
@@ -27253,6 +27501,8 @@ paths:
|
|
|
27253
27501
|
- Dunning Campaigns
|
|
27254
27502
|
operationId: create_dunning_campaign
|
|
27255
27503
|
summary: Create a new dunning campaign
|
|
27504
|
+
parameters:
|
|
27505
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
27256
27506
|
requestBody:
|
|
27257
27507
|
content:
|
|
27258
27508
|
application/json:
|
|
@@ -27311,7 +27561,11 @@ paths:
|
|
|
27311
27561
|
tags:
|
|
27312
27562
|
- Dunning Campaigns
|
|
27313
27563
|
operationId: get_dunning_campaign
|
|
27564
|
+
x-product:
|
|
27565
|
+
- recover
|
|
27314
27566
|
summary: Fetch a dunning campaign
|
|
27567
|
+
parameters:
|
|
27568
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
27315
27569
|
responses:
|
|
27316
27570
|
'200':
|
|
27317
27571
|
description: Settings for a dunning campaign.
|
|
@@ -27345,6 +27599,8 @@ paths:
|
|
|
27345
27599
|
summary: Update a dunning campaign
|
|
27346
27600
|
description: Each cycle write is a full replacement of that cycle's settings;
|
|
27347
27601
|
omitted scalars fall back to the model default rather than the prior version.
|
|
27602
|
+
parameters:
|
|
27603
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
27348
27604
|
requestBody:
|
|
27349
27605
|
content:
|
|
27350
27606
|
application/json:
|
|
@@ -27402,6 +27658,8 @@ paths:
|
|
|
27402
27658
|
operationId: deactivate_dunning_campaign
|
|
27403
27659
|
summary: Deactivate a dunning campaign
|
|
27404
27660
|
description: The default dunning campaign cannot be deactivated.
|
|
27661
|
+
parameters:
|
|
27662
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
27405
27663
|
responses:
|
|
27406
27664
|
'200':
|
|
27407
27665
|
description: The deactivated dunning campaign.
|
|
@@ -27440,6 +27698,8 @@ paths:
|
|
|
27440
27698
|
- Dunning Campaigns
|
|
27441
27699
|
operationId: list_dunning_campaign_email_templates
|
|
27442
27700
|
summary: List the custom email templates assignable to a dunning campaign interval
|
|
27701
|
+
parameters:
|
|
27702
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
27443
27703
|
responses:
|
|
27444
27704
|
'200':
|
|
27445
27705
|
description: A list of the site's assignable custom email templates.
|
|
@@ -27475,6 +27735,8 @@ paths:
|
|
|
27475
27735
|
- Dunning Campaigns
|
|
27476
27736
|
operationId: put_dunning_campaign_bulk_update
|
|
27477
27737
|
summary: Assign a dunning campaign to multiple plans
|
|
27738
|
+
parameters:
|
|
27739
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
27478
27740
|
requestBody:
|
|
27479
27741
|
content:
|
|
27480
27742
|
application/json:
|
|
@@ -27515,6 +27777,7 @@ paths:
|
|
|
27515
27777
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
27516
27778
|
to learn how to use pagination in the API and Client Libraries.
|
|
27517
27779
|
parameters:
|
|
27780
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
27518
27781
|
- "$ref": "#/components/parameters/sort_dates"
|
|
27519
27782
|
responses:
|
|
27520
27783
|
'200':
|
|
@@ -27544,6 +27807,8 @@ paths:
|
|
|
27544
27807
|
- Invoice Templates
|
|
27545
27808
|
operationId: get_invoice_template
|
|
27546
27809
|
summary: Fetch an invoice template
|
|
27810
|
+
parameters:
|
|
27811
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
27547
27812
|
responses:
|
|
27548
27813
|
'200':
|
|
27549
27814
|
description: Settings for an invoice template.
|
|
@@ -27579,6 +27844,7 @@ paths:
|
|
|
27579
27844
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
27580
27845
|
to learn how to use pagination in the API and Client Libraries.
|
|
27581
27846
|
parameters:
|
|
27847
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
27582
27848
|
- "$ref": "#/components/parameters/sort_dates"
|
|
27583
27849
|
- "$ref": "#/components/parameters/limit"
|
|
27584
27850
|
- "$ref": "#/components/parameters/order"
|
|
@@ -27610,6 +27876,8 @@ paths:
|
|
|
27610
27876
|
- External Invoice
|
|
27611
27877
|
operationId: show_external_invoice
|
|
27612
27878
|
summary: Fetch an external invoice
|
|
27879
|
+
parameters:
|
|
27880
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
27613
27881
|
responses:
|
|
27614
27882
|
'201':
|
|
27615
27883
|
description: Returns the external invoice
|
|
@@ -27647,6 +27915,7 @@ paths:
|
|
|
27647
27915
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
27648
27916
|
to learn how to use pagination in the API and Client Libraries.
|
|
27649
27917
|
parameters:
|
|
27918
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
27650
27919
|
- "$ref": "#/components/parameters/sort_dates"
|
|
27651
27920
|
- "$ref": "#/components/parameters/limit"
|
|
27652
27921
|
- "$ref": "#/components/parameters/order"
|
|
@@ -27679,6 +27948,8 @@ paths:
|
|
|
27679
27948
|
- External Payment Phase
|
|
27680
27949
|
operationId: get_external_subscription_external_payment_phase
|
|
27681
27950
|
summary: Fetch an external payment phase
|
|
27951
|
+
parameters:
|
|
27952
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
27682
27953
|
responses:
|
|
27683
27954
|
'200':
|
|
27684
27955
|
description: Details for an external payment phase.
|
|
@@ -27708,6 +27979,8 @@ paths:
|
|
|
27708
27979
|
- Account
|
|
27709
27980
|
operationId: list_entitlements
|
|
27710
27981
|
summary: List entitlements granted to an account
|
|
27982
|
+
parameters:
|
|
27983
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
27711
27984
|
responses:
|
|
27712
27985
|
'200':
|
|
27713
27986
|
description: A list of the entitlements granted to an account.
|
|
@@ -27739,6 +28012,7 @@ paths:
|
|
|
27739
28012
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
27740
28013
|
to learn how to use pagination in the API and Client Libraries.
|
|
27741
28014
|
parameters:
|
|
28015
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
27742
28016
|
- "$ref": "#/components/parameters/sort_dates"
|
|
27743
28017
|
responses:
|
|
27744
28018
|
'200':
|
|
@@ -27768,6 +28042,8 @@ paths:
|
|
|
27768
28042
|
- Business Entities
|
|
27769
28043
|
operationId: get_business_entity
|
|
27770
28044
|
summary: Fetch a business entity
|
|
28045
|
+
parameters:
|
|
28046
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
27771
28047
|
responses:
|
|
27772
28048
|
'200':
|
|
27773
28049
|
description: Business entity details
|
|
@@ -27794,6 +28070,8 @@ paths:
|
|
|
27794
28070
|
- Business Entities
|
|
27795
28071
|
operationId: list_business_entities
|
|
27796
28072
|
summary: List business entities
|
|
28073
|
+
parameters:
|
|
28074
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
27797
28075
|
responses:
|
|
27798
28076
|
'200':
|
|
27799
28077
|
description: List of all business entities on your site.
|
|
@@ -27820,6 +28098,8 @@ paths:
|
|
|
27820
28098
|
- Gift Cards
|
|
27821
28099
|
operationId: list_gift_cards
|
|
27822
28100
|
summary: List gift cards
|
|
28101
|
+
parameters:
|
|
28102
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
27823
28103
|
responses:
|
|
27824
28104
|
'200':
|
|
27825
28105
|
description: List of all created gift cards on your site.
|
|
@@ -27845,6 +28125,8 @@ paths:
|
|
|
27845
28125
|
- Gift Cards
|
|
27846
28126
|
operationId: create_gift_card
|
|
27847
28127
|
summary: Create gift card
|
|
28128
|
+
parameters:
|
|
28129
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
27848
28130
|
requestBody:
|
|
27849
28131
|
content:
|
|
27850
28132
|
application/json:
|
|
@@ -27885,6 +28167,8 @@ paths:
|
|
|
27885
28167
|
- Gift Cards
|
|
27886
28168
|
operationId: get_gift_card
|
|
27887
28169
|
summary: Fetch a gift card
|
|
28170
|
+
parameters:
|
|
28171
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
27888
28172
|
responses:
|
|
27889
28173
|
'200':
|
|
27890
28174
|
description: Gift card details
|
|
@@ -27911,6 +28195,8 @@ paths:
|
|
|
27911
28195
|
- Gift Cards
|
|
27912
28196
|
operationId: preview_gift_card
|
|
27913
28197
|
summary: Preview gift card
|
|
28198
|
+
parameters:
|
|
28199
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
27914
28200
|
requestBody:
|
|
27915
28201
|
content:
|
|
27916
28202
|
application/json:
|
|
@@ -27951,6 +28237,8 @@ paths:
|
|
|
27951
28237
|
- Gift Cards
|
|
27952
28238
|
operationId: redeem_gift_card
|
|
27953
28239
|
summary: Redeem gift card
|
|
28240
|
+
parameters:
|
|
28241
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
27954
28242
|
requestBody:
|
|
27955
28243
|
content:
|
|
27956
28244
|
application/json:
|
|
@@ -27992,6 +28280,7 @@ paths:
|
|
|
27992
28280
|
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
|
27993
28281
|
to learn how to use pagination in the API and Client Libraries.
|
|
27994
28282
|
parameters:
|
|
28283
|
+
- "$ref": "#/components/parameters/accept_header"
|
|
27995
28284
|
- "$ref": "#/components/parameters/business_entity_id"
|
|
27996
28285
|
- "$ref": "#/components/parameters/ids"
|
|
27997
28286
|
- "$ref": "#/components/parameters/invoice_state"
|
|
@@ -28032,6 +28321,15 @@ servers:
|
|
|
28032
28321
|
- url: https://v3.eu.recurly.com
|
|
28033
28322
|
components:
|
|
28034
28323
|
parameters:
|
|
28324
|
+
accept_header:
|
|
28325
|
+
name: Accept
|
|
28326
|
+
in: header
|
|
28327
|
+
description: The API version to use for this request, e.g. `application/vnd.recurly.v2021-02-25`.
|
|
28328
|
+
Requests without a versioned `Accept` header return a 406 response.
|
|
28329
|
+
required: true
|
|
28330
|
+
schema:
|
|
28331
|
+
default: application/vnd.recurly.v2021-02-25
|
|
28332
|
+
"$ref": "#/components/schemas/AcceptHeaderEnum"
|
|
28035
28333
|
site_id:
|
|
28036
28334
|
name: site_id
|
|
28037
28335
|
in: path
|
|
@@ -28536,6 +28834,11 @@ components:
|
|
|
28536
28834
|
page.
|
|
28537
28835
|
scheme: basic
|
|
28538
28836
|
schemas:
|
|
28837
|
+
AcceptHeaderEnum:
|
|
28838
|
+
type: string
|
|
28839
|
+
enum:
|
|
28840
|
+
- application/vnd.recurly.v2021-02-25
|
|
28841
|
+
- application/vnd.recurly.v2021-02-25+json
|
|
28539
28842
|
Empty:
|
|
28540
28843
|
type: object
|
|
28541
28844
|
properties: {}
|
|
@@ -30559,6 +30862,12 @@ components:
|
|
|
30559
30862
|
type: string
|
|
30560
30863
|
title: An identifier for a specific payment gateway.
|
|
30561
30864
|
maxLength: 12
|
|
30865
|
+
backup_gateway_code:
|
|
30866
|
+
type: string
|
|
30867
|
+
title: Identifies a backup gateway. Applies only when `gateway_code` is
|
|
30868
|
+
provided and that gateway is in failover. Providing this code overrides
|
|
30869
|
+
gateway exclusion configurations and restricts the backup to this gateway.
|
|
30870
|
+
maxLength: 12
|
|
30562
30871
|
payment_gateway_references:
|
|
30563
30872
|
type: array
|
|
30564
30873
|
description: Array of Payment Gateway References, each a reference to a
|
|
@@ -30692,6 +31001,10 @@ components:
|
|
|
30692
31001
|
through Adyen Components will utilize this return URL.
|
|
30693
31002
|
authentication_method:
|
|
30694
31003
|
"$ref": "#/components/schemas/UpiAutopayAuthenticationMethodEnum"
|
|
31004
|
+
store_billing_info:
|
|
31005
|
+
type: boolean
|
|
31006
|
+
description: Whether to store this billing info onto its associated account.
|
|
31007
|
+
Defaults to `true`.
|
|
30695
31008
|
BillingInfoVerify:
|
|
30696
31009
|
type: object
|
|
30697
31010
|
properties:
|
|
@@ -35114,6 +35427,8 @@ components:
|
|
|
35114
35427
|
type: boolean
|
|
35115
35428
|
title: Activated?
|
|
35116
35429
|
description: Returns `true` if the subscription change is activated.
|
|
35430
|
+
price_segment_id:
|
|
35431
|
+
"$ref": "#/components/schemas/PriceSegmentId"
|
|
35117
35432
|
revenue_schedule_type:
|
|
35118
35433
|
title: Revenue schedule type
|
|
35119
35434
|
"$ref": "#/components/schemas/RevenueScheduleTypeEnum"
|
|
@@ -38709,8 +39024,8 @@ components:
|
|
|
38709
39024
|
- post
|
|
38710
39025
|
PaymentGatewayReferencesEnum:
|
|
38711
39026
|
type: string
|
|
38712
|
-
description: The type of reference token.
|
|
38713
|
-
|
|
39027
|
+
description: The type of reference token. The value can be omitted for gateways
|
|
39028
|
+
that only support one type of token.
|
|
38714
39029
|
enum:
|
|
38715
39030
|
- stripe_confirmation_token
|
|
38716
39031
|
- upi_vpa
|