orb-billing 1.0.1 → 1.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +35 -0
- data/README.md +1 -1
- data/lib/orb/errors.rb +22 -0
- data/lib/orb/internal/type/array_of.rb +6 -1
- data/lib/orb/internal/type/base_model.rb +79 -25
- data/lib/orb/internal/type/boolean.rb +7 -1
- data/lib/orb/internal/type/converter.rb +42 -34
- data/lib/orb/internal/type/enum.rb +10 -2
- data/lib/orb/internal/type/file_input.rb +6 -1
- data/lib/orb/internal/type/hash_of.rb +6 -1
- data/lib/orb/internal/type/union.rb +12 -7
- data/lib/orb/internal/type/unknown.rb +7 -1
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +4 -4
- data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +4 -4
- data/lib/orb/models/invoice.rb +4 -1
- data/lib/orb/models/invoice_fetch_upcoming_response.rb +4 -1
- data/lib/orb/models/invoice_line_item_create_response.rb +4 -1
- data/lib/orb/models/monetary_amount_discount_adjustment.rb +10 -1
- data/lib/orb/models/monetary_maximum_adjustment.rb +10 -1
- data/lib/orb/models/monetary_minimum_adjustment.rb +10 -1
- data/lib/orb/models/monetary_percentage_discount_adjustment.rb +10 -1
- data/lib/orb/models/monetary_usage_discount_adjustment.rb +10 -1
- data/lib/orb/models/new_plan_bps_price.rb +10 -1
- data/lib/orb/models/new_plan_bulk_bps_price.rb +10 -1
- data/lib/orb/models/new_plan_bulk_price.rb +10 -1
- data/lib/orb/models/new_plan_bulk_with_proration_price.rb +10 -1
- data/lib/orb/models/new_plan_cumulative_grouped_bulk_price.rb +10 -1
- data/lib/orb/models/new_plan_grouped_allocation_price.rb +10 -1
- data/lib/orb/models/new_plan_grouped_tiered_package_price.rb +10 -1
- data/lib/orb/models/new_plan_grouped_tiered_price.rb +10 -1
- data/lib/orb/models/new_plan_grouped_with_metered_minimum_price.rb +10 -1
- data/lib/orb/models/new_plan_grouped_with_prorated_minimum_price.rb +10 -1
- data/lib/orb/models/new_plan_matrix_price.rb +10 -1
- data/lib/orb/models/new_plan_matrix_with_allocation_price.rb +10 -1
- data/lib/orb/models/new_plan_matrix_with_display_name_price.rb +10 -1
- data/lib/orb/models/new_plan_max_group_tiered_package_price.rb +10 -1
- data/lib/orb/models/new_plan_package_price.rb +10 -1
- data/lib/orb/models/new_plan_package_with_allocation_price.rb +10 -1
- data/lib/orb/models/new_plan_scalable_matrix_with_tiered_pricing_price.rb +10 -1
- data/lib/orb/models/new_plan_scalable_matrix_with_unit_pricing_price.rb +10 -1
- data/lib/orb/models/new_plan_threshold_total_amount_price.rb +10 -1
- data/lib/orb/models/new_plan_tier_with_proration_price.rb +10 -1
- data/lib/orb/models/new_plan_tiered_bps_price.rb +10 -1
- data/lib/orb/models/new_plan_tiered_package_price.rb +10 -1
- data/lib/orb/models/new_plan_tiered_package_with_minimum_price.rb +10 -1
- data/lib/orb/models/new_plan_tiered_price.rb +10 -1
- data/lib/orb/models/new_plan_tiered_with_minimum_price.rb +10 -1
- data/lib/orb/models/new_plan_unit_price.rb +10 -1
- data/lib/orb/models/new_plan_unit_with_percent_price.rb +10 -1
- data/lib/orb/models/new_plan_unit_with_proration_price.rb +10 -1
- data/lib/orb/models/plan_create_params.rb +185 -37
- data/lib/orb/models/plan_phase_amount_discount_adjustment.rb +10 -1
- data/lib/orb/models/plan_phase_maximum_adjustment.rb +10 -1
- data/lib/orb/models/plan_phase_minimum_adjustment.rb +10 -1
- data/lib/orb/models/plan_phase_percentage_discount_adjustment.rb +10 -1
- data/lib/orb/models/plan_phase_usage_discount_adjustment.rb +10 -1
- data/lib/orb/models/price.rb +280 -28
- data/lib/orb/resources/customers/credits/ledger.rb +6 -6
- data/lib/orb/resources/plans.rb +6 -2
- data/lib/orb/version.rb +1 -1
- data/rbi/orb/errors.rbi +16 -0
- data/rbi/orb/internal/type/boolean.rbi +2 -0
- data/rbi/orb/internal/type/converter.rbi +15 -15
- data/rbi/orb/internal/type/union.rbi +5 -0
- data/rbi/orb/internal/type/unknown.rbi +2 -0
- data/rbi/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +3 -3
- data/rbi/orb/models/customers/credits/ledger_create_entry_params.rbi +3 -3
- data/rbi/orb/models/invoice.rbi +2 -0
- data/rbi/orb/models/invoice_fetch_upcoming_response.rbi +2 -0
- data/rbi/orb/models/invoice_line_item_create_response.rbi +2 -0
- data/rbi/orb/models/monetary_amount_discount_adjustment.rbi +13 -3
- data/rbi/orb/models/monetary_maximum_adjustment.rbi +13 -3
- data/rbi/orb/models/monetary_minimum_adjustment.rbi +13 -3
- data/rbi/orb/models/monetary_percentage_discount_adjustment.rbi +13 -3
- data/rbi/orb/models/monetary_usage_discount_adjustment.rbi +10 -0
- data/rbi/orb/models/new_plan_bps_price.rbi +13 -3
- data/rbi/orb/models/new_plan_bulk_bps_price.rbi +13 -3
- data/rbi/orb/models/new_plan_bulk_price.rbi +13 -3
- data/rbi/orb/models/new_plan_bulk_with_proration_price.rbi +13 -3
- data/rbi/orb/models/new_plan_cumulative_grouped_bulk_price.rbi +13 -3
- data/rbi/orb/models/new_plan_grouped_allocation_price.rbi +13 -3
- data/rbi/orb/models/new_plan_grouped_tiered_package_price.rbi +13 -3
- data/rbi/orb/models/new_plan_grouped_tiered_price.rbi +13 -3
- data/rbi/orb/models/new_plan_grouped_with_metered_minimum_price.rbi +13 -3
- data/rbi/orb/models/new_plan_grouped_with_prorated_minimum_price.rbi +13 -3
- data/rbi/orb/models/new_plan_matrix_price.rbi +13 -3
- data/rbi/orb/models/new_plan_matrix_with_allocation_price.rbi +13 -3
- data/rbi/orb/models/new_plan_matrix_with_display_name_price.rbi +13 -3
- data/rbi/orb/models/new_plan_max_group_tiered_package_price.rbi +13 -3
- data/rbi/orb/models/new_plan_package_price.rbi +13 -3
- data/rbi/orb/models/new_plan_package_with_allocation_price.rbi +13 -3
- data/rbi/orb/models/new_plan_scalable_matrix_with_tiered_pricing_price.rbi +13 -3
- data/rbi/orb/models/new_plan_scalable_matrix_with_unit_pricing_price.rbi +13 -3
- data/rbi/orb/models/new_plan_threshold_total_amount_price.rbi +13 -3
- data/rbi/orb/models/new_plan_tier_with_proration_price.rbi +13 -3
- data/rbi/orb/models/new_plan_tiered_bps_price.rbi +13 -3
- data/rbi/orb/models/new_plan_tiered_package_price.rbi +13 -3
- data/rbi/orb/models/new_plan_tiered_package_with_minimum_price.rbi +13 -3
- data/rbi/orb/models/new_plan_tiered_price.rbi +13 -3
- data/rbi/orb/models/new_plan_tiered_with_minimum_price.rbi +13 -3
- data/rbi/orb/models/new_plan_unit_price.rbi +13 -3
- data/rbi/orb/models/new_plan_unit_with_percent_price.rbi +13 -3
- data/rbi/orb/models/new_plan_unit_with_proration_price.rbi +13 -3
- data/rbi/orb/models/plan_create_params.rbi +415 -135
- data/rbi/orb/models/plan_phase_amount_discount_adjustment.rbi +13 -3
- data/rbi/orb/models/plan_phase_maximum_adjustment.rbi +13 -3
- data/rbi/orb/models/plan_phase_minimum_adjustment.rbi +13 -3
- data/rbi/orb/models/plan_phase_percentage_discount_adjustment.rbi +13 -3
- data/rbi/orb/models/plan_phase_usage_discount_adjustment.rbi +10 -0
- data/rbi/orb/models/price.rbi +280 -0
- data/rbi/orb/resources/customers/credits/ledger.rbi +6 -6
- data/rbi/orb/resources/plans.rbi +11 -33
- data/sig/orb/errors.rbs +9 -0
- data/sig/orb/internal/type/converter.rbs +7 -1
- data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbs +1 -1
- data/sig/orb/models/customers/credits/ledger_create_entry_params.rbs +1 -1
- data/sig/orb/models/monetary_amount_discount_adjustment.rbs +8 -3
- data/sig/orb/models/monetary_maximum_adjustment.rbs +8 -3
- data/sig/orb/models/monetary_minimum_adjustment.rbs +8 -3
- data/sig/orb/models/monetary_percentage_discount_adjustment.rbs +8 -3
- data/sig/orb/models/monetary_usage_discount_adjustment.rbs +5 -0
- data/sig/orb/models/new_plan_bps_price.rbs +8 -3
- data/sig/orb/models/new_plan_bulk_bps_price.rbs +8 -3
- data/sig/orb/models/new_plan_bulk_price.rbs +8 -3
- data/sig/orb/models/new_plan_bulk_with_proration_price.rbs +8 -3
- data/sig/orb/models/new_plan_cumulative_grouped_bulk_price.rbs +8 -3
- data/sig/orb/models/new_plan_grouped_allocation_price.rbs +8 -3
- data/sig/orb/models/new_plan_grouped_tiered_package_price.rbs +8 -3
- data/sig/orb/models/new_plan_grouped_tiered_price.rbs +8 -3
- data/sig/orb/models/new_plan_grouped_with_metered_minimum_price.rbs +8 -3
- data/sig/orb/models/new_plan_grouped_with_prorated_minimum_price.rbs +8 -3
- data/sig/orb/models/new_plan_matrix_price.rbs +8 -3
- data/sig/orb/models/new_plan_matrix_with_allocation_price.rbs +8 -3
- data/sig/orb/models/new_plan_matrix_with_display_name_price.rbs +8 -3
- data/sig/orb/models/new_plan_max_group_tiered_package_price.rbs +8 -3
- data/sig/orb/models/new_plan_package_price.rbs +8 -3
- data/sig/orb/models/new_plan_package_with_allocation_price.rbs +8 -3
- data/sig/orb/models/new_plan_scalable_matrix_with_tiered_pricing_price.rbs +8 -3
- data/sig/orb/models/new_plan_scalable_matrix_with_unit_pricing_price.rbs +8 -3
- data/sig/orb/models/new_plan_threshold_total_amount_price.rbs +8 -3
- data/sig/orb/models/new_plan_tier_with_proration_price.rbs +8 -3
- data/sig/orb/models/new_plan_tiered_bps_price.rbs +8 -3
- data/sig/orb/models/new_plan_tiered_package_price.rbs +8 -3
- data/sig/orb/models/new_plan_tiered_package_with_minimum_price.rbs +8 -3
- data/sig/orb/models/new_plan_tiered_price.rbs +8 -3
- data/sig/orb/models/new_plan_tiered_with_minimum_price.rbs +8 -3
- data/sig/orb/models/new_plan_unit_price.rbs +8 -3
- data/sig/orb/models/new_plan_unit_with_percent_price.rbs +8 -3
- data/sig/orb/models/new_plan_unit_with_proration_price.rbs +8 -3
- data/sig/orb/models/plan_create_params.rbs +156 -37
- data/sig/orb/models/plan_phase_amount_discount_adjustment.rbs +8 -3
- data/sig/orb/models/plan_phase_maximum_adjustment.rbs +8 -3
- data/sig/orb/models/plan_phase_minimum_adjustment.rbs +8 -3
- data/sig/orb/models/plan_phase_percentage_discount_adjustment.rbs +8 -3
- data/sig/orb/models/plan_phase_usage_discount_adjustment.rbs +5 -0
- data/sig/orb/models/price.rbs +140 -0
- data/sig/orb/resources/customers/credits/ledger.rbs +2 -2
- data/sig/orb/resources/plans.rbs +3 -1
- metadata +2 -2
@@ -113,7 +113,14 @@ module Orb
|
|
113
113
|
# @return [Hash{Symbol=>String, nil}, nil]
|
114
114
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
115
115
|
|
116
|
-
# @!
|
116
|
+
# @!attribute reference_id
|
117
|
+
# A transient ID that can be used to reference this price when adding adjustments
|
118
|
+
# in the same API call.
|
119
|
+
#
|
120
|
+
# @return [String, nil]
|
121
|
+
optional :reference_id, String, nil?: true
|
122
|
+
|
123
|
+
# @!method initialize(cadence:, item_id:, model_type:, name:, package_with_allocation_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, conversion_rate_config: nil, currency: nil, dimensional_price_configuration: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil)
|
117
124
|
# Some parameter documentations has been truncated, see
|
118
125
|
# {Orb::Models::NewPlanPackageWithAllocationPrice} for more details.
|
119
126
|
#
|
@@ -150,6 +157,8 @@ module Orb
|
|
150
157
|
# @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
151
158
|
#
|
152
159
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
160
|
+
#
|
161
|
+
# @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments
|
153
162
|
|
154
163
|
# The cadence to bill for this price on.
|
155
164
|
#
|
@@ -114,7 +114,14 @@ module Orb
|
|
114
114
|
# @return [Hash{Symbol=>String, nil}, nil]
|
115
115
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
116
116
|
|
117
|
-
# @!
|
117
|
+
# @!attribute reference_id
|
118
|
+
# A transient ID that can be used to reference this price when adding adjustments
|
119
|
+
# in the same API call.
|
120
|
+
#
|
121
|
+
# @return [String, nil]
|
122
|
+
optional :reference_id, String, nil?: true
|
123
|
+
|
124
|
+
# @!method initialize(cadence:, item_id:, model_type:, name:, scalable_matrix_with_tiered_pricing_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, conversion_rate_config: nil, currency: nil, dimensional_price_configuration: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil)
|
118
125
|
# Some parameter documentations has been truncated, see
|
119
126
|
# {Orb::Models::NewPlanScalableMatrixWithTieredPricingPrice} for more details.
|
120
127
|
#
|
@@ -151,6 +158,8 @@ module Orb
|
|
151
158
|
# @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
152
159
|
#
|
153
160
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
161
|
+
#
|
162
|
+
# @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments
|
154
163
|
|
155
164
|
# The cadence to bill for this price on.
|
156
165
|
#
|
@@ -114,7 +114,14 @@ module Orb
|
|
114
114
|
# @return [Hash{Symbol=>String, nil}, nil]
|
115
115
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
116
116
|
|
117
|
-
# @!
|
117
|
+
# @!attribute reference_id
|
118
|
+
# A transient ID that can be used to reference this price when adding adjustments
|
119
|
+
# in the same API call.
|
120
|
+
#
|
121
|
+
# @return [String, nil]
|
122
|
+
optional :reference_id, String, nil?: true
|
123
|
+
|
124
|
+
# @!method initialize(cadence:, item_id:, model_type:, name:, scalable_matrix_with_unit_pricing_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, conversion_rate_config: nil, currency: nil, dimensional_price_configuration: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil)
|
118
125
|
# Some parameter documentations has been truncated, see
|
119
126
|
# {Orb::Models::NewPlanScalableMatrixWithUnitPricingPrice} for more details.
|
120
127
|
#
|
@@ -151,6 +158,8 @@ module Orb
|
|
151
158
|
# @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
152
159
|
#
|
153
160
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
161
|
+
#
|
162
|
+
# @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments
|
154
163
|
|
155
164
|
# The cadence to bill for this price on.
|
156
165
|
#
|
@@ -113,7 +113,14 @@ module Orb
|
|
113
113
|
# @return [Hash{Symbol=>String, nil}, nil]
|
114
114
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
115
115
|
|
116
|
-
# @!
|
116
|
+
# @!attribute reference_id
|
117
|
+
# A transient ID that can be used to reference this price when adding adjustments
|
118
|
+
# in the same API call.
|
119
|
+
#
|
120
|
+
# @return [String, nil]
|
121
|
+
optional :reference_id, String, nil?: true
|
122
|
+
|
123
|
+
# @!method initialize(cadence:, item_id:, model_type:, name:, threshold_total_amount_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, conversion_rate_config: nil, currency: nil, dimensional_price_configuration: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil)
|
117
124
|
# Some parameter documentations has been truncated, see
|
118
125
|
# {Orb::Models::NewPlanThresholdTotalAmountPrice} for more details.
|
119
126
|
#
|
@@ -150,6 +157,8 @@ module Orb
|
|
150
157
|
# @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
151
158
|
#
|
152
159
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
160
|
+
#
|
161
|
+
# @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments
|
153
162
|
|
154
163
|
# The cadence to bill for this price on.
|
155
164
|
#
|
@@ -113,7 +113,14 @@ module Orb
|
|
113
113
|
# @return [Hash{Symbol=>String, nil}, nil]
|
114
114
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
115
115
|
|
116
|
-
# @!
|
116
|
+
# @!attribute reference_id
|
117
|
+
# A transient ID that can be used to reference this price when adding adjustments
|
118
|
+
# in the same API call.
|
119
|
+
#
|
120
|
+
# @return [String, nil]
|
121
|
+
optional :reference_id, String, nil?: true
|
122
|
+
|
123
|
+
# @!method initialize(cadence:, item_id:, model_type:, name:, tiered_with_proration_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, conversion_rate_config: nil, currency: nil, dimensional_price_configuration: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil)
|
117
124
|
# Some parameter documentations has been truncated, see
|
118
125
|
# {Orb::Models::NewPlanTierWithProrationPrice} for more details.
|
119
126
|
#
|
@@ -150,6 +157,8 @@ module Orb
|
|
150
157
|
# @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
151
158
|
#
|
152
159
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
160
|
+
#
|
161
|
+
# @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments
|
153
162
|
|
154
163
|
# The cadence to bill for this price on.
|
155
164
|
#
|
@@ -113,7 +113,14 @@ module Orb
|
|
113
113
|
# @return [Hash{Symbol=>String, nil}, nil]
|
114
114
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
115
115
|
|
116
|
-
# @!
|
116
|
+
# @!attribute reference_id
|
117
|
+
# A transient ID that can be used to reference this price when adding adjustments
|
118
|
+
# in the same API call.
|
119
|
+
#
|
120
|
+
# @return [String, nil]
|
121
|
+
optional :reference_id, String, nil?: true
|
122
|
+
|
123
|
+
# @!method initialize(cadence:, item_id:, model_type:, name:, tiered_bps_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, conversion_rate_config: nil, currency: nil, dimensional_price_configuration: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil)
|
117
124
|
# Some parameter documentations has been truncated, see
|
118
125
|
# {Orb::Models::NewPlanTieredBPSPrice} for more details.
|
119
126
|
#
|
@@ -150,6 +157,8 @@ module Orb
|
|
150
157
|
# @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
151
158
|
#
|
152
159
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
160
|
+
#
|
161
|
+
# @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments
|
153
162
|
|
154
163
|
# The cadence to bill for this price on.
|
155
164
|
#
|
@@ -113,7 +113,14 @@ module Orb
|
|
113
113
|
# @return [Hash{Symbol=>String, nil}, nil]
|
114
114
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
115
115
|
|
116
|
-
# @!
|
116
|
+
# @!attribute reference_id
|
117
|
+
# A transient ID that can be used to reference this price when adding adjustments
|
118
|
+
# in the same API call.
|
119
|
+
#
|
120
|
+
# @return [String, nil]
|
121
|
+
optional :reference_id, String, nil?: true
|
122
|
+
|
123
|
+
# @!method initialize(cadence:, item_id:, model_type:, name:, tiered_package_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, conversion_rate_config: nil, currency: nil, dimensional_price_configuration: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil)
|
117
124
|
# Some parameter documentations has been truncated, see
|
118
125
|
# {Orb::Models::NewPlanTieredPackagePrice} for more details.
|
119
126
|
#
|
@@ -150,6 +157,8 @@ module Orb
|
|
150
157
|
# @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
151
158
|
#
|
152
159
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
160
|
+
#
|
161
|
+
# @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments
|
153
162
|
|
154
163
|
# The cadence to bill for this price on.
|
155
164
|
#
|
@@ -113,7 +113,14 @@ module Orb
|
|
113
113
|
# @return [Hash{Symbol=>String, nil}, nil]
|
114
114
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
115
115
|
|
116
|
-
# @!
|
116
|
+
# @!attribute reference_id
|
117
|
+
# A transient ID that can be used to reference this price when adding adjustments
|
118
|
+
# in the same API call.
|
119
|
+
#
|
120
|
+
# @return [String, nil]
|
121
|
+
optional :reference_id, String, nil?: true
|
122
|
+
|
123
|
+
# @!method initialize(cadence:, item_id:, model_type:, name:, tiered_package_with_minimum_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, conversion_rate_config: nil, currency: nil, dimensional_price_configuration: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil)
|
117
124
|
# Some parameter documentations has been truncated, see
|
118
125
|
# {Orb::Models::NewPlanTieredPackageWithMinimumPrice} for more details.
|
119
126
|
#
|
@@ -150,6 +157,8 @@ module Orb
|
|
150
157
|
# @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
151
158
|
#
|
152
159
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
160
|
+
#
|
161
|
+
# @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments
|
153
162
|
|
154
163
|
# The cadence to bill for this price on.
|
155
164
|
#
|
@@ -115,7 +115,14 @@ module Orb
|
|
115
115
|
# @return [Hash{Symbol=>String, nil}, nil]
|
116
116
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
117
117
|
|
118
|
-
# @!
|
118
|
+
# @!attribute reference_id
|
119
|
+
# A transient ID that can be used to reference this price when adding adjustments
|
120
|
+
# in the same API call.
|
121
|
+
#
|
122
|
+
# @return [String, nil]
|
123
|
+
optional :reference_id, String, nil?: true
|
124
|
+
|
125
|
+
# @!method initialize(cadence:, item_id:, model_type:, name:, tiered_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, conversion_rate_config: nil, currency: nil, dimensional_price_configuration: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil)
|
119
126
|
# Some parameter documentations has been truncated, see
|
120
127
|
# {Orb::Models::NewPlanTieredPrice} for more details.
|
121
128
|
#
|
@@ -152,6 +159,8 @@ module Orb
|
|
152
159
|
# @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
153
160
|
#
|
154
161
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
162
|
+
#
|
163
|
+
# @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments
|
155
164
|
|
156
165
|
# The cadence to bill for this price on.
|
157
166
|
#
|
@@ -113,7 +113,14 @@ module Orb
|
|
113
113
|
# @return [Hash{Symbol=>String, nil}, nil]
|
114
114
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
115
115
|
|
116
|
-
# @!
|
116
|
+
# @!attribute reference_id
|
117
|
+
# A transient ID that can be used to reference this price when adding adjustments
|
118
|
+
# in the same API call.
|
119
|
+
#
|
120
|
+
# @return [String, nil]
|
121
|
+
optional :reference_id, String, nil?: true
|
122
|
+
|
123
|
+
# @!method initialize(cadence:, item_id:, model_type:, name:, tiered_with_minimum_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, conversion_rate_config: nil, currency: nil, dimensional_price_configuration: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil)
|
117
124
|
# Some parameter documentations has been truncated, see
|
118
125
|
# {Orb::Models::NewPlanTieredWithMinimumPrice} for more details.
|
119
126
|
#
|
@@ -150,6 +157,8 @@ module Orb
|
|
150
157
|
# @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
151
158
|
#
|
152
159
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
160
|
+
#
|
161
|
+
# @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments
|
153
162
|
|
154
163
|
# The cadence to bill for this price on.
|
155
164
|
#
|
@@ -111,7 +111,14 @@ module Orb
|
|
111
111
|
# @return [Hash{Symbol=>String, nil}, nil]
|
112
112
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
113
113
|
|
114
|
-
# @!
|
114
|
+
# @!attribute reference_id
|
115
|
+
# A transient ID that can be used to reference this price when adding adjustments
|
116
|
+
# in the same API call.
|
117
|
+
#
|
118
|
+
# @return [String, nil]
|
119
|
+
optional :reference_id, String, nil?: true
|
120
|
+
|
121
|
+
# @!method initialize(cadence:, item_id:, model_type:, name:, unit_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, conversion_rate_config: nil, currency: nil, dimensional_price_configuration: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil)
|
115
122
|
# Some parameter documentations has been truncated, see
|
116
123
|
# {Orb::Models::NewPlanUnitPrice} for more details.
|
117
124
|
#
|
@@ -148,6 +155,8 @@ module Orb
|
|
148
155
|
# @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
149
156
|
#
|
150
157
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
158
|
+
#
|
159
|
+
# @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments
|
151
160
|
|
152
161
|
# The cadence to bill for this price on.
|
153
162
|
#
|
@@ -113,7 +113,14 @@ module Orb
|
|
113
113
|
# @return [Hash{Symbol=>String, nil}, nil]
|
114
114
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
115
115
|
|
116
|
-
# @!
|
116
|
+
# @!attribute reference_id
|
117
|
+
# A transient ID that can be used to reference this price when adding adjustments
|
118
|
+
# in the same API call.
|
119
|
+
#
|
120
|
+
# @return [String, nil]
|
121
|
+
optional :reference_id, String, nil?: true
|
122
|
+
|
123
|
+
# @!method initialize(cadence:, item_id:, model_type:, name:, unit_with_percent_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, conversion_rate_config: nil, currency: nil, dimensional_price_configuration: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil)
|
117
124
|
# Some parameter documentations has been truncated, see
|
118
125
|
# {Orb::Models::NewPlanUnitWithPercentPrice} for more details.
|
119
126
|
#
|
@@ -150,6 +157,8 @@ module Orb
|
|
150
157
|
# @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
151
158
|
#
|
152
159
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
160
|
+
#
|
161
|
+
# @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments
|
153
162
|
|
154
163
|
# The cadence to bill for this price on.
|
155
164
|
#
|
@@ -113,7 +113,14 @@ module Orb
|
|
113
113
|
# @return [Hash{Symbol=>String, nil}, nil]
|
114
114
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
115
115
|
|
116
|
-
# @!
|
116
|
+
# @!attribute reference_id
|
117
|
+
# A transient ID that can be used to reference this price when adding adjustments
|
118
|
+
# in the same API call.
|
119
|
+
#
|
120
|
+
# @return [String, nil]
|
121
|
+
optional :reference_id, String, nil?: true
|
122
|
+
|
123
|
+
# @!method initialize(cadence:, item_id:, model_type:, name:, unit_with_proration_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, conversion_rate_config: nil, currency: nil, dimensional_price_configuration: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, reference_id: nil)
|
117
124
|
# Some parameter documentations has been truncated, see
|
118
125
|
# {Orb::Models::NewPlanUnitWithProrationPrice} for more details.
|
119
126
|
#
|
@@ -150,6 +157,8 @@ module Orb
|
|
150
157
|
# @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
151
158
|
#
|
152
159
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
160
|
+
#
|
161
|
+
# @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments
|
153
162
|
|
154
163
|
# The cadence to bill for this price on.
|
155
164
|
#
|