recurly 4.1.0 → 4.5.0
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/workflows/docs.yml +1 -1
- data/CHANGELOG.md +45 -0
- data/GETTING_STARTED.md +1 -1
- data/lib/recurly/client.rb +5 -3
- data/lib/recurly/client/operations.rb +49 -152
- data/lib/recurly/requests/address.rb +1 -1
- data/lib/recurly/requests/billing_info_create.rb +4 -4
- data/lib/recurly/requests/billing_info_verify.rb +14 -0
- data/lib/recurly/requests/invoice_address.rb +1 -1
- data/lib/recurly/requests/shipping_address_create.rb +1 -1
- data/lib/recurly/requests/shipping_address_update.rb +1 -1
- data/lib/recurly/requests/subscription_add_on_tier.rb +6 -2
- data/lib/recurly/requests/subscription_create.rb +1 -1
- data/lib/recurly/requests/subscription_purchase.rb +1 -1
- data/lib/recurly/resources/address.rb +1 -1
- data/lib/recurly/resources/address_with_name.rb +1 -1
- data/lib/recurly/resources/billing_info.rb +2 -2
- data/lib/recurly/resources/billing_info_updated_by.rb +1 -1
- data/lib/recurly/resources/invoice.rb +1 -1
- data/lib/recurly/resources/invoice_address.rb +1 -1
- data/lib/recurly/resources/payment_method.rb +4 -0
- data/lib/recurly/resources/shipping_address.rb +1 -1
- data/lib/recurly/resources/subscription_add_on_tier.rb +6 -2
- data/lib/recurly/resources/subscription_change.rb +4 -0
- data/lib/recurly/resources/subscription_change_billing_info.rb +14 -0
- data/lib/recurly/resources/tax_detail.rb +26 -0
- data/lib/recurly/resources/tax_info.rb +4 -0
- data/lib/recurly/resources/transaction.rb +1 -1
- data/lib/recurly/version.rb +1 -1
- data/openapi/api.yaml +273 -186
- metadata +6 -3
@@ -15,7 +15,7 @@ module Recurly
|
|
15
15
|
define_attribute :amazon_billing_agreement_id, String
|
16
16
|
|
17
17
|
# @!attribute backup_payment_method
|
18
|
-
# @return [Boolean] The `backup_payment_method`
|
18
|
+
# @return [Boolean] The `backup_payment_method` field is used to designate a billing info as a backup on the account that will be tried if the initial billing info used for an invoice is declined. All payment methods, including the billing info marked `primary_payment_method` can be set as a backup. An account can have a maximum of 1 backup, if a user sets a different payment method as a backup, the existing backup will no longer be marked as such.
|
19
19
|
define_attribute :backup_payment_method, :Boolean
|
20
20
|
|
21
21
|
# @!attribute company
|
@@ -67,15 +67,15 @@ module Recurly
|
|
67
67
|
define_attribute :paypal_billing_agreement_id, String
|
68
68
|
|
69
69
|
# @!attribute primary_payment_method
|
70
|
-
# @return [Boolean] The `primary_payment_method`
|
70
|
+
# @return [Boolean] The `primary_payment_method` field is used to designate the primary billing info on the account. The first billing info created on an account will always become primary. Adding additional billing infos provides the flexibility to mark another billing info as primary, or adding additional non-primary billing infos. This can be accomplished by passing the `primary_payment_method` with a value of `true`. When adding billing infos via the billing_info and /accounts endpoints, this value is not permitted, and will return an error if provided.
|
71
71
|
define_attribute :primary_payment_method, :Boolean
|
72
72
|
|
73
73
|
# @!attribute tax_identifier
|
74
|
-
# @return [String] Tax identifier is required if adding a billing info that is a consumer card in Brazil. This would be the customer's CPF
|
74
|
+
# @return [String] Tax identifier is required if adding a billing info that is a consumer card in Brazil or in Argentina. This would be the customer's CPF (Brazil) and CUIT (Argentina). CPF and CUIT are tax identifiers for all residents who pay taxes in Brazil and Argentina respectively.
|
75
75
|
define_attribute :tax_identifier, String
|
76
76
|
|
77
77
|
# @!attribute tax_identifier_type
|
78
|
-
# @return [String]
|
78
|
+
# @return [String] This field and a value of `cpf` or `cuit` are required if adding a billing info that is an elo or hipercard type in Brazil or in Argentina.
|
79
79
|
define_attribute :tax_identifier_type, String
|
80
80
|
|
81
81
|
# @!attribute three_d_secure_action_result_token_id
|
@@ -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 BillingInfoVerify < Request
|
8
|
+
|
9
|
+
# @!attribute gateway_code
|
10
|
+
# @return [String] An identifier for a specific payment gateway.
|
11
|
+
define_attribute :gateway_code, String
|
12
|
+
end
|
13
|
+
end
|
14
|
+
end
|
@@ -15,7 +15,7 @@ module Recurly
|
|
15
15
|
define_attribute :company, String
|
16
16
|
|
17
17
|
# @!attribute country
|
18
|
-
# @return [String] Country, 2-letter ISO code.
|
18
|
+
# @return [String] Country, 2-letter ISO 3166-1 alpha-2 code.
|
19
19
|
define_attribute :country, String
|
20
20
|
|
21
21
|
# @!attribute first_name
|
@@ -11,12 +11,16 @@ module Recurly
|
|
11
11
|
define_attribute :ending_quantity, Integer
|
12
12
|
|
13
13
|
# @!attribute unit_amount
|
14
|
-
# @return [Float] Allows up to 2 decimal places. Optionally, override the tiers' default unit amount.
|
14
|
+
# @return [Float] Allows up to 2 decimal places. Optionally, override the tiers' default unit amount. If add-on's `add_on_type` is `usage` and `usage_type` is `percentage`, cannot be provided.
|
15
15
|
define_attribute :unit_amount, Float
|
16
16
|
|
17
17
|
# @!attribute unit_amount_decimal
|
18
|
-
# @return [String] Allows up to 9 decimal places. Optionally, override tiers' default unit amount. If `unit_amount_decimal` is provided, `unit_amount` cannot be provided.
|
18
|
+
# @return [String] Allows up to 9 decimal places. Optionally, override tiers' default unit amount. If `unit_amount_decimal` is provided, `unit_amount` cannot be provided. If add-on's `add_on_type` is `usage` and `usage_type` is `percentage`, cannot be provided.
|
19
19
|
define_attribute :unit_amount_decimal, String
|
20
|
+
|
21
|
+
# @!attribute usage_percentage
|
22
|
+
# @return [String] The percentage taken of the monetary amount of usage tracked. This can be up to 4 decimal places represented as a string. A value between 0.0 and 100.0. Optionally, override tiers' default usage percentage. Required if add-on's `add_on_type` is `usage` and `usage_type` is `percentage`. Must be omitted otherwise.
|
23
|
+
define_attribute :usage_percentage, String
|
20
24
|
end
|
21
25
|
end
|
22
26
|
end
|
@@ -99,7 +99,7 @@ module Recurly
|
|
99
99
|
define_attribute :transaction_type, String
|
100
100
|
|
101
101
|
# @!attribute trial_ends_at
|
102
|
-
# @return [DateTime] If set, overrides the default trial behavior for the subscription.
|
102
|
+
# @return [DateTime] If set, overrides the default trial behavior for the subscription. When the current date time or a past date time is provided the subscription will begin with no trial phase (overriding any plan default trial). When a future date time is provided the subscription will begin with a trial phase ending at the specified date time.
|
103
103
|
define_attribute :trial_ends_at, DateTime
|
104
104
|
|
105
105
|
# @!attribute unit_amount
|
@@ -55,7 +55,7 @@ module Recurly
|
|
55
55
|
define_attribute :total_billing_cycles, Integer
|
56
56
|
|
57
57
|
# @!attribute trial_ends_at
|
58
|
-
# @return [DateTime] If set, overrides the default trial behavior for the subscription.
|
58
|
+
# @return [DateTime] If set, overrides the default trial behavior for the subscription. When the current date time or a past date time is provided the subscription will begin with no trial phase (overriding any plan default trial). When a future date time is provided the subscription will begin with a trial phase ending at the specified date time.
|
59
59
|
define_attribute :trial_ends_at, DateTime
|
60
60
|
|
61
61
|
# @!attribute unit_amount
|
@@ -15,7 +15,7 @@ module Recurly
|
|
15
15
|
define_attribute :address, :Address
|
16
16
|
|
17
17
|
# @!attribute backup_payment_method
|
18
|
-
# @return [Boolean] The `backup_payment_method`
|
18
|
+
# @return [Boolean] The `backup_payment_method` field is used to indicate a billing info as a backup on the account that will be tried if the initial billing info used for an invoice is declined.
|
19
19
|
define_attribute :backup_payment_method, :Boolean
|
20
20
|
|
21
21
|
# @!attribute company
|
@@ -51,7 +51,7 @@ module Recurly
|
|
51
51
|
define_attribute :payment_method, :PaymentMethod
|
52
52
|
|
53
53
|
# @!attribute primary_payment_method
|
54
|
-
# @return [Boolean] The `primary_payment_method`
|
54
|
+
# @return [Boolean] The `primary_payment_method` field is used to indicate the primary billing info on the account. The first billing info created on an account will always become primary. This payment method will be used
|
55
55
|
define_attribute :primary_payment_method, :Boolean
|
56
56
|
|
57
57
|
# @!attribute updated_at
|
@@ -7,7 +7,7 @@ module Recurly
|
|
7
7
|
class BillingInfoUpdatedBy < Resource
|
8
8
|
|
9
9
|
# @!attribute country
|
10
|
-
# @return [String] Country
|
10
|
+
# @return [String] Country, 2-letter ISO 3166-1 alpha-2 code matching the origin IP address, if known by Recurly.
|
11
11
|
define_attribute :country, String
|
12
12
|
|
13
13
|
# @!attribute ip
|
@@ -111,7 +111,7 @@ module Recurly
|
|
111
111
|
define_attribute :subscription_ids, Array, { :item_type => String }
|
112
112
|
|
113
113
|
# @!attribute subtotal
|
114
|
-
# @return [Float] The summation of charges
|
114
|
+
# @return [Float] The summation of charges and credits, before discounts and taxes.
|
115
115
|
define_attribute :subtotal, Float
|
116
116
|
|
117
117
|
# @!attribute tax
|
@@ -15,7 +15,7 @@ module Recurly
|
|
15
15
|
define_attribute :company, String
|
16
16
|
|
17
17
|
# @!attribute country
|
18
|
-
# @return [String] Country, 2-letter ISO code.
|
18
|
+
# @return [String] Country, 2-letter ISO 3166-1 alpha-2 code.
|
19
19
|
define_attribute :country, String
|
20
20
|
|
21
21
|
# @!attribute first_name
|
@@ -18,6 +18,10 @@ module Recurly
|
|
18
18
|
# @return [String] Visa, MasterCard, American Express, Discover, JCB, etc.
|
19
19
|
define_attribute :card_type, String
|
20
20
|
|
21
|
+
# @!attribute cc_bin_country
|
22
|
+
# @return [String] The 2-letter ISO 3166-1 alpha-2 country code associated with the credit card BIN, if known by Recurly. Available on the BillingInfo object only. Available when the BIN country lookup feature is enabled.
|
23
|
+
define_attribute :cc_bin_country, String
|
24
|
+
|
21
25
|
# @!attribute exp_month
|
22
26
|
# @return [Integer] Expiration month.
|
23
27
|
define_attribute :exp_month, Integer
|
@@ -19,7 +19,7 @@ module Recurly
|
|
19
19
|
define_attribute :company, String
|
20
20
|
|
21
21
|
# @!attribute country
|
22
|
-
# @return [String] Country, 2-letter ISO code.
|
22
|
+
# @return [String] Country, 2-letter ISO 3166-1 alpha-2 code.
|
23
23
|
define_attribute :country, String
|
24
24
|
|
25
25
|
# @!attribute created_at
|
@@ -11,12 +11,16 @@ module Recurly
|
|
11
11
|
define_attribute :ending_quantity, Integer
|
12
12
|
|
13
13
|
# @!attribute unit_amount
|
14
|
-
# @return [Float] Allows up to 2 decimal places. Optionally, override the tiers' default unit amount.
|
14
|
+
# @return [Float] Allows up to 2 decimal places. Optionally, override the tiers' default unit amount. If add-on's `add_on_type` is `usage` and `usage_type` is `percentage`, cannot be provided.
|
15
15
|
define_attribute :unit_amount, Float
|
16
16
|
|
17
17
|
# @!attribute unit_amount_decimal
|
18
|
-
# @return [String] Allows up to 9 decimal places. Optionally, override tiers' default unit amount. If `unit_amount_decimal` is provided, `unit_amount` cannot be provided.
|
18
|
+
# @return [String] Allows up to 9 decimal places. Optionally, override tiers' default unit amount. If `unit_amount_decimal` is provided, `unit_amount` cannot be provided. If add-on's `add_on_type` is `usage` and `usage_type` is `percentage`, cannot be provided.
|
19
19
|
define_attribute :unit_amount_decimal, String
|
20
|
+
|
21
|
+
# @!attribute usage_percentage
|
22
|
+
# @return [String] The percentage taken of the monetary amount of usage tracked. This can be up to 4 decimal places represented as a string. A value between 0.0 and 100.0. Optionally, override tiers' default usage percentage. Required if add-on's `add_on_type` is `usage` and `usage_type` is `percentage`. Must be omitted otherwise.
|
23
|
+
define_attribute :usage_percentage, String
|
20
24
|
end
|
21
25
|
end
|
22
26
|
end
|
@@ -18,6 +18,10 @@ module Recurly
|
|
18
18
|
# @return [Array[SubscriptionAddOn]] These add-ons will be used when the subscription renews.
|
19
19
|
define_attribute :add_ons, Array, { :item_type => :SubscriptionAddOn }
|
20
20
|
|
21
|
+
# @!attribute billing_info
|
22
|
+
# @return [SubscriptionChangeBillingInfo] Accept nested attributes for three_d_secure_action_result_token_id
|
23
|
+
define_attribute :billing_info, :SubscriptionChangeBillingInfo
|
24
|
+
|
21
25
|
# @!attribute created_at
|
22
26
|
# @return [DateTime] Created at
|
23
27
|
define_attribute :created_at, DateTime
|
@@ -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 Resources
|
7
|
+
class SubscriptionChangeBillingInfo < Resource
|
8
|
+
|
9
|
+
# @!attribute three_d_secure_action_result_token_id
|
10
|
+
# @return [String] A token generated by Recurly.js after completing a 3-D Secure device fingerprinting or authentication challenge.
|
11
|
+
define_attribute :three_d_secure_action_result_token_id, String
|
12
|
+
end
|
13
|
+
end
|
14
|
+
end
|
@@ -0,0 +1,26 @@
|
|
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 TaxDetail < Resource
|
8
|
+
|
9
|
+
# @!attribute rate
|
10
|
+
# @return [Float] Provides the tax rate for the region.
|
11
|
+
define_attribute :rate, Float
|
12
|
+
|
13
|
+
# @!attribute region
|
14
|
+
# @return [String] Provides the tax region applied on an invoice. For Canadian Sales Tax, this will be either the 2 letter province code or country code.
|
15
|
+
define_attribute :region, String
|
16
|
+
|
17
|
+
# @!attribute tax
|
18
|
+
# @return [Float] The total tax applied for this tax type.
|
19
|
+
define_attribute :tax, Float
|
20
|
+
|
21
|
+
# @!attribute type
|
22
|
+
# @return [String] Provides the tax type for the region. For Canadian Sales Tax, this will be GST, HST, QST or PST.
|
23
|
+
define_attribute :type, String
|
24
|
+
end
|
25
|
+
end
|
26
|
+
end
|
@@ -14,6 +14,10 @@ module Recurly
|
|
14
14
|
# @return [String] Provides the tax region applied on an invoice. For U.S. Sales Tax, this will be the 2 letter state code. For EU VAT this will be the 2 letter country code. For all country level tax types, this will display the regional tax, like VAT, GST, or PST.
|
15
15
|
define_attribute :region, String
|
16
16
|
|
17
|
+
# @!attribute tax_details
|
18
|
+
# @return [Array[TaxDetail]] Provides additional tax details for Canadian Sales Tax when there is tax applied at both the country and province levels. This will only be populated for the Invoice response when fetching a single invoice and not for the InvoiceList or LineItem.
|
19
|
+
define_attribute :tax_details, Array, { :item_type => :TaxDetail }
|
20
|
+
|
17
21
|
# @!attribute type
|
18
22
|
# @return [String] Provides the tax type as "vat" for EU VAT, "usst" for U.S. Sales Tax, or the 2 letter country code for country level tax types like Canada, Australia, New Zealand, Israel, and all non-EU European countries.
|
19
23
|
define_attribute :type, String
|
@@ -87,7 +87,7 @@ module Recurly
|
|
87
87
|
define_attribute :invoice, :InvoiceMini
|
88
88
|
|
89
89
|
# @!attribute ip_address_country
|
90
|
-
# @return [String] IP address
|
90
|
+
# @return [String] Origin IP address country, 2-letter ISO 3166-1 alpha-2 code, if known by Recurly.
|
91
91
|
define_attribute :ip_address_country, String
|
92
92
|
|
93
93
|
# @!attribute ip_address_v4
|
data/lib/recurly/version.rb
CHANGED
data/openapi/api.yaml
CHANGED
@@ -111,9 +111,11 @@ info:
|
|
111
111
|
developers and those who are familiar with API technology. When using the
|
112
112
|
API and passing error messages to target systems, be mindful that
|
113
113
|
these messages may not make sense in the context of the target system.
|
114
|
-
Please consider changing these messages in target system to be better
|
114
|
+
Please consider changing these messages in the target system to be better
|
115
115
|
suited to the audience of the system.
|
116
116
|
|
117
|
+
Please see [transaction error codes](https://developers.recurly.com/pages/api-transaction-errors.html) for more details.
|
118
|
+
|
117
119
|
## Pagination
|
118
120
|
### Response Schema
|
119
121
|
Every GET listing endpoint returns a response with the same schema:
|
@@ -190,6 +192,7 @@ x-tagGroups:
|
|
190
192
|
- note
|
191
193
|
- account_acquisition
|
192
194
|
- billing_info
|
195
|
+
- billing_infos
|
193
196
|
- subscription
|
194
197
|
- subscription_change
|
195
198
|
- shipping_address
|
@@ -260,9 +263,15 @@ tags:
|
|
260
263
|
to match this data with revenue and billing data events in Recurly.
|
261
264
|
- name: billing_info
|
262
265
|
x-displayName: Billing Info
|
263
|
-
description:
|
264
|
-
a credit
|
265
|
-
the customer upon purchase or when they update their
|
266
|
+
description: Without the premium Wallet feature, an account can only have one stored
|
267
|
+
payment method at a time. Examples include credit cards, PayPal, or bank accounts.
|
268
|
+
Billing info is filled out by the customer upon purchase or when they update their
|
269
|
+
information.
|
270
|
+
- name: billing_infos
|
271
|
+
x-displayName: Billing Infos
|
272
|
+
description: If the premium Wallet feature is enabled, an account can have multiple
|
273
|
+
payment methods stored. Examples include credit cards, PayPal, or bank accounts.
|
274
|
+
Primary or backup billing infos can be designated from these endpoints.
|
266
275
|
- name: subscription
|
267
276
|
x-displayName: Subscription
|
268
277
|
description: Subscriptions are created when your customers subscribe to one of your
|
@@ -547,7 +556,6 @@ paths:
|
|
547
556
|
description: See the [Pagination Guide](/guides/pagination.html) to learn how
|
548
557
|
to use pagination in the API and Client Libraries.
|
549
558
|
parameters:
|
550
|
-
- "$ref": "#/components/parameters/site_id"
|
551
559
|
- "$ref": "#/components/parameters/ids"
|
552
560
|
- "$ref": "#/components/parameters/limit"
|
553
561
|
- "$ref": "#/components/parameters/order"
|
@@ -650,8 +658,6 @@ paths:
|
|
650
658
|
- account
|
651
659
|
operationId: create_account
|
652
660
|
summary: Create an account
|
653
|
-
parameters:
|
654
|
-
- "$ref": "#/components/parameters/site_id"
|
655
661
|
requestBody:
|
656
662
|
content:
|
657
663
|
application/json:
|
@@ -899,7 +905,6 @@ paths:
|
|
899
905
|
%s\", account.Id)"
|
900
906
|
"/accounts/{account_id}":
|
901
907
|
parameters:
|
902
|
-
- "$ref": "#/components/parameters/site_id"
|
903
908
|
- "$ref": "#/components/parameters/account_id"
|
904
909
|
get:
|
905
910
|
tags:
|
@@ -1288,7 +1293,6 @@ paths:
|
|
1288
1293
|
Account: %s\", account.Id)"
|
1289
1294
|
"/accounts/{account_id}/acquisition":
|
1290
1295
|
parameters:
|
1291
|
-
- "$ref": "#/components/parameters/site_id"
|
1292
1296
|
- "$ref": "#/components/parameters/account_id"
|
1293
1297
|
get:
|
1294
1298
|
tags:
|
@@ -1668,7 +1672,6 @@ paths:
|
|
1668
1672
|
Acquisition: %s\", accountAcquisition.Id)"
|
1669
1673
|
"/accounts/{account_id}/reactivate":
|
1670
1674
|
parameters:
|
1671
|
-
- "$ref": "#/components/parameters/site_id"
|
1672
1675
|
- "$ref": "#/components/parameters/account_id"
|
1673
1676
|
put:
|
1674
1677
|
tags:
|
@@ -1792,7 +1795,6 @@ paths:
|
|
1792
1795
|
Account: %s\", account.Id)"
|
1793
1796
|
"/accounts/{account_id}/balance":
|
1794
1797
|
parameters:
|
1795
|
-
- "$ref": "#/components/parameters/site_id"
|
1796
1798
|
- "$ref": "#/components/parameters/account_id"
|
1797
1799
|
get:
|
1798
1800
|
tags:
|
@@ -1914,7 +1916,6 @@ paths:
|
|
1914
1916
|
operationId: get_billing_info
|
1915
1917
|
summary: Fetch an account's billing information
|
1916
1918
|
parameters:
|
1917
|
-
- "$ref": "#/components/parameters/site_id"
|
1918
1919
|
- "$ref": "#/components/parameters/account_id"
|
1919
1920
|
responses:
|
1920
1921
|
'200':
|
@@ -2050,7 +2051,6 @@ paths:
|
|
2050
2051
|
- gateway_token
|
2051
2052
|
- gateway_code
|
2052
2053
|
parameters:
|
2053
|
-
- "$ref": "#/components/parameters/site_id"
|
2054
2054
|
- "$ref": "#/components/parameters/account_id"
|
2055
2055
|
requestBody:
|
2056
2056
|
content:
|
@@ -2205,7 +2205,6 @@ paths:
|
|
2205
2205
|
operationId: remove_billing_info
|
2206
2206
|
summary: Remove an account's billing information
|
2207
2207
|
parameters:
|
2208
|
-
- "$ref": "#/components/parameters/site_id"
|
2209
2208
|
- "$ref": "#/components/parameters/account_id"
|
2210
2209
|
description: You may remove any stored billing information for an account. If
|
2211
2210
|
the account has a subscription, the renewal will go into dunning unless the
|
@@ -2307,16 +2306,146 @@ paths:
|
|
2307
2306
|
{\n\t\tfmt.Printf(\"Resource not found: %v\", e)\n\t\treturn nil, err\n\t}\n\tfmt.Printf(\"Unexpected
|
2308
2307
|
Recurly error: %v\", e)\n\treturn nil, err\n}\n\nfmt.Printf(\"Removed Billing
|
2309
2308
|
Info: %v\", billingInfo)"
|
2309
|
+
"/accounts/{account_id}/billing_info/verify":
|
2310
|
+
post:
|
2311
|
+
tags:
|
2312
|
+
- billing_info
|
2313
|
+
operationId: verify_billing_info
|
2314
|
+
summary: Verify an account's credit card billing information
|
2315
|
+
parameters:
|
2316
|
+
- "$ref": "#/components/parameters/account_id"
|
2317
|
+
requestBody:
|
2318
|
+
content:
|
2319
|
+
application/json:
|
2320
|
+
schema:
|
2321
|
+
"$ref": "#/components/schemas/BillingInfoVerify"
|
2322
|
+
required: false
|
2323
|
+
responses:
|
2324
|
+
'200':
|
2325
|
+
description: Transaction information from verify.
|
2326
|
+
content:
|
2327
|
+
application/json:
|
2328
|
+
schema:
|
2329
|
+
"$ref": "#/components/schemas/Transaction"
|
2330
|
+
'404':
|
2331
|
+
description: Account has no billing information, or incorrect site or account
|
2332
|
+
ID.
|
2333
|
+
content:
|
2334
|
+
application/json:
|
2335
|
+
schema:
|
2336
|
+
"$ref": "#/components/schemas/Error"
|
2337
|
+
default:
|
2338
|
+
description: Unexpected error.
|
2339
|
+
content:
|
2340
|
+
application/json:
|
2341
|
+
schema:
|
2342
|
+
"$ref": "#/components/schemas/Error"
|
2343
|
+
'422':
|
2344
|
+
description: Invalid billing information, or error running the verification
|
2345
|
+
transaction.
|
2346
|
+
content:
|
2347
|
+
application/json:
|
2348
|
+
schema:
|
2349
|
+
"$ref": "#/components/schemas/ErrorMayHaveTransaction"
|
2350
|
+
x-code-samples:
|
2351
|
+
- lang: Node.js
|
2352
|
+
source: |
|
2353
|
+
try {
|
2354
|
+
const transaction = await client.verifyBillingInfo(accountId)
|
2355
|
+
console.log('Fetched Transaction: ', transaction.id)
|
2356
|
+
} catch (err) {
|
2357
|
+
if (err instanceof recurly.errors.NotFoundError) {
|
2358
|
+
// If the request was not found, you may want to alert the user or
|
2359
|
+
// just return null
|
2360
|
+
console.log('Resource Not Found')
|
2361
|
+
} else {
|
2362
|
+
// If we don't know what to do with the err, we should
|
2363
|
+
// probably re-raise and let our web framework and logger handle it
|
2364
|
+
console.log('Unknown Error: ', err)
|
2365
|
+
}
|
2366
|
+
}
|
2367
|
+
- lang: Python
|
2368
|
+
source: |
|
2369
|
+
try:
|
2370
|
+
transaction = client.verify_billing_info(account_id)
|
2371
|
+
print("Got Transaction %s" % transaction)
|
2372
|
+
except recurly.errors.NotFoundError:
|
2373
|
+
# If the resource was not found, you may want to alert the user or
|
2374
|
+
# just return nil
|
2375
|
+
print("Resource Not Found")
|
2376
|
+
- lang: ".NET"
|
2377
|
+
source: |
|
2378
|
+
try
|
2379
|
+
{
|
2380
|
+
Transaction transaction = client.VerifyBillingInfo(accountId);
|
2381
|
+
Console.WriteLine($"Fetched transaction {transaction.Id}");
|
2382
|
+
}
|
2383
|
+
catch (Recurly.Errors.NotFound ex)
|
2384
|
+
{
|
2385
|
+
// If the resource was not found
|
2386
|
+
// we may want to alert the user or just return null
|
2387
|
+
Console.WriteLine($"Resource Not Found: {ex.Error.Message}");
|
2388
|
+
}
|
2389
|
+
catch (Recurly.Errors.ApiError ex)
|
2390
|
+
{
|
2391
|
+
// Use ApiError to catch a generic error from the API
|
2392
|
+
Console.WriteLine($"Unexpected Recurly Error: {ex.Error.Message}");
|
2393
|
+
}
|
2394
|
+
- lang: Ruby
|
2395
|
+
source: |
|
2396
|
+
begin
|
2397
|
+
transaction = @client.verify_billing_info(account_id: account_id)
|
2398
|
+
puts "Got Transaction #{transaction}"
|
2399
|
+
rescue Recurly::Errors::NotFoundError
|
2400
|
+
# If the resource was not found, you may want to alert the user or
|
2401
|
+
# just return nil
|
2402
|
+
puts "Resource Not Found"
|
2403
|
+
end
|
2404
|
+
- lang: Java
|
2405
|
+
source: |
|
2406
|
+
try {
|
2407
|
+
final Transaction transaction = client.verifyBillingInfo(accountId);
|
2408
|
+
System.out.println("Fetched transaction " + transaction.getId());
|
2409
|
+
} catch (NotFoundException e) {
|
2410
|
+
// If the resource was not found
|
2411
|
+
// we may want to alert the user or just return null
|
2412
|
+
System.out.println("Resource Not Found: " + e.getError().getMessage());
|
2413
|
+
} catch (ApiException e) {
|
2414
|
+
// Use ApiException to catch a generic error from the API
|
2415
|
+
System.out.println("Unexpected Recurly Error: " + e.getError().getMessage());
|
2416
|
+
}
|
2417
|
+
- lang: PHP
|
2418
|
+
source: |
|
2419
|
+
try {
|
2420
|
+
$transaction = $client->verifyBillingInfo($account_id);
|
2421
|
+
|
2422
|
+
echo 'Got Transaction:' . PHP_EOL;
|
2423
|
+
var_dump($transaction);
|
2424
|
+
} catch (\Recurly\Errors\NotFound $e) {
|
2425
|
+
// Could not find the resource, you may want to inform the user
|
2426
|
+
// or just return a NULL
|
2427
|
+
echo 'Could not find resource.' . PHP_EOL;
|
2428
|
+
var_dump($e);
|
2429
|
+
} catch (\Recurly\RecurlyError $e) {
|
2430
|
+
// Something bad happened... tell the user so that they can fix it?
|
2431
|
+
echo 'Some unexpected Recurly error happened. Try again later.' . PHP_EOL;
|
2432
|
+
}
|
2433
|
+
- lang: Go
|
2434
|
+
source: "verifyBillingInfoParams := &recurly.VerifyBillingInfoParams{}\ntransaction,
|
2435
|
+
err := client.VerifyBillingInfo(accountID, verifyBillingInfoParams)\nif
|
2436
|
+
e, ok := err.(*recurly.Error); ok {\n\tif e.Type == recurly.ErrorTypeNotFound
|
2437
|
+
{\n\t\tfmt.Printf(\"Resource not found: %v\", e)\n\t\treturn nil, err\n\t}\n\tfmt.Printf(\"Unexpected
|
2438
|
+
Recurly error: %v\", e)\n\treturn nil, err\n}\n\nfmt.Printf(\"Fetched Transaction:
|
2439
|
+
%v\", transaction)"
|
2310
2440
|
"/accounts/{account_id}/billing_infos":
|
2311
2441
|
get:
|
2312
2442
|
tags:
|
2313
|
-
-
|
2443
|
+
- billing_infos
|
2314
2444
|
operationId: list_billing_infos
|
2315
2445
|
summary: Get the list of billing information associated with an account
|
2316
2446
|
description: See the [Pagination Guide](/guides/pagination.html) to learn how
|
2317
2447
|
to use pagination in the API and Client Libraries.
|
2318
2448
|
parameters:
|
2319
|
-
- "$ref": "#/components/parameters/site_id"
|
2320
2449
|
- "$ref": "#/components/parameters/account_id"
|
2321
2450
|
- "$ref": "#/components/parameters/ids"
|
2322
2451
|
- "$ref": "#/components/parameters/sort_dates"
|
@@ -2344,9 +2473,9 @@ paths:
|
|
2344
2473
|
x-code-samples: []
|
2345
2474
|
post:
|
2346
2475
|
tags:
|
2347
|
-
-
|
2476
|
+
- billing_infos
|
2348
2477
|
operationId: create_billing_info
|
2349
|
-
summary:
|
2478
|
+
summary: Add new billing information on an account
|
2350
2479
|
description: |
|
2351
2480
|
If you're using Recurly.js to securely submit data from webforms without sending it through your server,
|
2352
2481
|
you can associate the billing information with an account by passing in the `token_id`. The only other
|
@@ -2367,7 +2496,6 @@ paths:
|
|
2367
2496
|
- gateway_token
|
2368
2497
|
- gateway_code
|
2369
2498
|
parameters:
|
2370
|
-
- "$ref": "#/components/parameters/site_id"
|
2371
2499
|
- "$ref": "#/components/parameters/account_id"
|
2372
2500
|
requestBody:
|
2373
2501
|
content:
|
@@ -2405,11 +2533,10 @@ paths:
|
|
2405
2533
|
"/accounts/{account_id}/billing_infos/{billing_info_id}":
|
2406
2534
|
get:
|
2407
2535
|
tags:
|
2408
|
-
-
|
2536
|
+
- billing_infos
|
2409
2537
|
operationId: get_a_billing_info
|
2410
2538
|
summary: Fetch a billing info
|
2411
2539
|
parameters:
|
2412
|
-
- "$ref": "#/components/parameters/site_id"
|
2413
2540
|
- "$ref": "#/components/parameters/account_id"
|
2414
2541
|
- "$ref": "#/components/parameters/billing_info_id"
|
2415
2542
|
responses:
|
@@ -2428,7 +2555,7 @@ paths:
|
|
2428
2555
|
x-code-samples: []
|
2429
2556
|
put:
|
2430
2557
|
tags:
|
2431
|
-
-
|
2558
|
+
- billing_infos
|
2432
2559
|
operationId: update_a_billing_info
|
2433
2560
|
summary: Update an account's billing information
|
2434
2561
|
description: |
|
@@ -2451,7 +2578,6 @@ paths:
|
|
2451
2578
|
- gateway_token
|
2452
2579
|
- gateway_code
|
2453
2580
|
parameters:
|
2454
|
-
- "$ref": "#/components/parameters/site_id"
|
2455
2581
|
- "$ref": "#/components/parameters/account_id"
|
2456
2582
|
- "$ref": "#/components/parameters/billing_info_id"
|
2457
2583
|
requestBody:
|
@@ -2489,11 +2615,10 @@ paths:
|
|
2489
2615
|
x-code-samples: []
|
2490
2616
|
delete:
|
2491
2617
|
tags:
|
2492
|
-
-
|
2618
|
+
- billing_infos
|
2493
2619
|
operationId: remove_a_billing_info
|
2494
2620
|
summary: Remove an account's billing information
|
2495
2621
|
parameters:
|
2496
|
-
- "$ref": "#/components/parameters/site_id"
|
2497
2622
|
- "$ref": "#/components/parameters/account_id"
|
2498
2623
|
- "$ref": "#/components/parameters/billing_info_id"
|
2499
2624
|
description: You may remove any stored billing information for an account. If
|
@@ -2526,7 +2651,6 @@ paths:
|
|
2526
2651
|
description: See the [Pagination Guide](/guides/pagination.html) to learn how
|
2527
2652
|
to use pagination in the API and Client Libraries.
|
2528
2653
|
parameters:
|
2529
|
-
- "$ref": "#/components/parameters/site_id"
|
2530
2654
|
- "$ref": "#/components/parameters/account_id"
|
2531
2655
|
- "$ref": "#/components/parameters/ids"
|
2532
2656
|
- "$ref": "#/components/parameters/sort_dates"
|
@@ -2624,7 +2748,6 @@ paths:
|
|
2624
2748
|
description: See the [Pagination Guide](/guides/pagination.html) to learn how
|
2625
2749
|
to use pagination in the API and Client Libraries.
|
2626
2750
|
parameters:
|
2627
|
-
- "$ref": "#/components/parameters/site_id"
|
2628
2751
|
- "$ref": "#/components/parameters/account_id"
|
2629
2752
|
responses:
|
2630
2753
|
'200':
|
@@ -2707,7 +2830,6 @@ paths:
|
|
2707
2830
|
operationId: create_coupon_redemption
|
2708
2831
|
summary: Generate an active coupon redemption on an account or subscription
|
2709
2832
|
parameters:
|
2710
|
-
- "$ref": "#/components/parameters/site_id"
|
2711
2833
|
- "$ref": "#/components/parameters/account_id"
|
2712
2834
|
requestBody:
|
2713
2835
|
content:
|
@@ -2838,7 +2960,6 @@ paths:
|
|
2838
2960
|
operationId: remove_coupon_redemption
|
2839
2961
|
summary: Delete the active coupon redemption from an account
|
2840
2962
|
parameters:
|
2841
|
-
- "$ref": "#/components/parameters/site_id"
|
2842
2963
|
- "$ref": "#/components/parameters/account_id"
|
2843
2964
|
responses:
|
2844
2965
|
'200':
|
@@ -2955,7 +3076,6 @@ paths:
|
|
2955
3076
|
description: See the [Pagination Guide](/guides/pagination.html) to learn how
|
2956
3077
|
to use pagination in the API and Client Libraries.
|
2957
3078
|
parameters:
|
2958
|
-
- "$ref": "#/components/parameters/site_id"
|
2959
3079
|
- "$ref": "#/components/parameters/account_id"
|
2960
3080
|
- "$ref": "#/components/parameters/limit"
|
2961
3081
|
- "$ref": "#/components/parameters/order"
|
@@ -3063,7 +3183,6 @@ paths:
|
|
3063
3183
|
description: See the [Pagination Guide](/guides/pagination.html) to learn how
|
3064
3184
|
to use pagination in the API and Client Libraries.
|
3065
3185
|
parameters:
|
3066
|
-
- "$ref": "#/components/parameters/site_id"
|
3067
3186
|
- "$ref": "#/components/parameters/account_id"
|
3068
3187
|
- "$ref": "#/components/parameters/ids"
|
3069
3188
|
- "$ref": "#/components/parameters/limit"
|
@@ -3165,7 +3284,6 @@ paths:
|
|
3165
3284
|
operationId: create_invoice
|
3166
3285
|
summary: Create an invoice for pending line items
|
3167
3286
|
parameters:
|
3168
|
-
- "$ref": "#/components/parameters/site_id"
|
3169
3287
|
- "$ref": "#/components/parameters/account_id"
|
3170
3288
|
requestBody:
|
3171
3289
|
content:
|
@@ -3336,7 +3454,6 @@ paths:
|
|
3336
3454
|
operationId: preview_invoice
|
3337
3455
|
summary: Preview new invoice for pending line items
|
3338
3456
|
parameters:
|
3339
|
-
- "$ref": "#/components/parameters/site_id"
|
3340
3457
|
- "$ref": "#/components/parameters/account_id"
|
3341
3458
|
requestBody:
|
3342
3459
|
content:
|
@@ -3508,7 +3625,6 @@ paths:
|
|
3508
3625
|
description: See the [Pagination Guide](/guides/pagination.html) to learn how
|
3509
3626
|
to use pagination in the API and Client Libraries.
|
3510
3627
|
parameters:
|
3511
|
-
- "$ref": "#/components/parameters/site_id"
|
3512
3628
|
- "$ref": "#/components/parameters/account_id"
|
3513
3629
|
- "$ref": "#/components/parameters/ids"
|
3514
3630
|
- "$ref": "#/components/parameters/limit"
|
@@ -3613,7 +3729,6 @@ paths:
|
|
3613
3729
|
operationId: create_line_item
|
3614
3730
|
summary: Create a new line item for the account
|
3615
3731
|
parameters:
|
3616
|
-
- "$ref": "#/components/parameters/site_id"
|
3617
3732
|
- "$ref": "#/components/parameters/account_id"
|
3618
3733
|
requestBody:
|
3619
3734
|
content:
|
@@ -3731,7 +3846,7 @@ paths:
|
|
3731
3846
|
try {
|
3732
3847
|
LineItemCreate lineItemCreate = new LineItemCreate();
|
3733
3848
|
lineItemCreate.setCurrency("USD");
|
3734
|
-
lineItemCreate.setUnitAmount(1000.
|
3849
|
+
lineItemCreate.setUnitAmount(new BigDecimal("1000.0"));
|
3735
3850
|
lineItemCreate.setType(Constants.LineItemType.CHARGE); // choose "credit" for a credit
|
3736
3851
|
|
3737
3852
|
LineItem lineItem = client.createLineItem(accountId, lineItemCreate);
|
@@ -3784,7 +3899,6 @@ paths:
|
|
3784
3899
|
description: See the [Pagination Guide](/guides/pagination.html) to learn how
|
3785
3900
|
to use pagination in the API and Client Libraries.
|
3786
3901
|
parameters:
|
3787
|
-
- "$ref": "#/components/parameters/site_id"
|
3788
3902
|
- "$ref": "#/components/parameters/account_id"
|
3789
3903
|
- "$ref": "#/components/parameters/ids"
|
3790
3904
|
responses:
|
@@ -3871,7 +3985,6 @@ paths:
|
|
3871
3985
|
operationId: get_account_note
|
3872
3986
|
summary: Fetch an account note
|
3873
3987
|
parameters:
|
3874
|
-
- "$ref": "#/components/parameters/site_id"
|
3875
3988
|
- "$ref": "#/components/parameters/account_id"
|
3876
3989
|
- name: account_note_id
|
3877
3990
|
in: path
|
@@ -4000,7 +4113,6 @@ paths:
|
|
4000
4113
|
description: See the [Pagination Guide](/guides/pagination.html) to learn how
|
4001
4114
|
to use pagination in the API and Client Libraries.
|
4002
4115
|
parameters:
|
4003
|
-
- "$ref": "#/components/parameters/site_id"
|
4004
4116
|
- "$ref": "#/components/parameters/account_id"
|
4005
4117
|
- "$ref": "#/components/parameters/ids"
|
4006
4118
|
- "$ref": "#/components/parameters/limit"
|
@@ -4095,7 +4207,6 @@ paths:
|
|
4095
4207
|
operationId: create_shipping_address
|
4096
4208
|
summary: Create a new shipping address for the account
|
4097
4209
|
parameters:
|
4098
|
-
- "$ref": "#/components/parameters/site_id"
|
4099
4210
|
- "$ref": "#/components/parameters/account_id"
|
4100
4211
|
requestBody:
|
4101
4212
|
content:
|
@@ -4285,7 +4396,6 @@ paths:
|
|
4285
4396
|
operationId: get_shipping_address
|
4286
4397
|
summary: Fetch an account's shipping address
|
4287
4398
|
parameters:
|
4288
|
-
- "$ref": "#/components/parameters/site_id"
|
4289
4399
|
- "$ref": "#/components/parameters/account_id"
|
4290
4400
|
- "$ref": "#/components/parameters/shipping_address_id"
|
4291
4401
|
responses:
|
@@ -4405,7 +4515,6 @@ paths:
|
|
4405
4515
|
operationId: update_shipping_address
|
4406
4516
|
summary: Update an account's shipping address
|
4407
4517
|
parameters:
|
4408
|
-
- "$ref": "#/components/parameters/site_id"
|
4409
4518
|
- "$ref": "#/components/parameters/account_id"
|
4410
4519
|
- "$ref": "#/components/parameters/shipping_address_id"
|
4411
4520
|
requestBody:
|
@@ -4576,7 +4685,6 @@ paths:
|
|
4576
4685
|
operationId: remove_shipping_address
|
4577
4686
|
summary: Remove an account's shipping address
|
4578
4687
|
parameters:
|
4579
|
-
- "$ref": "#/components/parameters/site_id"
|
4580
4688
|
- "$ref": "#/components/parameters/account_id"
|
4581
4689
|
- "$ref": "#/components/parameters/shipping_address_id"
|
4582
4690
|
responses:
|
@@ -4687,7 +4795,6 @@ paths:
|
|
4687
4795
|
description: See the [Pagination Guide](/guides/pagination.html) to learn how
|
4688
4796
|
to use pagination in the API and Client Libraries.
|
4689
4797
|
parameters:
|
4690
|
-
- "$ref": "#/components/parameters/site_id"
|
4691
4798
|
- "$ref": "#/components/parameters/account_id"
|
4692
4799
|
- "$ref": "#/components/parameters/ids"
|
4693
4800
|
- "$ref": "#/components/parameters/limit"
|
@@ -4792,7 +4899,6 @@ paths:
|
|
4792
4899
|
description: See the [Pagination Guide](/guides/pagination.html) to learn how
|
4793
4900
|
to use pagination in the API and Client Libraries.
|
4794
4901
|
parameters:
|
4795
|
-
- "$ref": "#/components/parameters/site_id"
|
4796
4902
|
- "$ref": "#/components/parameters/account_id"
|
4797
4903
|
- "$ref": "#/components/parameters/ids"
|
4798
4904
|
- "$ref": "#/components/parameters/limit"
|
@@ -4899,7 +5005,6 @@ paths:
|
|
4899
5005
|
description: See the [Pagination Guide](/guides/pagination.html) to learn how
|
4900
5006
|
to use pagination in the API and Client Libraries.
|
4901
5007
|
parameters:
|
4902
|
-
- "$ref": "#/components/parameters/site_id"
|
4903
5008
|
- "$ref": "#/components/parameters/account_id"
|
4904
5009
|
- "$ref": "#/components/parameters/ids"
|
4905
5010
|
- "$ref": "#/components/parameters/limit"
|
@@ -4983,7 +5088,6 @@ paths:
|
|
4983
5088
|
description: See the [Pagination Guide](/guides/pagination.html) to learn how
|
4984
5089
|
to use pagination in the API and Client Libraries.
|
4985
5090
|
parameters:
|
4986
|
-
- "$ref": "#/components/parameters/site_id"
|
4987
5091
|
- "$ref": "#/components/parameters/ids"
|
4988
5092
|
- "$ref": "#/components/parameters/limit"
|
4989
5093
|
- "$ref": "#/components/parameters/order"
|
@@ -5083,7 +5187,6 @@ paths:
|
|
5083
5187
|
description: See the [Pagination Guide](/guides/pagination.html) to learn how
|
5084
5188
|
to use pagination in the API and Client Libraries.
|
5085
5189
|
parameters:
|
5086
|
-
- "$ref": "#/components/parameters/site_id"
|
5087
5190
|
- "$ref": "#/components/parameters/ids"
|
5088
5191
|
- "$ref": "#/components/parameters/limit"
|
5089
5192
|
- "$ref": "#/components/parameters/order"
|
@@ -5183,8 +5286,6 @@ paths:
|
|
5183
5286
|
- coupon
|
5184
5287
|
operationId: create_coupon
|
5185
5288
|
summary: Create a new coupon
|
5186
|
-
parameters:
|
5187
|
-
- "$ref": "#/components/parameters/site_id"
|
5188
5289
|
requestBody:
|
5189
5290
|
content:
|
5190
5291
|
application/json:
|
@@ -5325,7 +5426,7 @@ paths:
|
|
5325
5426
|
List<CouponPricing> currencies = new ArrayList<CouponPricing>();
|
5326
5427
|
CouponPricing couponPrice = new CouponPricing();
|
5327
5428
|
couponPrice.setCurrency("USD");
|
5328
|
-
couponPrice.setDiscount(10.
|
5429
|
+
couponPrice.setDiscount(new BigDecimal("10.0"));
|
5329
5430
|
currencies.add(couponPrice);
|
5330
5431
|
|
5331
5432
|
couponCreate.setCurrencies(currencies);
|
@@ -5384,7 +5485,6 @@ paths:
|
|
5384
5485
|
operationId: get_coupon
|
5385
5486
|
summary: Fetch a coupon
|
5386
5487
|
parameters:
|
5387
|
-
- "$ref": "#/components/parameters/site_id"
|
5388
5488
|
- "$ref": "#/components/parameters/coupon_id"
|
5389
5489
|
responses:
|
5390
5490
|
'200':
|
@@ -5500,7 +5600,6 @@ paths:
|
|
5500
5600
|
operationId: update_coupon
|
5501
5601
|
summary: Update an active coupon
|
5502
5602
|
parameters:
|
5503
|
-
- "$ref": "#/components/parameters/site_id"
|
5504
5603
|
- "$ref": "#/components/parameters/coupon_id"
|
5505
5604
|
requestBody:
|
5506
5605
|
content:
|
@@ -5654,7 +5753,6 @@ paths:
|
|
5654
5753
|
operationId: deactivate_coupon
|
5655
5754
|
summary: Expire a coupon
|
5656
5755
|
parameters:
|
5657
|
-
- "$ref": "#/components/parameters/site_id"
|
5658
5756
|
- "$ref": "#/components/parameters/coupon_id"
|
5659
5757
|
description: Mark an existing Coupon as expired
|
5660
5758
|
responses:
|
@@ -5760,7 +5858,6 @@ paths:
|
|
5760
5858
|
operationId: generate_unique_coupon_codes
|
5761
5859
|
summary: Generate unique coupon codes
|
5762
5860
|
parameters:
|
5763
|
-
- "$ref": "#/components/parameters/site_id"
|
5764
5861
|
- "$ref": "#/components/parameters/coupon_id"
|
5765
5862
|
requestBody:
|
5766
5863
|
content:
|
@@ -5806,7 +5903,6 @@ paths:
|
|
5806
5903
|
description: Make an expired coupon redeemable again. You can change editable
|
5807
5904
|
fields in this call.
|
5808
5905
|
parameters:
|
5809
|
-
- "$ref": "#/components/parameters/site_id"
|
5810
5906
|
- "$ref": "#/components/parameters/coupon_id"
|
5811
5907
|
requestBody:
|
5812
5908
|
content:
|
@@ -5855,7 +5951,6 @@ paths:
|
|
5855
5951
|
description: See the [Pagination Guide](/guides/pagination.html) to learn how
|
5856
5952
|
to use pagination in the API and Client Libraries.
|
5857
5953
|
parameters:
|
5858
|
-
- "$ref": "#/components/parameters/site_id"
|
5859
5954
|
- "$ref": "#/components/parameters/coupon_id"
|
5860
5955
|
- "$ref": "#/components/parameters/ids"
|
5861
5956
|
- "$ref": "#/components/parameters/limit"
|
@@ -5892,7 +5987,6 @@ paths:
|
|
5892
5987
|
description: See the [Pagination Guide](/guides/pagination.html) to learn how
|
5893
5988
|
to use pagination in the API and Client Libraries.
|
5894
5989
|
parameters:
|
5895
|
-
- "$ref": "#/components/parameters/site_id"
|
5896
5990
|
- "$ref": "#/components/parameters/limit"
|
5897
5991
|
- "$ref": "#/components/parameters/order"
|
5898
5992
|
- "$ref": "#/components/parameters/sort_dates"
|
@@ -5993,7 +6087,6 @@ paths:
|
|
5993
6087
|
operationId: get_credit_payment
|
5994
6088
|
summary: Fetch a credit payment
|
5995
6089
|
parameters:
|
5996
|
-
- "$ref": "#/components/parameters/site_id"
|
5997
6090
|
- "$ref": "#/components/parameters/credit_payment_id"
|
5998
6091
|
responses:
|
5999
6092
|
'200':
|
@@ -6024,7 +6117,6 @@ paths:
|
|
6024
6117
|
description: See the [Pagination Guide](/guides/pagination.html) to learn how
|
6025
6118
|
to use pagination in the API and Client Libraries.
|
6026
6119
|
parameters:
|
6027
|
-
- "$ref": "#/components/parameters/site_id"
|
6028
6120
|
- "$ref": "#/components/parameters/ids"
|
6029
6121
|
- "$ref": "#/components/parameters/limit"
|
6030
6122
|
- "$ref": "#/components/parameters/order"
|
@@ -6132,7 +6224,6 @@ paths:
|
|
6132
6224
|
operationId: get_custom_field_definition
|
6133
6225
|
summary: Fetch an custom field definition
|
6134
6226
|
parameters:
|
6135
|
-
- "$ref": "#/components/parameters/site_id"
|
6136
6227
|
- "$ref": "#/components/parameters/custom_field_definition_id"
|
6137
6228
|
responses:
|
6138
6229
|
'200':
|
@@ -6251,7 +6342,6 @@ paths:
|
|
6251
6342
|
description: See the [Pagination Guide](/guides/pagination.html) to learn how
|
6252
6343
|
to use pagination in the API and Client Libraries.
|
6253
6344
|
parameters:
|
6254
|
-
- "$ref": "#/components/parameters/site_id"
|
6255
6345
|
- "$ref": "#/components/parameters/ids"
|
6256
6346
|
- "$ref": "#/components/parameters/limit"
|
6257
6347
|
- "$ref": "#/components/parameters/order"
|
@@ -6352,8 +6442,6 @@ paths:
|
|
6352
6442
|
- item
|
6353
6443
|
operationId: create_item
|
6354
6444
|
summary: Create a new item
|
6355
|
-
parameters:
|
6356
|
-
- "$ref": "#/components/parameters/site_id"
|
6357
6445
|
requestBody:
|
6358
6446
|
content:
|
6359
6447
|
application/json:
|
@@ -6566,7 +6654,6 @@ paths:
|
|
6566
6654
|
operationId: get_item
|
6567
6655
|
summary: Fetch an item
|
6568
6656
|
parameters:
|
6569
|
-
- "$ref": "#/components/parameters/site_id"
|
6570
6657
|
- "$ref": "#/components/parameters/item_id"
|
6571
6658
|
responses:
|
6572
6659
|
'200':
|
@@ -6682,7 +6769,6 @@ paths:
|
|
6682
6769
|
operationId: update_item
|
6683
6770
|
summary: Update an active item
|
6684
6771
|
parameters:
|
6685
|
-
- "$ref": "#/components/parameters/site_id"
|
6686
6772
|
- "$ref": "#/components/parameters/item_id"
|
6687
6773
|
requestBody:
|
6688
6774
|
content:
|
@@ -6849,7 +6935,6 @@ paths:
|
|
6849
6935
|
operationId: deactivate_item
|
6850
6936
|
summary: Deactivate an item
|
6851
6937
|
parameters:
|
6852
|
-
- "$ref": "#/components/parameters/site_id"
|
6853
6938
|
- "$ref": "#/components/parameters/item_id"
|
6854
6939
|
description: Deactivating an item makes it unavailable for new purchases. It
|
6855
6940
|
will not affect existing line items.
|
@@ -6962,7 +7047,6 @@ paths:
|
|
6962
7047
|
%s\", deactivatedItem.Code)"
|
6963
7048
|
"/items/{item_id}/reactivate":
|
6964
7049
|
parameters:
|
6965
|
-
- "$ref": "#/components/parameters/site_id"
|
6966
7050
|
- "$ref": "#/components/parameters/item_id"
|
6967
7051
|
put:
|
6968
7052
|
tags:
|
@@ -7093,7 +7177,6 @@ paths:
|
|
7093
7177
|
description: See the [Pagination Guide](/guides/pagination.html) to learn how
|
7094
7178
|
to use pagination in the API and Client Libraries.
|
7095
7179
|
parameters:
|
7096
|
-
- "$ref": "#/components/parameters/site_id"
|
7097
7180
|
- "$ref": "#/components/parameters/ids"
|
7098
7181
|
- "$ref": "#/components/parameters/limit"
|
7099
7182
|
- "$ref": "#/components/parameters/order"
|
@@ -7126,8 +7209,6 @@ paths:
|
|
7126
7209
|
- measured_unit
|
7127
7210
|
operationId: create_measured_unit
|
7128
7211
|
summary: Create a new measured unit
|
7129
|
-
parameters:
|
7130
|
-
- "$ref": "#/components/parameters/site_id"
|
7131
7212
|
requestBody:
|
7132
7213
|
content:
|
7133
7214
|
application/json:
|
@@ -7173,7 +7254,6 @@ paths:
|
|
7173
7254
|
operationId: get_measured_unit
|
7174
7255
|
summary: Fetch a measured unit
|
7175
7256
|
parameters:
|
7176
|
-
- "$ref": "#/components/parameters/site_id"
|
7177
7257
|
- "$ref": "#/components/parameters/measured_unit_id"
|
7178
7258
|
responses:
|
7179
7259
|
'200':
|
@@ -7201,7 +7281,6 @@ paths:
|
|
7201
7281
|
operationId: update_measured_unit
|
7202
7282
|
summary: Update a measured unit
|
7203
7283
|
parameters:
|
7204
|
-
- "$ref": "#/components/parameters/site_id"
|
7205
7284
|
- "$ref": "#/components/parameters/measured_unit_id"
|
7206
7285
|
requestBody:
|
7207
7286
|
content:
|
@@ -7248,7 +7327,6 @@ paths:
|
|
7248
7327
|
summary: Remove a measured unit
|
7249
7328
|
description: A mesured unit cannot be deleted if it is used by an active plan.
|
7250
7329
|
parameters:
|
7251
|
-
- "$ref": "#/components/parameters/site_id"
|
7252
7330
|
- "$ref": "#/components/parameters/measured_unit_id"
|
7253
7331
|
responses:
|
7254
7332
|
'200':
|
@@ -7279,7 +7357,6 @@ paths:
|
|
7279
7357
|
description: See the [Pagination Guide](/guides/pagination.html) to learn how
|
7280
7358
|
to use pagination in the API and Client Libraries.
|
7281
7359
|
parameters:
|
7282
|
-
- "$ref": "#/components/parameters/site_id"
|
7283
7360
|
- "$ref": "#/components/parameters/ids"
|
7284
7361
|
- "$ref": "#/components/parameters/limit"
|
7285
7362
|
- "$ref": "#/components/parameters/order"
|
@@ -7382,7 +7459,6 @@ paths:
|
|
7382
7459
|
operationId: get_invoice
|
7383
7460
|
summary: Fetch an invoice
|
7384
7461
|
parameters:
|
7385
|
-
- "$ref": "#/components/parameters/site_id"
|
7386
7462
|
- "$ref": "#/components/parameters/invoice_id"
|
7387
7463
|
responses:
|
7388
7464
|
'200':
|
@@ -7498,7 +7574,6 @@ paths:
|
|
7498
7574
|
operationId: update_invoice
|
7499
7575
|
summary: Update an invoice
|
7500
7576
|
parameters:
|
7501
|
-
- "$ref": "#/components/parameters/site_id"
|
7502
7577
|
- "$ref": "#/components/parameters/invoice_id"
|
7503
7578
|
requestBody:
|
7504
7579
|
content:
|
@@ -7650,7 +7725,6 @@ paths:
|
|
7650
7725
|
operationId: get_invoice_pdf
|
7651
7726
|
summary: Fetch an invoice as a PDF
|
7652
7727
|
parameters:
|
7653
|
-
- "$ref": "#/components/parameters/site_id"
|
7654
7728
|
- "$ref": "#/components/parameters/invoice_id"
|
7655
7729
|
responses:
|
7656
7730
|
'200':
|
@@ -7790,7 +7864,6 @@ paths:
|
|
7790
7864
|
description: Force a collection attempt using the stored billing information.
|
7791
7865
|
This will trigger a transaction outside of Recurly's normal retry logic.
|
7792
7866
|
parameters:
|
7793
|
-
- "$ref": "#/components/parameters/site_id"
|
7794
7867
|
- "$ref": "#/components/parameters/invoice_id"
|
7795
7868
|
requestBody:
|
7796
7869
|
content:
|
@@ -7923,7 +7996,6 @@ paths:
|
|
7923
7996
|
|
7924
7997
|
Only invoices with the `pending`, `processing` or `past_due` states can be marked as failed.
|
7925
7998
|
parameters:
|
7926
|
-
- "$ref": "#/components/parameters/site_id"
|
7927
7999
|
- "$ref": "#/components/parameters/invoice_id"
|
7928
8000
|
responses:
|
7929
8001
|
'200':
|
@@ -8050,7 +8122,6 @@ paths:
|
|
8050
8122
|
|
8051
8123
|
Only invoices with the `pending`, `processing`, `past_due` or `failed` states can be marked as paid.
|
8052
8124
|
parameters:
|
8053
|
-
- "$ref": "#/components/parameters/site_id"
|
8054
8125
|
- "$ref": "#/components/parameters/invoice_id"
|
8055
8126
|
responses:
|
8056
8127
|
'200':
|
@@ -8176,7 +8247,6 @@ paths:
|
|
8176
8247
|
operationId: reopen_invoice
|
8177
8248
|
summary: Reopen a closed, manual invoice
|
8178
8249
|
parameters:
|
8179
|
-
- "$ref": "#/components/parameters/site_id"
|
8180
8250
|
- "$ref": "#/components/parameters/invoice_id"
|
8181
8251
|
responses:
|
8182
8252
|
'200':
|
@@ -8302,7 +8372,6 @@ paths:
|
|
8302
8372
|
description: Invoice must be a credit invoice (`type=credit`) and cannot be
|
8303
8373
|
closed (`state=closed`), processing (`state=processing`), or already voided.
|
8304
8374
|
parameters:
|
8305
|
-
- "$ref": "#/components/parameters/site_id"
|
8306
8375
|
- "$ref": "#/components/parameters/invoice_id"
|
8307
8376
|
responses:
|
8308
8377
|
'200':
|
@@ -8410,7 +8479,6 @@ paths:
|
|
8410
8479
|
not captured through your gateway. It will throw an error for an auto-collecting
|
8411
8480
|
invoice.
|
8412
8481
|
parameters:
|
8413
|
-
- "$ref": "#/components/parameters/site_id"
|
8414
8482
|
- "$ref": "#/components/parameters/invoice_id"
|
8415
8483
|
requestBody:
|
8416
8484
|
content:
|
@@ -8474,7 +8542,6 @@ paths:
|
|
8474
8542
|
description: See the [Pagination Guide](/guides/pagination.html) to learn how
|
8475
8543
|
to use pagination in the API and Client Libraries.
|
8476
8544
|
parameters:
|
8477
|
-
- "$ref": "#/components/parameters/site_id"
|
8478
8545
|
- "$ref": "#/components/parameters/invoice_id"
|
8479
8546
|
- "$ref": "#/components/parameters/ids"
|
8480
8547
|
- "$ref": "#/components/parameters/limit"
|
@@ -8585,7 +8652,6 @@ paths:
|
|
8585
8652
|
description: See the [Pagination Guide](/guides/pagination.html) to learn how
|
8586
8653
|
to use pagination in the API and Client Libraries.
|
8587
8654
|
parameters:
|
8588
|
-
- "$ref": "#/components/parameters/site_id"
|
8589
8655
|
- "$ref": "#/components/parameters/invoice_id"
|
8590
8656
|
- "$ref": "#/components/parameters/ids"
|
8591
8657
|
- "$ref": "#/components/parameters/sort_dates"
|
@@ -8685,7 +8751,6 @@ paths:
|
|
8685
8751
|
|
8686
8752
|
See the [Pagination Guide](/guides/pagination.html) to learn how to use pagination in the API and Client Libraries.
|
8687
8753
|
parameters:
|
8688
|
-
- "$ref": "#/components/parameters/site_id"
|
8689
8754
|
- "$ref": "#/components/parameters/invoice_id"
|
8690
8755
|
responses:
|
8691
8756
|
'200':
|
@@ -8779,7 +8844,6 @@ paths:
|
|
8779
8844
|
If you want to refund the entire refundable amount on the invoice, the
|
8780
8845
|
simplest way is to do `type=amount` without specifiying an `amount`.
|
8781
8846
|
parameters:
|
8782
|
-
- "$ref": "#/components/parameters/site_id"
|
8783
8847
|
- "$ref": "#/components/parameters/invoice_id"
|
8784
8848
|
requestBody:
|
8785
8849
|
content:
|
@@ -8893,7 +8957,7 @@ paths:
|
|
8893
8957
|
final InvoiceRefund invoiceRefund = new InvoiceRefund();
|
8894
8958
|
invoiceRefund.setCreditCustomerNotes("Notes on credits");
|
8895
8959
|
invoiceRefund.setType(Constants.InvoiceRefundType.AMOUNT); // could also be "line_items"
|
8896
|
-
invoiceRefund.setAmount(
|
8960
|
+
invoiceRefund.setAmount(new BigDecimal("100"));
|
8897
8961
|
|
8898
8962
|
final Invoice invoice = client.refundInvoice(invoiceId, invoiceRefund);
|
8899
8963
|
System.out.println("Refunded invoice " + invoice.getNumber());
|
@@ -8942,7 +9006,6 @@ paths:
|
|
8942
9006
|
description: See the [Pagination Guide](/guides/pagination.html) to learn how
|
8943
9007
|
to use pagination in the API and Client Libraries.
|
8944
9008
|
parameters:
|
8945
|
-
- "$ref": "#/components/parameters/site_id"
|
8946
9009
|
- "$ref": "#/components/parameters/ids"
|
8947
9010
|
- "$ref": "#/components/parameters/limit"
|
8948
9011
|
- "$ref": "#/components/parameters/order"
|
@@ -9049,7 +9112,6 @@ paths:
|
|
9049
9112
|
operationId: get_line_item
|
9050
9113
|
summary: Fetch a line item
|
9051
9114
|
parameters:
|
9052
|
-
- "$ref": "#/components/parameters/site_id"
|
9053
9115
|
- "$ref": "#/components/parameters/line_item_id"
|
9054
9116
|
responses:
|
9055
9117
|
'200':
|
@@ -9165,7 +9227,6 @@ paths:
|
|
9165
9227
|
operationId: remove_line_item
|
9166
9228
|
summary: Delete an uninvoiced line item
|
9167
9229
|
parameters:
|
9168
|
-
- "$ref": "#/components/parameters/site_id"
|
9169
9230
|
- "$ref": "#/components/parameters/line_item_id"
|
9170
9231
|
responses:
|
9171
9232
|
'204':
|
@@ -9286,7 +9347,6 @@ paths:
|
|
9286
9347
|
description: See the [Pagination Guide](/guides/pagination.html) to learn how
|
9287
9348
|
to use pagination in the API and Client Libraries.
|
9288
9349
|
parameters:
|
9289
|
-
- "$ref": "#/components/parameters/site_id"
|
9290
9350
|
- "$ref": "#/components/parameters/ids"
|
9291
9351
|
- "$ref": "#/components/parameters/limit"
|
9292
9352
|
- "$ref": "#/components/parameters/order"
|
@@ -9387,8 +9447,6 @@ paths:
|
|
9387
9447
|
- plan
|
9388
9448
|
operationId: create_plan
|
9389
9449
|
summary: Create a plan
|
9390
|
-
parameters:
|
9391
|
-
- "$ref": "#/components/parameters/site_id"
|
9392
9450
|
requestBody:
|
9393
9451
|
content:
|
9394
9452
|
application/json:
|
@@ -9529,7 +9587,7 @@ paths:
|
|
9529
9587
|
List<PlanPricing> currencies = new ArrayList<PlanPricing>();
|
9530
9588
|
PlanPricing planPrice = new PlanPricing();
|
9531
9589
|
planPrice.setCurrency("USD");
|
9532
|
-
planPrice.setUnitAmount(10000
|
9590
|
+
planPrice.setUnitAmount(new BigDecimal("10000"));
|
9533
9591
|
currencies.add(planPrice);
|
9534
9592
|
|
9535
9593
|
planCreate.setCurrencies(currencies);
|
@@ -9587,7 +9645,6 @@ paths:
|
|
9587
9645
|
operationId: get_plan
|
9588
9646
|
summary: Fetch a plan
|
9589
9647
|
parameters:
|
9590
|
-
- "$ref": "#/components/parameters/site_id"
|
9591
9648
|
- "$ref": "#/components/parameters/plan_id"
|
9592
9649
|
responses:
|
9593
9650
|
'200':
|
@@ -9703,7 +9760,6 @@ paths:
|
|
9703
9760
|
operationId: update_plan
|
9704
9761
|
summary: Update a plan
|
9705
9762
|
parameters:
|
9706
|
-
- "$ref": "#/components/parameters/site_id"
|
9707
9763
|
- "$ref": "#/components/parameters/plan_id"
|
9708
9764
|
requestBody:
|
9709
9765
|
content:
|
@@ -9850,7 +9906,6 @@ paths:
|
|
9850
9906
|
operationId: remove_plan
|
9851
9907
|
summary: Remove a plan
|
9852
9908
|
parameters:
|
9853
|
-
- "$ref": "#/components/parameters/site_id"
|
9854
9909
|
- "$ref": "#/components/parameters/plan_id"
|
9855
9910
|
responses:
|
9856
9911
|
'200':
|
@@ -9961,7 +10016,6 @@ paths:
|
|
9961
10016
|
description: See the [Pagination Guide](/guides/pagination.html) to learn how
|
9962
10017
|
to use pagination in the API and Client Libraries.
|
9963
10018
|
parameters:
|
9964
|
-
- "$ref": "#/components/parameters/site_id"
|
9965
10019
|
- "$ref": "#/components/parameters/plan_id"
|
9966
10020
|
- "$ref": "#/components/parameters/ids"
|
9967
10021
|
- "$ref": "#/components/parameters/limit"
|
@@ -10063,7 +10117,6 @@ paths:
|
|
10063
10117
|
operationId: create_plan_add_on
|
10064
10118
|
summary: Create an add-on
|
10065
10119
|
parameters:
|
10066
|
-
- "$ref": "#/components/parameters/site_id"
|
10067
10120
|
- "$ref": "#/components/parameters/plan_id"
|
10068
10121
|
requestBody:
|
10069
10122
|
content:
|
@@ -10203,7 +10256,7 @@ paths:
|
|
10203
10256
|
List<AddOnPricing> currencies = new ArrayList<AddOnPricing>();
|
10204
10257
|
AddOnPricing addOnPrice = new AddOnPricing();
|
10205
10258
|
addOnPrice.setCurrency("USD");
|
10206
|
-
addOnPrice.setUnitAmount(10000.
|
10259
|
+
addOnPrice.setUnitAmount(new BigDecimal("10000.0"));
|
10207
10260
|
currencies.add(addOnPrice);
|
10208
10261
|
|
10209
10262
|
addOnCreate.setCurrencies(currencies);
|
@@ -10261,7 +10314,6 @@ paths:
|
|
10261
10314
|
operationId: get_plan_add_on
|
10262
10315
|
summary: Fetch a plan's add-on
|
10263
10316
|
parameters:
|
10264
|
-
- "$ref": "#/components/parameters/site_id"
|
10265
10317
|
- "$ref": "#/components/parameters/plan_id"
|
10266
10318
|
- "$ref": "#/components/parameters/add_on_id"
|
10267
10319
|
responses:
|
@@ -10380,7 +10432,6 @@ paths:
|
|
10380
10432
|
operationId: update_plan_add_on
|
10381
10433
|
summary: Update an add-on
|
10382
10434
|
parameters:
|
10383
|
-
- "$ref": "#/components/parameters/site_id"
|
10384
10435
|
- "$ref": "#/components/parameters/plan_id"
|
10385
10436
|
- "$ref": "#/components/parameters/add_on_id"
|
10386
10437
|
requestBody:
|
@@ -10523,7 +10574,6 @@ paths:
|
|
10523
10574
|
operationId: remove_plan_add_on
|
10524
10575
|
summary: Remove an add-on
|
10525
10576
|
parameters:
|
10526
|
-
- "$ref": "#/components/parameters/site_id"
|
10527
10577
|
- "$ref": "#/components/parameters/plan_id"
|
10528
10578
|
- "$ref": "#/components/parameters/add_on_id"
|
10529
10579
|
responses:
|
@@ -10632,7 +10682,6 @@ paths:
|
|
10632
10682
|
description: See the [Pagination Guide](/guides/pagination.html) to learn how
|
10633
10683
|
to use pagination in the API and Client Libraries.
|
10634
10684
|
parameters:
|
10635
|
-
- "$ref": "#/components/parameters/site_id"
|
10636
10685
|
- "$ref": "#/components/parameters/ids"
|
10637
10686
|
- "$ref": "#/components/parameters/limit"
|
10638
10687
|
- "$ref": "#/components/parameters/order"
|
@@ -10733,7 +10782,6 @@ paths:
|
|
10733
10782
|
operationId: get_add_on
|
10734
10783
|
summary: Fetch an add-on
|
10735
10784
|
parameters:
|
10736
|
-
- "$ref": "#/components/parameters/site_id"
|
10737
10785
|
- "$ref": "#/components/parameters/add_on_id"
|
10738
10786
|
responses:
|
10739
10787
|
'200':
|
@@ -10852,7 +10900,6 @@ paths:
|
|
10852
10900
|
description: See the [Pagination Guide](/guides/pagination.html) to learn how
|
10853
10901
|
to use pagination in the API and Client Libraries.
|
10854
10902
|
parameters:
|
10855
|
-
- "$ref": "#/components/parameters/site_id"
|
10856
10903
|
- "$ref": "#/components/parameters/ids"
|
10857
10904
|
- "$ref": "#/components/parameters/limit"
|
10858
10905
|
- "$ref": "#/components/parameters/order"
|
@@ -10950,8 +10997,6 @@ paths:
|
|
10950
10997
|
- shipping_method
|
10951
10998
|
operationId: create_shipping_method
|
10952
10999
|
summary: Create a new shipping method
|
10953
|
-
parameters:
|
10954
|
-
- "$ref": "#/components/parameters/site_id"
|
10955
11000
|
requestBody:
|
10956
11001
|
content:
|
10957
11002
|
application/json:
|
@@ -10997,7 +11042,6 @@ paths:
|
|
10997
11042
|
operationId: get_shipping_method
|
10998
11043
|
summary: Fetch a shipping method
|
10999
11044
|
parameters:
|
11000
|
-
- "$ref": "#/components/parameters/site_id"
|
11001
11045
|
- "$ref": "#/components/parameters/shipping_method_id"
|
11002
11046
|
responses:
|
11003
11047
|
'200':
|
@@ -11025,7 +11069,6 @@ paths:
|
|
11025
11069
|
operationId: update_shipping_method
|
11026
11070
|
summary: Update an active Shipping Method
|
11027
11071
|
parameters:
|
11028
|
-
- "$ref": "#/components/parameters/site_id"
|
11029
11072
|
- "$ref": "#/components/parameters/shipping_method_id"
|
11030
11073
|
requestBody:
|
11031
11074
|
content:
|
@@ -11071,7 +11114,6 @@ paths:
|
|
11071
11114
|
operationId: deactivate_shipping_method
|
11072
11115
|
summary: Deactivate a shipping method
|
11073
11116
|
parameters:
|
11074
|
-
- "$ref": "#/components/parameters/site_id"
|
11075
11117
|
- "$ref": "#/components/parameters/shipping_method_id"
|
11076
11118
|
description: Deactivating a shipping method makes it unavailable for new subscriptions
|
11077
11119
|
or purchases. It will not affect existing subscriptions.
|
@@ -11104,7 +11146,6 @@ paths:
|
|
11104
11146
|
description: See the [Pagination Guide](/guides/pagination.html) to learn how
|
11105
11147
|
to use pagination in the API and Client Libraries.
|
11106
11148
|
parameters:
|
11107
|
-
- "$ref": "#/components/parameters/site_id"
|
11108
11149
|
- "$ref": "#/components/parameters/ids"
|
11109
11150
|
- "$ref": "#/components/parameters/limit"
|
11110
11151
|
- "$ref": "#/components/parameters/order"
|
@@ -11205,8 +11246,6 @@ paths:
|
|
11205
11246
|
- subscription
|
11206
11247
|
operationId: create_subscription
|
11207
11248
|
summary: Create a new subscription
|
11208
|
-
parameters:
|
11209
|
-
- "$ref": "#/components/parameters/site_id"
|
11210
11249
|
requestBody:
|
11211
11250
|
content:
|
11212
11251
|
application/json:
|
@@ -11385,7 +11424,6 @@ paths:
|
|
11385
11424
|
operationId: get_subscription
|
11386
11425
|
summary: Fetch a subscription
|
11387
11426
|
parameters:
|
11388
|
-
- "$ref": "#/components/parameters/site_id"
|
11389
11427
|
- "$ref": "#/components/parameters/subscription_id"
|
11390
11428
|
responses:
|
11391
11429
|
'200':
|
@@ -11506,7 +11544,6 @@ paths:
|
|
11506
11544
|
impact on the billed amount. Use the [Create Subscription Change](#operation/create_subscription_change)
|
11507
11545
|
endpoint to make those changes.
|
11508
11546
|
parameters:
|
11509
|
-
- "$ref": "#/components/parameters/site_id"
|
11510
11547
|
- "$ref": "#/components/parameters/subscription_id"
|
11511
11548
|
requestBody:
|
11512
11549
|
content:
|
@@ -11655,7 +11692,6 @@ paths:
|
|
11655
11692
|
|
11656
11693
|
If the subscription has a paid invoice you may choose to refund all, part or none of last invoice's amount.
|
11657
11694
|
parameters:
|
11658
|
-
- "$ref": "#/components/parameters/site_id"
|
11659
11695
|
- "$ref": "#/components/parameters/subscription_id"
|
11660
11696
|
- name: refund
|
11661
11697
|
in: query
|
@@ -11818,7 +11854,6 @@ paths:
|
|
11818
11854
|
until the end of the billing cycle. When a future subscription (`state=future`)
|
11819
11855
|
is canceled it becomes failed `state=failed` and cannot be reactivated.
|
11820
11856
|
parameters:
|
11821
|
-
- "$ref": "#/components/parameters/site_id"
|
11822
11857
|
- "$ref": "#/components/parameters/subscription_id"
|
11823
11858
|
requestBody:
|
11824
11859
|
content:
|
@@ -11955,7 +11990,6 @@ paths:
|
|
11955
11990
|
|
11956
11991
|
Expired or failed subscriptions cannot be reactivated; instead a new subscription plan will need to be applied to the account.
|
11957
11992
|
parameters:
|
11958
|
-
- "$ref": "#/components/parameters/site_id"
|
11959
11993
|
- "$ref": "#/components/parameters/subscription_id"
|
11960
11994
|
responses:
|
11961
11995
|
'200':
|
@@ -12089,7 +12123,6 @@ paths:
|
|
12089
12123
|
|
12090
12124
|
Expired, cancelled, or failed subscriptions cannot be paused.
|
12091
12125
|
parameters:
|
12092
|
-
- "$ref": "#/components/parameters/site_id"
|
12093
12126
|
- "$ref": "#/components/parameters/subscription_id"
|
12094
12127
|
requestBody:
|
12095
12128
|
content:
|
@@ -12243,7 +12276,6 @@ paths:
|
|
12243
12276
|
The subscription must be in the paused state. Active, expired, cancelled,
|
12244
12277
|
or failed subscriptions cannot be resumed.
|
12245
12278
|
parameters:
|
12246
|
-
- "$ref": "#/components/parameters/site_id"
|
12247
12279
|
- "$ref": "#/components/parameters/subscription_id"
|
12248
12280
|
responses:
|
12249
12281
|
'200':
|
@@ -12374,7 +12406,6 @@ paths:
|
|
12374
12406
|
in trial. The subscription must be in a trial. Active, paused, expired, cancelled,
|
12375
12407
|
or failed subscriptions cannot be converted.
|
12376
12408
|
parameters:
|
12377
|
-
- "$ref": "#/components/parameters/site_id"
|
12378
12409
|
- "$ref": "#/components/parameters/subscription_id"
|
12379
12410
|
responses:
|
12380
12411
|
'200':
|
@@ -12410,7 +12441,6 @@ paths:
|
|
12410
12441
|
operationId: get_subscription_change
|
12411
12442
|
summary: Fetch a subscription's pending change
|
12412
12443
|
parameters:
|
12413
|
-
- "$ref": "#/components/parameters/site_id"
|
12414
12444
|
- "$ref": "#/components/parameters/subscription_id"
|
12415
12445
|
responses:
|
12416
12446
|
'200':
|
@@ -12542,7 +12572,6 @@ paths:
|
|
12542
12572
|
summary: Create a new subscription change
|
12543
12573
|
description: Calling this will overwrite an existing, pending subscription change.
|
12544
12574
|
parameters:
|
12545
|
-
- "$ref": "#/components/parameters/site_id"
|
12546
12575
|
- "$ref": "#/components/parameters/subscription_id"
|
12547
12576
|
requestBody:
|
12548
12577
|
content:
|
@@ -12700,7 +12729,6 @@ paths:
|
|
12700
12729
|
operationId: remove_subscription_change
|
12701
12730
|
summary: Delete the pending subscription change
|
12702
12731
|
parameters:
|
12703
|
-
- "$ref": "#/components/parameters/site_id"
|
12704
12732
|
- "$ref": "#/components/parameters/subscription_id"
|
12705
12733
|
description: Deleting the pending subscription change will cause the current
|
12706
12734
|
subscription settings to be used on the next renewal.
|
@@ -12817,7 +12845,6 @@ paths:
|
|
12817
12845
|
description: Calling this will not save the subscription change or overwrite
|
12818
12846
|
an existing change.
|
12819
12847
|
parameters:
|
12820
|
-
- "$ref": "#/components/parameters/site_id"
|
12821
12848
|
- "$ref": "#/components/parameters/subscription_id"
|
12822
12849
|
requestBody:
|
12823
12850
|
content:
|
@@ -12861,7 +12888,6 @@ paths:
|
|
12861
12888
|
description: See the [Pagination Guide](/guides/pagination.html) to learn how
|
12862
12889
|
to use pagination in the API and Client Libraries.
|
12863
12890
|
parameters:
|
12864
|
-
- "$ref": "#/components/parameters/site_id"
|
12865
12891
|
- "$ref": "#/components/parameters/subscription_id"
|
12866
12892
|
- "$ref": "#/components/parameters/ids"
|
12867
12893
|
- "$ref": "#/components/parameters/limit"
|
@@ -12966,7 +12992,6 @@ paths:
|
|
12966
12992
|
description: See the [Pagination Guide](/guides/pagination.html) to learn how
|
12967
12993
|
to use pagination in the API and Client Libraries.
|
12968
12994
|
parameters:
|
12969
|
-
- "$ref": "#/components/parameters/site_id"
|
12970
12995
|
- "$ref": "#/components/parameters/subscription_id"
|
12971
12996
|
- "$ref": "#/components/parameters/ids"
|
12972
12997
|
- "$ref": "#/components/parameters/limit"
|
@@ -13074,7 +13099,6 @@ paths:
|
|
13074
13099
|
description: See the [Pagination Guide](/guides/pagination.html) to learn how
|
13075
13100
|
to use pagination in the API and Client Libraries.
|
13076
13101
|
parameters:
|
13077
|
-
- "$ref": "#/components/parameters/site_id"
|
13078
13102
|
- "$ref": "#/components/parameters/subscription_id"
|
13079
13103
|
- "$ref": "#/components/parameters/ids"
|
13080
13104
|
- "$ref": "#/components/parameters/sort_dates"
|
@@ -13170,7 +13194,6 @@ paths:
|
|
13170
13194
|
operationId: list_usage
|
13171
13195
|
summary: List a subscription add-on's usage records
|
13172
13196
|
parameters:
|
13173
|
-
- "$ref": "#/components/parameters/site_id"
|
13174
13197
|
- "$ref": "#/components/parameters/subscription_id"
|
13175
13198
|
- "$ref": "#/components/parameters/add_on_id"
|
13176
13199
|
- "$ref": "#/components/parameters/ids"
|
@@ -13212,7 +13235,6 @@ paths:
|
|
13212
13235
|
operationId: create_usage
|
13213
13236
|
summary: Log a usage record on this subscription add-on
|
13214
13237
|
parameters:
|
13215
|
-
- "$ref": "#/components/parameters/site_id"
|
13216
13238
|
- "$ref": "#/components/parameters/subscription_id"
|
13217
13239
|
- "$ref": "#/components/parameters/add_on_id"
|
13218
13240
|
requestBody:
|
@@ -13260,7 +13282,6 @@ paths:
|
|
13260
13282
|
operationId: get_usage
|
13261
13283
|
summary: Get a usage record
|
13262
13284
|
parameters:
|
13263
|
-
- "$ref": "#/components/parameters/site_id"
|
13264
13285
|
- "$ref": "#/components/parameters/usage_id"
|
13265
13286
|
responses:
|
13266
13287
|
'200':
|
@@ -13294,7 +13315,6 @@ paths:
|
|
13294
13315
|
operationId: update_usage
|
13295
13316
|
summary: Update a usage record
|
13296
13317
|
parameters:
|
13297
|
-
- "$ref": "#/components/parameters/site_id"
|
13298
13318
|
- "$ref": "#/components/parameters/usage_id"
|
13299
13319
|
requestBody:
|
13300
13320
|
content:
|
@@ -13340,7 +13360,6 @@ paths:
|
|
13340
13360
|
operationId: remove_usage
|
13341
13361
|
summary: Delete a usage record.
|
13342
13362
|
parameters:
|
13343
|
-
- "$ref": "#/components/parameters/site_id"
|
13344
13363
|
- "$ref": "#/components/parameters/usage_id"
|
13345
13364
|
responses:
|
13346
13365
|
'204':
|
@@ -13379,7 +13398,6 @@ paths:
|
|
13379
13398
|
description: See the [Pagination Guide](/guides/pagination.html) to learn how
|
13380
13399
|
to use pagination in the API and Client Libraries.
|
13381
13400
|
parameters:
|
13382
|
-
- "$ref": "#/components/parameters/site_id"
|
13383
13401
|
- "$ref": "#/components/parameters/ids"
|
13384
13402
|
- "$ref": "#/components/parameters/limit"
|
13385
13403
|
- "$ref": "#/components/parameters/order"
|
@@ -13483,7 +13501,6 @@ paths:
|
|
13483
13501
|
operationId: get_transaction
|
13484
13502
|
summary: Fetch a transaction
|
13485
13503
|
parameters:
|
13486
|
-
- "$ref": "#/components/parameters/site_id"
|
13487
13504
|
- "$ref": "#/components/parameters/transaction_id"
|
13488
13505
|
responses:
|
13489
13506
|
'200':
|
@@ -13595,7 +13612,6 @@ paths:
|
|
13595
13612
|
%v\", transaction.Id)"
|
13596
13613
|
"/unique_coupon_codes/{unique_coupon_code_id}":
|
13597
13614
|
parameters:
|
13598
|
-
- "$ref": "#/components/parameters/site_id"
|
13599
13615
|
- "$ref": "#/components/parameters/unique_coupon_code_id"
|
13600
13616
|
get:
|
13601
13617
|
tags:
|
@@ -13657,7 +13673,6 @@ paths:
|
|
13657
13673
|
x-code-samples: []
|
13658
13674
|
"/unique_coupon_codes/{unique_coupon_code_id}/restore":
|
13659
13675
|
parameters:
|
13660
|
-
- "$ref": "#/components/parameters/site_id"
|
13661
13676
|
- "$ref": "#/components/parameters/unique_coupon_code_id"
|
13662
13677
|
put:
|
13663
13678
|
tags:
|
@@ -13699,8 +13714,6 @@ paths:
|
|
13699
13714
|
description: A purchase is a checkout containing at least one or more subscriptions
|
13700
13715
|
or one-time charges (line items) and supports both coupon and gift card redemptions.
|
13701
13716
|
All items purchased will be on one invoice and paid for with one transaction.
|
13702
|
-
parameters:
|
13703
|
-
- "$ref": "#/components/parameters/site_id"
|
13704
13717
|
requestBody:
|
13705
13718
|
content:
|
13706
13719
|
application/json:
|
@@ -13878,7 +13891,14 @@ paths:
|
|
13878
13891
|
// why. You can find the invalid params and reasons in e.getError().getParams()
|
13879
13892
|
System.out.println("Failed validation: " + e.getError().getMessage());
|
13880
13893
|
System.out.println("Params: " + e.getError().getParams());
|
13881
|
-
} catch (
|
13894
|
+
} catch (TransactionException e) {
|
13895
|
+
TransactionError tError = e.getError().getTransactionError();
|
13896
|
+
if (tError.getCategory() == Constants.ErrorCategory.THREE_D_SECURE_ACTION_REQUIRED) {
|
13897
|
+
String actionTokenId = tError.getThreeDSecureActionTokenId();
|
13898
|
+
System.out.println("Got 3DSecure TransactionError token: " + actionTokenId);
|
13899
|
+
}
|
13900
|
+
}
|
13901
|
+
catch (ApiException e) {
|
13882
13902
|
// Use ApiException to catch a generic error from the API
|
13883
13903
|
System.out.println("Unexpected Recurly Error: " + e.getError().getMessage());
|
13884
13904
|
}
|
@@ -13933,8 +13953,6 @@ paths:
|
|
13933
13953
|
description: A purchase is a checkout containing at least one or more subscriptions
|
13934
13954
|
or one-time charges (line items) and supports both coupon and gift card redemptions.
|
13935
13955
|
All items purchased will be on one invoice and paid for with one transaction.
|
13936
|
-
parameters:
|
13937
|
-
- "$ref": "#/components/parameters/site_id"
|
13938
13956
|
requestBody:
|
13939
13957
|
content:
|
13940
13958
|
application/json:
|
@@ -14156,8 +14174,6 @@ paths:
|
|
14156
14174
|
Recurly error: %v\", e)\n\treturn nil, err\n}\nfmt.Printf(\"Preview Charge
|
14157
14175
|
Invoice %v\", collection.ChargeInvoice)"
|
14158
14176
|
"/export_dates":
|
14159
|
-
parameters:
|
14160
|
-
- "$ref": "#/components/parameters/site_id"
|
14161
14177
|
get:
|
14162
14178
|
tags:
|
14163
14179
|
- automated_exports
|
@@ -14269,7 +14285,6 @@ paths:
|
|
14269
14285
|
for: \", date)\n}"
|
14270
14286
|
"/export_dates/{export_date}/export_files":
|
14271
14287
|
parameters:
|
14272
|
-
- "$ref": "#/components/parameters/site_id"
|
14273
14288
|
- "$ref": "#/components/parameters/export_date"
|
14274
14289
|
get:
|
14275
14290
|
tags:
|
@@ -15474,7 +15489,7 @@ components:
|
|
15474
15489
|
country:
|
15475
15490
|
type: string
|
15476
15491
|
title: Country
|
15477
|
-
description: Country, 2-letter ISO code.
|
15492
|
+
description: Country, 2-letter ISO 3166-1 alpha-2 code.
|
15478
15493
|
AddressWithName:
|
15479
15494
|
allOf:
|
15480
15495
|
- "$ref": "#/components/schemas/Address"
|
@@ -16029,19 +16044,14 @@ components:
|
|
16029
16044
|
title: Kount rules
|
16030
16045
|
primary_payment_method:
|
16031
16046
|
type: boolean
|
16032
|
-
description: The `primary_payment_method`
|
16033
|
-
|
16034
|
-
|
16035
|
-
provides the flexibility to mark another billing info as primary, or adding
|
16036
|
-
additional non-primary billing infos. This can be accomplished by passing
|
16037
|
-
the `primary_payment_method` indicator. When adding billing infos via
|
16038
|
-
the billing_info and /accounts endpoints, this value is not permitted,
|
16039
|
-
and will return an error if provided.
|
16047
|
+
description: The `primary_payment_method` field is used to indicate the
|
16048
|
+
primary billing info on the account. The first billing info created on
|
16049
|
+
an account will always become primary. This payment method will be used
|
16040
16050
|
backup_payment_method:
|
16041
16051
|
type: boolean
|
16042
|
-
description: The `backup_payment_method`
|
16043
|
-
|
16044
|
-
info
|
16052
|
+
description: The `backup_payment_method` field is used to indicate a billing
|
16053
|
+
info as a backup on the account that will be tried if the initial billing
|
16054
|
+
info used for an invoice is declined.
|
16045
16055
|
created_at:
|
16046
16056
|
type: string
|
16047
16057
|
format: date-time
|
@@ -16063,7 +16073,8 @@ components:
|
|
16063
16073
|
maxLength: 20
|
16064
16074
|
country:
|
16065
16075
|
type: string
|
16066
|
-
description: Country
|
16076
|
+
description: Country, 2-letter ISO 3166-1 alpha-2 code matching the
|
16077
|
+
origin IP address, if known by Recurly.
|
16067
16078
|
maxLength: 2
|
16068
16079
|
BillingInfoCreate:
|
16069
16080
|
type: object
|
@@ -16153,32 +16164,39 @@ components:
|
|
16153
16164
|
tax_identifier:
|
16154
16165
|
type: string
|
16155
16166
|
description: Tax identifier is required if adding a billing info that is
|
16156
|
-
a consumer card in Brazil. This would be the customer's
|
16157
|
-
|
16167
|
+
a consumer card in Brazil or in Argentina. This would be the customer's
|
16168
|
+
CPF (Brazil) and CUIT (Argentina). CPF and CUIT are tax identifiers for
|
16169
|
+
all residents who pay taxes in Brazil and Argentina respectively.
|
16158
16170
|
tax_identifier_type:
|
16159
|
-
description:
|
16160
|
-
info that is an elo or hipercard type in Brazil.
|
16171
|
+
description: This field and a value of `cpf` or `cuit` are required if adding
|
16172
|
+
a billing info that is an elo or hipercard type in Brazil or in Argentina.
|
16161
16173
|
"$ref": "#/components/schemas/TaxIdentifierTypeEnum"
|
16162
16174
|
primary_payment_method:
|
16163
16175
|
type: boolean
|
16164
16176
|
title: Primary Payment Method
|
16165
|
-
description: The `primary_payment_method`
|
16166
|
-
|
16167
|
-
|
16177
|
+
description: The `primary_payment_method` field is used to designate the
|
16178
|
+
primary billing info on the account. The first billing info created on
|
16179
|
+
an account will always become primary. Adding additional billing infos
|
16168
16180
|
provides the flexibility to mark another billing info as primary, or adding
|
16169
16181
|
additional non-primary billing infos. This can be accomplished by passing
|
16170
|
-
the `primary_payment_method`
|
16171
|
-
the billing_info and /accounts endpoints, this value is not
|
16172
|
-
and will return an error if provided.
|
16182
|
+
the `primary_payment_method` with a value of `true`. When adding billing
|
16183
|
+
infos via the billing_info and /accounts endpoints, this value is not
|
16184
|
+
permitted, and will return an error if provided.
|
16173
16185
|
backup_payment_method:
|
16174
16186
|
type: boolean
|
16175
|
-
description: The `backup_payment_method`
|
16176
|
-
|
16177
|
-
info
|
16178
|
-
|
16179
|
-
|
16180
|
-
|
16181
|
-
|
16187
|
+
description: The `backup_payment_method` field is used to designate a billing
|
16188
|
+
info as a backup on the account that will be tried if the initial billing
|
16189
|
+
info used for an invoice is declined. All payment methods, including the
|
16190
|
+
billing info marked `primary_payment_method` can be set as a backup. An
|
16191
|
+
account can have a maximum of 1 backup, if a user sets a different payment
|
16192
|
+
method as a backup, the existing backup will no longer be marked as such.
|
16193
|
+
BillingInfoVerify:
|
16194
|
+
type: object
|
16195
|
+
properties:
|
16196
|
+
gateway_code:
|
16197
|
+
type: string
|
16198
|
+
description: An identifier for a specific payment gateway.
|
16199
|
+
maxLength: 13
|
16182
16200
|
Coupon:
|
16183
16201
|
type: object
|
16184
16202
|
properties:
|
@@ -17220,7 +17238,8 @@ components:
|
|
17220
17238
|
type: number
|
17221
17239
|
format: float
|
17222
17240
|
title: Subtotal
|
17223
|
-
description: The summation of charges
|
17241
|
+
description: The summation of charges and credits, before discounts and
|
17242
|
+
taxes.
|
17224
17243
|
tax:
|
17225
17244
|
type: number
|
17226
17245
|
format: float
|
@@ -18733,7 +18752,7 @@ components:
|
|
18733
18752
|
country:
|
18734
18753
|
type: string
|
18735
18754
|
maxLength: 50
|
18736
|
-
description: Country, 2-letter ISO code.
|
18755
|
+
description: Country, 2-letter ISO 3166-1 alpha-2 code.
|
18737
18756
|
created_at:
|
18738
18757
|
type: string
|
18739
18758
|
title: Created at
|
@@ -18788,7 +18807,7 @@ components:
|
|
18788
18807
|
country:
|
18789
18808
|
type: string
|
18790
18809
|
maxLength: 50
|
18791
|
-
description: Country, 2-letter ISO code.
|
18810
|
+
description: Country, 2-letter ISO 3166-1 alpha-2 code.
|
18792
18811
|
required:
|
18793
18812
|
- first_name
|
18794
18813
|
- last_name
|
@@ -19038,7 +19057,7 @@ components:
|
|
19038
19057
|
country:
|
19039
19058
|
type: string
|
19040
19059
|
maxLength: 50
|
19041
|
-
description: Country, 2-letter ISO code.
|
19060
|
+
description: Country, 2-letter ISO 3166-1 alpha-2 code.
|
19042
19061
|
Site:
|
19043
19062
|
type: object
|
19044
19063
|
properties:
|
@@ -19493,13 +19512,23 @@ components:
|
|
19493
19512
|
minimum: 0
|
19494
19513
|
maximum: 1000000
|
19495
19514
|
description: Allows up to 2 decimal places. Optionally, override the tiers'
|
19496
|
-
default unit amount.
|
19515
|
+
default unit amount. If add-on's `add_on_type` is `usage` and `usage_type`
|
19516
|
+
is `percentage`, cannot be provided.
|
19497
19517
|
unit_amount_decimal:
|
19498
19518
|
type: string
|
19499
19519
|
title: Unit amount decimal
|
19500
19520
|
description: |
|
19501
19521
|
Allows up to 9 decimal places. Optionally, override tiers' default unit amount.
|
19502
19522
|
If `unit_amount_decimal` is provided, `unit_amount` cannot be provided.
|
19523
|
+
If add-on's `add_on_type` is `usage` and `usage_type` is `percentage`, cannot be provided.
|
19524
|
+
usage_percentage:
|
19525
|
+
type: string
|
19526
|
+
title: Usage Percentage
|
19527
|
+
description: The percentage taken of the monetary amount of usage tracked.
|
19528
|
+
This can be up to 4 decimal places represented as a string. A value between
|
19529
|
+
0.0 and 100.0. Optionally, override tiers' default usage percentage. Required
|
19530
|
+
if add-on's `add_on_type` is `usage` and `usage_type` is `percentage`.
|
19531
|
+
Must be omitted otherwise.
|
19503
19532
|
SubscriptionCancel:
|
19504
19533
|
type: object
|
19505
19534
|
properties:
|
@@ -19577,6 +19606,18 @@ components:
|
|
19577
19606
|
format: date-time
|
19578
19607
|
title: Deleted at
|
19579
19608
|
readOnly: true
|
19609
|
+
billing_info:
|
19610
|
+
"$ref": "#/components/schemas/SubscriptionChangeBillingInfo"
|
19611
|
+
SubscriptionChangeBillingInfo:
|
19612
|
+
type: object
|
19613
|
+
description: Accept nested attributes for three_d_secure_action_result_token_id
|
19614
|
+
properties:
|
19615
|
+
three_d_secure_action_result_token_id:
|
19616
|
+
type: string
|
19617
|
+
title: 3-D Secure action result token ID
|
19618
|
+
description: A token generated by Recurly.js after completing a 3-D Secure
|
19619
|
+
device fingerprinting or authentication challenge.
|
19620
|
+
maxLength: 22
|
19580
19621
|
SubscriptionChangeCreate:
|
19581
19622
|
type: object
|
19582
19623
|
properties:
|
@@ -19778,7 +19819,10 @@ components:
|
|
19778
19819
|
format: date-time
|
19779
19820
|
title: Trial ends at
|
19780
19821
|
description: If set, overrides the default trial behavior for the subscription.
|
19781
|
-
|
19822
|
+
When the current date time or a past date time is provided the subscription
|
19823
|
+
will begin with no trial phase (overriding any plan default trial). When
|
19824
|
+
a future date time is provided the subscription will begin with a trial
|
19825
|
+
phase ending at the specified date time.
|
19782
19826
|
starts_at:
|
19783
19827
|
type: string
|
19784
19828
|
format: date-time
|
@@ -19904,7 +19948,10 @@ components:
|
|
19904
19948
|
format: date-time
|
19905
19949
|
title: Trial ends at
|
19906
19950
|
description: If set, overrides the default trial behavior for the subscription.
|
19907
|
-
|
19951
|
+
When the current date time or a past date time is provided the subscription
|
19952
|
+
will begin with no trial phase (overriding any plan default trial). When
|
19953
|
+
a future date time is provided the subscription will begin with a trial
|
19954
|
+
phase ending at the specified date time.
|
19908
19955
|
starts_at:
|
19909
19956
|
type: string
|
19910
19957
|
format: date-time
|
@@ -20132,6 +20179,38 @@ components:
|
|
20132
20179
|
type: number
|
20133
20180
|
format: float
|
20134
20181
|
title: Rate
|
20182
|
+
tax_details:
|
20183
|
+
type: array
|
20184
|
+
description: Provides additional tax details for Canadian Sales Tax when
|
20185
|
+
there is tax applied at both the country and province levels. This will
|
20186
|
+
only be populated for the Invoice response when fetching a single invoice
|
20187
|
+
and not for the InvoiceList or LineItem.
|
20188
|
+
items:
|
20189
|
+
"$ref": "#/components/schemas/TaxDetail"
|
20190
|
+
TaxDetail:
|
20191
|
+
type: object
|
20192
|
+
title: Tax detail
|
20193
|
+
properties:
|
20194
|
+
type:
|
20195
|
+
type: string
|
20196
|
+
title: Type
|
20197
|
+
description: Provides the tax type for the region. For Canadian Sales Tax,
|
20198
|
+
this will be GST, HST, QST or PST.
|
20199
|
+
region:
|
20200
|
+
type: string
|
20201
|
+
title: Region
|
20202
|
+
description: Provides the tax region applied on an invoice. For Canadian
|
20203
|
+
Sales Tax, this will be either the 2 letter province code or country code.
|
20204
|
+
rate:
|
20205
|
+
type: number
|
20206
|
+
format: float
|
20207
|
+
title: Rate
|
20208
|
+
description: Provides the tax rate for the region.
|
20209
|
+
tax:
|
20210
|
+
type: number
|
20211
|
+
format: float
|
20212
|
+
title: Tax
|
20213
|
+
description: The total tax applied for this tax type.
|
20135
20214
|
Transaction:
|
20136
20215
|
type: object
|
20137
20216
|
properties:
|
@@ -20228,7 +20307,8 @@ components:
|
|
20228
20307
|
- When the merchant enters billing information using the UI, no IP address is recorded.
|
20229
20308
|
ip_address_country:
|
20230
20309
|
type: string
|
20231
|
-
title: IP address
|
20310
|
+
title: Origin IP address country, 2-letter ISO 3166-1 alpha-2 code, if known
|
20311
|
+
by Recurly.
|
20232
20312
|
status_code:
|
20233
20313
|
type: string
|
20234
20314
|
title: Status code
|
@@ -20713,6 +20793,11 @@ components:
|
|
20713
20793
|
description: A token used in place of a credit card in order to perform
|
20714
20794
|
transactions.
|
20715
20795
|
maxLength: 50
|
20796
|
+
cc_bin_country:
|
20797
|
+
type: string
|
20798
|
+
description: The 2-letter ISO 3166-1 alpha-2 country code associated with
|
20799
|
+
the credit card BIN, if known by Recurly. Available on the BillingInfo
|
20800
|
+
object only. Available when the BIN country lookup feature is enabled.
|
20716
20801
|
gateway_code:
|
20717
20802
|
type: string
|
20718
20803
|
description: An identifier for a specific payment gateway.
|
@@ -21433,6 +21518,7 @@ components:
|
|
21433
21518
|
- invalid_data
|
21434
21519
|
- invalid_email
|
21435
21520
|
- invalid_gateway_configuration
|
21521
|
+
- invalid_gateway_access_token
|
21436
21522
|
- invalid_issuer
|
21437
21523
|
- invalid_login
|
21438
21524
|
- invalid_merchant_type
|
@@ -21525,3 +21611,4 @@ components:
|
|
21525
21611
|
type: string
|
21526
21612
|
enum:
|
21527
21613
|
- cpf
|
21614
|
+
- cuit
|