recurly 2.17.5 → 4.18.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 +15 -0
- data/.changelog_config.yaml +11 -0
- data/.github/ISSUE_TEMPLATE/bug-report.md +30 -0
- data/.github/ISSUE_TEMPLATE/question-or-other.md +10 -0
- data/.github/workflows/ci.yml +29 -0
- data/.github/workflows/docs.yml +28 -0
- data/.gitignore +15 -0
- data/.rspec +2 -0
- data/.yardopts +2 -0
- data/CHANGELOG.md +295 -0
- data/CODE_OF_CONDUCT.md +130 -0
- data/CONTRIBUTING.md +106 -0
- data/GETTING_STARTED.md +330 -0
- data/Gemfile +4 -0
- data/LICENSE.txt +21 -0
- data/README.md +9 -148
- data/Rakefile +6 -0
- data/benchmark.rb +16 -0
- data/lib/data/ca-certificates.crt +3466 -0
- data/lib/recurly/client/operations.rb +4079 -0
- data/lib/recurly/client.rb +400 -0
- data/lib/recurly/connection_pool.rb +42 -0
- data/lib/recurly/errors/api_errors.rb +90 -0
- data/lib/recurly/errors/network_errors.rb +7 -0
- data/lib/recurly/errors.rb +51 -0
- data/lib/recurly/http.rb +50 -0
- data/lib/recurly/pager.rb +136 -0
- data/lib/recurly/request.rb +31 -0
- data/lib/recurly/requests/account_acquisition_cost.rb +18 -0
- data/lib/recurly/requests/account_acquisition_update.rb +26 -0
- data/lib/recurly/requests/account_create.rb +98 -0
- data/lib/recurly/requests/account_purchase.rb +98 -0
- data/lib/recurly/requests/account_update.rb +86 -0
- data/lib/recurly/requests/add_on_create.rb +102 -0
- data/lib/recurly/requests/add_on_pricing.rb +26 -0
- data/lib/recurly/requests/add_on_update.rb +78 -0
- data/lib/recurly/requests/address.rb +38 -0
- data/lib/recurly/requests/billing_info_create.rb +134 -0
- data/lib/recurly/requests/billing_info_verify.rb +14 -0
- data/lib/recurly/requests/coupon_bulk_create.rb +14 -0
- data/lib/recurly/requests/coupon_create.rb +102 -0
- data/lib/recurly/requests/coupon_pricing.rb +18 -0
- data/lib/recurly/requests/coupon_redemption_create.rb +22 -0
- data/lib/recurly/requests/coupon_update.rb +34 -0
- data/lib/recurly/requests/custom_field.rb +18 -0
- data/lib/recurly/requests/dunning_campaigns_bulk_update.rb +18 -0
- data/lib/recurly/requests/external_refund.rb +22 -0
- data/lib/recurly/requests/external_transaction.rb +26 -0
- data/lib/recurly/requests/invoice_address.rb +54 -0
- data/lib/recurly/requests/invoice_collect.rb +22 -0
- data/lib/recurly/requests/invoice_create.rb +42 -0
- data/lib/recurly/requests/invoice_refund.rb +34 -0
- data/lib/recurly/requests/invoice_update.rb +34 -0
- data/lib/recurly/requests/item_create.rb +58 -0
- data/lib/recurly/requests/item_update.rb +58 -0
- data/lib/recurly/requests/line_item_create.rb +86 -0
- data/lib/recurly/requests/line_item_refund.rb +22 -0
- data/lib/recurly/requests/measured_unit_create.rb +22 -0
- data/lib/recurly/requests/measured_unit_update.rb +22 -0
- data/lib/recurly/requests/percentage_tier.rb +18 -0
- data/lib/recurly/requests/percentage_tiers_by_currency.rb +18 -0
- data/lib/recurly/requests/plan_create.rb +102 -0
- data/lib/recurly/requests/plan_hosted_pages.rb +26 -0
- data/lib/recurly/requests/plan_pricing.rb +26 -0
- data/lib/recurly/requests/plan_update.rb +94 -0
- data/lib/recurly/requests/pricing.rb +22 -0
- data/lib/recurly/requests/purchase_create.rb +78 -0
- data/lib/recurly/requests/shipping_address_create.rb +62 -0
- data/lib/recurly/requests/shipping_address_update.rb +66 -0
- data/lib/recurly/requests/shipping_fee_create.rb +22 -0
- data/lib/recurly/requests/shipping_method_create.rb +26 -0
- data/lib/recurly/requests/shipping_method_update.rb +26 -0
- data/lib/recurly/requests/shipping_purchase.rb +22 -0
- data/lib/recurly/requests/subscription_add_on_create.rb +46 -0
- data/lib/recurly/requests/subscription_add_on_percentage_tier.rb +18 -0
- data/lib/recurly/requests/subscription_add_on_tier.rb +26 -0
- data/lib/recurly/requests/subscription_add_on_update.rb +50 -0
- data/lib/recurly/requests/subscription_cancel.rb +14 -0
- data/lib/recurly/requests/subscription_change_billing_info_create.rb +14 -0
- data/lib/recurly/requests/subscription_change_create.rb +74 -0
- data/lib/recurly/requests/subscription_change_shipping_create.rb +30 -0
- data/lib/recurly/requests/subscription_create.rb +114 -0
- data/lib/recurly/requests/subscription_pause.rb +14 -0
- data/lib/recurly/requests/subscription_purchase.rb +70 -0
- data/lib/recurly/requests/subscription_shipping_create.rb +30 -0
- data/lib/recurly/requests/subscription_shipping_purchase.rb +22 -0
- data/lib/recurly/requests/subscription_shipping_update.rb +22 -0
- data/lib/recurly/requests/subscription_update.rb +70 -0
- data/lib/recurly/requests/tier.rb +22 -0
- data/lib/recurly/requests/tier_pricing.rb +22 -0
- data/lib/recurly/requests/usage_create.rb +26 -0
- data/lib/recurly/requests.rb +8 -0
- data/lib/recurly/resource.rb +23 -1092
- data/lib/recurly/resources/account.rb +138 -0
- data/lib/recurly/resources/account_acquisition.rb +46 -0
- data/lib/recurly/resources/account_acquisition_cost.rb +18 -0
- data/lib/recurly/resources/account_balance.rb +26 -0
- data/lib/recurly/resources/account_balance_amount.rb +22 -0
- data/lib/recurly/resources/account_mini.rb +50 -0
- data/lib/recurly/resources/account_note.rb +34 -0
- data/lib/recurly/resources/add_on.rb +122 -0
- data/lib/recurly/resources/add_on_mini.rb +54 -0
- data/lib/recurly/resources/add_on_pricing.rb +26 -0
- data/lib/recurly/resources/address.rb +38 -0
- data/lib/recurly/resources/address_with_name.rb +46 -0
- data/lib/recurly/resources/billing_info.rb +74 -0
- data/lib/recurly/resources/billing_info_updated_by.rb +18 -0
- data/lib/recurly/resources/binary_file.rb +14 -0
- data/lib/recurly/resources/coupon.rb +126 -0
- data/lib/recurly/resources/coupon_discount.rb +26 -0
- data/lib/recurly/resources/coupon_discount_pricing.rb +18 -0
- data/lib/recurly/resources/coupon_discount_trial.rb +18 -0
- data/lib/recurly/resources/coupon_mini.rb +42 -0
- data/lib/recurly/resources/coupon_redemption.rb +54 -0
- data/lib/recurly/resources/coupon_redemption_mini.rb +34 -0
- data/lib/recurly/resources/credit_payment.rb +66 -0
- data/lib/recurly/resources/custom_field.rb +18 -0
- data/lib/recurly/resources/custom_field_definition.rb +50 -0
- data/lib/recurly/resources/dunning_campaign.rb +50 -0
- data/lib/recurly/resources/dunning_campaigns_bulk_update_response.rb +18 -0
- data/lib/recurly/resources/dunning_cycle.rb +58 -0
- data/lib/recurly/resources/dunning_interval.rb +18 -0
- data/lib/recurly/resources/error.rb +22 -0
- data/lib/recurly/resources/error_may_have_transaction.rb +26 -0
- data/lib/recurly/resources/export_dates.rb +18 -0
- data/lib/recurly/resources/export_file.rb +22 -0
- data/lib/recurly/resources/export_files.rb +18 -0
- data/lib/recurly/resources/fraud_info.rb +22 -0
- data/lib/recurly/resources/invoice.rb +162 -0
- data/lib/recurly/resources/invoice_address.rb +54 -0
- data/lib/recurly/resources/invoice_collection.rb +22 -0
- data/lib/recurly/resources/invoice_mini.rb +30 -0
- data/lib/recurly/resources/invoice_template.rb +34 -0
- data/lib/recurly/resources/item.rb +82 -0
- data/lib/recurly/resources/item_mini.rb +34 -0
- data/lib/recurly/resources/line_item.rb +206 -0
- data/lib/recurly/resources/measured_unit.rb +46 -0
- data/lib/recurly/resources/payment_method.rb +70 -0
- data/lib/recurly/resources/percentage_tier.rb +18 -0
- data/lib/recurly/resources/percentage_tiers_by_currency.rb +18 -0
- data/lib/recurly/resources/plan.rb +122 -0
- data/lib/recurly/resources/plan_hosted_pages.rb +26 -0
- data/lib/recurly/resources/plan_mini.rb +26 -0
- data/lib/recurly/resources/plan_pricing.rb +26 -0
- data/lib/recurly/resources/pricing.rb +22 -0
- data/lib/recurly/resources/settings.rb +22 -0
- data/lib/recurly/resources/shipping_address.rb +82 -0
- data/lib/recurly/resources/shipping_method.rb +46 -0
- data/lib/recurly/resources/shipping_method_mini.rb +26 -0
- data/lib/recurly/resources/site.rb +54 -0
- data/lib/recurly/resources/subscription.rb +198 -0
- data/lib/recurly/resources/subscription_add_on.rb +78 -0
- data/lib/recurly/resources/subscription_add_on_percentage_tier.rb +18 -0
- data/lib/recurly/resources/subscription_add_on_tier.rb +26 -0
- data/lib/recurly/resources/subscription_change.rb +82 -0
- data/lib/recurly/resources/subscription_change_billing_info.rb +14 -0
- data/lib/recurly/resources/subscription_shipping.rb +26 -0
- data/lib/recurly/resources/tax_detail.rb +26 -0
- data/lib/recurly/resources/tax_info.rb +26 -0
- data/lib/recurly/resources/tier.rb +22 -0
- data/lib/recurly/resources/tier_pricing.rb +22 -0
- data/lib/recurly/resources/transaction.rb +162 -0
- data/lib/recurly/resources/transaction_error.rb +38 -0
- data/lib/recurly/resources/transaction_payment_gateway.rb +26 -0
- data/lib/recurly/resources/unique_coupon_code.rb +50 -0
- data/lib/recurly/resources/unique_coupon_code_params.rb +26 -0
- data/lib/recurly/resources/usage.rb +78 -0
- data/lib/recurly/resources/user.rb +42 -0
- data/lib/recurly/resources.rb +18 -0
- data/lib/recurly/schema/file_parser.rb +13 -0
- data/lib/recurly/schema/json_parser.rb +72 -0
- data/lib/recurly/schema/request_caster.rb +60 -0
- data/lib/recurly/schema/resource_caster.rb +46 -0
- data/lib/recurly/schema/schema_factory.rb +48 -0
- data/lib/recurly/schema/schema_validator.rb +144 -0
- data/lib/recurly/schema.rb +156 -0
- data/lib/recurly/version.rb +1 -15
- data/lib/recurly.rb +15 -138
- data/openapi/api.yaml +22879 -0
- data/recurly.gemspec +39 -0
- data/scripts/build +5 -0
- data/scripts/clean +6 -0
- data/scripts/format +12 -0
- data/scripts/prepare-release +50 -0
- data/scripts/release +17 -0
- data/scripts/test +15 -0
- metadata +217 -217
- data/lib/recurly/account.rb +0 -179
- data/lib/recurly/account_balance.rb +0 -21
- data/lib/recurly/add_on.rb +0 -30
- data/lib/recurly/address.rb +0 -25
- data/lib/recurly/adjustment.rb +0 -76
- data/lib/recurly/api/errors.rb +0 -208
- data/lib/recurly/api/net_http_adapter.rb +0 -111
- data/lib/recurly/api.rb +0 -101
- data/lib/recurly/billing_info.rb +0 -80
- data/lib/recurly/coupon.rb +0 -134
- data/lib/recurly/credit_payment.rb +0 -32
- data/lib/recurly/custom_field.rb +0 -15
- data/lib/recurly/delivery.rb +0 -19
- data/lib/recurly/error.rb +0 -13
- data/lib/recurly/gift_card.rb +0 -82
- data/lib/recurly/helper.rb +0 -51
- data/lib/recurly/invoice.rb +0 -273
- data/lib/recurly/invoice_collection.rb +0 -14
- data/lib/recurly/js.rb +0 -14
- data/lib/recurly/juris_detail.rb +0 -14
- data/lib/recurly/measured_unit.rb +0 -16
- data/lib/recurly/money.rb +0 -120
- data/lib/recurly/note.rb +0 -14
- data/lib/recurly/plan.rb +0 -40
- data/lib/recurly/purchase.rb +0 -219
- data/lib/recurly/redemption.rb +0 -46
- data/lib/recurly/resource/association.rb +0 -16
- data/lib/recurly/resource/errors.rb +0 -20
- data/lib/recurly/resource/pager.rb +0 -313
- data/lib/recurly/shipping_address.rb +0 -26
- data/lib/recurly/subscription/add_ons.rb +0 -77
- data/lib/recurly/subscription.rb +0 -328
- data/lib/recurly/subscription_add_on.rb +0 -50
- data/lib/recurly/tax_detail.rb +0 -14
- data/lib/recurly/tax_type.rb +0 -12
- data/lib/recurly/transaction/errors.rb +0 -107
- data/lib/recurly/transaction.rb +0 -129
- data/lib/recurly/usage.rb +0 -28
- data/lib/recurly/webhook/account_notification.rb +0 -10
- data/lib/recurly/webhook/billing_info_updated_notification.rb +0 -6
- data/lib/recurly/webhook/canceled_account_notification.rb +0 -6
- data/lib/recurly/webhook/canceled_subscription_notification.rb +0 -6
- data/lib/recurly/webhook/closed_credit_invoice_notification.rb +0 -6
- data/lib/recurly/webhook/closed_invoice_notification.rb +0 -6
- data/lib/recurly/webhook/credit_payment_notification.rb +0 -12
- data/lib/recurly/webhook/dunning_notification.rb +0 -14
- data/lib/recurly/webhook/expired_subscription_notification.rb +0 -6
- data/lib/recurly/webhook/failed_charge_invoice_notification.rb +0 -6
- data/lib/recurly/webhook/failed_payment_notification.rb +0 -6
- data/lib/recurly/webhook/gift_card_notification.rb +0 -8
- data/lib/recurly/webhook/invoice_notification.rb +0 -12
- data/lib/recurly/webhook/low_balance_gift_card_notification.rb +0 -6
- data/lib/recurly/webhook/new_account_notification.rb +0 -6
- data/lib/recurly/webhook/new_charge_invoice_notification.rb +0 -6
- data/lib/recurly/webhook/new_credit_invoice_notification.rb +0 -6
- data/lib/recurly/webhook/new_credit_payment_notification.rb +0 -6
- data/lib/recurly/webhook/new_dunning_event_notification.rb +0 -6
- data/lib/recurly/webhook/new_invoice_notification.rb +0 -6
- data/lib/recurly/webhook/new_subscription_notification.rb +0 -6
- data/lib/recurly/webhook/new_usage_notification.rb +0 -8
- data/lib/recurly/webhook/notification.rb +0 -18
- data/lib/recurly/webhook/paid_charge_invoice_notification.rb +0 -6
- data/lib/recurly/webhook/past_due_charge_invoice_notification.rb +0 -6
- data/lib/recurly/webhook/past_due_invoice_notification.rb +0 -6
- data/lib/recurly/webhook/processing_charge_invoice_notification.rb +0 -6
- data/lib/recurly/webhook/processing_credit_invoice_notification.rb +0 -6
- data/lib/recurly/webhook/processing_invoice_notification.rb +0 -6
- data/lib/recurly/webhook/processing_payment_notification.rb +0 -6
- data/lib/recurly/webhook/purchased_gift_card_notification.rb +0 -7
- data/lib/recurly/webhook/reactivated_account_notification.rb +0 -6
- data/lib/recurly/webhook/redeemed_gift_card_notification.rb +0 -7
- data/lib/recurly/webhook/renewed_subscription_notification.rb +0 -6
- data/lib/recurly/webhook/reopened_charge_invoice_notification.rb +0 -6
- data/lib/recurly/webhook/reopened_credit_invoice_notification.rb +0 -6
- data/lib/recurly/webhook/scheduled_payment_notification.rb +0 -6
- data/lib/recurly/webhook/subscription_notification.rb +0 -12
- data/lib/recurly/webhook/successful_payment_notification.rb +0 -6
- data/lib/recurly/webhook/successful_refund_notification.rb +0 -6
- data/lib/recurly/webhook/transaction_authorized_notification.rb +0 -6
- data/lib/recurly/webhook/transaction_notification.rb +0 -12
- data/lib/recurly/webhook/transaction_status_updated_notification.rb +0 -6
- data/lib/recurly/webhook/updated_account_notification.rb +0 -6
- data/lib/recurly/webhook/updated_balance_gift_card_notification.rb +0 -7
- data/lib/recurly/webhook/updated_invoice_notification.rb +0 -6
- data/lib/recurly/webhook/updated_subscription_notification.rb +0 -6
- data/lib/recurly/webhook/void_payment_notification.rb +0 -6
- data/lib/recurly/webhook/voided_credit_invoice_notification.rb +0 -6
- data/lib/recurly/webhook/voided_credit_payment_notification.rb +0 -6
- data/lib/recurly/webhook.rb +0 -91
- data/lib/recurly/xml/nokogiri.rb +0 -60
- data/lib/recurly/xml/rexml.rb +0 -52
- data/lib/recurly/xml.rb +0 -122
@@ -0,0 +1,94 @@
|
|
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 PlanUpdate < Request
|
8
|
+
|
9
|
+
# @!attribute accounting_code
|
10
|
+
# @return [String] Accounting code for invoice line items for the plan. If no value is provided, it defaults to plan's code.
|
11
|
+
define_attribute :accounting_code, String
|
12
|
+
|
13
|
+
# @!attribute allow_any_item_on_subscriptions
|
14
|
+
# @return [Boolean] Used to determine whether items can be assigned as add-ons to individual subscriptions. If `true`, items can be assigned as add-ons to individual subscription add-ons. If `false`, only plan add-ons can be used.
|
15
|
+
define_attribute :allow_any_item_on_subscriptions, :Boolean
|
16
|
+
|
17
|
+
# @!attribute auto_renew
|
18
|
+
# @return [Boolean] Subscriptions will automatically inherit this value once they are active. If `auto_renew` is `true`, then a subscription will automatically renew its term at renewal. If `auto_renew` is `false`, then a subscription will expire at the end of its term. `auto_renew` can be overridden on the subscription record itself.
|
19
|
+
define_attribute :auto_renew, :Boolean
|
20
|
+
|
21
|
+
# @!attribute avalara_service_type
|
22
|
+
# @return [Integer] Used by Avalara for Communications taxes. The transaction type in combination with the service type describe how the plan is taxed. Refer to [the documentation](https://help.avalara.com/AvaTax_for_Communications/Tax_Calculation/AvaTax_for_Communications_Tax_Engine/Mapping_Resources/TM_00115_AFC_Modules_Corresponding_Transaction_Types) for more available t/s types.
|
23
|
+
define_attribute :avalara_service_type, Integer
|
24
|
+
|
25
|
+
# @!attribute avalara_transaction_type
|
26
|
+
# @return [Integer] Used by Avalara for Communications taxes. The transaction type in combination with the service type describe how the plan is taxed. Refer to [the documentation](https://help.avalara.com/AvaTax_for_Communications/Tax_Calculation/AvaTax_for_Communications_Tax_Engine/Mapping_Resources/TM_00115_AFC_Modules_Corresponding_Transaction_Types) for more available t/s types.
|
27
|
+
define_attribute :avalara_transaction_type, Integer
|
28
|
+
|
29
|
+
# @!attribute code
|
30
|
+
# @return [String] Unique code to identify the plan. This is used in Hosted Payment Page URLs and in the invoice exports.
|
31
|
+
define_attribute :code, String
|
32
|
+
|
33
|
+
# @!attribute currencies
|
34
|
+
# @return [Array[PlanPricing]] Pricing
|
35
|
+
define_attribute :currencies, Array, { :item_type => :PlanPricing }
|
36
|
+
|
37
|
+
# @!attribute description
|
38
|
+
# @return [String] Optional description, not displayed.
|
39
|
+
define_attribute :description, String
|
40
|
+
|
41
|
+
# @!attribute dunning_campaign_id
|
42
|
+
# @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.
|
43
|
+
define_attribute :dunning_campaign_id, String
|
44
|
+
|
45
|
+
# @!attribute hosted_pages
|
46
|
+
# @return [PlanHostedPages] Hosted pages settings
|
47
|
+
define_attribute :hosted_pages, :PlanHostedPages
|
48
|
+
|
49
|
+
# @!attribute id
|
50
|
+
# @return [String] Plan ID
|
51
|
+
define_attribute :id, String
|
52
|
+
|
53
|
+
# @!attribute name
|
54
|
+
# @return [String] This name describes your plan and will appear on the Hosted Payment Page and the subscriber's invoice.
|
55
|
+
define_attribute :name, String
|
56
|
+
|
57
|
+
# @!attribute revenue_schedule_type
|
58
|
+
# @return [String] Revenue schedule type
|
59
|
+
define_attribute :revenue_schedule_type, String
|
60
|
+
|
61
|
+
# @!attribute setup_fee_accounting_code
|
62
|
+
# @return [String] Accounting code for invoice line items for the plan's setup fee. If no value is provided, it defaults to plan's accounting code.
|
63
|
+
define_attribute :setup_fee_accounting_code, String
|
64
|
+
|
65
|
+
# @!attribute setup_fee_revenue_schedule_type
|
66
|
+
# @return [String] Setup fee revenue schedule type
|
67
|
+
define_attribute :setup_fee_revenue_schedule_type, String
|
68
|
+
|
69
|
+
# @!attribute tax_code
|
70
|
+
# @return [String] Optional field used by Avalara, Vertex, and Recurly's EU VAT tax feature to determine taxation rules. If you have your own AvaTax or Vertex account configured, use their tax codes to assign specific tax rules. If you are using Recurly's EU VAT feature, you can use values of `unknown`, `physical`, or `digital`.
|
71
|
+
define_attribute :tax_code, String
|
72
|
+
|
73
|
+
# @!attribute tax_exempt
|
74
|
+
# @return [Boolean] `true` exempts tax on the plan, `false` applies tax on the plan.
|
75
|
+
define_attribute :tax_exempt, :Boolean
|
76
|
+
|
77
|
+
# @!attribute total_billing_cycles
|
78
|
+
# @return [Integer] Automatically terminate plans after a defined number of billing cycles.
|
79
|
+
define_attribute :total_billing_cycles, Integer
|
80
|
+
|
81
|
+
# @!attribute trial_length
|
82
|
+
# @return [Integer] Length of plan's trial period in `trial_units`. `0` means `no trial`.
|
83
|
+
define_attribute :trial_length, Integer
|
84
|
+
|
85
|
+
# @!attribute trial_requires_billing_info
|
86
|
+
# @return [Boolean] Allow free trial subscriptions to be created without billing info. Should not be used if billing info is needed for initial invoice due to existing uninvoiced charges or setup fee.
|
87
|
+
define_attribute :trial_requires_billing_info, :Boolean
|
88
|
+
|
89
|
+
# @!attribute trial_unit
|
90
|
+
# @return [String] Units for the plan's trial period.
|
91
|
+
define_attribute :trial_unit, String
|
92
|
+
end
|
93
|
+
end
|
94
|
+
end
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# This file is automatically created by Recurly's OpenAPI generation process
|
2
|
+
# and thus any edits you make by hand will be lost. If you wish to make a
|
3
|
+
# change to this file, please create a Github issue explaining the changes you
|
4
|
+
# need and we will usher them to the appropriate places.
|
5
|
+
module Recurly
|
6
|
+
module Requests
|
7
|
+
class Pricing < Request
|
8
|
+
|
9
|
+
# @!attribute currency
|
10
|
+
# @return [String] 3-letter ISO 4217 currency code.
|
11
|
+
define_attribute :currency, String
|
12
|
+
|
13
|
+
# @!attribute tax_inclusive
|
14
|
+
# @return [Boolean] This field is deprecated. Please do not use it.
|
15
|
+
define_attribute :tax_inclusive, :Boolean
|
16
|
+
|
17
|
+
# @!attribute unit_amount
|
18
|
+
# @return [Float] Unit price
|
19
|
+
define_attribute :unit_amount, Float
|
20
|
+
end
|
21
|
+
end
|
22
|
+
end
|
@@ -0,0 +1,78 @@
|
|
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 PurchaseCreate < Request
|
8
|
+
|
9
|
+
# @!attribute account
|
10
|
+
# @return [AccountPurchase]
|
11
|
+
define_attribute :account, :AccountPurchase
|
12
|
+
|
13
|
+
# @!attribute billing_info_id
|
14
|
+
# @return [String] The `billing_info_id` is the value that represents a specific billing info for an end customer. When `billing_info_id` is used to assign billing info to the subscription, all future billing events for the subscription will bill to the specified billing info. `billing_info_id` can ONLY be used for sites utilizing the Wallet feature.
|
15
|
+
define_attribute :billing_info_id, String
|
16
|
+
|
17
|
+
# @!attribute collection_method
|
18
|
+
# @return [String] Must be set to manual in order to preview a purchase for an Account that does not have payment information associated with the Billing Info.
|
19
|
+
define_attribute :collection_method, String
|
20
|
+
|
21
|
+
# @!attribute coupon_codes
|
22
|
+
# @return [Array[String]] A list of coupon_codes to be redeemed on the subscription or account during the purchase.
|
23
|
+
define_attribute :coupon_codes, Array, { :item_type => String }
|
24
|
+
|
25
|
+
# @!attribute credit_customer_notes
|
26
|
+
# @return [String] Notes to be put on the credit invoice resulting from credits in the purchase, if any.
|
27
|
+
define_attribute :credit_customer_notes, String
|
28
|
+
|
29
|
+
# @!attribute currency
|
30
|
+
# @return [String] 3-letter ISO 4217 currency code.
|
31
|
+
define_attribute :currency, String
|
32
|
+
|
33
|
+
# @!attribute customer_notes
|
34
|
+
# @return [String] Customer notes
|
35
|
+
define_attribute :customer_notes, String
|
36
|
+
|
37
|
+
# @!attribute gateway_code
|
38
|
+
# @return [String] The default payment gateway identifier to be used for the purchase transaction. This will also be applied as the default for any subscriptions included in the purchase request.
|
39
|
+
define_attribute :gateway_code, String
|
40
|
+
|
41
|
+
# @!attribute gift_card_redemption_code
|
42
|
+
# @return [String] A gift card redemption code to be redeemed on the purchase invoice.
|
43
|
+
define_attribute :gift_card_redemption_code, String
|
44
|
+
|
45
|
+
# @!attribute line_items
|
46
|
+
# @return [Array[LineItemCreate]] A list of one time charges or credits to be created with the purchase.
|
47
|
+
define_attribute :line_items, Array, { :item_type => :LineItemCreate }
|
48
|
+
|
49
|
+
# @!attribute net_terms
|
50
|
+
# @return [Integer] Integer representing the number of days after an invoice's creation that the invoice will become past due. If an invoice's net terms are set to '0', it is due 'On Receipt' and will become past due 24 hours after it’s created. If an invoice is due net 30, it will become past due at 31 days exactly.
|
51
|
+
define_attribute :net_terms, Integer
|
52
|
+
|
53
|
+
# @!attribute po_number
|
54
|
+
# @return [String] For manual invoicing, this identifies the PO number associated with the subscription.
|
55
|
+
define_attribute :po_number, String
|
56
|
+
|
57
|
+
# @!attribute shipping
|
58
|
+
# @return [ShippingPurchase]
|
59
|
+
define_attribute :shipping, :ShippingPurchase
|
60
|
+
|
61
|
+
# @!attribute subscriptions
|
62
|
+
# @return [Array[SubscriptionPurchase]] A list of subscriptions to be created with the purchase.
|
63
|
+
define_attribute :subscriptions, Array, { :item_type => :SubscriptionPurchase }
|
64
|
+
|
65
|
+
# @!attribute terms_and_conditions
|
66
|
+
# @return [String] Terms and conditions to be put on the purchase invoice.
|
67
|
+
define_attribute :terms_and_conditions, String
|
68
|
+
|
69
|
+
# @!attribute transaction_type
|
70
|
+
# @return [String] An optional type designation for the payment gateway transaction created by this request. Supports 'moto' value, which is the acronym for mail order and telephone transactions.
|
71
|
+
define_attribute :transaction_type, String
|
72
|
+
|
73
|
+
# @!attribute vat_reverse_charge_notes
|
74
|
+
# @return [String] VAT reverse charge notes for cross border European tax settlement.
|
75
|
+
define_attribute :vat_reverse_charge_notes, String
|
76
|
+
end
|
77
|
+
end
|
78
|
+
end
|
@@ -0,0 +1,62 @@
|
|
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 ShippingAddressCreate < Request
|
8
|
+
|
9
|
+
# @!attribute city
|
10
|
+
# @return [String]
|
11
|
+
define_attribute :city, String
|
12
|
+
|
13
|
+
# @!attribute company
|
14
|
+
# @return [String]
|
15
|
+
define_attribute :company, String
|
16
|
+
|
17
|
+
# @!attribute country
|
18
|
+
# @return [String] Country, 2-letter ISO 3166-1 alpha-2 code.
|
19
|
+
define_attribute :country, String
|
20
|
+
|
21
|
+
# @!attribute email
|
22
|
+
# @return [String]
|
23
|
+
define_attribute :email, String
|
24
|
+
|
25
|
+
# @!attribute first_name
|
26
|
+
# @return [String]
|
27
|
+
define_attribute :first_name, String
|
28
|
+
|
29
|
+
# @!attribute last_name
|
30
|
+
# @return [String]
|
31
|
+
define_attribute :last_name, String
|
32
|
+
|
33
|
+
# @!attribute nickname
|
34
|
+
# @return [String]
|
35
|
+
define_attribute :nickname, String
|
36
|
+
|
37
|
+
# @!attribute phone
|
38
|
+
# @return [String]
|
39
|
+
define_attribute :phone, String
|
40
|
+
|
41
|
+
# @!attribute postal_code
|
42
|
+
# @return [String] Zip or postal code.
|
43
|
+
define_attribute :postal_code, String
|
44
|
+
|
45
|
+
# @!attribute region
|
46
|
+
# @return [String] State or province.
|
47
|
+
define_attribute :region, String
|
48
|
+
|
49
|
+
# @!attribute street1
|
50
|
+
# @return [String]
|
51
|
+
define_attribute :street1, String
|
52
|
+
|
53
|
+
# @!attribute street2
|
54
|
+
# @return [String]
|
55
|
+
define_attribute :street2, String
|
56
|
+
|
57
|
+
# @!attribute vat_number
|
58
|
+
# @return [String]
|
59
|
+
define_attribute :vat_number, String
|
60
|
+
end
|
61
|
+
end
|
62
|
+
end
|
@@ -0,0 +1,66 @@
|
|
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 ShippingAddressUpdate < Request
|
8
|
+
|
9
|
+
# @!attribute city
|
10
|
+
# @return [String]
|
11
|
+
define_attribute :city, String
|
12
|
+
|
13
|
+
# @!attribute company
|
14
|
+
# @return [String]
|
15
|
+
define_attribute :company, String
|
16
|
+
|
17
|
+
# @!attribute country
|
18
|
+
# @return [String] Country, 2-letter ISO 3166-1 alpha-2 code.
|
19
|
+
define_attribute :country, String
|
20
|
+
|
21
|
+
# @!attribute email
|
22
|
+
# @return [String]
|
23
|
+
define_attribute :email, String
|
24
|
+
|
25
|
+
# @!attribute first_name
|
26
|
+
# @return [String]
|
27
|
+
define_attribute :first_name, String
|
28
|
+
|
29
|
+
# @!attribute id
|
30
|
+
# @return [String] Shipping Address ID
|
31
|
+
define_attribute :id, String
|
32
|
+
|
33
|
+
# @!attribute last_name
|
34
|
+
# @return [String]
|
35
|
+
define_attribute :last_name, String
|
36
|
+
|
37
|
+
# @!attribute nickname
|
38
|
+
# @return [String]
|
39
|
+
define_attribute :nickname, String
|
40
|
+
|
41
|
+
# @!attribute phone
|
42
|
+
# @return [String]
|
43
|
+
define_attribute :phone, String
|
44
|
+
|
45
|
+
# @!attribute postal_code
|
46
|
+
# @return [String] Zip or postal code.
|
47
|
+
define_attribute :postal_code, String
|
48
|
+
|
49
|
+
# @!attribute region
|
50
|
+
# @return [String] State or province.
|
51
|
+
define_attribute :region, String
|
52
|
+
|
53
|
+
# @!attribute street1
|
54
|
+
# @return [String]
|
55
|
+
define_attribute :street1, String
|
56
|
+
|
57
|
+
# @!attribute street2
|
58
|
+
# @return [String]
|
59
|
+
define_attribute :street2, String
|
60
|
+
|
61
|
+
# @!attribute vat_number
|
62
|
+
# @return [String]
|
63
|
+
define_attribute :vat_number, String
|
64
|
+
end
|
65
|
+
end
|
66
|
+
end
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# This file is automatically created by Recurly's OpenAPI generation process
|
2
|
+
# and thus any edits you make by hand will be lost. If you wish to make a
|
3
|
+
# change to this file, please create a Github issue explaining the changes you
|
4
|
+
# need and we will usher them to the appropriate places.
|
5
|
+
module Recurly
|
6
|
+
module Requests
|
7
|
+
class ShippingFeeCreate < Request
|
8
|
+
|
9
|
+
# @!attribute amount
|
10
|
+
# @return [Float] This is priced in the purchase's currency.
|
11
|
+
define_attribute :amount, Float
|
12
|
+
|
13
|
+
# @!attribute method_code
|
14
|
+
# @return [String] The code of the shipping method used to deliver the purchase. If `method_id` and `method_code` are both present, `method_id` will be used.
|
15
|
+
define_attribute :method_code, String
|
16
|
+
|
17
|
+
# @!attribute method_id
|
18
|
+
# @return [String] The id of the shipping method used to deliver the purchase. If `method_id` and `method_code` are both present, `method_id` will be used.
|
19
|
+
define_attribute :method_id, String
|
20
|
+
end
|
21
|
+
end
|
22
|
+
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 Requests
|
7
|
+
class ShippingMethodCreate < Request
|
8
|
+
|
9
|
+
# @!attribute accounting_code
|
10
|
+
# @return [String] Accounting code for shipping method.
|
11
|
+
define_attribute :accounting_code, String
|
12
|
+
|
13
|
+
# @!attribute code
|
14
|
+
# @return [String] The internal name used identify the shipping method.
|
15
|
+
define_attribute :code, String
|
16
|
+
|
17
|
+
# @!attribute name
|
18
|
+
# @return [String] The name of the shipping method displayed to customers.
|
19
|
+
define_attribute :name, String
|
20
|
+
|
21
|
+
# @!attribute tax_code
|
22
|
+
# @return [String] Used by Avalara, Vertex, and Recurly’s built-in tax feature. The tax code values are specific to each tax system. If you are using Recurly’s built-in taxes the values are: - `FR` – Common Carrier FOB Destination - `FR022000` – Common Carrier FOB Origin - `FR020400` – Non Common Carrier FOB Destination - `FR020500` – Non Common Carrier FOB Origin - `FR010100` – Delivery by Company Vehicle Before Passage of Title - `FR010200` – Delivery by Company Vehicle After Passage of Title - `NT` – Non-Taxable
|
23
|
+
define_attribute :tax_code, String
|
24
|
+
end
|
25
|
+
end
|
26
|
+
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 Requests
|
7
|
+
class ShippingMethodUpdate < Request
|
8
|
+
|
9
|
+
# @!attribute accounting_code
|
10
|
+
# @return [String] Accounting code for shipping method.
|
11
|
+
define_attribute :accounting_code, String
|
12
|
+
|
13
|
+
# @!attribute code
|
14
|
+
# @return [String] The internal name used identify the shipping method.
|
15
|
+
define_attribute :code, String
|
16
|
+
|
17
|
+
# @!attribute name
|
18
|
+
# @return [String] The name of the shipping method displayed to customers.
|
19
|
+
define_attribute :name, String
|
20
|
+
|
21
|
+
# @!attribute tax_code
|
22
|
+
# @return [String] Used by Avalara, Vertex, and Recurly’s built-in tax feature. The tax code values are specific to each tax system. If you are using Recurly’s built-in taxes the values are: - `FR` – Common Carrier FOB Destination - `FR022000` – Common Carrier FOB Origin - `FR020400` – Non Common Carrier FOB Destination - `FR020500` – Non Common Carrier FOB Origin - `FR010100` – Delivery by Company Vehicle Before Passage of Title - `FR010200` – Delivery by Company Vehicle After Passage of Title - `NT` – Non-Taxable
|
23
|
+
define_attribute :tax_code, String
|
24
|
+
end
|
25
|
+
end
|
26
|
+
end
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# This file is automatically created by Recurly's OpenAPI generation process
|
2
|
+
# and thus any edits you make by hand will be lost. If you wish to make a
|
3
|
+
# change to this file, please create a Github issue explaining the changes you
|
4
|
+
# need and we will usher them to the appropriate places.
|
5
|
+
module Recurly
|
6
|
+
module Requests
|
7
|
+
class ShippingPurchase < Request
|
8
|
+
|
9
|
+
# @!attribute address
|
10
|
+
# @return [ShippingAddressCreate]
|
11
|
+
define_attribute :address, :ShippingAddressCreate
|
12
|
+
|
13
|
+
# @!attribute address_id
|
14
|
+
# @return [String] Assign a shipping address from the account's existing shipping addresses. If this and `address` are both present, `address` will take precedence.
|
15
|
+
define_attribute :address_id, String
|
16
|
+
|
17
|
+
# @!attribute fees
|
18
|
+
# @return [Array[ShippingFeeCreate]] A list of shipping fees to be created as charges with the purchase.
|
19
|
+
define_attribute :fees, Array, { :item_type => :ShippingFeeCreate }
|
20
|
+
end
|
21
|
+
end
|
22
|
+
end
|
@@ -0,0 +1,46 @@
|
|
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 SubscriptionAddOnCreate < Request
|
8
|
+
|
9
|
+
# @!attribute add_on_source
|
10
|
+
# @return [String] Used to determine where the associated add-on data is pulled from. If this value is set to `plan_add_on` or left blank, then add-on data will be pulled from the plan's add-ons. If the associated `plan` has `allow_any_item_on_subscriptions` set to `true` and this field is set to `item`, then the associated add-on data will be pulled from the site's item catalog.
|
11
|
+
define_attribute :add_on_source, String
|
12
|
+
|
13
|
+
# @!attribute code
|
14
|
+
# @return [String] If `add_on_source` is set to `plan_add_on` or left blank, then plan's add-on `code` should be used. If `add_on_source` is set to `item`, then the `code` from the associated item should be used.
|
15
|
+
define_attribute :code, String
|
16
|
+
|
17
|
+
# @!attribute percentage_tiers
|
18
|
+
# @return [Array[SubscriptionAddOnPercentageTier]] If percentage tiers are provided in the request, all existing percentage tiers on the Subscription Add-on will be removed and replaced by the percentage tiers in the request. There must be one tier without ending_amount value which represents the final tier. Use only if add_on.tier_type is tiered or volume and add_on.usage_type is percentage.
|
19
|
+
define_attribute :percentage_tiers, Array, { :item_type => :SubscriptionAddOnPercentageTier }
|
20
|
+
|
21
|
+
# @!attribute quantity
|
22
|
+
# @return [Integer] Quantity
|
23
|
+
define_attribute :quantity, Integer
|
24
|
+
|
25
|
+
# @!attribute revenue_schedule_type
|
26
|
+
# @return [String] Revenue schedule type
|
27
|
+
define_attribute :revenue_schedule_type, String
|
28
|
+
|
29
|
+
# @!attribute tiers
|
30
|
+
# @return [Array[SubscriptionAddOnTier]] If the plan add-on's `tier_type` is `flat`, then `tiers` must be absent. The `tiers` object must include one to many tiers with `ending_quantity` and `unit_amount`. There must be one tier without an `ending_quantity` value which represents the final tier. See our [Guide](https://developers.recurly.com/guides/item-addon-guide.html) for an overview of how to configure quantity-based pricing models.
|
31
|
+
define_attribute :tiers, Array, { :item_type => :SubscriptionAddOnTier }
|
32
|
+
|
33
|
+
# @!attribute unit_amount
|
34
|
+
# @return [Float] Allows up to 2 decimal places. Optionally, override the add-on's default unit amount. If the plan add-on's `tier_type` is `tiered`, `volume`, or `stairstep`, then `unit_amount` cannot be provided.
|
35
|
+
define_attribute :unit_amount, Float
|
36
|
+
|
37
|
+
# @!attribute unit_amount_decimal
|
38
|
+
# @return [String] Allows up to 9 decimal places. Optionally, override the add-on's default unit amount. If the plan add-on's `tier_type` is `tiered`, `volume`, or `stairstep`, then `unit_amount_decimal` cannot be provided. Only supported when the plan add-on's `add_on_type` = `usage`. If `unit_amount_decimal` is provided, `unit_amount` cannot be provided.
|
39
|
+
define_attribute :unit_amount_decimal, String
|
40
|
+
|
41
|
+
# @!attribute usage_percentage
|
42
|
+
# @return [Float] The percentage taken of the monetary amount of usage tracked. This can be up to 4 decimal places. A value between 0.0 and 100.0. Required if `add_on_type` is usage and `usage_type` is percentage. Must be omitted otherwise. `usage_percentage` does not support tiers. See our [Guide](https://developers.recurly.com/guides/usage-based-billing-guide.html) for an overview of how to configure usage add-ons.
|
43
|
+
define_attribute :usage_percentage, Float
|
44
|
+
end
|
45
|
+
end
|
46
|
+
end
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# This file is automatically created by Recurly's OpenAPI generation process
|
2
|
+
# and thus any edits you make by hand will be lost. If you wish to make a
|
3
|
+
# change to this file, please create a Github issue explaining the changes you
|
4
|
+
# need and we will usher them to the appropriate places.
|
5
|
+
module Recurly
|
6
|
+
module Requests
|
7
|
+
class SubscriptionAddOnPercentageTier < Request
|
8
|
+
|
9
|
+
# @!attribute ending_amount
|
10
|
+
# @return [Float] Ending amount for the tier. Allows up to 2 decimal places. Must be left empty if it is the final tier.
|
11
|
+
define_attribute :ending_amount, Float
|
12
|
+
|
13
|
+
# @!attribute usage_percentage
|
14
|
+
# @return [String] The percentage taken of the monetary amount of usage tracked. This can be up to 4 decimal places represented as a string.
|
15
|
+
define_attribute :usage_percentage, String
|
16
|
+
end
|
17
|
+
end
|
18
|
+
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 Requests
|
7
|
+
class SubscriptionAddOnTier < Request
|
8
|
+
|
9
|
+
# @!attribute ending_quantity
|
10
|
+
# @return [Integer] Ending quantity for the tier. This represents a unit amount for unit-priced add ons. Must be left empty if it is the final tier.
|
11
|
+
define_attribute :ending_quantity, Integer
|
12
|
+
|
13
|
+
# @!attribute 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
|
+
define_attribute :unit_amount, Float
|
16
|
+
|
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. If add-on's `add_on_type` is `usage` and `usage_type` is `percentage`, cannot be provided.
|
19
|
+
define_attribute :unit_amount_decimal, String
|
20
|
+
|
21
|
+
# @!attribute usage_percentage
|
22
|
+
# @return [String] (deprecated) -- Use the percentage_tiers object instead.
|
23
|
+
define_attribute :usage_percentage, String
|
24
|
+
end
|
25
|
+
end
|
26
|
+
end
|
@@ -0,0 +1,50 @@
|
|
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 SubscriptionAddOnUpdate < Request
|
8
|
+
|
9
|
+
# @!attribute add_on_source
|
10
|
+
# @return [String] Used to determine where the associated add-on data is pulled from. If this value is set to `plan_add_on` or left blank, then add-on data will be pulled from the plan's add-ons. If the associated `plan` has `allow_any_item_on_subscriptions` set to `true` and this field is set to `item`, then the associated add-on data will be pulled from the site's item catalog.
|
11
|
+
define_attribute :add_on_source, String
|
12
|
+
|
13
|
+
# @!attribute code
|
14
|
+
# @return [String] If a code is provided without an id, the subscription add-on attributes will be set to the current value for those attributes on the plan add-on unless provided in the request. If `add_on_source` is set to `plan_add_on` or left blank, then plan's add-on `code` should be used. If `add_on_source` is set to `item`, then the `code` from the associated item should be used.
|
15
|
+
define_attribute :code, String
|
16
|
+
|
17
|
+
# @!attribute id
|
18
|
+
# @return [String] When an id is provided, the existing subscription add-on attributes will persist unless overridden in the request.
|
19
|
+
define_attribute :id, String
|
20
|
+
|
21
|
+
# @!attribute percentage_tiers
|
22
|
+
# @return [Array[SubscriptionAddOnPercentageTier]] If percentage tiers are provided in the request, all existing percentage tiers on the Subscription Add-on will be removed and replaced by the percentage tiers in the request. Use only if add_on.tier_type is tiered or volume and add_on.usage_type is percentage. There must be one tier without an `ending_amount` value which represents the final tier.
|
23
|
+
define_attribute :percentage_tiers, Array, { :item_type => :SubscriptionAddOnPercentageTier }
|
24
|
+
|
25
|
+
# @!attribute quantity
|
26
|
+
# @return [Integer] Quantity
|
27
|
+
define_attribute :quantity, Integer
|
28
|
+
|
29
|
+
# @!attribute revenue_schedule_type
|
30
|
+
# @return [String] Revenue schedule type
|
31
|
+
define_attribute :revenue_schedule_type, String
|
32
|
+
|
33
|
+
# @!attribute tiers
|
34
|
+
# @return [Array[SubscriptionAddOnTier]] If the plan add-on's `tier_type` is `flat`, then `tiers` must be absent. The `tiers` object must include one to many tiers with `ending_quantity` and `unit_amount`. There must be one tier without an `ending_quantity` value which represents the final tier.
|
35
|
+
define_attribute :tiers, Array, { :item_type => :SubscriptionAddOnTier }
|
36
|
+
|
37
|
+
# @!attribute unit_amount
|
38
|
+
# @return [Float] Allows up to 2 decimal places. Optionally, override the add-on's default unit amount. If the plan add-on's `tier_type` is `tiered`, `volume`, or `stairstep`, then `unit_amount` cannot be provided.
|
39
|
+
define_attribute :unit_amount, Float
|
40
|
+
|
41
|
+
# @!attribute unit_amount_decimal
|
42
|
+
# @return [String] Allows up to 9 decimal places. Optionally, override the add-on's default unit amount. If the plan add-on's `tier_type` is `tiered`, `volume`, or `stairstep`, then `unit_amount_decimal` cannot be provided. Only supported when the plan add-on's `add_on_type` = `usage`. If `unit_amount_decimal` is provided, `unit_amount` cannot be provided.
|
43
|
+
define_attribute :unit_amount_decimal, String
|
44
|
+
|
45
|
+
# @!attribute usage_percentage
|
46
|
+
# @return [Float] The percentage taken of the monetary amount of usage tracked. This can be up to 4 decimal places. A value between 0.0 and 100.0. Required if add_on_type is usage and usage_type is percentage.
|
47
|
+
define_attribute :usage_percentage, Float
|
48
|
+
end
|
49
|
+
end
|
50
|
+
end
|
@@ -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 SubscriptionCancel < Request
|
8
|
+
|
9
|
+
# @!attribute timeframe
|
10
|
+
# @return [String] The timeframe parameter controls when the expiration takes place. The `bill_date` timeframe causes the subscription to expire when the subscription is scheduled to bill next. The `term_end` timeframe causes the subscription to continue to bill until the end of the subscription term, then expire.
|
11
|
+
define_attribute :timeframe, String
|
12
|
+
end
|
13
|
+
end
|
14
|
+
end
|
@@ -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 SubscriptionChangeBillingInfoCreate < Request
|
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
|