orb-billing 1.13.0 → 1.14.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 +43 -0
- data/README.md +1 -1
- data/lib/orb/client.rb +7 -0
- data/lib/orb/internal/util.rb +22 -7
- data/lib/orb/models/alert.rb +10 -1
- data/lib/orb/models/alert_create_for_customer_params.rb +8 -1
- data/lib/orb/models/alert_create_for_external_customer_params.rb +8 -1
- data/lib/orb/models/alert_create_for_subscription_params.rb +29 -1
- data/lib/orb/models/alert_disable_params.rb +8 -1
- data/lib/orb/models/alert_enable_params.rb +8 -1
- data/lib/orb/models/alert_retrieve_params.rb +7 -1
- data/lib/orb/models/alert_update_params.rb +8 -1
- data/lib/orb/models/beta/external_plan_id_create_plan_version_params.rb +17769 -414
- data/lib/orb/models/beta/external_plan_id_fetch_plan_version_params.rb +7 -1
- data/lib/orb/models/beta/external_plan_id_set_default_plan_version_params.rb +8 -1
- data/lib/orb/models/beta_create_plan_version_params.rb +17633 -406
- data/lib/orb/models/beta_fetch_plan_version_params.rb +7 -1
- data/lib/orb/models/beta_set_default_plan_version_params.rb +8 -1
- data/lib/orb/models/coupon_archive_params.rb +7 -1
- data/lib/orb/models/coupon_fetch_params.rb +7 -1
- data/lib/orb/models/coupons/subscription_list_params.rb +8 -1
- data/lib/orb/models/credit_block_delete_params.rb +7 -1
- data/lib/orb/models/credit_block_list_invoices_params.rb +7 -1
- data/lib/orb/models/credit_block_retrieve_params.rb +7 -1
- data/lib/orb/models/credit_note_fetch_params.rb +7 -1
- data/lib/orb/models/customer.rb +13 -1
- data/lib/orb/models/customer_create_params.rb +12 -1
- data/lib/orb/models/customer_delete_params.rb +7 -1
- data/lib/orb/models/customer_fetch_by_external_id_params.rb +7 -1
- data/lib/orb/models/customer_fetch_params.rb +7 -1
- data/lib/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rb +7 -1
- data/lib/orb/models/customer_sync_payment_methods_from_gateway_params.rb +7 -1
- data/lib/orb/models/customer_update_by_external_id_params.rb +25 -5
- data/lib/orb/models/customer_update_params.rb +25 -5
- data/lib/orb/models/customers/balance_transaction_create_params.rb +8 -1
- data/lib/orb/models/customers/balance_transaction_list_params.rb +8 -1
- data/lib/orb/models/customers/cost_list_by_external_id_params.rb +8 -1
- data/lib/orb/models/customers/cost_list_params.rb +8 -1
- data/lib/orb/models/customers/credit_list_by_external_id_params.rb +8 -1
- data/lib/orb/models/customers/credit_list_params.rb +8 -1
- data/lib/orb/models/customers/credits/decrement_ledger_entry.rb +5 -1
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +582 -315
- data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +580 -313
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +8 -1
- data/lib/orb/models/customers/credits/ledger_list_params.rb +8 -1
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +8 -1
- data/lib/orb/models/customers/credits/top_up_create_params.rb +8 -1
- data/lib/orb/models/customers/credits/top_up_delete_by_external_id_params.rb +7 -1
- data/lib/orb/models/customers/credits/top_up_delete_params.rb +7 -1
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rb +8 -1
- data/lib/orb/models/customers/credits/top_up_list_params.rb +8 -1
- data/lib/orb/models/dimensional_price_group_retrieve_params.rb +7 -1
- data/lib/orb/models/dimensional_price_group_update_params.rb +8 -1
- data/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rb +7 -1
- data/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_update_params.rb +8 -1
- data/lib/orb/models/event_deprecate_params.rb +7 -1
- data/lib/orb/models/event_update_params.rb +8 -1
- data/lib/orb/models/events/backfill_close_params.rb +7 -1
- data/lib/orb/models/events/backfill_fetch_params.rb +7 -1
- data/lib/orb/models/events/backfill_revert_params.rb +7 -1
- data/lib/orb/models/invoice_delete_line_item_params.rb +7 -1
- data/lib/orb/models/invoice_fetch_params.rb +7 -1
- data/lib/orb/models/invoice_issue_params.rb +8 -1
- data/lib/orb/models/invoice_issue_summary_params.rb +8 -1
- data/lib/orb/models/invoice_mark_paid_params.rb +8 -1
- data/lib/orb/models/invoice_pay_params.rb +16 -1
- data/lib/orb/models/invoice_update_params.rb +8 -1
- data/lib/orb/models/invoice_void_params.rb +7 -1
- data/lib/orb/models/item_archive_params.rb +7 -1
- data/lib/orb/models/item_fetch_params.rb +7 -1
- data/lib/orb/models/item_update_params.rb +8 -1
- data/lib/orb/models/license_deactivate_params.rb +8 -1
- data/lib/orb/models/license_retrieve_by_external_id_params.rb +8 -1
- data/lib/orb/models/license_retrieve_params.rb +7 -1
- data/lib/orb/models/license_type_retrieve_params.rb +7 -1
- data/lib/orb/models/licenses/external_license_get_usage_params.rb +8 -1
- data/lib/orb/models/licenses/usage_get_usage_params.rb +8 -1
- data/lib/orb/models/metric_fetch_params.rb +7 -1
- data/lib/orb/models/metric_update_params.rb +8 -1
- data/lib/orb/models/plan_create_params.rb +8502 -1
- data/lib/orb/models/plan_fetch_params.rb +7 -1
- data/lib/orb/models/plan_update_params.rb +8 -1
- data/lib/orb/models/plans/external_plan_id_fetch_params.rb +7 -1
- data/lib/orb/models/plans/external_plan_id_update_params.rb +8 -1
- data/lib/orb/models/plans/migration_cancel_params.rb +7 -1
- data/lib/orb/models/plans/migration_list_params.rb +8 -1
- data/lib/orb/models/plans/migration_retrieve_params.rb +7 -1
- data/lib/orb/models/price.rb +248 -31
- data/lib/orb/models/price_create_params.rb +949 -1321
- data/lib/orb/models/price_evaluate_params.rb +8 -1
- data/lib/orb/models/price_fetch_params.rb +7 -1
- data/lib/orb/models/price_update_params.rb +8 -1
- data/lib/orb/models/prices/external_price_id_fetch_params.rb +7 -1
- data/lib/orb/models/prices/external_price_id_update_params.rb +8 -1
- data/lib/orb/models/subscription_cancel_params.rb +8 -1
- data/lib/orb/models/subscription_change_apply_params.rb +8 -1
- data/lib/orb/models/subscription_change_cancel_params.rb +7 -1
- data/lib/orb/models/subscription_change_retrieve_params.rb +7 -1
- data/lib/orb/models/subscription_fetch_costs_params.rb +8 -1
- data/lib/orb/models/subscription_fetch_params.rb +7 -1
- data/lib/orb/models/subscription_fetch_schedule_params.rb +8 -1
- data/lib/orb/models/subscription_fetch_usage_params.rb +8 -1
- data/lib/orb/models/subscription_price_intervals_params.rb +8 -1
- data/lib/orb/models/subscription_redeem_coupon_params.rb +8 -1
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +8 -1
- data/lib/orb/models/subscription_trigger_phase_params.rb +8 -1
- data/lib/orb/models/subscription_unschedule_cancellation_params.rb +7 -1
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rb +8 -1
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_params.rb +7 -1
- data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +8 -1
- data/lib/orb/models/subscription_update_params.rb +8 -1
- data/lib/orb/models/subscription_update_trial_params.rb +8 -1
- data/lib/orb/resources/alerts.rb +8 -1
- data/lib/orb/resources/coupons.rb +1 -2
- data/lib/orb/resources/credit_blocks.rb +11 -8
- data/lib/orb/resources/customers/credits/ledger.rb +12 -67
- data/lib/orb/resources/customers.rb +6 -5
- data/lib/orb/resources/events/backfills.rb +3 -4
- data/lib/orb/resources/invoices.rb +12 -5
- data/lib/orb/resources/prices.rb +9 -100
- data/lib/orb/resources/subscriptions.rb +4 -4
- data/lib/orb/version.rb +1 -1
- data/rbi/orb/client.rbi +6 -0
- data/rbi/orb/internal/util.rbi +8 -0
- data/rbi/orb/models/alert.rbi +10 -0
- data/rbi/orb/models/alert_create_for_customer_params.rbi +6 -0
- data/rbi/orb/models/alert_create_for_external_customer_params.rbi +6 -0
- data/rbi/orb/models/alert_create_for_subscription_params.rbi +26 -0
- data/rbi/orb/models/alert_disable_params.rbi +6 -0
- data/rbi/orb/models/alert_enable_params.rbi +6 -0
- data/rbi/orb/models/alert_retrieve_params.rbi +13 -5
- data/rbi/orb/models/alert_update_params.rbi +6 -0
- data/rbi/orb/models/beta/external_plan_id_create_plan_version_params.rbi +30163 -889
- data/rbi/orb/models/beta/external_plan_id_fetch_plan_version_params.rbi +10 -2
- data/rbi/orb/models/beta/external_plan_id_set_default_plan_version_params.rbi +10 -1
- data/rbi/orb/models/beta_create_plan_version_params.rbi +30126 -884
- data/rbi/orb/models/beta_fetch_plan_version_params.rbi +10 -2
- data/rbi/orb/models/beta_set_default_plan_version_params.rbi +10 -1
- data/rbi/orb/models/coupon_archive_params.rbi +13 -5
- data/rbi/orb/models/coupon_fetch_params.rbi +13 -5
- data/rbi/orb/models/coupons/subscription_list_params.rbi +6 -0
- data/rbi/orb/models/credit_block_delete_params.rbi +13 -5
- data/rbi/orb/models/credit_block_list_invoices_params.rbi +13 -5
- data/rbi/orb/models/credit_block_retrieve_params.rbi +13 -5
- data/rbi/orb/models/credit_note_fetch_params.rbi +13 -5
- data/rbi/orb/models/customer.rbi +22 -0
- data/rbi/orb/models/customer_create_params.rbi +17 -0
- data/rbi/orb/models/customer_delete_params.rbi +13 -5
- data/rbi/orb/models/customer_fetch_by_external_id_params.rbi +13 -5
- data/rbi/orb/models/customer_fetch_params.rbi +13 -5
- data/rbi/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi +13 -5
- data/rbi/orb/models/customer_sync_payment_methods_from_gateway_params.rbi +13 -5
- data/rbi/orb/models/customer_update_by_external_id_params.rbi +31 -4
- data/rbi/orb/models/customer_update_params.rbi +31 -4
- data/rbi/orb/models/customers/balance_transaction_create_params.rbi +6 -0
- data/rbi/orb/models/customers/balance_transaction_list_params.rbi +6 -0
- data/rbi/orb/models/customers/cost_list_by_external_id_params.rbi +6 -0
- data/rbi/orb/models/customers/cost_list_params.rbi +6 -0
- data/rbi/orb/models/customers/credit_list_by_external_id_params.rbi +6 -0
- data/rbi/orb/models/customers/credit_list_params.rbi +6 -0
- data/rbi/orb/models/customers/credits/decrement_ledger_entry.rbi +4 -0
- data/rbi/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +861 -478
- data/rbi/orb/models/customers/credits/ledger_create_entry_params.rbi +861 -478
- data/rbi/orb/models/customers/credits/ledger_list_by_external_id_params.rbi +6 -0
- data/rbi/orb/models/customers/credits/ledger_list_params.rbi +6 -0
- data/rbi/orb/models/customers/credits/top_up_create_by_external_id_params.rbi +6 -0
- data/rbi/orb/models/customers/credits/top_up_create_params.rbi +6 -0
- data/rbi/orb/models/customers/credits/top_up_delete_by_external_id_params.rbi +6 -1
- data/rbi/orb/models/customers/credits/top_up_delete_params.rbi +10 -2
- data/rbi/orb/models/customers/credits/top_up_list_by_external_id_params.rbi +6 -0
- data/rbi/orb/models/customers/credits/top_up_list_params.rbi +6 -0
- data/rbi/orb/models/dimensional_price_group_retrieve_params.rbi +16 -5
- data/rbi/orb/models/dimensional_price_group_update_params.rbi +6 -0
- data/rbi/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi +16 -5
- data/rbi/orb/models/dimensional_price_groups/external_dimensional_price_group_id_update_params.rbi +6 -0
- data/rbi/orb/models/event_deprecate_params.rbi +13 -5
- data/rbi/orb/models/event_update_params.rbi +6 -0
- data/rbi/orb/models/events/backfill_close_params.rbi +13 -5
- data/rbi/orb/models/events/backfill_fetch_params.rbi +13 -5
- data/rbi/orb/models/events/backfill_revert_params.rbi +13 -5
- data/rbi/orb/models/invoice_delete_line_item_params.rbi +10 -2
- data/rbi/orb/models/invoice_fetch_params.rbi +13 -5
- data/rbi/orb/models/invoice_issue_params.rbi +10 -1
- data/rbi/orb/models/invoice_issue_summary_params.rbi +10 -1
- data/rbi/orb/models/invoice_mark_paid_params.rbi +6 -0
- data/rbi/orb/models/invoice_pay_params.rbi +27 -5
- data/rbi/orb/models/invoice_update_params.rbi +6 -0
- data/rbi/orb/models/invoice_void_params.rbi +13 -5
- data/rbi/orb/models/item_archive_params.rbi +13 -5
- data/rbi/orb/models/item_fetch_params.rbi +13 -5
- data/rbi/orb/models/item_update_params.rbi +6 -0
- data/rbi/orb/models/license_deactivate_params.rbi +10 -1
- data/rbi/orb/models/license_retrieve_by_external_id_params.rbi +6 -0
- data/rbi/orb/models/license_retrieve_params.rbi +13 -5
- data/rbi/orb/models/license_type_retrieve_params.rbi +13 -5
- data/rbi/orb/models/licenses/external_license_get_usage_params.rbi +6 -0
- data/rbi/orb/models/licenses/usage_get_usage_params.rbi +6 -0
- data/rbi/orb/models/metric_fetch_params.rbi +13 -5
- data/rbi/orb/models/metric_update_params.rbi +6 -0
- data/rbi/orb/models/plan_create_params.rbi +14618 -0
- data/rbi/orb/models/plan_fetch_params.rbi +13 -5
- data/rbi/orb/models/plan_update_params.rbi +6 -0
- data/rbi/orb/models/plans/external_plan_id_fetch_params.rbi +13 -5
- data/rbi/orb/models/plans/external_plan_id_update_params.rbi +6 -0
- data/rbi/orb/models/plans/migration_cancel_params.rbi +10 -2
- data/rbi/orb/models/plans/migration_list_params.rbi +6 -0
- data/rbi/orb/models/plans/migration_retrieve_params.rbi +10 -2
- data/rbi/orb/models/price.rbi +186 -0
- data/rbi/orb/models/price_create_params.rbi +1778 -2590
- data/rbi/orb/models/price_evaluate_params.rbi +6 -0
- data/rbi/orb/models/price_fetch_params.rbi +13 -5
- data/rbi/orb/models/price_update_params.rbi +6 -0
- data/rbi/orb/models/prices/external_price_id_fetch_params.rbi +13 -5
- data/rbi/orb/models/prices/external_price_id_update_params.rbi +6 -0
- data/rbi/orb/models/subscription_cancel_params.rbi +6 -0
- data/rbi/orb/models/subscription_change_apply_params.rbi +6 -0
- data/rbi/orb/models/subscription_change_cancel_params.rbi +16 -5
- data/rbi/orb/models/subscription_change_retrieve_params.rbi +16 -5
- data/rbi/orb/models/subscription_fetch_costs_params.rbi +6 -0
- data/rbi/orb/models/subscription_fetch_params.rbi +13 -5
- data/rbi/orb/models/subscription_fetch_schedule_params.rbi +6 -0
- data/rbi/orb/models/subscription_fetch_usage_params.rbi +6 -0
- data/rbi/orb/models/subscription_price_intervals_params.rbi +6 -0
- data/rbi/orb/models/subscription_redeem_coupon_params.rbi +6 -0
- data/rbi/orb/models/subscription_schedule_plan_change_params.rbi +6 -0
- data/rbi/orb/models/subscription_trigger_phase_params.rbi +6 -0
- data/rbi/orb/models/subscription_unschedule_cancellation_params.rbi +13 -5
- data/rbi/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +10 -1
- data/rbi/orb/models/subscription_unschedule_pending_plan_changes_params.rbi +13 -5
- data/rbi/orb/models/subscription_update_fixed_fee_quantity_params.rbi +6 -0
- data/rbi/orb/models/subscription_update_params.rbi +6 -0
- data/rbi/orb/models/subscription_update_trial_params.rbi +6 -0
- data/rbi/orb/resources/alerts.rbi +8 -0
- data/rbi/orb/resources/coupons.rbi +1 -2
- data/rbi/orb/resources/credit_blocks.rbi +10 -7
- data/rbi/orb/resources/customers/credits/ledger.rbi +22 -132
- data/rbi/orb/resources/customers.rbi +12 -7
- data/rbi/orb/resources/events/backfills.rbi +3 -4
- data/rbi/orb/resources/invoices.rbi +11 -3
- data/rbi/orb/resources/prices.rbi +35 -184
- data/rbi/orb/resources/subscriptions.rbi +4 -4
- data/sig/orb/client.rbs +3 -0
- data/sig/orb/internal/util.rbs +4 -0
- data/sig/orb/models/alert.rbs +5 -0
- data/sig/orb/models/alert_create_for_customer_params.rbs +5 -0
- data/sig/orb/models/alert_create_for_external_customer_params.rbs +5 -0
- data/sig/orb/models/alert_create_for_subscription_params.rbs +16 -1
- data/sig/orb/models/alert_disable_params.rbs +6 -1
- data/sig/orb/models/alert_enable_params.rbs +6 -1
- data/sig/orb/models/alert_retrieve_params.rbs +9 -3
- data/sig/orb/models/alert_update_params.rbs +5 -1
- data/sig/orb/models/beta/external_plan_id_create_plan_version_params.rbs +12092 -373
- data/sig/orb/models/beta/external_plan_id_fetch_plan_version_params.rbs +6 -1
- data/sig/orb/models/beta/external_plan_id_set_default_plan_version_params.rbs +6 -1
- data/sig/orb/models/beta_create_plan_version_params.rbs +12075 -370
- data/sig/orb/models/beta_fetch_plan_version_params.rbs +10 -2
- data/sig/orb/models/beta_set_default_plan_version_params.rbs +10 -2
- data/sig/orb/models/coupon_archive_params.rbs +12 -3
- data/sig/orb/models/coupon_fetch_params.rbs +12 -3
- data/sig/orb/models/coupons/subscription_list_params.rbs +5 -1
- data/sig/orb/models/credit_block_delete_params.rbs +8 -3
- data/sig/orb/models/credit_block_list_invoices_params.rbs +8 -3
- data/sig/orb/models/credit_block_retrieve_params.rbs +8 -3
- data/sig/orb/models/credit_note_fetch_params.rbs +11 -3
- data/sig/orb/models/customer.rbs +14 -2
- data/sig/orb/models/customer_create_params.rbs +12 -1
- data/sig/orb/models/customer_delete_params.rbs +12 -3
- data/sig/orb/models/customer_fetch_by_external_id_params.rbs +11 -3
- data/sig/orb/models/customer_fetch_params.rbs +12 -3
- data/sig/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbs +11 -3
- data/sig/orb/models/customer_sync_payment_methods_from_gateway_params.rbs +11 -3
- data/sig/orb/models/customer_update_by_external_id_params.rbs +17 -1
- data/sig/orb/models/customer_update_params.rbs +17 -1
- data/sig/orb/models/customers/balance_transaction_create_params.rbs +5 -0
- data/sig/orb/models/customers/balance_transaction_list_params.rbs +5 -0
- data/sig/orb/models/customers/cost_list_by_external_id_params.rbs +5 -0
- data/sig/orb/models/customers/cost_list_params.rbs +5 -0
- data/sig/orb/models/customers/credit_list_by_external_id_params.rbs +5 -0
- data/sig/orb/models/customers/credit_list_params.rbs +5 -0
- data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbs +345 -157
- data/sig/orb/models/customers/credits/ledger_create_entry_params.rbs +345 -157
- data/sig/orb/models/customers/credits/ledger_list_by_external_id_params.rbs +5 -0
- data/sig/orb/models/customers/credits/ledger_list_params.rbs +5 -0
- data/sig/orb/models/customers/credits/top_up_create_by_external_id_params.rbs +5 -0
- data/sig/orb/models/customers/credits/top_up_create_params.rbs +5 -0
- data/sig/orb/models/customers/credits/top_up_delete_by_external_id_params.rbs +5 -1
- data/sig/orb/models/customers/credits/top_up_delete_params.rbs +6 -1
- data/sig/orb/models/customers/credits/top_up_list_by_external_id_params.rbs +5 -1
- data/sig/orb/models/customers/credits/top_up_list_params.rbs +5 -1
- data/sig/orb/models/dimensional_price_group_retrieve_params.rbs +12 -3
- data/sig/orb/models/dimensional_price_group_update_params.rbs +5 -0
- data/sig/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbs +12 -3
- data/sig/orb/models/dimensional_price_groups/external_dimensional_price_group_id_update_params.rbs +5 -0
- data/sig/orb/models/event_deprecate_params.rbs +9 -3
- data/sig/orb/models/event_update_params.rbs +5 -0
- data/sig/orb/models/events/backfill_close_params.rbs +11 -3
- data/sig/orb/models/events/backfill_fetch_params.rbs +11 -3
- data/sig/orb/models/events/backfill_revert_params.rbs +11 -3
- data/sig/orb/models/invoice_delete_line_item_params.rbs +6 -1
- data/sig/orb/models/invoice_fetch_params.rbs +12 -3
- data/sig/orb/models/invoice_issue_params.rbs +6 -1
- data/sig/orb/models/invoice_issue_summary_params.rbs +6 -1
- data/sig/orb/models/invoice_mark_paid_params.rbs +10 -1
- data/sig/orb/models/invoice_pay_params.rbs +17 -3
- data/sig/orb/models/invoice_update_params.rbs +5 -0
- data/sig/orb/models/invoice_void_params.rbs +12 -3
- data/sig/orb/models/item_archive_params.rbs +9 -3
- data/sig/orb/models/item_fetch_params.rbs +9 -3
- data/sig/orb/models/item_update_params.rbs +5 -0
- data/sig/orb/models/license_deactivate_params.rbs +10 -2
- data/sig/orb/models/license_retrieve_by_external_id_params.rbs +9 -1
- data/sig/orb/models/license_retrieve_params.rbs +11 -3
- data/sig/orb/models/license_type_retrieve_params.rbs +11 -3
- data/sig/orb/models/licenses/external_license_get_usage_params.rbs +5 -0
- data/sig/orb/models/licenses/usage_get_usage_params.rbs +5 -0
- data/sig/orb/models/metric_fetch_params.rbs +12 -3
- data/sig/orb/models/metric_update_params.rbs +5 -1
- data/sig/orb/models/plan_create_params.rbs +5850 -0
- data/sig/orb/models/plan_fetch_params.rbs +9 -3
- data/sig/orb/models/plan_update_params.rbs +9 -1
- data/sig/orb/models/plans/external_plan_id_fetch_params.rbs +11 -3
- data/sig/orb/models/plans/external_plan_id_update_params.rbs +9 -1
- data/sig/orb/models/plans/migration_cancel_params.rbs +6 -1
- data/sig/orb/models/plans/migration_list_params.rbs +5 -1
- data/sig/orb/models/plans/migration_retrieve_params.rbs +6 -1
- data/sig/orb/models/price.rbs +155 -0
- data/sig/orb/models/price_create_params.rbs +616 -1011
- data/sig/orb/models/price_evaluate_params.rbs +5 -0
- data/sig/orb/models/price_fetch_params.rbs +9 -3
- data/sig/orb/models/price_update_params.rbs +5 -1
- data/sig/orb/models/prices/external_price_id_fetch_params.rbs +11 -3
- data/sig/orb/models/prices/external_price_id_update_params.rbs +5 -1
- data/sig/orb/models/subscription_cancel_params.rbs +5 -0
- data/sig/orb/models/subscription_change_apply_params.rbs +5 -0
- data/sig/orb/models/subscription_change_cancel_params.rbs +12 -3
- data/sig/orb/models/subscription_change_retrieve_params.rbs +12 -3
- data/sig/orb/models/subscription_fetch_costs_params.rbs +5 -0
- data/sig/orb/models/subscription_fetch_params.rbs +11 -3
- data/sig/orb/models/subscription_fetch_schedule_params.rbs +5 -0
- data/sig/orb/models/subscription_fetch_usage_params.rbs +5 -0
- data/sig/orb/models/subscription_price_intervals_params.rbs +5 -0
- data/sig/orb/models/subscription_redeem_coupon_params.rbs +5 -0
- data/sig/orb/models/subscription_schedule_plan_change_params.rbs +5 -0
- data/sig/orb/models/subscription_trigger_phase_params.rbs +9 -1
- data/sig/orb/models/subscription_unschedule_cancellation_params.rbs +11 -3
- data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbs +10 -2
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_params.rbs +11 -3
- data/sig/orb/models/subscription_update_fixed_fee_quantity_params.rbs +5 -0
- data/sig/orb/models/subscription_update_params.rbs +5 -0
- data/sig/orb/models/subscription_update_trial_params.rbs +5 -0
- data/sig/orb/resources/alerts.rbs +2 -0
- data/sig/orb/resources/customers/credits/ledger.rbs +2 -26
- data/sig/orb/resources/invoices.rbs +1 -0
- data/sig/orb/resources/prices.rbs +1 -48
- metadata +2 -2
data/lib/orb/models/price.rb
CHANGED
|
@@ -153,6 +153,11 @@ module Orb
|
|
|
153
153
|
# @return [Float, nil]
|
|
154
154
|
required :fixed_price_quantity, Float, nil?: true
|
|
155
155
|
|
|
156
|
+
# @!attribute invoice_grouping_key
|
|
157
|
+
#
|
|
158
|
+
# @return [String, nil]
|
|
159
|
+
required :invoice_grouping_key, String, nil?: true
|
|
160
|
+
|
|
156
161
|
# @!attribute invoicing_cycle_configuration
|
|
157
162
|
#
|
|
158
163
|
# @return [Orb::Models::BillingCycleConfiguration, nil]
|
|
@@ -245,7 +250,7 @@ module Orb
|
|
|
245
250
|
# @return [Orb::Models::Price::Unit::LicenseType, nil]
|
|
246
251
|
optional :license_type, -> { Orb::Price::Unit::LicenseType }, nil?: true
|
|
247
252
|
|
|
248
|
-
# @!method initialize(id:, billable_metric:, billing_cycle_configuration:, billing_mode:, cadence:, composite_price_filters:, conversion_rate:, conversion_rate_config:, created_at:, credit_allocation:, currency:, discount:, external_price_id:, fixed_price_quantity:, invoicing_cycle_configuration:, item:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, plan_phase_order:, price_type:, replaces_price_id:, unit_config:, dimensional_price_configuration: nil, license_type: nil, model_type: :unit)
|
|
253
|
+
# @!method initialize(id:, billable_metric:, billing_cycle_configuration:, billing_mode:, cadence:, composite_price_filters:, conversion_rate:, conversion_rate_config:, created_at:, credit_allocation:, currency:, discount:, external_price_id:, fixed_price_quantity:, invoice_grouping_key:, invoicing_cycle_configuration:, item:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, plan_phase_order:, price_type:, replaces_price_id:, unit_config:, dimensional_price_configuration: nil, license_type: nil, model_type: :unit)
|
|
249
254
|
# Some parameter documentations has been truncated, see {Orb::Models::Price::Unit}
|
|
250
255
|
# for more details.
|
|
251
256
|
#
|
|
@@ -277,6 +282,8 @@ module Orb
|
|
|
277
282
|
#
|
|
278
283
|
# @param fixed_price_quantity [Float, nil]
|
|
279
284
|
#
|
|
285
|
+
# @param invoice_grouping_key [String, nil]
|
|
286
|
+
#
|
|
280
287
|
# @param invoicing_cycle_configuration [Orb::Models::BillingCycleConfiguration, nil]
|
|
281
288
|
#
|
|
282
289
|
# @param item [Orb::Models::ItemSlim] A minimal representation of an Item containing only the essential identifying in
|
|
@@ -512,6 +519,11 @@ module Orb
|
|
|
512
519
|
# @return [Float, nil]
|
|
513
520
|
required :fixed_price_quantity, Float, nil?: true
|
|
514
521
|
|
|
522
|
+
# @!attribute invoice_grouping_key
|
|
523
|
+
#
|
|
524
|
+
# @return [String, nil]
|
|
525
|
+
required :invoice_grouping_key, String, nil?: true
|
|
526
|
+
|
|
515
527
|
# @!attribute invoicing_cycle_configuration
|
|
516
528
|
#
|
|
517
529
|
# @return [Orb::Models::BillingCycleConfiguration, nil]
|
|
@@ -604,7 +616,7 @@ module Orb
|
|
|
604
616
|
# @return [Orb::Models::Price::Tiered::LicenseType, nil]
|
|
605
617
|
optional :license_type, -> { Orb::Price::Tiered::LicenseType }, nil?: true
|
|
606
618
|
|
|
607
|
-
# @!method initialize(id:, billable_metric:, billing_cycle_configuration:, billing_mode:, cadence:, composite_price_filters:, conversion_rate:, conversion_rate_config:, created_at:, credit_allocation:, currency:, discount:, external_price_id:, fixed_price_quantity:, invoicing_cycle_configuration:, item:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, plan_phase_order:, price_type:, replaces_price_id:, tiered_config:, dimensional_price_configuration: nil, license_type: nil, model_type: :tiered)
|
|
619
|
+
# @!method initialize(id:, billable_metric:, billing_cycle_configuration:, billing_mode:, cadence:, composite_price_filters:, conversion_rate:, conversion_rate_config:, created_at:, credit_allocation:, currency:, discount:, external_price_id:, fixed_price_quantity:, invoice_grouping_key:, invoicing_cycle_configuration:, item:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, plan_phase_order:, price_type:, replaces_price_id:, tiered_config:, dimensional_price_configuration: nil, license_type: nil, model_type: :tiered)
|
|
608
620
|
# Some parameter documentations has been truncated, see
|
|
609
621
|
# {Orb::Models::Price::Tiered} for more details.
|
|
610
622
|
#
|
|
@@ -636,6 +648,8 @@ module Orb
|
|
|
636
648
|
#
|
|
637
649
|
# @param fixed_price_quantity [Float, nil]
|
|
638
650
|
#
|
|
651
|
+
# @param invoice_grouping_key [String, nil]
|
|
652
|
+
#
|
|
639
653
|
# @param invoicing_cycle_configuration [Orb::Models::BillingCycleConfiguration, nil]
|
|
640
654
|
#
|
|
641
655
|
# @param item [Orb::Models::ItemSlim] A minimal representation of an Item containing only the essential identifying in
|
|
@@ -877,6 +891,11 @@ module Orb
|
|
|
877
891
|
# @return [Float, nil]
|
|
878
892
|
required :fixed_price_quantity, Float, nil?: true
|
|
879
893
|
|
|
894
|
+
# @!attribute invoice_grouping_key
|
|
895
|
+
#
|
|
896
|
+
# @return [String, nil]
|
|
897
|
+
required :invoice_grouping_key, String, nil?: true
|
|
898
|
+
|
|
880
899
|
# @!attribute invoicing_cycle_configuration
|
|
881
900
|
#
|
|
882
901
|
# @return [Orb::Models::BillingCycleConfiguration, nil]
|
|
@@ -963,7 +982,7 @@ module Orb
|
|
|
963
982
|
# @return [Orb::Models::Price::Bulk::LicenseType, nil]
|
|
964
983
|
optional :license_type, -> { Orb::Price::Bulk::LicenseType }, nil?: true
|
|
965
984
|
|
|
966
|
-
# @!method initialize(id:, billable_metric:, billing_cycle_configuration:, billing_mode:, bulk_config:, cadence:, composite_price_filters:, conversion_rate:, conversion_rate_config:, created_at:, credit_allocation:, currency:, discount:, external_price_id:, fixed_price_quantity:, invoicing_cycle_configuration:, item:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, plan_phase_order:, price_type:, replaces_price_id:, dimensional_price_configuration: nil, license_type: nil, model_type: :bulk)
|
|
985
|
+
# @!method initialize(id:, billable_metric:, billing_cycle_configuration:, billing_mode:, bulk_config:, cadence:, composite_price_filters:, conversion_rate:, conversion_rate_config:, created_at:, credit_allocation:, currency:, discount:, external_price_id:, fixed_price_quantity:, invoice_grouping_key:, invoicing_cycle_configuration:, item:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, plan_phase_order:, price_type:, replaces_price_id:, dimensional_price_configuration: nil, license_type: nil, model_type: :bulk)
|
|
967
986
|
# Some parameter documentations has been truncated, see {Orb::Models::Price::Bulk}
|
|
968
987
|
# for more details.
|
|
969
988
|
#
|
|
@@ -997,6 +1016,8 @@ module Orb
|
|
|
997
1016
|
#
|
|
998
1017
|
# @param fixed_price_quantity [Float, nil]
|
|
999
1018
|
#
|
|
1019
|
+
# @param invoice_grouping_key [String, nil]
|
|
1020
|
+
#
|
|
1000
1021
|
# @param invoicing_cycle_configuration [Orb::Models::BillingCycleConfiguration, nil]
|
|
1001
1022
|
#
|
|
1002
1023
|
# @param item [Orb::Models::ItemSlim] A minimal representation of an Item containing only the essential identifying in
|
|
@@ -1238,6 +1259,11 @@ module Orb
|
|
|
1238
1259
|
# @return [Float, nil]
|
|
1239
1260
|
required :fixed_price_quantity, Float, nil?: true
|
|
1240
1261
|
|
|
1262
|
+
# @!attribute invoice_grouping_key
|
|
1263
|
+
#
|
|
1264
|
+
# @return [String, nil]
|
|
1265
|
+
required :invoice_grouping_key, String, nil?: true
|
|
1266
|
+
|
|
1241
1267
|
# @!attribute invoicing_cycle_configuration
|
|
1242
1268
|
#
|
|
1243
1269
|
# @return [Orb::Models::BillingCycleConfiguration, nil]
|
|
@@ -1324,7 +1350,7 @@ module Orb
|
|
|
1324
1350
|
# @return [Orb::Models::Price::BulkWithFilters::LicenseType, nil]
|
|
1325
1351
|
optional :license_type, -> { Orb::Price::BulkWithFilters::LicenseType }, nil?: true
|
|
1326
1352
|
|
|
1327
|
-
# @!method initialize(id:, billable_metric:, billing_cycle_configuration:, billing_mode:, bulk_with_filters_config:, cadence:, composite_price_filters:, conversion_rate:, conversion_rate_config:, created_at:, credit_allocation:, currency:, discount:, external_price_id:, fixed_price_quantity:, invoicing_cycle_configuration:, item:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, plan_phase_order:, price_type:, replaces_price_id:, dimensional_price_configuration: nil, license_type: nil, model_type: :bulk_with_filters)
|
|
1353
|
+
# @!method initialize(id:, billable_metric:, billing_cycle_configuration:, billing_mode:, bulk_with_filters_config:, cadence:, composite_price_filters:, conversion_rate:, conversion_rate_config:, created_at:, credit_allocation:, currency:, discount:, external_price_id:, fixed_price_quantity:, invoice_grouping_key:, invoicing_cycle_configuration:, item:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, plan_phase_order:, price_type:, replaces_price_id:, dimensional_price_configuration: nil, license_type: nil, model_type: :bulk_with_filters)
|
|
1328
1354
|
# Some parameter documentations has been truncated, see
|
|
1329
1355
|
# {Orb::Models::Price::BulkWithFilters} for more details.
|
|
1330
1356
|
#
|
|
@@ -1358,6 +1384,8 @@ module Orb
|
|
|
1358
1384
|
#
|
|
1359
1385
|
# @param fixed_price_quantity [Float, nil]
|
|
1360
1386
|
#
|
|
1387
|
+
# @param invoice_grouping_key [String, nil]
|
|
1388
|
+
#
|
|
1361
1389
|
# @param invoicing_cycle_configuration [Orb::Models::BillingCycleConfiguration, nil]
|
|
1362
1390
|
#
|
|
1363
1391
|
# @param item [Orb::Models::ItemSlim] A minimal representation of an Item containing only the essential identifying in
|
|
@@ -1657,6 +1685,11 @@ module Orb
|
|
|
1657
1685
|
# @return [Float, nil]
|
|
1658
1686
|
required :fixed_price_quantity, Float, nil?: true
|
|
1659
1687
|
|
|
1688
|
+
# @!attribute invoice_grouping_key
|
|
1689
|
+
#
|
|
1690
|
+
# @return [String, nil]
|
|
1691
|
+
required :invoice_grouping_key, String, nil?: true
|
|
1692
|
+
|
|
1660
1693
|
# @!attribute invoicing_cycle_configuration
|
|
1661
1694
|
#
|
|
1662
1695
|
# @return [Orb::Models::BillingCycleConfiguration, nil]
|
|
@@ -1749,7 +1782,7 @@ module Orb
|
|
|
1749
1782
|
# @return [Orb::Models::Price::Package::LicenseType, nil]
|
|
1750
1783
|
optional :license_type, -> { Orb::Price::Package::LicenseType }, nil?: true
|
|
1751
1784
|
|
|
1752
|
-
# @!method initialize(id:, billable_metric:, billing_cycle_configuration:, billing_mode:, cadence:, composite_price_filters:, conversion_rate:, conversion_rate_config:, created_at:, credit_allocation:, currency:, discount:, external_price_id:, fixed_price_quantity:, invoicing_cycle_configuration:, item:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, package_config:, plan_phase_order:, price_type:, replaces_price_id:, dimensional_price_configuration: nil, license_type: nil, model_type: :package)
|
|
1785
|
+
# @!method initialize(id:, billable_metric:, billing_cycle_configuration:, billing_mode:, cadence:, composite_price_filters:, conversion_rate:, conversion_rate_config:, created_at:, credit_allocation:, currency:, discount:, external_price_id:, fixed_price_quantity:, invoice_grouping_key:, invoicing_cycle_configuration:, item:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, package_config:, plan_phase_order:, price_type:, replaces_price_id:, dimensional_price_configuration: nil, license_type: nil, model_type: :package)
|
|
1753
1786
|
# Some parameter documentations has been truncated, see
|
|
1754
1787
|
# {Orb::Models::Price::Package} for more details.
|
|
1755
1788
|
#
|
|
@@ -1781,6 +1814,8 @@ module Orb
|
|
|
1781
1814
|
#
|
|
1782
1815
|
# @param fixed_price_quantity [Float, nil]
|
|
1783
1816
|
#
|
|
1817
|
+
# @param invoice_grouping_key [String, nil]
|
|
1818
|
+
#
|
|
1784
1819
|
# @param invoicing_cycle_configuration [Orb::Models::BillingCycleConfiguration, nil]
|
|
1785
1820
|
#
|
|
1786
1821
|
# @param item [Orb::Models::ItemSlim] A minimal representation of an Item containing only the essential identifying in
|
|
@@ -2016,6 +2051,11 @@ module Orb
|
|
|
2016
2051
|
# @return [Float, nil]
|
|
2017
2052
|
required :fixed_price_quantity, Float, nil?: true
|
|
2018
2053
|
|
|
2054
|
+
# @!attribute invoice_grouping_key
|
|
2055
|
+
#
|
|
2056
|
+
# @return [String, nil]
|
|
2057
|
+
required :invoice_grouping_key, String, nil?: true
|
|
2058
|
+
|
|
2019
2059
|
# @!attribute invoicing_cycle_configuration
|
|
2020
2060
|
#
|
|
2021
2061
|
# @return [Orb::Models::BillingCycleConfiguration, nil]
|
|
@@ -2108,7 +2148,7 @@ module Orb
|
|
|
2108
2148
|
# @return [Orb::Models::Price::Matrix::LicenseType, nil]
|
|
2109
2149
|
optional :license_type, -> { Orb::Price::Matrix::LicenseType }, nil?: true
|
|
2110
2150
|
|
|
2111
|
-
# @!method initialize(id:, billable_metric:, billing_cycle_configuration:, billing_mode:, cadence:, composite_price_filters:, conversion_rate:, conversion_rate_config:, created_at:, credit_allocation:, currency:, discount:, external_price_id:, fixed_price_quantity:, invoicing_cycle_configuration:, item:, matrix_config:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, plan_phase_order:, price_type:, replaces_price_id:, dimensional_price_configuration: nil, license_type: nil, model_type: :matrix)
|
|
2151
|
+
# @!method initialize(id:, billable_metric:, billing_cycle_configuration:, billing_mode:, cadence:, composite_price_filters:, conversion_rate:, conversion_rate_config:, created_at:, credit_allocation:, currency:, discount:, external_price_id:, fixed_price_quantity:, invoice_grouping_key:, invoicing_cycle_configuration:, item:, matrix_config:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, plan_phase_order:, price_type:, replaces_price_id:, dimensional_price_configuration: nil, license_type: nil, model_type: :matrix)
|
|
2112
2152
|
# Some parameter documentations has been truncated, see
|
|
2113
2153
|
# {Orb::Models::Price::Matrix} for more details.
|
|
2114
2154
|
#
|
|
@@ -2140,6 +2180,8 @@ module Orb
|
|
|
2140
2180
|
#
|
|
2141
2181
|
# @param fixed_price_quantity [Float, nil]
|
|
2142
2182
|
#
|
|
2183
|
+
# @param invoice_grouping_key [String, nil]
|
|
2184
|
+
#
|
|
2143
2185
|
# @param invoicing_cycle_configuration [Orb::Models::BillingCycleConfiguration, nil]
|
|
2144
2186
|
#
|
|
2145
2187
|
# @param item [Orb::Models::ItemSlim] A minimal representation of an Item containing only the essential identifying in
|
|
@@ -2377,6 +2419,11 @@ module Orb
|
|
|
2377
2419
|
# @return [Float, nil]
|
|
2378
2420
|
required :fixed_price_quantity, Float, nil?: true
|
|
2379
2421
|
|
|
2422
|
+
# @!attribute invoice_grouping_key
|
|
2423
|
+
#
|
|
2424
|
+
# @return [String, nil]
|
|
2425
|
+
required :invoice_grouping_key, String, nil?: true
|
|
2426
|
+
|
|
2380
2427
|
# @!attribute invoicing_cycle_configuration
|
|
2381
2428
|
#
|
|
2382
2429
|
# @return [Orb::Models::BillingCycleConfiguration, nil]
|
|
@@ -2470,7 +2517,7 @@ module Orb
|
|
|
2470
2517
|
# @return [Orb::Models::Price::ThresholdTotalAmount::LicenseType, nil]
|
|
2471
2518
|
optional :license_type, -> { Orb::Price::ThresholdTotalAmount::LicenseType }, nil?: true
|
|
2472
2519
|
|
|
2473
|
-
# @!method initialize(id:, billable_metric:, billing_cycle_configuration:, billing_mode:, cadence:, composite_price_filters:, conversion_rate:, conversion_rate_config:, created_at:, credit_allocation:, currency:, discount:, external_price_id:, fixed_price_quantity:, invoicing_cycle_configuration:, item:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, plan_phase_order:, price_type:, replaces_price_id:, threshold_total_amount_config:, dimensional_price_configuration: nil, license_type: nil, model_type: :threshold_total_amount)
|
|
2520
|
+
# @!method initialize(id:, billable_metric:, billing_cycle_configuration:, billing_mode:, cadence:, composite_price_filters:, conversion_rate:, conversion_rate_config:, created_at:, credit_allocation:, currency:, discount:, external_price_id:, fixed_price_quantity:, invoice_grouping_key:, invoicing_cycle_configuration:, item:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, plan_phase_order:, price_type:, replaces_price_id:, threshold_total_amount_config:, dimensional_price_configuration: nil, license_type: nil, model_type: :threshold_total_amount)
|
|
2474
2521
|
# Some parameter documentations has been truncated, see
|
|
2475
2522
|
# {Orb::Models::Price::ThresholdTotalAmount} for more details.
|
|
2476
2523
|
#
|
|
@@ -2502,6 +2549,8 @@ module Orb
|
|
|
2502
2549
|
#
|
|
2503
2550
|
# @param fixed_price_quantity [Float, nil]
|
|
2504
2551
|
#
|
|
2552
|
+
# @param invoice_grouping_key [String, nil]
|
|
2553
|
+
#
|
|
2505
2554
|
# @param invoicing_cycle_configuration [Orb::Models::BillingCycleConfiguration, nil]
|
|
2506
2555
|
#
|
|
2507
2556
|
# @param item [Orb::Models::ItemSlim] A minimal representation of an Item containing only the essential identifying in
|
|
@@ -2787,6 +2836,11 @@ module Orb
|
|
|
2787
2836
|
# @return [Float, nil]
|
|
2788
2837
|
required :fixed_price_quantity, Float, nil?: true
|
|
2789
2838
|
|
|
2839
|
+
# @!attribute invoice_grouping_key
|
|
2840
|
+
#
|
|
2841
|
+
# @return [String, nil]
|
|
2842
|
+
required :invoice_grouping_key, String, nil?: true
|
|
2843
|
+
|
|
2790
2844
|
# @!attribute invoicing_cycle_configuration
|
|
2791
2845
|
#
|
|
2792
2846
|
# @return [Orb::Models::BillingCycleConfiguration, nil]
|
|
@@ -2879,7 +2933,7 @@ module Orb
|
|
|
2879
2933
|
# @return [Orb::Models::Price::TieredPackage::LicenseType, nil]
|
|
2880
2934
|
optional :license_type, -> { Orb::Price::TieredPackage::LicenseType }, nil?: true
|
|
2881
2935
|
|
|
2882
|
-
# @!method initialize(id:, billable_metric:, billing_cycle_configuration:, billing_mode:, cadence:, composite_price_filters:, conversion_rate:, conversion_rate_config:, created_at:, credit_allocation:, currency:, discount:, external_price_id:, fixed_price_quantity:, invoicing_cycle_configuration:, item:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, plan_phase_order:, price_type:, replaces_price_id:, tiered_package_config:, dimensional_price_configuration: nil, license_type: nil, model_type: :tiered_package)
|
|
2936
|
+
# @!method initialize(id:, billable_metric:, billing_cycle_configuration:, billing_mode:, cadence:, composite_price_filters:, conversion_rate:, conversion_rate_config:, created_at:, credit_allocation:, currency:, discount:, external_price_id:, fixed_price_quantity:, invoice_grouping_key:, invoicing_cycle_configuration:, item:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, plan_phase_order:, price_type:, replaces_price_id:, tiered_package_config:, dimensional_price_configuration: nil, license_type: nil, model_type: :tiered_package)
|
|
2883
2937
|
# Some parameter documentations has been truncated, see
|
|
2884
2938
|
# {Orb::Models::Price::TieredPackage} for more details.
|
|
2885
2939
|
#
|
|
@@ -2911,6 +2965,8 @@ module Orb
|
|
|
2911
2965
|
#
|
|
2912
2966
|
# @param fixed_price_quantity [Float, nil]
|
|
2913
2967
|
#
|
|
2968
|
+
# @param invoice_grouping_key [String, nil]
|
|
2969
|
+
#
|
|
2914
2970
|
# @param invoicing_cycle_configuration [Orb::Models::BillingCycleConfiguration, nil]
|
|
2915
2971
|
#
|
|
2916
2972
|
# @param item [Orb::Models::ItemSlim] A minimal representation of an Item containing only the essential identifying in
|
|
@@ -3195,6 +3251,11 @@ module Orb
|
|
|
3195
3251
|
# @return [Float, nil]
|
|
3196
3252
|
required :fixed_price_quantity, Float, nil?: true
|
|
3197
3253
|
|
|
3254
|
+
# @!attribute invoice_grouping_key
|
|
3255
|
+
#
|
|
3256
|
+
# @return [String, nil]
|
|
3257
|
+
required :invoice_grouping_key, String, nil?: true
|
|
3258
|
+
|
|
3198
3259
|
# @!attribute invoicing_cycle_configuration
|
|
3199
3260
|
#
|
|
3200
3261
|
# @return [Orb::Models::BillingCycleConfiguration, nil]
|
|
@@ -3287,7 +3348,7 @@ module Orb
|
|
|
3287
3348
|
# @return [Orb::Models::Price::TieredWithMinimum::LicenseType, nil]
|
|
3288
3349
|
optional :license_type, -> { Orb::Price::TieredWithMinimum::LicenseType }, nil?: true
|
|
3289
3350
|
|
|
3290
|
-
# @!method initialize(id:, billable_metric:, billing_cycle_configuration:, billing_mode:, cadence:, composite_price_filters:, conversion_rate:, conversion_rate_config:, created_at:, credit_allocation:, currency:, discount:, external_price_id:, fixed_price_quantity:, invoicing_cycle_configuration:, item:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, plan_phase_order:, price_type:, replaces_price_id:, tiered_with_minimum_config:, dimensional_price_configuration: nil, license_type: nil, model_type: :tiered_with_minimum)
|
|
3351
|
+
# @!method initialize(id:, billable_metric:, billing_cycle_configuration:, billing_mode:, cadence:, composite_price_filters:, conversion_rate:, conversion_rate_config:, created_at:, credit_allocation:, currency:, discount:, external_price_id:, fixed_price_quantity:, invoice_grouping_key:, invoicing_cycle_configuration:, item:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, plan_phase_order:, price_type:, replaces_price_id:, tiered_with_minimum_config:, dimensional_price_configuration: nil, license_type: nil, model_type: :tiered_with_minimum)
|
|
3291
3352
|
# Some parameter documentations has been truncated, see
|
|
3292
3353
|
# {Orb::Models::Price::TieredWithMinimum} for more details.
|
|
3293
3354
|
#
|
|
@@ -3319,6 +3380,8 @@ module Orb
|
|
|
3319
3380
|
#
|
|
3320
3381
|
# @param fixed_price_quantity [Float, nil]
|
|
3321
3382
|
#
|
|
3383
|
+
# @param invoice_grouping_key [String, nil]
|
|
3384
|
+
#
|
|
3322
3385
|
# @param invoicing_cycle_configuration [Orb::Models::BillingCycleConfiguration, nil]
|
|
3323
3386
|
#
|
|
3324
3387
|
# @param item [Orb::Models::ItemSlim] A minimal representation of an Item containing only the essential identifying in
|
|
@@ -3625,6 +3688,11 @@ module Orb
|
|
|
3625
3688
|
# @return [Orb::Models::Price::GroupedTiered::GroupedTieredConfig]
|
|
3626
3689
|
required :grouped_tiered_config, -> { Orb::Price::GroupedTiered::GroupedTieredConfig }
|
|
3627
3690
|
|
|
3691
|
+
# @!attribute invoice_grouping_key
|
|
3692
|
+
#
|
|
3693
|
+
# @return [String, nil]
|
|
3694
|
+
required :invoice_grouping_key, String, nil?: true
|
|
3695
|
+
|
|
3628
3696
|
# @!attribute invoicing_cycle_configuration
|
|
3629
3697
|
#
|
|
3630
3698
|
# @return [Orb::Models::BillingCycleConfiguration, nil]
|
|
@@ -3711,7 +3779,7 @@ module Orb
|
|
|
3711
3779
|
# @return [Orb::Models::Price::GroupedTiered::LicenseType, nil]
|
|
3712
3780
|
optional :license_type, -> { Orb::Price::GroupedTiered::LicenseType }, nil?: true
|
|
3713
3781
|
|
|
3714
|
-
# @!method initialize(id:, billable_metric:, billing_cycle_configuration:, billing_mode:, cadence:, composite_price_filters:, conversion_rate:, conversion_rate_config:, created_at:, credit_allocation:, currency:, discount:, external_price_id:, fixed_price_quantity:, grouped_tiered_config:, invoicing_cycle_configuration:, item:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, plan_phase_order:, price_type:, replaces_price_id:, dimensional_price_configuration: nil, license_type: nil, model_type: :grouped_tiered)
|
|
3782
|
+
# @!method initialize(id:, billable_metric:, billing_cycle_configuration:, billing_mode:, cadence:, composite_price_filters:, conversion_rate:, conversion_rate_config:, created_at:, credit_allocation:, currency:, discount:, external_price_id:, fixed_price_quantity:, grouped_tiered_config:, invoice_grouping_key:, invoicing_cycle_configuration:, item:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, plan_phase_order:, price_type:, replaces_price_id:, dimensional_price_configuration: nil, license_type: nil, model_type: :grouped_tiered)
|
|
3715
3783
|
# Some parameter documentations has been truncated, see
|
|
3716
3784
|
# {Orb::Models::Price::GroupedTiered} for more details.
|
|
3717
3785
|
#
|
|
@@ -3745,6 +3813,8 @@ module Orb
|
|
|
3745
3813
|
#
|
|
3746
3814
|
# @param grouped_tiered_config [Orb::Models::Price::GroupedTiered::GroupedTieredConfig] Configuration for grouped_tiered pricing
|
|
3747
3815
|
#
|
|
3816
|
+
# @param invoice_grouping_key [String, nil]
|
|
3817
|
+
#
|
|
3748
3818
|
# @param invoicing_cycle_configuration [Orb::Models::BillingCycleConfiguration, nil]
|
|
3749
3819
|
#
|
|
3750
3820
|
# @param item [Orb::Models::ItemSlim] A minimal representation of an Item containing only the essential identifying in
|
|
@@ -4028,6 +4098,11 @@ module Orb
|
|
|
4028
4098
|
# @return [Float, nil]
|
|
4029
4099
|
required :fixed_price_quantity, Float, nil?: true
|
|
4030
4100
|
|
|
4101
|
+
# @!attribute invoice_grouping_key
|
|
4102
|
+
#
|
|
4103
|
+
# @return [String, nil]
|
|
4104
|
+
required :invoice_grouping_key, String, nil?: true
|
|
4105
|
+
|
|
4031
4106
|
# @!attribute invoicing_cycle_configuration
|
|
4032
4107
|
#
|
|
4033
4108
|
# @return [Orb::Models::BillingCycleConfiguration, nil]
|
|
@@ -4121,7 +4196,7 @@ module Orb
|
|
|
4121
4196
|
# @return [Orb::Models::Price::TieredPackageWithMinimum::LicenseType, nil]
|
|
4122
4197
|
optional :license_type, -> { Orb::Price::TieredPackageWithMinimum::LicenseType }, nil?: true
|
|
4123
4198
|
|
|
4124
|
-
# @!method initialize(id:, billable_metric:, billing_cycle_configuration:, billing_mode:, cadence:, composite_price_filters:, conversion_rate:, conversion_rate_config:, created_at:, credit_allocation:, currency:, discount:, external_price_id:, fixed_price_quantity:, invoicing_cycle_configuration:, item:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, plan_phase_order:, price_type:, replaces_price_id:, tiered_package_with_minimum_config:, dimensional_price_configuration: nil, license_type: nil, model_type: :tiered_package_with_minimum)
|
|
4199
|
+
# @!method initialize(id:, billable_metric:, billing_cycle_configuration:, billing_mode:, cadence:, composite_price_filters:, conversion_rate:, conversion_rate_config:, created_at:, credit_allocation:, currency:, discount:, external_price_id:, fixed_price_quantity:, invoice_grouping_key:, invoicing_cycle_configuration:, item:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, plan_phase_order:, price_type:, replaces_price_id:, tiered_package_with_minimum_config:, dimensional_price_configuration: nil, license_type: nil, model_type: :tiered_package_with_minimum)
|
|
4125
4200
|
# Some parameter documentations has been truncated, see
|
|
4126
4201
|
# {Orb::Models::Price::TieredPackageWithMinimum} for more details.
|
|
4127
4202
|
#
|
|
@@ -4153,6 +4228,8 @@ module Orb
|
|
|
4153
4228
|
#
|
|
4154
4229
|
# @param fixed_price_quantity [Float, nil]
|
|
4155
4230
|
#
|
|
4231
|
+
# @param invoice_grouping_key [String, nil]
|
|
4232
|
+
#
|
|
4156
4233
|
# @param invoicing_cycle_configuration [Orb::Models::BillingCycleConfiguration, nil]
|
|
4157
4234
|
#
|
|
4158
4235
|
# @param item [Orb::Models::ItemSlim] A minimal representation of an Item containing only the essential identifying in
|
|
@@ -4441,6 +4518,11 @@ module Orb
|
|
|
4441
4518
|
# @return [Float, nil]
|
|
4442
4519
|
required :fixed_price_quantity, Float, nil?: true
|
|
4443
4520
|
|
|
4521
|
+
# @!attribute invoice_grouping_key
|
|
4522
|
+
#
|
|
4523
|
+
# @return [String, nil]
|
|
4524
|
+
required :invoice_grouping_key, String, nil?: true
|
|
4525
|
+
|
|
4444
4526
|
# @!attribute invoicing_cycle_configuration
|
|
4445
4527
|
#
|
|
4446
4528
|
# @return [Orb::Models::BillingCycleConfiguration, nil]
|
|
@@ -4534,7 +4616,7 @@ module Orb
|
|
|
4534
4616
|
# @return [Orb::Models::Price::PackageWithAllocation::LicenseType, nil]
|
|
4535
4617
|
optional :license_type, -> { Orb::Price::PackageWithAllocation::LicenseType }, nil?: true
|
|
4536
4618
|
|
|
4537
|
-
# @!method initialize(id:, billable_metric:, billing_cycle_configuration:, billing_mode:, cadence:, composite_price_filters:, conversion_rate:, conversion_rate_config:, created_at:, credit_allocation:, currency:, discount:, external_price_id:, fixed_price_quantity:, invoicing_cycle_configuration:, item:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, package_with_allocation_config:, plan_phase_order:, price_type:, replaces_price_id:, dimensional_price_configuration: nil, license_type: nil, model_type: :package_with_allocation)
|
|
4619
|
+
# @!method initialize(id:, billable_metric:, billing_cycle_configuration:, billing_mode:, cadence:, composite_price_filters:, conversion_rate:, conversion_rate_config:, created_at:, credit_allocation:, currency:, discount:, external_price_id:, fixed_price_quantity:, invoice_grouping_key:, invoicing_cycle_configuration:, item:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, package_with_allocation_config:, plan_phase_order:, price_type:, replaces_price_id:, dimensional_price_configuration: nil, license_type: nil, model_type: :package_with_allocation)
|
|
4538
4620
|
# Some parameter documentations has been truncated, see
|
|
4539
4621
|
# {Orb::Models::Price::PackageWithAllocation} for more details.
|
|
4540
4622
|
#
|
|
@@ -4566,6 +4648,8 @@ module Orb
|
|
|
4566
4648
|
#
|
|
4567
4649
|
# @param fixed_price_quantity [Float, nil]
|
|
4568
4650
|
#
|
|
4651
|
+
# @param invoice_grouping_key [String, nil]
|
|
4652
|
+
#
|
|
4569
4653
|
# @param invoicing_cycle_configuration [Orb::Models::BillingCycleConfiguration, nil]
|
|
4570
4654
|
#
|
|
4571
4655
|
# @param item [Orb::Models::ItemSlim] A minimal representation of an Item containing only the essential identifying in
|
|
@@ -4828,6 +4912,11 @@ module Orb
|
|
|
4828
4912
|
# @return [Float, nil]
|
|
4829
4913
|
required :fixed_price_quantity, Float, nil?: true
|
|
4830
4914
|
|
|
4915
|
+
# @!attribute invoice_grouping_key
|
|
4916
|
+
#
|
|
4917
|
+
# @return [String, nil]
|
|
4918
|
+
required :invoice_grouping_key, String, nil?: true
|
|
4919
|
+
|
|
4831
4920
|
# @!attribute invoicing_cycle_configuration
|
|
4832
4921
|
#
|
|
4833
4922
|
# @return [Orb::Models::BillingCycleConfiguration, nil]
|
|
@@ -4920,7 +5009,7 @@ module Orb
|
|
|
4920
5009
|
# @return [Orb::Models::Price::UnitWithPercent::LicenseType, nil]
|
|
4921
5010
|
optional :license_type, -> { Orb::Price::UnitWithPercent::LicenseType }, nil?: true
|
|
4922
5011
|
|
|
4923
|
-
# @!method initialize(id:, billable_metric:, billing_cycle_configuration:, billing_mode:, cadence:, composite_price_filters:, conversion_rate:, conversion_rate_config:, created_at:, credit_allocation:, currency:, discount:, external_price_id:, fixed_price_quantity:, invoicing_cycle_configuration:, item:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, plan_phase_order:, price_type:, replaces_price_id:, unit_with_percent_config:, dimensional_price_configuration: nil, license_type: nil, model_type: :unit_with_percent)
|
|
5012
|
+
# @!method initialize(id:, billable_metric:, billing_cycle_configuration:, billing_mode:, cadence:, composite_price_filters:, conversion_rate:, conversion_rate_config:, created_at:, credit_allocation:, currency:, discount:, external_price_id:, fixed_price_quantity:, invoice_grouping_key:, invoicing_cycle_configuration:, item:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, plan_phase_order:, price_type:, replaces_price_id:, unit_with_percent_config:, dimensional_price_configuration: nil, license_type: nil, model_type: :unit_with_percent)
|
|
4924
5013
|
# Some parameter documentations has been truncated, see
|
|
4925
5014
|
# {Orb::Models::Price::UnitWithPercent} for more details.
|
|
4926
5015
|
#
|
|
@@ -4952,6 +5041,8 @@ module Orb
|
|
|
4952
5041
|
#
|
|
4953
5042
|
# @param fixed_price_quantity [Float, nil]
|
|
4954
5043
|
#
|
|
5044
|
+
# @param invoice_grouping_key [String, nil]
|
|
5045
|
+
#
|
|
4955
5046
|
# @param invoicing_cycle_configuration [Orb::Models::BillingCycleConfiguration, nil]
|
|
4956
5047
|
#
|
|
4957
5048
|
# @param item [Orb::Models::ItemSlim] A minimal representation of an Item containing only the essential identifying in
|
|
@@ -5211,6 +5302,11 @@ module Orb
|
|
|
5211
5302
|
# @return [Float, nil]
|
|
5212
5303
|
required :fixed_price_quantity, Float, nil?: true
|
|
5213
5304
|
|
|
5305
|
+
# @!attribute invoice_grouping_key
|
|
5306
|
+
#
|
|
5307
|
+
# @return [String, nil]
|
|
5308
|
+
required :invoice_grouping_key, String, nil?: true
|
|
5309
|
+
|
|
5214
5310
|
# @!attribute invoicing_cycle_configuration
|
|
5215
5311
|
#
|
|
5216
5312
|
# @return [Orb::Models::BillingCycleConfiguration, nil]
|
|
@@ -5303,7 +5399,7 @@ module Orb
|
|
|
5303
5399
|
# @return [Orb::Models::Price::MatrixWithAllocation::LicenseType, nil]
|
|
5304
5400
|
optional :license_type, -> { Orb::Price::MatrixWithAllocation::LicenseType }, nil?: true
|
|
5305
5401
|
|
|
5306
|
-
# @!method initialize(id:, billable_metric:, billing_cycle_configuration:, billing_mode:, cadence:, composite_price_filters:, conversion_rate:, conversion_rate_config:, created_at:, credit_allocation:, currency:, discount:, external_price_id:, fixed_price_quantity:, invoicing_cycle_configuration:, item:, matrix_with_allocation_config:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, plan_phase_order:, price_type:, replaces_price_id:, dimensional_price_configuration: nil, license_type: nil, model_type: :matrix_with_allocation)
|
|
5402
|
+
# @!method initialize(id:, billable_metric:, billing_cycle_configuration:, billing_mode:, cadence:, composite_price_filters:, conversion_rate:, conversion_rate_config:, created_at:, credit_allocation:, currency:, discount:, external_price_id:, fixed_price_quantity:, invoice_grouping_key:, invoicing_cycle_configuration:, item:, matrix_with_allocation_config:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, plan_phase_order:, price_type:, replaces_price_id:, dimensional_price_configuration: nil, license_type: nil, model_type: :matrix_with_allocation)
|
|
5307
5403
|
# Some parameter documentations has been truncated, see
|
|
5308
5404
|
# {Orb::Models::Price::MatrixWithAllocation} for more details.
|
|
5309
5405
|
#
|
|
@@ -5335,6 +5431,8 @@ module Orb
|
|
|
5335
5431
|
#
|
|
5336
5432
|
# @param fixed_price_quantity [Float, nil]
|
|
5337
5433
|
#
|
|
5434
|
+
# @param invoice_grouping_key [String, nil]
|
|
5435
|
+
#
|
|
5338
5436
|
# @param invoicing_cycle_configuration [Orb::Models::BillingCycleConfiguration, nil]
|
|
5339
5437
|
#
|
|
5340
5438
|
# @param item [Orb::Models::ItemSlim] A minimal representation of an Item containing only the essential identifying in
|
|
@@ -5572,6 +5670,11 @@ module Orb
|
|
|
5572
5670
|
# @return [Float, nil]
|
|
5573
5671
|
required :fixed_price_quantity, Float, nil?: true
|
|
5574
5672
|
|
|
5673
|
+
# @!attribute invoice_grouping_key
|
|
5674
|
+
#
|
|
5675
|
+
# @return [String, nil]
|
|
5676
|
+
required :invoice_grouping_key, String, nil?: true
|
|
5677
|
+
|
|
5575
5678
|
# @!attribute invoicing_cycle_configuration
|
|
5576
5679
|
#
|
|
5577
5680
|
# @return [Orb::Models::BillingCycleConfiguration, nil]
|
|
@@ -5664,7 +5767,7 @@ module Orb
|
|
|
5664
5767
|
# @return [Orb::Models::Price::TieredWithProration::LicenseType, nil]
|
|
5665
5768
|
optional :license_type, -> { Orb::Price::TieredWithProration::LicenseType }, nil?: true
|
|
5666
5769
|
|
|
5667
|
-
# @!method initialize(id:, billable_metric:, billing_cycle_configuration:, billing_mode:, cadence:, composite_price_filters:, conversion_rate:, conversion_rate_config:, created_at:, credit_allocation:, currency:, discount:, external_price_id:, fixed_price_quantity:, invoicing_cycle_configuration:, item:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, plan_phase_order:, price_type:, replaces_price_id:, tiered_with_proration_config:, dimensional_price_configuration: nil, license_type: nil, model_type: :tiered_with_proration)
|
|
5770
|
+
# @!method initialize(id:, billable_metric:, billing_cycle_configuration:, billing_mode:, cadence:, composite_price_filters:, conversion_rate:, conversion_rate_config:, created_at:, credit_allocation:, currency:, discount:, external_price_id:, fixed_price_quantity:, invoice_grouping_key:, invoicing_cycle_configuration:, item:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, plan_phase_order:, price_type:, replaces_price_id:, tiered_with_proration_config:, dimensional_price_configuration: nil, license_type: nil, model_type: :tiered_with_proration)
|
|
5668
5771
|
# Some parameter documentations has been truncated, see
|
|
5669
5772
|
# {Orb::Models::Price::TieredWithProration} for more details.
|
|
5670
5773
|
#
|
|
@@ -5696,6 +5799,8 @@ module Orb
|
|
|
5696
5799
|
#
|
|
5697
5800
|
# @param fixed_price_quantity [Float, nil]
|
|
5698
5801
|
#
|
|
5802
|
+
# @param invoice_grouping_key [String, nil]
|
|
5803
|
+
#
|
|
5699
5804
|
# @param invoicing_cycle_configuration [Orb::Models::BillingCycleConfiguration, nil]
|
|
5700
5805
|
#
|
|
5701
5806
|
# @param item [Orb::Models::ItemSlim] A minimal representation of an Item containing only the essential identifying in
|
|
@@ -5974,6 +6079,11 @@ module Orb
|
|
|
5974
6079
|
# @return [Float, nil]
|
|
5975
6080
|
required :fixed_price_quantity, Float, nil?: true
|
|
5976
6081
|
|
|
6082
|
+
# @!attribute invoice_grouping_key
|
|
6083
|
+
#
|
|
6084
|
+
# @return [String, nil]
|
|
6085
|
+
required :invoice_grouping_key, String, nil?: true
|
|
6086
|
+
|
|
5977
6087
|
# @!attribute invoicing_cycle_configuration
|
|
5978
6088
|
#
|
|
5979
6089
|
# @return [Orb::Models::BillingCycleConfiguration, nil]
|
|
@@ -6066,7 +6176,7 @@ module Orb
|
|
|
6066
6176
|
# @return [Orb::Models::Price::UnitWithProration::LicenseType, nil]
|
|
6067
6177
|
optional :license_type, -> { Orb::Price::UnitWithProration::LicenseType }, nil?: true
|
|
6068
6178
|
|
|
6069
|
-
# @!method initialize(id:, billable_metric:, billing_cycle_configuration:, billing_mode:, cadence:, composite_price_filters:, conversion_rate:, conversion_rate_config:, created_at:, credit_allocation:, currency:, discount:, external_price_id:, fixed_price_quantity:, invoicing_cycle_configuration:, item:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, plan_phase_order:, price_type:, replaces_price_id:, unit_with_proration_config:, dimensional_price_configuration: nil, license_type: nil, model_type: :unit_with_proration)
|
|
6179
|
+
# @!method initialize(id:, billable_metric:, billing_cycle_configuration:, billing_mode:, cadence:, composite_price_filters:, conversion_rate:, conversion_rate_config:, created_at:, credit_allocation:, currency:, discount:, external_price_id:, fixed_price_quantity:, invoice_grouping_key:, invoicing_cycle_configuration:, item:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, plan_phase_order:, price_type:, replaces_price_id:, unit_with_proration_config:, dimensional_price_configuration: nil, license_type: nil, model_type: :unit_with_proration)
|
|
6070
6180
|
# Some parameter documentations has been truncated, see
|
|
6071
6181
|
# {Orb::Models::Price::UnitWithProration} for more details.
|
|
6072
6182
|
#
|
|
@@ -6098,6 +6208,8 @@ module Orb
|
|
|
6098
6208
|
#
|
|
6099
6209
|
# @param fixed_price_quantity [Float, nil]
|
|
6100
6210
|
#
|
|
6211
|
+
# @param invoice_grouping_key [String, nil]
|
|
6212
|
+
#
|
|
6101
6213
|
# @param invoicing_cycle_configuration [Orb::Models::BillingCycleConfiguration, nil]
|
|
6102
6214
|
#
|
|
6103
6215
|
# @param item [Orb::Models::ItemSlim] A minimal representation of an Item containing only the essential identifying in
|
|
@@ -6355,6 +6467,11 @@ module Orb
|
|
|
6355
6467
|
# @return [Orb::Models::Price::GroupedAllocation::GroupedAllocationConfig]
|
|
6356
6468
|
required :grouped_allocation_config, -> { Orb::Price::GroupedAllocation::GroupedAllocationConfig }
|
|
6357
6469
|
|
|
6470
|
+
# @!attribute invoice_grouping_key
|
|
6471
|
+
#
|
|
6472
|
+
# @return [String, nil]
|
|
6473
|
+
required :invoice_grouping_key, String, nil?: true
|
|
6474
|
+
|
|
6358
6475
|
# @!attribute invoicing_cycle_configuration
|
|
6359
6476
|
#
|
|
6360
6477
|
# @return [Orb::Models::BillingCycleConfiguration, nil]
|
|
@@ -6441,7 +6558,7 @@ module Orb
|
|
|
6441
6558
|
# @return [Orb::Models::Price::GroupedAllocation::LicenseType, nil]
|
|
6442
6559
|
optional :license_type, -> { Orb::Price::GroupedAllocation::LicenseType }, nil?: true
|
|
6443
6560
|
|
|
6444
|
-
# @!method initialize(id:, billable_metric:, billing_cycle_configuration:, billing_mode:, cadence:, composite_price_filters:, conversion_rate:, conversion_rate_config:, created_at:, credit_allocation:, currency:, discount:, external_price_id:, fixed_price_quantity:, grouped_allocation_config:, invoicing_cycle_configuration:, item:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, plan_phase_order:, price_type:, replaces_price_id:, dimensional_price_configuration: nil, license_type: nil, model_type: :grouped_allocation)
|
|
6561
|
+
# @!method initialize(id:, billable_metric:, billing_cycle_configuration:, billing_mode:, cadence:, composite_price_filters:, conversion_rate:, conversion_rate_config:, created_at:, credit_allocation:, currency:, discount:, external_price_id:, fixed_price_quantity:, grouped_allocation_config:, invoice_grouping_key:, invoicing_cycle_configuration:, item:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, plan_phase_order:, price_type:, replaces_price_id:, dimensional_price_configuration: nil, license_type: nil, model_type: :grouped_allocation)
|
|
6445
6562
|
# Some parameter documentations has been truncated, see
|
|
6446
6563
|
# {Orb::Models::Price::GroupedAllocation} for more details.
|
|
6447
6564
|
#
|
|
@@ -6475,6 +6592,8 @@ module Orb
|
|
|
6475
6592
|
#
|
|
6476
6593
|
# @param grouped_allocation_config [Orb::Models::Price::GroupedAllocation::GroupedAllocationConfig] Configuration for grouped_allocation pricing
|
|
6477
6594
|
#
|
|
6595
|
+
# @param invoice_grouping_key [String, nil]
|
|
6596
|
+
#
|
|
6478
6597
|
# @param invoicing_cycle_configuration [Orb::Models::BillingCycleConfiguration, nil]
|
|
6479
6598
|
#
|
|
6480
6599
|
# @param item [Orb::Models::ItemSlim] A minimal representation of an Item containing only the essential identifying in
|
|
@@ -6746,6 +6865,11 @@ module Orb
|
|
|
6746
6865
|
# @return [Float, nil]
|
|
6747
6866
|
required :fixed_price_quantity, Float, nil?: true
|
|
6748
6867
|
|
|
6868
|
+
# @!attribute invoice_grouping_key
|
|
6869
|
+
#
|
|
6870
|
+
# @return [String, nil]
|
|
6871
|
+
required :invoice_grouping_key, String, nil?: true
|
|
6872
|
+
|
|
6749
6873
|
# @!attribute invoicing_cycle_configuration
|
|
6750
6874
|
#
|
|
6751
6875
|
# @return [Orb::Models::BillingCycleConfiguration, nil]
|
|
@@ -6832,7 +6956,7 @@ module Orb
|
|
|
6832
6956
|
# @return [Orb::Models::Price::BulkWithProration::LicenseType, nil]
|
|
6833
6957
|
optional :license_type, -> { Orb::Price::BulkWithProration::LicenseType }, nil?: true
|
|
6834
6958
|
|
|
6835
|
-
# @!method initialize(id:, billable_metric:, billing_cycle_configuration:, billing_mode:, bulk_with_proration_config:, cadence:, composite_price_filters:, conversion_rate:, conversion_rate_config:, created_at:, credit_allocation:, currency:, discount:, external_price_id:, fixed_price_quantity:, invoicing_cycle_configuration:, item:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, plan_phase_order:, price_type:, replaces_price_id:, dimensional_price_configuration: nil, license_type: nil, model_type: :bulk_with_proration)
|
|
6959
|
+
# @!method initialize(id:, billable_metric:, billing_cycle_configuration:, billing_mode:, bulk_with_proration_config:, cadence:, composite_price_filters:, conversion_rate:, conversion_rate_config:, created_at:, credit_allocation:, currency:, discount:, external_price_id:, fixed_price_quantity:, invoice_grouping_key:, invoicing_cycle_configuration:, item:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, plan_phase_order:, price_type:, replaces_price_id:, dimensional_price_configuration: nil, license_type: nil, model_type: :bulk_with_proration)
|
|
6836
6960
|
# Some parameter documentations has been truncated, see
|
|
6837
6961
|
# {Orb::Models::Price::BulkWithProration} for more details.
|
|
6838
6962
|
#
|
|
@@ -6866,6 +6990,8 @@ module Orb
|
|
|
6866
6990
|
#
|
|
6867
6991
|
# @param fixed_price_quantity [Float, nil]
|
|
6868
6992
|
#
|
|
6993
|
+
# @param invoice_grouping_key [String, nil]
|
|
6994
|
+
#
|
|
6869
6995
|
# @param invoicing_cycle_configuration [Orb::Models::BillingCycleConfiguration, nil]
|
|
6870
6996
|
#
|
|
6871
6997
|
# @param item [Orb::Models::ItemSlim] A minimal representation of an Item containing only the essential identifying in
|
|
@@ -7146,6 +7272,11 @@ module Orb
|
|
|
7146
7272
|
required :grouped_with_prorated_minimum_config,
|
|
7147
7273
|
-> { Orb::Price::GroupedWithProratedMinimum::GroupedWithProratedMinimumConfig }
|
|
7148
7274
|
|
|
7275
|
+
# @!attribute invoice_grouping_key
|
|
7276
|
+
#
|
|
7277
|
+
# @return [String, nil]
|
|
7278
|
+
required :invoice_grouping_key, String, nil?: true
|
|
7279
|
+
|
|
7149
7280
|
# @!attribute invoicing_cycle_configuration
|
|
7150
7281
|
#
|
|
7151
7282
|
# @return [Orb::Models::BillingCycleConfiguration, nil]
|
|
@@ -7232,7 +7363,7 @@ module Orb
|
|
|
7232
7363
|
# @return [Orb::Models::Price::GroupedWithProratedMinimum::LicenseType, nil]
|
|
7233
7364
|
optional :license_type, -> { Orb::Price::GroupedWithProratedMinimum::LicenseType }, nil?: true
|
|
7234
7365
|
|
|
7235
|
-
# @!method initialize(id:, billable_metric:, billing_cycle_configuration:, billing_mode:, cadence:, composite_price_filters:, conversion_rate:, conversion_rate_config:, created_at:, credit_allocation:, currency:, discount:, external_price_id:, fixed_price_quantity:, grouped_with_prorated_minimum_config:, invoicing_cycle_configuration:, item:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, plan_phase_order:, price_type:, replaces_price_id:, dimensional_price_configuration: nil, license_type: nil, model_type: :grouped_with_prorated_minimum)
|
|
7366
|
+
# @!method initialize(id:, billable_metric:, billing_cycle_configuration:, billing_mode:, cadence:, composite_price_filters:, conversion_rate:, conversion_rate_config:, created_at:, credit_allocation:, currency:, discount:, external_price_id:, fixed_price_quantity:, grouped_with_prorated_minimum_config:, invoice_grouping_key:, invoicing_cycle_configuration:, item:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, plan_phase_order:, price_type:, replaces_price_id:, dimensional_price_configuration: nil, license_type: nil, model_type: :grouped_with_prorated_minimum)
|
|
7236
7367
|
# Some parameter documentations has been truncated, see
|
|
7237
7368
|
# {Orb::Models::Price::GroupedWithProratedMinimum} for more details.
|
|
7238
7369
|
#
|
|
@@ -7266,6 +7397,8 @@ module Orb
|
|
|
7266
7397
|
#
|
|
7267
7398
|
# @param grouped_with_prorated_minimum_config [Orb::Models::Price::GroupedWithProratedMinimum::GroupedWithProratedMinimumConfig] Configuration for grouped_with_prorated_minimum pricing
|
|
7268
7399
|
#
|
|
7400
|
+
# @param invoice_grouping_key [String, nil]
|
|
7401
|
+
#
|
|
7269
7402
|
# @param invoicing_cycle_configuration [Orb::Models::BillingCycleConfiguration, nil]
|
|
7270
7403
|
#
|
|
7271
7404
|
# @param item [Orb::Models::ItemSlim] A minimal representation of an Item containing only the essential identifying in
|
|
@@ -7540,6 +7673,11 @@ module Orb
|
|
|
7540
7673
|
required :grouped_with_metered_minimum_config,
|
|
7541
7674
|
-> { Orb::Price::GroupedWithMeteredMinimum::GroupedWithMeteredMinimumConfig }
|
|
7542
7675
|
|
|
7676
|
+
# @!attribute invoice_grouping_key
|
|
7677
|
+
#
|
|
7678
|
+
# @return [String, nil]
|
|
7679
|
+
required :invoice_grouping_key, String, nil?: true
|
|
7680
|
+
|
|
7543
7681
|
# @!attribute invoicing_cycle_configuration
|
|
7544
7682
|
#
|
|
7545
7683
|
# @return [Orb::Models::BillingCycleConfiguration, nil]
|
|
@@ -7626,7 +7764,7 @@ module Orb
|
|
|
7626
7764
|
# @return [Orb::Models::Price::GroupedWithMeteredMinimum::LicenseType, nil]
|
|
7627
7765
|
optional :license_type, -> { Orb::Price::GroupedWithMeteredMinimum::LicenseType }, nil?: true
|
|
7628
7766
|
|
|
7629
|
-
# @!method initialize(id:, billable_metric:, billing_cycle_configuration:, billing_mode:, cadence:, composite_price_filters:, conversion_rate:, conversion_rate_config:, created_at:, credit_allocation:, currency:, discount:, external_price_id:, fixed_price_quantity:, grouped_with_metered_minimum_config:, invoicing_cycle_configuration:, item:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, plan_phase_order:, price_type:, replaces_price_id:, dimensional_price_configuration: nil, license_type: nil, model_type: :grouped_with_metered_minimum)
|
|
7767
|
+
# @!method initialize(id:, billable_metric:, billing_cycle_configuration:, billing_mode:, cadence:, composite_price_filters:, conversion_rate:, conversion_rate_config:, created_at:, credit_allocation:, currency:, discount:, external_price_id:, fixed_price_quantity:, grouped_with_metered_minimum_config:, invoice_grouping_key:, invoicing_cycle_configuration:, item:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, plan_phase_order:, price_type:, replaces_price_id:, dimensional_price_configuration: nil, license_type: nil, model_type: :grouped_with_metered_minimum)
|
|
7630
7768
|
# Some parameter documentations has been truncated, see
|
|
7631
7769
|
# {Orb::Models::Price::GroupedWithMeteredMinimum} for more details.
|
|
7632
7770
|
#
|
|
@@ -7660,6 +7798,8 @@ module Orb
|
|
|
7660
7798
|
#
|
|
7661
7799
|
# @param grouped_with_metered_minimum_config [Orb::Models::Price::GroupedWithMeteredMinimum::GroupedWithMeteredMinimumConfig] Configuration for grouped_with_metered_minimum pricing
|
|
7662
7800
|
#
|
|
7801
|
+
# @param invoice_grouping_key [String, nil]
|
|
7802
|
+
#
|
|
7663
7803
|
# @param invoicing_cycle_configuration [Orb::Models::BillingCycleConfiguration, nil]
|
|
7664
7804
|
#
|
|
7665
7805
|
# @param item [Orb::Models::ItemSlim] A minimal representation of an Item containing only the essential identifying in
|
|
@@ -8004,6 +8144,11 @@ module Orb
|
|
|
8004
8144
|
required :grouped_with_min_max_thresholds_config,
|
|
8005
8145
|
-> { Orb::Price::GroupedWithMinMaxThresholds::GroupedWithMinMaxThresholdsConfig }
|
|
8006
8146
|
|
|
8147
|
+
# @!attribute invoice_grouping_key
|
|
8148
|
+
#
|
|
8149
|
+
# @return [String, nil]
|
|
8150
|
+
required :invoice_grouping_key, String, nil?: true
|
|
8151
|
+
|
|
8007
8152
|
# @!attribute invoicing_cycle_configuration
|
|
8008
8153
|
#
|
|
8009
8154
|
# @return [Orb::Models::BillingCycleConfiguration, nil]
|
|
@@ -8090,7 +8235,7 @@ module Orb
|
|
|
8090
8235
|
# @return [Orb::Models::Price::GroupedWithMinMaxThresholds::LicenseType, nil]
|
|
8091
8236
|
optional :license_type, -> { Orb::Price::GroupedWithMinMaxThresholds::LicenseType }, nil?: true
|
|
8092
8237
|
|
|
8093
|
-
# @!method initialize(id:, billable_metric:, billing_cycle_configuration:, billing_mode:, cadence:, composite_price_filters:, conversion_rate:, conversion_rate_config:, created_at:, credit_allocation:, currency:, discount:, external_price_id:, fixed_price_quantity:, grouped_with_min_max_thresholds_config:, invoicing_cycle_configuration:, item:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, plan_phase_order:, price_type:, replaces_price_id:, dimensional_price_configuration: nil, license_type: nil, model_type: :grouped_with_min_max_thresholds)
|
|
8238
|
+
# @!method initialize(id:, billable_metric:, billing_cycle_configuration:, billing_mode:, cadence:, composite_price_filters:, conversion_rate:, conversion_rate_config:, created_at:, credit_allocation:, currency:, discount:, external_price_id:, fixed_price_quantity:, grouped_with_min_max_thresholds_config:, invoice_grouping_key:, invoicing_cycle_configuration:, item:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, plan_phase_order:, price_type:, replaces_price_id:, dimensional_price_configuration: nil, license_type: nil, model_type: :grouped_with_min_max_thresholds)
|
|
8094
8239
|
# Some parameter documentations has been truncated, see
|
|
8095
8240
|
# {Orb::Models::Price::GroupedWithMinMaxThresholds} for more details.
|
|
8096
8241
|
#
|
|
@@ -8124,6 +8269,8 @@ module Orb
|
|
|
8124
8269
|
#
|
|
8125
8270
|
# @param grouped_with_min_max_thresholds_config [Orb::Models::Price::GroupedWithMinMaxThresholds::GroupedWithMinMaxThresholdsConfig] Configuration for grouped_with_min_max_thresholds pricing
|
|
8126
8271
|
#
|
|
8272
|
+
# @param invoice_grouping_key [String, nil]
|
|
8273
|
+
#
|
|
8127
8274
|
# @param invoicing_cycle_configuration [Orb::Models::BillingCycleConfiguration, nil]
|
|
8128
8275
|
#
|
|
8129
8276
|
# @param item [Orb::Models::ItemSlim] A minimal representation of an Item containing only the essential identifying in
|
|
@@ -8397,6 +8544,11 @@ module Orb
|
|
|
8397
8544
|
# @return [Float, nil]
|
|
8398
8545
|
required :fixed_price_quantity, Float, nil?: true
|
|
8399
8546
|
|
|
8547
|
+
# @!attribute invoice_grouping_key
|
|
8548
|
+
#
|
|
8549
|
+
# @return [String, nil]
|
|
8550
|
+
required :invoice_grouping_key, String, nil?: true
|
|
8551
|
+
|
|
8400
8552
|
# @!attribute invoicing_cycle_configuration
|
|
8401
8553
|
#
|
|
8402
8554
|
# @return [Orb::Models::BillingCycleConfiguration, nil]
|
|
@@ -8490,7 +8642,7 @@ module Orb
|
|
|
8490
8642
|
# @return [Orb::Models::Price::MatrixWithDisplayName::LicenseType, nil]
|
|
8491
8643
|
optional :license_type, -> { Orb::Price::MatrixWithDisplayName::LicenseType }, nil?: true
|
|
8492
8644
|
|
|
8493
|
-
# @!method initialize(id:, billable_metric:, billing_cycle_configuration:, billing_mode:, cadence:, composite_price_filters:, conversion_rate:, conversion_rate_config:, created_at:, credit_allocation:, currency:, discount:, external_price_id:, fixed_price_quantity:, invoicing_cycle_configuration:, item:, matrix_with_display_name_config:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, plan_phase_order:, price_type:, replaces_price_id:, dimensional_price_configuration: nil, license_type: nil, model_type: :matrix_with_display_name)
|
|
8645
|
+
# @!method initialize(id:, billable_metric:, billing_cycle_configuration:, billing_mode:, cadence:, composite_price_filters:, conversion_rate:, conversion_rate_config:, created_at:, credit_allocation:, currency:, discount:, external_price_id:, fixed_price_quantity:, invoice_grouping_key:, invoicing_cycle_configuration:, item:, matrix_with_display_name_config:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, plan_phase_order:, price_type:, replaces_price_id:, dimensional_price_configuration: nil, license_type: nil, model_type: :matrix_with_display_name)
|
|
8494
8646
|
# Some parameter documentations has been truncated, see
|
|
8495
8647
|
# {Orb::Models::Price::MatrixWithDisplayName} for more details.
|
|
8496
8648
|
#
|
|
@@ -8522,6 +8674,8 @@ module Orb
|
|
|
8522
8674
|
#
|
|
8523
8675
|
# @param fixed_price_quantity [Float, nil]
|
|
8524
8676
|
#
|
|
8677
|
+
# @param invoice_grouping_key [String, nil]
|
|
8678
|
+
#
|
|
8525
8679
|
# @param invoicing_cycle_configuration [Orb::Models::BillingCycleConfiguration, nil]
|
|
8526
8680
|
#
|
|
8527
8681
|
# @param item [Orb::Models::ItemSlim] A minimal representation of an Item containing only the essential identifying in
|
|
@@ -8818,6 +8972,11 @@ module Orb
|
|
|
8818
8972
|
required :grouped_tiered_package_config,
|
|
8819
8973
|
-> { Orb::Price::GroupedTieredPackage::GroupedTieredPackageConfig }
|
|
8820
8974
|
|
|
8975
|
+
# @!attribute invoice_grouping_key
|
|
8976
|
+
#
|
|
8977
|
+
# @return [String, nil]
|
|
8978
|
+
required :invoice_grouping_key, String, nil?: true
|
|
8979
|
+
|
|
8821
8980
|
# @!attribute invoicing_cycle_configuration
|
|
8822
8981
|
#
|
|
8823
8982
|
# @return [Orb::Models::BillingCycleConfiguration, nil]
|
|
@@ -8904,7 +9063,7 @@ module Orb
|
|
|
8904
9063
|
# @return [Orb::Models::Price::GroupedTieredPackage::LicenseType, nil]
|
|
8905
9064
|
optional :license_type, -> { Orb::Price::GroupedTieredPackage::LicenseType }, nil?: true
|
|
8906
9065
|
|
|
8907
|
-
# @!method initialize(id:, billable_metric:, billing_cycle_configuration:, billing_mode:, cadence:, composite_price_filters:, conversion_rate:, conversion_rate_config:, created_at:, credit_allocation:, currency:, discount:, external_price_id:, fixed_price_quantity:, grouped_tiered_package_config:, invoicing_cycle_configuration:, item:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, plan_phase_order:, price_type:, replaces_price_id:, dimensional_price_configuration: nil, license_type: nil, model_type: :grouped_tiered_package)
|
|
9066
|
+
# @!method initialize(id:, billable_metric:, billing_cycle_configuration:, billing_mode:, cadence:, composite_price_filters:, conversion_rate:, conversion_rate_config:, created_at:, credit_allocation:, currency:, discount:, external_price_id:, fixed_price_quantity:, grouped_tiered_package_config:, invoice_grouping_key:, invoicing_cycle_configuration:, item:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, plan_phase_order:, price_type:, replaces_price_id:, dimensional_price_configuration: nil, license_type: nil, model_type: :grouped_tiered_package)
|
|
8908
9067
|
# Some parameter documentations has been truncated, see
|
|
8909
9068
|
# {Orb::Models::Price::GroupedTieredPackage} for more details.
|
|
8910
9069
|
#
|
|
@@ -8938,6 +9097,8 @@ module Orb
|
|
|
8938
9097
|
#
|
|
8939
9098
|
# @param grouped_tiered_package_config [Orb::Models::Price::GroupedTieredPackage::GroupedTieredPackageConfig] Configuration for grouped_tiered_package pricing
|
|
8940
9099
|
#
|
|
9100
|
+
# @param invoice_grouping_key [String, nil]
|
|
9101
|
+
#
|
|
8941
9102
|
# @param invoicing_cycle_configuration [Orb::Models::BillingCycleConfiguration, nil]
|
|
8942
9103
|
#
|
|
8943
9104
|
# @param item [Orb::Models::ItemSlim] A minimal representation of an Item containing only the essential identifying in
|
|
@@ -9228,6 +9389,11 @@ module Orb
|
|
|
9228
9389
|
# @return [Float, nil]
|
|
9229
9390
|
required :fixed_price_quantity, Float, nil?: true
|
|
9230
9391
|
|
|
9392
|
+
# @!attribute invoice_grouping_key
|
|
9393
|
+
#
|
|
9394
|
+
# @return [String, nil]
|
|
9395
|
+
required :invoice_grouping_key, String, nil?: true
|
|
9396
|
+
|
|
9231
9397
|
# @!attribute invoicing_cycle_configuration
|
|
9232
9398
|
#
|
|
9233
9399
|
# @return [Orb::Models::BillingCycleConfiguration, nil]
|
|
@@ -9321,7 +9487,7 @@ module Orb
|
|
|
9321
9487
|
# @return [Orb::Models::Price::MaxGroupTieredPackage::LicenseType, nil]
|
|
9322
9488
|
optional :license_type, -> { Orb::Price::MaxGroupTieredPackage::LicenseType }, nil?: true
|
|
9323
9489
|
|
|
9324
|
-
# @!method initialize(id:, billable_metric:, billing_cycle_configuration:, billing_mode:, cadence:, composite_price_filters:, conversion_rate:, conversion_rate_config:, created_at:, credit_allocation:, currency:, discount:, external_price_id:, fixed_price_quantity:, invoicing_cycle_configuration:, item:, max_group_tiered_package_config:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, plan_phase_order:, price_type:, replaces_price_id:, dimensional_price_configuration: nil, license_type: nil, model_type: :max_group_tiered_package)
|
|
9490
|
+
# @!method initialize(id:, billable_metric:, billing_cycle_configuration:, billing_mode:, cadence:, composite_price_filters:, conversion_rate:, conversion_rate_config:, created_at:, credit_allocation:, currency:, discount:, external_price_id:, fixed_price_quantity:, invoice_grouping_key:, invoicing_cycle_configuration:, item:, max_group_tiered_package_config:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, plan_phase_order:, price_type:, replaces_price_id:, dimensional_price_configuration: nil, license_type: nil, model_type: :max_group_tiered_package)
|
|
9325
9491
|
# Some parameter documentations has been truncated, see
|
|
9326
9492
|
# {Orb::Models::Price::MaxGroupTieredPackage} for more details.
|
|
9327
9493
|
#
|
|
@@ -9353,6 +9519,8 @@ module Orb
|
|
|
9353
9519
|
#
|
|
9354
9520
|
# @param fixed_price_quantity [Float, nil]
|
|
9355
9521
|
#
|
|
9522
|
+
# @param invoice_grouping_key [String, nil]
|
|
9523
|
+
#
|
|
9356
9524
|
# @param invoicing_cycle_configuration [Orb::Models::BillingCycleConfiguration, nil]
|
|
9357
9525
|
#
|
|
9358
9526
|
# @param item [Orb::Models::ItemSlim] A minimal representation of an Item containing only the essential identifying in
|
|
@@ -9646,6 +9814,11 @@ module Orb
|
|
|
9646
9814
|
# @return [Float, nil]
|
|
9647
9815
|
required :fixed_price_quantity, Float, nil?: true
|
|
9648
9816
|
|
|
9817
|
+
# @!attribute invoice_grouping_key
|
|
9818
|
+
#
|
|
9819
|
+
# @return [String, nil]
|
|
9820
|
+
required :invoice_grouping_key, String, nil?: true
|
|
9821
|
+
|
|
9649
9822
|
# @!attribute invoicing_cycle_configuration
|
|
9650
9823
|
#
|
|
9651
9824
|
# @return [Orb::Models::BillingCycleConfiguration, nil]
|
|
@@ -9739,7 +9912,7 @@ module Orb
|
|
|
9739
9912
|
# @return [Orb::Models::Price::ScalableMatrixWithUnitPricing::LicenseType, nil]
|
|
9740
9913
|
optional :license_type, -> { Orb::Price::ScalableMatrixWithUnitPricing::LicenseType }, nil?: true
|
|
9741
9914
|
|
|
9742
|
-
# @!method initialize(id:, billable_metric:, billing_cycle_configuration:, billing_mode:, cadence:, composite_price_filters:, conversion_rate:, conversion_rate_config:, created_at:, credit_allocation:, currency:, discount:, external_price_id:, fixed_price_quantity:, invoicing_cycle_configuration:, item:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, plan_phase_order:, price_type:, replaces_price_id:, scalable_matrix_with_unit_pricing_config:, dimensional_price_configuration: nil, license_type: nil, model_type: :scalable_matrix_with_unit_pricing)
|
|
9915
|
+
# @!method initialize(id:, billable_metric:, billing_cycle_configuration:, billing_mode:, cadence:, composite_price_filters:, conversion_rate:, conversion_rate_config:, created_at:, credit_allocation:, currency:, discount:, external_price_id:, fixed_price_quantity:, invoice_grouping_key:, invoicing_cycle_configuration:, item:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, plan_phase_order:, price_type:, replaces_price_id:, scalable_matrix_with_unit_pricing_config:, dimensional_price_configuration: nil, license_type: nil, model_type: :scalable_matrix_with_unit_pricing)
|
|
9743
9916
|
# Some parameter documentations has been truncated, see
|
|
9744
9917
|
# {Orb::Models::Price::ScalableMatrixWithUnitPricing} for more details.
|
|
9745
9918
|
#
|
|
@@ -9771,6 +9944,8 @@ module Orb
|
|
|
9771
9944
|
#
|
|
9772
9945
|
# @param fixed_price_quantity [Float, nil]
|
|
9773
9946
|
#
|
|
9947
|
+
# @param invoice_grouping_key [String, nil]
|
|
9948
|
+
#
|
|
9774
9949
|
# @param invoicing_cycle_configuration [Orb::Models::BillingCycleConfiguration, nil]
|
|
9775
9950
|
#
|
|
9776
9951
|
# @param item [Orb::Models::ItemSlim] A minimal representation of an Item containing only the essential identifying in
|
|
@@ -10090,6 +10265,11 @@ module Orb
|
|
|
10090
10265
|
# @return [Float, nil]
|
|
10091
10266
|
required :fixed_price_quantity, Float, nil?: true
|
|
10092
10267
|
|
|
10268
|
+
# @!attribute invoice_grouping_key
|
|
10269
|
+
#
|
|
10270
|
+
# @return [String, nil]
|
|
10271
|
+
required :invoice_grouping_key, String, nil?: true
|
|
10272
|
+
|
|
10093
10273
|
# @!attribute invoicing_cycle_configuration
|
|
10094
10274
|
#
|
|
10095
10275
|
# @return [Orb::Models::BillingCycleConfiguration, nil]
|
|
@@ -10183,7 +10363,7 @@ module Orb
|
|
|
10183
10363
|
# @return [Orb::Models::Price::ScalableMatrixWithTieredPricing::LicenseType, nil]
|
|
10184
10364
|
optional :license_type, -> { Orb::Price::ScalableMatrixWithTieredPricing::LicenseType }, nil?: true
|
|
10185
10365
|
|
|
10186
|
-
# @!method initialize(id:, billable_metric:, billing_cycle_configuration:, billing_mode:, cadence:, composite_price_filters:, conversion_rate:, conversion_rate_config:, created_at:, credit_allocation:, currency:, discount:, external_price_id:, fixed_price_quantity:, invoicing_cycle_configuration:, item:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, plan_phase_order:, price_type:, replaces_price_id:, scalable_matrix_with_tiered_pricing_config:, dimensional_price_configuration: nil, license_type: nil, model_type: :scalable_matrix_with_tiered_pricing)
|
|
10366
|
+
# @!method initialize(id:, billable_metric:, billing_cycle_configuration:, billing_mode:, cadence:, composite_price_filters:, conversion_rate:, conversion_rate_config:, created_at:, credit_allocation:, currency:, discount:, external_price_id:, fixed_price_quantity:, invoice_grouping_key:, invoicing_cycle_configuration:, item:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, plan_phase_order:, price_type:, replaces_price_id:, scalable_matrix_with_tiered_pricing_config:, dimensional_price_configuration: nil, license_type: nil, model_type: :scalable_matrix_with_tiered_pricing)
|
|
10187
10367
|
# Some parameter documentations has been truncated, see
|
|
10188
10368
|
# {Orb::Models::Price::ScalableMatrixWithTieredPricing} for more details.
|
|
10189
10369
|
#
|
|
@@ -10215,6 +10395,8 @@ module Orb
|
|
|
10215
10395
|
#
|
|
10216
10396
|
# @param fixed_price_quantity [Float, nil]
|
|
10217
10397
|
#
|
|
10398
|
+
# @param invoice_grouping_key [String, nil]
|
|
10399
|
+
#
|
|
10218
10400
|
# @param invoicing_cycle_configuration [Orb::Models::BillingCycleConfiguration, nil]
|
|
10219
10401
|
#
|
|
10220
10402
|
# @param item [Orb::Models::ItemSlim] A minimal representation of an Item containing only the essential identifying in
|
|
@@ -10542,6 +10724,11 @@ module Orb
|
|
|
10542
10724
|
# @return [Float, nil]
|
|
10543
10725
|
required :fixed_price_quantity, Float, nil?: true
|
|
10544
10726
|
|
|
10727
|
+
# @!attribute invoice_grouping_key
|
|
10728
|
+
#
|
|
10729
|
+
# @return [String, nil]
|
|
10730
|
+
required :invoice_grouping_key, String, nil?: true
|
|
10731
|
+
|
|
10545
10732
|
# @!attribute invoicing_cycle_configuration
|
|
10546
10733
|
#
|
|
10547
10734
|
# @return [Orb::Models::BillingCycleConfiguration, nil]
|
|
@@ -10628,7 +10815,7 @@ module Orb
|
|
|
10628
10815
|
# @return [Orb::Models::Price::CumulativeGroupedBulk::LicenseType, nil]
|
|
10629
10816
|
optional :license_type, -> { Orb::Price::CumulativeGroupedBulk::LicenseType }, nil?: true
|
|
10630
10817
|
|
|
10631
|
-
# @!method initialize(id:, billable_metric:, billing_cycle_configuration:, billing_mode:, cadence:, composite_price_filters:, conversion_rate:, conversion_rate_config:, created_at:, credit_allocation:, cumulative_grouped_bulk_config:, currency:, discount:, external_price_id:, fixed_price_quantity:, invoicing_cycle_configuration:, item:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, plan_phase_order:, price_type:, replaces_price_id:, dimensional_price_configuration: nil, license_type: nil, model_type: :cumulative_grouped_bulk)
|
|
10818
|
+
# @!method initialize(id:, billable_metric:, billing_cycle_configuration:, billing_mode:, cadence:, composite_price_filters:, conversion_rate:, conversion_rate_config:, created_at:, credit_allocation:, cumulative_grouped_bulk_config:, currency:, discount:, external_price_id:, fixed_price_quantity:, invoice_grouping_key:, invoicing_cycle_configuration:, item:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, plan_phase_order:, price_type:, replaces_price_id:, dimensional_price_configuration: nil, license_type: nil, model_type: :cumulative_grouped_bulk)
|
|
10632
10819
|
# Some parameter documentations has been truncated, see
|
|
10633
10820
|
# {Orb::Models::Price::CumulativeGroupedBulk} for more details.
|
|
10634
10821
|
#
|
|
@@ -10662,6 +10849,8 @@ module Orb
|
|
|
10662
10849
|
#
|
|
10663
10850
|
# @param fixed_price_quantity [Float, nil]
|
|
10664
10851
|
#
|
|
10852
|
+
# @param invoice_grouping_key [String, nil]
|
|
10853
|
+
#
|
|
10665
10854
|
# @param invoicing_cycle_configuration [Orb::Models::BillingCycleConfiguration, nil]
|
|
10666
10855
|
#
|
|
10667
10856
|
# @param item [Orb::Models::ItemSlim] A minimal representation of an Item containing only the essential identifying in
|
|
@@ -10957,6 +11146,11 @@ module Orb
|
|
|
10957
11146
|
# @return [Float, nil]
|
|
10958
11147
|
required :fixed_price_quantity, Float, nil?: true
|
|
10959
11148
|
|
|
11149
|
+
# @!attribute invoice_grouping_key
|
|
11150
|
+
#
|
|
11151
|
+
# @return [String, nil]
|
|
11152
|
+
required :invoice_grouping_key, String, nil?: true
|
|
11153
|
+
|
|
10960
11154
|
# @!attribute invoicing_cycle_configuration
|
|
10961
11155
|
#
|
|
10962
11156
|
# @return [Orb::Models::BillingCycleConfiguration, nil]
|
|
@@ -11043,7 +11237,7 @@ module Orb
|
|
|
11043
11237
|
# @return [Orb::Models::Price::CumulativeGroupedAllocation::LicenseType, nil]
|
|
11044
11238
|
optional :license_type, -> { Orb::Price::CumulativeGroupedAllocation::LicenseType }, nil?: true
|
|
11045
11239
|
|
|
11046
|
-
# @!method initialize(id:, billable_metric:, billing_cycle_configuration:, billing_mode:, cadence:, composite_price_filters:, conversion_rate:, conversion_rate_config:, created_at:, credit_allocation:, cumulative_grouped_allocation_config:, currency:, discount:, external_price_id:, fixed_price_quantity:, invoicing_cycle_configuration:, item:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, plan_phase_order:, price_type:, replaces_price_id:, dimensional_price_configuration: nil, license_type: nil, model_type: :cumulative_grouped_allocation)
|
|
11240
|
+
# @!method initialize(id:, billable_metric:, billing_cycle_configuration:, billing_mode:, cadence:, composite_price_filters:, conversion_rate:, conversion_rate_config:, created_at:, credit_allocation:, cumulative_grouped_allocation_config:, currency:, discount:, external_price_id:, fixed_price_quantity:, invoice_grouping_key:, invoicing_cycle_configuration:, item:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, plan_phase_order:, price_type:, replaces_price_id:, dimensional_price_configuration: nil, license_type: nil, model_type: :cumulative_grouped_allocation)
|
|
11047
11241
|
# Some parameter documentations has been truncated, see
|
|
11048
11242
|
# {Orb::Models::Price::CumulativeGroupedAllocation} for more details.
|
|
11049
11243
|
#
|
|
@@ -11077,6 +11271,8 @@ module Orb
|
|
|
11077
11271
|
#
|
|
11078
11272
|
# @param fixed_price_quantity [Float, nil]
|
|
11079
11273
|
#
|
|
11274
|
+
# @param invoice_grouping_key [String, nil]
|
|
11275
|
+
#
|
|
11080
11276
|
# @param invoicing_cycle_configuration [Orb::Models::BillingCycleConfiguration, nil]
|
|
11081
11277
|
#
|
|
11082
11278
|
# @param item [Orb::Models::ItemSlim] A minimal representation of an Item containing only the essential identifying in
|
|
@@ -11350,6 +11546,11 @@ module Orb
|
|
|
11350
11546
|
# @return [Float, nil]
|
|
11351
11547
|
required :fixed_price_quantity, Float, nil?: true
|
|
11352
11548
|
|
|
11549
|
+
# @!attribute invoice_grouping_key
|
|
11550
|
+
#
|
|
11551
|
+
# @return [String, nil]
|
|
11552
|
+
required :invoice_grouping_key, String, nil?: true
|
|
11553
|
+
|
|
11353
11554
|
# @!attribute invoicing_cycle_configuration
|
|
11354
11555
|
#
|
|
11355
11556
|
# @return [Orb::Models::BillingCycleConfiguration, nil]
|
|
@@ -11442,7 +11643,7 @@ module Orb
|
|
|
11442
11643
|
# @return [Orb::Models::Price::MinimumComposite::LicenseType, nil]
|
|
11443
11644
|
optional :license_type, -> { Orb::Price::MinimumComposite::LicenseType }, nil?: true
|
|
11444
11645
|
|
|
11445
|
-
# @!method initialize(id:, billable_metric:, billing_cycle_configuration:, billing_mode:, cadence:, composite_price_filters:, conversion_rate:, conversion_rate_config:, created_at:, credit_allocation:, currency:, discount:, external_price_id:, fixed_price_quantity:, invoicing_cycle_configuration:, item:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, minimum_composite_config:, name:, plan_phase_order:, price_type:, replaces_price_id:, dimensional_price_configuration: nil, license_type: nil, model_type: :minimum_composite)
|
|
11646
|
+
# @!method initialize(id:, billable_metric:, billing_cycle_configuration:, billing_mode:, cadence:, composite_price_filters:, conversion_rate:, conversion_rate_config:, created_at:, credit_allocation:, currency:, discount:, external_price_id:, fixed_price_quantity:, invoice_grouping_key:, invoicing_cycle_configuration:, item:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, minimum_composite_config:, name:, plan_phase_order:, price_type:, replaces_price_id:, dimensional_price_configuration: nil, license_type: nil, model_type: :minimum_composite)
|
|
11446
11647
|
# Some parameter documentations has been truncated, see
|
|
11447
11648
|
# {Orb::Models::Price::MinimumComposite} for more details.
|
|
11448
11649
|
#
|
|
@@ -11474,6 +11675,8 @@ module Orb
|
|
|
11474
11675
|
#
|
|
11475
11676
|
# @param fixed_price_quantity [Float, nil]
|
|
11476
11677
|
#
|
|
11678
|
+
# @param invoice_grouping_key [String, nil]
|
|
11679
|
+
#
|
|
11477
11680
|
# @param invoicing_cycle_configuration [Orb::Models::BillingCycleConfiguration, nil]
|
|
11478
11681
|
#
|
|
11479
11682
|
# @param item [Orb::Models::ItemSlim] A minimal representation of an Item containing only the essential identifying in
|
|
@@ -11731,6 +11934,11 @@ module Orb
|
|
|
11731
11934
|
# @return [Float, nil]
|
|
11732
11935
|
required :fixed_price_quantity, Float, nil?: true
|
|
11733
11936
|
|
|
11937
|
+
# @!attribute invoice_grouping_key
|
|
11938
|
+
#
|
|
11939
|
+
# @return [String, nil]
|
|
11940
|
+
required :invoice_grouping_key, String, nil?: true
|
|
11941
|
+
|
|
11734
11942
|
# @!attribute invoicing_cycle_configuration
|
|
11735
11943
|
#
|
|
11736
11944
|
# @return [Orb::Models::BillingCycleConfiguration, nil]
|
|
@@ -11823,7 +12031,7 @@ module Orb
|
|
|
11823
12031
|
# @return [Orb::Models::Price::Percent::LicenseType, nil]
|
|
11824
12032
|
optional :license_type, -> { Orb::Price::Percent::LicenseType }, nil?: true
|
|
11825
12033
|
|
|
11826
|
-
# @!method initialize(id:, billable_metric:, billing_cycle_configuration:, billing_mode:, cadence:, composite_price_filters:, conversion_rate:, conversion_rate_config:, created_at:, credit_allocation:, currency:, discount:, external_price_id:, fixed_price_quantity:, invoicing_cycle_configuration:, item:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, percent_config:, plan_phase_order:, price_type:, replaces_price_id:, dimensional_price_configuration: nil, license_type: nil, model_type: :percent)
|
|
12034
|
+
# @!method initialize(id:, billable_metric:, billing_cycle_configuration:, billing_mode:, cadence:, composite_price_filters:, conversion_rate:, conversion_rate_config:, created_at:, credit_allocation:, currency:, discount:, external_price_id:, fixed_price_quantity:, invoice_grouping_key:, invoicing_cycle_configuration:, item:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, percent_config:, plan_phase_order:, price_type:, replaces_price_id:, dimensional_price_configuration: nil, license_type: nil, model_type: :percent)
|
|
11827
12035
|
# Some parameter documentations has been truncated, see
|
|
11828
12036
|
# {Orb::Models::Price::Percent} for more details.
|
|
11829
12037
|
#
|
|
@@ -11855,6 +12063,8 @@ module Orb
|
|
|
11855
12063
|
#
|
|
11856
12064
|
# @param fixed_price_quantity [Float, nil]
|
|
11857
12065
|
#
|
|
12066
|
+
# @param invoice_grouping_key [String, nil]
|
|
12067
|
+
#
|
|
11858
12068
|
# @param invoicing_cycle_configuration [Orb::Models::BillingCycleConfiguration, nil]
|
|
11859
12069
|
#
|
|
11860
12070
|
# @param item [Orb::Models::ItemSlim] A minimal representation of an Item containing only the essential identifying in
|
|
@@ -12114,6 +12324,11 @@ module Orb
|
|
|
12114
12324
|
# @return [Float, nil]
|
|
12115
12325
|
required :fixed_price_quantity, Float, nil?: true
|
|
12116
12326
|
|
|
12327
|
+
# @!attribute invoice_grouping_key
|
|
12328
|
+
#
|
|
12329
|
+
# @return [String, nil]
|
|
12330
|
+
required :invoice_grouping_key, String, nil?: true
|
|
12331
|
+
|
|
12117
12332
|
# @!attribute invoicing_cycle_configuration
|
|
12118
12333
|
#
|
|
12119
12334
|
# @return [Orb::Models::BillingCycleConfiguration, nil]
|
|
@@ -12200,7 +12415,7 @@ module Orb
|
|
|
12200
12415
|
# @return [Orb::Models::Price::EventOutput::LicenseType, nil]
|
|
12201
12416
|
optional :license_type, -> { Orb::Price::EventOutput::LicenseType }, nil?: true
|
|
12202
12417
|
|
|
12203
|
-
# @!method initialize(id:, billable_metric:, billing_cycle_configuration:, billing_mode:, cadence:, composite_price_filters:, conversion_rate:, conversion_rate_config:, created_at:, credit_allocation:, currency:, discount:, event_output_config:, external_price_id:, fixed_price_quantity:, invoicing_cycle_configuration:, item:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, plan_phase_order:, price_type:, replaces_price_id:, dimensional_price_configuration: nil, license_type: nil, model_type: :event_output)
|
|
12418
|
+
# @!method initialize(id:, billable_metric:, billing_cycle_configuration:, billing_mode:, cadence:, composite_price_filters:, conversion_rate:, conversion_rate_config:, created_at:, credit_allocation:, currency:, discount:, event_output_config:, external_price_id:, fixed_price_quantity:, invoice_grouping_key:, invoicing_cycle_configuration:, item:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, plan_phase_order:, price_type:, replaces_price_id:, dimensional_price_configuration: nil, license_type: nil, model_type: :event_output)
|
|
12204
12419
|
# Some parameter documentations has been truncated, see
|
|
12205
12420
|
# {Orb::Models::Price::EventOutput} for more details.
|
|
12206
12421
|
#
|
|
@@ -12234,6 +12449,8 @@ module Orb
|
|
|
12234
12449
|
#
|
|
12235
12450
|
# @param fixed_price_quantity [Float, nil]
|
|
12236
12451
|
#
|
|
12452
|
+
# @param invoice_grouping_key [String, nil]
|
|
12453
|
+
#
|
|
12237
12454
|
# @param invoicing_cycle_configuration [Orb::Models::BillingCycleConfiguration, nil]
|
|
12238
12455
|
#
|
|
12239
12456
|
# @param item [Orb::Models::ItemSlim] A minimal representation of an Item containing only the essential identifying in
|