recurly 4.67.0 → 4.69.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 +22 -0
- data/GETTING_STARTED.md +1 -1
- data/lib/recurly/client/operations.rb +30 -0
- data/lib/recurly/requests/account_create.rb +4 -0
- data/lib/recurly/requests/account_note_create.rb +14 -0
- data/lib/recurly/requests/account_purchase.rb +4 -0
- data/lib/recurly/requests/account_update.rb +4 -0
- data/lib/recurly/requests/add_on_create.rb +4 -0
- data/lib/recurly/requests/add_on_update.rb +4 -0
- data/lib/recurly/requests/billing_info_create.rb +1 -1
- data/lib/recurly/requests/item_create.rb +4 -0
- data/lib/recurly/requests/item_update.rb +4 -0
- data/lib/recurly/requests/line_item_create.rb +4 -0
- data/lib/recurly/requests/plan_create.rb +4 -0
- data/lib/recurly/requests/plan_update.rb +4 -0
- data/lib/recurly/requests/subscription_create.rb +5 -1
- data/lib/recurly/requests/subscription_create_proration_settings.rb +14 -0
- data/lib/recurly/requests/subscription_purchase.rb +4 -0
- data/lib/recurly/resources/account.rb +4 -0
- data/lib/recurly/resources/add_on.rb +4 -0
- data/lib/recurly/resources/item.rb +4 -0
- data/lib/recurly/resources/line_item.rb +4 -0
- data/lib/recurly/resources/plan.rb +4 -0
- data/lib/recurly/resources/transaction.rb +4 -0
- data/lib/recurly/resources/transaction_next_action.rb +18 -0
- data/lib/recurly/version.rb +1 -1
- data/openapi/api.yaml +254 -9
- metadata +6 -3
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 5b47a550c5fcd45124c917ca4c4dba881b5b6d045bcba8ec50b9c17a62704f49
|
|
4
|
+
data.tar.gz: 4af34eb50bb46053e22ce93ce26939c2be6ead84f8e7b8697e77ecdbdcc1f2dd
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 9cf13b027e609eedcb85f67af12a151ce40536ca3bf3e06adc4014b3fdb31cc8818f027d488b72419424a75ce0c0ec5034ea29c3584939ba809227f6c593b1f5
|
|
7
|
+
data.tar.gz: dcd17df5feb98ee03ae155e4067b4abbedb573c29c14ef2bb32317c5cde933d6007c9fb300856b9082186396cd347f02a6aa78f419ca4867c291da1c75c7153c
|
data/.bumpversion.cfg
CHANGED
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,27 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [4.69.0](https://github.com/recurly/recurly-client-ruby/tree/4.69.0) (2025-11-03)
|
|
4
|
+
|
|
5
|
+
[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.68.0...4.69.0)
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
**Merged Pull Requests**
|
|
9
|
+
|
|
10
|
+
- Generated Latest Changes for v2021-02-25 [#939](https://github.com/recurly/recurly-client-ruby/pull/939) ([recurly-integrations](https://github.com/recurly-integrations))
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
## [4.68.0](https://github.com/recurly/recurly-client-ruby/tree/4.68.0) (2025-10-09)
|
|
15
|
+
|
|
16
|
+
[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.67.0...4.68.0)
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
**Merged Pull Requests**
|
|
20
|
+
|
|
21
|
+
- Generated Latest Changes for v2021-02-25 [#936](https://github.com/recurly/recurly-client-ruby/pull/936) ([recurly-integrations](https://github.com/recurly-integrations))
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
|
|
3
25
|
## [4.67.0](https://github.com/recurly/recurly-client-ruby/tree/4.67.0) (2025-08-13)
|
|
4
26
|
|
|
5
27
|
[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.66.0...4.67.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.69'
|
|
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.
|
|
@@ -1113,6 +1113,21 @@ module Recurly
|
|
|
1113
1113
|
pager(path, **options)
|
|
1114
1114
|
end
|
|
1115
1115
|
|
|
1116
|
+
# Create an account note
|
|
1117
|
+
#
|
|
1118
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/create_account_note create_account_note api documentation}
|
|
1119
|
+
#
|
|
1120
|
+
# @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
|
|
1121
|
+
# @param body [Requests::AccountNoteCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::AccountNoteCreate}
|
|
1122
|
+
# @param params [Hash] Optional query string parameters:
|
|
1123
|
+
#
|
|
1124
|
+
# @return [Resources::AccountNote] An account note.
|
|
1125
|
+
#
|
|
1126
|
+
def create_account_note(account_id:, body:, **options)
|
|
1127
|
+
path = interpolate_path("/accounts/{account_id}/notes", account_id: account_id)
|
|
1128
|
+
post(path, body, Requests::AccountNoteCreate, **options)
|
|
1129
|
+
end
|
|
1130
|
+
|
|
1116
1131
|
# Fetch an account note
|
|
1117
1132
|
#
|
|
1118
1133
|
# {https://developers.recurly.com/api/v2021-02-25#operation/get_account_note get_account_note api documentation}
|
|
@@ -1140,6 +1155,21 @@ module Recurly
|
|
|
1140
1155
|
get(path, **options)
|
|
1141
1156
|
end
|
|
1142
1157
|
|
|
1158
|
+
# Delete an account note
|
|
1159
|
+
#
|
|
1160
|
+
# {https://developers.recurly.com/api/v2021-02-25#operation/remove_account_note remove_account_note api documentation}
|
|
1161
|
+
#
|
|
1162
|
+
# @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
|
|
1163
|
+
# @param account_note_id [String] Account Note ID.
|
|
1164
|
+
# @param params [Hash] Optional query string parameters:
|
|
1165
|
+
#
|
|
1166
|
+
# @return [Resources::Empty] Account note deleted.
|
|
1167
|
+
#
|
|
1168
|
+
def remove_account_note(account_id:, account_note_id:, **options)
|
|
1169
|
+
path = interpolate_path("/accounts/{account_id}/notes/{account_note_id}", account_id: account_id, account_note_id: account_note_id)
|
|
1170
|
+
delete(path, **options)
|
|
1171
|
+
end
|
|
1172
|
+
|
|
1143
1173
|
# Fetch a list of an account's shipping addresses
|
|
1144
1174
|
#
|
|
1145
1175
|
# {https://developers.recurly.com/api/v2021-02-25#operation/list_shipping_addresses list_shipping_addresses api documentation}
|
|
@@ -14,6 +14,10 @@ module Recurly
|
|
|
14
14
|
# @return [Address]
|
|
15
15
|
define_attribute :address, :Address
|
|
16
16
|
|
|
17
|
+
# @!attribute bill_date
|
|
18
|
+
# @return [DateTime] The preferred billing date for the account. This date will be used as the billing date for when activating new subscriptions on the account.
|
|
19
|
+
define_attribute :bill_date, DateTime
|
|
20
|
+
|
|
17
21
|
# @!attribute bill_to
|
|
18
22
|
# @return [String] An enumerable describing the billing behavior of the account, specifically whether the account is self-paying or will rely on the parent account to pay.
|
|
19
23
|
define_attribute :bill_to, String
|
|
@@ -0,0 +1,14 @@
|
|
|
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 AccountNoteCreate < Request
|
|
8
|
+
|
|
9
|
+
# @!attribute message
|
|
10
|
+
# @return [String] The content of the account note.
|
|
11
|
+
define_attribute :message, String
|
|
12
|
+
end
|
|
13
|
+
end
|
|
14
|
+
end
|
|
@@ -14,6 +14,10 @@ module Recurly
|
|
|
14
14
|
# @return [Address]
|
|
15
15
|
define_attribute :address, :Address
|
|
16
16
|
|
|
17
|
+
# @!attribute bill_date
|
|
18
|
+
# @return [DateTime] The preferred billing date for the account. This date will be used as the billing date for when activating new subscriptions on the account.
|
|
19
|
+
define_attribute :bill_date, DateTime
|
|
20
|
+
|
|
17
21
|
# @!attribute bill_to
|
|
18
22
|
# @return [String] An enumerable describing the billing behavior of the account, specifically whether the account is self-paying or will rely on the parent account to pay.
|
|
19
23
|
define_attribute :bill_to, String
|
|
@@ -10,6 +10,10 @@ module Recurly
|
|
|
10
10
|
# @return [Address]
|
|
11
11
|
define_attribute :address, :Address
|
|
12
12
|
|
|
13
|
+
# @!attribute bill_date
|
|
14
|
+
# @return [DateTime] The preferred billing date for the account. This date will be used as the billing date for when activating new subscriptions on the account.
|
|
15
|
+
define_attribute :bill_date, DateTime
|
|
16
|
+
|
|
13
17
|
# @!attribute bill_to
|
|
14
18
|
# @return [String] An enumerable describing the billing behavior of the account, specifically whether the account is self-paying or will rely on the parent account to pay.
|
|
15
19
|
define_attribute :bill_to, String
|
|
@@ -38,6 +38,10 @@ module Recurly
|
|
|
38
38
|
# @return [Boolean] Determines if the quantity field is displayed on the hosted pages for the add-on.
|
|
39
39
|
define_attribute :display_quantity, :Boolean
|
|
40
40
|
|
|
41
|
+
# @!attribute harmonized_system_code
|
|
42
|
+
# @return [String] The Harmonized System (HS) code is an internationally standardized system of names and numbers to classify traded products. The HS code, sometimes called Commodity Code, is used by customs authorities around the world to identify products when assessing duties and taxes. The HS code may also be referred to as the tariff code or customs code. Values should contain only digits and decimals.
|
|
43
|
+
define_attribute :harmonized_system_code, String
|
|
44
|
+
|
|
41
45
|
# @!attribute item_code
|
|
42
46
|
# @return [String] Unique code to identify an item. Available when the `Credit Invoices` feature is enabled. If `item_id` and `item_code` are both present, `item_id` will be used.
|
|
43
47
|
define_attribute :item_code, String
|
|
@@ -34,6 +34,10 @@ module Recurly
|
|
|
34
34
|
# @return [Boolean] Determines if the quantity field is displayed on the hosted pages for the add-on.
|
|
35
35
|
define_attribute :display_quantity, :Boolean
|
|
36
36
|
|
|
37
|
+
# @!attribute harmonized_system_code
|
|
38
|
+
# @return [String] The Harmonized System (HS) code is an internationally standardized system of names and numbers to classify traded products. The HS code, sometimes called Commodity Code, is used by customs authorities around the world to identify products when assessing duties and taxes. The HS code may also be referred to as the tariff code or customs code. Values should contain only digits and decimals.
|
|
39
|
+
define_attribute :harmonized_system_code, String
|
|
40
|
+
|
|
37
41
|
# @!attribute id
|
|
38
42
|
# @return [String] Add-on ID
|
|
39
43
|
define_attribute :id, String
|
|
@@ -151,7 +151,7 @@ module Recurly
|
|
|
151
151
|
define_attribute :transaction_type, String
|
|
152
152
|
|
|
153
153
|
# @!attribute type
|
|
154
|
-
# @return [String] The payment method type for a non-credit card based billing info. `bacs`
|
|
154
|
+
# @return [String] The payment method type for a non-credit card based billing info. `bacs`, `becs`, `pix-automatico`, `mercadopago` are the only accepted values.
|
|
155
155
|
define_attribute :type, String
|
|
156
156
|
|
|
157
157
|
# @!attribute vat_number
|
|
@@ -38,6 +38,10 @@ module Recurly
|
|
|
38
38
|
# @return [String] Optional, stock keeping unit to link the item to other inventory systems.
|
|
39
39
|
define_attribute :external_sku, String
|
|
40
40
|
|
|
41
|
+
# @!attribute harmonized_system_code
|
|
42
|
+
# @return [String] The Harmonized System (HS) code is an internationally standardized system of names and numbers to classify traded products. The HS code, sometimes called Commodity Code, is used by customs authorities around the world to identify products when assessing duties and taxes. The HS code may also be referred to as the tariff code or customs code. Values should contain only digits and decimals.
|
|
43
|
+
define_attribute :harmonized_system_code, String
|
|
44
|
+
|
|
41
45
|
# @!attribute liability_gl_account_id
|
|
42
46
|
# @return [String] The ID of a general ledger account. General ledger accounts are only accessible as a part of the Recurly RevRec Standard and Recurly RevRec Advanced features.
|
|
43
47
|
define_attribute :liability_gl_account_id, String
|
|
@@ -38,6 +38,10 @@ module Recurly
|
|
|
38
38
|
# @return [String] Optional, stock keeping unit to link the item to other inventory systems.
|
|
39
39
|
define_attribute :external_sku, String
|
|
40
40
|
|
|
41
|
+
# @!attribute harmonized_system_code
|
|
42
|
+
# @return [String] The Harmonized System (HS) code is an internationally standardized system of names and numbers to classify traded products. The HS code, sometimes called Commodity Code, is used by customs authorities around the world to identify products when assessing duties and taxes. The HS code may also be referred to as the tariff code or customs code. Values should contain only digits and decimals.
|
|
43
|
+
define_attribute :harmonized_system_code, String
|
|
44
|
+
|
|
41
45
|
# @!attribute liability_gl_account_id
|
|
42
46
|
# @return [String] The ID of a general ledger account. General ledger accounts are only accessible as a part of the Recurly RevRec Standard and Recurly RevRec Advanced features.
|
|
43
47
|
define_attribute :liability_gl_account_id, String
|
|
@@ -42,6 +42,10 @@ module Recurly
|
|
|
42
42
|
# @return [DateTime] If this date is provided, it indicates the end of a time range.
|
|
43
43
|
define_attribute :end_date, DateTime
|
|
44
44
|
|
|
45
|
+
# @!attribute harmonized_system_code
|
|
46
|
+
# @return [String] The Harmonized System (HS) code is an internationally standardized system of names and numbers to classify traded products. The HS code, sometimes called Commodity Code, is used by customs authorities around the world to identify products when assessing duties and taxes. The HS code may also be referred to as the tariff code or customs code. Values should contain only digits and decimals. If `item_code`/`item_id` is part of the request then `harmonized_system_code` must be absent.
|
|
47
|
+
define_attribute :harmonized_system_code, String
|
|
48
|
+
|
|
45
49
|
# @!attribute item_code
|
|
46
50
|
# @return [String] Unique code to identify an item. Available when the Credit Invoices feature is enabled.
|
|
47
51
|
define_attribute :item_code, String
|
|
@@ -50,6 +50,10 @@ module Recurly
|
|
|
50
50
|
# @return [String] Unique ID to identify a dunning campaign. Used to specify if a non-default dunning campaign should be assigned to this plan. For sites without multiple dunning campaigns enabled, the default dunning campaign will always be used.
|
|
51
51
|
define_attribute :dunning_campaign_id, String
|
|
52
52
|
|
|
53
|
+
# @!attribute harmonized_system_code
|
|
54
|
+
# @return [String] The Harmonized System (HS) code is an internationally standardized system of names and numbers to classify traded products. The HS code, sometimes called Commodity Code, is used by customs authorities around the world to identify products when assessing duties and taxes. The HS code may also be referred to as the tariff code or customs code. Values should contain only digits and decimals.
|
|
55
|
+
define_attribute :harmonized_system_code, String
|
|
56
|
+
|
|
53
57
|
# @!attribute hosted_pages
|
|
54
58
|
# @return [PlanHostedPages] Hosted pages settings
|
|
55
59
|
define_attribute :hosted_pages, :PlanHostedPages
|
|
@@ -46,6 +46,10 @@ module Recurly
|
|
|
46
46
|
# @return [String] Unique ID to identify a dunning campaign. Used to specify if a non-default dunning campaign should be assigned to this plan. For sites without multiple dunning campaigns enabled, the default dunning campaign will always be used.
|
|
47
47
|
define_attribute :dunning_campaign_id, String
|
|
48
48
|
|
|
49
|
+
# @!attribute harmonized_system_code
|
|
50
|
+
# @return [String] The Harmonized System (HS) code is an internationally standardized system of names and numbers to classify traded products. The HS code, sometimes called Commodity Code, is used by customs authorities around the world to identify products when assessing duties and taxes. The HS code may also be referred to as the tariff code or customs code. Values should contain only digits and decimals.
|
|
51
|
+
define_attribute :harmonized_system_code, String
|
|
52
|
+
|
|
49
53
|
# @!attribute hosted_pages
|
|
50
54
|
# @return [PlanHostedPages] Hosted pages settings
|
|
51
55
|
define_attribute :hosted_pages, :PlanHostedPages
|
|
@@ -59,7 +59,7 @@ module Recurly
|
|
|
59
59
|
define_attribute :customer_notes, String
|
|
60
60
|
|
|
61
61
|
# @!attribute gateway_code
|
|
62
|
-
# @return [String] If present, this subscription's transactions will use the payment gateway with this code.
|
|
62
|
+
# @return [String] If present, this subscription's subsequent transactions will use the payment gateway with this code. To select a payment gateway to use when creating a Subscription, be sure to set the `account.billing_info.gateway_code` as well.
|
|
63
63
|
define_attribute :gateway_code, String
|
|
64
64
|
|
|
65
65
|
# @!attribute gift_card_redemption_code
|
|
@@ -94,6 +94,10 @@ module Recurly
|
|
|
94
94
|
# @return [String] The price segment ID, e.g. `e28zov4fw0v2`.
|
|
95
95
|
define_attribute :price_segment_id, String
|
|
96
96
|
|
|
97
|
+
# @!attribute proration_settings
|
|
98
|
+
# @return [SubscriptionCreateProrationSettings] Allows you to control how any resulting charges will be calculated and prorated.
|
|
99
|
+
define_attribute :proration_settings, :SubscriptionCreateProrationSettings
|
|
100
|
+
|
|
97
101
|
# @!attribute quantity
|
|
98
102
|
# @return [Integer] Optionally override the default quantity of 1.
|
|
99
103
|
define_attribute :quantity, Integer
|
|
@@ -0,0 +1,14 @@
|
|
|
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 SubscriptionCreateProrationSettings < Request
|
|
8
|
+
|
|
9
|
+
# @!attribute charge
|
|
10
|
+
# @return [String] Determines how the amount charged is determined for this change
|
|
11
|
+
define_attribute :charge, String
|
|
12
|
+
end
|
|
13
|
+
end
|
|
14
|
+
end
|
|
@@ -38,6 +38,10 @@ module Recurly
|
|
|
38
38
|
# @return [String] The price segment ID or code. For ID no prefix is used e.g. `e28zov4fw0v2`. For requests, the code can also be used. Use prefix `code-`, e.g. `code-gold`.
|
|
39
39
|
define_attribute :price_segment_id, String
|
|
40
40
|
|
|
41
|
+
# @!attribute proration_settings
|
|
42
|
+
# @return [SubscriptionCreateProrationSettings] Allows you to control how any resulting charges will be calculated and prorated.
|
|
43
|
+
define_attribute :proration_settings, :SubscriptionCreateProrationSettings
|
|
44
|
+
|
|
41
45
|
# @!attribute quantity
|
|
42
46
|
# @return [Integer] Optionally override the default quantity of 1.
|
|
43
47
|
define_attribute :quantity, Integer
|
|
@@ -10,6 +10,10 @@ module Recurly
|
|
|
10
10
|
# @return [Address]
|
|
11
11
|
define_attribute :address, :Address
|
|
12
12
|
|
|
13
|
+
# @!attribute bill_date
|
|
14
|
+
# @return [DateTime] The preferred billing date for the account. This date will be used as the billing date for when activating new subscriptions on the account.
|
|
15
|
+
define_attribute :bill_date, DateTime
|
|
16
|
+
|
|
13
17
|
# @!attribute bill_to
|
|
14
18
|
# @return [String] An enumerable describing the billing behavior of the account, specifically whether the account is self-paying or will rely on the parent account to pay.
|
|
15
19
|
define_attribute :bill_to, String
|
|
@@ -50,6 +50,10 @@ module Recurly
|
|
|
50
50
|
# @return [String] Optional, stock keeping unit to link the item to other inventory systems.
|
|
51
51
|
define_attribute :external_sku, String
|
|
52
52
|
|
|
53
|
+
# @!attribute harmonized_system_code
|
|
54
|
+
# @return [String] The Harmonized System (HS) code is an internationally standardized system of names and numbers to classify traded products. The HS code, sometimes called Commodity Code, is used by customs authorities around the world to identify products when assessing duties and taxes. The HS code may also be referred to as the tariff code or customs code. Values should contain only digits and decimals.
|
|
55
|
+
define_attribute :harmonized_system_code, String
|
|
56
|
+
|
|
53
57
|
# @!attribute id
|
|
54
58
|
# @return [String] Add-on ID
|
|
55
59
|
define_attribute :id, String
|
|
@@ -46,6 +46,10 @@ module Recurly
|
|
|
46
46
|
# @return [String] Optional, stock keeping unit to link the item to other inventory systems.
|
|
47
47
|
define_attribute :external_sku, String
|
|
48
48
|
|
|
49
|
+
# @!attribute harmonized_system_code
|
|
50
|
+
# @return [String] The Harmonized System (HS) code is an internationally standardized system of names and numbers to classify traded products. The HS code, sometimes called Commodity Code, is used by customs authorities around the world to identify products when assessing duties and taxes. The HS code may also be referred to as the tariff code or customs code. Values should contain only digits and decimals.
|
|
51
|
+
define_attribute :harmonized_system_code, String
|
|
52
|
+
|
|
49
53
|
# @!attribute id
|
|
50
54
|
# @return [String] Item ID
|
|
51
55
|
define_attribute :id, String
|
|
@@ -78,6 +78,10 @@ module Recurly
|
|
|
78
78
|
# @return [String] Optional Stock Keeping Unit assigned to an item. Available when the Credit Invoices feature is enabled.
|
|
79
79
|
define_attribute :external_sku, String
|
|
80
80
|
|
|
81
|
+
# @!attribute harmonized_system_code
|
|
82
|
+
# @return [String] The Harmonized System (HS) code is an internationally standardized system of names and numbers to classify traded products. The HS code, sometimes called Commodity Code, is used by customs authorities around the world to identify products when assessing duties and taxes. The HS code may also be referred to as the tariff code or customs code. Values should contain only digits and decimals.
|
|
83
|
+
define_attribute :harmonized_system_code, String
|
|
84
|
+
|
|
81
85
|
# @!attribute id
|
|
82
86
|
# @return [String] Line item ID
|
|
83
87
|
define_attribute :id, String
|
|
@@ -54,6 +54,10 @@ module Recurly
|
|
|
54
54
|
# @return [String] Unique ID to identify a dunning campaign. Used to specify if a non-default dunning campaign should be assigned to this plan. For sites without multiple dunning campaigns enabled, the default dunning campaign will always be used.
|
|
55
55
|
define_attribute :dunning_campaign_id, String
|
|
56
56
|
|
|
57
|
+
# @!attribute harmonized_system_code
|
|
58
|
+
# @return [String] The Harmonized System (HS) code is an internationally standardized system of names and numbers to classify traded products. The HS code, sometimes called Commodity Code, is used by customs authorities around the world to identify products when assessing duties and taxes. The HS code may also be referred to as the tariff code or customs code. Values should contain only digits and decimals.
|
|
59
|
+
define_attribute :harmonized_system_code, String
|
|
60
|
+
|
|
57
61
|
# @!attribute hosted_pages
|
|
58
62
|
# @return [PlanHostedPages] Hosted pages settings
|
|
59
63
|
define_attribute :hosted_pages, :PlanHostedPages
|
|
@@ -110,6 +110,10 @@ module Recurly
|
|
|
110
110
|
# @return [String] This conditional parameter is useful for merchants in specific industries who need to submit one-time Merchant Initiated transactions in specific cases. Not all gateways support these methods, but will support a generic one-time Merchant Initiated transaction. Only use this if the initiator value is "merchant". Otherwise, it will be ignored. - Incremental: Send `incremental` with an additional purchase if the original authorization amount is not sufficient to cover the costs of your service or product. For example, if the customer adds goods or services or there are additional expenses. - No Show: Send `no_show` if you charge customers a fee due to an agreed-upon cancellation policy in your industry. - Resubmission: Send `resubmission` if you need to attempt collection on a declined transaction. You may also use the force collection behavior which has the same effect. - Service Extension: Send `service_extension` if you are in a service industry and the customer has increased/extended their service in some way. For example: adding a day onto a car rental agreement. - Split Shipment: Send `split_shipment` if you sell physical product and need to split up a shipment into multiple transactions when the customer is no longer in session. - Top Up: Send `top_up` if you process one-time transactions based on a pre-arranged agreement with your customer where there is a pre-arranged account balance that needs maintaining. For example, if the customer has agreed to maintain an account balance of 30.00 and their current balance is 20.00, the MIT amount would be at least 10.00 to meet that 30.00 threshold.
|
|
111
111
|
define_attribute :merchant_reason_code, String
|
|
112
112
|
|
|
113
|
+
# @!attribute next_action
|
|
114
|
+
# @return [TransactionNextAction] Next action values are used for any required customer follow-up action. Currently, this is supported for Ebanx when using Pix Automatico.
|
|
115
|
+
define_attribute :next_action, :TransactionNextAction
|
|
116
|
+
|
|
113
117
|
# @!attribute object
|
|
114
118
|
# @return [String] Object type
|
|
115
119
|
define_attribute :object, String
|
|
@@ -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 TransactionNextAction < Resource
|
|
8
|
+
|
|
9
|
+
# @!attribute type
|
|
10
|
+
# @return [String] The type of next action required.
|
|
11
|
+
define_attribute :type, String
|
|
12
|
+
|
|
13
|
+
# @!attribute value
|
|
14
|
+
# @return [String] The value associated with the next action type.
|
|
15
|
+
define_attribute :value, String
|
|
16
|
+
end
|
|
17
|
+
end
|
|
18
|
+
end
|
data/lib/recurly/version.rb
CHANGED
data/openapi/api.yaml
CHANGED
|
@@ -4462,6 +4462,51 @@ paths:
|
|
|
4462
4462
|
accountNotes.Fetch()\n\tif e, ok := err.(*recurly.Error); ok {\n\t\tfmt.Printf(\"Failed
|
|
4463
4463
|
to retrieve next page: %v\", e)\n\t\tbreak\n\t}\n\tfor i, note := range
|
|
4464
4464
|
accountNotes.Data() {\n\t\tfmt.Printf(\"Account Note %3d: %s\\n\",\n\t\t\ti,\n\t\t\tnote.Id,\n\t\t)\n\t}\n}"
|
|
4465
|
+
post:
|
|
4466
|
+
tags:
|
|
4467
|
+
- note
|
|
4468
|
+
operationId: create_account_note
|
|
4469
|
+
summary: Create an account note
|
|
4470
|
+
parameters:
|
|
4471
|
+
- "$ref": "#/components/parameters/account_id"
|
|
4472
|
+
requestBody:
|
|
4473
|
+
content:
|
|
4474
|
+
application/json:
|
|
4475
|
+
schema:
|
|
4476
|
+
"$ref": "#/components/schemas/AccountNoteCreate"
|
|
4477
|
+
required: true
|
|
4478
|
+
responses:
|
|
4479
|
+
'201':
|
|
4480
|
+
description: An account note.
|
|
4481
|
+
content:
|
|
4482
|
+
application/json:
|
|
4483
|
+
schema:
|
|
4484
|
+
"$ref": "#/components/schemas/AccountNote"
|
|
4485
|
+
'400':
|
|
4486
|
+
description: Bad request; perhaps missing or invalid parameters.
|
|
4487
|
+
content:
|
|
4488
|
+
application/json:
|
|
4489
|
+
schema:
|
|
4490
|
+
"$ref": "#/components/schemas/Error"
|
|
4491
|
+
'404':
|
|
4492
|
+
description: Incorrect site or account ID.
|
|
4493
|
+
content:
|
|
4494
|
+
application/json:
|
|
4495
|
+
schema:
|
|
4496
|
+
"$ref": "#/components/schemas/Error"
|
|
4497
|
+
'422':
|
|
4498
|
+
description: A validation error.
|
|
4499
|
+
content:
|
|
4500
|
+
application/json:
|
|
4501
|
+
schema:
|
|
4502
|
+
"$ref": "#/components/schemas/Error"
|
|
4503
|
+
default:
|
|
4504
|
+
description: Unexpected error.
|
|
4505
|
+
content:
|
|
4506
|
+
application/json:
|
|
4507
|
+
schema:
|
|
4508
|
+
"$ref": "#/components/schemas/Error"
|
|
4509
|
+
x-code-samples: []
|
|
4465
4510
|
"/accounts/{account_id}/notes/{account_note_id}":
|
|
4466
4511
|
get:
|
|
4467
4512
|
tags:
|
|
@@ -4470,12 +4515,7 @@ paths:
|
|
|
4470
4515
|
summary: Fetch an account note
|
|
4471
4516
|
parameters:
|
|
4472
4517
|
- "$ref": "#/components/parameters/account_id"
|
|
4473
|
-
-
|
|
4474
|
-
in: path
|
|
4475
|
-
description: Account Note ID.
|
|
4476
|
-
required: true
|
|
4477
|
-
schema:
|
|
4478
|
-
type: string
|
|
4518
|
+
- "$ref": "#/components/parameters/account_note_id"
|
|
4479
4519
|
responses:
|
|
4480
4520
|
'200':
|
|
4481
4521
|
description: An account note.
|
|
@@ -4588,6 +4628,30 @@ paths:
|
|
|
4588
4628
|
{\n\t\tfmt.Printf(\"Resource not found: %v\", e)\n\t\treturn nil, err\n\t}\n\tfmt.Printf(\"Unexpected
|
|
4589
4629
|
Recurly error: %v\", e)\n\treturn nil, err\n}\nfmt.Printf(\"Fetched Account
|
|
4590
4630
|
Note: %v\", accountNote)"
|
|
4631
|
+
delete:
|
|
4632
|
+
tags:
|
|
4633
|
+
- note
|
|
4634
|
+
operationId: remove_account_note
|
|
4635
|
+
summary: Delete an account note
|
|
4636
|
+
parameters:
|
|
4637
|
+
- "$ref": "#/components/parameters/account_id"
|
|
4638
|
+
- "$ref": "#/components/parameters/account_note_id"
|
|
4639
|
+
responses:
|
|
4640
|
+
'204':
|
|
4641
|
+
description: Account note deleted.
|
|
4642
|
+
'404':
|
|
4643
|
+
description: Incorrect site, account or note ID.
|
|
4644
|
+
content:
|
|
4645
|
+
application/json:
|
|
4646
|
+
schema:
|
|
4647
|
+
"$ref": "#/components/schemas/Error"
|
|
4648
|
+
default:
|
|
4649
|
+
description: Unexpected error.
|
|
4650
|
+
content:
|
|
4651
|
+
application/json:
|
|
4652
|
+
schema:
|
|
4653
|
+
"$ref": "#/components/schemas/Error"
|
|
4654
|
+
x-code-samples: []
|
|
4591
4655
|
"/accounts/{account_id}/shipping_addresses":
|
|
4592
4656
|
get:
|
|
4593
4657
|
tags:
|
|
@@ -16941,6 +17005,13 @@ components:
|
|
|
16941
17005
|
required: true
|
|
16942
17006
|
schema:
|
|
16943
17007
|
type: string
|
|
17008
|
+
account_note_id:
|
|
17009
|
+
name: account_note_id
|
|
17010
|
+
in: path
|
|
17011
|
+
description: Account Note ID.
|
|
17012
|
+
required: true
|
|
17013
|
+
schema:
|
|
17014
|
+
type: string
|
|
16944
17015
|
add_on_id:
|
|
16945
17016
|
name: add_on_id
|
|
16946
17017
|
in: path
|
|
@@ -18046,6 +18117,13 @@ components:
|
|
|
18046
18117
|
description: The Avalara AvaTax value that can be passed to identify the
|
|
18047
18118
|
customer type for tax purposes. The range of values can be A - R (more
|
|
18048
18119
|
info at Avalara). Value is case-sensitive.
|
|
18120
|
+
bill_date:
|
|
18121
|
+
type: string
|
|
18122
|
+
title: Bill Date
|
|
18123
|
+
format: date-time
|
|
18124
|
+
description: The preferred billing date for the account. This date will
|
|
18125
|
+
be used as the billing date for when activating new subscriptions on the
|
|
18126
|
+
account.
|
|
18049
18127
|
AccountResponse:
|
|
18050
18128
|
type: object
|
|
18051
18129
|
properties:
|
|
@@ -18152,6 +18230,13 @@ components:
|
|
|
18152
18230
|
description: The Avalara AvaTax value that can be passed to identify the
|
|
18153
18231
|
customer type for tax purposes. The range of values can be A - R (more
|
|
18154
18232
|
info at Avalara). Value is case-sensitive.
|
|
18233
|
+
bill_date:
|
|
18234
|
+
title: Bill Date
|
|
18235
|
+
type: string
|
|
18236
|
+
format: date-time
|
|
18237
|
+
description: The preferred billing date for the account. This date will
|
|
18238
|
+
be used as the billing date for when activating new subscriptions on the
|
|
18239
|
+
account.
|
|
18155
18240
|
AccountNote:
|
|
18156
18241
|
type: object
|
|
18157
18242
|
required:
|
|
@@ -18175,6 +18260,14 @@ components:
|
|
|
18175
18260
|
type: string
|
|
18176
18261
|
format: date-time
|
|
18177
18262
|
readOnly: true
|
|
18263
|
+
AccountNoteCreate:
|
|
18264
|
+
type: object
|
|
18265
|
+
required:
|
|
18266
|
+
- message
|
|
18267
|
+
properties:
|
|
18268
|
+
message:
|
|
18269
|
+
type: string
|
|
18270
|
+
description: The content of the account note.
|
|
18178
18271
|
AccountMini:
|
|
18179
18272
|
type: object
|
|
18180
18273
|
title: Account mini details
|
|
@@ -18280,9 +18373,11 @@ components:
|
|
|
18280
18373
|
street1:
|
|
18281
18374
|
type: string
|
|
18282
18375
|
title: Street 1
|
|
18376
|
+
maxLength: 50
|
|
18283
18377
|
street2:
|
|
18284
18378
|
type: string
|
|
18285
18379
|
title: Street 2
|
|
18380
|
+
maxLength: 50
|
|
18286
18381
|
city:
|
|
18287
18382
|
type: string
|
|
18288
18383
|
title: City
|
|
@@ -18488,6 +18583,17 @@ components:
|
|
|
18488
18583
|
offering you can also choose to instead use simple values of `unknown`,
|
|
18489
18584
|
`physical`, or `digital` tax codes. If `item_code`/`item_id` is part of
|
|
18490
18585
|
the request then `tax_code` must be absent.
|
|
18586
|
+
harmonized_system_code:
|
|
18587
|
+
type: string
|
|
18588
|
+
title: Harmonized System code
|
|
18589
|
+
description: The Harmonized System (HS) code is an internationally standardized
|
|
18590
|
+
system of names and numbers to classify traded products. The HS code,
|
|
18591
|
+
sometimes called Commodity Code, is used by customs authorities around
|
|
18592
|
+
the world to identify products when assessing duties and taxes. The HS
|
|
18593
|
+
code may also be referred to as the tariff code or customs code. Values
|
|
18594
|
+
should contain only digits and decimals.
|
|
18595
|
+
pattern: "^\\d+(\\.\\d+)*$"
|
|
18596
|
+
maxLength: 25
|
|
18491
18597
|
display_quantity:
|
|
18492
18598
|
type: boolean
|
|
18493
18599
|
title: Display quantity?
|
|
@@ -18710,6 +18816,17 @@ components:
|
|
|
18710
18816
|
offering you can also choose to instead use simple values of `unknown`,
|
|
18711
18817
|
`physical`, or `digital` tax codes. If `item_code`/`item_id` is part of
|
|
18712
18818
|
the request then `tax_code` must be absent.
|
|
18819
|
+
harmonized_system_code:
|
|
18820
|
+
type: string
|
|
18821
|
+
title: Harmonized System code
|
|
18822
|
+
description: The Harmonized System (HS) code is an internationally standardized
|
|
18823
|
+
system of names and numbers to classify traded products. The HS code,
|
|
18824
|
+
sometimes called Commodity Code, is used by customs authorities around
|
|
18825
|
+
the world to identify products when assessing duties and taxes. The HS
|
|
18826
|
+
code may also be referred to as the tariff code or customs code. Values
|
|
18827
|
+
should contain only digits and decimals.
|
|
18828
|
+
pattern: "^\\d+(\\.\\d+)*$"
|
|
18829
|
+
maxLength: 25
|
|
18713
18830
|
currencies:
|
|
18714
18831
|
type: array
|
|
18715
18832
|
title: Add-on pricing
|
|
@@ -18865,6 +18982,17 @@ components:
|
|
|
18865
18982
|
offering you can also choose to instead use simple values of `unknown`,
|
|
18866
18983
|
`physical`, or `digital` tax codes. If an `Item` is associated to the
|
|
18867
18984
|
`AddOn` then `tax_code` must be absent.
|
|
18985
|
+
harmonized_system_code:
|
|
18986
|
+
type: string
|
|
18987
|
+
title: Harmonized System code
|
|
18988
|
+
description: The Harmonized System (HS) code is an internationally standardized
|
|
18989
|
+
system of names and numbers to classify traded products. The HS code,
|
|
18990
|
+
sometimes called Commodity Code, is used by customs authorities around
|
|
18991
|
+
the world to identify products when assessing duties and taxes. The HS
|
|
18992
|
+
code may also be referred to as the tariff code or customs code. Values
|
|
18993
|
+
should contain only digits and decimals.
|
|
18994
|
+
pattern: "^\\d+(\\.\\d+)*$"
|
|
18995
|
+
maxLength: 25
|
|
18868
18996
|
display_quantity:
|
|
18869
18997
|
type: boolean
|
|
18870
18998
|
title: Display quantity?
|
|
@@ -20207,6 +20335,17 @@ components:
|
|
|
20207
20335
|
codes using any of these tax integrations. For Recurly's In-the-Box tax
|
|
20208
20336
|
offering you can also choose to instead use simple values of `unknown`,
|
|
20209
20337
|
`physical`, or `digital` tax codes.
|
|
20338
|
+
harmonized_system_code:
|
|
20339
|
+
type: string
|
|
20340
|
+
title: Harmonized System code
|
|
20341
|
+
description: The Harmonized System (HS) code is an internationally standardized
|
|
20342
|
+
system of names and numbers to classify traded products. The HS code,
|
|
20343
|
+
sometimes called Commodity Code, is used by customs authorities around
|
|
20344
|
+
the world to identify products when assessing duties and taxes. The HS
|
|
20345
|
+
code may also be referred to as the tariff code or customs code. Values
|
|
20346
|
+
should contain only digits and decimals.
|
|
20347
|
+
pattern: "^\\d+(\\.\\d+)*$"
|
|
20348
|
+
maxLength: 25
|
|
20210
20349
|
tax_exempt:
|
|
20211
20350
|
type: boolean
|
|
20212
20351
|
title: Tax exempt?
|
|
@@ -20317,6 +20456,17 @@ components:
|
|
|
20317
20456
|
codes using any of these tax integrations. For Recurly's In-the-Box tax
|
|
20318
20457
|
offering you can also choose to instead use simple values of `unknown`,
|
|
20319
20458
|
`physical`, or `digital` tax codes.
|
|
20459
|
+
harmonized_system_code:
|
|
20460
|
+
type: string
|
|
20461
|
+
title: Harmonized System code
|
|
20462
|
+
description: The Harmonized System (HS) code is an internationally standardized
|
|
20463
|
+
system of names and numbers to classify traded products. The HS code,
|
|
20464
|
+
sometimes called Commodity Code, is used by customs authorities around
|
|
20465
|
+
the world to identify products when assessing duties and taxes. The HS
|
|
20466
|
+
code may also be referred to as the tariff code or customs code. Values
|
|
20467
|
+
should contain only digits and decimals.
|
|
20468
|
+
pattern: "^\\d+(\\.\\d+)*$"
|
|
20469
|
+
maxLength: 25
|
|
20320
20470
|
tax_exempt:
|
|
20321
20471
|
type: boolean
|
|
20322
20472
|
title: Tax exempt?
|
|
@@ -20415,6 +20565,17 @@ components:
|
|
|
20415
20565
|
codes using any of these tax integrations. For Recurly's In-the-Box tax
|
|
20416
20566
|
offering you can also choose to instead use simple values of `unknown`,
|
|
20417
20567
|
`physical`, or `digital` tax codes.
|
|
20568
|
+
harmonized_system_code:
|
|
20569
|
+
type: string
|
|
20570
|
+
title: Harmonized System Code
|
|
20571
|
+
description: The Harmonized System (HS) code is an internationally standardized
|
|
20572
|
+
system of names and numbers to classify traded products. The HS code,
|
|
20573
|
+
sometimes called Commodity Code, is used by customs authorities around
|
|
20574
|
+
the world to identify products when assessing duties and taxes. The HS
|
|
20575
|
+
code may also be referred to as the tariff code or customs code. Values
|
|
20576
|
+
should contain only digits and decimals.
|
|
20577
|
+
pattern: "^\\d+(\\.\\d+)*$"
|
|
20578
|
+
maxLength: 25
|
|
20418
20579
|
tax_exempt:
|
|
20419
20580
|
type: boolean
|
|
20420
20581
|
title: Tax exempt?
|
|
@@ -21310,6 +21471,17 @@ components:
|
|
|
21310
21471
|
codes using any of these tax integrations. For Recurly's In-the-Box tax
|
|
21311
21472
|
offering you can also choose to instead use simple values of `unknown`,
|
|
21312
21473
|
`physical`, or `digital` tax codes.
|
|
21474
|
+
harmonized_system_code:
|
|
21475
|
+
type: string
|
|
21476
|
+
title: Harmonized System Code
|
|
21477
|
+
description: The Harmonized System (HS) code is an internationally standardized
|
|
21478
|
+
system of names and numbers to classify traded products. The HS code,
|
|
21479
|
+
sometimes called Commodity Code, is used by customs authorities around
|
|
21480
|
+
the world to identify products when assessing duties and taxes. The HS
|
|
21481
|
+
code may also be referred to as the tariff code or customs code. Values
|
|
21482
|
+
should contain only digits and decimals.
|
|
21483
|
+
maxLength: 25
|
|
21484
|
+
pattern: "^\\d+(\\.\\d+)*$"
|
|
21313
21485
|
tax_info:
|
|
21314
21486
|
"$ref": "#/components/schemas/TaxInfo"
|
|
21315
21487
|
origin_tax_address_source:
|
|
@@ -21554,6 +21726,18 @@ components:
|
|
|
21554
21726
|
codes using any of these tax integrations. For Recurly's In-the-Box tax
|
|
21555
21727
|
offering you can also choose to instead use simple values of `unknown`,
|
|
21556
21728
|
`physical`, or `digital` tax codes.
|
|
21729
|
+
harmonized_system_code:
|
|
21730
|
+
type: string
|
|
21731
|
+
title: Harmonized System Code
|
|
21732
|
+
description: The Harmonized System (HS) code is an internationally standardized
|
|
21733
|
+
system of names and numbers to classify traded products. The HS code,
|
|
21734
|
+
sometimes called Commodity Code, is used by customs authorities around
|
|
21735
|
+
the world to identify products when assessing duties and taxes. The HS
|
|
21736
|
+
code may also be referred to as the tariff code or customs code. Values
|
|
21737
|
+
should contain only digits and decimals. If `item_code`/`item_id` is part
|
|
21738
|
+
of the request then `harmonized_system_code` must be absent.
|
|
21739
|
+
maxLength: 25
|
|
21740
|
+
pattern: "^\\d+(\\.\\d+)*$"
|
|
21557
21741
|
product_code:
|
|
21558
21742
|
type: string
|
|
21559
21743
|
title: Product code
|
|
@@ -21749,6 +21933,17 @@ components:
|
|
|
21749
21933
|
codes using any of these tax integrations. For Recurly's In-the-Box tax
|
|
21750
21934
|
offering you can also choose to instead use simple values of `unknown`,
|
|
21751
21935
|
`physical`, or `digital` tax codes.
|
|
21936
|
+
harmonized_system_code:
|
|
21937
|
+
type: string
|
|
21938
|
+
title: Harmonized System Code
|
|
21939
|
+
description: The Harmonized System (HS) code is an internationally standardized
|
|
21940
|
+
system of names and numbers to classify traded products. The HS code,
|
|
21941
|
+
sometimes called Commodity Code, is used by customs authorities around
|
|
21942
|
+
the world to identify products when assessing duties and taxes. The HS
|
|
21943
|
+
code may also be referred to as the tariff code or customs code. Values
|
|
21944
|
+
should contain only digits and decimals.
|
|
21945
|
+
maxLength: 25
|
|
21946
|
+
pattern: "^\\d+(\\.\\d+)*$"
|
|
21752
21947
|
tax_exempt:
|
|
21753
21948
|
type: boolean
|
|
21754
21949
|
title: Tax exempt?
|
|
@@ -22182,6 +22377,22 @@ components:
|
|
|
22182
22377
|
- full_amount
|
|
22183
22378
|
- prorated_amount
|
|
22184
22379
|
- none
|
|
22380
|
+
SubscriptionCreateProrationSettings:
|
|
22381
|
+
type: object
|
|
22382
|
+
title: Proration Settings
|
|
22383
|
+
description: Allows you to control how any resulting charges will be calculated
|
|
22384
|
+
and prorated.
|
|
22385
|
+
properties:
|
|
22386
|
+
charge:
|
|
22387
|
+
"$ref": "#/components/schemas/SubscriptionCreateProrationSettingsChargeEnum"
|
|
22388
|
+
SubscriptionCreateProrationSettingsChargeEnum:
|
|
22389
|
+
type: string
|
|
22390
|
+
title: Charge
|
|
22391
|
+
description: Determines how the amount charged is determined for this change
|
|
22392
|
+
default: prorated_amount
|
|
22393
|
+
enum:
|
|
22394
|
+
- full_amount
|
|
22395
|
+
- prorated_amount
|
|
22185
22396
|
Settings:
|
|
22186
22397
|
type: object
|
|
22187
22398
|
properties:
|
|
@@ -23768,8 +23979,10 @@ components:
|
|
|
23768
23979
|
gateway_code:
|
|
23769
23980
|
type: string
|
|
23770
23981
|
title: Gateway Code
|
|
23771
|
-
description: If present, this subscription's transactions will
|
|
23772
|
-
gateway with this code.
|
|
23982
|
+
description: If present, this subscription's subsequent transactions will
|
|
23983
|
+
use the payment gateway with this code. To select a payment gateway to
|
|
23984
|
+
use when creating a Subscription, be sure to set the `account.billing_info.gateway_code`
|
|
23985
|
+
as well.
|
|
23773
23986
|
maxLength: 13
|
|
23774
23987
|
transaction_type:
|
|
23775
23988
|
description: An optional type designation for the payment gateway transaction
|
|
@@ -23787,6 +24000,8 @@ components:
|
|
|
23787
24000
|
second limit on creating subscriptions. Should only be used when creating
|
|
23788
24001
|
subscriptions in bulk from the API.
|
|
23789
24002
|
default: false
|
|
24003
|
+
proration_settings:
|
|
24004
|
+
"$ref": "#/components/schemas/SubscriptionCreateProrationSettings"
|
|
23790
24005
|
required:
|
|
23791
24006
|
- plan_code
|
|
23792
24007
|
- currency
|
|
@@ -23898,6 +24113,8 @@ components:
|
|
|
23898
24113
|
second limit on creating subscriptions. Should only be used when creating
|
|
23899
24114
|
subscriptions in bulk from the API.
|
|
23900
24115
|
default: false
|
|
24116
|
+
proration_settings:
|
|
24117
|
+
"$ref": "#/components/schemas/SubscriptionCreateProrationSettings"
|
|
23901
24118
|
required:
|
|
23902
24119
|
- plan_code
|
|
23903
24120
|
SubscriptionUpdate:
|
|
@@ -24421,6 +24638,22 @@ components:
|
|
|
24421
24638
|
title: VAT Number
|
|
24422
24639
|
fraud_info:
|
|
24423
24640
|
"$ref": "#/components/schemas/TransactionFraudInfo"
|
|
24641
|
+
next_action:
|
|
24642
|
+
type: object
|
|
24643
|
+
x-class-name: TransactionNextAction
|
|
24644
|
+
description: Next action values are used for any required customer follow-up
|
|
24645
|
+
action. Currently, this is supported for Ebanx when using Pix Automatico.
|
|
24646
|
+
properties:
|
|
24647
|
+
type:
|
|
24648
|
+
type: string
|
|
24649
|
+
title: Next action type
|
|
24650
|
+
description: The type of next action required.
|
|
24651
|
+
"$ref": "#/components/schemas/NextActionTypeEnum"
|
|
24652
|
+
value:
|
|
24653
|
+
type: string
|
|
24654
|
+
title: Next action value
|
|
24655
|
+
description: The value associated with the next action type.
|
|
24656
|
+
title: Next action
|
|
24424
24657
|
TransactionFraudInfo:
|
|
24425
24658
|
type: object
|
|
24426
24659
|
title: Fraud information
|
|
@@ -26830,9 +27063,11 @@ components:
|
|
|
26830
27063
|
- credit_card
|
|
26831
27064
|
- eft
|
|
26832
27065
|
- google_pay
|
|
27066
|
+
- mercadopago
|
|
26833
27067
|
- money_order
|
|
26834
27068
|
- other
|
|
26835
27069
|
- paypal
|
|
27070
|
+
- pix_automatico
|
|
26836
27071
|
- roku
|
|
26837
27072
|
- sepadirectdebit
|
|
26838
27073
|
- wire_transfer
|
|
@@ -26970,6 +27205,11 @@ components:
|
|
|
26970
27205
|
- scheduled
|
|
26971
27206
|
- success
|
|
26972
27207
|
- void
|
|
27208
|
+
NextActionTypeEnum:
|
|
27209
|
+
type: string
|
|
27210
|
+
description: The type of next action required for the transaction.
|
|
27211
|
+
enum:
|
|
27212
|
+
- qr_code
|
|
26973
27213
|
CvvCheckEnum:
|
|
26974
27214
|
type: string
|
|
26975
27215
|
enum:
|
|
@@ -27046,6 +27286,9 @@ components:
|
|
|
27046
27286
|
- boleto
|
|
27047
27287
|
- cash_app
|
|
27048
27288
|
- upi_autopay
|
|
27289
|
+
- pix_automatico
|
|
27290
|
+
- mercadopago
|
|
27291
|
+
- klarna
|
|
27049
27292
|
CardTypeEnum:
|
|
27050
27293
|
type: string
|
|
27051
27294
|
enum:
|
|
@@ -27371,10 +27614,12 @@ components:
|
|
|
27371
27614
|
AchTypeEnum:
|
|
27372
27615
|
type: string
|
|
27373
27616
|
description: The payment method type for a non-credit card based billing info.
|
|
27374
|
-
`bacs`
|
|
27617
|
+
`bacs`, `becs`, `pix-automatico`, `mercadopago` are the only accepted values.
|
|
27375
27618
|
enum:
|
|
27376
27619
|
- bacs
|
|
27377
27620
|
- becs
|
|
27621
|
+
- pix-automatico
|
|
27622
|
+
- mercadopago
|
|
27378
27623
|
AchAccountTypeEnum:
|
|
27379
27624
|
type: string
|
|
27380
27625
|
description: The bank account type. (ACH only)
|
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.69.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Recurly
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2025-
|
|
11
|
+
date: 2025-11-03 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: base64
|
|
@@ -167,6 +167,7 @@ files:
|
|
|
167
167
|
- lib/recurly/requests/account_acquisition_update.rb
|
|
168
168
|
- lib/recurly/requests/account_create.rb
|
|
169
169
|
- lib/recurly/requests/account_external_subscription.rb
|
|
170
|
+
- lib/recurly/requests/account_note_create.rb
|
|
170
171
|
- lib/recurly/requests/account_purchase.rb
|
|
171
172
|
- lib/recurly/requests/account_reference.rb
|
|
172
173
|
- lib/recurly/requests/account_update.rb
|
|
@@ -244,6 +245,7 @@ files:
|
|
|
244
245
|
- lib/recurly/requests/subscription_change_create.rb
|
|
245
246
|
- lib/recurly/requests/subscription_change_shipping_create.rb
|
|
246
247
|
- lib/recurly/requests/subscription_create.rb
|
|
248
|
+
- lib/recurly/requests/subscription_create_proration_settings.rb
|
|
247
249
|
- lib/recurly/requests/subscription_pause.rb
|
|
248
250
|
- lib/recurly/requests/subscription_purchase.rb
|
|
249
251
|
- lib/recurly/requests/subscription_ramp_interval.rb
|
|
@@ -354,6 +356,7 @@ files:
|
|
|
354
356
|
- lib/recurly/resources/transaction.rb
|
|
355
357
|
- lib/recurly/resources/transaction_error.rb
|
|
356
358
|
- lib/recurly/resources/transaction_fraud_info.rb
|
|
359
|
+
- lib/recurly/resources/transaction_next_action.rb
|
|
357
360
|
- lib/recurly/resources/transaction_payment_gateway.rb
|
|
358
361
|
- lib/recurly/resources/unique_coupon_code.rb
|
|
359
362
|
- lib/recurly/resources/unique_coupon_code_params.rb
|
|
@@ -384,7 +387,7 @@ metadata:
|
|
|
384
387
|
changelog_uri: https://github.com/recurly/recurly-client-ruby/blob/master/CHANGELOG.md
|
|
385
388
|
documentation_uri: https://recurly.github.io/recurly-client-ruby/
|
|
386
389
|
homepage_uri: https://github.com/recurly/recurly-client-ruby
|
|
387
|
-
source_code_uri: https://github.com/recurly/recurly-client-ruby/tree/4.
|
|
390
|
+
source_code_uri: https://github.com/recurly/recurly-client-ruby/tree/4.69.0
|
|
388
391
|
post_install_message:
|
|
389
392
|
rdoc_options: []
|
|
390
393
|
require_paths:
|