recurly 3.3.0 → 3.3.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.bumpversion.cfg +1 -1
- data/.github/ISSUE_TEMPLATE/bug-report.md +1 -1
- data/.github_changelog_generator +8 -0
- data/CHANGELOG.md +135 -0
- data/lib/recurly/requests/add_on_create.rb +9 -5
- data/lib/recurly/requests/add_on_update.rb +4 -0
- data/lib/recurly/requests/billing_info_create.rb +4 -0
- data/lib/recurly/requests/invoice_refund.rb +2 -2
- data/lib/recurly/requests/line_item_create.rb +2 -2
- data/lib/recurly/requests/plan_create.rb +8 -0
- data/lib/recurly/requests/plan_update.rb +8 -0
- data/lib/recurly/requests/subscription_add_on_create.rb +4 -0
- data/lib/recurly/requests/subscription_add_on_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_update.rb +4 -0
- data/lib/recurly/resources/add_on.rb +4 -0
- data/lib/recurly/resources/coupon.rb +4 -0
- data/lib/recurly/resources/line_item.rb +3 -3
- data/lib/recurly/resources/plan.rb +8 -0
- data/lib/recurly/resources/subscription.rb +4 -0
- data/lib/recurly/resources/subscription_change.rb +8 -0
- data/lib/recurly/version.rb +1 -1
- data/openapi/api.yaml +3368 -2277
- data/recurly.gemspec +1 -1
- data/scripts/bump +8 -1
- data/scripts/changelog +12 -0
- data/scripts/prepare-release +36 -0
- data/scripts/release +23 -4
- metadata +9 -5
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 8dcd9b43c18398ce92fd53c0a69832ac86cedfa9e80a7b4b9aff7c5ca66fae79
|
4
|
+
data.tar.gz: 91a5fc7487165529d5c50146a7b8154475fa60c1a7732d3a404ea96cec203e3a
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 7b6629ac03702f3b50a4ad3ca60a610cea8b0ded86a0fa0de7a40a9f6bfb1ba29cc9b0f8868ed2884969656543a70fd1fa124b005ff76be53cfb262a1b2f0e4a
|
7
|
+
data.tar.gz: 453e008bebc7b684c49d766f57f7c398c8ce16b0544500ee944f5055ad927d6977f9223f0995f181a1842054231f2fd076361e2fbbb02bfbea9b6aa6e0d8c6a3
|
data/.bumpversion.cfg
CHANGED
@@ -11,7 +11,7 @@ _Warning_: Github issues are not an official support channel for Recurly. If you
|
|
11
11
|
|
12
12
|
**Describe the bug**
|
13
13
|
|
14
|
-
A clear and concise description of what the bug is.
|
14
|
+
A clear and concise description of what the bug is. Please include a full stack trace if available.
|
15
15
|
|
16
16
|
**To Reproduce**
|
17
17
|
|
data/CHANGELOG.md
ADDED
@@ -0,0 +1,135 @@
|
|
1
|
+
# Changelog
|
2
|
+
|
3
|
+
## [3.3.0](https://github.com/recurly/recurly-client-ruby/tree/3.3.0) (2020-02-20)
|
4
|
+
|
5
|
+
[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/3.2.2...3.3.0)
|
6
|
+
|
7
|
+
**Merged pull requests:**
|
8
|
+
|
9
|
+
- Release 3.3.0 [\#556](https://github.com/recurly/recurly-client-ruby/pull/556) ([bhelx](https://github.com/bhelx))
|
10
|
+
- Latest generated changes for v2019-10-10 [\#555](https://github.com/recurly/recurly-client-ruby/pull/555) ([bhelx](https://github.com/bhelx))
|
11
|
+
- Link to new dev docs for webhooks [\#554](https://github.com/recurly/recurly-client-ruby/pull/554) ([bhelx](https://github.com/bhelx))
|
12
|
+
- Latest v2019-10-10 Changes [\#552](https://github.com/recurly/recurly-client-ruby/pull/552) ([bhelx](https://github.com/bhelx))
|
13
|
+
|
14
|
+
## [3.2.2](https://github.com/recurly/recurly-client-ruby/tree/3.2.2) (2020-02-03)
|
15
|
+
|
16
|
+
[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/3.2.1...3.2.2)
|
17
|
+
|
18
|
+
**Merged pull requests:**
|
19
|
+
|
20
|
+
- Release 3.2.2 [\#550](https://github.com/recurly/recurly-client-ruby/pull/550) ([bhelx](https://github.com/bhelx))
|
21
|
+
- Loosen version restriction on faraday [\#549](https://github.com/recurly/recurly-client-ruby/pull/549) ([bhelx](https://github.com/bhelx))
|
22
|
+
|
23
|
+
## [3.2.1](https://github.com/recurly/recurly-client-ruby/tree/3.2.1) (2019-12-10)
|
24
|
+
|
25
|
+
[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/3.2.0...3.2.1)
|
26
|
+
|
27
|
+
**Fixed bugs:**
|
28
|
+
|
29
|
+
- Convert Array params to CSV strings [\#545](https://github.com/recurly/recurly-client-ruby/pull/545) ([douglasmiller](https://github.com/douglasmiller))
|
30
|
+
|
31
|
+
## [3.2.0](https://github.com/recurly/recurly-client-ruby/tree/3.2.0) (2019-12-03)
|
32
|
+
|
33
|
+
[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/3.1.3...3.2.0)
|
34
|
+
|
35
|
+
**Fixed bugs:**
|
36
|
+
|
37
|
+
- It's hard to find out what payment method was used [\#543](https://github.com/recurly/recurly-client-ruby/issues/543)
|
38
|
+
- Implement way to actually get ErrorMayHaveTransaction [\#540](https://github.com/recurly/recurly-client-ruby/issues/540)
|
39
|
+
|
40
|
+
**Merged pull requests:**
|
41
|
+
|
42
|
+
- Release 3.2.0 [\#544](https://github.com/recurly/recurly-client-ruby/pull/544) ([bhelx](https://github.com/bhelx))
|
43
|
+
- Allow object attributes through [\#542](https://github.com/recurly/recurly-client-ruby/pull/542) ([bhelx](https://github.com/bhelx))
|
44
|
+
|
45
|
+
## [3.1.3](https://github.com/recurly/recurly-client-ruby/tree/3.1.3) (2019-12-02)
|
46
|
+
|
47
|
+
[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/3.1.2...3.1.3)
|
48
|
+
|
49
|
+
**Fixed bugs:**
|
50
|
+
|
51
|
+
- Getting ArgumentError instead of Recurly::Errors::ValidationError [\#538](https://github.com/recurly/recurly-client-ruby/issues/538)
|
52
|
+
- Issue 540 error may have transaction [\#541](https://github.com/recurly/recurly-client-ruby/pull/541) ([bhelx](https://github.com/bhelx))
|
53
|
+
|
54
|
+
## [3.1.2](https://github.com/recurly/recurly-client-ruby/tree/3.1.2) (2019-12-02)
|
55
|
+
|
56
|
+
[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/3.1.1...3.1.2)
|
57
|
+
|
58
|
+
**Fixed bugs:**
|
59
|
+
|
60
|
+
- Skip request property type validation for nil values [\#539](https://github.com/recurly/recurly-client-ruby/pull/539) ([bhelx](https://github.com/bhelx))
|
61
|
+
|
62
|
+
## [3.1.1](https://github.com/recurly/recurly-client-ruby/tree/3.1.1) (2019-11-27)
|
63
|
+
|
64
|
+
[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/3.1.0...3.1.1)
|
65
|
+
|
66
|
+
**Fixed bugs:**
|
67
|
+
|
68
|
+
- Undefined method cast [\#536](https://github.com/recurly/recurly-client-ruby/issues/536)
|
69
|
+
- Disable searching ancestors when looking up constants [\#537](https://github.com/recurly/recurly-client-ruby/pull/537) ([douglasmiller](https://github.com/douglasmiller))
|
70
|
+
|
71
|
+
## [3.1.0](https://github.com/recurly/recurly-client-ruby/tree/3.1.0) (2019-11-18)
|
72
|
+
|
73
|
+
[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/3.0.0...3.1.0)
|
74
|
+
|
75
|
+
**Merged pull requests:**
|
76
|
+
|
77
|
+
- Release 3.1.0 [\#530](https://github.com/recurly/recurly-client-ruby/pull/530) ([bhelx](https://github.com/bhelx))
|
78
|
+
- Generated Updates for API version v2019-10-10 [\#529](https://github.com/recurly/recurly-client-ruby/pull/529) ([douglasmiller](https://github.com/douglasmiller))
|
79
|
+
- Generated Updates for API version v2019-10-10 [\#528](https://github.com/recurly/recurly-client-ruby/pull/528) ([bhelx](https://github.com/bhelx))
|
80
|
+
|
81
|
+
## [3.0.0](https://github.com/recurly/recurly-client-ruby/tree/3.0.0) (2019-10-09)
|
82
|
+
|
83
|
+
[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/3.0.0.beta.5...3.0.0)
|
84
|
+
|
85
|
+
**Merged pull requests:**
|
86
|
+
|
87
|
+
- Release 3.0.0 [\#521](https://github.com/recurly/recurly-client-ruby/pull/521) ([bhelx](https://github.com/bhelx))
|
88
|
+
- Upgrade API version v2019-10-10 [\#519](https://github.com/recurly/recurly-client-ruby/pull/519) ([bhelx](https://github.com/bhelx))
|
89
|
+
- Update recurly.gemspec [\#518](https://github.com/recurly/recurly-client-ruby/pull/518) ([bhelx](https://github.com/bhelx))
|
90
|
+
- Add a script for releasing [\#517](https://github.com/recurly/recurly-client-ruby/pull/517) ([bhelx](https://github.com/bhelx))
|
91
|
+
- Change base url to v3.recurly.com [\#516](https://github.com/recurly/recurly-client-ruby/pull/516) ([bhelx](https://github.com/bhelx))
|
92
|
+
- No longer need bundler 1.7 [\#511](https://github.com/recurly/recurly-client-ruby/pull/511) ([bhelx](https://github.com/bhelx))
|
93
|
+
- Refactor internal schema representation [\#510](https://github.com/recurly/recurly-client-ruby/pull/510) ([bhelx](https://github.com/bhelx))
|
94
|
+
- Implement bump script [\#507](https://github.com/recurly/recurly-client-ruby/pull/507) ([bhelx](https://github.com/bhelx))
|
95
|
+
- Remove the site-id constraint from Client [\#504](https://github.com/recurly/recurly-client-ruby/pull/504) ([bhelx](https://github.com/bhelx))
|
96
|
+
- Only set strict mode when env explicitly true [\#501](https://github.com/recurly/recurly-client-ruby/pull/501) ([bhelx](https://github.com/bhelx))
|
97
|
+
- Document use of webhooks [\#500](https://github.com/recurly/recurly-client-ruby/pull/500) ([bhelx](https://github.com/bhelx))
|
98
|
+
- Latest v2018-08-09 Updates [\#498](https://github.com/recurly/recurly-client-ruby/pull/498) ([bhelx](https://github.com/bhelx))
|
99
|
+
- Refer user to rubydoc.info [\#497](https://github.com/recurly/recurly-client-ruby/pull/497) ([bhelx](https://github.com/bhelx))
|
100
|
+
- Expose HTTP request and response metadata [\#488](https://github.com/recurly/recurly-client-ruby/pull/488) ([bhelx](https://github.com/bhelx))
|
101
|
+
- Add CONTRIBUTING.md [\#486](https://github.com/recurly/recurly-client-ruby/pull/486) ([bhelx](https://github.com/bhelx))
|
102
|
+
- Bump 3.0.0.beta.6 [\#485](https://github.com/recurly/recurly-client-ruby/pull/485) ([bhelx](https://github.com/bhelx))
|
103
|
+
- Latest v2018-08-09 Changes [\#484](https://github.com/recurly/recurly-client-ruby/pull/484) ([bhelx](https://github.com/bhelx))
|
104
|
+
|
105
|
+
## [3.0.0.beta.5](https://github.com/recurly/recurly-client-ruby/tree/3.0.0.beta.5) (2019-06-28)
|
106
|
+
|
107
|
+
[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/3.0.0.beta.4...3.0.0.beta.5)
|
108
|
+
|
109
|
+
**Merged pull requests:**
|
110
|
+
|
111
|
+
- Latest v2018-08-09 Changes [\#482](https://github.com/recurly/recurly-client-ruby/pull/482) ([bhelx](https://github.com/bhelx))
|
112
|
+
- no longer need dep scripts [\#476](https://github.com/recurly/recurly-client-ruby/pull/476) ([bhelx](https://github.com/bhelx))
|
113
|
+
- Add format script and check in specs [\#474](https://github.com/recurly/recurly-client-ruby/pull/474) ([bhelx](https://github.com/bhelx))
|
114
|
+
- Url Encode Path items [\#472](https://github.com/recurly/recurly-client-ruby/pull/472) ([bhelx](https://github.com/bhelx))
|
115
|
+
- Add strict mode for json deserializer [\#469](https://github.com/recurly/recurly-client-ruby/pull/469) ([bhelx](https://github.com/bhelx))
|
116
|
+
|
117
|
+
## [3.0.0.beta.4](https://github.com/recurly/recurly-client-ruby/tree/3.0.0.beta.4) (2019-04-04)
|
118
|
+
|
119
|
+
[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/3.0.0.beta.1...3.0.0.beta.4)
|
120
|
+
|
121
|
+
**Merged pull requests:**
|
122
|
+
|
123
|
+
- 3.0.0.beta.5 [\#483](https://github.com/recurly/recurly-client-ruby/pull/483) ([bhelx](https://github.com/bhelx))
|
124
|
+
- V3 Update v2018-08-09 [\#460](https://github.com/recurly/recurly-client-ruby/pull/460) ([aaron-suarez](https://github.com/aaron-suarez))
|
125
|
+
- Small fixes for private beta [\#458](https://github.com/recurly/recurly-client-ruby/pull/458) ([bhelx](https://github.com/bhelx))
|
126
|
+
- Use Net-http-persistent for persistent connection [\#408](https://github.com/recurly/recurly-client-ruby/pull/408) ([bhelx](https://github.com/bhelx))
|
127
|
+
- Update to API 2018-06-06 [\#407](https://github.com/recurly/recurly-client-ruby/pull/407) ([bhelx](https://github.com/bhelx))
|
128
|
+
- Regenerating the client [\#406](https://github.com/recurly/recurly-client-ruby/pull/406) ([drewish](https://github.com/drewish))
|
129
|
+
- V3 Pager can error [\#401](https://github.com/recurly/recurly-client-ruby/pull/401) ([drewish](https://github.com/drewish))
|
130
|
+
- \[V3\] Test more versions of ruby [\#397](https://github.com/recurly/recurly-client-ruby/pull/397) ([drewish](https://github.com/drewish))
|
131
|
+
- Allow faraday 0.12 for compatibility with oauth2 gem [\#396](https://github.com/recurly/recurly-client-ruby/pull/396) ([drewish](https://github.com/drewish))
|
132
|
+
|
133
|
+
|
134
|
+
|
135
|
+
\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*
|
@@ -7,7 +7,7 @@ module Recurly
|
|
7
7
|
class AddOnCreate < Request
|
8
8
|
|
9
9
|
# @!attribute accounting_code
|
10
|
-
# @return [String] Accounting code for invoice line items for this add-on. If no value is provided, it defaults to add-on's code. If `item_code`/`item_id` is part of the request then `
|
10
|
+
# @return [String] Accounting code for invoice line items for this add-on. If no value is provided, it defaults to add-on's code. If `item_code`/`item_id` is part of the request then `accounting_code` must be absent.
|
11
11
|
define_attribute :accounting_code, String
|
12
12
|
|
13
13
|
# @!attribute code
|
@@ -27,23 +27,27 @@ module Recurly
|
|
27
27
|
define_attribute :display_quantity, :Boolean
|
28
28
|
|
29
29
|
# @!attribute item_code
|
30
|
-
# @return [String] Unique code to identify an item
|
30
|
+
# @return [String] Unique code to identify an item. Avaliable when the `Catalog: Item Add-Ons` feature is enabled. If `item_id` and `item_code` are both present, `item_id` will be used.
|
31
31
|
define_attribute :item_code, String
|
32
32
|
|
33
33
|
# @!attribute item_id
|
34
|
-
# @return [String] Available when the `Catalog: Item Add-Ons` feature is enabled. If `item_id` and `item_code` are both present, `item_id` will be used.
|
34
|
+
# @return [String] System-generated unique identifier for an item. Available when the `Catalog: Item Add-Ons` feature is enabled. If `item_id` and `item_code` are both present, `item_id` will be used.
|
35
35
|
define_attribute :item_id, String
|
36
36
|
|
37
37
|
# @!attribute name
|
38
|
-
# @return [String] Describes your add-on and will appear in subscribers' invoices. If `item_code`/`item_id` is part of the request then `
|
38
|
+
# @return [String] Describes your add-on and will appear in subscribers' invoices. If `item_code`/`item_id` is part of the request then `name` must be absent. If `item_code`/`item_id` is not present `name` is required.
|
39
39
|
define_attribute :name, String
|
40
40
|
|
41
41
|
# @!attribute plan_id
|
42
42
|
# @return [String] Plan ID
|
43
43
|
define_attribute :plan_id, String
|
44
44
|
|
45
|
+
# @!attribute revenue_schedule_type
|
46
|
+
# @return [String] When this add-on is invoiced, the line item will use this revenue schedule. If `item_code`/`item_id` is part of the request then `revenue_schedule_type` must be absent in the request as the value will be set from the item.
|
47
|
+
define_attribute :revenue_schedule_type, String
|
48
|
+
|
45
49
|
# @!attribute tax_code
|
46
|
-
# @return [String] Optional field used by Avalara, Vertex, and Recurly's EU VAT tax feature to determine taxation rules. If you have your own AvaTax or Vertex account configured, use their tax codes to assign specific tax rules. If you are using Recurly's EU VAT feature, you can use values of `unknown`, `physical`, or `digital`. If `item_code`/`item_id` is part of the request then `
|
50
|
+
# @return [String] Optional field used by Avalara, Vertex, and Recurly's EU VAT tax feature to determine taxation rules. If you have your own AvaTax or Vertex account configured, use their tax codes to assign specific tax rules. If you are using Recurly's EU VAT feature, you can use values of `unknown`, `physical`, or `digital`. If `item_code`/`item_id` is part of the request then `tax_code` must be absent.
|
47
51
|
define_attribute :tax_code, String
|
48
52
|
end
|
49
53
|
end
|
@@ -34,6 +34,10 @@ module Recurly
|
|
34
34
|
# @return [String] Describes your add-on and will appear in subscribers' invoices. If an `Item` is associated to the `AddOn` then `name` must be absent.
|
35
35
|
define_attribute :name, String
|
36
36
|
|
37
|
+
# @!attribute revenue_schedule_type
|
38
|
+
# @return [String] When this add-on is invoiced, the line item will use this revenue schedule. If an `Item` is associated to the `AddOn` then `revenue_schedule_type` must be absent in the request as the value will be set from the item.
|
39
|
+
define_attribute :revenue_schedule_type, String
|
40
|
+
|
37
41
|
# @!attribute tax_code
|
38
42
|
# @return [String] Optional field used by Avalara, Vertex, and Recurly's EU VAT tax feature to determine taxation rules. If you have your own AvaTax or Vertex account configured, use their tax codes to assign specific tax rules. If you are using Recurly's EU VAT feature, you can use values of `unknown`, `physical`, or `digital`. If an `Item` is associated to the `AddOn` then `tax code` must be absent.
|
39
43
|
define_attribute :tax_code, String
|
@@ -38,6 +38,10 @@ module Recurly
|
|
38
38
|
# @return [String] A token used in place of a credit card in order to perform transactions. Must be used in conjunction with `gateway_code`.
|
39
39
|
define_attribute :gateway_token, String
|
40
40
|
|
41
|
+
# @!attribute iban
|
42
|
+
# @return [String] The International Bank Account Number, up to 34 alphanumeric characters comprising a country code; two check digits; and a number that includes the domestic bank account number, branch identifier, and potential routing information
|
43
|
+
define_attribute :iban, String
|
44
|
+
|
41
45
|
# @!attribute ip_address
|
42
46
|
# @return [String] *STRONGLY RECOMMENDED* Customer's IP address when updating their billing information.
|
43
47
|
define_attribute :ip_address, String
|
@@ -7,8 +7,8 @@ module Recurly
|
|
7
7
|
class InvoiceRefund < Request
|
8
8
|
|
9
9
|
# @!attribute amount
|
10
|
-
# @return [
|
11
|
-
define_attribute :amount,
|
10
|
+
# @return [Float] The amount to be refunded. The amount will be split between the line items. If no amount is specified, it will default to refunding the total refundable amount on the invoice.
|
11
|
+
define_attribute :amount, Float
|
12
12
|
|
13
13
|
# @!attribute credit_customer_notes
|
14
14
|
# @return [String] Used as the Customer Notes on the credit invoice. This field can only be include when the Credit Invoices feature is enabled.
|
@@ -27,11 +27,11 @@ module Recurly
|
|
27
27
|
define_attribute :end_date, DateTime
|
28
28
|
|
29
29
|
# @!attribute item_code
|
30
|
-
# @return [String] Unique code to identify an item
|
30
|
+
# @return [String] Unique code to identify an item. Avaliable when the Credit Invoices and Subscription Billing Terms features are enabled.
|
31
31
|
define_attribute :item_code, String
|
32
32
|
|
33
33
|
# @!attribute item_id
|
34
|
-
# @return [String] Available when the
|
34
|
+
# @return [String] System-generated unique identifier for an item. Available when the Credit Invoices and Subscription Billing Terms features are enabled.
|
35
35
|
define_attribute :item_id, String
|
36
36
|
|
37
37
|
# @!attribute origin
|
@@ -46,10 +46,18 @@ module Recurly
|
|
46
46
|
# @return [String] This name describes your plan and will appear on the Hosted Payment Page and the subscriber's invoice.
|
47
47
|
define_attribute :name, String
|
48
48
|
|
49
|
+
# @!attribute revenue_schedule_type
|
50
|
+
# @return [String] Revenue schedule type
|
51
|
+
define_attribute :revenue_schedule_type, String
|
52
|
+
|
49
53
|
# @!attribute setup_fee_accounting_code
|
50
54
|
# @return [String] Accounting code for invoice line items for the plan's setup fee. If no value is provided, it defaults to plan's accounting code.
|
51
55
|
define_attribute :setup_fee_accounting_code, String
|
52
56
|
|
57
|
+
# @!attribute setup_fee_revenue_schedule_type
|
58
|
+
# @return [String] Setup fee revenue schedule type
|
59
|
+
define_attribute :setup_fee_revenue_schedule_type, String
|
60
|
+
|
53
61
|
# @!attribute tax_code
|
54
62
|
# @return [String] Optional field used by Avalara, Vertex, and Recurly's EU VAT tax feature to determine taxation rules. If you have your own AvaTax or Vertex account configured, use their tax codes to assign specific tax rules. If you are using Recurly's EU VAT feature, you can use values of `unknown`, `physical`, or `digital`.
|
55
63
|
define_attribute :tax_code, String
|
@@ -42,10 +42,18 @@ module Recurly
|
|
42
42
|
# @return [String] This name describes your plan and will appear on the Hosted Payment Page and the subscriber's invoice.
|
43
43
|
define_attribute :name, String
|
44
44
|
|
45
|
+
# @!attribute revenue_schedule_type
|
46
|
+
# @return [String] Revenue schedule type
|
47
|
+
define_attribute :revenue_schedule_type, String
|
48
|
+
|
45
49
|
# @!attribute setup_fee_accounting_code
|
46
50
|
# @return [String] Accounting code for invoice line items for the plan's setup fee. If no value is provided, it defaults to plan's accounting code.
|
47
51
|
define_attribute :setup_fee_accounting_code, String
|
48
52
|
|
53
|
+
# @!attribute setup_fee_revenue_schedule_type
|
54
|
+
# @return [String] Setup fee revenue schedule type
|
55
|
+
define_attribute :setup_fee_revenue_schedule_type, String
|
56
|
+
|
49
57
|
# @!attribute tax_code
|
50
58
|
# @return [String] Optional field used by Avalara, Vertex, and Recurly's EU VAT tax feature to determine taxation rules. If you have your own AvaTax or Vertex account configured, use their tax codes to assign specific tax rules. If you are using Recurly's EU VAT feature, you can use values of `unknown`, `physical`, or `digital`.
|
51
59
|
define_attribute :tax_code, String
|
@@ -14,6 +14,10 @@ module Recurly
|
|
14
14
|
# @return [Integer] Quantity
|
15
15
|
define_attribute :quantity, Integer
|
16
16
|
|
17
|
+
# @!attribute revenue_schedule_type
|
18
|
+
# @return [String] Revenue schedule type
|
19
|
+
define_attribute :revenue_schedule_type, String
|
20
|
+
|
17
21
|
# @!attribute unit_amount
|
18
22
|
# @return [Float] Optionally, override the add-on's default unit amount.
|
19
23
|
define_attribute :unit_amount, Float
|
@@ -18,6 +18,10 @@ module Recurly
|
|
18
18
|
# @return [Integer] Quantity
|
19
19
|
define_attribute :quantity, Integer
|
20
20
|
|
21
|
+
# @!attribute revenue_schedule_type
|
22
|
+
# @return [String] Revenue schedule type
|
23
|
+
define_attribute :revenue_schedule_type, String
|
24
|
+
|
21
25
|
# @!attribute unit_amount
|
22
26
|
# @return [Float] Optionally, override the add-on's default unit amount.
|
23
27
|
define_attribute :unit_amount, Float
|
@@ -38,6 +38,10 @@ module Recurly
|
|
38
38
|
# @return [Integer] Optionally override the default quantity of 1.
|
39
39
|
define_attribute :quantity, Integer
|
40
40
|
|
41
|
+
# @!attribute revenue_schedule_type
|
42
|
+
# @return [String] Revenue schedule type
|
43
|
+
define_attribute :revenue_schedule_type, String
|
44
|
+
|
41
45
|
# @!attribute shipping
|
42
46
|
# @return [SubscriptionChangeShippingCreate] The shipping address can currently only be changed immediately, using SubscriptionUpdate.
|
43
47
|
define_attribute :shipping, :SubscriptionChangeShippingCreate
|
@@ -70,6 +70,10 @@ module Recurly
|
|
70
70
|
# @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`.
|
71
71
|
define_attribute :renewal_billing_cycles, Integer
|
72
72
|
|
73
|
+
# @!attribute revenue_schedule_type
|
74
|
+
# @return [String] Revenue schedule type
|
75
|
+
define_attribute :revenue_schedule_type, String
|
76
|
+
|
73
77
|
# @!attribute shipping
|
74
78
|
# @return [SubscriptionShippingCreate] Create a shipping address on the account and assign it to the subscription.
|
75
79
|
define_attribute :shipping, :SubscriptionShippingCreate
|
@@ -38,6 +38,10 @@ module Recurly
|
|
38
38
|
# @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
39
|
define_attribute :renewal_billing_cycles, Integer
|
40
40
|
|
41
|
+
# @!attribute revenue_schedule_type
|
42
|
+
# @return [String] Revenue schedule type
|
43
|
+
define_attribute :revenue_schedule_type, String
|
44
|
+
|
41
45
|
# @!attribute shipping
|
42
46
|
# @return [SubscriptionShippingPurchase] Create a shipping address on the account and assign it to the subscription.
|
43
47
|
define_attribute :shipping, :SubscriptionShippingPurchase
|
@@ -42,6 +42,10 @@ module Recurly
|
|
42
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`.
|
43
43
|
define_attribute :renewal_billing_cycles, Integer
|
44
44
|
|
45
|
+
# @!attribute revenue_schedule_type
|
46
|
+
# @return [String] Revenue schedule type
|
47
|
+
define_attribute :revenue_schedule_type, String
|
48
|
+
|
45
49
|
# @!attribute shipping
|
46
50
|
# @return [SubscriptionShippingUpdate] Subscription shipping details
|
47
51
|
define_attribute :shipping, :SubscriptionShippingUpdate
|
@@ -62,6 +62,10 @@ module Recurly
|
|
62
62
|
# @return [String] Plan ID
|
63
63
|
define_attribute :plan_id, String
|
64
64
|
|
65
|
+
# @!attribute revenue_schedule_type
|
66
|
+
# @return [String] When this add-on is invoiced, the line item will use this revenue schedule. If `item_code`/`item_id` is part of the request then `revenue_schedule_type` must be absent in the request as the value will be set from the item.
|
67
|
+
define_attribute :revenue_schedule_type, String
|
68
|
+
|
65
69
|
# @!attribute state
|
66
70
|
# @return [String] Add-ons can be either active or inactive.
|
67
71
|
define_attribute :state, String
|
@@ -86,6 +86,10 @@ module Recurly
|
|
86
86
|
# @return [DateTime] The date and time the coupon will expire and can no longer be redeemed. Time is always 11:59:59, the end-of-day Pacific time.
|
87
87
|
define_attribute :redeem_by, DateTime
|
88
88
|
|
89
|
+
# @!attribute redeemed_at
|
90
|
+
# @return [DateTime] The date and time the unique coupon code was redeemed. This is only present for bulk coupons.
|
91
|
+
define_attribute :redeemed_at, DateTime
|
92
|
+
|
89
93
|
# @!attribute redemption_resource
|
90
94
|
# @return [String] Whether the discount is for all eligible charges on the account, or only a specific subscription.
|
91
95
|
define_attribute :redemption_resource, String
|
@@ -55,7 +55,7 @@ module Recurly
|
|
55
55
|
define_attribute :end_date, DateTime
|
56
56
|
|
57
57
|
# @!attribute external_sku
|
58
|
-
# @return [String] Optional Stock Keeping Unit assigned to an item
|
58
|
+
# @return [String] Optional Stock Keeping Unit assigned to an item. Available when the Credit Invoices and Subscription Billing Terms features are enabled.
|
59
59
|
define_attribute :external_sku, String
|
60
60
|
|
61
61
|
# @!attribute id
|
@@ -71,11 +71,11 @@ module Recurly
|
|
71
71
|
define_attribute :invoice_number, String
|
72
72
|
|
73
73
|
# @!attribute item_code
|
74
|
-
# @return [String] Unique code to identify an item
|
74
|
+
# @return [String] Unique code to identify an item. Available when the Credit Invoices and Subscription Billing Terms features are enabled.
|
75
75
|
define_attribute :item_code, String
|
76
76
|
|
77
77
|
# @!attribute item_id
|
78
|
-
# @return [String] Available when the
|
78
|
+
# @return [String] System-generated unique identifier for an item. Available when the Credit Invoices and Subscription Billing Terms features are enabled.
|
79
79
|
define_attribute :item_id, String
|
80
80
|
|
81
81
|
# @!attribute legacy_category
|
@@ -58,10 +58,18 @@ module Recurly
|
|
58
58
|
# @return [String] Object type
|
59
59
|
define_attribute :object, String
|
60
60
|
|
61
|
+
# @!attribute revenue_schedule_type
|
62
|
+
# @return [String] Revenue schedule type
|
63
|
+
define_attribute :revenue_schedule_type, String
|
64
|
+
|
61
65
|
# @!attribute setup_fee_accounting_code
|
62
66
|
# @return [String] Accounting code for invoice line items for the plan's setup fee. If no value is provided, it defaults to plan's accounting code.
|
63
67
|
define_attribute :setup_fee_accounting_code, String
|
64
68
|
|
69
|
+
# @!attribute setup_fee_revenue_schedule_type
|
70
|
+
# @return [String] Setup fee revenue schedule type
|
71
|
+
define_attribute :setup_fee_revenue_schedule_type, String
|
72
|
+
|
65
73
|
# @!attribute state
|
66
74
|
# @return [String] The current state of the plan.
|
67
75
|
define_attribute :state, String
|
@@ -126,6 +126,10 @@ module Recurly
|
|
126
126
|
# @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`.
|
127
127
|
define_attribute :renewal_billing_cycles, Integer
|
128
128
|
|
129
|
+
# @!attribute revenue_schedule_type
|
130
|
+
# @return [String] Revenue schedule type
|
131
|
+
define_attribute :revenue_schedule_type, String
|
132
|
+
|
129
133
|
# @!attribute shipping
|
130
134
|
# @return [SubscriptionShipping] Subscription shipping details
|
131
135
|
define_attribute :shipping, :SubscriptionShipping
|