recurly 3.21.0 → 3.23.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: b9218a6c207426f02771031f66b2f5def8e22805b4dd7e0d565909a943404bff
4
- data.tar.gz: 3269a3003e8446cabf915d742a554eb94af0f3e6fe5511de6f602b6adf41e287
3
+ metadata.gz: 88fb21ff9bb9df689fe849ead892c462a7641966f9523d805e99f7de40e6633d
4
+ data.tar.gz: f68162f74081ecaa0a6248315518e41799fb64bce245837854d6bea2244a6502
5
5
  SHA512:
6
- metadata.gz: f0dfe2d431ebbcacc24aa32c9bed1477e0ecec23235c6ed63bcfd94a2640508da40d635b30b205515c88f14d4f51f7b2e00a39f0c0fb6d36bab56730285885b5
7
- data.tar.gz: 0b76576ac5143019670a2c69320c801ac7c47df22661b703ee393313dbac7a3b542c46e2ff5dbfb0a9a04136f0389ab934957b0d9e3427838c60ffe6b44dd5ba
6
+ metadata.gz: 147ad743a5a25edebbe89cf7e71cb5125a1523cbf2de343be31d561c741ddc4a6043fc6c5008d52bf368992c009a6c59d232a0b54fbcbe6244fa0e61741ec9b3
7
+ data.tar.gz: 8bcff488cb7ccbdaefdb02fbff141057fe4a3c71fa2f36fe58b9eef99ab558a4a350ad618e51ad8edc244aa0fbc719dfc35427df2ed354ee6f711093916831dc
data/.bumpversion.cfg CHANGED
@@ -1,5 +1,5 @@
1
1
  [bumpversion]
2
- current_version = 3.21.0
2
+ current_version = 3.23.0
3
3
  parse = (?P<major>\d+)
4
4
  \.(?P<minor>\d+)
5
5
  \.(?P<patch>\d+)
data/CHANGELOG.md CHANGED
@@ -1,5 +1,28 @@
1
1
  # Changelog
2
2
 
