recurly 4.19.0 → 4.20.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 +11 -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 +5 -1
- 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/payment_method.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 +4 -0
- data/lib/recurly/resources/subscription_change.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 +126 -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: ddbe10a46c49fe38816f13bd6c15dd1c3b99bd941c18c06ba235ab6b3644a377
|
4
|
+
data.tar.gz: 1822d5c3bed83c12b5e463cc403e680dd8daa6b5ae776102327697358c8bfde7
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 146925248479fdd7c7027982427da8eed0570220ed095c4346e95dfb5391d005d4b1386b8635fe592318eca4162935b486d796479762687ad4450827c46a2ba6
|
7
|
+
data.tar.gz: a5f2f54921c83dc8e0590e4c18c2053a838cd532f86d1bcb545586c26bb894b0a22d7a2116fd9db87f671cf76d6114e337146f54ebeacf42632986fbbc65fbb6
|
data/.bumpversion.cfg
CHANGED
data/CHANGELOG.md
CHANGED
@@ -1,5 +1,16 @@
|
|
1
1
|
# Changelog
|
2
2
|
|
3
|
+
## [4.20.0](https://github.com/recurly/recurly-client-ruby/tree/4.20.0) (2022-08-03)
|
4
|
+
|
5
|
+
[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.19.0...4.20.0)
|
6
|
+
|
7
|
+
|
8
|
+
**Merged Pull Requests**
|
9
|
+
|
10
|
+
- Generated Latest Changes for v2021-02-25 [#783](https://github.com/recurly/recurly-client-ruby/pull/783) ([recurly-integrations](https://github.com/recurly-integrations))
|
11
|
+
|
12
|
+
|
13
|
+
|
3
14
|
## [4.19.0](https://github.com/recurly/recurly-client-ruby/tree/4.19.0) (2022-07-11)
|
4
15
|
|
5
16
|
[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.18.0...4.19.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', '~> 4.
|
8
|
+
gem 'recurly', '~> 4.20'
|
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
|
@@ -31,7 +31,7 @@ module Recurly
|
|
31
31
|
define_attribute :code, String
|
32
32
|
|
33
33
|
# @!attribute currencies
|
34
|
-
# @return [Array[PlanPricing]]
|
34
|
+
# @return [Array[PlanPricing]] Optional when the pricing model is 'ramp'.
|
35
35
|
define_attribute :currencies, Array, { :item_type => :PlanPricing }
|
36
36
|
|
37
37
|
# @!attribute description
|
@@ -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
|
@@ -65,6 +65,10 @@ module Recurly
|
|
65
65
|
# @!attribute routing_number_bank
|
66
66
|
# @return [String] The bank name of this routing number.
|
67
67
|
define_attribute :routing_number_bank, String
|
68
|
+
|
69
|
+
# @!attribute username
|
70
|
+
# @return [String] Username of the associated payment method. Currently only associated with Venmo.
|
71
|
+
define_attribute :username, String
|
68
72
|
end
|
69
73
|
end
|
70
74
|
end
|
@@ -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
|
@@ -126,6 +126,10 @@ module Recurly
|
|
126
126
|
# @return [Integer] Subscription quantity
|
127
127
|
define_attribute :quantity, Integer
|
128
128
|
|
129
|
+
# @!attribute ramp_intervals
|
130
|
+
# @return [Array[SubscriptionRampIntervalResponse]] The ramp intervals representing the pricing schedule for the subscription.
|
131
|
+
define_attribute :ramp_intervals, Array, { :item_type => :SubscriptionRampIntervalResponse }
|
132
|
+
|
129
133
|
# @!attribute remaining_billing_cycles
|
130
134
|
# @return [Integer] The remaining billing cycles in the current term.
|
131
135
|
define_attribute :remaining_billing_cycles, Integer
|
@@ -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
@@ -17535,7 +17535,7 @@ components:
|
|
17535
17535
|
title: Field value
|
17536
17536
|
description: Any values that resemble a credit card number or security code
|
17537
17537
|
(CVV/CVC) will be rejected.
|
17538
|
-
maxLength:
|
17538
|
+
maxLength: 255
|
17539
17539
|
required:
|
17540
17540
|
- name
|
17541
17541
|
- value
|
@@ -18959,6 +18959,14 @@ components:
|
|
18959
18959
|
renew its term at renewal. If `auto_renew` is `false`, then a subscription
|
18960
18960
|
will expire at the end of its term. `auto_renew` can be overridden on
|
18961
18961
|
the subscription record itself.
|
18962
|
+
pricing_model:
|
18963
|
+
title: Pricing Model
|
18964
|
+
"$ref": "#/components/schemas/PricingModelTypeEnum"
|
18965
|
+
ramp_intervals:
|
18966
|
+
type: array
|
18967
|
+
title: Ramp Intervals
|
18968
|
+
items:
|
18969
|
+
"$ref": "#/components/schemas/PlanRampInterval"
|
18962
18970
|
revenue_schedule_type:
|
18963
18971
|
title: Revenue schedule type
|
18964
18972
|
"$ref": "#/components/schemas/RevenueScheduleTypeEnum"
|
@@ -19121,6 +19129,14 @@ components:
|
|
19121
19129
|
renew its term at renewal. If `auto_renew` is `false`, then a subscription
|
19122
19130
|
will expire at the end of its term. `auto_renew` can be overridden on
|
19123
19131
|
the subscription record itself.
|
19132
|
+
pricing_model:
|
19133
|
+
title: Pricing Model
|
19134
|
+
"$ref": "#/components/schemas/PricingModelTypeEnum"
|
19135
|
+
ramp_intervals:
|
19136
|
+
type: array
|
19137
|
+
title: Ramp Intervals
|
19138
|
+
items:
|
19139
|
+
"$ref": "#/components/schemas/PlanRampInterval"
|
19124
19140
|
revenue_schedule_type:
|
19125
19141
|
title: Revenue schedule type
|
19126
19142
|
"$ref": "#/components/schemas/RevenueScheduleTypeEnum"
|
@@ -19242,6 +19258,7 @@ components:
|
|
19242
19258
|
type: number
|
19243
19259
|
format: float
|
19244
19260
|
title: Unit price
|
19261
|
+
description: This field should not be sent when the pricing model is 'ramp'.
|
19245
19262
|
minimum: 0
|
19246
19263
|
maximum: 1000000
|
19247
19264
|
tax_inclusive:
|
@@ -19250,6 +19267,19 @@ components:
|
|
19250
19267
|
default: false
|
19251
19268
|
description: This field is deprecated. Please do not use it.
|
19252
19269
|
deprecated: true
|
19270
|
+
PlanRampInterval:
|
19271
|
+
type: object
|
19272
|
+
title: Plan Ramp Interval
|
19273
|
+
properties:
|
19274
|
+
starting_billing_cycle:
|
19275
|
+
type: integer
|
19276
|
+
description: Represents the first billing cycle of a ramp.
|
19277
|
+
default: 1
|
19278
|
+
currencies:
|
19279
|
+
type: array
|
19280
|
+
description: Represents the price for the ramp interval.
|
19281
|
+
items:
|
19282
|
+
"$ref": "#/components/schemas/PlanRampPricing"
|
19253
19283
|
PlanUpdate:
|
19254
19284
|
type: object
|
19255
19285
|
properties:
|
@@ -19316,6 +19346,11 @@ components:
|
|
19316
19346
|
renew its term at renewal. If `auto_renew` is `false`, then a subscription
|
19317
19347
|
will expire at the end of its term. `auto_renew` can be overridden on
|
19318
19348
|
the subscription record itself.
|
19349
|
+
ramp_intervals:
|
19350
|
+
type: array
|
19351
|
+
title: Ramp Intervals
|
19352
|
+
items:
|
19353
|
+
"$ref": "#/components/schemas/PlanRampInterval"
|
19319
19354
|
revenue_schedule_type:
|
19320
19355
|
title: Revenue schedule type
|
19321
19356
|
"$ref": "#/components/schemas/RevenueScheduleTypeEnum"
|
@@ -19362,6 +19397,7 @@ components:
|
|
19362
19397
|
currencies:
|
19363
19398
|
type: array
|
19364
19399
|
title: Pricing
|
19400
|
+
description: Optional when the pricing model is 'ramp'.
|
19365
19401
|
items:
|
19366
19402
|
"$ref": "#/components/schemas/PlanPricing"
|
19367
19403
|
minItems: 1
|
@@ -19441,6 +19477,24 @@ components:
|
|
19441
19477
|
If `unit_amount_decimal` is provided, `unit_amount` cannot be provided.
|
19442
19478
|
required:
|
19443
19479
|
- currency
|
19480
|
+
PlanRampPricing:
|
19481
|
+
type: object
|
19482
|
+
properties:
|
19483
|
+
currency:
|
19484
|
+
type: string
|
19485
|
+
title: Currency
|
19486
|
+
description: 3-letter ISO 4217 currency code.
|
19487
|
+
maxLength: 3
|
19488
|
+
unit_amount:
|
19489
|
+
type: number
|
19490
|
+
format: float
|
19491
|
+
title: Unit price
|
19492
|
+
description: Represents the price for the Ramp Interval.
|
19493
|
+
minimum: 0
|
19494
|
+
maximum: 1000000
|
19495
|
+
required:
|
19496
|
+
- currency
|
19497
|
+
- unit_amount
|
19444
19498
|
Pricing:
|
19445
19499
|
type: object
|
19446
19500
|
properties:
|
@@ -20044,6 +20098,13 @@ components:
|
|
20044
20098
|
default: true
|
20045
20099
|
title: Auto renew
|
20046
20100
|
description: Whether the subscription renews at the end of its term.
|
20101
|
+
ramp_intervals:
|
20102
|
+
type: array
|
20103
|
+
title: Ramp Intervals
|
20104
|
+
description: The ramp intervals representing the pricing schedule for the
|
20105
|
+
subscription.
|
20106
|
+
items:
|
20107
|
+
"$ref": "#/components/schemas/SubscriptionRampIntervalResponse"
|
20047
20108
|
paused_at:
|
20048
20109
|
type: string
|
20049
20110
|
format: date-time
|
@@ -20546,6 +20607,13 @@ components:
|
|
20546
20607
|
readOnly: true
|
20547
20608
|
billing_info:
|
20548
20609
|
"$ref": "#/components/schemas/SubscriptionChangeBillingInfo"
|
20610
|
+
ramp_intervals:
|
20611
|
+
type: array
|
20612
|
+
title: Ramp Intervals
|
20613
|
+
description: The ramp intervals representing the pricing schedule for the
|
20614
|
+
subscription.
|
20615
|
+
items:
|
20616
|
+
"$ref": "#/components/schemas/SubscriptionRampIntervalResponse"
|
20549
20617
|
SubscriptionChangeBillingInfo:
|
20550
20618
|
type: object
|
20551
20619
|
description: Accept nested attributes for three_d_secure_action_result_token_id
|
@@ -20671,6 +20739,12 @@ components:
|
|
20671
20739
|
"$ref": "#/components/schemas/GatewayTransactionTypeEnum"
|
20672
20740
|
billing_info:
|
20673
20741
|
"$ref": "#/components/schemas/SubscriptionChangeBillingInfoCreate"
|
20742
|
+
ramp_intervals:
|
20743
|
+
type: array
|
20744
|
+
title: Ramp Intervals
|
20745
|
+
description: The new set of ramp intervals for the subscription.
|
20746
|
+
items:
|
20747
|
+
"$ref": "#/components/schemas/SubscriptionRampInterval"
|
20674
20748
|
SubscriptionChangeShippingCreate:
|
20675
20749
|
type: object
|
20676
20750
|
title: Shipping details that will be changed on a subscription
|
@@ -20825,6 +20899,12 @@ components:
|
|
20825
20899
|
default: true
|
20826
20900
|
title: Auto renew
|
20827
20901
|
description: Whether the subscription renews at the end of its term.
|
20902
|
+
ramp_intervals:
|
20903
|
+
type: array
|
20904
|
+
title: Ramp Intervals
|
20905
|
+
description: The new set of ramp intervals for the subscription.
|
20906
|
+
items:
|
20907
|
+
"$ref": "#/components/schemas/SubscriptionRampInterval"
|
20828
20908
|
revenue_schedule_type:
|
20829
20909
|
title: Revenue schedule type
|
20830
20910
|
"$ref": "#/components/schemas/RevenueScheduleTypeEnum"
|
@@ -20964,6 +21044,12 @@ components:
|
|
20964
21044
|
revenue_schedule_type:
|
20965
21045
|
title: Revenue schedule type
|
20966
21046
|
"$ref": "#/components/schemas/RevenueScheduleTypeEnum"
|
21047
|
+
ramp_intervals:
|
21048
|
+
type: array
|
21049
|
+
title: Ramp Intervals
|
21050
|
+
description: The new set of ramp intervals for the subscription.
|
21051
|
+
items:
|
21052
|
+
"$ref": "#/components/schemas/SubscriptionRampInterval"
|
20967
21053
|
required:
|
20968
21054
|
- plan_code
|
20969
21055
|
SubscriptionUpdate:
|
@@ -21145,6 +21231,30 @@ components:
|
|
21145
21231
|
format: float
|
21146
21232
|
title: Assigns the subscription's shipping cost. If this is greater than
|
21147
21233
|
zero then a `method_id` or `method_code` is required.
|
21234
|
+
SubscriptionRampInterval:
|
21235
|
+
type: object
|
21236
|
+
title: Subscription Ramp Interval
|
21237
|
+
properties:
|
21238
|
+
starting_billing_cycle:
|
21239
|
+
type: integer
|
21240
|
+
description: Represents how many billing cycles are included in a ramp interval.
|
21241
|
+
default: 1
|
21242
|
+
unit_amount:
|
21243
|
+
type: integer
|
21244
|
+
description: Represents the price for the ramp interval.
|
21245
|
+
SubscriptionRampIntervalResponse:
|
21246
|
+
type: object
|
21247
|
+
title: Subscription Ramp Interval
|
21248
|
+
properties:
|
21249
|
+
starting_billing_cycle:
|
21250
|
+
type: integer
|
21251
|
+
description: Represents how many billing cycles are included in a ramp interval.
|
21252
|
+
remaining_billing_cycles:
|
21253
|
+
type: integer
|
21254
|
+
description: Represents how many billing cycles are left in a ramp interval.
|
21255
|
+
unit_amount:
|
21256
|
+
type: integer
|
21257
|
+
description: Represents the price for the ramp interval.
|
21148
21258
|
TaxInfo:
|
21149
21259
|
type: object
|
21150
21260
|
title: Tax info
|
@@ -21998,6 +22108,10 @@ components:
|
|
21998
22108
|
routing_number_bank:
|
21999
22109
|
type: string
|
22000
22110
|
description: The bank name of this routing number.
|
22111
|
+
username:
|
22112
|
+
type: string
|
22113
|
+
description: Username of the associated payment method. Currently only associated
|
22114
|
+
with Venmo.
|
22001
22115
|
Error:
|
22002
22116
|
type: object
|
22003
22117
|
properties:
|
@@ -22327,6 +22441,16 @@ components:
|
|
22327
22441
|
- api_only
|
22328
22442
|
- read_only
|
22329
22443
|
- write
|
22444
|
+
PricingModelTypeEnum:
|
22445
|
+
type: string
|
22446
|
+
enum:
|
22447
|
+
- fixed
|
22448
|
+
- ramp
|
22449
|
+
default: fixed
|
22450
|
+
description: |
|
22451
|
+
A fixed pricing model has the same price for each billing period.
|
22452
|
+
A ramp pricing model defines a set of Ramp Intervals, where a subscription changes price on
|
22453
|
+
a specified cadence of billing periods. The price change could be an increase or decrease.
|
22330
22454
|
RevenueScheduleTypeEnum:
|
22331
22455
|
type: string
|
22332
22456
|
enum:
|
@@ -22594,6 +22718,7 @@ components:
|
|
22594
22718
|
- paypal_billing_agreement
|
22595
22719
|
- roku
|
22596
22720
|
- sepadirectdebit
|
22721
|
+
- venmo
|
22597
22722
|
- wire_transfer
|
22598
22723
|
- braintree_v_zero
|
22599
22724
|
CardTypeEnum:
|
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: 4.
|
4
|
+
version: 4.20.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
|
@@ -181,6 +181,8 @@ files:
|
|
181
181
|
- lib/recurly/requests/plan_create.rb
|
182
182
|
- lib/recurly/requests/plan_hosted_pages.rb
|
183
183
|
- lib/recurly/requests/plan_pricing.rb
|
184
|
+
- lib/recurly/requests/plan_ramp_interval.rb
|
185
|
+
- lib/recurly/requests/plan_ramp_pricing.rb
|
184
186
|
- lib/recurly/requests/plan_update.rb
|
185
187
|
- lib/recurly/requests/pricing.rb
|
186
188
|
- lib/recurly/requests/purchase_create.rb
|
@@ -201,6 +203,7 @@ files:
|
|
201
203
|
- lib/recurly/requests/subscription_create.rb
|
202
204
|
- lib/recurly/requests/subscription_pause.rb
|
203
205
|
- lib/recurly/requests/subscription_purchase.rb
|
206
|
+
- lib/recurly/requests/subscription_ramp_interval.rb
|
204
207
|
- lib/recurly/requests/subscription_shipping_create.rb
|
205
208
|
- lib/recurly/requests/subscription_shipping_purchase.rb
|
206
209
|
- lib/recurly/requests/subscription_shipping_update.rb
|
@@ -261,6 +264,8 @@ files:
|
|
261
264
|
- lib/recurly/resources/plan_hosted_pages.rb
|
262
265
|
- lib/recurly/resources/plan_mini.rb
|
263
266
|
- lib/recurly/resources/plan_pricing.rb
|
267
|
+
- lib/recurly/resources/plan_ramp_interval.rb
|
268
|
+
- lib/recurly/resources/plan_ramp_pricing.rb
|
264
269
|
- lib/recurly/resources/pricing.rb
|
265
270
|
- lib/recurly/resources/settings.rb
|
266
271
|
- lib/recurly/resources/shipping_address.rb
|
@@ -273,6 +278,7 @@ files:
|
|
273
278
|
- lib/recurly/resources/subscription_add_on_tier.rb
|
274
279
|
- lib/recurly/resources/subscription_change.rb
|
275
280
|
- lib/recurly/resources/subscription_change_billing_info.rb
|
281
|
+
- lib/recurly/resources/subscription_ramp_interval_response.rb
|
276
282
|
- lib/recurly/resources/subscription_shipping.rb
|
277
283
|
- lib/recurly/resources/tax_detail.rb
|
278
284
|
- lib/recurly/resources/tax_info.rb
|
@@ -309,7 +315,7 @@ metadata:
|
|
309
315
|
changelog_uri: https://github.com/recurly/recurly-client-ruby/blob/master/CHANGELOG.md
|
310
316
|
documentation_uri: https://recurly.github.io/recurly-client-ruby/
|
311
317
|
homepage_uri: https://github.com/recurly/recurly-client-ruby
|
312
|
-
source_code_uri: https://github.com/recurly/recurly-client-ruby/tree/4.
|
318
|
+
source_code_uri: https://github.com/recurly/recurly-client-ruby/tree/4.20.0
|
313
319
|
post_install_message:
|
314
320
|
rdoc_options: []
|
315
321
|
require_paths:
|