recurly 4.1.0 → 4.2.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.bumpversion.cfg +1 -1
- data/.github/workflows/docs.yml +1 -1
- data/CHANGELOG.md +11 -0
- data/GETTING_STARTED.md +1 -1
- data/lib/recurly/client/operations.rb +24 -151
- data/lib/recurly/requests/subscription_add_on_tier.rb +6 -2
- data/lib/recurly/resources/subscription_add_on_tier.rb +6 -2
- data/lib/recurly/version.rb +1 -1
- data/openapi/api.yaml +11 -133
- metadata +3 -3
@@ -11,12 +11,16 @@ module Recurly
|
|
11
11
|
define_attribute :ending_quantity, Integer
|
12
12
|
|
13
13
|
# @!attribute unit_amount
|
14
|
-
# @return [Float] Allows up to 2 decimal places. Optionally, override the tiers' default unit amount.
|
14
|
+
# @return [Float] Allows up to 2 decimal places. Optionally, override the tiers' default unit amount. If add-on's `add_on_type` is `usage` and `usage_type` is `percentage`, cannot be provided.
|
15
15
|
define_attribute :unit_amount, Float
|
16
16
|
|
17
17
|
# @!attribute unit_amount_decimal
|
18
|
-
# @return [String] Allows up to 9 decimal places. Optionally, override tiers' default unit amount. If `unit_amount_decimal` is provided, `unit_amount` cannot be provided.
|
18
|
+
# @return [String] Allows up to 9 decimal places. Optionally, override tiers' default unit amount. If `unit_amount_decimal` is provided, `unit_amount` cannot be provided. If add-on's `add_on_type` is `usage` and `usage_type` is `percentage`, cannot be provided.
|
19
19
|
define_attribute :unit_amount_decimal, String
|
20
|
+
|
21
|
+
# @!attribute usage_percentage
|
22
|
+
# @return [String] The percentage taken of the monetary amount of usage tracked. This can be up to 4 decimal places represented as a string. A value between 0.0 and 100.0. Optionally, override tiers' default usage percentage. Required if add-on's `add_on_type` is `usage` and `usage_type` is `percentage`. Must be omitted otherwise.
|
23
|
+
define_attribute :usage_percentage, String
|
20
24
|
end
|
21
25
|
end
|
22
26
|
end
|
@@ -11,12 +11,16 @@ module Recurly
|
|
11
11
|
define_attribute :ending_quantity, Integer
|
12
12
|
|
13
13
|
# @!attribute unit_amount
|
14
|
-
# @return [Float] Allows up to 2 decimal places. Optionally, override the tiers' default unit amount.
|
14
|
+
# @return [Float] Allows up to 2 decimal places. Optionally, override the tiers' default unit amount. If add-on's `add_on_type` is `usage` and `usage_type` is `percentage`, cannot be provided.
|
15
15
|
define_attribute :unit_amount, Float
|
16
16
|
|
17
17
|
# @!attribute unit_amount_decimal
|
18
|
-
# @return [String] Allows up to 9 decimal places. Optionally, override tiers' default unit amount. If `unit_amount_decimal` is provided, `unit_amount` cannot be provided.
|
18
|
+
# @return [String] Allows up to 9 decimal places. Optionally, override tiers' default unit amount. If `unit_amount_decimal` is provided, `unit_amount` cannot be provided. If add-on's `add_on_type` is `usage` and `usage_type` is `percentage`, cannot be provided.
|
19
19
|
define_attribute :unit_amount_decimal, String
|
20
|
+
|
21
|
+
# @!attribute usage_percentage
|
22
|
+
# @return [String] The percentage taken of the monetary amount of usage tracked. This can be up to 4 decimal places represented as a string. A value between 0.0 and 100.0. Optionally, override tiers' default usage percentage. Required if add-on's `add_on_type` is `usage` and `usage_type` is `percentage`. Must be omitted otherwise.
|
23
|
+
define_attribute :usage_percentage, String
|
20
24
|
end
|
21
25
|
end
|
22
26
|
end
|
data/lib/recurly/version.rb
CHANGED
data/openapi/api.yaml
CHANGED
@@ -547,7 +547,6 @@ paths:
|
|
547
547
|
description: See the [Pagination Guide](/guides/pagination.html) to learn how
|
548
548
|
to use pagination in the API and Client Libraries.
|
549
549
|
parameters:
|
550
|
-
- "$ref": "#/components/parameters/site_id"
|
551
550
|
- "$ref": "#/components/parameters/ids"
|
552
551
|
- "$ref": "#/components/parameters/limit"
|
553
552
|
- "$ref": "#/components/parameters/order"
|
@@ -650,8 +649,6 @@ paths:
|
|
650
649
|
- account
|
651
650
|
operationId: create_account
|
652
651
|
summary: Create an account
|
653
|
-
parameters:
|
654
|
-
- "$ref": "#/components/parameters/site_id"
|
655
652
|
requestBody:
|
656
653
|
content:
|
657
654
|
application/json:
|
@@ -899,7 +896,6 @@ paths:
|
|
899
896
|
%s\", account.Id)"
|
900
897
|
"/accounts/{account_id}":
|
901
898
|
parameters:
|
902
|
-
- "$ref": "#/components/parameters/site_id"
|
903
899
|
- "$ref": "#/components/parameters/account_id"
|
904
900
|
get:
|
905
901
|
tags:
|
@@ -1288,7 +1284,6 @@ paths:
|
|
1288
1284
|
Account: %s\", account.Id)"
|
1289
1285
|
"/accounts/{account_id}/acquisition":
|
1290
1286
|
parameters:
|
1291
|
-
- "$ref": "#/components/parameters/site_id"
|
1292
1287
|
- "$ref": "#/components/parameters/account_id"
|
1293
1288
|
get:
|
1294
1289
|
tags:
|
@@ -1668,7 +1663,6 @@ paths:
|
|
1668
1663
|
Acquisition: %s\", accountAcquisition.Id)"
|
1669
1664
|
"/accounts/{account_id}/reactivate":
|
1670
1665
|
parameters:
|
1671
|
-
- "$ref": "#/components/parameters/site_id"
|
1672
1666
|
- "$ref": "#/components/parameters/account_id"
|
1673
1667
|
put:
|
1674
1668
|
tags:
|
@@ -1792,7 +1786,6 @@ paths:
|
|
1792
1786
|
Account: %s\", account.Id)"
|
1793
1787
|
"/accounts/{account_id}/balance":
|
1794
1788
|
parameters:
|
1795
|
-
- "$ref": "#/components/parameters/site_id"
|
1796
1789
|
- "$ref": "#/components/parameters/account_id"
|
1797
1790
|
get:
|
1798
1791
|
tags:
|
@@ -1914,7 +1907,6 @@ paths:
|
|
1914
1907
|
operationId: get_billing_info
|
1915
1908
|
summary: Fetch an account's billing information
|
1916
1909
|
parameters:
|
1917
|
-
- "$ref": "#/components/parameters/site_id"
|
1918
1910
|
- "$ref": "#/components/parameters/account_id"
|
1919
1911
|
responses:
|
1920
1912
|
'200':
|
@@ -2050,7 +2042,6 @@ paths:
|
|
2050
2042
|
- gateway_token
|
2051
2043
|
- gateway_code
|
2052
2044
|
parameters:
|
2053
|
-
- "$ref": "#/components/parameters/site_id"
|
2054
2045
|
- "$ref": "#/components/parameters/account_id"
|
2055
2046
|
requestBody:
|
2056
2047
|
content:
|
@@ -2205,7 +2196,6 @@ paths:
|
|
2205
2196
|
operationId: remove_billing_info
|
2206
2197
|
summary: Remove an account's billing information
|
2207
2198
|
parameters:
|
2208
|
-
- "$ref": "#/components/parameters/site_id"
|
2209
2199
|
- "$ref": "#/components/parameters/account_id"
|
2210
2200
|
description: You may remove any stored billing information for an account. If
|
2211
2201
|
the account has a subscription, the renewal will go into dunning unless the
|
@@ -2316,7 +2306,6 @@ paths:
|
|
2316
2306
|
description: See the [Pagination Guide](/guides/pagination.html) to learn how
|
2317
2307
|
to use pagination in the API and Client Libraries.
|
2318
2308
|
parameters:
|
2319
|
-
- "$ref": "#/components/parameters/site_id"
|
2320
2309
|
- "$ref": "#/components/parameters/account_id"
|
2321
2310
|
- "$ref": "#/components/parameters/ids"
|
2322
2311
|
- "$ref": "#/components/parameters/sort_dates"
|
@@ -2367,7 +2356,6 @@ paths:
|
|
2367
2356
|
- gateway_token
|
2368
2357
|
- gateway_code
|
2369
2358
|
parameters:
|
2370
|
-
- "$ref": "#/components/parameters/site_id"
|
2371
2359
|
- "$ref": "#/components/parameters/account_id"
|
2372
2360
|
requestBody:
|
2373
2361
|
content:
|
@@ -2409,7 +2397,6 @@ paths:
|
|
2409
2397
|
operationId: get_a_billing_info
|
2410
2398
|
summary: Fetch a billing info
|
2411
2399
|
parameters:
|
2412
|
-
- "$ref": "#/components/parameters/site_id"
|
2413
2400
|
- "$ref": "#/components/parameters/account_id"
|
2414
2401
|
- "$ref": "#/components/parameters/billing_info_id"
|
2415
2402
|
responses:
|
@@ -2451,7 +2438,6 @@ paths:
|
|
2451
2438
|
- gateway_token
|
2452
2439
|
- gateway_code
|
2453
2440
|
parameters:
|
2454
|
-
- "$ref": "#/components/parameters/site_id"
|
2455
2441
|
- "$ref": "#/components/parameters/account_id"
|
2456
2442
|
- "$ref": "#/components/parameters/billing_info_id"
|
2457
2443
|
requestBody:
|
@@ -2493,7 +2479,6 @@ paths:
|
|
2493
2479
|
operationId: remove_a_billing_info
|
2494
2480
|
summary: Remove an account's billing information
|
2495
2481
|
parameters:
|
2496
|
-
- "$ref": "#/components/parameters/site_id"
|
2497
2482
|
- "$ref": "#/components/parameters/account_id"
|
2498
2483
|
- "$ref": "#/components/parameters/billing_info_id"
|
2499
2484
|
description: You may remove any stored billing information for an account. If
|
@@ -2526,7 +2511,6 @@ paths:
|
|
2526
2511
|
description: See the [Pagination Guide](/guides/pagination.html) to learn how
|
2527
2512
|
to use pagination in the API and Client Libraries.
|
2528
2513
|
parameters:
|
2529
|
-
- "$ref": "#/components/parameters/site_id"
|
2530
2514
|
- "$ref": "#/components/parameters/account_id"
|
2531
2515
|
- "$ref": "#/components/parameters/ids"
|
2532
2516
|
- "$ref": "#/components/parameters/sort_dates"
|
@@ -2624,7 +2608,6 @@ paths:
|
|
2624
2608
|
description: See the [Pagination Guide](/guides/pagination.html) to learn how
|
2625
2609
|
to use pagination in the API and Client Libraries.
|
2626
2610
|
parameters:
|
2627
|
-
- "$ref": "#/components/parameters/site_id"
|
2628
2611
|
- "$ref": "#/components/parameters/account_id"
|
2629
2612
|
responses:
|
2630
2613
|
'200':
|
@@ -2707,7 +2690,6 @@ paths:
|
|
2707
2690
|
operationId: create_coupon_redemption
|
2708
2691
|
summary: Generate an active coupon redemption on an account or subscription
|
2709
2692
|
parameters:
|
2710
|
-
- "$ref": "#/components/parameters/site_id"
|
2711
2693
|
- "$ref": "#/components/parameters/account_id"
|
2712
2694
|
requestBody:
|
2713
2695
|
content:
|
@@ -2838,7 +2820,6 @@ paths:
|
|
2838
2820
|
operationId: remove_coupon_redemption
|
2839
2821
|
summary: Delete the active coupon redemption from an account
|
2840
2822
|
parameters:
|
2841
|
-
- "$ref": "#/components/parameters/site_id"
|
2842
2823
|
- "$ref": "#/components/parameters/account_id"
|
2843
2824
|
responses:
|
2844
2825
|
'200':
|
@@ -2955,7 +2936,6 @@ paths:
|
|
2955
2936
|
description: See the [Pagination Guide](/guides/pagination.html) to learn how
|
2956
2937
|
to use pagination in the API and Client Libraries.
|
2957
2938
|
parameters:
|
2958
|
-
- "$ref": "#/components/parameters/site_id"
|
2959
2939
|
- "$ref": "#/components/parameters/account_id"
|
2960
2940
|
- "$ref": "#/components/parameters/limit"
|
2961
2941
|
- "$ref": "#/components/parameters/order"
|
@@ -3063,7 +3043,6 @@ paths:
|
|
3063
3043
|
description: See the [Pagination Guide](/guides/pagination.html) to learn how
|
3064
3044
|
to use pagination in the API and Client Libraries.
|
3065
3045
|
parameters:
|
3066
|
-
- "$ref": "#/components/parameters/site_id"
|
3067
3046
|
- "$ref": "#/components/parameters/account_id"
|
3068
3047
|
- "$ref": "#/components/parameters/ids"
|
3069
3048
|
- "$ref": "#/components/parameters/limit"
|
@@ -3165,7 +3144,6 @@ paths:
|
|
3165
3144
|
operationId: create_invoice
|
3166
3145
|
summary: Create an invoice for pending line items
|
3167
3146
|
parameters:
|
3168
|
-
- "$ref": "#/components/parameters/site_id"
|
3169
3147
|
- "$ref": "#/components/parameters/account_id"
|
3170
3148
|
requestBody:
|
3171
3149
|
content:
|
@@ -3336,7 +3314,6 @@ paths:
|
|
3336
3314
|
operationId: preview_invoice
|
3337
3315
|
summary: Preview new invoice for pending line items
|
3338
3316
|
parameters:
|
3339
|
-
- "$ref": "#/components/parameters/site_id"
|
3340
3317
|
- "$ref": "#/components/parameters/account_id"
|
3341
3318
|
requestBody:
|
3342
3319
|
content:
|
@@ -3508,7 +3485,6 @@ paths:
|
|
3508
3485
|
description: See the [Pagination Guide](/guides/pagination.html) to learn how
|
3509
3486
|
to use pagination in the API and Client Libraries.
|
3510
3487
|
parameters:
|
3511
|
-
- "$ref": "#/components/parameters/site_id"
|
3512
3488
|
- "$ref": "#/components/parameters/account_id"
|
3513
3489
|
- "$ref": "#/components/parameters/ids"
|
3514
3490
|
- "$ref": "#/components/parameters/limit"
|
@@ -3613,7 +3589,6 @@ paths:
|
|
3613
3589
|
operationId: create_line_item
|
3614
3590
|
summary: Create a new line item for the account
|
3615
3591
|
parameters:
|
3616
|
-
- "$ref": "#/components/parameters/site_id"
|
3617
3592
|
- "$ref": "#/components/parameters/account_id"
|
3618
3593
|
requestBody:
|
3619
3594
|
content:
|
@@ -3784,7 +3759,6 @@ paths:
|
|
3784
3759
|
description: See the [Pagination Guide](/guides/pagination.html) to learn how
|
3785
3760
|
to use pagination in the API and Client Libraries.
|
3786
3761
|
parameters:
|
3787
|
-
- "$ref": "#/components/parameters/site_id"
|
3788
3762
|
- "$ref": "#/components/parameters/account_id"
|
3789
3763
|
- "$ref": "#/components/parameters/ids"
|
3790
3764
|
responses:
|
@@ -3871,7 +3845,6 @@ paths:
|
|
3871
3845
|
operationId: get_account_note
|
3872
3846
|
summary: Fetch an account note
|
3873
3847
|
parameters:
|
3874
|
-
- "$ref": "#/components/parameters/site_id"
|
3875
3848
|
- "$ref": "#/components/parameters/account_id"
|
3876
3849
|
- name: account_note_id
|
3877
3850
|
in: path
|
@@ -4000,7 +3973,6 @@ paths:
|
|
4000
3973
|
description: See the [Pagination Guide](/guides/pagination.html) to learn how
|
4001
3974
|
to use pagination in the API and Client Libraries.
|
4002
3975
|
parameters:
|
4003
|
-
- "$ref": "#/components/parameters/site_id"
|
4004
3976
|
- "$ref": "#/components/parameters/account_id"
|
4005
3977
|
- "$ref": "#/components/parameters/ids"
|
4006
3978
|
- "$ref": "#/components/parameters/limit"
|
@@ -4095,7 +4067,6 @@ paths:
|
|
4095
4067
|
operationId: create_shipping_address
|
4096
4068
|
summary: Create a new shipping address for the account
|
4097
4069
|
parameters:
|
4098
|
-
- "$ref": "#/components/parameters/site_id"
|
4099
4070
|
- "$ref": "#/components/parameters/account_id"
|
4100
4071
|
requestBody:
|
4101
4072
|
content:
|
@@ -4285,7 +4256,6 @@ paths:
|
|
4285
4256
|
operationId: get_shipping_address
|
4286
4257
|
summary: Fetch an account's shipping address
|
4287
4258
|
parameters:
|
4288
|
-
- "$ref": "#/components/parameters/site_id"
|
4289
4259
|
- "$ref": "#/components/parameters/account_id"
|
4290
4260
|
- "$ref": "#/components/parameters/shipping_address_id"
|
4291
4261
|
responses:
|
@@ -4405,7 +4375,6 @@ paths:
|
|
4405
4375
|
operationId: update_shipping_address
|
4406
4376
|
summary: Update an account's shipping address
|
4407
4377
|
parameters:
|
4408
|
-
- "$ref": "#/components/parameters/site_id"
|
4409
4378
|
- "$ref": "#/components/parameters/account_id"
|
4410
4379
|
- "$ref": "#/components/parameters/shipping_address_id"
|
4411
4380
|
requestBody:
|
@@ -4576,7 +4545,6 @@ paths:
|
|
4576
4545
|
operationId: remove_shipping_address
|
4577
4546
|
summary: Remove an account's shipping address
|
4578
4547
|
parameters:
|
4579
|
-
- "$ref": "#/components/parameters/site_id"
|
4580
4548
|
- "$ref": "#/components/parameters/account_id"
|
4581
4549
|
- "$ref": "#/components/parameters/shipping_address_id"
|
4582
4550
|
responses:
|
@@ -4687,7 +4655,6 @@ paths:
|
|
4687
4655
|
description: See the [Pagination Guide](/guides/pagination.html) to learn how
|
4688
4656
|
to use pagination in the API and Client Libraries.
|
4689
4657
|
parameters:
|
4690
|
-
- "$ref": "#/components/parameters/site_id"
|
4691
4658
|
- "$ref": "#/components/parameters/account_id"
|
4692
4659
|
- "$ref": "#/components/parameters/ids"
|
4693
4660
|
- "$ref": "#/components/parameters/limit"
|
@@ -4792,7 +4759,6 @@ paths:
|
|
4792
4759
|
description: See the [Pagination Guide](/guides/pagination.html) to learn how
|
4793
4760
|
to use pagination in the API and Client Libraries.
|
4794
4761
|
parameters:
|
4795
|
-
- "$ref": "#/components/parameters/site_id"
|
4796
4762
|
- "$ref": "#/components/parameters/account_id"
|
4797
4763
|
- "$ref": "#/components/parameters/ids"
|
4798
4764
|
- "$ref": "#/components/parameters/limit"
|
@@ -4899,7 +4865,6 @@ paths:
|
|
4899
4865
|
description: See the [Pagination Guide](/guides/pagination.html) to learn how
|
4900
4866
|
to use pagination in the API and Client Libraries.
|
4901
4867
|
parameters:
|
4902
|
-
- "$ref": "#/components/parameters/site_id"
|
4903
4868
|
- "$ref": "#/components/parameters/account_id"
|
4904
4869
|
- "$ref": "#/components/parameters/ids"
|
4905
4870
|
- "$ref": "#/components/parameters/limit"
|
@@ -4983,7 +4948,6 @@ paths:
|
|
4983
4948
|
description: See the [Pagination Guide](/guides/pagination.html) to learn how
|
4984
4949
|
to use pagination in the API and Client Libraries.
|
4985
4950
|
parameters:
|
4986
|
-
- "$ref": "#/components/parameters/site_id"
|
4987
4951
|
- "$ref": "#/components/parameters/ids"
|
4988
4952
|
- "$ref": "#/components/parameters/limit"
|
4989
4953
|
- "$ref": "#/components/parameters/order"
|
@@ -5083,7 +5047,6 @@ paths:
|
|
5083
5047
|
description: See the [Pagination Guide](/guides/pagination.html) to learn how
|
5084
5048
|
to use pagination in the API and Client Libraries.
|
5085
5049
|
parameters:
|
5086
|
-
- "$ref": "#/components/parameters/site_id"
|
5087
5050
|
- "$ref": "#/components/parameters/ids"
|
5088
5051
|
- "$ref": "#/components/parameters/limit"
|
5089
5052
|
- "$ref": "#/components/parameters/order"
|
@@ -5183,8 +5146,6 @@ paths:
|
|
5183
5146
|
- coupon
|
5184
5147
|
operationId: create_coupon
|
5185
5148
|
summary: Create a new coupon
|
5186
|
-
parameters:
|
5187
|
-
- "$ref": "#/components/parameters/site_id"
|
5188
5149
|
requestBody:
|
5189
5150
|
content:
|
5190
5151
|
application/json:
|
@@ -5384,7 +5345,6 @@ paths:
|
|
5384
5345
|
operationId: get_coupon
|
5385
5346
|
summary: Fetch a coupon
|
5386
5347
|
parameters:
|
5387
|
-
- "$ref": "#/components/parameters/site_id"
|
5388
5348
|
- "$ref": "#/components/parameters/coupon_id"
|
5389
5349
|
responses:
|
5390
5350
|
'200':
|
@@ -5500,7 +5460,6 @@ paths:
|
|
5500
5460
|
operationId: update_coupon
|
5501
5461
|
summary: Update an active coupon
|
5502
5462
|
parameters:
|
5503
|
-
- "$ref": "#/components/parameters/site_id"
|
5504
5463
|
- "$ref": "#/components/parameters/coupon_id"
|
5505
5464
|
requestBody:
|
5506
5465
|
content:
|
@@ -5654,7 +5613,6 @@ paths:
|
|
5654
5613
|
operationId: deactivate_coupon
|
5655
5614
|
summary: Expire a coupon
|
5656
5615
|
parameters:
|
5657
|
-
- "$ref": "#/components/parameters/site_id"
|
5658
5616
|
- "$ref": "#/components/parameters/coupon_id"
|
5659
5617
|
description: Mark an existing Coupon as expired
|
5660
5618
|
responses:
|
@@ -5760,7 +5718,6 @@ paths:
|
|
5760
5718
|
operationId: generate_unique_coupon_codes
|
5761
5719
|
summary: Generate unique coupon codes
|
5762
5720
|
parameters:
|
5763
|
-
- "$ref": "#/components/parameters/site_id"
|
5764
5721
|
- "$ref": "#/components/parameters/coupon_id"
|
5765
5722
|
requestBody:
|
5766
5723
|
content:
|
@@ -5806,7 +5763,6 @@ paths:
|
|
5806
5763
|
description: Make an expired coupon redeemable again. You can change editable
|
5807
5764
|
fields in this call.
|
5808
5765
|
parameters:
|
5809
|
-
- "$ref": "#/components/parameters/site_id"
|
5810
5766
|
- "$ref": "#/components/parameters/coupon_id"
|
5811
5767
|
requestBody:
|
5812
5768
|
content:
|
@@ -5855,7 +5811,6 @@ paths:
|
|
5855
5811
|
description: See the [Pagination Guide](/guides/pagination.html) to learn how
|
5856
5812
|
to use pagination in the API and Client Libraries.
|
5857
5813
|
parameters:
|
5858
|
-
- "$ref": "#/components/parameters/site_id"
|
5859
5814
|
- "$ref": "#/components/parameters/coupon_id"
|
5860
5815
|
- "$ref": "#/components/parameters/ids"
|
5861
5816
|
- "$ref": "#/components/parameters/limit"
|
@@ -5892,7 +5847,6 @@ paths:
|
|
5892
5847
|
description: See the [Pagination Guide](/guides/pagination.html) to learn how
|
5893
5848
|
to use pagination in the API and Client Libraries.
|
5894
5849
|
parameters:
|
5895
|
-
- "$ref": "#/components/parameters/site_id"
|
5896
5850
|
- "$ref": "#/components/parameters/limit"
|
5897
5851
|
- "$ref": "#/components/parameters/order"
|
5898
5852
|
- "$ref": "#/components/parameters/sort_dates"
|
@@ -5993,7 +5947,6 @@ paths:
|
|
5993
5947
|
operationId: get_credit_payment
|
5994
5948
|
summary: Fetch a credit payment
|
5995
5949
|
parameters:
|
5996
|
-
- "$ref": "#/components/parameters/site_id"
|
5997
5950
|
- "$ref": "#/components/parameters/credit_payment_id"
|
5998
5951
|
responses:
|
5999
5952
|
'200':
|
@@ -6024,7 +5977,6 @@ paths:
|
|
6024
5977
|
description: See the [Pagination Guide](/guides/pagination.html) to learn how
|
6025
5978
|
to use pagination in the API and Client Libraries.
|
6026
5979
|
parameters:
|
6027
|
-
- "$ref": "#/components/parameters/site_id"
|
6028
5980
|
- "$ref": "#/components/parameters/ids"
|
6029
5981
|
- "$ref": "#/components/parameters/limit"
|
6030
5982
|
- "$ref": "#/components/parameters/order"
|
@@ -6132,7 +6084,6 @@ paths:
|
|
6132
6084
|
operationId: get_custom_field_definition
|
6133
6085
|
summary: Fetch an custom field definition
|
6134
6086
|
parameters:
|
6135
|
-
- "$ref": "#/components/parameters/site_id"
|
6136
6087
|
- "$ref": "#/components/parameters/custom_field_definition_id"
|
6137
6088
|
responses:
|
6138
6089
|
'200':
|
@@ -6251,7 +6202,6 @@ paths:
|
|
6251
6202
|
description: See the [Pagination Guide](/guides/pagination.html) to learn how
|
6252
6203
|
to use pagination in the API and Client Libraries.
|
6253
6204
|
parameters:
|
6254
|
-
- "$ref": "#/components/parameters/site_id"
|
6255
6205
|
- "$ref": "#/components/parameters/ids"
|
6256
6206
|
- "$ref": "#/components/parameters/limit"
|
6257
6207
|
- "$ref": "#/components/parameters/order"
|
@@ -6352,8 +6302,6 @@ paths:
|
|
6352
6302
|
- item
|
6353
6303
|
operationId: create_item
|
6354
6304
|
summary: Create a new item
|
6355
|
-
parameters:
|
6356
|
-
- "$ref": "#/components/parameters/site_id"
|
6357
6305
|
requestBody:
|
6358
6306
|
content:
|
6359
6307
|
application/json:
|
@@ -6566,7 +6514,6 @@ paths:
|
|
6566
6514
|
operationId: get_item
|
6567
6515
|
summary: Fetch an item
|
6568
6516
|
parameters:
|
6569
|
-
- "$ref": "#/components/parameters/site_id"
|
6570
6517
|
- "$ref": "#/components/parameters/item_id"
|
6571
6518
|
responses:
|
6572
6519
|
'200':
|
@@ -6682,7 +6629,6 @@ paths:
|
|
6682
6629
|
operationId: update_item
|
6683
6630
|
summary: Update an active item
|
6684
6631
|
parameters:
|
6685
|
-
- "$ref": "#/components/parameters/site_id"
|
6686
6632
|
- "$ref": "#/components/parameters/item_id"
|
6687
6633
|
requestBody:
|
6688
6634
|
content:
|
@@ -6849,7 +6795,6 @@ paths:
|
|
6849
6795
|
operationId: deactivate_item
|
6850
6796
|
summary: Deactivate an item
|
6851
6797
|
parameters:
|
6852
|
-
- "$ref": "#/components/parameters/site_id"
|
6853
6798
|
- "$ref": "#/components/parameters/item_id"
|
6854
6799
|
description: Deactivating an item makes it unavailable for new purchases. It
|
6855
6800
|
will not affect existing line items.
|
@@ -6962,7 +6907,6 @@ paths:
|
|
6962
6907
|
%s\", deactivatedItem.Code)"
|
6963
6908
|
"/items/{item_id}/reactivate":
|
6964
6909
|
parameters:
|
6965
|
-
- "$ref": "#/components/parameters/site_id"
|
6966
6910
|
- "$ref": "#/components/parameters/item_id"
|
6967
6911
|
put:
|
6968
6912
|
tags:
|
@@ -7093,7 +7037,6 @@ paths:
|
|
7093
7037
|
description: See the [Pagination Guide](/guides/pagination.html) to learn how
|
7094
7038
|
to use pagination in the API and Client Libraries.
|
7095
7039
|
parameters:
|
7096
|
-
- "$ref": "#/components/parameters/site_id"
|
7097
7040
|
- "$ref": "#/components/parameters/ids"
|
7098
7041
|
- "$ref": "#/components/parameters/limit"
|
7099
7042
|
- "$ref": "#/components/parameters/order"
|
@@ -7126,8 +7069,6 @@ paths:
|
|
7126
7069
|
- measured_unit
|
7127
7070
|
operationId: create_measured_unit
|
7128
7071
|
summary: Create a new measured unit
|
7129
|
-
parameters:
|
7130
|
-
- "$ref": "#/components/parameters/site_id"
|
7131
7072
|
requestBody:
|
7132
7073
|
content:
|
7133
7074
|
application/json:
|
@@ -7173,7 +7114,6 @@ paths:
|
|
7173
7114
|
operationId: get_measured_unit
|
7174
7115
|
summary: Fetch a measured unit
|
7175
7116
|
parameters:
|
7176
|
-
- "$ref": "#/components/parameters/site_id"
|
7177
7117
|
- "$ref": "#/components/parameters/measured_unit_id"
|
7178
7118
|
responses:
|
7179
7119
|
'200':
|
@@ -7201,7 +7141,6 @@ paths:
|
|
7201
7141
|
operationId: update_measured_unit
|
7202
7142
|
summary: Update a measured unit
|
7203
7143
|
parameters:
|
7204
|
-
- "$ref": "#/components/parameters/site_id"
|
7205
7144
|
- "$ref": "#/components/parameters/measured_unit_id"
|
7206
7145
|
requestBody:
|
7207
7146
|
content:
|
@@ -7248,7 +7187,6 @@ paths:
|
|
7248
7187
|
summary: Remove a measured unit
|
7249
7188
|
description: A mesured unit cannot be deleted if it is used by an active plan.
|
7250
7189
|
parameters:
|
7251
|
-
- "$ref": "#/components/parameters/site_id"
|
7252
7190
|
- "$ref": "#/components/parameters/measured_unit_id"
|
7253
7191
|
responses:
|
7254
7192
|
'200':
|
@@ -7279,7 +7217,6 @@ paths:
|
|
7279
7217
|
description: See the [Pagination Guide](/guides/pagination.html) to learn how
|
7280
7218
|
to use pagination in the API and Client Libraries.
|
7281
7219
|
parameters:
|
7282
|
-
- "$ref": "#/components/parameters/site_id"
|
7283
7220
|
- "$ref": "#/components/parameters/ids"
|
7284
7221
|
- "$ref": "#/components/parameters/limit"
|
7285
7222
|
- "$ref": "#/components/parameters/order"
|
@@ -7382,7 +7319,6 @@ paths:
|
|
7382
7319
|
operationId: get_invoice
|
7383
7320
|
summary: Fetch an invoice
|
7384
7321
|
parameters:
|
7385
|
-
- "$ref": "#/components/parameters/site_id"
|
7386
7322
|
- "$ref": "#/components/parameters/invoice_id"
|
7387
7323
|
responses:
|
7388
7324
|
'200':
|
@@ -7498,7 +7434,6 @@ paths:
|
|
7498
7434
|
operationId: update_invoice
|
7499
7435
|
summary: Update an invoice
|
7500
7436
|
parameters:
|
7501
|
-
- "$ref": "#/components/parameters/site_id"
|
7502
7437
|
- "$ref": "#/components/parameters/invoice_id"
|
7503
7438
|
requestBody:
|
7504
7439
|
content:
|
@@ -7650,7 +7585,6 @@ paths:
|
|
7650
7585
|
operationId: get_invoice_pdf
|
7651
7586
|
summary: Fetch an invoice as a PDF
|
7652
7587
|
parameters:
|
7653
|
-
- "$ref": "#/components/parameters/site_id"
|
7654
7588
|
- "$ref": "#/components/parameters/invoice_id"
|
7655
7589
|
responses:
|
7656
7590
|
'200':
|
@@ -7790,7 +7724,6 @@ paths:
|
|
7790
7724
|
description: Force a collection attempt using the stored billing information.
|
7791
7725
|
This will trigger a transaction outside of Recurly's normal retry logic.
|
7792
7726
|
parameters:
|
7793
|
-
- "$ref": "#/components/parameters/site_id"
|
7794
7727
|
- "$ref": "#/components/parameters/invoice_id"
|
7795
7728
|
requestBody:
|
7796
7729
|
content:
|
@@ -7923,7 +7856,6 @@ paths:
|
|
7923
7856
|
|
7924
7857
|
Only invoices with the `pending`, `processing` or `past_due` states can be marked as failed.
|
7925
7858
|
parameters:
|
7926
|
-
- "$ref": "#/components/parameters/site_id"
|
7927
7859
|
- "$ref": "#/components/parameters/invoice_id"
|
7928
7860
|
responses:
|
7929
7861
|
'200':
|
@@ -8050,7 +7982,6 @@ paths:
|
|
8050
7982
|
|
8051
7983
|
Only invoices with the `pending`, `processing`, `past_due` or `failed` states can be marked as paid.
|
8052
7984
|
parameters:
|
8053
|
-
- "$ref": "#/components/parameters/site_id"
|
8054
7985
|
- "$ref": "#/components/parameters/invoice_id"
|
8055
7986
|
responses:
|
8056
7987
|
'200':
|
@@ -8176,7 +8107,6 @@ paths:
|
|
8176
8107
|
operationId: reopen_invoice
|
8177
8108
|
summary: Reopen a closed, manual invoice
|
8178
8109
|
parameters:
|
8179
|
-
- "$ref": "#/components/parameters/site_id"
|
8180
8110
|
- "$ref": "#/components/parameters/invoice_id"
|
8181
8111
|
responses:
|
8182
8112
|
'200':
|
@@ -8302,7 +8232,6 @@ paths:
|
|
8302
8232
|
description: Invoice must be a credit invoice (`type=credit`) and cannot be
|
8303
8233
|
closed (`state=closed`), processing (`state=processing`), or already voided.
|
8304
8234
|
parameters:
|
8305
|
-
- "$ref": "#/components/parameters/site_id"
|
8306
8235
|
- "$ref": "#/components/parameters/invoice_id"
|
8307
8236
|
responses:
|
8308
8237
|
'200':
|
@@ -8410,7 +8339,6 @@ paths:
|
|
8410
8339
|
not captured through your gateway. It will throw an error for an auto-collecting
|
8411
8340
|
invoice.
|
8412
8341
|
parameters:
|
8413
|
-
- "$ref": "#/components/parameters/site_id"
|
8414
8342
|
- "$ref": "#/components/parameters/invoice_id"
|
8415
8343
|
requestBody:
|
8416
8344
|
content:
|
@@ -8474,7 +8402,6 @@ paths:
|
|
8474
8402
|
description: See the [Pagination Guide](/guides/pagination.html) to learn how
|
8475
8403
|
to use pagination in the API and Client Libraries.
|
8476
8404
|
parameters:
|
8477
|
-
- "$ref": "#/components/parameters/site_id"
|
8478
8405
|
- "$ref": "#/components/parameters/invoice_id"
|
8479
8406
|
- "$ref": "#/components/parameters/ids"
|
8480
8407
|
- "$ref": "#/components/parameters/limit"
|
@@ -8585,7 +8512,6 @@ paths:
|
|
8585
8512
|
description: See the [Pagination Guide](/guides/pagination.html) to learn how
|
8586
8513
|
to use pagination in the API and Client Libraries.
|
8587
8514
|
parameters:
|
8588
|
-
- "$ref": "#/components/parameters/site_id"
|
8589
8515
|
- "$ref": "#/components/parameters/invoice_id"
|
8590
8516
|
- "$ref": "#/components/parameters/ids"
|
8591
8517
|
- "$ref": "#/components/parameters/sort_dates"
|
@@ -8685,7 +8611,6 @@ paths:
|
|
8685
8611
|
|
8686
8612
|
See the [Pagination Guide](/guides/pagination.html) to learn how to use pagination in the API and Client Libraries.
|
8687
8613
|
parameters:
|
8688
|
-
- "$ref": "#/components/parameters/site_id"
|
8689
8614
|
- "$ref": "#/components/parameters/invoice_id"
|
8690
8615
|
responses:
|
8691
8616
|
'200':
|
@@ -8779,7 +8704,6 @@ paths:
|
|
8779
8704
|
If you want to refund the entire refundable amount on the invoice, the
|
8780
8705
|
simplest way is to do `type=amount` without specifiying an `amount`.
|
8781
8706
|
parameters:
|
8782
|
-
- "$ref": "#/components/parameters/site_id"
|
8783
8707
|
- "$ref": "#/components/parameters/invoice_id"
|
8784
8708
|
requestBody:
|
8785
8709
|
content:
|
@@ -8942,7 +8866,6 @@ paths:
|
|
8942
8866
|
description: See the [Pagination Guide](/guides/pagination.html) to learn how
|
8943
8867
|
to use pagination in the API and Client Libraries.
|
8944
8868
|
parameters:
|
8945
|
-
- "$ref": "#/components/parameters/site_id"
|
8946
8869
|
- "$ref": "#/components/parameters/ids"
|
8947
8870
|
- "$ref": "#/components/parameters/limit"
|
8948
8871
|
- "$ref": "#/components/parameters/order"
|
@@ -9049,7 +8972,6 @@ paths:
|
|
9049
8972
|
operationId: get_line_item
|
9050
8973
|
summary: Fetch a line item
|
9051
8974
|
parameters:
|
9052
|
-
- "$ref": "#/components/parameters/site_id"
|
9053
8975
|
- "$ref": "#/components/parameters/line_item_id"
|
9054
8976
|
responses:
|
9055
8977
|
'200':
|
@@ -9165,7 +9087,6 @@ paths:
|
|
9165
9087
|
operationId: remove_line_item
|
9166
9088
|
summary: Delete an uninvoiced line item
|
9167
9089
|
parameters:
|
9168
|
-
- "$ref": "#/components/parameters/site_id"
|
9169
9090
|
- "$ref": "#/components/parameters/line_item_id"
|
9170
9091
|
responses:
|
9171
9092
|
'204':
|
@@ -9286,7 +9207,6 @@ paths:
|
|
9286
9207
|
description: See the [Pagination Guide](/guides/pagination.html) to learn how
|
9287
9208
|
to use pagination in the API and Client Libraries.
|
9288
9209
|
parameters:
|
9289
|
-
- "$ref": "#/components/parameters/site_id"
|
9290
9210
|
- "$ref": "#/components/parameters/ids"
|
9291
9211
|
- "$ref": "#/components/parameters/limit"
|
9292
9212
|
- "$ref": "#/components/parameters/order"
|
@@ -9387,8 +9307,6 @@ paths:
|
|
9387
9307
|
- plan
|
9388
9308
|
operationId: create_plan
|
9389
9309
|
summary: Create a plan
|
9390
|
-
parameters:
|
9391
|
-
- "$ref": "#/components/parameters/site_id"
|
9392
9310
|
requestBody:
|
9393
9311
|
content:
|
9394
9312
|
application/json:
|
@@ -9587,7 +9505,6 @@ paths:
|
|
9587
9505
|
operationId: get_plan
|
9588
9506
|
summary: Fetch a plan
|
9589
9507
|
parameters:
|
9590
|
-
- "$ref": "#/components/parameters/site_id"
|
9591
9508
|
- "$ref": "#/components/parameters/plan_id"
|
9592
9509
|
responses:
|
9593
9510
|
'200':
|
@@ -9703,7 +9620,6 @@ paths:
|
|
9703
9620
|
operationId: update_plan
|
9704
9621
|
summary: Update a plan
|
9705
9622
|
parameters:
|
9706
|
-
- "$ref": "#/components/parameters/site_id"
|
9707
9623
|
- "$ref": "#/components/parameters/plan_id"
|
9708
9624
|
requestBody:
|
9709
9625
|
content:
|
@@ -9850,7 +9766,6 @@ paths:
|
|
9850
9766
|
operationId: remove_plan
|
9851
9767
|
summary: Remove a plan
|
9852
9768
|
parameters:
|
9853
|
-
- "$ref": "#/components/parameters/site_id"
|
9854
9769
|
- "$ref": "#/components/parameters/plan_id"
|
9855
9770
|
responses:
|
9856
9771
|
'200':
|
@@ -9961,7 +9876,6 @@ paths:
|
|
9961
9876
|
description: See the [Pagination Guide](/guides/pagination.html) to learn how
|
9962
9877
|
to use pagination in the API and Client Libraries.
|
9963
9878
|
parameters:
|
9964
|
-
- "$ref": "#/components/parameters/site_id"
|
9965
9879
|
- "$ref": "#/components/parameters/plan_id"
|
9966
9880
|
- "$ref": "#/components/parameters/ids"
|
9967
9881
|
- "$ref": "#/components/parameters/limit"
|
@@ -10063,7 +9977,6 @@ paths:
|
|
10063
9977
|
operationId: create_plan_add_on
|
10064
9978
|
summary: Create an add-on
|
10065
9979
|
parameters:
|
10066
|
-
- "$ref": "#/components/parameters/site_id"
|
10067
9980
|
- "$ref": "#/components/parameters/plan_id"
|
10068
9981
|
requestBody:
|
10069
9982
|
content:
|
@@ -10261,7 +10174,6 @@ paths:
|
|
10261
10174
|
operationId: get_plan_add_on
|
10262
10175
|
summary: Fetch a plan's add-on
|
10263
10176
|
parameters:
|
10264
|
-
- "$ref": "#/components/parameters/site_id"
|
10265
10177
|
- "$ref": "#/components/parameters/plan_id"
|
10266
10178
|
- "$ref": "#/components/parameters/add_on_id"
|
10267
10179
|
responses:
|
@@ -10380,7 +10292,6 @@ paths:
|
|
10380
10292
|
operationId: update_plan_add_on
|
10381
10293
|
summary: Update an add-on
|
10382
10294
|
parameters:
|
10383
|
-
- "$ref": "#/components/parameters/site_id"
|
10384
10295
|
- "$ref": "#/components/parameters/plan_id"
|
10385
10296
|
- "$ref": "#/components/parameters/add_on_id"
|
10386
10297
|
requestBody:
|
@@ -10523,7 +10434,6 @@ paths:
|
|
10523
10434
|
operationId: remove_plan_add_on
|
10524
10435
|
summary: Remove an add-on
|
10525
10436
|
parameters:
|
10526
|
-
- "$ref": "#/components/parameters/site_id"
|
10527
10437
|
- "$ref": "#/components/parameters/plan_id"
|
10528
10438
|
- "$ref": "#/components/parameters/add_on_id"
|
10529
10439
|
responses:
|
@@ -10632,7 +10542,6 @@ paths:
|
|
10632
10542
|
description: See the [Pagination Guide](/guides/pagination.html) to learn how
|
10633
10543
|
to use pagination in the API and Client Libraries.
|
10634
10544
|
parameters:
|
10635
|
-
- "$ref": "#/components/parameters/site_id"
|
10636
10545
|
- "$ref": "#/components/parameters/ids"
|
10637
10546
|
- "$ref": "#/components/parameters/limit"
|
10638
10547
|
- "$ref": "#/components/parameters/order"
|
@@ -10733,7 +10642,6 @@ paths:
|
|
10733
10642
|
operationId: get_add_on
|
10734
10643
|
summary: Fetch an add-on
|
10735
10644
|
parameters:
|
10736
|
-
- "$ref": "#/components/parameters/site_id"
|
10737
10645
|
- "$ref": "#/components/parameters/add_on_id"
|
10738
10646
|
responses:
|
10739
10647
|
'200':
|
@@ -10852,7 +10760,6 @@ paths:
|
|
10852
10760
|
description: See the [Pagination Guide](/guides/pagination.html) to learn how
|
10853
10761
|
to use pagination in the API and Client Libraries.
|
10854
10762
|
parameters:
|
10855
|
-
- "$ref": "#/components/parameters/site_id"
|
10856
10763
|
- "$ref": "#/components/parameters/ids"
|
10857
10764
|
- "$ref": "#/components/parameters/limit"
|
10858
10765
|
- "$ref": "#/components/parameters/order"
|
@@ -10950,8 +10857,6 @@ paths:
|
|
10950
10857
|
- shipping_method
|
10951
10858
|
operationId: create_shipping_method
|
10952
10859
|
summary: Create a new shipping method
|
10953
|
-
parameters:
|
10954
|
-
- "$ref": "#/components/parameters/site_id"
|
10955
10860
|
requestBody:
|
10956
10861
|
content:
|
10957
10862
|
application/json:
|
@@ -10997,7 +10902,6 @@ paths:
|
|
10997
10902
|
operationId: get_shipping_method
|
10998
10903
|
summary: Fetch a shipping method
|
10999
10904
|
parameters:
|
11000
|
-
- "$ref": "#/components/parameters/site_id"
|
11001
10905
|
- "$ref": "#/components/parameters/shipping_method_id"
|
11002
10906
|
responses:
|
11003
10907
|
'200':
|
@@ -11025,7 +10929,6 @@ paths:
|
|
11025
10929
|
operationId: update_shipping_method
|
11026
10930
|
summary: Update an active Shipping Method
|
11027
10931
|
parameters:
|
11028
|
-
- "$ref": "#/components/parameters/site_id"
|
11029
10932
|
- "$ref": "#/components/parameters/shipping_method_id"
|
11030
10933
|
requestBody:
|
11031
10934
|
content:
|
@@ -11071,7 +10974,6 @@ paths:
|
|
11071
10974
|
operationId: deactivate_shipping_method
|
11072
10975
|
summary: Deactivate a shipping method
|
11073
10976
|
parameters:
|
11074
|
-
- "$ref": "#/components/parameters/site_id"
|
11075
10977
|
- "$ref": "#/components/parameters/shipping_method_id"
|
11076
10978
|
description: Deactivating a shipping method makes it unavailable for new subscriptions
|
11077
10979
|
or purchases. It will not affect existing subscriptions.
|
@@ -11104,7 +11006,6 @@ paths:
|
|
11104
11006
|
description: See the [Pagination Guide](/guides/pagination.html) to learn how
|
11105
11007
|
to use pagination in the API and Client Libraries.
|
11106
11008
|
parameters:
|
11107
|
-
- "$ref": "#/components/parameters/site_id"
|
11108
11009
|
- "$ref": "#/components/parameters/ids"
|
11109
11010
|
- "$ref": "#/components/parameters/limit"
|
11110
11011
|
- "$ref": "#/components/parameters/order"
|
@@ -11205,8 +11106,6 @@ paths:
|
|
11205
11106
|
- subscription
|
11206
11107
|
operationId: create_subscription
|
11207
11108
|
summary: Create a new subscription
|
11208
|
-
parameters:
|
11209
|
-
- "$ref": "#/components/parameters/site_id"
|
11210
11109
|
requestBody:
|
11211
11110
|
content:
|
11212
11111
|
application/json:
|
@@ -11385,7 +11284,6 @@ paths:
|
|
11385
11284
|
operationId: get_subscription
|
11386
11285
|
summary: Fetch a subscription
|
11387
11286
|
parameters:
|
11388
|
-
- "$ref": "#/components/parameters/site_id"
|
11389
11287
|
- "$ref": "#/components/parameters/subscription_id"
|
11390
11288
|
responses:
|
11391
11289
|
'200':
|
@@ -11506,7 +11404,6 @@ paths:
|
|
11506
11404
|
impact on the billed amount. Use the [Create Subscription Change](#operation/create_subscription_change)
|
11507
11405
|
endpoint to make those changes.
|
11508
11406
|
parameters:
|
11509
|
-
- "$ref": "#/components/parameters/site_id"
|
11510
11407
|
- "$ref": "#/components/parameters/subscription_id"
|
11511
11408
|
requestBody:
|
11512
11409
|
content:
|
@@ -11655,7 +11552,6 @@ paths:
|
|
11655
11552
|
|
11656
11553
|
If the subscription has a paid invoice you may choose to refund all, part or none of last invoice's amount.
|
11657
11554
|
parameters:
|
11658
|
-
- "$ref": "#/components/parameters/site_id"
|
11659
11555
|
- "$ref": "#/components/parameters/subscription_id"
|
11660
11556
|
- name: refund
|
11661
11557
|
in: query
|
@@ -11818,7 +11714,6 @@ paths:
|
|
11818
11714
|
until the end of the billing cycle. When a future subscription (`state=future`)
|
11819
11715
|
is canceled it becomes failed `state=failed` and cannot be reactivated.
|
11820
11716
|
parameters:
|
11821
|
-
- "$ref": "#/components/parameters/site_id"
|
11822
11717
|
- "$ref": "#/components/parameters/subscription_id"
|
11823
11718
|
requestBody:
|
11824
11719
|
content:
|
@@ -11955,7 +11850,6 @@ paths:
|
|
11955
11850
|
|
11956
11851
|
Expired or failed subscriptions cannot be reactivated; instead a new subscription plan will need to be applied to the account.
|
11957
11852
|
parameters:
|
11958
|
-
- "$ref": "#/components/parameters/site_id"
|
11959
11853
|
- "$ref": "#/components/parameters/subscription_id"
|
11960
11854
|
responses:
|
11961
11855
|
'200':
|
@@ -12089,7 +11983,6 @@ paths:
|
|
12089
11983
|
|
12090
11984
|
Expired, cancelled, or failed subscriptions cannot be paused.
|
12091
11985
|
parameters:
|
12092
|
-
- "$ref": "#/components/parameters/site_id"
|
12093
11986
|
- "$ref": "#/components/parameters/subscription_id"
|
12094
11987
|
requestBody:
|
12095
11988
|
content:
|
@@ -12243,7 +12136,6 @@ paths:
|
|
12243
12136
|
The subscription must be in the paused state. Active, expired, cancelled,
|
12244
12137
|
or failed subscriptions cannot be resumed.
|
12245
12138
|
parameters:
|
12246
|
-
- "$ref": "#/components/parameters/site_id"
|
12247
12139
|
- "$ref": "#/components/parameters/subscription_id"
|
12248
12140
|
responses:
|
12249
12141
|
'200':
|
@@ -12374,7 +12266,6 @@ paths:
|
|
12374
12266
|
in trial. The subscription must be in a trial. Active, paused, expired, cancelled,
|
12375
12267
|
or failed subscriptions cannot be converted.
|
12376
12268
|
parameters:
|
12377
|
-
- "$ref": "#/components/parameters/site_id"
|
12378
12269
|
- "$ref": "#/components/parameters/subscription_id"
|
12379
12270
|
responses:
|
12380
12271
|
'200':
|
@@ -12410,7 +12301,6 @@ paths:
|
|
12410
12301
|
operationId: get_subscription_change
|
12411
12302
|
summary: Fetch a subscription's pending change
|
12412
12303
|
parameters:
|
12413
|
-
- "$ref": "#/components/parameters/site_id"
|
12414
12304
|
- "$ref": "#/components/parameters/subscription_id"
|
12415
12305
|
responses:
|
12416
12306
|
'200':
|
@@ -12542,7 +12432,6 @@ paths:
|
|
12542
12432
|
summary: Create a new subscription change
|
12543
12433
|
description: Calling this will overwrite an existing, pending subscription change.
|
12544
12434
|
parameters:
|
12545
|
-
- "$ref": "#/components/parameters/site_id"
|
12546
12435
|
- "$ref": "#/components/parameters/subscription_id"
|
12547
12436
|
requestBody:
|
12548
12437
|
content:
|
@@ -12700,7 +12589,6 @@ paths:
|
|
12700
12589
|
operationId: remove_subscription_change
|
12701
12590
|
summary: Delete the pending subscription change
|
12702
12591
|
parameters:
|
12703
|
-
- "$ref": "#/components/parameters/site_id"
|
12704
12592
|
- "$ref": "#/components/parameters/subscription_id"
|
12705
12593
|
description: Deleting the pending subscription change will cause the current
|
12706
12594
|
subscription settings to be used on the next renewal.
|
@@ -12817,7 +12705,6 @@ paths:
|
|
12817
12705
|
description: Calling this will not save the subscription change or overwrite
|
12818
12706
|
an existing change.
|
12819
12707
|
parameters:
|
12820
|
-
- "$ref": "#/components/parameters/site_id"
|
12821
12708
|
- "$ref": "#/components/parameters/subscription_id"
|
12822
12709
|
requestBody:
|
12823
12710
|
content:
|
@@ -12861,7 +12748,6 @@ paths:
|
|
12861
12748
|
description: See the [Pagination Guide](/guides/pagination.html) to learn how
|
12862
12749
|
to use pagination in the API and Client Libraries.
|
12863
12750
|
parameters:
|
12864
|
-
- "$ref": "#/components/parameters/site_id"
|
12865
12751
|
- "$ref": "#/components/parameters/subscription_id"
|
12866
12752
|
- "$ref": "#/components/parameters/ids"
|
12867
12753
|
- "$ref": "#/components/parameters/limit"
|
@@ -12966,7 +12852,6 @@ paths:
|
|
12966
12852
|
description: See the [Pagination Guide](/guides/pagination.html) to learn how
|
12967
12853
|
to use pagination in the API and Client Libraries.
|
12968
12854
|
parameters:
|
12969
|
-
- "$ref": "#/components/parameters/site_id"
|
12970
12855
|
- "$ref": "#/components/parameters/subscription_id"
|
12971
12856
|
- "$ref": "#/components/parameters/ids"
|
12972
12857
|
- "$ref": "#/components/parameters/limit"
|
@@ -13074,7 +12959,6 @@ paths:
|
|
13074
12959
|
description: See the [Pagination Guide](/guides/pagination.html) to learn how
|
13075
12960
|
to use pagination in the API and Client Libraries.
|
13076
12961
|
parameters:
|
13077
|
-
- "$ref": "#/components/parameters/site_id"
|
13078
12962
|
- "$ref": "#/components/parameters/subscription_id"
|
13079
12963
|
- "$ref": "#/components/parameters/ids"
|
13080
12964
|
- "$ref": "#/components/parameters/sort_dates"
|
@@ -13170,7 +13054,6 @@ paths:
|
|
13170
13054
|
operationId: list_usage
|
13171
13055
|
summary: List a subscription add-on's usage records
|
13172
13056
|
parameters:
|
13173
|
-
- "$ref": "#/components/parameters/site_id"
|
13174
13057
|
- "$ref": "#/components/parameters/subscription_id"
|
13175
13058
|
- "$ref": "#/components/parameters/add_on_id"
|
13176
13059
|
- "$ref": "#/components/parameters/ids"
|
@@ -13212,7 +13095,6 @@ paths:
|
|
13212
13095
|
operationId: create_usage
|
13213
13096
|
summary: Log a usage record on this subscription add-on
|
13214
13097
|
parameters:
|
13215
|
-
- "$ref": "#/components/parameters/site_id"
|
13216
13098
|
- "$ref": "#/components/parameters/subscription_id"
|
13217
13099
|
- "$ref": "#/components/parameters/add_on_id"
|
13218
13100
|
requestBody:
|
@@ -13260,7 +13142,6 @@ paths:
|
|
13260
13142
|
operationId: get_usage
|
13261
13143
|
summary: Get a usage record
|
13262
13144
|
parameters:
|
13263
|
-
- "$ref": "#/components/parameters/site_id"
|
13264
13145
|
- "$ref": "#/components/parameters/usage_id"
|
13265
13146
|
responses:
|
13266
13147
|
'200':
|
@@ -13294,7 +13175,6 @@ paths:
|
|
13294
13175
|
operationId: update_usage
|
13295
13176
|
summary: Update a usage record
|
13296
13177
|
parameters:
|
13297
|
-
- "$ref": "#/components/parameters/site_id"
|
13298
13178
|
- "$ref": "#/components/parameters/usage_id"
|
13299
13179
|
requestBody:
|
13300
13180
|
content:
|
@@ -13340,7 +13220,6 @@ paths:
|
|
13340
13220
|
operationId: remove_usage
|
13341
13221
|
summary: Delete a usage record.
|
13342
13222
|
parameters:
|
13343
|
-
- "$ref": "#/components/parameters/site_id"
|
13344
13223
|
- "$ref": "#/components/parameters/usage_id"
|
13345
13224
|
responses:
|
13346
13225
|
'204':
|
@@ -13379,7 +13258,6 @@ paths:
|
|
13379
13258
|
description: See the [Pagination Guide](/guides/pagination.html) to learn how
|
13380
13259
|
to use pagination in the API and Client Libraries.
|
13381
13260
|
parameters:
|
13382
|
-
- "$ref": "#/components/parameters/site_id"
|
13383
13261
|
- "$ref": "#/components/parameters/ids"
|
13384
13262
|
- "$ref": "#/components/parameters/limit"
|
13385
13263
|
- "$ref": "#/components/parameters/order"
|
@@ -13483,7 +13361,6 @@ paths:
|
|
13483
13361
|
operationId: get_transaction
|
13484
13362
|
summary: Fetch a transaction
|
13485
13363
|
parameters:
|
13486
|
-
- "$ref": "#/components/parameters/site_id"
|
13487
13364
|
- "$ref": "#/components/parameters/transaction_id"
|
13488
13365
|
responses:
|
13489
13366
|
'200':
|
@@ -13595,7 +13472,6 @@ paths:
|
|
13595
13472
|
%v\", transaction.Id)"
|
13596
13473
|
"/unique_coupon_codes/{unique_coupon_code_id}":
|
13597
13474
|
parameters:
|
13598
|
-
- "$ref": "#/components/parameters/site_id"
|
13599
13475
|
- "$ref": "#/components/parameters/unique_coupon_code_id"
|
13600
13476
|
get:
|
13601
13477
|
tags:
|
@@ -13657,7 +13533,6 @@ paths:
|
|
13657
13533
|
x-code-samples: []
|
13658
13534
|
"/unique_coupon_codes/{unique_coupon_code_id}/restore":
|
13659
13535
|
parameters:
|
13660
|
-
- "$ref": "#/components/parameters/site_id"
|
13661
13536
|
- "$ref": "#/components/parameters/unique_coupon_code_id"
|
13662
13537
|
put:
|
13663
13538
|
tags:
|
@@ -13699,8 +13574,6 @@ paths:
|
|
13699
13574
|
description: A purchase is a checkout containing at least one or more subscriptions
|
13700
13575
|
or one-time charges (line items) and supports both coupon and gift card redemptions.
|
13701
13576
|
All items purchased will be on one invoice and paid for with one transaction.
|
13702
|
-
parameters:
|
13703
|
-
- "$ref": "#/components/parameters/site_id"
|
13704
13577
|
requestBody:
|
13705
13578
|
content:
|
13706
13579
|
application/json:
|
@@ -13933,8 +13806,6 @@ paths:
|
|
13933
13806
|
description: A purchase is a checkout containing at least one or more subscriptions
|
13934
13807
|
or one-time charges (line items) and supports both coupon and gift card redemptions.
|
13935
13808
|
All items purchased will be on one invoice and paid for with one transaction.
|
13936
|
-
parameters:
|
13937
|
-
- "$ref": "#/components/parameters/site_id"
|
13938
13809
|
requestBody:
|
13939
13810
|
content:
|
13940
13811
|
application/json:
|
@@ -14156,8 +14027,6 @@ paths:
|
|
14156
14027
|
Recurly error: %v\", e)\n\treturn nil, err\n}\nfmt.Printf(\"Preview Charge
|
14157
14028
|
Invoice %v\", collection.ChargeInvoice)"
|
14158
14029
|
"/export_dates":
|
14159
|
-
parameters:
|
14160
|
-
- "$ref": "#/components/parameters/site_id"
|
14161
14030
|
get:
|
14162
14031
|
tags:
|
14163
14032
|
- automated_exports
|
@@ -14269,7 +14138,6 @@ paths:
|
|
14269
14138
|
for: \", date)\n}"
|
14270
14139
|
"/export_dates/{export_date}/export_files":
|
14271
14140
|
parameters:
|
14272
|
-
- "$ref": "#/components/parameters/site_id"
|
14273
14141
|
- "$ref": "#/components/parameters/export_date"
|
14274
14142
|
get:
|
14275
14143
|
tags:
|
@@ -19493,13 +19361,23 @@ components:
|
|
19493
19361
|
minimum: 0
|
19494
19362
|
maximum: 1000000
|
19495
19363
|
description: Allows up to 2 decimal places. Optionally, override the tiers'
|
19496
|
-
default unit amount.
|
19364
|
+
default unit amount. If add-on's `add_on_type` is `usage` and `usage_type`
|
19365
|
+
is `percentage`, cannot be provided.
|
19497
19366
|
unit_amount_decimal:
|
19498
19367
|
type: string
|
19499
19368
|
title: Unit amount decimal
|
19500
19369
|
description: |
|
19501
19370
|
Allows up to 9 decimal places. Optionally, override tiers' default unit amount.
|
19502
19371
|
If `unit_amount_decimal` is provided, `unit_amount` cannot be provided.
|
19372
|
+
If add-on's `add_on_type` is `usage` and `usage_type` is `percentage`, cannot be provided.
|
19373
|
+
usage_percentage:
|
19374
|
+
type: string
|
19375
|
+
title: Usage Percentage
|
19376
|
+
description: The percentage taken of the monetary amount of usage tracked.
|
19377
|
+
This can be up to 4 decimal places represented as a string. A value between
|
19378
|
+
0.0 and 100.0. Optionally, override tiers' default usage percentage. Required
|
19379
|
+
if add-on's `add_on_type` is `usage` and `usage_type` is `percentage`.
|
19380
|
+
Must be omitted otherwise.
|
19503
19381
|
SubscriptionCancel:
|
19504
19382
|
type: object
|
19505
19383
|
properties:
|