3
+ ## [3.23.0](https://github.com/recurly/recurly-client-ruby/tree/3.23.0) (2022-11-17)
4
+
5
+ [Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/3.22.0...3.23.0)
6
+
7
+
8
+ **Merged Pull Requests**
9
+
10
+ - Generated Latest Changes for v2019-10-10 (Apply Credit Balance feature) [#810](https://github.com/recurly/recurly-client-ruby/pull/810) ([recurly-integrations](https://github.com/recurly-integrations))
11
+ - Generated Latest Changes for v2019-10-10 [#806](https://github.com/recurly/recurly-client-ruby/pull/806) ([recurly-integrations](https://github.com/recurly-integrations))
12
+
13
+
14
+
15
+ ## [3.22.0](https://github.com/recurly/recurly-client-ruby/tree/3.22.0) (2022-10-21)
16
+
17
+ [Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/3.21.0...3.22.0)
18
+
19
+
20
+ **Merged Pull Requests**
21
+
22
+ - Generated Latest Changes for v2019-10-10(Decimal Usage and Quantities) [#800](https://github.com/recurly/recurly-client-ruby/pull/800) ([recurly-integrations](https://github.com/recurly-integrations))
23
+
24
+
25
+
3
26
  ## [3.21.0](https://github.com/recurly/recurly-client-ruby/tree/3.21.0) (2022-08-03)
4
27
 
5
28
  [Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/3.20.0...3.21.0)
data/GETTING_STARTED.md CHANGED
@@ -5,7 +5,7 @@ This repository houses the official ruby client for Recurly's V3 API.
5
5
  In your Gemfile, add `recurly` as a dependency.
6
6
 
7
7
  ```ruby
8
- gem 'recurly', '~> 3.21'
8
+ gem 'recurly', '~> 3.23'
9
9
  ```
10
10
 
11
11
  > *Note*: We try to follow [semantic versioning](https://semver.org/) and will only apply breaking changes to major versions.
@@ -565,7 +565,7 @@ module Recurly
565
565
  delete(path, **options)
566
566
  end
567
567
 
568
- # Show the coupon redemptions for an account
568
+ # List the coupon redemptions for an account
569
569
  #
570
570
  # {https://developers.recurly.com/api/v2019-10-10#operation/list_account_coupon_redemptions list_account_coupon_redemptions api documentation}
571
571
  #
@@ -610,7 +610,7 @@ module Recurly
610
610
  pager(path, **options)
611
611
  end
612
612
 
613
- # Show the coupon redemption that is active on an account
613
+ # Fetch the coupon redemption that is active on an account
614
614
  #
615
615
  # {https://developers.recurly.com/api/v2019-10-10#operation/get_active_coupon_redemption get_active_coupon_redemption api documentation}
616
616
  #
@@ -916,7 +916,7 @@ module Recurly
916
916
  post(path, body, Requests::LineItemCreate, **options)
917
917
  end
918
918
 
919
- # Fetch a list of an account's notes
919
+ # List an account's notes
920
920
  #
921
921
  # {https://developers.recurly.com/api/v2019-10-10#operation/list_account_notes list_account_notes api documentation}
922
922
  #
@@ -2060,6 +2060,20 @@ module Recurly
2060
2060
  get(path, **options)
2061
2061
  end
2062
2062
 
2063
+ # Apply available credit to a pending or past due charge invoice
2064
+ #
2065
+ # {https://developers.recurly.com/api/v2019-10-10#operation/apply_credit_balance apply_credit_balance api documentation}
2066
+ #
2067
+ # @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+.
2068
+ # @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+.
2069
+ #
2070
+ # @return [Resources::Invoice] The updated invoice.
2071
+ #
2072
+ def apply_credit_balance(invoice_id:, **options)
2073
+ path = interpolate_path("/invoices/{invoice_id}/apply_credit_balance", invoice_id: invoice_id)
2074
+ put(path, **options)
2075
+ end
2076
+
2063
2077
  # Collect a pending or past due, automatic invoice
2064
2078
  #
2065
2079
  # {https://developers.recurly.com/api/v2019-10-10#operation/collect_invoice collect_invoice api documentation}
@@ -2240,7 +2254,7 @@ module Recurly
2240
2254
  pager(path, **options)
2241
2255
  end
2242
2256
 
2243
- # Show the coupon redemptions applied to an invoice
2257
+ # List the coupon redemptions applied to an invoice
2244
2258
  #
2245
2259
  # {https://developers.recurly.com/api/v2019-10-10#operation/list_invoice_coupon_redemptions list_invoice_coupon_redemptions api documentation}
2246
2260
  #
@@ -3427,7 +3441,7 @@ module Recurly
3427
3441
  pager(path, **options)
3428
3442
  end
3429
3443
 
3430
- # Show the coupon redemptions for a subscription
3444
+ # List the coupon redemptions for a subscription
3431
3445
  #
3432
3446
  # {https://developers.recurly.com/api/v2019-10-10#operation/list_subscription_coupon_redemptions list_subscription_coupon_redemptions api documentation}
3433
3447
  #
@@ -3808,7 +3822,7 @@ module Recurly
3808
3822
  get(path, **options)
3809
3823
  end
3810
3824
 
3811
- # Show the dunning campaigns for a site
3825
+ # List the dunning campaigns for a site
3812
3826
  #
3813
3827
  # {https://developers.recurly.com/api/v2019-10-10#operation/list_dunning_campaigns list_dunning_campaigns api documentation}
3814
3828
  #
@@ -3824,7 +3838,7 @@ module Recurly
3824
3838
  pager(path, **options)
3825
3839
  end
3826
3840
 
3827
- # Show the settings for a dunning campaign
3841
+ # Fetch a dunning campaign
3828
3842
  #
3829
3843
  # {https://developers.recurly.com/api/v2019-10-10#operation/get_dunning_campaign get_dunning_campaign api documentation}
3830
3844
  #
@@ -3841,12 +3855,13 @@ module Recurly
3841
3855
  #
3842
3856
  # {https://developers.recurly.com/api/v2019-10-10#operation/put_dunning_campaign_bulk_update put_dunning_campaign_bulk_update api documentation}
3843
3857
  #
3858
+ # @param dunning_campaign_id [String] Dunning Campaign ID, e.g. +e28zov4fw0v2+.
3844
3859
  # @param body [Requests::DunningCampaignsBulkUpdate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::DunningCampaignsBulkUpdate}
3845
3860
  #
3846
3861
  # @return [Resources::DunningCampaignsBulkUpdateResponse] A list of updated plans.
3847
3862
  #
3848
- def put_dunning_campaign_bulk_update(body:)
3849
- path = "/dunning_campaigns/{dunning_campaign_id}/bulk_update"
3863
+ def put_dunning_campaign_bulk_update(dunning_campaign_id:, body:)
3864
+ path = interpolate_path("/dunning_campaigns/{dunning_campaign_id}/bulk_update", dunning_campaign_id: dunning_campaign_id)
3850
3865
  put(path, body, Requests::DunningCampaignsBulkUpdate)
3851
3866
  end
3852
3867
  end
@@ -75,7 +75,7 @@ module Recurly
75
75
  define_attribute :tax_code, String
76
76
 
77
77
  # @!attribute tier_type
78
- # @return [String] The pricing model for the add-on. For more information, [click here](https://docs.recurly.com/docs/billing-models#section-quantity-based). See our [Guide](https://developers.recurly.com/guides/item-addon-guide.html) for an overview of how to configure quantity-based pricing models.
78
+ # @return [String] The pricing model for the add-on. For more information, [click here](https://docs.recurly.com/docs/billing-models#section-quantity-based). See our [Guide](https://recurly.com/developers/guides/item-addon-guide.html) for an overview of how to configure quantity-based pricing models.
79
79
  define_attribute :tier_type, String
80
80
 
81
81
  # @!attribute tiers
@@ -87,7 +87,7 @@ module Recurly
87
87
  define_attribute :usage_percentage, Float
88
88
 
89
89
  # @!attribute usage_type
90
- # @return [String] Type of usage, required if `add_on_type` is `usage`. See our [Guide](https://developers.recurly.com/guides/usage-based-billing-guide.html) for an overview of how to configure usage add-ons.
90
+ # @return [String] Type of usage, required if `add_on_type` is `usage`. See our [Guide](https://recurly.com/developers/guides/usage-based-billing-guide.html) for an overview of how to configure usage add-ons.
91
91
  define_attribute :usage_type, String
92
92
  end
93
93
  end
@@ -103,7 +103,7 @@ module Recurly
103
103
  define_attribute :three_d_secure_action_result_token_id, String
104
104
 
105
105
  # @!attribute token_id
106
- # @return [String] A token [generated by Recurly.js](https://developers.recurly.com/reference/recurly-js/#getting-a-token).
106
+ # @return [String] A token [generated by Recurly.js](https://recurly.com/developers/reference/recurly-js/#getting-a-token).
107
107
  define_attribute :token_id, String
108
108
 
109
109
  # @!attribute transaction_type
@@ -17,6 +17,10 @@ module Recurly
17
17
  # @!attribute quantity
18
18
  # @return [Integer] Line item quantity to be refunded.
19
19
  define_attribute :quantity, Integer
20
+
21
+ # @!attribute quantity_decimal
22
+ # @return [String] A floating-point alternative to Quantity. If this value is present, it will be used in place of Quantity for calculations, and Quantity will be the rounded integer value of this number. This field supports up to 9 decimal places. The Decimal Quantity feature must be enabled to utilize this field.
23
+ define_attribute :quantity_decimal, String
20
24
  end
21
25
  end
22
26
  end
@@ -38,6 +38,10 @@ module Recurly
38
38
  # @return [Array[PlanPricing]] Pricing
39
39
  define_attribute :currencies, Array, { :item_type => :PlanPricing }
40
40
 
41
+ # @!attribute custom_fields
42
+ # @return [Array[CustomField]] The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.
43
+ define_attribute :custom_fields, Array, { :item_type => :CustomField }
44
+
41
45
  # @!attribute description
42
46
  # @return [String] Optional description, not displayed.
43
47
  define_attribute :description, String
@@ -11,7 +11,7 @@ module Recurly
11
11
  define_attribute :currencies, Array, { :item_type => :PlanRampPricing }
12
12
 
13
13
  # @!attribute starting_billing_cycle
14
- # @return [Integer] Represents the first billing cycle of a ramp.
14
+ # @return [Integer] Represents the billing cycle where a ramp interval starts.
15
15
  define_attribute :starting_billing_cycle, Integer
16
16
  end
17
17
  end
@@ -34,6 +34,10 @@ module Recurly
34
34
  # @return [Array[PlanPricing]] Pricing
35
35
  define_attribute :currencies, Array, { :item_type => :PlanPricing }
36
36
 
37
+ # @!attribute custom_fields
38
+ # @return [Array[CustomField]] The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.
39
+ define_attribute :custom_fields, Array, { :item_type => :CustomField }
40
+
37
41
  # @!attribute description
38
42
  # @return [String] Optional description, not displayed.
39
43
  define_attribute :description, String
@@ -23,7 +23,7 @@ module Recurly
23
23
  define_attribute :revenue_schedule_type, String
24
24
 
25
25
  # @!attribute tiers
26
- # @return [Array[SubscriptionAddOnTier]] If the plan add-on's `tier_type` is `flat`, then `tiers` must be absent. The `tiers` object must include one to many tiers with `ending_quantity` and `unit_amount`. There must be one tier with an `ending_quantity` of 999999999 which is the default if not provided. See our [Guide](https://developers.recurly.com/guides/item-addon-guide.html) for an overview of how to configure quantity-based pricing models.
26
+ # @return [Array[SubscriptionAddOnTier]] If the plan add-on's `tier_type` is `flat`, then `tiers` must be absent. The `tiers` object must include one to many tiers with `ending_quantity` and `unit_amount`. There must be one tier with an `ending_quantity` of 999999999 which is the default if not provided. See our [Guide](https://recurly.com/developers/guides/item-addon-guide.html) for an overview of how to configure quantity-based pricing models.
27
27
  define_attribute :tiers, Array, { :item_type => :SubscriptionAddOnTier }
28
28
 
29
29
  # @!attribute unit_amount
@@ -31,7 +31,7 @@ module Recurly
31
31
  define_attribute :unit_amount, Float
32
32
 
33
33
  # @!attribute usage_percentage
34
- # @return [Float] The percentage taken of the monetary amount of usage tracked. This can be up to 4 decimal places. A value between 0.0 and 100.0. Required if `add_on_type` is usage and `usage_type` is percentage. Must be omitted otherwise. `usage_percentage` does not support tiers. See our [Guide](https://developers.recurly.com/guides/usage-based-billing-guide.html) for an overview of how to configure usage add-ons.
34
+ # @return [Float] The percentage taken of the monetary amount of usage tracked. This can be up to 4 decimal places. A value between 0.0 and 100.0. Required if `add_on_type` is usage and `usage_type` is percentage. Must be omitted otherwise. `usage_percentage` does not support tiers. See our [Guide](https://recurly.com/developers/guides/usage-based-billing-guide.html) for an overview of how to configure usage add-ons.
35
35
  define_attribute :usage_percentage, Float
36
36
  end
37
37
  end
@@ -7,7 +7,7 @@ module Recurly
7
7
  class SubscriptionRampInterval < Request
8
8
 
9
9
  # @!attribute starting_billing_cycle
10
- # @return [Integer] Represents how many billing cycles are included in a ramp interval.
10
+ # @return [Integer] Represents the billing cycle where a ramp interval starts.
11
11
  define_attribute :starting_billing_cycle, Integer
12
12
 
13
13
  # @!attribute unit_amount
@@ -7,7 +7,7 @@ module Recurly
7
7
  class UsageCreate < Request
8
8
 
9
9
  # @!attribute amount
10
- # @return [Float] The amount of usage. Can be positive, negative, or 0. No decimals allowed, we will strip them. If the usage-based add-on is billed with a percentage, your usage will be a monetary amount you will want to format in cents. (e.g., $5.00 is "500").
10
+ # @return [Float] The amount of usage. Can be positive, negative, or 0. If the Decimal Quantity feature is enabled, this value will be rounded to nine decimal places. Otherwise, all digits after the decimal will be stripped. If the usage-based add-on is billed with a percentage, your usage should be a monetary amount formatted in cents (e.g., $5.00 is "500").
11
11
  define_attribute :amount, Float
12
12
 
13
13
  # @!attribute merchant_tag
@@ -10,6 +10,10 @@ module Recurly
10
10
  # @return [Float] Total amount the account is past due.
11
11
  define_attribute :amount, Float
12
12
 
13
+ # @!attribute available_credit_amount
14
+ # @return [Float] Total amount of the open balances on credit invoices for the account.
15
+ define_attribute :available_credit_amount, Float
16
+
13
17
  # @!attribute currency
14
18
  # @return [String] 3-letter ISO 4217 currency code.
15
19
  define_attribute :currency, String
@@ -130,6 +130,10 @@ module Recurly
130
130
  # @return [Integer] This number will be multiplied by the unit amount to compute the subtotal before any discounts or taxes.
131
131
  define_attribute :quantity, Integer
132
132
 
133
+ # @!attribute quantity_decimal
134
+ # @return [String] A floating-point alternative to Quantity. If this value is present, it will be used in place of Quantity for calculations, and Quantity will be the rounded integer value of this number. This field supports up to 9 decimal places. The Decimal Quantity feature must be enabled to utilize this field.
135
+ define_attribute :quantity_decimal, String
136
+
133
137
  # @!attribute refund
134
138
  # @return [Boolean] Refund?
135
139
  define_attribute :refund, :Boolean
@@ -138,6 +142,10 @@ module Recurly
138
142
  # @return [Integer] For refund charges, the quantity being refunded. For non-refund charges, the total quantity refunded (possibly over multiple refunds).
139
143
  define_attribute :refunded_quantity, Integer
140
144
 
145
+ # @!attribute refunded_quantity_decimal
146
+ # @return [String] A floating-point alternative to Refunded Quantity. For refund charges, the quantity being refunded. For non-refund charges, the total quantity refunded (possibly over multiple refunds). The Decimal Quantity feature must be enabled to utilize this field.
147
+ define_attribute :refunded_quantity_decimal, String
148
+
141
149
  # @!attribute revenue_schedule_type
142
150
  # @return [String] Revenue schedule type
143
151
  define_attribute :revenue_schedule_type, String
@@ -38,6 +38,10 @@ module Recurly
38
38
  # @return [Array[PlanPricing]] Pricing
39
39
  define_attribute :currencies, Array, { :item_type => :PlanPricing }
40
40
 
41
+ # @!attribute custom_fields
42
+ # @return [Array[CustomField]] The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.
43
+ define_attribute :custom_fields, Array, { :item_type => :CustomField }
44
+
41
45
  # @!attribute deleted_at
42
46
  # @return [DateTime] Deleted at
43
47
  define_attribute :deleted_at, DateTime
@@ -11,7 +11,7 @@ module Recurly
11
11
  define_attribute :currencies, Array, { :item_type => :PlanRampPricing }
12
12
 
13
13
  # @!attribute starting_billing_cycle
14
- # @return [Integer] Represents the first billing cycle of a ramp.
14
+ # @return [Integer] Represents the billing cycle where a ramp interval starts.
15
15
  define_attribute :starting_billing_cycle, Integer
16
16
  end
17
17
  end
@@ -11,7 +11,7 @@ module Recurly
11
11
  define_attribute :remaining_billing_cycles, Integer
12
12
 
13
13
  # @!attribute starting_billing_cycle
14
- # @return [Integer] Represents how many billing cycles are included in a ramp interval.
14
+ # @return [Integer] Represents the billing cycle where a ramp interval starts.
15
15
  define_attribute :starting_billing_cycle, Integer
16
16
 
17
17
  # @!attribute unit_amount
@@ -7,7 +7,7 @@ module Recurly
7
7
  class Usage < Resource
8
8
 
9
9
  # @!attribute amount
10
- # @return [Float] The amount of usage. Can be positive, negative, or 0. No decimals allowed, we will strip them. If the usage-based add-on is billed with a percentage, your usage will be a monetary amount you will want to format in cents. (e.g., $5.00 is "500").
10
+ # @return [Float] The amount of usage. Can be positive, negative, or 0. If the Decimal Quantity feature is enabled, this value will be rounded to nine decimal places. Otherwise, all digits after the decimal will be stripped. If the usage-based add-on is billed with a percentage, your usage should be a monetary amount formatted in cents (e.g., $5.00 is "500").
11
11
  define_attribute :amount, Float
12
12
 
13
13
  # @!attribute billed_at
@@ -1,3 +1,3 @@
1
1
  module Recurly
2
- VERSION = "3.21.0"
2
+ VERSION = "3.23.0"
3
3
  end
data/openapi/api.yaml CHANGED
@@ -57,7 +57,7 @@ info:
57
57
 
58
58
  We encourage you to update to the latest version of the API and corresponding client library,
59
59
  as most recent versions are more performant than their predecessors. See the
60
- [changelog](https://developers.recurly.com/api/changelog.html) for a comprehensive list of changes
60
+ [changelog](https://recurly.com/developers/api/changelog.html) for a comprehensive list of changes
61
61
  introduced in the latest API version.
62
62
 
63
63
  ### Default Versions
@@ -113,7 +113,7 @@ info:
113
113
  Please consider changing these messages in target system to be better
114
114
  suited to the audience of the system.
115
115
 
116
- Please see [transaction error codes](https://developers.recurly.com/pages/api-transaction-errors.html) for more details.
116
+ Please see [transaction error codes](https://recurly.com/developers/pages/api-transaction-errors.html) for more details.
117
117
 
118
118
  ## Pagination
119
119
  ### Response Schema
@@ -180,7 +180,7 @@ info:
180
180
 
181
181
  ## Change Log
182
182
 
183
- A list of changes for this version can be found [in the changelog](https://developers.recurly.com/api/changelog.html#v2019-10-10).
183
+ A list of changes for this version can be found [in the changelog](https://recurly.com/developers/api/changelog.html#v2019-10-10).
184
184
  version: v2019-10-10
185
185
  security:
186
186
  - api_key: []
@@ -304,6 +304,8 @@ tags:
304
304
  description: A purchase is a checkout containing at least one or more subscriptions
305
305
  or one-time charges (line items) and supports both coupon and gift card redemptions.
306
306
  All items purchased will be on one invoice and paid for with one transaction.
307
+ The purchases endpoint can also be used to immediately create a credit invoice
308
+ on an account, when Credit Invoices is enabled on your site.
307
309
  - name: usage
308
310
  x-displayName: Usage
309
311
  description: Send Recurly your customer usage and we will automatically bill them
@@ -343,7 +345,7 @@ paths:
343
345
  description: |
344
346
  This route is most useful for finding a site's ID for subsequent requests.
345
347
 
346
- See the [Pagination Guide](/guides/pagination.html) to learn how to use pagination in the API and Client Libraries.
348
+ See the [Pagination Guide](/developers/guides/pagination.html) to learn how to use pagination in the API and Client Libraries.
347
349
  tags:
348
350
  - site
349
351
  parameters:
@@ -542,8 +544,8 @@ paths:
542
544
  - account
543
545
  operationId: list_accounts
544
546
  summary: List a site's accounts
545
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
546
- to use pagination in the API and Client Libraries.
547
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
548
+ to learn how to use pagination in the API and Client Libraries.
547
549
  parameters:
548
550
  - "$ref": "#/components/parameters/site_id"
549
551
  - "$ref": "#/components/parameters/ids"
@@ -2425,8 +2427,8 @@ paths:
2425
2427
  - billing_infos
2426
2428
  operationId: list_billing_infos
2427
2429
  summary: Get the list of billing information associated with an account
2428
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
2429
- to use pagination in the API and Client Libraries.
2430
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
2431
+ to learn how to use pagination in the API and Client Libraries.
2430
2432
  parameters:
2431
2433
  - "$ref": "#/components/parameters/site_id"
2432
2434
  - "$ref": "#/components/parameters/account_id"
@@ -2634,9 +2636,9 @@ paths:
2634
2636
  tags:
2635
2637
  - coupon_redemption
2636
2638
  operationId: list_account_coupon_redemptions
2637
- summary: Show the coupon redemptions for an account
2638
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
2639
- to use pagination in the API and Client Libraries.
2639
+ summary: List the coupon redemptions for an account
2640
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
2641
+ to learn how to use pagination in the API and Client Libraries.
2640
2642
  parameters:
2641
2643
  - "$ref": "#/components/parameters/site_id"
2642
2644
  - "$ref": "#/components/parameters/account_id"
@@ -2723,7 +2725,7 @@ paths:
2723
2725
  tags:
2724
2726
  - coupon_redemption
2725
2727
  operationId: get_active_coupon_redemption
2726
- summary: Show the coupon redemption that is active on an account
2728
+ summary: Fetch the coupon redemption that is active on an account
2727
2729
  parameters:
2728
2730
  - "$ref": "#/components/parameters/site_id"
2729
2731
  - "$ref": "#/components/parameters/account_id"
@@ -3086,8 +3088,8 @@ paths:
3086
3088
  - credit_payment
3087
3089
  operationId: list_account_credit_payments
3088
3090
  summary: List an account's credit payments
3089
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
3090
- to use pagination in the API and Client Libraries.
3091
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
3092
+ to learn how to use pagination in the API and Client Libraries.
3091
3093
  parameters:
3092
3094
  - "$ref": "#/components/parameters/site_id"
3093
3095
  - "$ref": "#/components/parameters/account_id"
@@ -3181,8 +3183,8 @@ paths:
3181
3183
  - invoice
3182
3184
  operationId: list_account_invoices
3183
3185
  summary: List an account's invoices
3184
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
3185
- to use pagination in the API and Client Libraries.
3186
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
3187
+ to learn how to use pagination in the API and Client Libraries.
3186
3188
  parameters:
3187
3189
  - "$ref": "#/components/parameters/site_id"
3188
3190
  - "$ref": "#/components/parameters/account_id"
@@ -3617,8 +3619,8 @@ paths:
3617
3619
  - line_item
3618
3620
  operationId: list_account_line_items
3619
3621
  summary: List an account's line items
3620
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
3621
- to use pagination in the API and Client Libraries.
3622
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
3623
+ to learn how to use pagination in the API and Client Libraries.
3622
3624
  parameters:
3623
3625
  - "$ref": "#/components/parameters/site_id"
3624
3626
  - "$ref": "#/components/parameters/account_id"
@@ -3715,6 +3717,8 @@ paths:
3715
3717
  - line_item
3716
3718
  operationId: create_line_item
3717
3719
  summary: Create a new line item for the account
3720
+ description: When using the Credit Invoices feature, utilize the purchases endpoint
3721
+ in order to immediately post credit to a credit invoice.
3718
3722
  parameters:
3719
3723
  - "$ref": "#/components/parameters/site_id"
3720
3724
  - "$ref": "#/components/parameters/account_id"
@@ -3883,9 +3887,9 @@ paths:
3883
3887
  tags:
3884
3888
  - note
3885
3889
  operationId: list_account_notes
3886
- summary: Fetch a list of an account's notes
3887
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
3888
- to use pagination in the API and Client Libraries.
3890
+ summary: List an account's notes
3891
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
3892
+ to learn how to use pagination in the API and Client Libraries.
3889
3893
  parameters:
3890
3894
  - "$ref": "#/components/parameters/site_id"
3891
3895
  - "$ref": "#/components/parameters/account_id"
@@ -4092,8 +4096,8 @@ paths:
4092
4096
  - shipping_address
4093
4097
  operationId: list_shipping_addresses
4094
4098
  summary: Fetch a list of an account's shipping addresses
4095
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
4096
- to use pagination in the API and Client Libraries.
4099
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
4100
+ to learn how to use pagination in the API and Client Libraries.
4097
4101
  parameters:
4098
4102
  - "$ref": "#/components/parameters/site_id"
4099
4103
  - "$ref": "#/components/parameters/account_id"
@@ -4771,8 +4775,8 @@ paths:
4771
4775
  - subscription
4772
4776
  operationId: list_account_subscriptions
4773
4777
  summary: List an account's subscriptions
4774
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
4775
- to use pagination in the API and Client Libraries.
4778
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
4779
+ to learn how to use pagination in the API and Client Libraries.
4776
4780
  parameters:
4777
4781
  - "$ref": "#/components/parameters/site_id"
4778
4782
  - "$ref": "#/components/parameters/account_id"
@@ -4867,8 +4871,8 @@ paths:
4867
4871
  - transaction
4868
4872
  operationId: list_account_transactions
4869
4873
  summary: List an account's transactions
4870
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
4871
- to use pagination in the API and Client Libraries.
4874
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
4875
+ to learn how to use pagination in the API and Client Libraries.
4872
4876
  parameters:
4873
4877
  - "$ref": "#/components/parameters/site_id"
4874
4878
  - "$ref": "#/components/parameters/account_id"
@@ -4965,8 +4969,8 @@ paths:
4965
4969
  - account
4966
4970
  operationId: list_child_accounts
4967
4971
  summary: List an account's child accounts
4968
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
4969
- to use pagination in the API and Client Libraries.
4972
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
4973
+ to learn how to use pagination in the API and Client Libraries.
4970
4974
  parameters:
4971
4975
  - "$ref": "#/components/parameters/site_id"
4972
4976
  - "$ref": "#/components/parameters/account_id"
@@ -5040,8 +5044,8 @@ paths:
5040
5044
  - account_acquisition
5041
5045
  operationId: list_account_acquisition
5042
5046
  summary: List a site's account acquisition data
5043
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
5044
- to use pagination in the API and Client Libraries.
5047
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
5048
+ to learn how to use pagination in the API and Client Libraries.
5045
5049
  parameters:
5046
5050
  - "$ref": "#/components/parameters/site_id"
5047
5051
  - "$ref": "#/components/parameters/ids"
@@ -5132,8 +5136,8 @@ paths:
5132
5136
  - coupon
5133
5137
  operationId: list_coupons
5134
5138
  summary: List a site's coupons
5135
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
5136
- to use pagination in the API and Client Libraries.
5139
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
5140
+ to learn how to use pagination in the API and Client Libraries.
5137
5141
  parameters:
5138
5142
  - "$ref": "#/components/parameters/site_id"
5139
5143
  - "$ref": "#/components/parameters/ids"
@@ -5995,8 +5999,8 @@ paths:
5995
5999
  - unique_coupon_code
5996
6000
  operationId: list_unique_coupon_codes
5997
6001
  summary: List unique coupon codes associated with a bulk coupon
5998
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
5999
- to use pagination in the API and Client Libraries.
6002
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
6003
+ to learn how to use pagination in the API and Client Libraries.
6000
6004
  parameters:
6001
6005
  - "$ref": "#/components/parameters/site_id"
6002
6006
  - "$ref": "#/components/parameters/coupon_id"
@@ -6032,8 +6036,8 @@ paths:
6032
6036
  - credit_payment
6033
6037
  operationId: list_credit_payments
6034
6038
  summary: List a site's credit payments
6035
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
6036
- to use pagination in the API and Client Libraries.
6039
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
6040
+ to learn how to use pagination in the API and Client Libraries.
6037
6041
  parameters:
6038
6042
  - "$ref": "#/components/parameters/site_id"
6039
6043
  - "$ref": "#/components/parameters/limit"
@@ -6151,8 +6155,8 @@ paths:
6151
6155
  - custom_field_definition
6152
6156
  operationId: list_custom_field_definitions
6153
6157
  summary: List a site's custom field definitions
6154
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
6155
- to use pagination in the API and Client Libraries.
6158
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
6159
+ to learn how to use pagination in the API and Client Libraries.
6156
6160
  parameters:
6157
6161
  - "$ref": "#/components/parameters/site_id"
6158
6162
  - "$ref": "#/components/parameters/ids"
@@ -6169,6 +6173,7 @@ paths:
6169
6173
  enum:
6170
6174
  - account
6171
6175
  - item
6176
+ - plan
6172
6177
  - subscription
6173
6178
  responses:
6174
6179
  '200':
@@ -6369,8 +6374,8 @@ paths:
6369
6374
  - item
6370
6375
  operationId: list_items
6371
6376
  summary: List a site's items
6372
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
6373
- to use pagination in the API and Client Libraries.
6377
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
6378
+ to learn how to use pagination in the API and Client Libraries.
6374
6379
  parameters:
6375
6380
  - "$ref": "#/components/parameters/site_id"
6376
6381
  - "$ref": "#/components/parameters/ids"
@@ -7191,8 +7196,8 @@ paths:
7191
7196
  - measured_unit
7192
7197
  operationId: list_measured_unit
7193
7198
  summary: List a site's measured units
7194
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
7195
- to use pagination in the API and Client Libraries.
7199
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
7200
+ to learn how to use pagination in the API and Client Libraries.
7196
7201
  parameters:
7197
7202
  - "$ref": "#/components/parameters/site_id"
7198
7203
  - "$ref": "#/components/parameters/ids"
@@ -7377,8 +7382,8 @@ paths:
7377
7382
  - invoice
7378
7383
  operationId: list_invoices
7379
7384
  summary: List a site's invoices
7380
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
7381
- to use pagination in the API and Client Libraries.
7385
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
7386
+ to learn how to use pagination in the API and Client Libraries.
7382
7387
  parameters:
7383
7388
  - "$ref": "#/components/parameters/site_id"
7384
7389
  - "$ref": "#/components/parameters/ids"
@@ -7868,6 +7873,44 @@ paths:
7868
7873
  // Something bad happened... tell the user so that they can fix it?
7869
7874
  echo 'Some unexpected Recurly error happened. Try again later.' . PHP_EOL;
7870
7875
  }
7876
+ "/sites/{site_id}/invoices/{invoice_id}/apply_credit_balance":
7877
+ put:
7878
+ tags:
7879
+ - invoice
7880
+ operationId: apply_credit_balance
7881
+ summary: Apply available credit to a pending or past due charge invoice
7882
+ description: Apply credit payment to the outstanding balance on an existing
7883
+ charge invoice from an account’s available balance from existing credit invoices.
7884
+ parameters:
7885
+ - "$ref": "#/components/parameters/site_id"
7886
+ - "$ref": "#/components/parameters/invoice_id"
7887
+ responses:
7888
+ '200':
7889
+ description: The updated invoice.
7890
+ content:
7891
+ application/json:
7892
+ schema:
7893
+ "$ref": "#/components/schemas/Invoice"
7894
+ '404':
7895
+ description: Incorrect site or invoice ID.
7896
+ content:
7897
+ application/json:
7898
+ schema:
7899
+ "$ref": "#/components/schemas/Error"
7900
+ '422':
7901
+ description: Tried applying credit to a legacy or closed invoice or there
7902
+ was an error processing the credit payment.
7903
+ content:
7904
+ application/json:
7905
+ schema:
7906
+ "$ref": "#/components/schemas/Error"
7907
+ default:
7908
+ description: Unexpected error.
7909
+ content:
7910
+ application/json:
7911
+ schema:
7912
+ "$ref": "#/components/schemas/Error"
7913
+ x-code-samples: []
7871
7914
  "/sites/{site_id}/invoices/{invoice_id}/collect":
7872
7915
  put:
7873
7916
  tags:
@@ -8557,8 +8600,8 @@ paths:
8557
8600
  - line_item
8558
8601
  operationId: list_invoice_line_items
8559
8602
  summary: List an invoice's line items
8560
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
8561
- to use pagination in the API and Client Libraries.
8603
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
8604
+ to learn how to use pagination in the API and Client Libraries.
8562
8605
  parameters:
8563
8606
  - "$ref": "#/components/parameters/site_id"
8564
8607
  - "$ref": "#/components/parameters/invoice_id"
@@ -8658,9 +8701,9 @@ paths:
8658
8701
  tags:
8659
8702
  - coupon_redemption
8660
8703
  operationId: list_invoice_coupon_redemptions
8661
- summary: Show the coupon redemptions applied to an invoice
8662
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
8663
- to use pagination in the API and Client Libraries.
8704
+ summary: List the coupon redemptions applied to an invoice
8705
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
8706
+ to learn how to use pagination in the API and Client Libraries.
8664
8707
  parameters:
8665
8708
  - "$ref": "#/components/parameters/site_id"
8666
8709
  - "$ref": "#/components/parameters/invoice_id"
@@ -8756,7 +8799,7 @@ paths:
8756
8799
  For a charge invoice the related invoices will be credit invoices.
8757
8800
  For a credit invoice the related invoices will be charge invoices.
8758
8801
 
8759
- See the [Pagination Guide](/guides/pagination.html) to learn how to use pagination in the API and Client Libraries.
8802
+ See the [Pagination Guide](/developers/guides/pagination.html) to learn how to use pagination in the API and Client Libraries.
8760
8803
  parameters:
8761
8804
  - "$ref": "#/components/parameters/site_id"
8762
8805
  - "$ref": "#/components/parameters/invoice_id"
@@ -9006,8 +9049,8 @@ paths:
9006
9049
  - line_item
9007
9050
  operationId: list_line_items
9008
9051
  summary: List a site's line items
9009
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
9010
- to use pagination in the API and Client Libraries.
9052
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
9053
+ to learn how to use pagination in the API and Client Libraries.
9011
9054
  parameters:
9012
9055
  - "$ref": "#/components/parameters/site_id"
9013
9056
  - "$ref": "#/components/parameters/ids"
@@ -9336,8 +9379,8 @@ paths:
9336
9379
  - plan
9337
9380
  operationId: list_plans
9338
9381
  summary: List a site's plans
9339
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
9340
- to use pagination in the API and Client Libraries.
9382
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
9383
+ to learn how to use pagination in the API and Client Libraries.
9341
9384
  parameters:
9342
9385
  - "$ref": "#/components/parameters/site_id"
9343
9386
  - "$ref": "#/components/parameters/ids"
@@ -9997,8 +10040,8 @@ paths:
9997
10040
  - add-on
9998
10041
  operationId: list_plan_add_ons
9999
10042
  summary: List a plan's add-ons
10000
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
10001
- to use pagination in the API and Client Libraries.
10043
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
10044
+ to learn how to use pagination in the API and Client Libraries.
10002
10045
  parameters:
10003
10046
  - "$ref": "#/components/parameters/site_id"
10004
10047
  - "$ref": "#/components/parameters/plan_id"
@@ -10659,8 +10702,8 @@ paths:
10659
10702
  - add-on
10660
10703
  operationId: list_add_ons
10661
10704
  summary: List a site's add-ons
10662
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
10663
- to use pagination in the API and Client Libraries.
10705
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
10706
+ to learn how to use pagination in the API and Client Libraries.
10664
10707
  parameters:
10665
10708
  - "$ref": "#/components/parameters/site_id"
10666
10709
  - "$ref": "#/components/parameters/ids"
@@ -10869,8 +10912,8 @@ paths:
10869
10912
  - shipping_method
10870
10913
  operationId: list_shipping_methods
10871
10914
  summary: List a site's shipping methods
10872
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
10873
- to use pagination in the API and Client Libraries.
10915
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
10916
+ to learn how to use pagination in the API and Client Libraries.
10874
10917
  parameters:
10875
10918
  - "$ref": "#/components/parameters/site_id"
10876
10919
  - "$ref": "#/components/parameters/ids"
@@ -11120,8 +11163,8 @@ paths:
11120
11163
  - subscription
11121
11164
  operationId: list_subscriptions
11122
11165
  summary: List a site's subscriptions
11123
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
11124
- to use pagination in the API and Client Libraries.
11166
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
11167
+ to learn how to use pagination in the API and Client Libraries.
11125
11168
  parameters:
11126
11169
  - "$ref": "#/components/parameters/site_id"
11127
11170
  - "$ref": "#/components/parameters/ids"
@@ -12912,8 +12955,8 @@ paths:
12912
12955
  - invoice
12913
12956
  operationId: list_subscription_invoices
12914
12957
  summary: List a subscription's invoices
12915
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
12916
- to use pagination in the API and Client Libraries.
12958
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
12959
+ to learn how to use pagination in the API and Client Libraries.
12917
12960
  parameters:
12918
12961
  - "$ref": "#/components/parameters/site_id"
12919
12962
  - "$ref": "#/components/parameters/subscription_id"
@@ -13009,8 +13052,8 @@ paths:
13009
13052
  - line_item
13010
13053
  operationId: list_subscription_line_items
13011
13054
  summary: List a subscription's line items
13012
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
13013
- to use pagination in the API and Client Libraries.
13055
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
13056
+ to learn how to use pagination in the API and Client Libraries.
13014
13057
  parameters:
13015
13058
  - "$ref": "#/components/parameters/site_id"
13016
13059
  - "$ref": "#/components/parameters/subscription_id"
@@ -13107,9 +13150,9 @@ paths:
13107
13150
  tags:
13108
13151
  - coupon_redemption
13109
13152
  operationId: list_subscription_coupon_redemptions
13110
- summary: Show the coupon redemptions for a subscription
13111
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
13112
- to use pagination in the API and Client Libraries.
13153
+ summary: List the coupon redemptions for a subscription
13154
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
13155
+ to learn how to use pagination in the API and Client Libraries.
13113
13156
  parameters:
13114
13157
  - "$ref": "#/components/parameters/site_id"
13115
13158
  - "$ref": "#/components/parameters/subscription_id"
@@ -13402,8 +13445,8 @@ paths:
13402
13445
  - transaction
13403
13446
  operationId: list_transactions
13404
13447
  summary: List a site's transactions
13405
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
13406
- to use pagination in the API and Client Libraries.
13448
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
13449
+ to learn how to use pagination in the API and Client Libraries.
13407
13450
  parameters:
13408
13451
  - "$ref": "#/components/parameters/site_id"
13409
13452
  - "$ref": "#/components/parameters/ids"
@@ -14403,9 +14446,9 @@ paths:
14403
14446
  tags:
14404
14447
  - dunning_campaigns
14405
14448
  operationId: list_dunning_campaigns
14406
- summary: Show the dunning campaigns for a site
14407
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
14408
- to use pagination in the API and Client Libraries.
14449
+ summary: List the dunning campaigns for a site
14450
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
14451
+ to learn how to use pagination in the API and Client Libraries.
14409
14452
  parameters:
14410
14453
  - "$ref": "#/components/parameters/sort_dates"
14411
14454
  responses:
@@ -14435,7 +14478,7 @@ paths:
14435
14478
  tags:
14436
14479
  - dunning_campaigns
14437
14480
  operationId: get_dunning_campaign
14438
- summary: Show the settings for a dunning campaign
14481
+ summary: Fetch a dunning campaign
14439
14482
  responses:
14440
14483
  '200':
14441
14484
  description: Settings for a dunning campaign.
@@ -14463,6 +14506,8 @@ paths:
14463
14506
  "$ref": "#/components/schemas/Error"
14464
14507
  x-code-samples: []
14465
14508
  "/dunning_campaigns/{dunning_campaign_id}/bulk_update":
14509
+ parameters:
14510
+ - "$ref": "#/components/parameters/dunning_campaign_id"
14466
14511
  put:
14467
14512
  tags:
14468
14513
  - dunning_campaigns
@@ -15721,9 +15766,15 @@ components:
15721
15766
  processing_prepayment_amount:
15722
15767
  type: number
15723
15768
  format: float
15724
- title: Amount
15769
+ title: Processing Prepayment Amount
15725
15770
  description: Total amount for the prepayment credit invoices in a `processing`
15726
15771
  state on the account.
15772
+ available_credit_amount:
15773
+ type: number
15774
+ format: float
15775
+ title: Available Credit Amount
15776
+ description: Total amount of the open balances on credit invoices for the
15777
+ account.
15727
15778
  InvoiceAddress:
15728
15779
  allOf:
15729
15780
  - "$ref": "#/components/schemas/Address"
@@ -16059,7 +16110,7 @@ components:
16059
16110
  title: Usage Type
16060
16111
  description: |
16061
16112
  Type of usage, required if `add_on_type` is `usage`. See our
16062
- [Guide](https://developers.recurly.com/guides/usage-based-billing-guide.html)
16113
+ [Guide](https://recurly.com/developers/guides/usage-based-billing-guide.html)
16063
16114
  for an overview of how to configure usage add-ons.
16064
16115
  usage_percentage:
16065
16116
  type: number
@@ -16175,7 +16226,7 @@ components:
16175
16226
  description: |
16176
16227
  The pricing model for the add-on. For more information,
16177
16228
  [click here](https://docs.recurly.com/docs/billing-models#section-quantity-based). See
16178
- our [Guide](https://developers.recurly.com/guides/item-addon-guide.html) for an overview
16229
+ our [Guide](https://recurly.com/developers/guides/item-addon-guide.html) for an overview
16179
16230
  of how to configure quantity-based pricing models.
16180
16231
  default: flat
16181
16232
  enum:
@@ -16426,7 +16477,7 @@ components:
16426
16477
  token_id:
16427
16478
  type: string
16428
16479
  title: Token ID
16429
- description: A token [generated by Recurly.js](https://developers.recurly.com/reference/recurly-js/#getting-a-token).
16480
+ description: A token [generated by Recurly.js](https://recurly.com/developers/reference/recurly-js/#getting-a-token).
16430
16481
  maxLength: 22
16431
16482
  first_name:
16432
16483
  type: string
@@ -17289,6 +17340,7 @@ components:
17289
17340
  enum:
17290
17341
  - account
17291
17342
  - item
17343
+ - plan
17292
17344
  - subscription
17293
17345
  name:
17294
17346
  type: string
@@ -18423,6 +18475,14 @@ components:
18423
18475
  description: This number will be multiplied by the unit amount to compute
18424
18476
  the subtotal before any discounts or taxes.
18425
18477
  default: 1
18478
+ quantity_decimal:
18479
+ type: string
18480
+ title: Quantity Decimal
18481
+ description: A floating-point alternative to Quantity. If this value is
18482
+ present, it will be used in place of Quantity for calculations, and Quantity
18483
+ will be the rounded integer value of this number. This field supports
18484
+ up to 9 decimal places. The Decimal Quantity feature must be enabled to
18485
+ utilize this field.
18426
18486
  unit_amount:
18427
18487
  type: number
18428
18488
  format: float
@@ -18503,6 +18563,13 @@ components:
18503
18563
  title: Refunded Quantity
18504
18564
  description: For refund charges, the quantity being refunded. For non-refund
18505
18565
  charges, the total quantity refunded (possibly over multiple refunds).
18566
+ refunded_quantity_decimal:
18567
+ type: string
18568
+ title: Refunded Quantity Decimal
18569
+ description: A floating-point alternative to Refunded Quantity. For refund
18570
+ charges, the quantity being refunded. For non-refund charges, the total
18571
+ quantity refunded (possibly over multiple refunds). The Decimal Quantity
18572
+ feature must be enabled to utilize this field.
18506
18573
  credit_applied:
18507
18574
  type: number
18508
18575
  format: float
@@ -18544,6 +18611,14 @@ components:
18544
18611
  type: integer
18545
18612
  title: Quantity
18546
18613
  description: Line item quantity to be refunded.
18614
+ quantity_decimal:
18615
+ type: string
18616
+ title: Quantity Decimal
18617
+ description: A floating-point alternative to Quantity. If this value is
18618
+ present, it will be used in place of Quantity for calculations, and Quantity
18619
+ will be the rounded integer value of this number. This field supports
18620
+ up to 9 decimal places. The Decimal Quantity feature must be enabled to
18621
+ utilize this field.
18547
18622
  prorate:
18548
18623
  type: boolean
18549
18624
  title: Prorate
@@ -18844,6 +18919,8 @@ components:
18844
18919
  title: Ramp Intervals
18845
18920
  items:
18846
18921
  "$ref": "#/components/schemas/PlanRampInterval"
18922
+ custom_fields:
18923
+ "$ref": "#/components/schemas/CustomFields"
18847
18924
  accounting_code:
18848
18925
  type: string
18849
18926
  title: Plan accounting code
@@ -19038,6 +19115,8 @@ components:
19038
19115
  title: Ramp Intervals
19039
19116
  items:
19040
19117
  "$ref": "#/components/schemas/PlanRampInterval"
19118
+ custom_fields:
19119
+ "$ref": "#/components/schemas/CustomFields"
19041
19120
  revenue_schedule_type:
19042
19121
  type: string
19043
19122
  title: Revenue schedule type
@@ -19252,6 +19331,8 @@ components:
19252
19331
  title: Ramp Intervals
19253
19332
  items:
19254
19333
  "$ref": "#/components/schemas/PlanRampInterval"
19334
+ custom_fields:
19335
+ "$ref": "#/components/schemas/CustomFields"
19255
19336
  revenue_schedule_type:
19256
19337
  type: string
19257
19338
  title: Revenue schedule type
@@ -19335,7 +19416,7 @@ components:
19335
19416
  properties:
19336
19417
  starting_billing_cycle:
19337
19418
  type: integer
19338
- description: Represents the first billing cycle of a ramp.
19419
+ description: Represents the billing cycle where a ramp interval starts.
19339
19420
  default: 1
19340
19421
  currencies:
19341
19422
  type: array
@@ -20232,7 +20313,7 @@ components:
20232
20313
  If the plan add-on's `tier_type` is `flat`, then `tiers` must be absent. The `tiers` object
20233
20314
  must include one to many tiers with `ending_quantity` and `unit_amount`.
20234
20315
  There must be one tier with an `ending_quantity` of 999999999 which is the
20235
- default if not provided. See our [Guide](https://developers.recurly.com/guides/item-addon-guide.html)
20316
+ default if not provided. See our [Guide](https://recurly.com/developers/guides/item-addon-guide.html)
20236
20317
  for an overview of how to configure quantity-based pricing models.
20237
20318
  usage_percentage:
20238
20319
  type: number
@@ -20241,7 +20322,7 @@ components:
20241
20322
  description: The percentage taken of the monetary amount of usage tracked.
20242
20323
  This can be up to 4 decimal places. A value between 0.0 and 100.0. Required
20243
20324
  if `add_on_type` is usage and `usage_type` is percentage. Must be omitted
20244
- otherwise. `usage_percentage` does not support tiers. See our [Guide](https://developers.recurly.com/guides/usage-based-billing-guide.html)
20325
+ otherwise. `usage_percentage` does not support tiers. See our [Guide](https://recurly.com/developers/guides/usage-based-billing-guide.html)
20245
20326
  for an overview of how to configure usage add-ons.
20246
20327
  revenue_schedule_type:
20247
20328
  type: string
@@ -21093,7 +21174,7 @@ components:
21093
21174
  properties:
21094
21175
  starting_billing_cycle:
21095
21176
  type: integer
21096
- description: Represents how many billing cycles are included in a ramp interval.
21177
+ description: Represents the billing cycle where a ramp interval starts.
21097
21178
  default: 1
21098
21179
  unit_amount:
21099
21180
  type: integer
@@ -21104,7 +21185,7 @@ components:
21104
21185
  properties:
21105
21186
  starting_billing_cycle:
21106
21187
  type: integer
21107
- description: Represents how many billing cycles are included in a ramp interval.
21188
+ description: Represents the billing cycle where a ramp interval starts.
21108
21189
  remaining_billing_cycles:
21109
21190
  type: integer
21110
21191
  description: Represents how many billing cycles are left in a ramp interval.
@@ -21533,10 +21614,11 @@ components:
21533
21614
  amount:
21534
21615
  type: number
21535
21616
  format: float
21536
- description: The amount of usage. Can be positive, negative, or 0. No decimals
21537
- allowed, we will strip them. If the usage-based add-on is billed with
21538
- a percentage, your usage will be a monetary amount you will want to format
21539
- in cents. (e.g., $5.00 is "500").
21617
+ description: The amount of usage. Can be positive, negative, or 0. If the
21618
+ Decimal Quantity feature is enabled, this value will be rounded to nine
21619
+ decimal places. Otherwise, all digits after the decimal will be stripped.
21620
+ If the usage-based add-on is billed with a percentage, your usage should
21621
+ be a monetary amount formatted in cents (e.g., $5.00 is "500").
21540
21622
  usage_type:
21541
21623
  type: string
21542
21624
  enum:
@@ -21609,10 +21691,11 @@ components:
21609
21691
  amount:
21610
21692
  type: number
21611
21693
  format: float
21612
- description: The amount of usage. Can be positive, negative, or 0. No decimals
21613
- allowed, we will strip them. If the usage-based add-on is billed with
21614
- a percentage, your usage will be a monetary amount you will want to format
21615
- in cents. (e.g., $5.00 is "500").
21694
+ description: The amount of usage. Can be positive, negative, or 0. If the
21695
+ Decimal Quantity feature is enabled, this value will be rounded to nine
21696
+ decimal places. Otherwise, all digits after the decimal will be stripped.
21697
+ If the usage-based add-on is billed with a percentage, your usage should
21698
+ be a monetary amount formatted in cents (e.g., $5.00 is "500").
21616
21699
  recording_timestamp:
21617
21700
  type: string
21618
21701
  format: date-time
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: recurly
3
3
  version: !ruby/object:Gem::Version
4
- version: 3.21.0
4
+ version: 3.23.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Recurly
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2022-08-03 00:00:00.000000000 Z
11
+ date: 2022-11-17 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: bundler
@@ -306,7 +306,7 @@ metadata:
306
306
  changelog_uri: https://github.com/recurly/recurly-client-ruby/blob/master/CHANGELOG.md
307
307
  documentation_uri: https://recurly.github.io/recurly-client-ruby/
308
308
  homepage_uri: https://github.com/recurly/recurly-client-ruby
309
- source_code_uri: https://github.com/recurly/recurly-client-ruby/tree/3.21.0
309
+ source_code_uri: https://github.com/recurly/recurly-client-ruby/tree/3.23.0
310
310
  post_install_message:
311
311
  rdoc_options: []
312
312
  require_paths: