recurly 4.13.0 → 4.17.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/CHANGELOG.md +44 -0
- data/GETTING_STARTED.md +1 -1
- data/lib/recurly/client/operations.rb +209 -136
- data/lib/recurly/requests/account_create.rb +1 -1
- data/lib/recurly/requests/account_purchase.rb +1 -1
- data/lib/recurly/requests/account_update.rb +1 -1
- data/lib/recurly/requests/add_on_create.rb +9 -1
- data/lib/recurly/requests/add_on_update.rb +5 -1
- data/lib/recurly/requests/billing_info_create.rb +8 -0
- data/lib/recurly/requests/percentage_tier.rb +18 -0
- data/lib/recurly/requests/percentage_tiers_by_currency.rb +18 -0
- data/lib/recurly/requests/plan_create.rb +1 -1
- data/lib/recurly/requests/plan_update.rb +1 -1
- data/lib/recurly/requests/subscription_add_on_create.rb +5 -1
- data/lib/recurly/requests/subscription_add_on_percentage_tier.rb +18 -0
- data/lib/recurly/requests/subscription_add_on_tier.rb +2 -2
- data/lib/recurly/requests/subscription_add_on_update.rb +5 -1
- data/lib/recurly/requests/subscription_update.rb +1 -1
- data/lib/recurly/requests/tier.rb +2 -2
- data/lib/recurly/resources/account.rb +4 -4
- data/lib/recurly/resources/account_mini.rb +1 -1
- data/lib/recurly/resources/add_on.rb +8 -0
- data/lib/recurly/resources/invoice.rb +5 -1
- data/lib/recurly/resources/invoice_template.rb +34 -0
- data/lib/recurly/resources/percentage_tier.rb +18 -0
- data/lib/recurly/resources/{account_invoice_template.rb → percentage_tiers_by_currency.rb} +7 -7
- data/lib/recurly/resources/plan.rb +1 -1
- data/lib/recurly/resources/subscription.rb +4 -0
- data/lib/recurly/resources/subscription_add_on.rb +9 -1
- data/lib/recurly/resources/subscription_add_on_percentage_tier.rb +18 -0
- data/lib/recurly/resources/subscription_add_on_tier.rb +2 -2
- data/lib/recurly/resources/tier.rb +2 -2
- data/lib/recurly/resources/usage.rb +5 -1
- data/lib/recurly/version.rb +1 -1
- data/openapi/api.yaml +617 -78
- metadata +10 -4
@@ -10,7 +10,7 @@ module Recurly
|
|
10
10
|
|
11
11
|
# List sites
|
12
12
|
#
|
13
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/list_sites list_sites api
|
13
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/list_sites list_sites api documentation}
|
14
14
|
#
|
15
15
|
# @param params [Hash] Optional query string parameters:
|
16
16
|
# :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
|
@@ -50,7 +50,7 @@ module Recurly
|
|
50
50
|
|
51
51
|
# Fetch a site
|
52
52
|
#
|
53
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/get_site get_site api
|
53
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/get_site get_site api documentation}
|
54
54
|
#
|
55
55
|
# @param site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
|
56
56
|
# @param params [Hash] Optional query string parameters:
|
@@ -73,7 +73,7 @@ module Recurly
|
|
73
73
|
|
74
74
|
# List a site's accounts
|
75
75
|
#
|
76
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/list_accounts list_accounts api
|
76
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/list_accounts list_accounts api documentation}
|
77
77
|
#
|
78
78
|
# @param params [Hash] Optional query string parameters:
|
79
79
|
# :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
|
@@ -123,7 +123,7 @@ module Recurly
|
|
123
123
|
|
124
124
|
# Create an account
|
125
125
|
#
|
126
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/create_account create_account api
|
126
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/create_account create_account api documentation}
|
127
127
|
#
|
128
128
|
# @param body [Requests::AccountCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::AccountCreate}
|
129
129
|
# @param params [Hash] Optional query string parameters:
|
@@ -172,7 +172,7 @@ module Recurly
|
|
172
172
|
|
173
173
|
# Fetch an account
|
174
174
|
#
|
175
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/get_account get_account api
|
175
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/get_account get_account api documentation}
|
176
176
|
#
|
177
177
|
# @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
|
178
178
|
# @param params [Hash] Optional query string parameters:
|
@@ -195,7 +195,7 @@ module Recurly
|
|
195
195
|
|
196
196
|
# Update an account
|
197
197
|
#
|
198
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/update_account update_account api
|
198
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/update_account update_account api documentation}
|
199
199
|
#
|
200
200
|
# @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
|
201
201
|
# @param body [Requests::AccountUpdate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::AccountUpdate}
|
@@ -226,7 +226,7 @@ module Recurly
|
|
226
226
|
|
227
227
|
# Deactivate an account
|
228
228
|
#
|
229
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/deactivate_account deactivate_account api
|
229
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/deactivate_account deactivate_account api documentation}
|
230
230
|
#
|
231
231
|
# @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
|
232
232
|
# @param params [Hash] Optional query string parameters:
|
@@ -249,7 +249,7 @@ module Recurly
|
|
249
249
|
|
250
250
|
# Fetch an account's acquisition data
|
251
251
|
#
|
252
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/get_account_acquisition get_account_acquisition api
|
252
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/get_account_acquisition get_account_acquisition api documentation}
|
253
253
|
#
|
254
254
|
# @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
|
255
255
|
# @param params [Hash] Optional query string parameters:
|
@@ -272,7 +272,7 @@ module Recurly
|
|
272
272
|
|
273
273
|
# Update an account's acquisition data
|
274
274
|
#
|
275
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/update_account_acquisition update_account_acquisition api
|
275
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/update_account_acquisition update_account_acquisition api documentation}
|
276
276
|
#
|
277
277
|
# @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
|
278
278
|
# @param body [Requests::AccountAcquisitionUpdate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::AccountAcquisitionUpdate}
|
@@ -308,7 +308,7 @@ module Recurly
|
|
308
308
|
|
309
309
|
# Remove an account's acquisition data
|
310
310
|
#
|
311
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/remove_account_acquisition remove_account_acquisition api
|
311
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/remove_account_acquisition remove_account_acquisition api documentation}
|
312
312
|
#
|
313
313
|
# @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
|
314
314
|
# @param params [Hash] Optional query string parameters:
|
@@ -331,7 +331,7 @@ module Recurly
|
|
331
331
|
|
332
332
|
# Reactivate an inactive account
|
333
333
|
#
|
334
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/reactivate_account reactivate_account api
|
334
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/reactivate_account reactivate_account api documentation}
|
335
335
|
#
|
336
336
|
# @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
|
337
337
|
# @param params [Hash] Optional query string parameters:
|
@@ -354,7 +354,7 @@ module Recurly
|
|
354
354
|
|
355
355
|
# Fetch an account's balance and past due status
|
356
356
|
#
|
357
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/get_account_balance get_account_balance api
|
357
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/get_account_balance get_account_balance api documentation}
|
358
358
|
#
|
359
359
|
# @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
|
360
360
|
# @param params [Hash] Optional query string parameters:
|
@@ -377,7 +377,7 @@ module Recurly
|
|
377
377
|
|
378
378
|
# Fetch an account's billing information
|
379
379
|
#
|
380
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/get_billing_info get_billing_info api
|
380
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/get_billing_info get_billing_info api documentation}
|
381
381
|
#
|
382
382
|
# @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
|
383
383
|
# @param params [Hash] Optional query string parameters:
|
@@ -400,7 +400,7 @@ module Recurly
|
|
400
400
|
|
401
401
|
# Set an account's billing information
|
402
402
|
#
|
403
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/update_billing_info update_billing_info api
|
403
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/update_billing_info update_billing_info api documentation}
|
404
404
|
#
|
405
405
|
# @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
|
406
406
|
# @param body [Requests::BillingInfoCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::BillingInfoCreate}
|
@@ -431,7 +431,7 @@ module Recurly
|
|
431
431
|
|
432
432
|
# Remove an account's billing information
|
433
433
|
#
|
434
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/remove_billing_info remove_billing_info api
|
434
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/remove_billing_info remove_billing_info api documentation}
|
435
435
|
#
|
436
436
|
# @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
|
437
437
|
# @param params [Hash] Optional query string parameters:
|
@@ -454,7 +454,7 @@ module Recurly
|
|
454
454
|
|
455
455
|
# Verify an account's credit card billing information
|
456
456
|
#
|
457
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/verify_billing_info verify_billing_info api
|
457
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/verify_billing_info verify_billing_info api documentation}
|
458
458
|
#
|
459
459
|
# @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
|
460
460
|
# @param params [Hash] Optional query string parameters:
|
@@ -478,7 +478,7 @@ module Recurly
|
|
478
478
|
|
479
479
|
# Get the list of billing information associated with an account
|
480
480
|
#
|
481
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/list_billing_infos list_billing_infos api
|
481
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/list_billing_infos list_billing_infos api documentation}
|
482
482
|
#
|
483
483
|
# @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
|
484
484
|
# @param params [Hash] Optional query string parameters:
|
@@ -514,7 +514,7 @@ module Recurly
|
|
514
514
|
|
515
515
|
# Add new billing information on an account
|
516
516
|
#
|
517
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/create_billing_info create_billing_info api
|
517
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/create_billing_info create_billing_info api documentation}
|
518
518
|
#
|
519
519
|
# @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
|
520
520
|
# @param body [Requests::BillingInfoCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::BillingInfoCreate}
|
@@ -529,7 +529,7 @@ module Recurly
|
|
529
529
|
|
530
530
|
# Fetch a billing info
|
531
531
|
#
|
532
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/get_a_billing_info get_a_billing_info api
|
532
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/get_a_billing_info get_a_billing_info api documentation}
|
533
533
|
#
|
534
534
|
# @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
|
535
535
|
# @param billing_info_id [String] Billing Info ID. Can ONLY be used for sites utilizing the Wallet feature.
|
@@ -544,7 +544,7 @@ module Recurly
|
|
544
544
|
|
545
545
|
# Update an account's billing information
|
546
546
|
#
|
547
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/update_a_billing_info update_a_billing_info api
|
547
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/update_a_billing_info update_a_billing_info api documentation}
|
548
548
|
#
|
549
549
|
# @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
|
550
550
|
# @param billing_info_id [String] Billing Info ID. Can ONLY be used for sites utilizing the Wallet feature.
|
@@ -560,7 +560,7 @@ module Recurly
|
|
560
560
|
|
561
561
|
# Remove an account's billing information
|
562
562
|
#
|
563
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/remove_a_billing_info remove_a_billing_info api
|
563
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/remove_a_billing_info remove_a_billing_info api documentation}
|
564
564
|
#
|
565
565
|
# @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
|
566
566
|
# @param billing_info_id [String] Billing Info ID. Can ONLY be used for sites utilizing the Wallet feature.
|
@@ -575,7 +575,7 @@ module Recurly
|
|
575
575
|
|
576
576
|
# Show the coupon redemptions for an account
|
577
577
|
#
|
578
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/list_account_coupon_redemptions list_account_coupon_redemptions api
|
578
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/list_account_coupon_redemptions list_account_coupon_redemptions api documentation}
|
579
579
|
#
|
580
580
|
# @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
|
581
581
|
# @param params [Hash] Optional query string parameters:
|
@@ -623,7 +623,7 @@ module Recurly
|
|
623
623
|
|
624
624
|
# Show the coupon redemptions that are active on an account
|
625
625
|
#
|
626
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/list_active_coupon_redemptions list_active_coupon_redemptions api
|
626
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/list_active_coupon_redemptions list_active_coupon_redemptions api documentation}
|
627
627
|
#
|
628
628
|
# @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
|
629
629
|
# @param params [Hash] Optional query string parameters:
|
@@ -645,7 +645,7 @@ module Recurly
|
|
645
645
|
|
646
646
|
# Generate an active coupon redemption on an account or subscription
|
647
647
|
#
|
648
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/create_coupon_redemption create_coupon_redemption api
|
648
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/create_coupon_redemption create_coupon_redemption api documentation}
|
649
649
|
#
|
650
650
|
# @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
|
651
651
|
# @param body [Requests::CouponRedemptionCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::CouponRedemptionCreate}
|
@@ -676,7 +676,7 @@ module Recurly
|
|
676
676
|
|
677
677
|
# Delete the active coupon redemption from an account
|
678
678
|
#
|
679
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/remove_coupon_redemption remove_coupon_redemption api
|
679
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/remove_coupon_redemption remove_coupon_redemption api documentation}
|
680
680
|
#
|
681
681
|
# @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
|
682
682
|
# @param params [Hash] Optional query string parameters:
|
@@ -699,7 +699,7 @@ module Recurly
|
|
699
699
|
|
700
700
|
# List an account's credit payments
|
701
701
|
#
|
702
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/list_account_credit_payments list_account_credit_payments api
|
702
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/list_account_credit_payments list_account_credit_payments api documentation}
|
703
703
|
#
|
704
704
|
# @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
|
705
705
|
# @param params [Hash] Optional query string parameters:
|
@@ -736,7 +736,7 @@ module Recurly
|
|
736
736
|
|
737
737
|
# List an account's invoices
|
738
738
|
#
|
739
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/list_account_invoices list_account_invoices api
|
739
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/list_account_invoices list_account_invoices api documentation}
|
740
740
|
#
|
741
741
|
# @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
|
742
742
|
# @param params [Hash] Optional query string parameters:
|
@@ -791,7 +791,7 @@ module Recurly
|
|
791
791
|
|
792
792
|
# Create an invoice for pending line items
|
793
793
|
#
|
794
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/create_invoice create_invoice api
|
794
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/create_invoice create_invoice api documentation}
|
795
795
|
#
|
796
796
|
# @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
|
797
797
|
# @param body [Requests::InvoiceCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::InvoiceCreate}
|
@@ -822,7 +822,7 @@ module Recurly
|
|
822
822
|
|
823
823
|
# Preview new invoice for pending line items
|
824
824
|
#
|
825
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/preview_invoice preview_invoice api
|
825
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/preview_invoice preview_invoice api documentation}
|
826
826
|
#
|
827
827
|
# @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
|
828
828
|
# @param body [Requests::InvoiceCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::InvoiceCreate}
|
@@ -853,7 +853,7 @@ module Recurly
|
|
853
853
|
|
854
854
|
# List an account's line items
|
855
855
|
#
|
856
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/list_account_line_items list_account_line_items api
|
856
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/list_account_line_items list_account_line_items api documentation}
|
857
857
|
#
|
858
858
|
# @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
|
859
859
|
# @param params [Hash] Optional query string parameters:
|
@@ -905,7 +905,7 @@ module Recurly
|
|
905
905
|
|
906
906
|
# Create a new line item for the account
|
907
907
|
#
|
908
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/create_line_item create_line_item api
|
908
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/create_line_item create_line_item api documentation}
|
909
909
|
#
|
910
910
|
# @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
|
911
911
|
# @param body [Requests::LineItemCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::LineItemCreate}
|
@@ -937,7 +937,7 @@ module Recurly
|
|
937
937
|
|
938
938
|
# Fetch a list of an account's notes
|
939
939
|
#
|
940
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/list_account_notes list_account_notes api
|
940
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/list_account_notes list_account_notes api documentation}
|
941
941
|
#
|
942
942
|
# @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
|
943
943
|
# @param params [Hash] Optional query string parameters:
|
@@ -971,7 +971,7 @@ module Recurly
|
|
971
971
|
|
972
972
|
# Fetch an account note
|
973
973
|
#
|
974
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/get_account_note get_account_note api
|
974
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/get_account_note get_account_note api documentation}
|
975
975
|
#
|
976
976
|
# @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
|
977
977
|
# @param account_note_id [String] Account Note ID.
|
@@ -998,7 +998,7 @@ module Recurly
|
|
998
998
|
|
999
999
|
# Fetch a list of an account's shipping addresses
|
1000
1000
|
#
|
1001
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/list_shipping_addresses list_shipping_addresses api
|
1001
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/list_shipping_addresses list_shipping_addresses api documentation}
|
1002
1002
|
#
|
1003
1003
|
# @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
|
1004
1004
|
# @param params [Hash] Optional query string parameters:
|
@@ -1047,7 +1047,7 @@ module Recurly
|
|
1047
1047
|
|
1048
1048
|
# Create a new shipping address for the account
|
1049
1049
|
#
|
1050
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/create_shipping_address create_shipping_address api
|
1050
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/create_shipping_address create_shipping_address api documentation}
|
1051
1051
|
#
|
1052
1052
|
# @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
|
1053
1053
|
# @param body [Requests::ShippingAddressCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::ShippingAddressCreate}
|
@@ -1081,7 +1081,7 @@ module Recurly
|
|
1081
1081
|
|
1082
1082
|
# Fetch an account's shipping address
|
1083
1083
|
#
|
1084
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/get_shipping_address get_shipping_address api
|
1084
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/get_shipping_address get_shipping_address api documentation}
|
1085
1085
|
#
|
1086
1086
|
# @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
|
1087
1087
|
# @param shipping_address_id [String] Shipping Address ID.
|
@@ -1108,7 +1108,7 @@ module Recurly
|
|
1108
1108
|
|
1109
1109
|
# Update an account's shipping address
|
1110
1110
|
#
|
1111
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/update_shipping_address update_shipping_address api
|
1111
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/update_shipping_address update_shipping_address api documentation}
|
1112
1112
|
#
|
1113
1113
|
# @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
|
1114
1114
|
# @param shipping_address_id [String] Shipping Address ID.
|
@@ -1142,7 +1142,7 @@ module Recurly
|
|
1142
1142
|
|
1143
1143
|
# Remove an account's shipping address
|
1144
1144
|
#
|
1145
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/remove_shipping_address remove_shipping_address api
|
1145
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/remove_shipping_address remove_shipping_address api documentation}
|
1146
1146
|
#
|
1147
1147
|
# @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
|
1148
1148
|
# @param shipping_address_id [String] Shipping Address ID.
|
@@ -1169,7 +1169,7 @@ module Recurly
|
|
1169
1169
|
|
1170
1170
|
# List an account's subscriptions
|
1171
1171
|
#
|
1172
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/list_account_subscriptions list_account_subscriptions api
|
1172
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/list_account_subscriptions list_account_subscriptions api documentation}
|
1173
1173
|
#
|
1174
1174
|
# @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
|
1175
1175
|
# @param params [Hash] Optional query string parameters:
|
@@ -1224,7 +1224,7 @@ module Recurly
|
|
1224
1224
|
|
1225
1225
|
# List an account's transactions
|
1226
1226
|
#
|
1227
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/list_account_transactions list_account_transactions api
|
1227
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/list_account_transactions list_account_transactions api documentation}
|
1228
1228
|
#
|
1229
1229
|
# @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
|
1230
1230
|
# @param params [Hash] Optional query string parameters:
|
@@ -1275,7 +1275,7 @@ module Recurly
|
|
1275
1275
|
|
1276
1276
|
# List an account's child accounts
|
1277
1277
|
#
|
1278
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/list_child_accounts list_child_accounts api
|
1278
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/list_child_accounts list_child_accounts api documentation}
|
1279
1279
|
#
|
1280
1280
|
# @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
|
1281
1281
|
# @param params [Hash] Optional query string parameters:
|
@@ -1329,7 +1329,7 @@ module Recurly
|
|
1329
1329
|
|
1330
1330
|
# List a site's account acquisition data
|
1331
1331
|
#
|
1332
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/list_account_acquisition list_account_acquisition api
|
1332
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/list_account_acquisition list_account_acquisition api documentation}
|
1333
1333
|
#
|
1334
1334
|
# @param params [Hash] Optional query string parameters:
|
1335
1335
|
# :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
|
@@ -1374,7 +1374,7 @@ module Recurly
|
|
1374
1374
|
|
1375
1375
|
# List a site's coupons
|
1376
1376
|
#
|
1377
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/list_coupons list_coupons api
|
1377
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/list_coupons list_coupons api documentation}
|
1378
1378
|
#
|
1379
1379
|
# @param params [Hash] Optional query string parameters:
|
1380
1380
|
# :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
|
@@ -1419,7 +1419,7 @@ module Recurly
|
|
1419
1419
|
|
1420
1420
|
# Create a new coupon
|
1421
1421
|
#
|
1422
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/create_coupon create_coupon api
|
1422
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/create_coupon create_coupon api documentation}
|
1423
1423
|
#
|
1424
1424
|
# @param body [Requests::CouponCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::CouponCreate}
|
1425
1425
|
# @param params [Hash] Optional query string parameters:
|
@@ -1455,7 +1455,7 @@ module Recurly
|
|
1455
1455
|
|
1456
1456
|
# Fetch a coupon
|
1457
1457
|
#
|
1458
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/get_coupon get_coupon api
|
1458
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/get_coupon get_coupon api documentation}
|
1459
1459
|
#
|
1460
1460
|
# @param coupon_id [String] Coupon ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-10off+.
|
1461
1461
|
# @param params [Hash] Optional query string parameters:
|
@@ -1478,7 +1478,7 @@ module Recurly
|
|
1478
1478
|
|
1479
1479
|
# Update an active coupon
|
1480
1480
|
#
|
1481
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/update_coupon update_coupon api
|
1481
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/update_coupon update_coupon api documentation}
|
1482
1482
|
#
|
1483
1483
|
# @param coupon_id [String] Coupon ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-10off+.
|
1484
1484
|
# @param body [Requests::CouponUpdate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::CouponUpdate}
|
@@ -1505,7 +1505,7 @@ module Recurly
|
|
1505
1505
|
|
1506
1506
|
# Expire a coupon
|
1507
1507
|
#
|
1508
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/deactivate_coupon deactivate_coupon api
|
1508
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/deactivate_coupon deactivate_coupon api documentation}
|
1509
1509
|
#
|
1510
1510
|
# @param coupon_id [String] Coupon ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-10off+.
|
1511
1511
|
# @param params [Hash] Optional query string parameters:
|
@@ -1528,7 +1528,7 @@ module Recurly
|
|
1528
1528
|
|
1529
1529
|
# Generate unique coupon codes
|
1530
1530
|
#
|
1531
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/generate_unique_coupon_codes generate_unique_coupon_codes api
|
1531
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/generate_unique_coupon_codes generate_unique_coupon_codes api documentation}
|
1532
1532
|
#
|
1533
1533
|
# @param coupon_id [String] Coupon ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-10off+.
|
1534
1534
|
# @param body [Requests::CouponBulkCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::CouponBulkCreate}
|
@@ -1543,7 +1543,7 @@ module Recurly
|
|
1543
1543
|
|
1544
1544
|
# Restore an inactive coupon
|
1545
1545
|
#
|
1546
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/restore_coupon restore_coupon api
|
1546
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/restore_coupon restore_coupon api documentation}
|
1547
1547
|
#
|
1548
1548
|
# @param coupon_id [String] Coupon ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-10off+.
|
1549
1549
|
# @param body [Requests::CouponUpdate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::CouponUpdate}
|
@@ -1558,7 +1558,7 @@ module Recurly
|
|
1558
1558
|
|
1559
1559
|
# List unique coupon codes associated with a bulk coupon
|
1560
1560
|
#
|
1561
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/list_unique_coupon_codes list_unique_coupon_codes api
|
1561
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/list_unique_coupon_codes list_unique_coupon_codes api documentation}
|
1562
1562
|
#
|
1563
1563
|
# @param coupon_id [String] Coupon ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-10off+.
|
1564
1564
|
# @param params [Hash] Optional query string parameters:
|
@@ -1596,7 +1596,7 @@ module Recurly
|
|
1596
1596
|
|
1597
1597
|
# List a site's credit payments
|
1598
1598
|
#
|
1599
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/list_credit_payments list_credit_payments api
|
1599
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/list_credit_payments list_credit_payments api documentation}
|
1600
1600
|
#
|
1601
1601
|
# @param params [Hash] Optional query string parameters:
|
1602
1602
|
# :limit [Integer] Limit number of records 1-200.
|
@@ -1629,7 +1629,7 @@ module Recurly
|
|
1629
1629
|
|
1630
1630
|
# Fetch a credit payment
|
1631
1631
|
#
|
1632
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/get_credit_payment get_credit_payment api
|
1632
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/get_credit_payment get_credit_payment api documentation}
|
1633
1633
|
#
|
1634
1634
|
# @param credit_payment_id [String] Credit Payment ID or UUID. For ID no prefix is used e.g. +e28zov4fw0v2+. For UUID use prefix +uuid-+, e.g. +uuid-123457890+.
|
1635
1635
|
# @param params [Hash] Optional query string parameters:
|
@@ -1643,7 +1643,7 @@ module Recurly
|
|
1643
1643
|
|
1644
1644
|
# List a site's custom field definitions
|
1645
1645
|
#
|
1646
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/list_custom_field_definitions list_custom_field_definitions api
|
1646
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/list_custom_field_definitions list_custom_field_definitions api documentation}
|
1647
1647
|
#
|
1648
1648
|
# @param params [Hash] Optional query string parameters:
|
1649
1649
|
# :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
|
@@ -1689,7 +1689,7 @@ module Recurly
|
|
1689
1689
|
|
1690
1690
|
# Fetch an custom field definition
|
1691
1691
|
#
|
1692
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/get_custom_field_definition get_custom_field_definition api
|
1692
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/get_custom_field_definition get_custom_field_definition api documentation}
|
1693
1693
|
#
|
1694
1694
|
# @param custom_field_definition_id [String] Custom Field Definition ID
|
1695
1695
|
# @param params [Hash] Optional query string parameters:
|
@@ -1714,9 +1714,9 @@ module Recurly
|
|
1714
1714
|
|
1715
1715
|
# List an invoice template's associated accounts
|
1716
1716
|
#
|
1717
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/list_invoice_template_accounts list_invoice_template_accounts api
|
1717
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/list_invoice_template_accounts list_invoice_template_accounts api documentation}
|
1718
1718
|
#
|
1719
|
-
# @param invoice_template_id [String] Invoice template ID.
|
1719
|
+
# @param invoice_template_id [String] Invoice template ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
|
1720
1720
|
# @param params [Hash] Optional query string parameters:
|
1721
1721
|
# :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
|
1722
1722
|
# commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
|
@@ -1757,7 +1757,7 @@ module Recurly
|
|
1757
1757
|
|
1758
1758
|
# List a site's items
|
1759
1759
|
#
|
1760
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/list_items list_items api
|
1760
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/list_items list_items api documentation}
|
1761
1761
|
#
|
1762
1762
|
# @param params [Hash] Optional query string parameters:
|
1763
1763
|
# :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
|
@@ -1803,7 +1803,7 @@ module Recurly
|
|
1803
1803
|
|
1804
1804
|
# Create a new item
|
1805
1805
|
#
|
1806
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/create_item create_item api
|
1806
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/create_item create_item api documentation}
|
1807
1807
|
#
|
1808
1808
|
# @param body [Requests::ItemCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::ItemCreate}
|
1809
1809
|
# @param params [Hash] Optional query string parameters:
|
@@ -1838,7 +1838,7 @@ module Recurly
|
|
1838
1838
|
|
1839
1839
|
# Fetch an item
|
1840
1840
|
#
|
1841
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/get_item get_item api
|
1841
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/get_item get_item api documentation}
|
1842
1842
|
#
|
1843
1843
|
# @param item_id [String] Item ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-red+.
|
1844
1844
|
# @param params [Hash] Optional query string parameters:
|
@@ -1861,7 +1861,7 @@ module Recurly
|
|
1861
1861
|
|
1862
1862
|
# Update an active item
|
1863
1863
|
#
|
1864
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/update_item update_item api
|
1864
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/update_item update_item api documentation}
|
1865
1865
|
#
|
1866
1866
|
# @param item_id [String] Item ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-red+.
|
1867
1867
|
# @param body [Requests::ItemUpdate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::ItemUpdate}
|
@@ -1892,7 +1892,7 @@ module Recurly
|
|
1892
1892
|
|
1893
1893
|
# Deactivate an item
|
1894
1894
|
#
|
1895
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/deactivate_item deactivate_item api
|
1895
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/deactivate_item deactivate_item api documentation}
|
1896
1896
|
#
|
1897
1897
|
# @param item_id [String] Item ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-red+.
|
1898
1898
|
# @param params [Hash] Optional query string parameters:
|
@@ -1915,7 +1915,7 @@ module Recurly
|
|
1915
1915
|
|
1916
1916
|
# Reactivate an inactive item
|
1917
1917
|
#
|
1918
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/reactivate_item reactivate_item api
|
1918
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/reactivate_item reactivate_item api documentation}
|
1919
1919
|
#
|
1920
1920
|
# @param item_id [String] Item ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-red+.
|
1921
1921
|
# @param params [Hash] Optional query string parameters:
|
@@ -1938,7 +1938,7 @@ module Recurly
|
|
1938
1938
|
|
1939
1939
|
# List a site's measured units
|
1940
1940
|
#
|
1941
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/list_measured_unit list_measured_unit api
|
1941
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/list_measured_unit list_measured_unit api documentation}
|
1942
1942
|
#
|
1943
1943
|
# @param params [Hash] Optional query string parameters:
|
1944
1944
|
# :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
|
@@ -1976,7 +1976,7 @@ module Recurly
|
|
1976
1976
|
|
1977
1977
|
# Create a new measured unit
|
1978
1978
|
#
|
1979
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/create_measured_unit create_measured_unit api
|
1979
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/create_measured_unit create_measured_unit api documentation}
|
1980
1980
|
#
|
1981
1981
|
# @param body [Requests::MeasuredUnitCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::MeasuredUnitCreate}
|
1982
1982
|
# @param params [Hash] Optional query string parameters:
|
@@ -1990,7 +1990,7 @@ module Recurly
|
|
1990
1990
|
|
1991
1991
|
# Fetch a measured unit
|
1992
1992
|
#
|
1993
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/get_measured_unit get_measured_unit api
|
1993
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/get_measured_unit get_measured_unit api documentation}
|
1994
1994
|
#
|
1995
1995
|
# @param measured_unit_id [String] Measured unit ID or name. For ID no prefix is used e.g. +e28zov4fw0v2+. For name use prefix +name-+, e.g. +name-Storage+.
|
1996
1996
|
# @param params [Hash] Optional query string parameters:
|
@@ -2004,7 +2004,7 @@ module Recurly
|
|
2004
2004
|
|
2005
2005
|
# Update a measured unit
|
2006
2006
|
#
|
2007
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/update_measured_unit update_measured_unit api
|
2007
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/update_measured_unit update_measured_unit api documentation}
|
2008
2008
|
#
|
2009
2009
|
# @param measured_unit_id [String] Measured unit ID or name. For ID no prefix is used e.g. +e28zov4fw0v2+. For name use prefix +name-+, e.g. +name-Storage+.
|
2010
2010
|
# @param body [Requests::MeasuredUnitUpdate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::MeasuredUnitUpdate}
|
@@ -2019,7 +2019,7 @@ module Recurly
|
|
2019
2019
|
|
2020
2020
|
# Remove a measured unit
|
2021
2021
|
#
|
2022
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/remove_measured_unit remove_measured_unit api
|
2022
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/remove_measured_unit remove_measured_unit api documentation}
|
2023
2023
|
#
|
2024
2024
|
# @param measured_unit_id [String] Measured unit ID or name. For ID no prefix is used e.g. +e28zov4fw0v2+. For name use prefix +name-+, e.g. +name-Storage+.
|
2025
2025
|
# @param params [Hash] Optional query string parameters:
|
@@ -2033,7 +2033,7 @@ module Recurly
|
|
2033
2033
|
|
2034
2034
|
# List a site's invoices
|
2035
2035
|
#
|
2036
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/list_invoices list_invoices api
|
2036
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/list_invoices list_invoices api documentation}
|
2037
2037
|
#
|
2038
2038
|
# @param params [Hash] Optional query string parameters:
|
2039
2039
|
# :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
|
@@ -2084,7 +2084,7 @@ module Recurly
|
|
2084
2084
|
|
2085
2085
|
# Fetch an invoice
|
2086
2086
|
#
|
2087
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/get_invoice get_invoice api
|
2087
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/get_invoice get_invoice api documentation}
|
2088
2088
|
#
|
2089
2089
|
# @param invoice_id [String] Invoice ID or number. For ID no prefix is used e.g. +e28zov4fw0v2+. For number use prefix +number-+, e.g. +number-1000+.
|
2090
2090
|
# @param params [Hash] Optional query string parameters:
|
@@ -2107,7 +2107,7 @@ module Recurly
|
|
2107
2107
|
|
2108
2108
|
# Update an invoice
|
2109
2109
|
#
|
2110
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/update_invoice update_invoice api
|
2110
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/update_invoice update_invoice api documentation}
|
2111
2111
|
#
|
2112
2112
|
# @param invoice_id [String] Invoice ID or number. For ID no prefix is used e.g. +e28zov4fw0v2+. For number use prefix +number-+, e.g. +number-1000+.
|
2113
2113
|
# @param body [Requests::InvoiceUpdate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::InvoiceUpdate}
|
@@ -2135,7 +2135,7 @@ module Recurly
|
|
2135
2135
|
|
2136
2136
|
# Fetch an invoice as a PDF
|
2137
2137
|
#
|
2138
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/get_invoice_pdf get_invoice_pdf api
|
2138
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/get_invoice_pdf get_invoice_pdf api documentation}
|
2139
2139
|
#
|
2140
2140
|
# @param invoice_id [String] Invoice ID or number. For ID no prefix is used e.g. +e28zov4fw0v2+. For number use prefix +number-+, e.g. +number-1000+.
|
2141
2141
|
# @param params [Hash] Optional query string parameters:
|
@@ -2161,7 +2161,7 @@ module Recurly
|
|
2161
2161
|
|
2162
2162
|
# Collect a pending or past due, automatic invoice
|
2163
2163
|
#
|
2164
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/collect_invoice collect_invoice api
|
2164
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/collect_invoice collect_invoice api documentation}
|
2165
2165
|
#
|
2166
2166
|
# @param invoice_id [String] Invoice ID or number. For ID no prefix is used e.g. +e28zov4fw0v2+. For number use prefix +number-+, e.g. +number-1000+.
|
2167
2167
|
# @param params [Hash] Optional query string parameters:
|
@@ -2185,7 +2185,7 @@ module Recurly
|
|
2185
2185
|
|
2186
2186
|
# Mark an open invoice as failed
|
2187
2187
|
#
|
2188
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/mark_invoice_failed mark_invoice_failed api
|
2188
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/mark_invoice_failed mark_invoice_failed api documentation}
|
2189
2189
|
#
|
2190
2190
|
# @param invoice_id [String] Invoice ID or number. For ID no prefix is used e.g. +e28zov4fw0v2+. For number use prefix +number-+, e.g. +number-1000+.
|
2191
2191
|
# @param params [Hash] Optional query string parameters:
|
@@ -2208,7 +2208,7 @@ module Recurly
|
|
2208
2208
|
|
2209
2209
|
# Mark an open invoice as successful
|
2210
2210
|
#
|
2211
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/mark_invoice_successful mark_invoice_successful api
|
2211
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/mark_invoice_successful mark_invoice_successful api documentation}
|
2212
2212
|
#
|
2213
2213
|
# @param invoice_id [String] Invoice ID or number. For ID no prefix is used e.g. +e28zov4fw0v2+. For number use prefix +number-+, e.g. +number-1000+.
|
2214
2214
|
# @param params [Hash] Optional query string parameters:
|
@@ -2231,7 +2231,7 @@ module Recurly
|
|
2231
2231
|
|
2232
2232
|
# Reopen a closed, manual invoice
|
2233
2233
|
#
|
2234
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/reopen_invoice reopen_invoice api
|
2234
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/reopen_invoice reopen_invoice api documentation}
|
2235
2235
|
#
|
2236
2236
|
# @param invoice_id [String] Invoice ID or number. For ID no prefix is used e.g. +e28zov4fw0v2+. For number use prefix +number-+, e.g. +number-1000+.
|
2237
2237
|
# @param params [Hash] Optional query string parameters:
|
@@ -2254,7 +2254,7 @@ module Recurly
|
|
2254
2254
|
|
2255
2255
|
# Void a credit invoice.
|
2256
2256
|
#
|
2257
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/void_invoice void_invoice api
|
2257
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/void_invoice void_invoice api documentation}
|
2258
2258
|
#
|
2259
2259
|
# @param invoice_id [String] Invoice ID or number. For ID no prefix is used e.g. +e28zov4fw0v2+. For number use prefix +number-+, e.g. +number-1000+.
|
2260
2260
|
# @param params [Hash] Optional query string parameters:
|
@@ -2277,7 +2277,7 @@ module Recurly
|
|
2277
2277
|
|
2278
2278
|
# Record an external payment for a manual invoices.
|
2279
2279
|
#
|
2280
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/record_external_transaction record_external_transaction api
|
2280
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/record_external_transaction record_external_transaction api documentation}
|
2281
2281
|
#
|
2282
2282
|
# @param invoice_id [String] Invoice ID or number. For ID no prefix is used e.g. +e28zov4fw0v2+. For number use prefix +number-+, e.g. +number-1000+.
|
2283
2283
|
# @param body [Requests::ExternalTransaction] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::ExternalTransaction}
|
@@ -2292,7 +2292,7 @@ module Recurly
|
|
2292
2292
|
|
2293
2293
|
# List an invoice's line items
|
2294
2294
|
#
|
2295
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/list_invoice_line_items list_invoice_line_items api
|
2295
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/list_invoice_line_items list_invoice_line_items api documentation}
|
2296
2296
|
#
|
2297
2297
|
# @param invoice_id [String] Invoice ID or number. For ID no prefix is used e.g. +e28zov4fw0v2+. For number use prefix +number-+, e.g. +number-1000+.
|
2298
2298
|
# @param params [Hash] Optional query string parameters:
|
@@ -2344,7 +2344,7 @@ module Recurly
|
|
2344
2344
|
|
2345
2345
|
# Show the coupon redemptions applied to an invoice
|
2346
2346
|
#
|
2347
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/list_invoice_coupon_redemptions list_invoice_coupon_redemptions api
|
2347
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/list_invoice_coupon_redemptions list_invoice_coupon_redemptions api documentation}
|
2348
2348
|
#
|
2349
2349
|
# @param invoice_id [String] Invoice ID or number. For ID no prefix is used e.g. +e28zov4fw0v2+. For number use prefix +number-+, e.g. +number-1000+.
|
2350
2350
|
# @param params [Hash] Optional query string parameters:
|
@@ -2391,7 +2391,7 @@ module Recurly
|
|
2391
2391
|
|
2392
2392
|
# List an invoice's related credit or charge invoices
|
2393
2393
|
#
|
2394
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/list_related_invoices list_related_invoices api
|
2394
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/list_related_invoices list_related_invoices api documentation}
|
2395
2395
|
#
|
2396
2396
|
# @param invoice_id [String] Invoice ID or number. For ID no prefix is used e.g. +e28zov4fw0v2+. For number use prefix +number-+, e.g. +number-1000+.
|
2397
2397
|
# @param params [Hash] Optional query string parameters:
|
@@ -2416,7 +2416,7 @@ module Recurly
|
|
2416
2416
|
|
2417
2417
|
# Refund an invoice
|
2418
2418
|
#
|
2419
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/refund_invoice refund_invoice api
|
2419
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/refund_invoice refund_invoice api documentation}
|
2420
2420
|
#
|
2421
2421
|
# @param invoice_id [String] Invoice ID or number. For ID no prefix is used e.g. +e28zov4fw0v2+. For number use prefix +number-+, e.g. +number-1000+.
|
2422
2422
|
# @param body [Requests::InvoiceRefund] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::InvoiceRefund}
|
@@ -2447,7 +2447,7 @@ module Recurly
|
|
2447
2447
|
|
2448
2448
|
# List a site's line items
|
2449
2449
|
#
|
2450
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/list_line_items list_line_items api
|
2450
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/list_line_items list_line_items api documentation}
|
2451
2451
|
#
|
2452
2452
|
# @param params [Hash] Optional query string parameters:
|
2453
2453
|
# :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
|
@@ -2497,7 +2497,7 @@ module Recurly
|
|
2497
2497
|
|
2498
2498
|
# Fetch a line item
|
2499
2499
|
#
|
2500
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/get_line_item get_line_item api
|
2500
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/get_line_item get_line_item api documentation}
|
2501
2501
|
#
|
2502
2502
|
# @param line_item_id [String] Line Item ID.
|
2503
2503
|
# @param params [Hash] Optional query string parameters:
|
@@ -2520,7 +2520,7 @@ module Recurly
|
|
2520
2520
|
|
2521
2521
|
# Delete an uninvoiced line item
|
2522
2522
|
#
|
2523
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/remove_line_item remove_line_item api
|
2523
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/remove_line_item remove_line_item api documentation}
|
2524
2524
|
#
|
2525
2525
|
# @param line_item_id [String] Line Item ID.
|
2526
2526
|
# @param params [Hash] Optional query string parameters:
|
@@ -2545,7 +2545,7 @@ module Recurly
|
|
2545
2545
|
|
2546
2546
|
# List a site's plans
|
2547
2547
|
#
|
2548
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/list_plans list_plans api
|
2548
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/list_plans list_plans api documentation}
|
2549
2549
|
#
|
2550
2550
|
# @param params [Hash] Optional query string parameters:
|
2551
2551
|
# :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
|
@@ -2591,7 +2591,7 @@ module Recurly
|
|
2591
2591
|
|
2592
2592
|
# Create a plan
|
2593
2593
|
#
|
2594
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/create_plan create_plan api
|
2594
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/create_plan create_plan api documentation}
|
2595
2595
|
#
|
2596
2596
|
# @param body [Requests::PlanCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::PlanCreate}
|
2597
2597
|
# @param params [Hash] Optional query string parameters:
|
@@ -2631,7 +2631,7 @@ module Recurly
|
|
2631
2631
|
|
2632
2632
|
# Fetch a plan
|
2633
2633
|
#
|
2634
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/get_plan get_plan api
|
2634
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/get_plan get_plan api documentation}
|
2635
2635
|
#
|
2636
2636
|
# @param plan_id [String] Plan ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-gold+.
|
2637
2637
|
# @param params [Hash] Optional query string parameters:
|
@@ -2654,7 +2654,7 @@ module Recurly
|
|
2654
2654
|
|
2655
2655
|
# Update a plan
|
2656
2656
|
#
|
2657
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/update_plan update_plan api
|
2657
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/update_plan update_plan api documentation}
|
2658
2658
|
#
|
2659
2659
|
# @param plan_id [String] Plan ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-gold+.
|
2660
2660
|
# @param body [Requests::PlanUpdate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::PlanUpdate}
|
@@ -2681,7 +2681,7 @@ module Recurly
|
|
2681
2681
|
|
2682
2682
|
# Remove a plan
|
2683
2683
|
#
|
2684
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/remove_plan remove_plan api
|
2684
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/remove_plan remove_plan api documentation}
|
2685
2685
|
#
|
2686
2686
|
# @param plan_id [String] Plan ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-gold+.
|
2687
2687
|
# @param params [Hash] Optional query string parameters:
|
@@ -2704,7 +2704,7 @@ module Recurly
|
|
2704
2704
|
|
2705
2705
|
# List a plan's add-ons
|
2706
2706
|
#
|
2707
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/list_plan_add_ons list_plan_add_ons api
|
2707
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/list_plan_add_ons list_plan_add_ons api documentation}
|
2708
2708
|
#
|
2709
2709
|
# @param plan_id [String] Plan ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-gold+.
|
2710
2710
|
# @param params [Hash] Optional query string parameters:
|
@@ -2754,7 +2754,7 @@ module Recurly
|
|
2754
2754
|
|
2755
2755
|
# Create an add-on
|
2756
2756
|
#
|
2757
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/create_plan_add_on create_plan_add_on api
|
2757
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/create_plan_add_on create_plan_add_on api documentation}
|
2758
2758
|
#
|
2759
2759
|
# @param plan_id [String] Plan ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-gold+.
|
2760
2760
|
# @param body [Requests::AddOnCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::AddOnCreate}
|
@@ -2789,7 +2789,7 @@ module Recurly
|
|
2789
2789
|
|
2790
2790
|
# Fetch a plan's add-on
|
2791
2791
|
#
|
2792
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/get_plan_add_on get_plan_add_on api
|
2792
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/get_plan_add_on get_plan_add_on api documentation}
|
2793
2793
|
#
|
2794
2794
|
# @param plan_id [String] Plan ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-gold+.
|
2795
2795
|
# @param add_on_id [String] Add-on ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-gold+.
|
@@ -2815,7 +2815,7 @@ module Recurly
|
|
2815
2815
|
|
2816
2816
|
# Update an add-on
|
2817
2817
|
#
|
2818
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/update_plan_add_on update_plan_add_on api
|
2818
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/update_plan_add_on update_plan_add_on api documentation}
|
2819
2819
|
#
|
2820
2820
|
# @param plan_id [String] Plan ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-gold+.
|
2821
2821
|
# @param add_on_id [String] Add-on ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-gold+.
|
@@ -2847,7 +2847,7 @@ module Recurly
|
|
2847
2847
|
|
2848
2848
|
# Remove an add-on
|
2849
2849
|
#
|
2850
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/remove_plan_add_on remove_plan_add_on api
|
2850
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/remove_plan_add_on remove_plan_add_on api documentation}
|
2851
2851
|
#
|
2852
2852
|
# @param plan_id [String] Plan ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-gold+.
|
2853
2853
|
# @param add_on_id [String] Add-on ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-gold+.
|
@@ -2874,7 +2874,7 @@ module Recurly
|
|
2874
2874
|
|
2875
2875
|
# List a site's add-ons
|
2876
2876
|
#
|
2877
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/list_add_ons list_add_ons api
|
2877
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/list_add_ons list_add_ons api documentation}
|
2878
2878
|
#
|
2879
2879
|
# @param params [Hash] Optional query string parameters:
|
2880
2880
|
# :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
|
@@ -2922,7 +2922,7 @@ module Recurly
|
|
2922
2922
|
|
2923
2923
|
# Fetch an add-on
|
2924
2924
|
#
|
2925
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/get_add_on get_add_on api
|
2925
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/get_add_on get_add_on api documentation}
|
2926
2926
|
#
|
2927
2927
|
# @param add_on_id [String] Add-on ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-gold+.
|
2928
2928
|
# @param params [Hash] Optional query string parameters:
|
@@ -2945,7 +2945,7 @@ module Recurly
|
|
2945
2945
|
|
2946
2946
|
# List a site's shipping methods
|
2947
2947
|
#
|
2948
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/list_shipping_methods list_shipping_methods api
|
2948
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/list_shipping_methods list_shipping_methods api documentation}
|
2949
2949
|
#
|
2950
2950
|
# @param params [Hash] Optional query string parameters:
|
2951
2951
|
# :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
|
@@ -2992,7 +2992,7 @@ module Recurly
|
|
2992
2992
|
|
2993
2993
|
# Create a new shipping method
|
2994
2994
|
#
|
2995
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/create_shipping_method create_shipping_method api
|
2995
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/create_shipping_method create_shipping_method api documentation}
|
2996
2996
|
#
|
2997
2997
|
# @param body [Requests::ShippingMethodCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::ShippingMethodCreate}
|
2998
2998
|
# @param params [Hash] Optional query string parameters:
|
@@ -3006,7 +3006,7 @@ module Recurly
|
|
3006
3006
|
|
3007
3007
|
# Fetch a shipping method
|
3008
3008
|
#
|
3009
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/get_shipping_method get_shipping_method api
|
3009
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/get_shipping_method get_shipping_method api documentation}
|
3010
3010
|
#
|
3011
3011
|
# @param shipping_method_id [String] Shipping Method ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-usps_2-day+.
|
3012
3012
|
# @param params [Hash] Optional query string parameters:
|
@@ -3020,7 +3020,7 @@ module Recurly
|
|
3020
3020
|
|
3021
3021
|
# Update an active Shipping Method
|
3022
3022
|
#
|
3023
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/update_shipping_method update_shipping_method api
|
3023
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/update_shipping_method update_shipping_method api documentation}
|
3024
3024
|
#
|
3025
3025
|
# @param shipping_method_id [String] Shipping Method ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-usps_2-day+.
|
3026
3026
|
# @param body [Requests::ShippingMethodUpdate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::ShippingMethodUpdate}
|
@@ -3035,7 +3035,7 @@ module Recurly
|
|
3035
3035
|
|
3036
3036
|
# Deactivate a shipping method
|
3037
3037
|
#
|
3038
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/deactivate_shipping_method deactivate_shipping_method api
|
3038
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/deactivate_shipping_method deactivate_shipping_method api documentation}
|
3039
3039
|
#
|
3040
3040
|
# @param shipping_method_id [String] Shipping Method ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-usps_2-day+.
|
3041
3041
|
# @param params [Hash] Optional query string parameters:
|
@@ -3049,7 +3049,7 @@ module Recurly
|
|
3049
3049
|
|
3050
3050
|
# List a site's subscriptions
|
3051
3051
|
#
|
3052
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/list_subscriptions list_subscriptions api
|
3052
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/list_subscriptions list_subscriptions api documentation}
|
3053
3053
|
#
|
3054
3054
|
# @param params [Hash] Optional query string parameters:
|
3055
3055
|
# :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
|
@@ -3100,7 +3100,7 @@ module Recurly
|
|
3100
3100
|
|
3101
3101
|
# Create a new subscription
|
3102
3102
|
#
|
3103
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/create_subscription create_subscription api
|
3103
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/create_subscription create_subscription api documentation}
|
3104
3104
|
#
|
3105
3105
|
# @param body [Requests::SubscriptionCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::SubscriptionCreate}
|
3106
3106
|
# @param params [Hash] Optional query string parameters:
|
@@ -3133,7 +3133,7 @@ module Recurly
|
|
3133
3133
|
|
3134
3134
|
# Fetch a subscription
|
3135
3135
|
#
|
3136
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/get_subscription get_subscription api
|
3136
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/get_subscription get_subscription api documentation}
|
3137
3137
|
#
|
3138
3138
|
# @param subscription_id [String] Subscription ID or UUID. For ID no prefix is used e.g. +e28zov4fw0v2+. For UUID use prefix +uuid-+, e.g. +uuid-123457890+.
|
3139
3139
|
# @param params [Hash] Optional query string parameters:
|
@@ -3158,7 +3158,7 @@ module Recurly
|
|
3158
3158
|
|
3159
3159
|
# Update a subscription
|
3160
3160
|
#
|
3161
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/update_subscription update_subscription api
|
3161
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/update_subscription update_subscription api documentation}
|
3162
3162
|
#
|
3163
3163
|
# @param subscription_id [String] Subscription ID or UUID. For ID no prefix is used e.g. +e28zov4fw0v2+. For UUID use prefix +uuid-+, e.g. +uuid-123457890+.
|
3164
3164
|
# @param body [Requests::SubscriptionUpdate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::SubscriptionUpdate}
|
@@ -3189,7 +3189,7 @@ module Recurly
|
|
3189
3189
|
|
3190
3190
|
# Terminate a subscription
|
3191
3191
|
#
|
3192
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/terminate_subscription terminate_subscription api
|
3192
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/terminate_subscription terminate_subscription api documentation}
|
3193
3193
|
#
|
3194
3194
|
# @param subscription_id [String] Subscription ID or UUID. For ID no prefix is used e.g. +e28zov4fw0v2+. For UUID use prefix +uuid-+, e.g. +uuid-123457890+.
|
3195
3195
|
# @param params [Hash] Optional query string parameters:
|
@@ -3225,7 +3225,7 @@ module Recurly
|
|
3225
3225
|
|
3226
3226
|
# Cancel a subscription
|
3227
3227
|
#
|
3228
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/cancel_subscription cancel_subscription api
|
3228
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/cancel_subscription cancel_subscription api documentation}
|
3229
3229
|
#
|
3230
3230
|
# @param subscription_id [String] Subscription ID or UUID. For ID no prefix is used e.g. +e28zov4fw0v2+. For UUID use prefix +uuid-+, e.g. +uuid-123457890+.
|
3231
3231
|
# @param params [Hash] Optional query string parameters:
|
@@ -3251,7 +3251,7 @@ module Recurly
|
|
3251
3251
|
|
3252
3252
|
# Reactivate a canceled subscription
|
3253
3253
|
#
|
3254
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/reactivate_subscription reactivate_subscription api
|
3254
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/reactivate_subscription reactivate_subscription api documentation}
|
3255
3255
|
#
|
3256
3256
|
# @param subscription_id [String] Subscription ID or UUID. For ID no prefix is used e.g. +e28zov4fw0v2+. For UUID use prefix +uuid-+, e.g. +uuid-123457890+.
|
3257
3257
|
# @param params [Hash] Optional query string parameters:
|
@@ -3276,7 +3276,7 @@ module Recurly
|
|
3276
3276
|
|
3277
3277
|
# Pause subscription
|
3278
3278
|
#
|
3279
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/pause_subscription pause_subscription api
|
3279
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/pause_subscription pause_subscription api documentation}
|
3280
3280
|
#
|
3281
3281
|
# @param subscription_id [String] Subscription ID or UUID. For ID no prefix is used e.g. +e28zov4fw0v2+. For UUID use prefix +uuid-+, e.g. +uuid-123457890+.
|
3282
3282
|
# @param body [Requests::SubscriptionPause] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::SubscriptionPause}
|
@@ -3306,7 +3306,7 @@ module Recurly
|
|
3306
3306
|
|
3307
3307
|
# Resume subscription
|
3308
3308
|
#
|
3309
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/resume_subscription resume_subscription api
|
3309
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/resume_subscription resume_subscription api documentation}
|
3310
3310
|
#
|
3311
3311
|
# @param subscription_id [String] Subscription ID or UUID. For ID no prefix is used e.g. +e28zov4fw0v2+. For UUID use prefix +uuid-+, e.g. +uuid-123457890+.
|
3312
3312
|
# @param params [Hash] Optional query string parameters:
|
@@ -3331,7 +3331,7 @@ module Recurly
|
|
3331
3331
|
|
3332
3332
|
# Convert trial subscription
|
3333
3333
|
#
|
3334
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/convert_trial convert_trial api
|
3334
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/convert_trial convert_trial api documentation}
|
3335
3335
|
#
|
3336
3336
|
# @param subscription_id [String] Subscription ID or UUID. For ID no prefix is used e.g. +e28zov4fw0v2+. For UUID use prefix +uuid-+, e.g. +uuid-123457890+.
|
3337
3337
|
# @param params [Hash] Optional query string parameters:
|
@@ -3345,7 +3345,7 @@ module Recurly
|
|
3345
3345
|
|
3346
3346
|
# Fetch a preview of a subscription's renewal invoice(s)
|
3347
3347
|
#
|
3348
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/get_preview_renewal get_preview_renewal api
|
3348
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/get_preview_renewal get_preview_renewal api documentation}
|
3349
3349
|
#
|
3350
3350
|
# @param subscription_id [String] Subscription ID or UUID. For ID no prefix is used e.g. +e28zov4fw0v2+. For UUID use prefix +uuid-+, e.g. +uuid-123457890+.
|
3351
3351
|
# @param params [Hash] Optional query string parameters:
|
@@ -3359,7 +3359,7 @@ module Recurly
|
|
3359
3359
|
|
3360
3360
|
# Fetch a subscription's pending change
|
3361
3361
|
#
|
3362
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/get_subscription_change get_subscription_change api
|
3362
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/get_subscription_change get_subscription_change api documentation}
|
3363
3363
|
#
|
3364
3364
|
# @param subscription_id [String] Subscription ID or UUID. For ID no prefix is used e.g. +e28zov4fw0v2+. For UUID use prefix +uuid-+, e.g. +uuid-123457890+.
|
3365
3365
|
# @param params [Hash] Optional query string parameters:
|
@@ -3384,7 +3384,7 @@ module Recurly
|
|
3384
3384
|
|
3385
3385
|
# Create a new subscription change
|
3386
3386
|
#
|
3387
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/create_subscription_change create_subscription_change api
|
3387
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/create_subscription_change create_subscription_change api documentation}
|
3388
3388
|
#
|
3389
3389
|
# @param subscription_id [String] Subscription ID or UUID. For ID no prefix is used e.g. +e28zov4fw0v2+. For UUID use prefix +uuid-+, e.g. +uuid-123457890+.
|
3390
3390
|
# @param body [Requests::SubscriptionChangeCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::SubscriptionChangeCreate}
|
@@ -3415,7 +3415,7 @@ module Recurly
|
|
3415
3415
|
|
3416
3416
|
# Delete the pending subscription change
|
3417
3417
|
#
|
3418
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/remove_subscription_change remove_subscription_change api
|
3418
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/remove_subscription_change remove_subscription_change api documentation}
|
3419
3419
|
#
|
3420
3420
|
# @param subscription_id [String] Subscription ID or UUID. For ID no prefix is used e.g. +e28zov4fw0v2+. For UUID use prefix +uuid-+, e.g. +uuid-123457890+.
|
3421
3421
|
# @param params [Hash] Optional query string parameters:
|
@@ -3440,7 +3440,7 @@ module Recurly
|
|
3440
3440
|
|
3441
3441
|
# Preview a new subscription change
|
3442
3442
|
#
|
3443
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/preview_subscription_change preview_subscription_change api
|
3443
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/preview_subscription_change preview_subscription_change api documentation}
|
3444
3444
|
#
|
3445
3445
|
# @param subscription_id [String] Subscription ID or UUID. For ID no prefix is used e.g. +e28zov4fw0v2+. For UUID use prefix +uuid-+, e.g. +uuid-123457890+.
|
3446
3446
|
# @param body [Requests::SubscriptionChangeCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::SubscriptionChangeCreate}
|
@@ -3455,7 +3455,7 @@ module Recurly
|
|
3455
3455
|
|
3456
3456
|
# List a subscription's invoices
|
3457
3457
|
#
|
3458
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/list_subscription_invoices list_subscription_invoices api
|
3458
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/list_subscription_invoices list_subscription_invoices api documentation}
|
3459
3459
|
#
|
3460
3460
|
# @param subscription_id [String] Subscription ID or UUID. For ID no prefix is used e.g. +e28zov4fw0v2+. For UUID use prefix +uuid-+, e.g. +uuid-123457890+.
|
3461
3461
|
# @param params [Hash] Optional query string parameters:
|
@@ -3510,7 +3510,7 @@ module Recurly
|
|
3510
3510
|
|
3511
3511
|
# List a subscription's line items
|
3512
3512
|
#
|
3513
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/list_subscription_line_items list_subscription_line_items api
|
3513
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/list_subscription_line_items list_subscription_line_items api documentation}
|
3514
3514
|
#
|
3515
3515
|
# @param subscription_id [String] Subscription ID or UUID. For ID no prefix is used e.g. +e28zov4fw0v2+. For UUID use prefix +uuid-+, e.g. +uuid-123457890+.
|
3516
3516
|
# @param params [Hash] Optional query string parameters:
|
@@ -3562,7 +3562,7 @@ module Recurly
|
|
3562
3562
|
|
3563
3563
|
# Show the coupon redemptions for a subscription
|
3564
3564
|
#
|
3565
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/list_subscription_coupon_redemptions list_subscription_coupon_redemptions api
|
3565
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/list_subscription_coupon_redemptions list_subscription_coupon_redemptions api documentation}
|
3566
3566
|
#
|
3567
3567
|
# @param subscription_id [String] Subscription ID or UUID. For ID no prefix is used e.g. +e28zov4fw0v2+. For UUID use prefix +uuid-+, e.g. +uuid-123457890+.
|
3568
3568
|
# @param params [Hash] Optional query string parameters:
|
@@ -3609,7 +3609,7 @@ module Recurly
|
|
3609
3609
|
|
3610
3610
|
# List a subscription add-on's usage records
|
3611
3611
|
#
|
3612
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/list_usage list_usage api
|
3612
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/list_usage list_usage api documentation}
|
3613
3613
|
#
|
3614
3614
|
# @param subscription_id [String] Subscription ID or UUID. For ID no prefix is used e.g. +e28zov4fw0v2+. For UUID use prefix +uuid-+, e.g. +uuid-123457890+.
|
3615
3615
|
# @param add_on_id [String] Add-on ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-gold+.
|
@@ -3649,7 +3649,7 @@ module Recurly
|
|
3649
3649
|
|
3650
3650
|
# Log a usage record on this subscription add-on
|
3651
3651
|
#
|
3652
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/create_usage create_usage api
|
3652
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/create_usage create_usage api documentation}
|
3653
3653
|
#
|
3654
3654
|
# @param subscription_id [String] Subscription ID or UUID. For ID no prefix is used e.g. +e28zov4fw0v2+. For UUID use prefix +uuid-+, e.g. +uuid-123457890+.
|
3655
3655
|
# @param add_on_id [String] Add-on ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-gold+.
|
@@ -3665,7 +3665,7 @@ module Recurly
|
|
3665
3665
|
|
3666
3666
|
# Get a usage record
|
3667
3667
|
#
|
3668
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/get_usage get_usage api
|
3668
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/get_usage get_usage api documentation}
|
3669
3669
|
#
|
3670
3670
|
# @param usage_id [String] Usage Record ID.
|
3671
3671
|
# @param params [Hash] Optional query string parameters:
|
@@ -3679,7 +3679,7 @@ module Recurly
|
|
3679
3679
|
|
3680
3680
|
# Update a usage record
|
3681
3681
|
#
|
3682
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/update_usage update_usage api
|
3682
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/update_usage update_usage api documentation}
|
3683
3683
|
#
|
3684
3684
|
# @param usage_id [String] Usage Record ID.
|
3685
3685
|
# @param body [Requests::UsageCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::UsageCreate}
|
@@ -3694,7 +3694,7 @@ module Recurly
|
|
3694
3694
|
|
3695
3695
|
# Delete a usage record.
|
3696
3696
|
#
|
3697
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/remove_usage remove_usage api
|
3697
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/remove_usage remove_usage api documentation}
|
3698
3698
|
#
|
3699
3699
|
# @param usage_id [String] Usage Record ID.
|
3700
3700
|
# @param params [Hash] Optional query string parameters:
|
@@ -3708,7 +3708,7 @@ module Recurly
|
|
3708
3708
|
|
3709
3709
|
# List a site's transactions
|
3710
3710
|
#
|
3711
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/list_transactions list_transactions api
|
3711
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/list_transactions list_transactions api documentation}
|
3712
3712
|
#
|
3713
3713
|
# @param params [Hash] Optional query string parameters:
|
3714
3714
|
# :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
|
@@ -3755,7 +3755,7 @@ module Recurly
|
|
3755
3755
|
|
3756
3756
|
# Fetch a transaction
|
3757
3757
|
#
|
3758
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/get_transaction get_transaction api
|
3758
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/get_transaction get_transaction api documentation}
|
3759
3759
|
#
|
3760
3760
|
# @param transaction_id [String] Transaction ID or UUID. For ID no prefix is used e.g. +e28zov4fw0v2+. For UUID use prefix +uuid-+, e.g. +uuid-123457890+.
|
3761
3761
|
# @param params [Hash] Optional query string parameters:
|
@@ -3778,7 +3778,7 @@ module Recurly
|
|
3778
3778
|
|
3779
3779
|
# Fetch a unique coupon code
|
3780
3780
|
#
|
3781
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/get_unique_coupon_code get_unique_coupon_code api
|
3781
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/get_unique_coupon_code get_unique_coupon_code api documentation}
|
3782
3782
|
#
|
3783
3783
|
# @param unique_coupon_code_id [String] Unique Coupon Code ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-abc-8dh2-def+.
|
3784
3784
|
# @param params [Hash] Optional query string parameters:
|
@@ -3792,7 +3792,7 @@ module Recurly
|
|
3792
3792
|
|
3793
3793
|
# Deactivate a unique coupon code
|
3794
3794
|
#
|
3795
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/deactivate_unique_coupon_code deactivate_unique_coupon_code api
|
3795
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/deactivate_unique_coupon_code deactivate_unique_coupon_code api documentation}
|
3796
3796
|
#
|
3797
3797
|
# @param unique_coupon_code_id [String] Unique Coupon Code ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-abc-8dh2-def+.
|
3798
3798
|
# @param params [Hash] Optional query string parameters:
|
@@ -3806,7 +3806,7 @@ module Recurly
|
|
3806
3806
|
|
3807
3807
|
# Restore a unique coupon code
|
3808
3808
|
#
|
3809
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/reactivate_unique_coupon_code reactivate_unique_coupon_code api
|
3809
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/reactivate_unique_coupon_code reactivate_unique_coupon_code api documentation}
|
3810
3810
|
#
|
3811
3811
|
# @param unique_coupon_code_id [String] Unique Coupon Code ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-abc-8dh2-def+.
|
3812
3812
|
# @param params [Hash] Optional query string parameters:
|
@@ -3820,7 +3820,7 @@ module Recurly
|
|
3820
3820
|
|
3821
3821
|
# Create a new purchase
|
3822
3822
|
#
|
3823
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/create_purchase create_purchase api
|
3823
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/create_purchase create_purchase api documentation}
|
3824
3824
|
#
|
3825
3825
|
# @param body [Requests::PurchaseCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::PurchaseCreate}
|
3826
3826
|
# @param params [Hash] Optional query string parameters:
|
@@ -3860,7 +3860,7 @@ module Recurly
|
|
3860
3860
|
|
3861
3861
|
# Preview a new purchase
|
3862
3862
|
#
|
3863
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/preview_purchase preview_purchase api
|
3863
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/preview_purchase preview_purchase api documentation}
|
3864
3864
|
#
|
3865
3865
|
# @param body [Requests::PurchaseCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::PurchaseCreate}
|
3866
3866
|
# @param params [Hash] Optional query string parameters:
|
@@ -3898,9 +3898,51 @@ module Recurly
|
|
3898
3898
|
post(path, body, Requests::PurchaseCreate, **options)
|
3899
3899
|
end
|
3900
3900
|
|
3901
|
+
# Create a pending purchase
|
3902
|
+
#
|
3903
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/create_pending_purchase create_pending_purchase api documentation}
|
3904
|
+
#
|
3905
|
+
# @param body [Requests::PurchaseCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::PurchaseCreate}
|
3906
|
+
# @param params [Hash] Optional query string parameters:
|
3907
|
+
#
|
3908
|
+
# @return [Resources::InvoiceCollection] Returns the pending invoice
|
3909
|
+
# @example
|
3910
|
+
# begin
|
3911
|
+
# purchase = {
|
3912
|
+
# currency: 'EUR',
|
3913
|
+
# account: {
|
3914
|
+
# code: account_code,
|
3915
|
+
# email: 'benjamin@example.com',
|
3916
|
+
# billing_info: {
|
3917
|
+
# first_name: 'Benjamin',
|
3918
|
+
# last_name: 'Du Monde',
|
3919
|
+
# online_banking_payment_type: 'ideal'
|
3920
|
+
# },
|
3921
|
+
# },
|
3922
|
+
# line_items: [
|
3923
|
+
# {
|
3924
|
+
# currency: 'EUR',
|
3925
|
+
# unit_amount: 1000,
|
3926
|
+
# type: 'charge'
|
3927
|
+
# }
|
3928
|
+
# ]
|
3929
|
+
# }
|
3930
|
+
# invoice_collection = @client.create_pending_purchase(body: purchase)
|
3931
|
+
# puts "Created ChargeInvoice with UUID: #{invoice_collection.charge_invoice.uuid}"
|
3932
|
+
# rescue Recurly::Errors::ValidationError => e
|
3933
|
+
# # If the request was invalid, you may want to tell your user
|
3934
|
+
# # why. You can find the invalid params and reasons in e.recurly_error.params
|
3935
|
+
# puts "ValidationError: #{e.recurly_error.params}"
|
3936
|
+
# end
|
3937
|
+
#
|
3938
|
+
def create_pending_purchase(body:, **options)
|
3939
|
+
path = "/purchases/pending"
|
3940
|
+
post(path, body, Requests::PurchaseCreate, **options)
|
3941
|
+
end
|
3942
|
+
|
3901
3943
|
# List the dates that have an available export to download.
|
3902
3944
|
#
|
3903
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/get_export_dates get_export_dates api
|
3945
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/get_export_dates get_export_dates api documentation}
|
3904
3946
|
#
|
3905
3947
|
# @param params [Hash] Optional query string parameters:
|
3906
3948
|
#
|
@@ -3924,7 +3966,7 @@ module Recurly
|
|
3924
3966
|
|
3925
3967
|
# List of the export files that are available to download.
|
3926
3968
|
#
|
3927
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/get_export_files get_export_files api
|
3969
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/get_export_files get_export_files api documentation}
|
3928
3970
|
#
|
3929
3971
|
# @param export_date [String] Date for which to get a list of available automated export files. Date must be in YYYY-MM-DD format.
|
3930
3972
|
# @param params [Hash] Optional query string parameters:
|
@@ -3949,7 +3991,7 @@ module Recurly
|
|
3949
3991
|
|
3950
3992
|
# Show the dunning campaigns for a site
|
3951
3993
|
#
|
3952
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/list_dunning_campaigns list_dunning_campaigns api
|
3994
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/list_dunning_campaigns list_dunning_campaigns api documentation}
|
3953
3995
|
#
|
3954
3996
|
# @param params [Hash] Optional query string parameters:
|
3955
3997
|
# :sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
|
@@ -3966,7 +4008,7 @@ module Recurly
|
|
3966
4008
|
|
3967
4009
|
# Show the settings for a dunning campaign
|
3968
4010
|
#
|
3969
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/get_dunning_campaign get_dunning_campaign api
|
4011
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/get_dunning_campaign get_dunning_campaign api documentation}
|
3970
4012
|
#
|
3971
4013
|
# @param dunning_campaign_id [String] Dunning Campaign ID, e.g. +e28zov4fw0v2+.
|
3972
4014
|
# @param params [Hash] Optional query string parameters:
|
@@ -3980,7 +4022,7 @@ module Recurly
|
|
3980
4022
|
|
3981
4023
|
# Assign a dunning campaign to multiple plans
|
3982
4024
|
#
|
3983
|
-
# {https://developers.recurly.com/api/v2021-02-25#operation/put_dunning_campaign_bulk_update put_dunning_campaign_bulk_update api
|
4025
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/put_dunning_campaign_bulk_update put_dunning_campaign_bulk_update api documentation}
|
3984
4026
|
#
|
3985
4027
|
# @param body [Requests::DunningCampaignsBulkUpdate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::DunningCampaignsBulkUpdate}
|
3986
4028
|
# @param params [Hash] Optional query string parameters:
|
@@ -3991,5 +4033,36 @@ module Recurly
|
|
3991
4033
|
path = "/dunning_campaigns/{dunning_campaign_id}/bulk_update"
|
3992
4034
|
put(path, body, Requests::DunningCampaignsBulkUpdate, **options)
|
3993
4035
|
end
|
4036
|
+
|
4037
|
+
# Show the invoice templates for a site
|
4038
|
+
#
|
4039
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/list_invoice_templates list_invoice_templates api documentation}
|
4040
|
+
#
|
4041
|
+
# @param params [Hash] Optional query string parameters:
|
4042
|
+
# :sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
|
4043
|
+
# order. In descending order updated records will move behind the cursor and could
|
4044
|
+
# prevent some records from being returned.
|
4045
|
+
#
|
4046
|
+
#
|
4047
|
+
# @return [Pager<Resources::InvoiceTemplate>] A list of the the invoice templates on a site.
|
4048
|
+
#
|
4049
|
+
def list_invoice_templates(**options)
|
4050
|
+
path = "/invoice_templates"
|
4051
|
+
pager(path, **options)
|
4052
|
+
end
|
4053
|
+
|
4054
|
+
# Show the settings for an invoice template
|
4055
|
+
#
|
4056
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/get_invoice_template get_invoice_template api documentation}
|
4057
|
+
#
|
4058
|
+
# @param invoice_template_id [String] Invoice template ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
|
4059
|
+
# @param params [Hash] Optional query string parameters:
|
4060
|
+
#
|
4061
|
+
# @return [Resources::InvoiceTemplate] Settings for an invoice template.
|
4062
|
+
#
|
4063
|
+
def get_invoice_template(invoice_template_id:, **options)
|
4064
|
+
path = interpolate_path("/invoice_templates/{invoice_template_id}", invoice_template_id: invoice_template_id)
|
4065
|
+
get(path, **options)
|
4066
|
+
end
|
3994
4067
|
end
|
3995
4068
|
end
|