orb-billing 0.12.0 → 1.0.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 +20 -0
- data/README.md +1 -1
- data/lib/orb/internal/type/base_model.rb +5 -5
- data/lib/orb/models/accounting_provider_config.rb +21 -0
- data/lib/orb/models/address.rb +45 -0
- data/lib/orb/models/address_input.rb +45 -0
- data/lib/orb/models/adjustment_interval.rb +66 -0
- data/lib/orb/models/aggregated_cost.rb +45 -0
- data/lib/orb/models/alert.rb +9 -60
- data/lib/orb/models/alert_create_for_customer_params.rb +3 -24
- data/lib/orb/models/alert_create_for_external_customer_params.rb +3 -24
- data/lib/orb/models/alert_create_for_subscription_params.rb +3 -23
- data/lib/orb/models/alert_update_params.rb +3 -22
- data/lib/orb/models/allocation.rb +27 -0
- data/lib/orb/models/amount_discount.rb +3 -59
- data/lib/orb/models/amount_discount_interval.rb +65 -0
- data/lib/orb/models/beta/external_plan_id_create_plan_version_params.rb +193 -19201
- data/lib/orb/models/beta_create_plan_version_params.rb +183 -19025
- data/lib/orb/models/billable_metric_tiny.rb +15 -0
- data/lib/orb/models/billing_cycle_anchor_configuration.rb +41 -0
- data/lib/orb/models/billing_cycle_configuration.rb +32 -0
- data/lib/orb/models/bps_config.rb +24 -0
- data/lib/orb/models/bps_tier.rb +40 -0
- data/lib/orb/models/bulk_bps_config.rb +20 -0
- data/lib/orb/models/bulk_bps_tier.rb +32 -0
- data/lib/orb/models/bulk_config.rb +16 -0
- data/lib/orb/models/bulk_tier.rb +24 -0
- data/lib/orb/models/changed_subscription_resources.rb +40 -0
- data/lib/orb/models/conversion_rate_tier.rb +32 -0
- data/lib/orb/models/conversion_rate_tiered_config.rb +16 -0
- data/lib/orb/models/conversion_rate_unit_config.rb +16 -0
- data/lib/orb/models/coupon_redemption.rb +27 -0
- data/lib/orb/models/credit_note.rb +6 -51
- data/lib/orb/models/credit_note_tiny.rb +16 -0
- data/lib/orb/models/custom_expiration.rb +32 -0
- data/lib/orb/models/customer.rb +15 -426
- data/lib/orb/models/customer_create_params.rb +24 -527
- data/lib/orb/models/customer_hierarchy_config.rb +29 -0
- data/lib/orb/models/customer_minified.rb +21 -0
- data/lib/orb/models/customer_tax_id.rb +300 -0
- data/lib/orb/models/customer_update_by_external_id_params.rb +24 -529
- data/lib/orb/models/customer_update_params.rb +24 -527
- data/lib/orb/models/customers/balance_transaction_create_response.rb +6 -32
- data/lib/orb/models/customers/balance_transaction_list_response.rb +6 -32
- data/lib/orb/models/customers/cost_list_by_external_id_response.rb +3 -88
- data/lib/orb/models/customers/cost_list_response.rb +3 -87
- data/lib/orb/models/customers/credits/affected_block.rb +31 -0
- data/lib/orb/models/customers/credits/amendment_ledger_entry.rb +131 -0
- data/lib/orb/models/customers/credits/credit_block_expiry_ledger_entry.rb +137 -0
- data/lib/orb/models/customers/credits/decrement_ledger_entry.rb +152 -0
- data/lib/orb/models/customers/credits/expiration_change_ledger_entry.rb +141 -0
- data/lib/orb/models/customers/credits/increment_ledger_entry.rb +139 -0
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +8 -1177
- data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +8 -1169
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +8 -1173
- data/lib/orb/models/customers/credits/ledger_list_response.rb +8 -1161
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb +3 -52
- data/lib/orb/models/customers/credits/top_up_create_response.rb +3 -51
- data/lib/orb/models/customers/credits/top_up_invoice_settings.rb +53 -0
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb +3 -52
- data/lib/orb/models/customers/credits/top_up_list_response.rb +3 -51
- data/lib/orb/models/customers/credits/void_initiated_ledger_entry.rb +152 -0
- data/lib/orb/models/customers/credits/void_ledger_entry.rb +145 -0
- data/lib/orb/models/dimensional_price_configuration.rb +21 -0
- data/lib/orb/models/discount_override.rb +56 -0
- data/lib/orb/models/fixed_fee_quantity_schedule_entry.rb +33 -0
- data/lib/orb/models/fixed_fee_quantity_transition.rb +27 -0
- data/lib/orb/models/invoice.rb +56 -1777
- data/lib/orb/models/invoice_create_params.rb +3 -15
- data/lib/orb/models/invoice_fetch_upcoming_response.rb +56 -1794
- data/lib/orb/models/invoice_line_item_create_response.rb +25 -1142
- data/lib/orb/models/invoice_tiny.rb +16 -0
- data/lib/orb/models/item_slim.rb +21 -0
- data/lib/orb/models/matrix_config.rb +32 -0
- data/lib/orb/models/matrix_sub_line_item.rb +61 -0
- data/lib/orb/models/matrix_value.rb +29 -0
- data/lib/orb/models/matrix_with_allocation_config.rb +40 -0
- data/lib/orb/models/maximum.rb +38 -0
- data/lib/orb/models/maximum_interval.rb +52 -0
- data/lib/orb/models/minimum.rb +38 -0
- data/lib/orb/models/minimum_interval.rb +52 -0
- data/lib/orb/models/monetary_amount_discount_adjustment.rb +87 -0
- data/lib/orb/models/monetary_maximum_adjustment.rb +87 -0
- data/lib/orb/models/monetary_minimum_adjustment.rb +95 -0
- data/lib/orb/models/monetary_percentage_discount_adjustment.rb +87 -0
- data/lib/orb/models/monetary_usage_discount_adjustment.rb +87 -0
- data/lib/orb/models/mutated_subscription.rb +302 -0
- data/lib/orb/models/new_accounting_sync_configuration.rb +23 -0
- data/lib/orb/models/new_allocation_price.rb +70 -0
- data/lib/orb/models/new_amount_discount.rb +120 -0
- data/lib/orb/models/new_avalara_tax_configuration.rb +37 -0
- data/lib/orb/models/new_billing_cycle_configuration.rb +37 -0
- data/lib/orb/models/new_dimensional_price_configuration.rb +36 -0
- data/lib/orb/models/new_floating_bps_price.rb +199 -0
- data/lib/orb/models/new_floating_bulk_bps_price.rb +197 -0
- data/lib/orb/models/new_floating_bulk_price.rb +197 -0
- data/lib/orb/models/new_floating_bulk_with_proration_price.rb +197 -0
- data/lib/orb/models/new_floating_cumulative_grouped_bulk_price.rb +197 -0
- data/lib/orb/models/new_floating_grouped_allocation_price.rb +197 -0
- data/lib/orb/models/new_floating_grouped_tiered_package_price.rb +197 -0
- data/lib/orb/models/new_floating_grouped_tiered_price.rb +197 -0
- data/lib/orb/models/new_floating_grouped_with_metered_minimum_price.rb +197 -0
- data/lib/orb/models/new_floating_grouped_with_prorated_minimum_price.rb +198 -0
- data/lib/orb/models/new_floating_matrix_price.rb +197 -0
- data/lib/orb/models/new_floating_matrix_with_allocation_price.rb +197 -0
- data/lib/orb/models/new_floating_matrix_with_display_name_price.rb +197 -0
- data/lib/orb/models/new_floating_max_group_tiered_package_price.rb +197 -0
- data/lib/orb/models/new_floating_package_price.rb +197 -0
- data/lib/orb/models/new_floating_package_with_allocation_price.rb +197 -0
- data/lib/orb/models/new_floating_scalable_matrix_with_tiered_pricing_price.rb +198 -0
- data/lib/orb/models/new_floating_scalable_matrix_with_unit_pricing_price.rb +198 -0
- data/lib/orb/models/new_floating_threshold_total_amount_price.rb +197 -0
- data/lib/orb/models/new_floating_tiered_bps_price.rb +197 -0
- data/lib/orb/models/new_floating_tiered_package_price.rb +197 -0
- data/lib/orb/models/new_floating_tiered_package_with_minimum_price.rb +197 -0
- data/lib/orb/models/new_floating_tiered_price.rb +197 -0
- data/lib/orb/models/new_floating_tiered_with_minimum_price.rb +197 -0
- data/lib/orb/models/new_floating_tiered_with_proration_price.rb +197 -0
- data/lib/orb/models/new_floating_unit_price.rb +197 -0
- data/lib/orb/models/new_floating_unit_with_percent_price.rb +197 -0
- data/lib/orb/models/new_floating_unit_with_proration_price.rb +197 -0
- data/lib/orb/models/new_maximum.rb +120 -0
- data/lib/orb/models/new_minimum.rb +128 -0
- data/lib/orb/models/new_percentage_discount.rb +120 -0
- data/lib/orb/models/new_plan_bps_price.rb +196 -0
- data/lib/orb/models/new_plan_bulk_bps_price.rb +200 -0
- data/lib/orb/models/new_plan_bulk_price.rb +196 -0
- data/lib/orb/models/new_plan_bulk_with_proration_price.rb +198 -0
- data/lib/orb/models/new_plan_cumulative_grouped_bulk_price.rb +198 -0
- data/lib/orb/models/new_plan_grouped_allocation_price.rb +198 -0
- data/lib/orb/models/new_plan_grouped_tiered_package_price.rb +198 -0
- data/lib/orb/models/new_plan_grouped_tiered_price.rb +198 -0
- data/lib/orb/models/new_plan_grouped_with_metered_minimum_price.rb +198 -0
- data/lib/orb/models/new_plan_grouped_with_prorated_minimum_price.rb +199 -0
- data/lib/orb/models/new_plan_matrix_price.rb +200 -0
- data/lib/orb/models/new_plan_matrix_with_allocation_price.rb +198 -0
- data/lib/orb/models/new_plan_matrix_with_display_name_price.rb +198 -0
- data/lib/orb/models/new_plan_max_group_tiered_package_price.rb +198 -0
- data/lib/orb/models/new_plan_package_price.rb +200 -0
- data/lib/orb/models/new_plan_package_with_allocation_price.rb +198 -0
- data/lib/orb/models/new_plan_scalable_matrix_with_tiered_pricing_price.rb +199 -0
- data/lib/orb/models/new_plan_scalable_matrix_with_unit_pricing_price.rb +199 -0
- data/lib/orb/models/new_plan_threshold_total_amount_price.rb +198 -0
- data/lib/orb/models/new_plan_tier_with_proration_price.rb +198 -0
- data/lib/orb/models/new_plan_tiered_bps_price.rb +198 -0
- data/lib/orb/models/new_plan_tiered_package_price.rb +198 -0
- data/lib/orb/models/new_plan_tiered_package_with_minimum_price.rb +198 -0
- data/lib/orb/models/new_plan_tiered_price.rb +200 -0
- data/lib/orb/models/new_plan_tiered_with_minimum_price.rb +198 -0
- data/lib/orb/models/new_plan_unit_price.rb +196 -0
- data/lib/orb/models/new_plan_unit_with_percent_price.rb +198 -0
- data/lib/orb/models/new_plan_unit_with_proration_price.rb +198 -0
- data/lib/orb/models/new_reporting_configuration.rb +15 -0
- data/lib/orb/models/new_sphere_configuration.rb +31 -0
- data/lib/orb/models/new_subscription_bps_price.rb +207 -0
- data/lib/orb/models/new_subscription_bulk_bps_price.rb +207 -0
- data/lib/orb/models/new_subscription_bulk_price.rb +207 -0
- data/lib/orb/models/new_subscription_bulk_with_proration_price.rb +207 -0
- data/lib/orb/models/new_subscription_cumulative_grouped_bulk_price.rb +207 -0
- data/lib/orb/models/new_subscription_grouped_allocation_price.rb +207 -0
- data/lib/orb/models/new_subscription_grouped_tiered_package_price.rb +207 -0
- data/lib/orb/models/new_subscription_grouped_tiered_price.rb +207 -0
- data/lib/orb/models/new_subscription_grouped_with_metered_minimum_price.rb +207 -0
- data/lib/orb/models/new_subscription_grouped_with_prorated_minimum_price.rb +208 -0
- data/lib/orb/models/new_subscription_matrix_price.rb +207 -0
- data/lib/orb/models/new_subscription_matrix_with_allocation_price.rb +207 -0
- data/lib/orb/models/new_subscription_matrix_with_display_name_price.rb +207 -0
- data/lib/orb/models/new_subscription_max_group_tiered_package_price.rb +207 -0
- data/lib/orb/models/new_subscription_package_price.rb +207 -0
- data/lib/orb/models/new_subscription_package_with_allocation_price.rb +207 -0
- data/lib/orb/models/new_subscription_scalable_matrix_with_tiered_pricing_price.rb +209 -0
- data/lib/orb/models/new_subscription_scalable_matrix_with_unit_pricing_price.rb +209 -0
- data/lib/orb/models/new_subscription_threshold_total_amount_price.rb +207 -0
- data/lib/orb/models/new_subscription_tier_with_proration_price.rb +207 -0
- data/lib/orb/models/new_subscription_tiered_bps_price.rb +207 -0
- data/lib/orb/models/new_subscription_tiered_package_price.rb +207 -0
- data/lib/orb/models/new_subscription_tiered_package_with_minimum_price.rb +207 -0
- data/lib/orb/models/new_subscription_tiered_price.rb +207 -0
- data/lib/orb/models/new_subscription_tiered_with_minimum_price.rb +207 -0
- data/lib/orb/models/new_subscription_unit_price.rb +207 -0
- data/lib/orb/models/new_subscription_unit_with_percent_price.rb +207 -0
- data/lib/orb/models/new_subscription_unit_with_proration_price.rb +207 -0
- data/lib/orb/models/new_tax_jar_configuration.rb +31 -0
- data/lib/orb/models/new_usage_discount.rb +120 -0
- data/lib/orb/models/other_sub_line_item.rb +54 -0
- data/lib/orb/models/package_config.rb +28 -0
- data/lib/orb/models/per_price_cost.rb +48 -0
- data/lib/orb/models/percentage_discount.rb +3 -59
- data/lib/orb/models/percentage_discount_interval.rb +69 -0
- data/lib/orb/models/plan.rb +22 -1040
- data/lib/orb/models/plan_create_params.rb +31 -8145
- data/lib/orb/models/plan_phase_amount_discount_adjustment.rb +87 -0
- data/lib/orb/models/plan_phase_maximum_adjustment.rb +87 -0
- data/lib/orb/models/plan_phase_minimum_adjustment.rb +95 -0
- data/lib/orb/models/plan_phase_percentage_discount_adjustment.rb +87 -0
- data/lib/orb/models/plan_phase_usage_discount_adjustment.rb +87 -0
- data/lib/orb/models/plan_version.rb +10 -672
- data/lib/orb/models/price.rb +1225 -10817
- data/lib/orb/models/price_create_params.rb +53 -472
- data/lib/orb/models/price_evaluate_multiple_params.rb +32 -8479
- data/lib/orb/models/price_evaluate_preview_events_params.rb +236 -0
- data/lib/orb/models/price_evaluate_preview_events_response.rb +51 -0
- data/lib/orb/models/price_interval.rb +113 -0
- data/lib/orb/models/sub_line_item_grouping.rb +23 -0
- data/lib/orb/models/sub_line_item_matrix_config.rb +16 -0
- data/lib/orb/models/subscription.rb +33 -1581
- data/lib/orb/models/subscription_change_apply_response.rb +3 -1904
- data/lib/orb/models/subscription_change_cancel_response.rb +3 -1905
- data/lib/orb/models/subscription_change_minified.rb +15 -0
- data/lib/orb/models/subscription_change_retrieve_response.rb +3 -1906
- data/lib/orb/models/subscription_create_params.rb +232 -19698
- data/lib/orb/models/subscription_fetch_costs_response.rb +3 -87
- data/lib/orb/models/subscription_minified.rb +15 -0
- data/lib/orb/models/subscription_price_intervals_params.rb +86 -9468
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +238 -19792
- data/lib/orb/models/subscription_trial_info.rb +15 -0
- data/lib/orb/models/tax_amount.rb +32 -0
- data/lib/orb/models/threshold.rb +24 -0
- data/lib/orb/models/tier.rb +32 -0
- data/lib/orb/models/tier_config.rb +27 -0
- data/lib/orb/models/tier_sub_line_item.rb +61 -0
- data/lib/orb/models/tiered_bps_config.rb +20 -0
- data/lib/orb/models/tiered_config.rb +16 -0
- data/lib/orb/models/tiered_conversion_rate_config.rb +31 -0
- data/lib/orb/models/transform_price_filter.rb +61 -0
- data/lib/orb/models/trial_discount.rb +3 -59
- data/lib/orb/models/unit_config.rb +16 -0
- data/lib/orb/models/unit_conversion_rate_config.rb +31 -0
- data/lib/orb/models/usage_discount.rb +3 -59
- data/lib/orb/models/usage_discount_interval.rb +69 -0
- data/lib/orb/models.rb +348 -0
- data/lib/orb/resources/alerts.rb +4 -4
- data/lib/orb/resources/customers/credits/ledger.rb +4 -4
- data/lib/orb/resources/customers.rb +21 -21
- data/lib/orb/resources/plans.rb +1 -1
- data/lib/orb/resources/prices/external_price_id.rb +2 -2
- data/lib/orb/resources/prices.rb +82 -34
- data/lib/orb/resources/subscriptions.rb +24 -24
- data/lib/orb/version.rb +1 -1
- data/lib/orb.rb +181 -11
- data/rbi/orb/models/accounting_provider_config.rbi +34 -0
- data/rbi/orb/models/address.rbi +55 -0
- data/rbi/orb/models/address_input.rbi +62 -0
- data/rbi/orb/models/adjustment_interval.rbi +93 -0
- data/rbi/orb/models/aggregated_cost.rbi +61 -0
- data/rbi/orb/models/alert.rbi +11 -84
- data/rbi/orb/models/alert_create_for_customer_params.rbi +3 -42
- data/rbi/orb/models/alert_create_for_external_customer_params.rbi +3 -48
- data/rbi/orb/models/alert_create_for_subscription_params.rbi +3 -38
- data/rbi/orb/models/alert_update_params.rbi +3 -31
- data/rbi/orb/models/allocation.rbi +45 -0
- data/rbi/orb/models/amount_discount.rbi +3 -112
- data/rbi/orb/models/amount_discount_interval.rbi +100 -0
- data/rbi/orb/models/beta/external_plan_id_create_plan_version_params.rbi +558 -35618
- data/rbi/orb/models/beta_create_plan_version_params.rbi +558 -35610
- data/rbi/orb/models/billable_metric_tiny.rbi +21 -0
- data/rbi/orb/models/billing_cycle_anchor_configuration.rbi +61 -0
- data/rbi/orb/models/billing_cycle_configuration.rbi +70 -0
- data/rbi/orb/models/bps_config.rbi +36 -0
- data/rbi/orb/models/bps_tier.rbi +58 -0
- data/rbi/orb/models/bulk_bps_config.rbi +31 -0
- data/rbi/orb/models/bulk_bps_tier.rbi +50 -0
- data/rbi/orb/models/bulk_config.rbi +26 -0
- data/rbi/orb/models/bulk_tier.rbi +38 -0
- data/rbi/orb/models/changed_subscription_resources.rbi +61 -0
- data/rbi/orb/models/conversion_rate_tier.rbi +51 -0
- data/rbi/orb/models/conversion_rate_tiered_config.rbi +31 -0
- data/rbi/orb/models/conversion_rate_unit_config.rbi +27 -0
- data/rbi/orb/models/coupon_redemption.rbi +37 -0
- data/rbi/orb/models/credit_note.rbi +7 -87
- data/rbi/orb/models/credit_note_tiny.rbi +25 -0
- data/rbi/orb/models/custom_expiration.rbi +55 -0
- data/rbi/orb/models/customer.rbi +19 -522
- data/rbi/orb/models/customer_create_params.rbi +36 -957
- data/rbi/orb/models/customer_hierarchy_config.rbi +52 -0
- data/rbi/orb/models/customer_minified.rbi +32 -0
- data/rbi/orb/models/customer_tax_id.rbi +324 -0
- data/rbi/orb/models/customer_update_by_external_id_params.rbi +36 -1436
- data/rbi/orb/models/customer_update_params.rbi +36 -957
- data/rbi/orb/models/customers/balance_transaction_create_response.rbi +8 -96
- data/rbi/orb/models/customers/balance_transaction_list_response.rbi +8 -96
- data/rbi/orb/models/customers/cost_list_by_external_id_response.rbi +5 -191
- data/rbi/orb/models/customers/cost_list_response.rbi +5 -182
- data/rbi/orb/models/customers/credits/affected_block.rbi +50 -0
- data/rbi/orb/models/customers/credits/amendment_ledger_entry.rbi +207 -0
- data/rbi/orb/models/customers/credits/credit_block_expiry_ledger_entry.rbi +209 -0
- data/rbi/orb/models/customers/credits/decrement_ledger_entry.rbi +225 -0
- data/rbi/orb/models/customers/credits/expiration_change_ledger_entry.rbi +213 -0
- data/rbi/orb/models/customers/credits/increment_ledger_entry.rbi +215 -0
- data/rbi/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi +7 -1854
- data/rbi/orb/models/customers/credits/ledger_create_entry_response.rbi +7 -1854
- data/rbi/orb/models/customers/credits/ledger_list_by_external_id_response.rbi +7 -1854
- data/rbi/orb/models/customers/credits/ledger_list_response.rbi +7 -1854
- data/rbi/orb/models/customers/credits/top_up_create_by_external_id_response.rbi +4 -84
- data/rbi/orb/models/customers/credits/top_up_create_response.rbi +4 -84
- data/rbi/orb/models/customers/credits/top_up_invoice_settings.rbi +83 -0
- data/rbi/orb/models/customers/credits/top_up_list_by_external_id_response.rbi +4 -84
- data/rbi/orb/models/customers/credits/top_up_list_response.rbi +4 -84
- data/rbi/orb/models/customers/credits/void_initiated_ledger_entry.rbi +225 -0
- data/rbi/orb/models/customers/credits/void_ledger_entry.rbi +219 -0
- data/rbi/orb/models/dimensional_price_configuration.rbi +38 -0
- data/rbi/orb/models/discount_override.rbi +83 -0
- data/rbi/orb/models/fixed_fee_quantity_schedule_entry.rbi +48 -0
- data/rbi/orb/models/fixed_fee_quantity_transition.rbi +39 -0
- data/rbi/orb/models/invoice.rbi +212 -3345
- data/rbi/orb/models/invoice_create_params.rbi +4 -33
- data/rbi/orb/models/invoice_fetch_upcoming_response.rbi +355 -4329
- data/rbi/orb/models/invoice_line_item_create_response.rbi +30 -2260
- data/rbi/orb/models/invoice_tiny.rbi +24 -0
- data/rbi/orb/models/item_slim.rbi +23 -0
- data/rbi/orb/models/matrix_config.rbi +50 -0
- data/rbi/orb/models/matrix_sub_line_item.rbi +87 -0
- data/rbi/orb/models/matrix_value.rbi +43 -0
- data/rbi/orb/models/matrix_with_allocation_config.rbi +61 -0
- data/rbi/orb/models/maximum.rbi +52 -0
- data/rbi/orb/models/maximum_interval.rbi +69 -0
- data/rbi/orb/models/minimum.rbi +52 -0
- data/rbi/orb/models/minimum_interval.rbi +69 -0
- data/rbi/orb/models/monetary_amount_discount_adjustment.rbi +125 -0
- data/rbi/orb/models/monetary_maximum_adjustment.rbi +123 -0
- data/rbi/orb/models/monetary_minimum_adjustment.rbi +131 -0
- data/rbi/orb/models/monetary_percentage_discount_adjustment.rbi +131 -0
- data/rbi/orb/models/monetary_usage_discount_adjustment.rbi +125 -0
- data/rbi/orb/models/mutated_subscription.rbi +412 -0
- data/rbi/orb/models/new_accounting_sync_configuration.rbi +40 -0
- data/rbi/orb/models/new_allocation_price.rbi +104 -0
- data/rbi/orb/models/new_amount_discount.rbi +179 -0
- data/rbi/orb/models/new_avalara_tax_configuration.rbi +68 -0
- data/rbi/orb/models/new_billing_cycle_configuration.rbi +79 -0
- data/rbi/orb/models/new_dimensional_price_configuration.rbi +55 -0
- data/rbi/orb/models/new_floating_bps_price.rbi +294 -0
- data/rbi/orb/models/new_floating_bulk_bps_price.rbi +309 -0
- data/rbi/orb/models/new_floating_bulk_price.rbi +298 -0
- data/rbi/orb/models/new_floating_bulk_with_proration_price.rbi +331 -0
- data/rbi/orb/models/new_floating_cumulative_grouped_bulk_price.rbi +338 -0
- data/rbi/orb/models/new_floating_grouped_allocation_price.rbi +331 -0
- data/rbi/orb/models/new_floating_grouped_tiered_package_price.rbi +337 -0
- data/rbi/orb/models/new_floating_grouped_tiered_price.rbi +325 -0
- data/rbi/orb/models/new_floating_grouped_with_metered_minimum_price.rbi +348 -0
- data/rbi/orb/models/new_floating_grouped_with_prorated_minimum_price.rbi +348 -0
- data/rbi/orb/models/new_floating_matrix_price.rbi +304 -0
- data/rbi/orb/models/new_floating_matrix_with_allocation_price.rbi +345 -0
- data/rbi/orb/models/new_floating_matrix_with_display_name_price.rbi +338 -0
- data/rbi/orb/models/new_floating_max_group_tiered_package_price.rbi +338 -0
- data/rbi/orb/models/new_floating_package_price.rbi +306 -0
- data/rbi/orb/models/new_floating_package_with_allocation_price.rbi +338 -0
- data/rbi/orb/models/new_floating_scalable_matrix_with_tiered_pricing_price.rbi +350 -0
- data/rbi/orb/models/new_floating_scalable_matrix_with_unit_pricing_price.rbi +349 -0
- data/rbi/orb/models/new_floating_threshold_total_amount_price.rbi +337 -0
- data/rbi/orb/models/new_floating_tiered_bps_price.rbi +317 -0
- data/rbi/orb/models/new_floating_tiered_package_price.rbi +325 -0
- data/rbi/orb/models/new_floating_tiered_package_with_minimum_price.rbi +348 -0
- data/rbi/orb/models/new_floating_tiered_price.rbi +304 -0
- data/rbi/orb/models/new_floating_tiered_with_minimum_price.rbi +331 -0
- data/rbi/orb/models/new_floating_tiered_with_proration_price.rbi +337 -0
- data/rbi/orb/models/new_floating_unit_price.rbi +298 -0
- data/rbi/orb/models/new_floating_unit_with_percent_price.rbi +328 -0
- data/rbi/orb/models/new_floating_unit_with_proration_price.rbi +331 -0
- data/rbi/orb/models/new_maximum.rbi +160 -0
- data/rbi/orb/models/new_minimum.rbi +168 -0
- data/rbi/orb/models/new_percentage_discount.rbi +193 -0
- data/rbi/orb/models/new_plan_bps_price.rbi +294 -0
- data/rbi/orb/models/new_plan_bulk_bps_price.rbi +297 -0
- data/rbi/orb/models/new_plan_bulk_price.rbi +295 -0
- data/rbi/orb/models/new_plan_bulk_with_proration_price.rbi +327 -0
- data/rbi/orb/models/new_plan_cumulative_grouped_bulk_price.rbi +333 -0
- data/rbi/orb/models/new_plan_grouped_allocation_price.rbi +327 -0
- data/rbi/orb/models/new_plan_grouped_tiered_package_price.rbi +333 -0
- data/rbi/orb/models/new_plan_grouped_tiered_price.rbi +316 -0
- data/rbi/orb/models/new_plan_grouped_with_metered_minimum_price.rbi +340 -0
- data/rbi/orb/models/new_plan_grouped_with_prorated_minimum_price.rbi +345 -0
- data/rbi/orb/models/new_plan_matrix_price.rbi +297 -0
- data/rbi/orb/models/new_plan_matrix_with_allocation_price.rbi +341 -0
- data/rbi/orb/models/new_plan_matrix_with_display_name_price.rbi +333 -0
- data/rbi/orb/models/new_plan_max_group_tiered_package_price.rbi +333 -0
- data/rbi/orb/models/new_plan_package_price.rbi +297 -0
- data/rbi/orb/models/new_plan_package_with_allocation_price.rbi +333 -0
- data/rbi/orb/models/new_plan_scalable_matrix_with_tiered_pricing_price.rbi +352 -0
- data/rbi/orb/models/new_plan_scalable_matrix_with_unit_pricing_price.rbi +351 -0
- data/rbi/orb/models/new_plan_threshold_total_amount_price.rbi +333 -0
- data/rbi/orb/models/new_plan_tier_with_proration_price.rbi +327 -0
- data/rbi/orb/models/new_plan_tiered_bps_price.rbi +304 -0
- data/rbi/orb/models/new_plan_tiered_package_price.rbi +316 -0
- data/rbi/orb/models/new_plan_tiered_package_with_minimum_price.rbi +339 -0
- data/rbi/orb/models/new_plan_tiered_price.rbi +297 -0
- data/rbi/orb/models/new_plan_tiered_with_minimum_price.rbi +327 -0
- data/rbi/orb/models/new_plan_unit_price.rbi +295 -0
- data/rbi/orb/models/new_plan_unit_with_percent_price.rbi +325 -0
- data/rbi/orb/models/new_plan_unit_with_proration_price.rbi +327 -0
- data/rbi/orb/models/new_reporting_configuration.rbi +23 -0
- data/rbi/orb/models/new_sphere_configuration.rbi +59 -0
- data/rbi/orb/models/new_subscription_bps_price.rbi +317 -0
- data/rbi/orb/models/new_subscription_bulk_bps_price.rbi +338 -0
- data/rbi/orb/models/new_subscription_bulk_price.rbi +321 -0
- data/rbi/orb/models/new_subscription_bulk_with_proration_price.rbi +350 -0
- data/rbi/orb/models/new_subscription_cumulative_grouped_bulk_price.rbi +360 -0
- data/rbi/orb/models/new_subscription_grouped_allocation_price.rbi +350 -0
- data/rbi/orb/models/new_subscription_grouped_tiered_package_price.rbi +360 -0
- data/rbi/orb/models/new_subscription_grouped_tiered_price.rbi +343 -0
- data/rbi/orb/models/new_subscription_grouped_with_metered_minimum_price.rbi +360 -0
- data/rbi/orb/models/new_subscription_grouped_with_prorated_minimum_price.rbi +360 -0
- data/rbi/orb/models/new_subscription_matrix_price.rbi +332 -0
- data/rbi/orb/models/new_subscription_matrix_with_allocation_price.rbi +368 -0
- data/rbi/orb/models/new_subscription_matrix_with_display_name_price.rbi +360 -0
- data/rbi/orb/models/new_subscription_max_group_tiered_package_price.rbi +360 -0
- data/rbi/orb/models/new_subscription_package_price.rbi +338 -0
- data/rbi/orb/models/new_subscription_package_with_allocation_price.rbi +360 -0
- data/rbi/orb/models/new_subscription_scalable_matrix_with_tiered_pricing_price.rbi +362 -0
- data/rbi/orb/models/new_subscription_scalable_matrix_with_unit_pricing_price.rbi +361 -0
- data/rbi/orb/models/new_subscription_threshold_total_amount_price.rbi +360 -0
- data/rbi/orb/models/new_subscription_tier_with_proration_price.rbi +350 -0
- data/rbi/orb/models/new_subscription_tiered_bps_price.rbi +340 -0
- data/rbi/orb/models/new_subscription_tiered_package_price.rbi +343 -0
- data/rbi/orb/models/new_subscription_tiered_package_with_minimum_price.rbi +360 -0
- data/rbi/orb/models/new_subscription_tiered_price.rbi +332 -0
- data/rbi/orb/models/new_subscription_tiered_with_minimum_price.rbi +350 -0
- data/rbi/orb/models/new_subscription_unit_price.rbi +321 -0
- data/rbi/orb/models/new_subscription_unit_with_percent_price.rbi +349 -0
- data/rbi/orb/models/new_subscription_unit_with_proration_price.rbi +350 -0
- data/rbi/orb/models/new_tax_jar_configuration.rbi +59 -0
- data/rbi/orb/models/new_usage_discount.rbi +177 -0
- data/rbi/orb/models/other_sub_line_item.rbi +78 -0
- data/rbi/orb/models/package_config.rbi +39 -0
- data/rbi/orb/models/per_price_cost.rbi +96 -0
- data/rbi/orb/models/percentage_discount.rbi +3 -126
- data/rbi/orb/models/percentage_discount_interval.rbi +107 -0
- data/rbi/orb/models/plan.rbi +29 -1937
- data/rbi/orb/models/plan_create_params.rbi +112 -15428
- data/rbi/orb/models/plan_phase_amount_discount_adjustment.rbi +128 -0
- data/rbi/orb/models/plan_phase_maximum_adjustment.rbi +123 -0
- data/rbi/orb/models/plan_phase_minimum_adjustment.rbi +131 -0
- data/rbi/orb/models/plan_phase_percentage_discount_adjustment.rbi +131 -0
- data/rbi/orb/models/plan_phase_usage_discount_adjustment.rbi +125 -0
- data/rbi/orb/models/plan_version.rbi +13 -1252
- data/rbi/orb/models/price.rbi +3518 -26097
- data/rbi/orb/models/price_create_params.rbi +81 -937
- data/rbi/orb/models/price_evaluate_multiple_params.rbi +112 -15566
- data/rbi/orb/models/price_evaluate_preview_events_params.rbi +411 -0
- data/rbi/orb/models/price_evaluate_preview_events_response.rbi +101 -0
- data/rbi/orb/models/price_interval.rbi +174 -0
- data/rbi/orb/models/sub_line_item_grouping.rbi +31 -0
- data/rbi/orb/models/sub_line_item_matrix_config.rbi +33 -0
- data/rbi/orb/models/subscription.rbi +51 -2939
- data/rbi/orb/models/subscription_change_apply_response.rbi +4 -3580
- data/rbi/orb/models/subscription_change_cancel_response.rbi +4 -3580
- data/rbi/orb/models/subscription_change_minified.rbi +23 -0
- data/rbi/orb/models/subscription_change_retrieve_response.rbi +4 -3582
- data/rbi/orb/models/subscription_create_params.rbi +686 -36613
- data/rbi/orb/models/subscription_fetch_costs_response.rbi +5 -182
- data/rbi/orb/models/subscription_minified.rbi +23 -0
- data/rbi/orb/models/subscription_price_intervals_params.rbi +224 -17694
- data/rbi/orb/models/subscription_schedule_plan_change_params.rbi +696 -36631
- data/rbi/orb/models/subscription_trial_info.rbi +23 -0
- data/rbi/orb/models/tax_amount.rbi +50 -0
- data/rbi/orb/models/threshold.rbi +30 -0
- data/rbi/orb/models/tier.rbi +50 -0
- data/rbi/orb/models/tier_config.rbi +40 -0
- data/rbi/orb/models/tier_sub_line_item.rbi +87 -0
- data/rbi/orb/models/tiered_bps_config.rbi +29 -0
- data/rbi/orb/models/tiered_config.rbi +26 -0
- data/rbi/orb/models/tiered_conversion_rate_config.rbi +73 -0
- data/rbi/orb/models/transform_price_filter.rbi +106 -0
- data/rbi/orb/models/trial_discount.rbi +3 -104
- data/rbi/orb/models/unit_config.rbi +24 -0
- data/rbi/orb/models/unit_conversion_rate_config.rbi +71 -0
- data/rbi/orb/models/usage_discount.rbi +3 -104
- data/rbi/orb/models/usage_discount_interval.rbi +99 -0
- data/rbi/orb/models.rbi +398 -0
- data/rbi/orb/resources/alerts.rbi +4 -13
- data/rbi/orb/resources/customers.rbi +27 -51
- data/rbi/orb/resources/plans.rbi +28 -28
- data/rbi/orb/resources/prices.rbi +82 -36
- data/rbi/orb/resources/subscriptions.rbi +13 -19
- data/sig/orb/models/accounting_provider_config.rbs +19 -0
- data/sig/orb/models/address.rbs +45 -0
- data/sig/orb/models/address_input.rbs +45 -0
- data/sig/orb/models/adjustment_interval.rbs +53 -0
- data/sig/orb/models/aggregated_cost.rbs +40 -0
- data/sig/orb/models/alert.rbs +12 -44
- data/sig/orb/models/alert_create_for_customer_params.rbs +4 -14
- data/sig/orb/models/alert_create_for_external_customer_params.rbs +4 -14
- data/sig/orb/models/alert_create_for_subscription_params.rbs +4 -14
- data/sig/orb/models/alert_update_params.rbs +4 -14
- data/sig/orb/models/allocation.rbs +30 -0
- data/sig/orb/models/amount_discount.rbs +4 -57
- data/sig/orb/models/amount_discount_interval.rbs +55 -0
- data/sig/orb/models/beta/external_plan_id_create_plan_version_params.rbs +149 -13933
- data/sig/orb/models/beta_create_plan_version_params.rbs +146 -13914
- data/sig/orb/models/billable_metric_tiny.rbs +13 -0
- data/sig/orb/models/billing_cycle_anchor_configuration.rbs +18 -0
- data/sig/orb/models/billing_cycle_configuration.rbs +36 -0
- data/sig/orb/models/bps_config.rbs +15 -0
- data/sig/orb/models/bps_tier.rbs +35 -0
- data/sig/orb/models/bulk_bps_config.rbs +13 -0
- data/sig/orb/models/bulk_bps_tier.rbs +26 -0
- data/sig/orb/models/bulk_config.rbs +13 -0
- data/sig/orb/models/bulk_tier.rbs +15 -0
- data/sig/orb/models/changed_subscription_resources.rbs +35 -0
- data/sig/orb/models/conversion_rate_tier.rbs +26 -0
- data/sig/orb/models/conversion_rate_tiered_config.rbs +14 -0
- data/sig/orb/models/conversion_rate_unit_config.rbs +13 -0
- data/sig/orb/models/coupon_redemption.rbs +22 -0
- data/sig/orb/models/credit_note.rbs +8 -47
- data/sig/orb/models/credit_note_tiny.rbs +13 -0
- data/sig/orb/models/custom_expiration.rbs +36 -0
- data/sig/orb/models/customer.rbs +20 -471
- data/sig/orb/models/customer_create_params.rbs +27 -577
- data/sig/orb/models/customer_hierarchy_config.rbs +24 -0
- data/sig/orb/models/customer_minified.rbs +15 -0
- data/sig/orb/models/customer_tax_id.rbs +346 -0
- data/sig/orb/models/customer_update_by_external_id_params.rbs +27 -577
- data/sig/orb/models/customer_update_params.rbs +27 -577
- data/sig/orb/models/customers/balance_transaction_create_response.rbs +8 -28
- data/sig/orb/models/customers/balance_transaction_list_response.rbs +8 -28
- data/sig/orb/models/customers/cost_list_by_external_id_response.rbs +4 -84
- data/sig/orb/models/customers/cost_list_response.rbs +4 -83
- data/sig/orb/models/customers/credits/affected_block.rbs +30 -0
- data/sig/orb/models/customers/credits/amendment_ledger_entry.rbs +105 -0
- data/sig/orb/models/customers/credits/credit_block_expiry_ledger_entry.rbs +107 -0
- data/sig/orb/models/customers/credits/decrement_ledger_entry.rbs +120 -0
- data/sig/orb/models/customers/credits/expiration_change_ledger_entry.rbs +110 -0
- data/sig/orb/models/customers/credits/increment_ledger_entry.rbs +110 -0
- data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbs +7 -939
- data/sig/orb/models/customers/credits/ledger_create_entry_response.rbs +7 -939
- data/sig/orb/models/customers/credits/ledger_list_by_external_id_response.rbs +7 -939
- data/sig/orb/models/customers/credits/ledger_list_response.rbs +7 -939
- data/sig/orb/models/customers/credits/top_up_create_by_external_id_response.rbs +4 -38
- data/sig/orb/models/customers/credits/top_up_create_response.rbs +4 -38
- data/sig/orb/models/customers/credits/top_up_invoice_settings.rbs +41 -0
- data/sig/orb/models/customers/credits/top_up_list_by_external_id_response.rbs +4 -38
- data/sig/orb/models/customers/credits/top_up_list_response.rbs +4 -38
- data/sig/orb/models/customers/credits/void_initiated_ledger_entry.rbs +120 -0
- data/sig/orb/models/customers/credits/void_ledger_entry.rbs +115 -0
- data/sig/orb/models/dimensional_price_configuration.rbs +22 -0
- data/sig/orb/models/discount_override.rbs +47 -0
- data/sig/orb/models/fixed_fee_quantity_schedule_entry.rbs +30 -0
- data/sig/orb/models/fixed_fee_quantity_transition.rbs +26 -0
- data/sig/orb/models/invoice.rbs +54 -1612
- data/sig/orb/models/invoice_create_params.rbs +4 -14
- data/sig/orb/models/invoice_fetch_upcoming_response.rbs +54 -1612
- data/sig/orb/models/invoice_line_item_create_response.rbs +18 -927
- data/sig/orb/models/invoice_tiny.rbs +13 -0
- data/sig/orb/models/item_slim.rbs +15 -0
- data/sig/orb/models/matrix_config.rbs +30 -0
- data/sig/orb/models/matrix_sub_line_item.rbs +55 -0
- data/sig/orb/models/matrix_value.rbs +22 -0
- data/sig/orb/models/matrix_with_allocation_config.rbs +35 -0
- data/sig/orb/models/maximum.rbs +30 -0
- data/sig/orb/models/maximum_interval.rbs +40 -0
- data/sig/orb/models/minimum.rbs +30 -0
- data/sig/orb/models/minimum_interval.rbs +40 -0
- data/sig/orb/models/monetary_amount_discount_adjustment.rbs +65 -0
- data/sig/orb/models/monetary_maximum_adjustment.rbs +65 -0
- data/sig/orb/models/monetary_minimum_adjustment.rbs +70 -0
- data/sig/orb/models/monetary_percentage_discount_adjustment.rbs +65 -0
- data/sig/orb/models/monetary_usage_discount_adjustment.rbs +65 -0
- data/sig/orb/models/mutated_subscription.rbs +178 -0
- data/sig/orb/models/new_accounting_sync_configuration.rbs +25 -0
- data/sig/orb/models/new_allocation_price.rbs +56 -0
- data/sig/orb/models/new_amount_discount.rbs +97 -0
- data/sig/orb/models/new_avalara_tax_configuration.rbs +40 -0
- data/sig/orb/models/new_billing_cycle_configuration.rbs +36 -0
- data/sig/orb/models/new_dimensional_price_configuration.rbs +30 -0
- data/sig/orb/models/new_floating_bps_price.rbs +135 -0
- data/sig/orb/models/new_floating_bulk_bps_price.rbs +135 -0
- data/sig/orb/models/new_floating_bulk_price.rbs +135 -0
- data/sig/orb/models/new_floating_bulk_with_proration_price.rbs +135 -0
- data/sig/orb/models/new_floating_cumulative_grouped_bulk_price.rbs +135 -0
- data/sig/orb/models/new_floating_grouped_allocation_price.rbs +135 -0
- data/sig/orb/models/new_floating_grouped_tiered_package_price.rbs +135 -0
- data/sig/orb/models/new_floating_grouped_tiered_price.rbs +135 -0
- data/sig/orb/models/new_floating_grouped_with_metered_minimum_price.rbs +135 -0
- data/sig/orb/models/new_floating_grouped_with_prorated_minimum_price.rbs +135 -0
- data/sig/orb/models/new_floating_matrix_price.rbs +135 -0
- data/sig/orb/models/new_floating_matrix_with_allocation_price.rbs +135 -0
- data/sig/orb/models/new_floating_matrix_with_display_name_price.rbs +135 -0
- data/sig/orb/models/new_floating_max_group_tiered_package_price.rbs +135 -0
- data/sig/orb/models/new_floating_package_price.rbs +135 -0
- data/sig/orb/models/new_floating_package_with_allocation_price.rbs +135 -0
- data/sig/orb/models/new_floating_scalable_matrix_with_tiered_pricing_price.rbs +135 -0
- data/sig/orb/models/new_floating_scalable_matrix_with_unit_pricing_price.rbs +135 -0
- data/sig/orb/models/new_floating_threshold_total_amount_price.rbs +135 -0
- data/sig/orb/models/new_floating_tiered_bps_price.rbs +135 -0
- data/sig/orb/models/new_floating_tiered_package_price.rbs +135 -0
- data/sig/orb/models/new_floating_tiered_package_with_minimum_price.rbs +135 -0
- data/sig/orb/models/new_floating_tiered_price.rbs +135 -0
- data/sig/orb/models/new_floating_tiered_with_minimum_price.rbs +135 -0
- data/sig/orb/models/new_floating_tiered_with_proration_price.rbs +135 -0
- data/sig/orb/models/new_floating_unit_price.rbs +135 -0
- data/sig/orb/models/new_floating_unit_with_percent_price.rbs +135 -0
- data/sig/orb/models/new_floating_unit_with_proration_price.rbs +135 -0
- data/sig/orb/models/new_maximum.rbs +97 -0
- data/sig/orb/models/new_minimum.rbs +102 -0
- data/sig/orb/models/new_percentage_discount.rbs +97 -0
- data/sig/orb/models/new_plan_bps_price.rbs +135 -0
- data/sig/orb/models/new_plan_bulk_bps_price.rbs +135 -0
- data/sig/orb/models/new_plan_bulk_price.rbs +135 -0
- data/sig/orb/models/new_plan_bulk_with_proration_price.rbs +135 -0
- data/sig/orb/models/new_plan_cumulative_grouped_bulk_price.rbs +135 -0
- data/sig/orb/models/new_plan_grouped_allocation_price.rbs +135 -0
- data/sig/orb/models/new_plan_grouped_tiered_package_price.rbs +135 -0
- data/sig/orb/models/new_plan_grouped_tiered_price.rbs +135 -0
- data/sig/orb/models/new_plan_grouped_with_metered_minimum_price.rbs +135 -0
- data/sig/orb/models/new_plan_grouped_with_prorated_minimum_price.rbs +135 -0
- data/sig/orb/models/new_plan_matrix_price.rbs +135 -0
- data/sig/orb/models/new_plan_matrix_with_allocation_price.rbs +135 -0
- data/sig/orb/models/new_plan_matrix_with_display_name_price.rbs +135 -0
- data/sig/orb/models/new_plan_max_group_tiered_package_price.rbs +135 -0
- data/sig/orb/models/new_plan_package_price.rbs +135 -0
- data/sig/orb/models/new_plan_package_with_allocation_price.rbs +135 -0
- data/sig/orb/models/new_plan_scalable_matrix_with_tiered_pricing_price.rbs +135 -0
- data/sig/orb/models/new_plan_scalable_matrix_with_unit_pricing_price.rbs +135 -0
- data/sig/orb/models/new_plan_threshold_total_amount_price.rbs +135 -0
- data/sig/orb/models/new_plan_tier_with_proration_price.rbs +135 -0
- data/sig/orb/models/new_plan_tiered_bps_price.rbs +135 -0
- data/sig/orb/models/new_plan_tiered_package_price.rbs +135 -0
- data/sig/orb/models/new_plan_tiered_package_with_minimum_price.rbs +135 -0
- data/sig/orb/models/new_plan_tiered_price.rbs +135 -0
- data/sig/orb/models/new_plan_tiered_with_minimum_price.rbs +135 -0
- data/sig/orb/models/new_plan_unit_price.rbs +135 -0
- data/sig/orb/models/new_plan_unit_with_percent_price.rbs +135 -0
- data/sig/orb/models/new_plan_unit_with_proration_price.rbs +135 -0
- data/sig/orb/models/new_reporting_configuration.rbs +13 -0
- data/sig/orb/models/new_sphere_configuration.rbs +35 -0
- data/sig/orb/models/new_subscription_bps_price.rbs +140 -0
- data/sig/orb/models/new_subscription_bulk_bps_price.rbs +140 -0
- data/sig/orb/models/new_subscription_bulk_price.rbs +140 -0
- data/sig/orb/models/new_subscription_bulk_with_proration_price.rbs +140 -0
- data/sig/orb/models/new_subscription_cumulative_grouped_bulk_price.rbs +140 -0
- data/sig/orb/models/new_subscription_grouped_allocation_price.rbs +140 -0
- data/sig/orb/models/new_subscription_grouped_tiered_package_price.rbs +140 -0
- data/sig/orb/models/new_subscription_grouped_tiered_price.rbs +140 -0
- data/sig/orb/models/new_subscription_grouped_with_metered_minimum_price.rbs +140 -0
- data/sig/orb/models/new_subscription_grouped_with_prorated_minimum_price.rbs +140 -0
- data/sig/orb/models/new_subscription_matrix_price.rbs +140 -0
- data/sig/orb/models/new_subscription_matrix_with_allocation_price.rbs +140 -0
- data/sig/orb/models/new_subscription_matrix_with_display_name_price.rbs +140 -0
- data/sig/orb/models/new_subscription_max_group_tiered_package_price.rbs +140 -0
- data/sig/orb/models/new_subscription_package_price.rbs +140 -0
- data/sig/orb/models/new_subscription_package_with_allocation_price.rbs +140 -0
- data/sig/orb/models/new_subscription_scalable_matrix_with_tiered_pricing_price.rbs +140 -0
- data/sig/orb/models/new_subscription_scalable_matrix_with_unit_pricing_price.rbs +140 -0
- data/sig/orb/models/new_subscription_threshold_total_amount_price.rbs +140 -0
- data/sig/orb/models/new_subscription_tier_with_proration_price.rbs +140 -0
- data/sig/orb/models/new_subscription_tiered_bps_price.rbs +140 -0
- data/sig/orb/models/new_subscription_tiered_package_price.rbs +140 -0
- data/sig/orb/models/new_subscription_tiered_package_with_minimum_price.rbs +140 -0
- data/sig/orb/models/new_subscription_tiered_price.rbs +140 -0
- data/sig/orb/models/new_subscription_tiered_with_minimum_price.rbs +140 -0
- data/sig/orb/models/new_subscription_unit_price.rbs +140 -0
- data/sig/orb/models/new_subscription_unit_with_percent_price.rbs +140 -0
- data/sig/orb/models/new_subscription_unit_with_proration_price.rbs +140 -0
- data/sig/orb/models/new_tax_jar_configuration.rbs +35 -0
- data/sig/orb/models/new_usage_discount.rbs +97 -0
- data/sig/orb/models/other_sub_line_item.rbs +50 -0
- data/sig/orb/models/package_config.rbs +15 -0
- data/sig/orb/models/per_price_cost.rbs +40 -0
- data/sig/orb/models/percentage_discount.rbs +4 -57
- data/sig/orb/models/percentage_discount_interval.rbs +55 -0
- data/sig/orb/models/plan.rbs +21 -871
- data/sig/orb/models/plan_create_params.rbs +28 -5952
- data/sig/orb/models/plan_phase_amount_discount_adjustment.rbs +65 -0
- data/sig/orb/models/plan_phase_maximum_adjustment.rbs +65 -0
- data/sig/orb/models/plan_phase_minimum_adjustment.rbs +70 -0
- data/sig/orb/models/plan_phase_percentage_discount_adjustment.rbs +65 -0
- data/sig/orb/models/plan_phase_usage_discount_adjustment.rbs +65 -0
- data/sig/orb/models/plan_version.rbs +5 -535
- data/sig/orb/models/price.rbs +2164 -11297
- data/sig/orb/models/price_create_params.rbs +58 -418
- data/sig/orb/models/price_evaluate_multiple_params.rbs +28 -6138
- data/sig/orb/models/price_evaluate_preview_events_params.rbs +166 -0
- data/sig/orb/models/price_evaluate_preview_events_response.rbs +50 -0
- data/sig/orb/models/price_interval.rbs +65 -0
- data/sig/orb/models/sub_line_item_grouping.rbs +15 -0
- data/sig/orb/models/sub_line_item_matrix_config.rbs +13 -0
- data/sig/orb/models/subscription.rbs +39 -1274
- data/sig/orb/models/subscription_change_apply_response.rbs +4 -1467
- data/sig/orb/models/subscription_change_cancel_response.rbs +4 -1467
- data/sig/orb/models/subscription_change_minified.rbs +13 -0
- data/sig/orb/models/subscription_change_retrieve_response.rbs +4 -1467
- data/sig/orb/models/subscription_create_params.rbs +176 -14331
- data/sig/orb/models/subscription_fetch_costs_response.rbs +4 -82
- data/sig/orb/models/subscription_minified.rbs +13 -0
- data/sig/orb/models/subscription_price_intervals_params.rbs +61 -6945
- data/sig/orb/models/subscription_schedule_plan_change_params.rbs +178 -14333
- data/sig/orb/models/subscription_trial_info.rbs +13 -0
- data/sig/orb/models/tax_amount.rbs +30 -0
- data/sig/orb/models/threshold.rbs +13 -0
- data/sig/orb/models/tier.rbs +25 -0
- data/sig/orb/models/tier_config.rbs +26 -0
- data/sig/orb/models/tier_sub_line_item.rbs +55 -0
- data/sig/orb/models/tiered_bps_config.rbs +13 -0
- data/sig/orb/models/tiered_config.rbs +13 -0
- data/sig/orb/models/tiered_conversion_rate_config.rbs +35 -0
- data/sig/orb/models/transform_price_filter.rbs +56 -0
- data/sig/orb/models/trial_discount.rbs +4 -57
- data/sig/orb/models/unit_config.rbs +13 -0
- data/sig/orb/models/unit_conversion_rate_config.rbs +35 -0
- data/sig/orb/models/usage_discount.rbs +4 -57
- data/sig/orb/models/usage_discount_interval.rbs +55 -0
- data/sig/orb/models.rbs +342 -0
- data/sig/orb/resources/alerts.rbs +4 -4
- data/sig/orb/resources/customers.rbs +18 -18
- data/sig/orb/resources/prices.rbs +23 -13
- data/sig/orb/resources/subscriptions.rbs +13 -13
- metadata +545 -35
- data/lib/orb/models/subscription_cancel_response.rb +0 -1873
- data/lib/orb/models/subscription_create_response.rb +0 -1873
- data/lib/orb/models/subscription_price_intervals_response.rb +0 -1888
- data/lib/orb/models/subscription_redeem_coupon_response.rb +0 -1883
- data/lib/orb/models/subscription_schedule_plan_change_response.rb +0 -1893
- data/lib/orb/models/subscription_trigger_phase_response.rb +0 -1883
- data/lib/orb/models/subscription_unschedule_cancellation_response.rb +0 -1897
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +0 -1912
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +0 -1908
- data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +0 -1897
- data/lib/orb/models/subscription_update_trial_response.rb +0 -1879
- data/rbi/orb/models/subscription_cancel_response.rbi +0 -3537
- data/rbi/orb/models/subscription_create_response.rbi +0 -3537
- data/rbi/orb/models/subscription_price_intervals_response.rbi +0 -3564
- data/rbi/orb/models/subscription_redeem_coupon_response.rbi +0 -3557
- data/rbi/orb/models/subscription_schedule_plan_change_response.rbi +0 -3564
- data/rbi/orb/models/subscription_trigger_phase_response.rbi +0 -3557
- data/rbi/orb/models/subscription_unschedule_cancellation_response.rbi +0 -3566
- data/rbi/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +0 -3566
- data/rbi/orb/models/subscription_unschedule_pending_plan_changes_response.rbi +0 -3566
- data/rbi/orb/models/subscription_update_fixed_fee_quantity_response.rbi +0 -3566
- data/rbi/orb/models/subscription_update_trial_response.rbi +0 -3556
- data/sig/orb/models/subscription_cancel_response.rbs +0 -1445
- data/sig/orb/models/subscription_create_response.rbs +0 -1445
- data/sig/orb/models/subscription_price_intervals_response.rbs +0 -1445
- data/sig/orb/models/subscription_redeem_coupon_response.rbs +0 -1445
- data/sig/orb/models/subscription_schedule_plan_change_response.rbs +0 -1445
- data/sig/orb/models/subscription_trigger_phase_response.rbs +0 -1445
- data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +0 -1445
- data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +0 -1445
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +0 -1445
- data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +0 -1445
- data/sig/orb/models/subscription_update_trial_response.rbs +0 -1445
@@ -38,8 +38,8 @@ module Orb
|
|
38
38
|
|
39
39
|
# @!attribute unit_config
|
40
40
|
#
|
41
|
-
# @return [Orb::Models::
|
42
|
-
required :unit_config, -> { Orb::
|
41
|
+
# @return [Orb::Models::UnitConfig]
|
42
|
+
required :unit_config, -> { Orb::UnitConfig }
|
43
43
|
|
44
44
|
# @!attribute billable_metric_id
|
45
45
|
# The id of the billable metric for the price. Only needed if the price is
|
@@ -59,10 +59,8 @@ module Orb
|
|
59
59
|
# For custom cadence: specifies the duration of the billing period in days or
|
60
60
|
# months.
|
61
61
|
#
|
62
|
-
# @return [Orb::Models::
|
63
|
-
optional :billing_cycle_configuration,
|
64
|
-
-> { Orb::PriceCreateParams::BillingCycleConfiguration },
|
65
|
-
nil?: true
|
62
|
+
# @return [Orb::Models::NewBillingCycleConfiguration, nil]
|
63
|
+
optional :billing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
|
66
64
|
|
67
65
|
# @!attribute conversion_rate
|
68
66
|
# The per unit conversion rate of the price currency to the invoicing currency.
|
@@ -70,13 +68,17 @@ module Orb
|
|
70
68
|
# @return [Float, nil]
|
71
69
|
optional :conversion_rate, Float, nil?: true
|
72
70
|
|
71
|
+
# @!attribute conversion_rate_config
|
72
|
+
# The configuration for the rate of the price currency to the invoicing currency.
|
73
|
+
#
|
74
|
+
# @return [Orb::Models::UnitConversionRateConfig, Orb::Models::TieredConversionRateConfig, nil]
|
75
|
+
optional :conversion_rate_config, union: -> { Orb::PriceCreateParams::ConversionRateConfig }, nil?: true
|
76
|
+
|
73
77
|
# @!attribute dimensional_price_configuration
|
74
78
|
# For dimensional price: specifies a price group and dimension values
|
75
79
|
#
|
76
|
-
# @return [Orb::Models::
|
77
|
-
optional :dimensional_price_configuration,
|
78
|
-
-> { Orb::PriceCreateParams::DimensionalPriceConfiguration },
|
79
|
-
nil?: true
|
80
|
+
# @return [Orb::Models::NewDimensionalPriceConfiguration, nil]
|
81
|
+
optional :dimensional_price_configuration, -> { Orb::NewDimensionalPriceConfiguration }, nil?: true
|
80
82
|
|
81
83
|
# @!attribute external_price_id
|
82
84
|
# An alias for the price.
|
@@ -101,10 +103,8 @@ module Orb
|
|
101
103
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
102
104
|
# If unspecified, a single invoice is produced per billing cycle.
|
103
105
|
#
|
104
|
-
# @return [Orb::Models::
|
105
|
-
optional :invoicing_cycle_configuration,
|
106
|
-
-> { Orb::PriceCreateParams::InvoicingCycleConfiguration },
|
107
|
-
nil?: true
|
106
|
+
# @return [Orb::Models::NewBillingCycleConfiguration, nil]
|
107
|
+
optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
|
108
108
|
|
109
109
|
# @!attribute metadata
|
110
110
|
# User-specified key/value pairs for the resource. Individual keys can be removed
|
@@ -116,43 +116,43 @@ module Orb
|
|
116
116
|
|
117
117
|
# @!attribute package_config
|
118
118
|
#
|
119
|
-
# @return [Orb::Models::
|
120
|
-
required :package_config, -> { Orb::
|
119
|
+
# @return [Orb::Models::PackageConfig]
|
120
|
+
required :package_config, -> { Orb::PackageConfig }
|
121
121
|
|
122
122
|
# @!attribute matrix_config
|
123
123
|
#
|
124
|
-
# @return [Orb::Models::
|
125
|
-
required :matrix_config, -> { Orb::
|
124
|
+
# @return [Orb::Models::MatrixConfig]
|
125
|
+
required :matrix_config, -> { Orb::MatrixConfig }
|
126
126
|
|
127
127
|
# @!attribute matrix_with_allocation_config
|
128
128
|
#
|
129
|
-
# @return [Orb::Models::
|
130
|
-
required :matrix_with_allocation_config, -> { Orb::
|
129
|
+
# @return [Orb::Models::MatrixWithAllocationConfig]
|
130
|
+
required :matrix_with_allocation_config, -> { Orb::MatrixWithAllocationConfig }
|
131
131
|
|
132
132
|
# @!attribute tiered_config
|
133
133
|
#
|
134
|
-
# @return [Orb::Models::
|
135
|
-
required :tiered_config, -> { Orb::
|
134
|
+
# @return [Orb::Models::TieredConfig]
|
135
|
+
required :tiered_config, -> { Orb::TieredConfig }
|
136
136
|
|
137
137
|
# @!attribute tiered_bps_config
|
138
138
|
#
|
139
|
-
# @return [Orb::Models::
|
140
|
-
required :tiered_bps_config, -> { Orb::
|
139
|
+
# @return [Orb::Models::TieredBPSConfig]
|
140
|
+
required :tiered_bps_config, -> { Orb::TieredBPSConfig }
|
141
141
|
|
142
142
|
# @!attribute bps_config
|
143
143
|
#
|
144
|
-
# @return [Orb::Models::
|
145
|
-
required :bps_config, -> { Orb::
|
144
|
+
# @return [Orb::Models::BPSConfig]
|
145
|
+
required :bps_config, -> { Orb::BPSConfig }
|
146
146
|
|
147
147
|
# @!attribute bulk_bps_config
|
148
148
|
#
|
149
|
-
# @return [Orb::Models::
|
150
|
-
required :bulk_bps_config, -> { Orb::
|
149
|
+
# @return [Orb::Models::BulkBPSConfig]
|
150
|
+
required :bulk_bps_config, -> { Orb::BulkBPSConfig }
|
151
151
|
|
152
152
|
# @!attribute bulk_config
|
153
153
|
#
|
154
|
-
# @return [Orb::Models::
|
155
|
-
required :bulk_config, -> { Orb::
|
154
|
+
# @return [Orb::Models::BulkConfig]
|
155
|
+
required :bulk_config, -> { Orb::BulkConfig }
|
156
156
|
|
157
157
|
# @!attribute threshold_total_amount_config
|
158
158
|
#
|
@@ -252,7 +252,7 @@ module Orb
|
|
252
252
|
# @return [Hash{Symbol=>Object}]
|
253
253
|
required :cumulative_grouped_bulk_config, Orb::Internal::Type::HashOf[Orb::Internal::Type::Unknown]
|
254
254
|
|
255
|
-
# @!method initialize(cadence:, currency:, item_id:, model_type:, name:, unit_config:, package_config:, matrix_config:, matrix_with_allocation_config:, tiered_config:, tiered_bps_config:, bps_config:, bulk_bps_config:, bulk_config:, threshold_total_amount_config:, tiered_package_config:, grouped_tiered_config:, max_group_tiered_package_config:, tiered_with_minimum_config:, package_with_allocation_config:, tiered_package_with_minimum_config:, unit_with_percent_config:, tiered_with_proration_config:, unit_with_proration_config:, grouped_allocation_config:, grouped_with_prorated_minimum_config:, grouped_with_metered_minimum_config:, matrix_with_display_name_config:, bulk_with_proration_config:, grouped_tiered_package_config:, scalable_matrix_with_unit_pricing_config:, scalable_matrix_with_tiered_pricing_config:, cumulative_grouped_bulk_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, dimensional_price_configuration: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, request_options: {})
|
255
|
+
# @!method initialize(cadence:, currency:, item_id:, model_type:, name:, unit_config:, package_config:, matrix_config:, matrix_with_allocation_config:, tiered_config:, tiered_bps_config:, bps_config:, bulk_bps_config:, bulk_config:, threshold_total_amount_config:, tiered_package_config:, grouped_tiered_config:, max_group_tiered_package_config:, tiered_with_minimum_config:, package_with_allocation_config:, tiered_package_with_minimum_config:, unit_with_percent_config:, tiered_with_proration_config:, unit_with_proration_config:, grouped_allocation_config:, grouped_with_prorated_minimum_config:, grouped_with_metered_minimum_config:, matrix_with_display_name_config:, bulk_with_proration_config:, grouped_tiered_package_config:, scalable_matrix_with_unit_pricing_config:, scalable_matrix_with_tiered_pricing_config:, cumulative_grouped_bulk_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, conversion_rate_config: nil, dimensional_price_configuration: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, request_options: {})
|
256
256
|
# Some parameter documentations has been truncated, see
|
257
257
|
# {Orb::Models::PriceCreateParams} for more details.
|
258
258
|
#
|
@@ -266,23 +266,23 @@ module Orb
|
|
266
266
|
#
|
267
267
|
# @param name [String] The name of the price.
|
268
268
|
#
|
269
|
-
# @param unit_config [Orb::Models::
|
269
|
+
# @param unit_config [Orb::Models::UnitConfig]
|
270
270
|
#
|
271
|
-
# @param package_config [Orb::Models::
|
271
|
+
# @param package_config [Orb::Models::PackageConfig]
|
272
272
|
#
|
273
|
-
# @param matrix_config [Orb::Models::
|
273
|
+
# @param matrix_config [Orb::Models::MatrixConfig]
|
274
274
|
#
|
275
|
-
# @param matrix_with_allocation_config [Orb::Models::
|
275
|
+
# @param matrix_with_allocation_config [Orb::Models::MatrixWithAllocationConfig]
|
276
276
|
#
|
277
|
-
# @param tiered_config [Orb::Models::
|
277
|
+
# @param tiered_config [Orb::Models::TieredConfig]
|
278
278
|
#
|
279
|
-
# @param tiered_bps_config [Orb::Models::
|
279
|
+
# @param tiered_bps_config [Orb::Models::TieredBPSConfig]
|
280
280
|
#
|
281
|
-
# @param bps_config [Orb::Models::
|
281
|
+
# @param bps_config [Orb::Models::BPSConfig]
|
282
282
|
#
|
283
|
-
# @param bulk_bps_config [Orb::Models::
|
283
|
+
# @param bulk_bps_config [Orb::Models::BulkBPSConfig]
|
284
284
|
#
|
285
|
-
# @param bulk_config [Orb::Models::
|
285
|
+
# @param bulk_config [Orb::Models::BulkConfig]
|
286
286
|
#
|
287
287
|
# @param threshold_total_amount_config [Hash{Symbol=>Object}]
|
288
288
|
#
|
@@ -326,11 +326,13 @@ module Orb
|
|
326
326
|
#
|
327
327
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
328
328
|
#
|
329
|
-
# @param billing_cycle_configuration [Orb::Models::
|
329
|
+
# @param billing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
330
330
|
#
|
331
331
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
332
332
|
#
|
333
|
-
# @param
|
333
|
+
# @param conversion_rate_config [Orb::Models::UnitConversionRateConfig, Orb::Models::TieredConversionRateConfig, nil] The configuration for the rate of the price currency to the invoicing currency.
|
334
|
+
#
|
335
|
+
# @param dimensional_price_configuration [Orb::Models::NewDimensionalPriceConfiguration, nil] For dimensional price: specifies a price group and dimension values
|
334
336
|
#
|
335
337
|
# @param external_price_id [String, nil] An alias for the price.
|
336
338
|
#
|
@@ -338,7 +340,7 @@ module Orb
|
|
338
340
|
#
|
339
341
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
340
342
|
#
|
341
|
-
# @param invoicing_cycle_configuration [Orb::Models::
|
343
|
+
# @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
342
344
|
#
|
343
345
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
344
346
|
#
|
@@ -368,439 +370,18 @@ module Orb
|
|
368
370
|
# @return [Array<Symbol>]
|
369
371
|
end
|
370
372
|
|
371
|
-
|
372
|
-
|
373
|
-
|
374
|
-
#
|
375
|
-
# @return [String]
|
376
|
-
required :unit_amount, String
|
377
|
-
|
378
|
-
# @!method initialize(unit_amount:)
|
379
|
-
# @param unit_amount [String] Rate per unit of usage
|
380
|
-
end
|
381
|
-
|
382
|
-
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
383
|
-
# @!attribute duration
|
384
|
-
# The duration of the billing period.
|
385
|
-
#
|
386
|
-
# @return [Integer]
|
387
|
-
required :duration, Integer
|
388
|
-
|
389
|
-
# @!attribute duration_unit
|
390
|
-
# The unit of billing period duration.
|
391
|
-
#
|
392
|
-
# @return [Symbol, Orb::Models::PriceCreateParams::BillingCycleConfiguration::DurationUnit]
|
393
|
-
required :duration_unit, enum: -> { Orb::PriceCreateParams::BillingCycleConfiguration::DurationUnit }
|
394
|
-
|
395
|
-
# @!method initialize(duration:, duration_unit:)
|
396
|
-
# For custom cadence: specifies the duration of the billing period in days or
|
397
|
-
# months.
|
398
|
-
#
|
399
|
-
# @param duration [Integer] The duration of the billing period.
|
400
|
-
#
|
401
|
-
# @param duration_unit [Symbol, Orb::Models::PriceCreateParams::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
402
|
-
|
403
|
-
# The unit of billing period duration.
|
404
|
-
#
|
405
|
-
# @see Orb::Models::PriceCreateParams::BillingCycleConfiguration#duration_unit
|
406
|
-
module DurationUnit
|
407
|
-
extend Orb::Internal::Type::Enum
|
408
|
-
|
409
|
-
DAY = :day
|
410
|
-
MONTH = :month
|
411
|
-
|
412
|
-
# @!method self.values
|
413
|
-
# @return [Array<Symbol>]
|
414
|
-
end
|
415
|
-
end
|
416
|
-
|
417
|
-
class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel
|
418
|
-
# @!attribute dimension_values
|
419
|
-
# The list of dimension values matching (in order) the dimensions of the price
|
420
|
-
# group
|
421
|
-
#
|
422
|
-
# @return [Array<String>]
|
423
|
-
required :dimension_values, Orb::Internal::Type::ArrayOf[String]
|
424
|
-
|
425
|
-
# @!attribute dimensional_price_group_id
|
426
|
-
# The id of the dimensional price group to include this price in
|
427
|
-
#
|
428
|
-
# @return [String, nil]
|
429
|
-
optional :dimensional_price_group_id, String, nil?: true
|
430
|
-
|
431
|
-
# @!attribute external_dimensional_price_group_id
|
432
|
-
# The external id of the dimensional price group to include this price in
|
433
|
-
#
|
434
|
-
# @return [String, nil]
|
435
|
-
optional :external_dimensional_price_group_id, String, nil?: true
|
436
|
-
|
437
|
-
# @!method initialize(dimension_values:, dimensional_price_group_id: nil, external_dimensional_price_group_id: nil)
|
438
|
-
# Some parameter documentations has been truncated, see
|
439
|
-
# {Orb::Models::PriceCreateParams::DimensionalPriceConfiguration} for more
|
440
|
-
# details.
|
441
|
-
#
|
442
|
-
# For dimensional price: specifies a price group and dimension values
|
443
|
-
#
|
444
|
-
# @param dimension_values [Array<String>] The list of dimension values matching (in order) the dimensions of the price gro
|
445
|
-
#
|
446
|
-
# @param dimensional_price_group_id [String, nil] The id of the dimensional price group to include this price in
|
447
|
-
#
|
448
|
-
# @param external_dimensional_price_group_id [String, nil] The external id of the dimensional price group to include this price in
|
449
|
-
end
|
450
|
-
|
451
|
-
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
452
|
-
# @!attribute duration
|
453
|
-
# The duration of the billing period.
|
454
|
-
#
|
455
|
-
# @return [Integer]
|
456
|
-
required :duration, Integer
|
457
|
-
|
458
|
-
# @!attribute duration_unit
|
459
|
-
# The unit of billing period duration.
|
460
|
-
#
|
461
|
-
# @return [Symbol, Orb::Models::PriceCreateParams::InvoicingCycleConfiguration::DurationUnit]
|
462
|
-
required :duration_unit,
|
463
|
-
enum: -> {
|
464
|
-
Orb::PriceCreateParams::InvoicingCycleConfiguration::DurationUnit
|
465
|
-
}
|
466
|
-
|
467
|
-
# @!method initialize(duration:, duration_unit:)
|
468
|
-
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
469
|
-
# If unspecified, a single invoice is produced per billing cycle.
|
470
|
-
#
|
471
|
-
# @param duration [Integer] The duration of the billing period.
|
472
|
-
#
|
473
|
-
# @param duration_unit [Symbol, Orb::Models::PriceCreateParams::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
474
|
-
|
475
|
-
# The unit of billing period duration.
|
476
|
-
#
|
477
|
-
# @see Orb::Models::PriceCreateParams::InvoicingCycleConfiguration#duration_unit
|
478
|
-
module DurationUnit
|
479
|
-
extend Orb::Internal::Type::Enum
|
480
|
-
|
481
|
-
DAY = :day
|
482
|
-
MONTH = :month
|
483
|
-
|
484
|
-
# @!method self.values
|
485
|
-
# @return [Array<Symbol>]
|
486
|
-
end
|
487
|
-
end
|
488
|
-
|
489
|
-
class PackageConfig < Orb::Internal::Type::BaseModel
|
490
|
-
# @!attribute package_amount
|
491
|
-
# A currency amount to rate usage by
|
492
|
-
#
|
493
|
-
# @return [String]
|
494
|
-
required :package_amount, String
|
495
|
-
|
496
|
-
# @!attribute package_size
|
497
|
-
# An integer amount to represent package size. For example, 1000 here would divide
|
498
|
-
# usage by 1000 before multiplying by package_amount in rating
|
499
|
-
#
|
500
|
-
# @return [Integer]
|
501
|
-
required :package_size, Integer
|
502
|
-
|
503
|
-
# @!method initialize(package_amount:, package_size:)
|
504
|
-
# Some parameter documentations has been truncated, see
|
505
|
-
# {Orb::Models::PriceCreateParams::PackageConfig} for more details.
|
506
|
-
#
|
507
|
-
# @param package_amount [String] A currency amount to rate usage by
|
508
|
-
#
|
509
|
-
# @param package_size [Integer] An integer amount to represent package size. For example, 1000 here would divide
|
510
|
-
end
|
511
|
-
|
512
|
-
class MatrixConfig < Orb::Internal::Type::BaseModel
|
513
|
-
# @!attribute default_unit_amount
|
514
|
-
# Default per unit rate for any usage not bucketed into a specified matrix_value
|
515
|
-
#
|
516
|
-
# @return [String]
|
517
|
-
required :default_unit_amount, String
|
518
|
-
|
519
|
-
# @!attribute dimensions
|
520
|
-
# One or two event property values to evaluate matrix groups by
|
521
|
-
#
|
522
|
-
# @return [Array<String, nil>]
|
523
|
-
required :dimensions, Orb::Internal::Type::ArrayOf[String, nil?: true]
|
524
|
-
|
525
|
-
# @!attribute matrix_values
|
526
|
-
# Matrix values for specified matrix grouping keys
|
527
|
-
#
|
528
|
-
# @return [Array<Orb::Models::PriceCreateParams::MatrixConfig::MatrixValue>]
|
529
|
-
required :matrix_values,
|
530
|
-
-> { Orb::Internal::Type::ArrayOf[Orb::PriceCreateParams::MatrixConfig::MatrixValue] }
|
531
|
-
|
532
|
-
# @!method initialize(default_unit_amount:, dimensions:, matrix_values:)
|
533
|
-
# @param default_unit_amount [String] Default per unit rate for any usage not bucketed into a specified matrix_value
|
534
|
-
#
|
535
|
-
# @param dimensions [Array<String, nil>] One or two event property values to evaluate matrix groups by
|
536
|
-
#
|
537
|
-
# @param matrix_values [Array<Orb::Models::PriceCreateParams::MatrixConfig::MatrixValue>] Matrix values for specified matrix grouping keys
|
538
|
-
|
539
|
-
class MatrixValue < Orb::Internal::Type::BaseModel
|
540
|
-
# @!attribute dimension_values
|
541
|
-
# One or two matrix keys to filter usage to this Matrix value by. For example,
|
542
|
-
# ["region", "tier"] could be used to filter cloud usage by a cloud region and an
|
543
|
-
# instance tier.
|
544
|
-
#
|
545
|
-
# @return [Array<String, nil>]
|
546
|
-
required :dimension_values, Orb::Internal::Type::ArrayOf[String, nil?: true]
|
547
|
-
|
548
|
-
# @!attribute unit_amount
|
549
|
-
# Unit price for the specified dimension_values
|
550
|
-
#
|
551
|
-
# @return [String]
|
552
|
-
required :unit_amount, String
|
553
|
-
|
554
|
-
# @!method initialize(dimension_values:, unit_amount:)
|
555
|
-
# Some parameter documentations has been truncated, see
|
556
|
-
# {Orb::Models::PriceCreateParams::MatrixConfig::MatrixValue} for more details.
|
557
|
-
#
|
558
|
-
# @param dimension_values [Array<String, nil>] One or two matrix keys to filter usage to this Matrix value by. For example, ["r
|
559
|
-
#
|
560
|
-
# @param unit_amount [String] Unit price for the specified dimension_values
|
561
|
-
end
|
562
|
-
end
|
373
|
+
# The configuration for the rate of the price currency to the invoicing currency.
|
374
|
+
module ConversionRateConfig
|
375
|
+
extend Orb::Internal::Type::Union
|
563
376
|
|
564
|
-
|
565
|
-
# @!attribute allocation
|
566
|
-
# Allocation to be used to calculate the price
|
567
|
-
#
|
568
|
-
# @return [Float]
|
569
|
-
required :allocation, Float
|
570
|
-
|
571
|
-
# @!attribute default_unit_amount
|
572
|
-
# Default per unit rate for any usage not bucketed into a specified matrix_value
|
573
|
-
#
|
574
|
-
# @return [String]
|
575
|
-
required :default_unit_amount, String
|
576
|
-
|
577
|
-
# @!attribute dimensions
|
578
|
-
# One or two event property values to evaluate matrix groups by
|
579
|
-
#
|
580
|
-
# @return [Array<String, nil>]
|
581
|
-
required :dimensions, Orb::Internal::Type::ArrayOf[String, nil?: true]
|
582
|
-
|
583
|
-
# @!attribute matrix_values
|
584
|
-
# Matrix values for specified matrix grouping keys
|
585
|
-
#
|
586
|
-
# @return [Array<Orb::Models::PriceCreateParams::MatrixWithAllocationConfig::MatrixValue>]
|
587
|
-
required :matrix_values,
|
588
|
-
-> {
|
589
|
-
Orb::Internal::Type::ArrayOf[Orb::PriceCreateParams::MatrixWithAllocationConfig::MatrixValue]
|
590
|
-
}
|
591
|
-
|
592
|
-
# @!method initialize(allocation:, default_unit_amount:, dimensions:, matrix_values:)
|
593
|
-
# @param allocation [Float] Allocation to be used to calculate the price
|
594
|
-
#
|
595
|
-
# @param default_unit_amount [String] Default per unit rate for any usage not bucketed into a specified matrix_value
|
596
|
-
#
|
597
|
-
# @param dimensions [Array<String, nil>] One or two event property values to evaluate matrix groups by
|
598
|
-
#
|
599
|
-
# @param matrix_values [Array<Orb::Models::PriceCreateParams::MatrixWithAllocationConfig::MatrixValue>] Matrix values for specified matrix grouping keys
|
600
|
-
|
601
|
-
class MatrixValue < Orb::Internal::Type::BaseModel
|
602
|
-
# @!attribute dimension_values
|
603
|
-
# One or two matrix keys to filter usage to this Matrix value by. For example,
|
604
|
-
# ["region", "tier"] could be used to filter cloud usage by a cloud region and an
|
605
|
-
# instance tier.
|
606
|
-
#
|
607
|
-
# @return [Array<String, nil>]
|
608
|
-
required :dimension_values, Orb::Internal::Type::ArrayOf[String, nil?: true]
|
609
|
-
|
610
|
-
# @!attribute unit_amount
|
611
|
-
# Unit price for the specified dimension_values
|
612
|
-
#
|
613
|
-
# @return [String]
|
614
|
-
required :unit_amount, String
|
615
|
-
|
616
|
-
# @!method initialize(dimension_values:, unit_amount:)
|
617
|
-
# Some parameter documentations has been truncated, see
|
618
|
-
# {Orb::Models::PriceCreateParams::MatrixWithAllocationConfig::MatrixValue} for
|
619
|
-
# more details.
|
620
|
-
#
|
621
|
-
# @param dimension_values [Array<String, nil>] One or two matrix keys to filter usage to this Matrix value by. For example, ["r
|
622
|
-
#
|
623
|
-
# @param unit_amount [String] Unit price for the specified dimension_values
|
624
|
-
end
|
625
|
-
end
|
377
|
+
discriminator :conversion_rate_type
|
626
378
|
|
627
|
-
|
628
|
-
# @!attribute tiers
|
629
|
-
# Tiers for rating based on total usage quantities into the specified tier
|
630
|
-
#
|
631
|
-
# @return [Array<Orb::Models::PriceCreateParams::TieredConfig::Tier>]
|
632
|
-
required :tiers, -> { Orb::Internal::Type::ArrayOf[Orb::PriceCreateParams::TieredConfig::Tier] }
|
633
|
-
|
634
|
-
# @!method initialize(tiers:)
|
635
|
-
# @param tiers [Array<Orb::Models::PriceCreateParams::TieredConfig::Tier>] Tiers for rating based on total usage quantities into the specified tier
|
636
|
-
|
637
|
-
class Tier < Orb::Internal::Type::BaseModel
|
638
|
-
# @!attribute first_unit
|
639
|
-
# Exclusive tier starting value
|
640
|
-
#
|
641
|
-
# @return [Float]
|
642
|
-
required :first_unit, Float
|
643
|
-
|
644
|
-
# @!attribute unit_amount
|
645
|
-
# Amount per unit
|
646
|
-
#
|
647
|
-
# @return [String]
|
648
|
-
required :unit_amount, String
|
649
|
-
|
650
|
-
# @!attribute last_unit
|
651
|
-
# Inclusive tier ending value. If null, this is treated as the last tier
|
652
|
-
#
|
653
|
-
# @return [Float, nil]
|
654
|
-
optional :last_unit, Float, nil?: true
|
655
|
-
|
656
|
-
# @!method initialize(first_unit:, unit_amount:, last_unit: nil)
|
657
|
-
# @param first_unit [Float] Exclusive tier starting value
|
658
|
-
#
|
659
|
-
# @param unit_amount [String] Amount per unit
|
660
|
-
#
|
661
|
-
# @param last_unit [Float, nil] Inclusive tier ending value. If null, this is treated as the last tier
|
662
|
-
end
|
663
|
-
end
|
379
|
+
variant :unit, -> { Orb::UnitConversionRateConfig }
|
664
380
|
|
665
|
-
|
666
|
-
# @!attribute tiers
|
667
|
-
# Tiers for a Graduated BPS pricing model, where usage is bucketed into specified
|
668
|
-
# tiers
|
669
|
-
#
|
670
|
-
# @return [Array<Orb::Models::PriceCreateParams::TieredBpsConfig::Tier>]
|
671
|
-
required :tiers, -> { Orb::Internal::Type::ArrayOf[Orb::PriceCreateParams::TieredBpsConfig::Tier] }
|
672
|
-
|
673
|
-
# @!method initialize(tiers:)
|
674
|
-
# Some parameter documentations has been truncated, see
|
675
|
-
# {Orb::Models::PriceCreateParams::TieredBpsConfig} for more details.
|
676
|
-
#
|
677
|
-
# @param tiers [Array<Orb::Models::PriceCreateParams::TieredBpsConfig::Tier>] Tiers for a Graduated BPS pricing model, where usage is bucketed into specified
|
678
|
-
|
679
|
-
class Tier < Orb::Internal::Type::BaseModel
|
680
|
-
# @!attribute bps
|
681
|
-
# Per-event basis point rate
|
682
|
-
#
|
683
|
-
# @return [Float]
|
684
|
-
required :bps, Float
|
685
|
-
|
686
|
-
# @!attribute minimum_amount
|
687
|
-
# Exclusive tier starting value
|
688
|
-
#
|
689
|
-
# @return [String]
|
690
|
-
required :minimum_amount, String
|
691
|
-
|
692
|
-
# @!attribute maximum_amount
|
693
|
-
# Inclusive tier ending value
|
694
|
-
#
|
695
|
-
# @return [String, nil]
|
696
|
-
optional :maximum_amount, String, nil?: true
|
697
|
-
|
698
|
-
# @!attribute per_unit_maximum
|
699
|
-
# Per unit maximum to charge
|
700
|
-
#
|
701
|
-
# @return [String, nil]
|
702
|
-
optional :per_unit_maximum, String, nil?: true
|
703
|
-
|
704
|
-
# @!method initialize(bps:, minimum_amount:, maximum_amount: nil, per_unit_maximum: nil)
|
705
|
-
# @param bps [Float] Per-event basis point rate
|
706
|
-
#
|
707
|
-
# @param minimum_amount [String] Exclusive tier starting value
|
708
|
-
#
|
709
|
-
# @param maximum_amount [String, nil] Inclusive tier ending value
|
710
|
-
#
|
711
|
-
# @param per_unit_maximum [String, nil] Per unit maximum to charge
|
712
|
-
end
|
713
|
-
end
|
714
|
-
|
715
|
-
class BpsConfig < Orb::Internal::Type::BaseModel
|
716
|
-
# @!attribute bps
|
717
|
-
# Basis point take rate per event
|
718
|
-
#
|
719
|
-
# @return [Float]
|
720
|
-
required :bps, Float
|
721
|
-
|
722
|
-
# @!attribute per_unit_maximum
|
723
|
-
# Optional currency amount maximum to cap spend per event
|
724
|
-
#
|
725
|
-
# @return [String, nil]
|
726
|
-
optional :per_unit_maximum, String, nil?: true
|
727
|
-
|
728
|
-
# @!method initialize(bps:, per_unit_maximum: nil)
|
729
|
-
# @param bps [Float] Basis point take rate per event
|
730
|
-
#
|
731
|
-
# @param per_unit_maximum [String, nil] Optional currency amount maximum to cap spend per event
|
732
|
-
end
|
733
|
-
|
734
|
-
class BulkBpsConfig < Orb::Internal::Type::BaseModel
|
735
|
-
# @!attribute tiers
|
736
|
-
# Tiers for a bulk BPS pricing model where all usage is aggregated to a single
|
737
|
-
# tier based on total volume
|
738
|
-
#
|
739
|
-
# @return [Array<Orb::Models::PriceCreateParams::BulkBpsConfig::Tier>]
|
740
|
-
required :tiers, -> { Orb::Internal::Type::ArrayOf[Orb::PriceCreateParams::BulkBpsConfig::Tier] }
|
741
|
-
|
742
|
-
# @!method initialize(tiers:)
|
743
|
-
# Some parameter documentations has been truncated, see
|
744
|
-
# {Orb::Models::PriceCreateParams::BulkBpsConfig} for more details.
|
745
|
-
#
|
746
|
-
# @param tiers [Array<Orb::Models::PriceCreateParams::BulkBpsConfig::Tier>] Tiers for a bulk BPS pricing model where all usage is aggregated to a single tie
|
747
|
-
|
748
|
-
class Tier < Orb::Internal::Type::BaseModel
|
749
|
-
# @!attribute bps
|
750
|
-
# Basis points to rate on
|
751
|
-
#
|
752
|
-
# @return [Float]
|
753
|
-
required :bps, Float
|
754
|
-
|
755
|
-
# @!attribute maximum_amount
|
756
|
-
# Upper bound for tier
|
757
|
-
#
|
758
|
-
# @return [String, nil]
|
759
|
-
optional :maximum_amount, String, nil?: true
|
760
|
-
|
761
|
-
# @!attribute per_unit_maximum
|
762
|
-
# The maximum amount to charge for any one event
|
763
|
-
#
|
764
|
-
# @return [String, nil]
|
765
|
-
optional :per_unit_maximum, String, nil?: true
|
766
|
-
|
767
|
-
# @!method initialize(bps:, maximum_amount: nil, per_unit_maximum: nil)
|
768
|
-
# @param bps [Float] Basis points to rate on
|
769
|
-
#
|
770
|
-
# @param maximum_amount [String, nil] Upper bound for tier
|
771
|
-
#
|
772
|
-
# @param per_unit_maximum [String, nil] The maximum amount to charge for any one event
|
773
|
-
end
|
774
|
-
end
|
381
|
+
variant :tiered, -> { Orb::TieredConversionRateConfig }
|
775
382
|
|
776
|
-
|
777
|
-
#
|
778
|
-
# Bulk tiers for rating based on total usage volume
|
779
|
-
#
|
780
|
-
# @return [Array<Orb::Models::PriceCreateParams::BulkConfig::Tier>]
|
781
|
-
required :tiers, -> { Orb::Internal::Type::ArrayOf[Orb::PriceCreateParams::BulkConfig::Tier] }
|
782
|
-
|
783
|
-
# @!method initialize(tiers:)
|
784
|
-
# @param tiers [Array<Orb::Models::PriceCreateParams::BulkConfig::Tier>] Bulk tiers for rating based on total usage volume
|
785
|
-
|
786
|
-
class Tier < Orb::Internal::Type::BaseModel
|
787
|
-
# @!attribute unit_amount
|
788
|
-
# Amount per unit
|
789
|
-
#
|
790
|
-
# @return [String]
|
791
|
-
required :unit_amount, String
|
792
|
-
|
793
|
-
# @!attribute maximum_units
|
794
|
-
# Upper bound for this tier
|
795
|
-
#
|
796
|
-
# @return [Float, nil]
|
797
|
-
optional :maximum_units, Float, nil?: true
|
798
|
-
|
799
|
-
# @!method initialize(unit_amount:, maximum_units: nil)
|
800
|
-
# @param unit_amount [String] Amount per unit
|
801
|
-
#
|
802
|
-
# @param maximum_units [Float, nil] Upper bound for this tier
|
803
|
-
end
|
383
|
+
# @!method self.variants
|
384
|
+
# @return [Array(Orb::Models::UnitConversionRateConfig, Orb::Models::TieredConversionRateConfig)]
|
804
385
|
end
|
805
386
|
end
|
806
387
|
end
|