recurly 3.20.0 → 3.21.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.bumpversion.cfg +1 -1
- data/CHANGELOG.md +12 -0
- data/GETTING_STARTED.md +1 -1
- data/lib/recurly/requests/plan_create.rb +8 -0
- data/lib/recurly/requests/plan_pricing.rb +1 -1
- data/lib/recurly/requests/plan_ramp_interval.rb +18 -0
- data/lib/recurly/requests/plan_ramp_pricing.rb +18 -0
- data/lib/recurly/requests/plan_update.rb +4 -0
- data/lib/recurly/requests/subscription_change_create.rb +4 -0
- data/lib/recurly/requests/subscription_create.rb +4 -0
- data/lib/recurly/requests/subscription_purchase.rb +4 -0
- data/lib/recurly/requests/subscription_ramp_interval.rb +18 -0
- data/lib/recurly/resources/line_item.rb +4 -0
- data/lib/recurly/resources/plan.rb +8 -0
- data/lib/recurly/resources/plan_pricing.rb +1 -1
- data/lib/recurly/resources/plan_ramp_interval.rb +18 -0
- data/lib/recurly/resources/plan_ramp_pricing.rb +18 -0
- data/lib/recurly/resources/subscription.rb +8 -0
- data/lib/recurly/resources/subscription_change.rb +4 -0
- data/lib/recurly/resources/subscription_change_preview.rb +4 -0
- data/lib/recurly/resources/subscription_ramp_interval_response.rb +22 -0
- data/lib/recurly/version.rb +1 -1
- data/openapi/api.yaml +138 -1
- metadata +9 -3
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: b9218a6c207426f02771031f66b2f5def8e22805b4dd7e0d565909a943404bff
|
4
|
+
data.tar.gz: 3269a3003e8446cabf915d742a554eb94af0f3e6fe5511de6f602b6adf41e287
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: f0dfe2d431ebbcacc24aa32c9bed1477e0ecec23235c6ed63bcfd94a2640508da40d635b30b205515c88f14d4f51f7b2e00a39f0c0fb6d36bab56730285885b5
|
7
|
+
data.tar.gz: 0b76576ac5143019670a2c69320c801ac7c47df22661b703ee393313dbac7a3b542c46e2ff5dbfb0a9a04136f0389ab934957b0d9e3427838c60ffe6b44dd5ba
|
data/.bumpversion.cfg
CHANGED
data/CHANGELOG.md
CHANGED
@@ -1,5 +1,17 @@
|
|
1
1
|
# Changelog
|
2
2
|
|
3
|
+
## [3.21.0](https://github.com/recurly/recurly-client-ruby/tree/3.21.0) (2022-08-03)
|
4
|
+
|
5
|
+
[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/3.20.0...3.21.0)
|
6
|
+
|
7
|
+
|
8
|
+
**Merged Pull Requests**
|
9
|
+
|
10
|
+
- Generated Latest Changes for v2019-10-10 [#782](https://github.com/recurly/recurly-client-ruby/pull/782) ([recurly-integrations](https://github.com/recurly-integrations))
|
11
|
+
- Generated Latest Changes for v2019-10-10 [#779](https://github.com/recurly/recurly-client-ruby/pull/779) ([recurly-integrations](https://github.com/recurly-integrations))
|
12
|
+
|
13
|
+
|
14
|
+
|
3
15
|
## [3.20.0](https://github.com/recurly/recurly-client-ruby/tree/3.20.0) (2022-06-16)
|
4
16
|
|
5
17
|
[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/3.19.0...3.20.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.
|
8
|
+
gem 'recurly', '~> 3.21'
|
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.
|
@@ -62,6 +62,14 @@ module Recurly
|
|
62
62
|
# @return [String] This name describes your plan and will appear on the Hosted Payment Page and the subscriber's invoice.
|
63
63
|
define_attribute :name, String
|
64
64
|
|
65
|
+
# @!attribute pricing_model
|
66
|
+
# @return [String] A fixed pricing model has the same price for each billing period. A ramp pricing model defines a set of Ramp Intervals, where a subscription changes price on a specified cadence of billing periods. The price change could be an increase or decrease.
|
67
|
+
define_attribute :pricing_model, String
|
68
|
+
|
69
|
+
# @!attribute ramp_intervals
|
70
|
+
# @return [Array[PlanRampInterval]] Ramp Intervals
|
71
|
+
define_attribute :ramp_intervals, Array, { :item_type => :PlanRampInterval }
|
72
|
+
|
65
73
|
# @!attribute revenue_schedule_type
|
66
74
|
# @return [String] Revenue schedule type
|
67
75
|
define_attribute :revenue_schedule_type, String
|
@@ -19,7 +19,7 @@ module Recurly
|
|
19
19
|
define_attribute :tax_inclusive, :Boolean
|
20
20
|
|
21
21
|
# @!attribute unit_amount
|
22
|
-
# @return [Float]
|
22
|
+
# @return [Float] This field should not be sent when the pricing model is 'ramp'.
|
23
23
|
define_attribute :unit_amount, Float
|
24
24
|
end
|
25
25
|
end
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# This file is automatically created by Recurly's OpenAPI generation process
|
2
|
+
# and thus any edits you make by hand will be lost. If you wish to make a
|
3
|
+
# change to this file, please create a Github issue explaining the changes you
|
4
|
+
# need and we will usher them to the appropriate places.
|
5
|
+
module Recurly
|
6
|
+
module Requests
|
7
|
+
class PlanRampInterval < Request
|
8
|
+
|
9
|
+
# @!attribute currencies
|
10
|
+
# @return [Array[PlanRampPricing]] Represents the price for the ramp interval.
|
11
|
+
define_attribute :currencies, Array, { :item_type => :PlanRampPricing }
|
12
|
+
|
13
|
+
# @!attribute starting_billing_cycle
|
14
|
+
# @return [Integer] Represents the first billing cycle of a ramp.
|
15
|
+
define_attribute :starting_billing_cycle, Integer
|
16
|
+
end
|
17
|
+
end
|
18
|
+
end
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# This file is automatically created by Recurly's OpenAPI generation process
|
2
|
+
# and thus any edits you make by hand will be lost. If you wish to make a
|
3
|
+
# change to this file, please create a Github issue explaining the changes you
|
4
|
+
# need and we will usher them to the appropriate places.
|
5
|
+
module Recurly
|
6
|
+
module Requests
|
7
|
+
class PlanRampPricing < Request
|
8
|
+
|
9
|
+
# @!attribute currency
|
10
|
+
# @return [String] 3-letter ISO 4217 currency code.
|
11
|
+
define_attribute :currency, String
|
12
|
+
|
13
|
+
# @!attribute unit_amount
|
14
|
+
# @return [Float] Represents the price for the Ramp Interval.
|
15
|
+
define_attribute :unit_amount, Float
|
16
|
+
end
|
17
|
+
end
|
18
|
+
end
|
@@ -54,6 +54,10 @@ module Recurly
|
|
54
54
|
# @return [String] This name describes your plan and will appear on the Hosted Payment Page and the subscriber's invoice.
|
55
55
|
define_attribute :name, String
|
56
56
|
|
57
|
+
# @!attribute ramp_intervals
|
58
|
+
# @return [Array[PlanRampInterval]] Ramp Intervals
|
59
|
+
define_attribute :ramp_intervals, Array, { :item_type => :PlanRampInterval }
|
60
|
+
|
57
61
|
# @!attribute revenue_schedule_type
|
58
62
|
# @return [String] Revenue schedule type
|
59
63
|
define_attribute :revenue_schedule_type, String
|
@@ -46,6 +46,10 @@ module Recurly
|
|
46
46
|
# @return [Integer] Optionally override the default quantity of 1.
|
47
47
|
define_attribute :quantity, Integer
|
48
48
|
|
49
|
+
# @!attribute ramp_intervals
|
50
|
+
# @return [Array[SubscriptionRampInterval]] The new set of ramp intervals for the subscription.
|
51
|
+
define_attribute :ramp_intervals, Array, { :item_type => :SubscriptionRampInterval }
|
52
|
+
|
49
53
|
# @!attribute revenue_schedule_type
|
50
54
|
# @return [String] Revenue schedule type
|
51
55
|
define_attribute :revenue_schedule_type, String
|
@@ -70,6 +70,10 @@ module Recurly
|
|
70
70
|
# @return [Integer] Optionally override the default quantity of 1.
|
71
71
|
define_attribute :quantity, Integer
|
72
72
|
|
73
|
+
# @!attribute ramp_intervals
|
74
|
+
# @return [Array[SubscriptionRampInterval]] The new set of ramp intervals for the subscription.
|
75
|
+
define_attribute :ramp_intervals, Array, { :item_type => :SubscriptionRampInterval }
|
76
|
+
|
73
77
|
# @!attribute renewal_billing_cycles
|
74
78
|
# @return [Integer] If `auto_renew=true`, when a term completes, `total_billing_cycles` takes this value as the length of subsequent terms. Defaults to the plan's `total_billing_cycles`.
|
75
79
|
define_attribute :renewal_billing_cycles, Integer
|
@@ -34,6 +34,10 @@ module Recurly
|
|
34
34
|
# @return [Integer] Optionally override the default quantity of 1.
|
35
35
|
define_attribute :quantity, Integer
|
36
36
|
|
37
|
+
# @!attribute ramp_intervals
|
38
|
+
# @return [Array[SubscriptionRampInterval]] The new set of ramp intervals for the subscription.
|
39
|
+
define_attribute :ramp_intervals, Array, { :item_type => :SubscriptionRampInterval }
|
40
|
+
|
37
41
|
# @!attribute renewal_billing_cycles
|
38
42
|
# @return [Integer] If `auto_renew=true`, when a term completes, `total_billing_cycles` takes this value as the length of subsequent terms. Defaults to the plan's `total_billing_cycles`.
|
39
43
|
define_attribute :renewal_billing_cycles, Integer
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# This file is automatically created by Recurly's OpenAPI generation process
|
2
|
+
# and thus any edits you make by hand will be lost. If you wish to make a
|
3
|
+
# change to this file, please create a Github issue explaining the changes you
|
4
|
+
# need and we will usher them to the appropriate places.
|
5
|
+
module Recurly
|
6
|
+
module Requests
|
7
|
+
class SubscriptionRampInterval < Request
|
8
|
+
|
9
|
+
# @!attribute starting_billing_cycle
|
10
|
+
# @return [Integer] Represents how many billing cycles are included in a ramp interval.
|
11
|
+
define_attribute :starting_billing_cycle, Integer
|
12
|
+
|
13
|
+
# @!attribute unit_amount
|
14
|
+
# @return [Integer] Represents the price for the ramp interval.
|
15
|
+
define_attribute :unit_amount, Integer
|
16
|
+
end
|
17
|
+
end
|
18
|
+
end
|
@@ -174,6 +174,10 @@ module Recurly
|
|
174
174
|
# @return [Boolean] `true` exempts tax on charges, `false` applies tax on charges. If not defined, then defaults to the Plan and Site settings. This attribute does not work for credits (negative line items). Credits are always applied post-tax. Pre-tax discounts should use the Coupons feature.
|
175
175
|
define_attribute :tax_exempt, :Boolean
|
176
176
|
|
177
|
+
# @!attribute tax_inclusive
|
178
|
+
# @return [Boolean] Determines whether or not tax is included in the unit amount. The Tax Inclusive Pricing feature (separate from the Mixed Tax Pricing feature) must be enabled to utilize this flag.
|
179
|
+
define_attribute :tax_inclusive, :Boolean
|
180
|
+
|
177
181
|
# @!attribute tax_info
|
178
182
|
# @return [TaxInfo] Tax info
|
179
183
|
define_attribute :tax_info, :TaxInfo
|
@@ -74,6 +74,14 @@ module Recurly
|
|
74
74
|
# @return [String] Object type
|
75
75
|
define_attribute :object, String
|
76
76
|
|
77
|
+
# @!attribute pricing_model
|
78
|
+
# @return [String] A fixed pricing model has the same price for each billing period. A ramp pricing model defines a set of Ramp Intervals, where a subscription changes price on a specified cadence of billing periods. The price change could be an increase or decrease.
|
79
|
+
define_attribute :pricing_model, String
|
80
|
+
|
81
|
+
# @!attribute ramp_intervals
|
82
|
+
# @return [Array[PlanRampInterval]] Ramp Intervals
|
83
|
+
define_attribute :ramp_intervals, Array, { :item_type => :PlanRampInterval }
|
84
|
+
|
77
85
|
# @!attribute revenue_schedule_type
|
78
86
|
# @return [String] Revenue schedule type
|
79
87
|
define_attribute :revenue_schedule_type, String
|
@@ -19,7 +19,7 @@ module Recurly
|
|
19
19
|
define_attribute :tax_inclusive, :Boolean
|
20
20
|
|
21
21
|
# @!attribute unit_amount
|
22
|
-
# @return [Float]
|
22
|
+
# @return [Float] This field should not be sent when the pricing model is 'ramp'.
|
23
23
|
define_attribute :unit_amount, Float
|
24
24
|
end
|
25
25
|
end
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# This file is automatically created by Recurly's OpenAPI generation process
|
2
|
+
# and thus any edits you make by hand will be lost. If you wish to make a
|
3
|
+
# change to this file, please create a Github issue explaining the changes you
|
4
|
+
# need and we will usher them to the appropriate places.
|
5
|
+
module Recurly
|
6
|
+
module Resources
|
7
|
+
class PlanRampInterval < Resource
|
8
|
+
|
9
|
+
# @!attribute currencies
|
10
|
+
# @return [Array[PlanRampPricing]] Represents the price for the ramp interval.
|
11
|
+
define_attribute :currencies, Array, { :item_type => :PlanRampPricing }
|
12
|
+
|
13
|
+
# @!attribute starting_billing_cycle
|
14
|
+
# @return [Integer] Represents the first billing cycle of a ramp.
|
15
|
+
define_attribute :starting_billing_cycle, Integer
|
16
|
+
end
|
17
|
+
end
|
18
|
+
end
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# This file is automatically created by Recurly's OpenAPI generation process
|
2
|
+
# and thus any edits you make by hand will be lost. If you wish to make a
|
3
|
+
# change to this file, please create a Github issue explaining the changes you
|
4
|
+
# need and we will usher them to the appropriate places.
|
5
|
+
module Recurly
|
6
|
+
module Resources
|
7
|
+
class PlanRampPricing < Resource
|
8
|
+
|
9
|
+
# @!attribute currency
|
10
|
+
# @return [String] 3-letter ISO 4217 currency code.
|
11
|
+
define_attribute :currency, String
|
12
|
+
|
13
|
+
# @!attribute unit_amount
|
14
|
+
# @return [Float] Represents the price for the Ramp Interval.
|
15
|
+
define_attribute :unit_amount, Float
|
16
|
+
end
|
17
|
+
end
|
18
|
+
end
|
@@ -122,6 +122,10 @@ module Recurly
|
|
122
122
|
# @return [Integer] Subscription quantity
|
123
123
|
define_attribute :quantity, Integer
|
124
124
|
|
125
|
+
# @!attribute ramp_intervals
|
126
|
+
# @return [Array[SubscriptionRampIntervalResponse]] The ramp intervals representing the pricing schedule for the subscription.
|
127
|
+
define_attribute :ramp_intervals, Array, { :item_type => :SubscriptionRampIntervalResponse }
|
128
|
+
|
125
129
|
# @!attribute remaining_billing_cycles
|
126
130
|
# @return [Integer] The remaining billing cycles in the current term.
|
127
131
|
define_attribute :remaining_billing_cycles, Integer
|
@@ -150,6 +154,10 @@ module Recurly
|
|
150
154
|
# @return [Float] Estimated total, before tax.
|
151
155
|
define_attribute :subtotal, Float
|
152
156
|
|
157
|
+
# @!attribute tax_inclusive
|
158
|
+
# @return [Boolean] Determines whether or not tax is included in the unit amount. The Tax Inclusive Pricing feature (separate from the Mixed Tax Pricing feature) must be enabled to utilize this flag.
|
159
|
+
define_attribute :tax_inclusive, :Boolean
|
160
|
+
|
153
161
|
# @!attribute terms_and_conditions
|
154
162
|
# @return [String] Terms and conditions
|
155
163
|
define_attribute :terms_and_conditions, String
|
@@ -54,6 +54,10 @@ module Recurly
|
|
54
54
|
# @return [Integer] Subscription quantity
|
55
55
|
define_attribute :quantity, Integer
|
56
56
|
|
57
|
+
# @!attribute ramp_intervals
|
58
|
+
# @return [Array[SubscriptionRampIntervalResponse]] The ramp intervals representing the pricing schedule for the subscription.
|
59
|
+
define_attribute :ramp_intervals, Array, { :item_type => :SubscriptionRampIntervalResponse }
|
60
|
+
|
57
61
|
# @!attribute revenue_schedule_type
|
58
62
|
# @return [String] Revenue schedule type
|
59
63
|
define_attribute :revenue_schedule_type, String
|
@@ -54,6 +54,10 @@ module Recurly
|
|
54
54
|
# @return [Integer] Subscription quantity
|
55
55
|
define_attribute :quantity, Integer
|
56
56
|
|
57
|
+
# @!attribute ramp_intervals
|
58
|
+
# @return [Array[SubscriptionRampIntervalResponse]] The ramp intervals representing the pricing schedule for the subscription.
|
59
|
+
define_attribute :ramp_intervals, Array, { :item_type => :SubscriptionRampIntervalResponse }
|
60
|
+
|
57
61
|
# @!attribute revenue_schedule_type
|
58
62
|
# @return [String] Revenue schedule type
|
59
63
|
define_attribute :revenue_schedule_type, String
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# This file is automatically created by Recurly's OpenAPI generation process
|
2
|
+
# and thus any edits you make by hand will be lost. If you wish to make a
|
3
|
+
# change to this file, please create a Github issue explaining the changes you
|
4
|
+
# need and we will usher them to the appropriate places.
|
5
|
+
module Recurly
|
6
|
+
module Resources
|
7
|
+
class SubscriptionRampIntervalResponse < Resource
|
8
|
+
|
9
|
+
# @!attribute remaining_billing_cycles
|
10
|
+
# @return [Integer] Represents how many billing cycles are left in a ramp interval.
|
11
|
+
define_attribute :remaining_billing_cycles, Integer
|
12
|
+
|
13
|
+
# @!attribute starting_billing_cycle
|
14
|
+
# @return [Integer] Represents how many billing cycles are included in a ramp interval.
|
15
|
+
define_attribute :starting_billing_cycle, Integer
|
16
|
+
|
17
|
+
# @!attribute unit_amount
|
18
|
+
# @return [Integer] Represents the price for the ramp interval.
|
19
|
+
define_attribute :unit_amount, Integer
|
20
|
+
end
|
21
|
+
end
|
22
|
+
end
|
data/lib/recurly/version.rb
CHANGED
data/openapi/api.yaml
CHANGED
@@ -17259,7 +17259,7 @@ components:
|
|
17259
17259
|
title: Field value
|
17260
17260
|
description: Any values that resemble a credit card number or security code
|
17261
17261
|
(CVV/CVC) will be rejected.
|
17262
|
-
maxLength:
|
17262
|
+
maxLength: 255
|
17263
17263
|
required:
|
17264
17264
|
- name
|
17265
17265
|
- value
|
@@ -18428,6 +18428,12 @@ components:
|
|
18428
18428
|
format: float
|
18429
18429
|
title: Unit amount
|
18430
18430
|
description: Positive amount for a charge, negative amount for a credit.
|
18431
|
+
tax_inclusive:
|
18432
|
+
type: boolean
|
18433
|
+
title: Tax Inclusive?
|
18434
|
+
description: Determines whether or not tax is included in the unit amount.
|
18435
|
+
The Tax Inclusive Pricing feature (separate from the Mixed Tax Pricing
|
18436
|
+
feature) must be enabled to utilize this flag.
|
18431
18437
|
subtotal:
|
18432
18438
|
type: number
|
18433
18439
|
format: float
|
@@ -18822,6 +18828,22 @@ components:
|
|
18822
18828
|
renew its term at renewal. If `auto_renew` is `false`, then a subscription
|
18823
18829
|
will expire at the end of its term. `auto_renew` can be overridden on
|
18824
18830
|
the subscription record itself.
|
18831
|
+
pricing_model:
|
18832
|
+
title: Pricing Model
|
18833
|
+
type: string
|
18834
|
+
enum:
|
18835
|
+
- fixed
|
18836
|
+
- ramp
|
18837
|
+
default: fixed
|
18838
|
+
description: |
|
18839
|
+
A fixed pricing model has the same price for each billing period.
|
18840
|
+
A ramp pricing model defines a set of Ramp Intervals, where a subscription changes price on
|
18841
|
+
a specified cadence of billing periods. The price change could be an increase or decrease.
|
18842
|
+
ramp_intervals:
|
18843
|
+
type: array
|
18844
|
+
title: Ramp Intervals
|
18845
|
+
items:
|
18846
|
+
"$ref": "#/components/schemas/PlanRampInterval"
|
18825
18847
|
accounting_code:
|
18826
18848
|
type: string
|
18827
18849
|
title: Plan accounting code
|
@@ -19000,6 +19022,22 @@ components:
|
|
19000
19022
|
renew its term at renewal. If `auto_renew` is `false`, then a subscription
|
19001
19023
|
will expire at the end of its term. `auto_renew` can be overridden on
|
19002
19024
|
the subscription record itself.
|
19025
|
+
pricing_model:
|
19026
|
+
title: Pricing Model
|
19027
|
+
type: string
|
19028
|
+
enum:
|
19029
|
+
- fixed
|
19030
|
+
- ramp
|
19031
|
+
default: fixed
|
19032
|
+
description: |
|
19033
|
+
A fixed pricing model has the same price for each billing period.
|
19034
|
+
A ramp pricing model defines a set of Ramp Intervals, where a subscription changes price on
|
19035
|
+
a specified cadence of billing periods. The price change could be an increase or decrease.
|
19036
|
+
ramp_intervals:
|
19037
|
+
type: array
|
19038
|
+
title: Ramp Intervals
|
19039
|
+
items:
|
19040
|
+
"$ref": "#/components/schemas/PlanRampInterval"
|
19003
19041
|
revenue_schedule_type:
|
19004
19042
|
type: string
|
19005
19043
|
title: Revenue schedule type
|
@@ -19131,6 +19169,7 @@ components:
|
|
19131
19169
|
type: number
|
19132
19170
|
format: float
|
19133
19171
|
title: Unit price
|
19172
|
+
description: This field should not be sent when the pricing model is 'ramp'.
|
19134
19173
|
minimum: 0
|
19135
19174
|
maximum: 1000000
|
19136
19175
|
tax_inclusive:
|
@@ -19208,6 +19247,11 @@ components:
|
|
19208
19247
|
renew its term at renewal. If `auto_renew` is `false`, then a subscription
|
19209
19248
|
will expire at the end of its term. `auto_renew` can be overridden on
|
19210
19249
|
the subscription record itself.
|
19250
|
+
ramp_intervals:
|
19251
|
+
type: array
|
19252
|
+
title: Ramp Intervals
|
19253
|
+
items:
|
19254
|
+
"$ref": "#/components/schemas/PlanRampInterval"
|
19211
19255
|
revenue_schedule_type:
|
19212
19256
|
type: string
|
19213
19257
|
title: Revenue schedule type
|
@@ -19285,6 +19329,19 @@ components:
|
|
19285
19329
|
a non-default dunning campaign should be assigned to this plan. For sites
|
19286
19330
|
without multiple dunning campaigns enabled, the default dunning campaign
|
19287
19331
|
will always be used.
|
19332
|
+
PlanRampInterval:
|
19333
|
+
type: object
|
19334
|
+
title: Plan Ramp Interval
|
19335
|
+
properties:
|
19336
|
+
starting_billing_cycle:
|
19337
|
+
type: integer
|
19338
|
+
description: Represents the first billing cycle of a ramp.
|
19339
|
+
default: 1
|
19340
|
+
currencies:
|
19341
|
+
type: array
|
19342
|
+
description: Represents the price for the ramp interval.
|
19343
|
+
items:
|
19344
|
+
"$ref": "#/components/schemas/PlanRampPricing"
|
19288
19345
|
AddOnPricing:
|
19289
19346
|
type: object
|
19290
19347
|
properties:
|
@@ -19308,6 +19365,24 @@ components:
|
|
19308
19365
|
required:
|
19309
19366
|
- currency
|
19310
19367
|
- unit_amount
|
19368
|
+
PlanRampPricing:
|
19369
|
+
type: object
|
19370
|
+
properties:
|
19371
|
+
currency:
|
19372
|
+
type: string
|
19373
|
+
title: Currency
|
19374
|
+
description: 3-letter ISO 4217 currency code.
|
19375
|
+
maxLength: 3
|
19376
|
+
unit_amount:
|
19377
|
+
type: number
|
19378
|
+
format: float
|
19379
|
+
title: Unit price
|
19380
|
+
description: Represents the price for the Ramp Interval.
|
19381
|
+
minimum: 0
|
19382
|
+
maximum: 1000000
|
19383
|
+
required:
|
19384
|
+
- currency
|
19385
|
+
- unit_amount
|
19311
19386
|
Pricing:
|
19312
19387
|
type: object
|
19313
19388
|
properties:
|
@@ -19893,6 +19968,13 @@ components:
|
|
19893
19968
|
default: true
|
19894
19969
|
title: Auto renew
|
19895
19970
|
description: Whether the subscription renews at the end of its term.
|
19971
|
+
ramp_intervals:
|
19972
|
+
type: array
|
19973
|
+
title: Ramp Intervals
|
19974
|
+
description: The ramp intervals representing the pricing schedule for the
|
19975
|
+
subscription.
|
19976
|
+
items:
|
19977
|
+
"$ref": "#/components/schemas/SubscriptionRampIntervalResponse"
|
19896
19978
|
paused_at:
|
19897
19979
|
type: string
|
19898
19980
|
format: date-time
|
@@ -19921,6 +20003,12 @@ components:
|
|
19921
20003
|
type: number
|
19922
20004
|
format: float
|
19923
20005
|
title: Subscription unit price
|
20006
|
+
tax_inclusive:
|
20007
|
+
type: boolean
|
20008
|
+
title: Tax Inclusive?
|
20009
|
+
description: Determines whether or not tax is included in the unit amount.
|
20010
|
+
The Tax Inclusive Pricing feature (separate from the Mixed Tax Pricing
|
20011
|
+
feature) must be enabled to utilize this flag.
|
19924
20012
|
quantity:
|
19925
20013
|
type: integer
|
19926
20014
|
title: Subscription quantity
|
@@ -20350,6 +20438,13 @@ components:
|
|
20350
20438
|
readOnly: true
|
20351
20439
|
billing_info:
|
20352
20440
|
"$ref": "#/components/schemas/SubscriptionChangeBillingInfo"
|
20441
|
+
ramp_intervals:
|
20442
|
+
type: array
|
20443
|
+
title: Ramp Intervals
|
20444
|
+
description: The ramp intervals representing the pricing schedule for the
|
20445
|
+
subscription.
|
20446
|
+
items:
|
20447
|
+
"$ref": "#/components/schemas/SubscriptionRampIntervalResponse"
|
20353
20448
|
SubscriptionChangeBillingInfo:
|
20354
20449
|
type: object
|
20355
20450
|
description: Accept nested attributes for three_d_secure_action_result_token_id
|
@@ -20489,6 +20584,12 @@ components:
|
|
20489
20584
|
- moto
|
20490
20585
|
billing_info:
|
20491
20586
|
"$ref": "#/components/schemas/SubscriptionChangeBillingInfoCreate"
|
20587
|
+
ramp_intervals:
|
20588
|
+
type: array
|
20589
|
+
title: Ramp Intervals
|
20590
|
+
description: The new set of ramp intervals for the subscription.
|
20591
|
+
items:
|
20592
|
+
"$ref": "#/components/schemas/SubscriptionRampInterval"
|
20492
20593
|
SubscriptionChangePreview:
|
20493
20594
|
type: object
|
20494
20595
|
allOf:
|
@@ -20640,6 +20741,12 @@ components:
|
|
20640
20741
|
default: true
|
20641
20742
|
title: Auto renew
|
20642
20743
|
description: Whether the subscription renews at the end of its term.
|
20744
|
+
ramp_intervals:
|
20745
|
+
type: array
|
20746
|
+
title: Ramp Intervals
|
20747
|
+
description: The new set of ramp intervals for the subscription.
|
20748
|
+
items:
|
20749
|
+
"$ref": "#/components/schemas/SubscriptionRampInterval"
|
20643
20750
|
revenue_schedule_type:
|
20644
20751
|
type: string
|
20645
20752
|
title: Revenue schedule type
|
@@ -20791,6 +20898,12 @@ components:
|
|
20791
20898
|
- evenly
|
20792
20899
|
- at_range_end
|
20793
20900
|
- at_range_start
|
20901
|
+
ramp_intervals:
|
20902
|
+
type: array
|
20903
|
+
title: Ramp Intervals
|
20904
|
+
description: The new set of ramp intervals for the subscription.
|
20905
|
+
items:
|
20906
|
+
"$ref": "#/components/schemas/SubscriptionRampInterval"
|
20794
20907
|
required:
|
20795
20908
|
- plan_code
|
20796
20909
|
SubscriptionUpdate:
|
@@ -20974,6 +21087,30 @@ components:
|
|
20974
21087
|
format: float
|
20975
21088
|
title: Assigns the subscription's shipping cost. If this is greater than
|
20976
21089
|
zero then a `method_id` or `method_code` is required.
|
21090
|
+
SubscriptionRampInterval:
|
21091
|
+
type: object
|
21092
|
+
title: Subscription Ramp Interval
|
21093
|
+
properties:
|
21094
|
+
starting_billing_cycle:
|
21095
|
+
type: integer
|
21096
|
+
description: Represents how many billing cycles are included in a ramp interval.
|
21097
|
+
default: 1
|
21098
|
+
unit_amount:
|
21099
|
+
type: integer
|
21100
|
+
description: Represents the price for the ramp interval.
|
21101
|
+
SubscriptionRampIntervalResponse:
|
21102
|
+
type: object
|
21103
|
+
title: Subscription Ramp Interval
|
21104
|
+
properties:
|
21105
|
+
starting_billing_cycle:
|
21106
|
+
type: integer
|
21107
|
+
description: Represents how many billing cycles are included in a ramp interval.
|
21108
|
+
remaining_billing_cycles:
|
21109
|
+
type: integer
|
21110
|
+
description: Represents how many billing cycles are left in a ramp interval.
|
21111
|
+
unit_amount:
|
21112
|
+
type: integer
|
21113
|
+
description: Represents the price for the ramp interval.
|
20977
21114
|
TaxInfo:
|
20978
21115
|
type: object
|
20979
21116
|
title: Tax info
|
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.
|
4
|
+
version: 3.21.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-
|
11
|
+
date: 2022-08-03 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: bundler
|
@@ -179,6 +179,8 @@ files:
|
|
179
179
|
- lib/recurly/requests/plan_create.rb
|
180
180
|
- lib/recurly/requests/plan_hosted_pages.rb
|
181
181
|
- lib/recurly/requests/plan_pricing.rb
|
182
|
+
- lib/recurly/requests/plan_ramp_interval.rb
|
183
|
+
- lib/recurly/requests/plan_ramp_pricing.rb
|
182
184
|
- lib/recurly/requests/plan_update.rb
|
183
185
|
- lib/recurly/requests/pricing.rb
|
184
186
|
- lib/recurly/requests/purchase_create.rb
|
@@ -198,6 +200,7 @@ files:
|
|
198
200
|
- lib/recurly/requests/subscription_create.rb
|
199
201
|
- lib/recurly/requests/subscription_pause.rb
|
200
202
|
- lib/recurly/requests/subscription_purchase.rb
|
203
|
+
- lib/recurly/requests/subscription_ramp_interval.rb
|
201
204
|
- lib/recurly/requests/subscription_shipping_create.rb
|
202
205
|
- lib/recurly/requests/subscription_shipping_purchase.rb
|
203
206
|
- lib/recurly/requests/subscription_shipping_update.rb
|
@@ -254,6 +257,8 @@ files:
|
|
254
257
|
- lib/recurly/resources/plan_hosted_pages.rb
|
255
258
|
- lib/recurly/resources/plan_mini.rb
|
256
259
|
- lib/recurly/resources/plan_pricing.rb
|
260
|
+
- lib/recurly/resources/plan_ramp_interval.rb
|
261
|
+
- lib/recurly/resources/plan_ramp_pricing.rb
|
257
262
|
- lib/recurly/resources/pricing.rb
|
258
263
|
- lib/recurly/resources/settings.rb
|
259
264
|
- lib/recurly/resources/shipping_address.rb
|
@@ -266,6 +271,7 @@ files:
|
|
266
271
|
- lib/recurly/resources/subscription_change.rb
|
267
272
|
- lib/recurly/resources/subscription_change_billing_info.rb
|
268
273
|
- lib/recurly/resources/subscription_change_preview.rb
|
274
|
+
- lib/recurly/resources/subscription_ramp_interval_response.rb
|
269
275
|
- lib/recurly/resources/subscription_shipping.rb
|
270
276
|
- lib/recurly/resources/tax_detail.rb
|
271
277
|
- lib/recurly/resources/tax_info.rb
|
@@ -300,7 +306,7 @@ metadata:
|
|
300
306
|
changelog_uri: https://github.com/recurly/recurly-client-ruby/blob/master/CHANGELOG.md
|
301
307
|
documentation_uri: https://recurly.github.io/recurly-client-ruby/
|
302
308
|
homepage_uri: https://github.com/recurly/recurly-client-ruby
|
303
|
-
source_code_uri: https://github.com/recurly/recurly-client-ruby/tree/3.
|
309
|
+
source_code_uri: https://github.com/recurly/recurly-client-ruby/tree/3.21.0
|
304
310
|
post_install_message:
|
305
311
|
rdoc_options: []
|
306
312
|
require_paths:
|