orb-billing 0.5.2 → 0.5.4
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 +25 -0
- data/README.md +4 -4
- data/SECURITY.md +2 -2
- data/lib/orb/internal/util.rb +3 -1
- data/lib/orb/internal.rb +3 -0
- data/lib/orb/models/alert.rb +23 -23
- data/lib/orb/models/alert_create_for_customer_params.rb +5 -5
- data/lib/orb/models/alert_create_for_external_customer_params.rb +5 -5
- data/lib/orb/models/alert_create_for_subscription_params.rb +5 -5
- data/lib/orb/models/alert_update_params.rb +3 -3
- data/lib/orb/models/amount_discount.rb +5 -5
- data/lib/orb/models/billable_metric.rb +7 -7
- data/lib/orb/models/coupon.rb +6 -6
- data/lib/orb/models/coupon_create_params.rb +3 -3
- data/lib/orb/models/credit_note.rb +33 -33
- data/lib/orb/models/credit_note_create_params.rb +4 -4
- data/lib/orb/models/customer.rb +39 -39
- data/lib/orb/models/customer_create_params.rb +26 -26
- data/lib/orb/models/customer_update_by_external_id_params.rb +26 -26
- data/lib/orb/models/customer_update_params.rb +26 -26
- data/lib/orb/models/customers/balance_transaction_create_params.rb +2 -2
- data/lib/orb/models/customers/cost_list_by_external_id_params.rb +2 -2
- data/lib/orb/models/customers/cost_list_by_external_id_response.rb +2 -2
- data/lib/orb/models/customers/cost_list_params.rb +2 -2
- data/lib/orb/models/customers/cost_list_response.rb +2 -2
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +7 -7
- data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +8 -8
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +4 -4
- data/lib/orb/models/customers/credits/ledger_list_params.rb +4 -4
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +6 -6
- data/lib/orb/models/customers/credits/top_up_create_params.rb +6 -5
- data/lib/orb/models/dimensional_price_group.rb +1 -1
- data/lib/orb/models/dimensional_price_groups.rb +4 -4
- data/lib/orb/models/discount.rb +1 -1
- data/lib/orb/models/event_ingest_params.rb +3 -3
- data/lib/orb/models/events/event_volumes.rb +2 -2
- data/lib/orb/models/invoice.rb +114 -113
- data/lib/orb/models/invoice_create_params.rb +10 -10
- data/lib/orb/models/invoice_fetch_upcoming_response.rb +6 -6
- data/lib/orb/models/invoice_level_discount.rb +1 -1
- data/lib/orb/models/invoice_line_item_create_response.rb +4 -4
- data/lib/orb/models/invoice_list_params.rb +4 -4
- data/lib/orb/models/item.rb +5 -5
- data/lib/orb/models/item_update_params.rb +5 -5
- data/lib/orb/models/percentage_discount.rb +5 -5
- data/lib/orb/models/plan.rb +58 -58
- data/lib/orb/models/plan_create_params.rb +448 -444
- data/lib/orb/models/plan_list_params.rb +2 -2
- data/lib/orb/models/price.rb +1204 -1204
- data/lib/orb/models/price_create_params.rb +50 -50
- data/lib/orb/models/price_evaluate_response.rb +2 -2
- data/lib/orb/models/subscription.rb +58 -56
- data/lib/orb/models/subscription_cancel_params.rb +2 -2
- data/lib/orb/models/subscription_cancel_response.rb +14 -14
- data/lib/orb/models/subscription_change_apply_response.rb +14 -14
- data/lib/orb/models/subscription_change_cancel_response.rb +14 -14
- data/lib/orb/models/subscription_change_retrieve_response.rb +14 -14
- data/lib/orb/models/subscription_create_params.rb +1002 -987
- data/lib/orb/models/subscription_create_response.rb +14 -14
- data/lib/orb/models/subscription_fetch_costs_params.rb +2 -2
- data/lib/orb/models/subscription_fetch_costs_response.rb +2 -2
- data/lib/orb/models/subscription_fetch_usage_params.rb +4 -4
- data/lib/orb/models/subscription_list_params.rb +2 -2
- data/lib/orb/models/subscription_price_intervals_params.rb +596 -585
- data/lib/orb/models/subscription_price_intervals_response.rb +14 -14
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +973 -971
- data/lib/orb/models/subscription_schedule_plan_change_response.rb +14 -14
- data/lib/orb/models/subscription_trigger_phase_response.rb +14 -14
- data/lib/orb/models/subscription_unschedule_cancellation_response.rb +14 -14
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +14 -14
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +14 -14
- data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +2 -2
- data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +14 -14
- data/lib/orb/models/subscription_update_trial_params.rb +3 -3
- data/lib/orb/models/subscription_update_trial_response.rb +14 -14
- data/lib/orb/models/subscription_usage.rb +26 -26
- data/lib/orb/models/subscriptions.rb +4 -4
- data/lib/orb/models/trial_discount.rb +5 -5
- data/lib/orb/models/usage_discount.rb +5 -5
- data/lib/orb/resources/alerts.rb +15 -15
- data/lib/orb/resources/coupons/subscriptions.rb +1 -1
- data/lib/orb/resources/coupons.rb +5 -5
- data/lib/orb/resources/credit_notes.rb +5 -5
- data/lib/orb/resources/customers/balance_transactions.rb +1 -1
- data/lib/orb/resources/customers/costs.rb +2 -2
- data/lib/orb/resources/customers/credits/ledger.rb +10 -10
- data/lib/orb/resources/customers/credits/top_ups.rb +4 -4
- data/lib/orb/resources/customers.rb +30 -30
- data/lib/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rb +1 -1
- data/lib/orb/resources/dimensional_price_groups.rb +3 -3
- data/lib/orb/resources/events/volume.rb +1 -1
- data/lib/orb/resources/events.rb +1 -1
- data/lib/orb/resources/invoices.rb +12 -12
- data/lib/orb/resources/items.rb +5 -5
- data/lib/orb/resources/metrics.rb +4 -4
- data/lib/orb/resources/plans/external_plan_id.rb +2 -2
- data/lib/orb/resources/plans.rb +7 -7
- data/lib/orb/resources/prices/external_price_id.rb +2 -2
- data/lib/orb/resources/prices.rb +17 -17
- data/lib/orb/resources/subscriptions.rb +32 -32
- data/lib/orb/version.rb +1 -1
- data/rbi/orb/internal.rbi +3 -0
- data/rbi/orb/models/subscription_price_intervals_params.rbi +26 -72
- data/rbi/orb/models/subscription_update_trial_params.rbi +14 -3
- data/rbi/orb/resources/subscriptions.rbi +4 -1
- data/sig/orb/internal/page.rbs +2 -0
- data/sig/orb/internal.rbs +2 -0
- data/sig/orb/models/alert.rbs +32 -4
- data/sig/orb/models/alert_create_for_customer_params.rbs +9 -0
- data/sig/orb/models/alert_create_for_external_customer_params.rbs +9 -0
- data/sig/orb/models/alert_create_for_subscription_params.rbs +9 -0
- data/sig/orb/models/alert_disable_params.rbs +5 -0
- data/sig/orb/models/alert_enable_params.rbs +5 -0
- data/sig/orb/models/alert_list_params.rbs +13 -0
- data/sig/orb/models/alert_retrieve_params.rbs +2 -0
- data/sig/orb/models/alert_update_params.rbs +7 -0
- data/sig/orb/models/amount_discount.rbs +11 -4
- data/sig/orb/models/billable_metric.rbs +13 -4
- data/sig/orb/models/coupon.rbs +14 -4
- data/sig/orb/models/coupon_archive_params.rbs +2 -0
- data/sig/orb/models/coupon_create_params.rbs +15 -0
- data/sig/orb/models/coupon_fetch_params.rbs +2 -0
- data/sig/orb/models/coupon_list_params.rbs +8 -0
- data/sig/orb/models/coupons/subscription_list_params.rbs +6 -0
- data/sig/orb/models/credit_note.rbs +88 -20
- data/sig/orb/models/credit_note_create_params.rbs +9 -0
- data/sig/orb/models/credit_note_fetch_params.rbs +2 -0
- data/sig/orb/models/credit_note_list_params.rbs +10 -0
- data/sig/orb/models/customer.rbs +86 -16
- data/sig/orb/models/customer_create_params.rbs +79 -8
- data/sig/orb/models/customer_delete_params.rbs +2 -0
- data/sig/orb/models/customer_fetch_by_external_id_params.rbs +2 -0
- data/sig/orb/models/customer_fetch_params.rbs +2 -0
- data/sig/orb/models/customer_list_params.rbs +10 -0
- data/sig/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbs +2 -0
- data/sig/orb/models/customer_sync_payment_methods_from_gateway_params.rbs +2 -0
- data/sig/orb/models/customer_update_by_external_id_params.rbs +78 -8
- data/sig/orb/models/customer_update_params.rbs +78 -8
- data/sig/orb/models/customers/balance_transaction_create_params.rbs +7 -0
- data/sig/orb/models/customers/balance_transaction_create_response.rbs +17 -0
- data/sig/orb/models/customers/balance_transaction_list_params.rbs +10 -0
- data/sig/orb/models/customers/balance_transaction_list_response.rbs +17 -0
- data/sig/orb/models/customers/cost_list_by_external_id_params.rbs +8 -0
- data/sig/orb/models/customers/cost_list_by_external_id_response.rbs +20 -0
- data/sig/orb/models/customers/cost_list_params.rbs +8 -0
- data/sig/orb/models/customers/cost_list_response.rbs +20 -0
- data/sig/orb/models/customers/credit_list_by_external_id_params.rbs +8 -0
- data/sig/orb/models/customers/credit_list_by_external_id_response.rbs +10 -0
- data/sig/orb/models/customers/credit_list_params.rbs +8 -0
- data/sig/orb/models/customers/credit_list_response.rbs +10 -0
- data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbs +23 -0
- data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbs +177 -0
- data/sig/orb/models/customers/credits/ledger_create_entry_params.rbs +23 -0
- data/sig/orb/models/customers/credits/ledger_create_entry_response.rbs +177 -0
- data/sig/orb/models/customers/credits/ledger_list_by_external_id_params.rbs +14 -0
- data/sig/orb/models/customers/credits/ledger_list_by_external_id_response.rbs +177 -0
- data/sig/orb/models/customers/credits/ledger_list_params.rbs +14 -0
- data/sig/orb/models/customers/credits/ledger_list_response.rbs +177 -0
- data/sig/orb/models/customers/credits/top_up_create_by_external_id_params.rbs +19 -0
- data/sig/orb/models/customers/credits/top_up_create_by_external_id_response.rbs +18 -0
- data/sig/orb/models/customers/credits/top_up_create_params.rbs +19 -0
- data/sig/orb/models/customers/credits/top_up_create_response.rbs +18 -0
- data/sig/orb/models/customers/credits/top_up_delete_by_external_id_params.rbs +5 -0
- data/sig/orb/models/customers/credits/top_up_delete_params.rbs +5 -0
- data/sig/orb/models/customers/credits/top_up_list_by_external_id_params.rbs +6 -0
- data/sig/orb/models/customers/credits/top_up_list_by_external_id_response.rbs +18 -0
- data/sig/orb/models/customers/credits/top_up_list_params.rbs +6 -0
- data/sig/orb/models/customers/credits/top_up_list_response.rbs +18 -0
- data/sig/orb/models/dimensional_price_group.rbs +9 -0
- data/sig/orb/models/dimensional_price_group_create_params.rbs +9 -0
- data/sig/orb/models/dimensional_price_group_list_params.rbs +6 -0
- data/sig/orb/models/dimensional_price_group_retrieve_params.rbs +2 -0
- data/sig/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbs +2 -0
- data/sig/orb/models/dimensional_price_groups.rbs +5 -0
- data/sig/orb/models/evaluate_price_group.rbs +10 -4
- data/sig/orb/models/event_deprecate_params.rbs +2 -0
- data/sig/orb/models/event_deprecate_response.rbs +2 -0
- data/sig/orb/models/event_ingest_params.rbs +16 -0
- data/sig/orb/models/event_ingest_response.rbs +15 -0
- data/sig/orb/models/event_search_params.rbs +7 -0
- data/sig/orb/models/event_search_response.rbs +12 -0
- data/sig/orb/models/event_update_params.rbs +9 -0
- data/sig/orb/models/event_update_response.rbs +2 -0
- data/sig/orb/models/events/backfill_close_params.rbs +2 -0
- data/sig/orb/models/events/backfill_close_response.rbs +14 -0
- data/sig/orb/models/events/backfill_create_params.rbs +11 -0
- data/sig/orb/models/events/backfill_create_response.rbs +14 -0
- data/sig/orb/models/events/backfill_fetch_params.rbs +2 -0
- data/sig/orb/models/events/backfill_fetch_response.rbs +14 -0
- data/sig/orb/models/events/backfill_list_params.rbs +6 -0
- data/sig/orb/models/events/backfill_list_response.rbs +14 -0
- data/sig/orb/models/events/backfill_revert_params.rbs +2 -0
- data/sig/orb/models/events/backfill_revert_response.rbs +14 -0
- data/sig/orb/models/events/event_volumes.rbs +8 -0
- data/sig/orb/models/events/volume_list_params.rbs +8 -0
- data/sig/orb/models/invoice.rbs +293 -36
- data/sig/orb/models/invoice_create_params.rbs +30 -4
- data/sig/orb/models/invoice_fetch_params.rbs +2 -0
- data/sig/orb/models/invoice_fetch_upcoming_params.rbs +5 -0
- data/sig/orb/models/invoice_fetch_upcoming_response.rbs +257 -0
- data/sig/orb/models/invoice_issue_params.rbs +5 -0
- data/sig/orb/models/invoice_line_item_create_params.rbs +10 -0
- data/sig/orb/models/invoice_line_item_create_response.rbs +132 -0
- data/sig/orb/models/invoice_list_params.rbs +27 -4
- data/sig/orb/models/invoice_mark_paid_params.rbs +7 -0
- data/sig/orb/models/invoice_pay_params.rbs +2 -0
- data/sig/orb/models/invoice_update_params.rbs +5 -0
- data/sig/orb/models/invoice_void_params.rbs +2 -0
- data/sig/orb/models/item.rbs +16 -4
- data/sig/orb/models/item_create_params.rbs +2 -0
- data/sig/orb/models/item_fetch_params.rbs +2 -0
- data/sig/orb/models/item_list_params.rbs +6 -0
- data/sig/orb/models/item_update_params.rbs +15 -4
- data/sig/orb/models/metric_create_params.rbs +9 -0
- data/sig/orb/models/metric_fetch_params.rbs +2 -0
- data/sig/orb/models/metric_list_params.rbs +10 -0
- data/sig/orb/models/metric_update_params.rbs +5 -0
- data/sig/orb/models/pagination_metadata.rbs +2 -0
- data/sig/orb/models/percentage_discount.rbs +11 -4
- data/sig/orb/models/plan.rbs +141 -16
- data/sig/orb/models/plan_create_params.rbs +1070 -304
- data/sig/orb/models/plan_fetch_params.rbs +2 -0
- data/sig/orb/models/plan_list_params.rbs +11 -0
- data/sig/orb/models/plan_update_params.rbs +6 -0
- data/sig/orb/models/plans/external_plan_id_fetch_params.rbs +2 -0
- data/sig/orb/models/plans/external_plan_id_update_params.rbs +6 -0
- data/sig/orb/models/price.rbs +2148 -460
- data/sig/orb/models/price_create_params.rbs +130 -8
- data/sig/orb/models/price_evaluate_params.rbs +10 -0
- data/sig/orb/models/price_evaluate_response.rbs +2 -0
- data/sig/orb/models/price_fetch_params.rbs +2 -0
- data/sig/orb/models/price_list_params.rbs +6 -0
- data/sig/orb/models/price_update_params.rbs +5 -0
- data/sig/orb/models/prices/external_price_id_fetch_params.rbs +2 -0
- data/sig/orb/models/prices/external_price_id_update_params.rbs +5 -0
- data/sig/orb/models/subscription.rbs +177 -12
- data/sig/orb/models/subscription_cancel_params.rbs +7 -0
- data/sig/orb/models/subscription_cancel_response.rbs +173 -0
- data/sig/orb/models/subscription_change_apply_params.rbs +6 -0
- data/sig/orb/models/subscription_change_apply_response.rbs +186 -0
- data/sig/orb/models/subscription_change_cancel_params.rbs +2 -0
- data/sig/orb/models/subscription_change_cancel_response.rbs +186 -0
- data/sig/orb/models/subscription_change_retrieve_params.rbs +2 -0
- data/sig/orb/models/subscription_change_retrieve_response.rbs +186 -0
- data/sig/orb/models/subscription_create_params.rbs +2368 -632
- data/sig/orb/models/subscription_create_response.rbs +173 -0
- data/sig/orb/models/subscription_fetch_costs_params.rbs +8 -0
- data/sig/orb/models/subscription_fetch_costs_response.rbs +20 -0
- data/sig/orb/models/subscription_fetch_params.rbs +2 -0
- data/sig/orb/models/subscription_fetch_schedule_params.rbs +10 -0
- data/sig/orb/models/subscription_fetch_schedule_response.rbs +13 -0
- data/sig/orb/models/subscription_fetch_usage_params.rbs +14 -0
- data/sig/orb/models/subscription_list_params.rbs +13 -0
- data/sig/orb/models/subscription_price_intervals_params.rbs +1348 -396
- data/sig/orb/models/subscription_price_intervals_response.rbs +173 -0
- data/sig/orb/models/subscription_schedule_plan_change_params.rbs +2363 -632
- data/sig/orb/models/subscription_schedule_plan_change_response.rbs +173 -0
- data/sig/orb/models/subscription_trigger_phase_params.rbs +6 -0
- data/sig/orb/models/subscription_trigger_phase_response.rbs +173 -0
- data/sig/orb/models/subscription_unschedule_cancellation_params.rbs +2 -0
- data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +173 -0
- data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbs +2 -0
- data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +173 -0
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_params.rbs +2 -0
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +173 -0
- data/sig/orb/models/subscription_update_fixed_fee_quantity_params.rbs +9 -0
- data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +173 -0
- data/sig/orb/models/subscription_update_params.rbs +9 -0
- data/sig/orb/models/subscription_update_trial_params.rbs +6 -0
- data/sig/orb/models/subscription_update_trial_response.rbs +173 -0
- data/sig/orb/models/subscription_usage.rbs +48 -8
- data/sig/orb/models/subscriptions.rbs +5 -0
- data/sig/orb/models/top_level_ping_params.rbs +2 -0
- data/sig/orb/models/top_level_ping_response.rbs +2 -0
- data/sig/orb/models/trial_discount.rbs +12 -4
- data/sig/orb/models/usage_discount.rbs +11 -4
- data/sig/orb/resources/invoices.rbs +1 -1
- data/sig/orb/resources/plans.rbs +1 -1
- metadata +2 -2
@@ -23,7 +23,7 @@ module Orb
|
|
23
23
|
# Prices for this plan. If the plan has phases, this includes prices across all
|
24
24
|
# phases of the plan.
|
25
25
|
#
|
26
|
-
# @return [Array<Orb::PlanCreateParams::Price::Unit, Orb::PlanCreateParams::Price::Package, Orb::PlanCreateParams::Price::Matrix, Orb::PlanCreateParams::Price::Tiered, Orb::PlanCreateParams::Price::TieredBps, Orb::PlanCreateParams::Price::Bps, Orb::PlanCreateParams::Price::BulkBps, Orb::PlanCreateParams::Price::Bulk, Orb::PlanCreateParams::Price::ThresholdTotalAmount, Orb::PlanCreateParams::Price::TieredPackage, Orb::PlanCreateParams::Price::TieredWithMinimum, Orb::PlanCreateParams::Price::UnitWithPercent, Orb::PlanCreateParams::Price::PackageWithAllocation, Orb::PlanCreateParams::Price::TieredWithProration, Orb::PlanCreateParams::Price::UnitWithProration, Orb::PlanCreateParams::Price::GroupedAllocation, Orb::PlanCreateParams::Price::GroupedWithProratedMinimum, Orb::PlanCreateParams::Price::GroupedWithMeteredMinimum, Orb::PlanCreateParams::Price::MatrixWithDisplayName, Orb::PlanCreateParams::Price::BulkWithProration, Orb::PlanCreateParams::Price::GroupedTieredPackage, Orb::PlanCreateParams::Price::MaxGroupTieredPackage, Orb::PlanCreateParams::Price::ScalableMatrixWithUnitPricing, Orb::PlanCreateParams::Price::ScalableMatrixWithTieredPricing, Orb::PlanCreateParams::Price::CumulativeGroupedBulk>]
|
26
|
+
# @return [Array<Orb::Models::PlanCreateParams::Price::Unit, Orb::Models::PlanCreateParams::Price::Package, Orb::Models::PlanCreateParams::Price::Matrix, Orb::Models::PlanCreateParams::Price::Tiered, Orb::Models::PlanCreateParams::Price::TieredBps, Orb::Models::PlanCreateParams::Price::Bps, Orb::Models::PlanCreateParams::Price::BulkBps, Orb::Models::PlanCreateParams::Price::Bulk, Orb::Models::PlanCreateParams::Price::ThresholdTotalAmount, Orb::Models::PlanCreateParams::Price::TieredPackage, Orb::Models::PlanCreateParams::Price::TieredWithMinimum, Orb::Models::PlanCreateParams::Price::UnitWithPercent, Orb::Models::PlanCreateParams::Price::PackageWithAllocation, Orb::Models::PlanCreateParams::Price::TieredWithProration, Orb::Models::PlanCreateParams::Price::UnitWithProration, Orb::Models::PlanCreateParams::Price::GroupedAllocation, Orb::Models::PlanCreateParams::Price::GroupedWithProratedMinimum, Orb::Models::PlanCreateParams::Price::GroupedWithMeteredMinimum, Orb::Models::PlanCreateParams::Price::MatrixWithDisplayName, Orb::Models::PlanCreateParams::Price::BulkWithProration, Orb::Models::PlanCreateParams::Price::GroupedTieredPackage, Orb::Models::PlanCreateParams::Price::MaxGroupTieredPackage, Orb::Models::PlanCreateParams::Price::ScalableMatrixWithUnitPricing, Orb::Models::PlanCreateParams::Price::ScalableMatrixWithTieredPricing, Orb::Models::PlanCreateParams::Price::CumulativeGroupedBulk>]
|
27
27
|
required :prices, -> { Orb::Internal::Type::ArrayOf[union: Orb::PlanCreateParams::Price] }
|
28
28
|
|
29
29
|
# @!attribute default_invoice_memo
|
@@ -57,7 +57,7 @@ module Orb
|
|
57
57
|
# The status of the plan to create (either active or draft). If not specified,
|
58
58
|
# this defaults to active.
|
59
59
|
#
|
60
|
-
# @return [Symbol, Orb::PlanCreateParams::Status, nil]
|
60
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Status, nil]
|
61
61
|
optional :status, enum: -> { Orb::PlanCreateParams::Status }
|
62
62
|
|
63
63
|
# @!method initialize(currency:, name:, prices:, default_invoice_memo: nil, external_plan_id: nil, metadata: nil, net_terms: nil, status: nil, request_options: {})
|
@@ -68,7 +68,7 @@ module Orb
|
|
68
68
|
#
|
69
69
|
# @param name [String]
|
70
70
|
#
|
71
|
-
# @param prices [Array<Orb::PlanCreateParams::Price::Unit, Orb::PlanCreateParams::Price::Package, Orb::PlanCreateParams::Price::Matrix, Orb::PlanCreateParams::Price::Tiered, Orb::PlanCreateParams::Price::TieredBps, Orb::PlanCreateParams::Price::Bps, Orb::PlanCreateParams::Price::BulkBps, Orb::PlanCreateParams::Price::Bulk, Orb::PlanCreateParams::Price::ThresholdTotalAmount, Orb::PlanCreateParams::Price::TieredPackage, Orb::PlanCreateParams::Price::TieredWithMinimum, Orb::PlanCreateParams::Price::UnitWithPercent, Orb::PlanCreateParams::Price::PackageWithAllocation, Orb::PlanCreateParams::Price::TieredWithProration, Orb::PlanCreateParams::Price::UnitWithProration, Orb::PlanCreateParams::Price::GroupedAllocation, Orb::PlanCreateParams::Price::GroupedWithProratedMinimum, Orb::PlanCreateParams::Price::GroupedWithMeteredMinimum, Orb::PlanCreateParams::Price::MatrixWithDisplayName, Orb::PlanCreateParams::Price::BulkWithProration, Orb::PlanCreateParams::Price::GroupedTieredPackage, Orb::PlanCreateParams::Price::MaxGroupTieredPackage, Orb::PlanCreateParams::Price::ScalableMatrixWithUnitPricing, Orb::PlanCreateParams::Price::ScalableMatrixWithTieredPricing, Orb::PlanCreateParams::Price::CumulativeGroupedBulk>] Prices for this plan. If the plan has phases, this includes prices across all ph
|
71
|
+
# @param prices [Array<Orb::Models::PlanCreateParams::Price::Unit, Orb::Models::PlanCreateParams::Price::Package, Orb::Models::PlanCreateParams::Price::Matrix, Orb::Models::PlanCreateParams::Price::Tiered, Orb::Models::PlanCreateParams::Price::TieredBps, Orb::Models::PlanCreateParams::Price::Bps, Orb::Models::PlanCreateParams::Price::BulkBps, Orb::Models::PlanCreateParams::Price::Bulk, Orb::Models::PlanCreateParams::Price::ThresholdTotalAmount, Orb::Models::PlanCreateParams::Price::TieredPackage, Orb::Models::PlanCreateParams::Price::TieredWithMinimum, Orb::Models::PlanCreateParams::Price::UnitWithPercent, Orb::Models::PlanCreateParams::Price::PackageWithAllocation, Orb::Models::PlanCreateParams::Price::TieredWithProration, Orb::Models::PlanCreateParams::Price::UnitWithProration, Orb::Models::PlanCreateParams::Price::GroupedAllocation, Orb::Models::PlanCreateParams::Price::GroupedWithProratedMinimum, Orb::Models::PlanCreateParams::Price::GroupedWithMeteredMinimum, Orb::Models::PlanCreateParams::Price::MatrixWithDisplayName, Orb::Models::PlanCreateParams::Price::BulkWithProration, Orb::Models::PlanCreateParams::Price::GroupedTieredPackage, Orb::Models::PlanCreateParams::Price::MaxGroupTieredPackage, Orb::Models::PlanCreateParams::Price::ScalableMatrixWithUnitPricing, Orb::Models::PlanCreateParams::Price::ScalableMatrixWithTieredPricing, Orb::Models::PlanCreateParams::Price::CumulativeGroupedBulk>] Prices for this plan. If the plan has phases, this includes prices across all ph
|
72
72
|
#
|
73
73
|
# @param default_invoice_memo [String, nil] Free-form text which is available on the invoice PDF and the Orb invoice portal.
|
74
74
|
#
|
@@ -78,7 +78,7 @@ module Orb
|
|
78
78
|
#
|
79
79
|
# @param net_terms [Integer, nil] The net terms determines the difference between the invoice date and the issue d
|
80
80
|
#
|
81
|
-
# @param status [Symbol, Orb::PlanCreateParams::Status] The status of the plan to create (either active or draft). If not specified, thi
|
81
|
+
# @param status [Symbol, Orb::Models::PlanCreateParams::Status] The status of the plan to create (either active or draft). If not specified, thi
|
82
82
|
#
|
83
83
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
84
84
|
|
@@ -146,7 +146,7 @@ module Orb
|
|
146
146
|
# @!attribute cadence
|
147
147
|
# The cadence to bill for this price on.
|
148
148
|
#
|
149
|
-
# @return [Symbol, Orb::PlanCreateParams::Price::Unit::Cadence]
|
149
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::Unit::Cadence]
|
150
150
|
required :cadence, enum: -> { Orb::PlanCreateParams::Price::Unit::Cadence }
|
151
151
|
|
152
152
|
# @!attribute item_id
|
@@ -168,7 +168,7 @@ module Orb
|
|
168
168
|
|
169
169
|
# @!attribute unit_config
|
170
170
|
#
|
171
|
-
# @return [Orb::PlanCreateParams::Price::Unit::UnitConfig]
|
171
|
+
# @return [Orb::Models::PlanCreateParams::Price::Unit::UnitConfig]
|
172
172
|
required :unit_config, -> { Orb::PlanCreateParams::Price::Unit::UnitConfig }
|
173
173
|
|
174
174
|
# @!attribute billable_metric_id
|
@@ -189,7 +189,7 @@ module Orb
|
|
189
189
|
# For custom cadence: specifies the duration of the billing period in days or
|
190
190
|
# months.
|
191
191
|
#
|
192
|
-
# @return [Orb::PlanCreateParams::Price::Unit::BillingCycleConfiguration, nil]
|
192
|
+
# @return [Orb::Models::PlanCreateParams::Price::Unit::BillingCycleConfiguration, nil]
|
193
193
|
optional :billing_cycle_configuration,
|
194
194
|
-> { Orb::PlanCreateParams::Price::Unit::BillingCycleConfiguration },
|
195
195
|
nil?: true
|
@@ -230,7 +230,7 @@ module Orb
|
|
230
230
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
231
231
|
# If unspecified, a single invoice is produced per billing cycle.
|
232
232
|
#
|
233
|
-
# @return [Orb::PlanCreateParams::Price::Unit::InvoicingCycleConfiguration, nil]
|
233
|
+
# @return [Orb::Models::PlanCreateParams::Price::Unit::InvoicingCycleConfiguration, nil]
|
234
234
|
optional :invoicing_cycle_configuration,
|
235
235
|
-> { Orb::PlanCreateParams::Price::Unit::InvoicingCycleConfiguration },
|
236
236
|
nil?: true
|
@@ -245,21 +245,21 @@ module Orb
|
|
245
245
|
|
246
246
|
# @!method initialize(cadence:, item_id:, name:, unit_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :unit)
|
247
247
|
# Some parameter documentations has been truncated, see
|
248
|
-
# {Orb::PlanCreateParams::Price::Unit} for more details.
|
248
|
+
# {Orb::Models::PlanCreateParams::Price::Unit} for more details.
|
249
249
|
#
|
250
|
-
# @param cadence [Symbol, Orb::PlanCreateParams::Price::Unit::Cadence] The cadence to bill for this price on.
|
250
|
+
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::Unit::Cadence] The cadence to bill for this price on.
|
251
251
|
#
|
252
252
|
# @param item_id [String] The id of the item the price will be associated with.
|
253
253
|
#
|
254
254
|
# @param name [String] The name of the price.
|
255
255
|
#
|
256
|
-
# @param unit_config [Orb::PlanCreateParams::Price::Unit::UnitConfig]
|
256
|
+
# @param unit_config [Orb::Models::PlanCreateParams::Price::Unit::UnitConfig]
|
257
257
|
#
|
258
258
|
# @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b
|
259
259
|
#
|
260
260
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
261
261
|
#
|
262
|
-
# @param billing_cycle_configuration [Orb::PlanCreateParams::Price::Unit::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
262
|
+
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::Unit::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
263
263
|
#
|
264
264
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
265
265
|
#
|
@@ -271,7 +271,7 @@ module Orb
|
|
271
271
|
#
|
272
272
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
273
273
|
#
|
274
|
-
# @param invoicing_cycle_configuration [Orb::PlanCreateParams::Price::Unit::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
274
|
+
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::Unit::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
275
275
|
#
|
276
276
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
277
277
|
#
|
@@ -279,7 +279,7 @@ module Orb
|
|
279
279
|
|
280
280
|
# The cadence to bill for this price on.
|
281
281
|
#
|
282
|
-
# @see Orb::PlanCreateParams::Price::Unit#cadence
|
282
|
+
# @see Orb::Models::PlanCreateParams::Price::Unit#cadence
|
283
283
|
module Cadence
|
284
284
|
extend Orb::Internal::Type::Enum
|
285
285
|
|
@@ -294,7 +294,7 @@ module Orb
|
|
294
294
|
# @return [Array<Symbol>]
|
295
295
|
end
|
296
296
|
|
297
|
-
# @see Orb::PlanCreateParams::Price::Unit#unit_config
|
297
|
+
# @see Orb::Models::PlanCreateParams::Price::Unit#unit_config
|
298
298
|
class UnitConfig < Orb::Internal::Type::BaseModel
|
299
299
|
# @!attribute unit_amount
|
300
300
|
# Rate per unit of usage
|
@@ -306,7 +306,7 @@ module Orb
|
|
306
306
|
# @param unit_amount [String] Rate per unit of usage
|
307
307
|
end
|
308
308
|
|
309
|
-
# @see Orb::PlanCreateParams::Price::Unit#billing_cycle_configuration
|
309
|
+
# @see Orb::Models::PlanCreateParams::Price::Unit#billing_cycle_configuration
|
310
310
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
311
311
|
# @!attribute duration
|
312
312
|
# The duration of the billing period.
|
@@ -317,7 +317,7 @@ module Orb
|
|
317
317
|
# @!attribute duration_unit
|
318
318
|
# The unit of billing period duration.
|
319
319
|
#
|
320
|
-
# @return [Symbol, Orb::PlanCreateParams::Price::Unit::BillingCycleConfiguration::DurationUnit]
|
320
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::Unit::BillingCycleConfiguration::DurationUnit]
|
321
321
|
required :duration_unit,
|
322
322
|
enum: -> { Orb::PlanCreateParams::Price::Unit::BillingCycleConfiguration::DurationUnit }
|
323
323
|
|
@@ -327,11 +327,11 @@ module Orb
|
|
327
327
|
#
|
328
328
|
# @param duration [Integer] The duration of the billing period.
|
329
329
|
#
|
330
|
-
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::Unit::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
330
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::Unit::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
331
331
|
|
332
332
|
# The unit of billing period duration.
|
333
333
|
#
|
334
|
-
# @see Orb::PlanCreateParams::Price::Unit::BillingCycleConfiguration#duration_unit
|
334
|
+
# @see Orb::Models::PlanCreateParams::Price::Unit::BillingCycleConfiguration#duration_unit
|
335
335
|
module DurationUnit
|
336
336
|
extend Orb::Internal::Type::Enum
|
337
337
|
|
@@ -343,7 +343,7 @@ module Orb
|
|
343
343
|
end
|
344
344
|
end
|
345
345
|
|
346
|
-
# @see Orb::PlanCreateParams::Price::Unit#invoicing_cycle_configuration
|
346
|
+
# @see Orb::Models::PlanCreateParams::Price::Unit#invoicing_cycle_configuration
|
347
347
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
348
348
|
# @!attribute duration
|
349
349
|
# The duration of the billing period.
|
@@ -354,7 +354,7 @@ module Orb
|
|
354
354
|
# @!attribute duration_unit
|
355
355
|
# The unit of billing period duration.
|
356
356
|
#
|
357
|
-
# @return [Symbol, Orb::PlanCreateParams::Price::Unit::InvoicingCycleConfiguration::DurationUnit]
|
357
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::Unit::InvoicingCycleConfiguration::DurationUnit]
|
358
358
|
required :duration_unit,
|
359
359
|
enum: -> {
|
360
360
|
Orb::PlanCreateParams::Price::Unit::InvoicingCycleConfiguration::DurationUnit
|
@@ -366,11 +366,11 @@ module Orb
|
|
366
366
|
#
|
367
367
|
# @param duration [Integer] The duration of the billing period.
|
368
368
|
#
|
369
|
-
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::Unit::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
369
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::Unit::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
370
370
|
|
371
371
|
# The unit of billing period duration.
|
372
372
|
#
|
373
|
-
# @see Orb::PlanCreateParams::Price::Unit::InvoicingCycleConfiguration#duration_unit
|
373
|
+
# @see Orb::Models::PlanCreateParams::Price::Unit::InvoicingCycleConfiguration#duration_unit
|
374
374
|
module DurationUnit
|
375
375
|
extend Orb::Internal::Type::Enum
|
376
376
|
|
@@ -387,7 +387,7 @@ module Orb
|
|
387
387
|
# @!attribute cadence
|
388
388
|
# The cadence to bill for this price on.
|
389
389
|
#
|
390
|
-
# @return [Symbol, Orb::PlanCreateParams::Price::Package::Cadence]
|
390
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::Package::Cadence]
|
391
391
|
required :cadence, enum: -> { Orb::PlanCreateParams::Price::Package::Cadence }
|
392
392
|
|
393
393
|
# @!attribute item_id
|
@@ -409,7 +409,7 @@ module Orb
|
|
409
409
|
|
410
410
|
# @!attribute package_config
|
411
411
|
#
|
412
|
-
# @return [Orb::PlanCreateParams::Price::Package::PackageConfig]
|
412
|
+
# @return [Orb::Models::PlanCreateParams::Price::Package::PackageConfig]
|
413
413
|
required :package_config, -> { Orb::PlanCreateParams::Price::Package::PackageConfig }
|
414
414
|
|
415
415
|
# @!attribute billable_metric_id
|
@@ -430,7 +430,7 @@ module Orb
|
|
430
430
|
# For custom cadence: specifies the duration of the billing period in days or
|
431
431
|
# months.
|
432
432
|
#
|
433
|
-
# @return [Orb::PlanCreateParams::Price::Package::BillingCycleConfiguration, nil]
|
433
|
+
# @return [Orb::Models::PlanCreateParams::Price::Package::BillingCycleConfiguration, nil]
|
434
434
|
optional :billing_cycle_configuration,
|
435
435
|
-> { Orb::PlanCreateParams::Price::Package::BillingCycleConfiguration },
|
436
436
|
nil?: true
|
@@ -471,7 +471,7 @@ module Orb
|
|
471
471
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
472
472
|
# If unspecified, a single invoice is produced per billing cycle.
|
473
473
|
#
|
474
|
-
# @return [Orb::PlanCreateParams::Price::Package::InvoicingCycleConfiguration, nil]
|
474
|
+
# @return [Orb::Models::PlanCreateParams::Price::Package::InvoicingCycleConfiguration, nil]
|
475
475
|
optional :invoicing_cycle_configuration,
|
476
476
|
-> { Orb::PlanCreateParams::Price::Package::InvoicingCycleConfiguration },
|
477
477
|
nil?: true
|
@@ -486,21 +486,21 @@ module Orb
|
|
486
486
|
|
487
487
|
# @!method initialize(cadence:, item_id:, name:, package_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :package)
|
488
488
|
# Some parameter documentations has been truncated, see
|
489
|
-
# {Orb::PlanCreateParams::Price::Package} for more details.
|
489
|
+
# {Orb::Models::PlanCreateParams::Price::Package} for more details.
|
490
490
|
#
|
491
|
-
# @param cadence [Symbol, Orb::PlanCreateParams::Price::Package::Cadence] The cadence to bill for this price on.
|
491
|
+
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::Package::Cadence] The cadence to bill for this price on.
|
492
492
|
#
|
493
493
|
# @param item_id [String] The id of the item the price will be associated with.
|
494
494
|
#
|
495
495
|
# @param name [String] The name of the price.
|
496
496
|
#
|
497
|
-
# @param package_config [Orb::PlanCreateParams::Price::Package::PackageConfig]
|
497
|
+
# @param package_config [Orb::Models::PlanCreateParams::Price::Package::PackageConfig]
|
498
498
|
#
|
499
499
|
# @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b
|
500
500
|
#
|
501
501
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
502
502
|
#
|
503
|
-
# @param billing_cycle_configuration [Orb::PlanCreateParams::Price::Package::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
503
|
+
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::Package::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
504
504
|
#
|
505
505
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
506
506
|
#
|
@@ -512,7 +512,7 @@ module Orb
|
|
512
512
|
#
|
513
513
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
514
514
|
#
|
515
|
-
# @param invoicing_cycle_configuration [Orb::PlanCreateParams::Price::Package::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
515
|
+
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::Package::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
516
516
|
#
|
517
517
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
518
518
|
#
|
@@ -520,7 +520,7 @@ module Orb
|
|
520
520
|
|
521
521
|
# The cadence to bill for this price on.
|
522
522
|
#
|
523
|
-
# @see Orb::PlanCreateParams::Price::Package#cadence
|
523
|
+
# @see Orb::Models::PlanCreateParams::Price::Package#cadence
|
524
524
|
module Cadence
|
525
525
|
extend Orb::Internal::Type::Enum
|
526
526
|
|
@@ -535,7 +535,7 @@ module Orb
|
|
535
535
|
# @return [Array<Symbol>]
|
536
536
|
end
|
537
537
|
|
538
|
-
# @see Orb::PlanCreateParams::Price::Package#package_config
|
538
|
+
# @see Orb::Models::PlanCreateParams::Price::Package#package_config
|
539
539
|
class PackageConfig < Orb::Internal::Type::BaseModel
|
540
540
|
# @!attribute package_amount
|
541
541
|
# A currency amount to rate usage by
|
@@ -552,14 +552,14 @@ module Orb
|
|
552
552
|
|
553
553
|
# @!method initialize(package_amount:, package_size:)
|
554
554
|
# Some parameter documentations has been truncated, see
|
555
|
-
# {Orb::PlanCreateParams::Price::Package::PackageConfig} for more details.
|
555
|
+
# {Orb::Models::PlanCreateParams::Price::Package::PackageConfig} for more details.
|
556
556
|
#
|
557
557
|
# @param package_amount [String] A currency amount to rate usage by
|
558
558
|
#
|
559
559
|
# @param package_size [Integer] An integer amount to represent package size. For example, 1000 here would divide
|
560
560
|
end
|
561
561
|
|
562
|
-
# @see Orb::PlanCreateParams::Price::Package#billing_cycle_configuration
|
562
|
+
# @see Orb::Models::PlanCreateParams::Price::Package#billing_cycle_configuration
|
563
563
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
564
564
|
# @!attribute duration
|
565
565
|
# The duration of the billing period.
|
@@ -570,7 +570,7 @@ module Orb
|
|
570
570
|
# @!attribute duration_unit
|
571
571
|
# The unit of billing period duration.
|
572
572
|
#
|
573
|
-
# @return [Symbol, Orb::PlanCreateParams::Price::Package::BillingCycleConfiguration::DurationUnit]
|
573
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::Package::BillingCycleConfiguration::DurationUnit]
|
574
574
|
required :duration_unit,
|
575
575
|
enum: -> {
|
576
576
|
Orb::PlanCreateParams::Price::Package::BillingCycleConfiguration::DurationUnit
|
@@ -582,11 +582,11 @@ module Orb
|
|
582
582
|
#
|
583
583
|
# @param duration [Integer] The duration of the billing period.
|
584
584
|
#
|
585
|
-
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::Package::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
585
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::Package::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
586
586
|
|
587
587
|
# The unit of billing period duration.
|
588
588
|
#
|
589
|
-
# @see Orb::PlanCreateParams::Price::Package::BillingCycleConfiguration#duration_unit
|
589
|
+
# @see Orb::Models::PlanCreateParams::Price::Package::BillingCycleConfiguration#duration_unit
|
590
590
|
module DurationUnit
|
591
591
|
extend Orb::Internal::Type::Enum
|
592
592
|
|
@@ -598,7 +598,7 @@ module Orb
|
|
598
598
|
end
|
599
599
|
end
|
600
600
|
|
601
|
-
# @see Orb::PlanCreateParams::Price::Package#invoicing_cycle_configuration
|
601
|
+
# @see Orb::Models::PlanCreateParams::Price::Package#invoicing_cycle_configuration
|
602
602
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
603
603
|
# @!attribute duration
|
604
604
|
# The duration of the billing period.
|
@@ -609,7 +609,7 @@ module Orb
|
|
609
609
|
# @!attribute duration_unit
|
610
610
|
# The unit of billing period duration.
|
611
611
|
#
|
612
|
-
# @return [Symbol, Orb::PlanCreateParams::Price::Package::InvoicingCycleConfiguration::DurationUnit]
|
612
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::Package::InvoicingCycleConfiguration::DurationUnit]
|
613
613
|
required :duration_unit,
|
614
614
|
enum: -> {
|
615
615
|
Orb::PlanCreateParams::Price::Package::InvoicingCycleConfiguration::DurationUnit
|
@@ -621,11 +621,11 @@ module Orb
|
|
621
621
|
#
|
622
622
|
# @param duration [Integer] The duration of the billing period.
|
623
623
|
#
|
624
|
-
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::Package::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
624
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::Package::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
625
625
|
|
626
626
|
# The unit of billing period duration.
|
627
627
|
#
|
628
|
-
# @see Orb::PlanCreateParams::Price::Package::InvoicingCycleConfiguration#duration_unit
|
628
|
+
# @see Orb::Models::PlanCreateParams::Price::Package::InvoicingCycleConfiguration#duration_unit
|
629
629
|
module DurationUnit
|
630
630
|
extend Orb::Internal::Type::Enum
|
631
631
|
|
@@ -642,7 +642,7 @@ module Orb
|
|
642
642
|
# @!attribute cadence
|
643
643
|
# The cadence to bill for this price on.
|
644
644
|
#
|
645
|
-
# @return [Symbol, Orb::PlanCreateParams::Price::Matrix::Cadence]
|
645
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::Matrix::Cadence]
|
646
646
|
required :cadence, enum: -> { Orb::PlanCreateParams::Price::Matrix::Cadence }
|
647
647
|
|
648
648
|
# @!attribute item_id
|
@@ -653,7 +653,7 @@ module Orb
|
|
653
653
|
|
654
654
|
# @!attribute matrix_config
|
655
655
|
#
|
656
|
-
# @return [Orb::PlanCreateParams::Price::Matrix::MatrixConfig]
|
656
|
+
# @return [Orb::Models::PlanCreateParams::Price::Matrix::MatrixConfig]
|
657
657
|
required :matrix_config, -> { Orb::PlanCreateParams::Price::Matrix::MatrixConfig }
|
658
658
|
|
659
659
|
# @!attribute model_type
|
@@ -685,7 +685,7 @@ module Orb
|
|
685
685
|
# For custom cadence: specifies the duration of the billing period in days or
|
686
686
|
# months.
|
687
687
|
#
|
688
|
-
# @return [Orb::PlanCreateParams::Price::Matrix::BillingCycleConfiguration, nil]
|
688
|
+
# @return [Orb::Models::PlanCreateParams::Price::Matrix::BillingCycleConfiguration, nil]
|
689
689
|
optional :billing_cycle_configuration,
|
690
690
|
-> { Orb::PlanCreateParams::Price::Matrix::BillingCycleConfiguration },
|
691
691
|
nil?: true
|
@@ -726,7 +726,7 @@ module Orb
|
|
726
726
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
727
727
|
# If unspecified, a single invoice is produced per billing cycle.
|
728
728
|
#
|
729
|
-
# @return [Orb::PlanCreateParams::Price::Matrix::InvoicingCycleConfiguration, nil]
|
729
|
+
# @return [Orb::Models::PlanCreateParams::Price::Matrix::InvoicingCycleConfiguration, nil]
|
730
730
|
optional :invoicing_cycle_configuration,
|
731
731
|
-> { Orb::PlanCreateParams::Price::Matrix::InvoicingCycleConfiguration },
|
732
732
|
nil?: true
|
@@ -741,13 +741,13 @@ module Orb
|
|
741
741
|
|
742
742
|
# @!method initialize(cadence:, item_id:, matrix_config:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :matrix)
|
743
743
|
# Some parameter documentations has been truncated, see
|
744
|
-
# {Orb::PlanCreateParams::Price::Matrix} for more details.
|
744
|
+
# {Orb::Models::PlanCreateParams::Price::Matrix} for more details.
|
745
745
|
#
|
746
|
-
# @param cadence [Symbol, Orb::PlanCreateParams::Price::Matrix::Cadence] The cadence to bill for this price on.
|
746
|
+
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::Matrix::Cadence] The cadence to bill for this price on.
|
747
747
|
#
|
748
748
|
# @param item_id [String] The id of the item the price will be associated with.
|
749
749
|
#
|
750
|
-
# @param matrix_config [Orb::PlanCreateParams::Price::Matrix::MatrixConfig]
|
750
|
+
# @param matrix_config [Orb::Models::PlanCreateParams::Price::Matrix::MatrixConfig]
|
751
751
|
#
|
752
752
|
# @param name [String] The name of the price.
|
753
753
|
#
|
@@ -755,7 +755,7 @@ module Orb
|
|
755
755
|
#
|
756
756
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
757
757
|
#
|
758
|
-
# @param billing_cycle_configuration [Orb::PlanCreateParams::Price::Matrix::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
758
|
+
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::Matrix::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
759
759
|
#
|
760
760
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
761
761
|
#
|
@@ -767,7 +767,7 @@ module Orb
|
|
767
767
|
#
|
768
768
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
769
769
|
#
|
770
|
-
# @param invoicing_cycle_configuration [Orb::PlanCreateParams::Price::Matrix::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
770
|
+
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::Matrix::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
771
771
|
#
|
772
772
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
773
773
|
#
|
@@ -775,7 +775,7 @@ module Orb
|
|
775
775
|
|
776
776
|
# The cadence to bill for this price on.
|
777
777
|
#
|
778
|
-
# @see Orb::PlanCreateParams::Price::Matrix#cadence
|
778
|
+
# @see Orb::Models::PlanCreateParams::Price::Matrix#cadence
|
779
779
|
module Cadence
|
780
780
|
extend Orb::Internal::Type::Enum
|
781
781
|
|
@@ -790,7 +790,7 @@ module Orb
|
|
790
790
|
# @return [Array<Symbol>]
|
791
791
|
end
|
792
792
|
|
793
|
-
# @see Orb::PlanCreateParams::Price::Matrix#matrix_config
|
793
|
+
# @see Orb::Models::PlanCreateParams::Price::Matrix#matrix_config
|
794
794
|
class MatrixConfig < Orb::Internal::Type::BaseModel
|
795
795
|
# @!attribute default_unit_amount
|
796
796
|
# Default per unit rate for any usage not bucketed into a specified matrix_value
|
@@ -807,7 +807,7 @@ module Orb
|
|
807
807
|
# @!attribute matrix_values
|
808
808
|
# Matrix values for specified matrix grouping keys
|
809
809
|
#
|
810
|
-
# @return [Array<Orb::PlanCreateParams::Price::Matrix::MatrixConfig::MatrixValue>]
|
810
|
+
# @return [Array<Orb::Models::PlanCreateParams::Price::Matrix::MatrixConfig::MatrixValue>]
|
811
811
|
required :matrix_values,
|
812
812
|
-> {
|
813
813
|
Orb::Internal::Type::ArrayOf[Orb::PlanCreateParams::Price::Matrix::MatrixConfig::MatrixValue]
|
@@ -818,7 +818,7 @@ module Orb
|
|
818
818
|
#
|
819
819
|
# @param dimensions [Array<String, nil>] One or two event property values to evaluate matrix groups by
|
820
820
|
#
|
821
|
-
# @param matrix_values [Array<Orb::PlanCreateParams::Price::Matrix::MatrixConfig::MatrixValue>] Matrix values for specified matrix grouping keys
|
821
|
+
# @param matrix_values [Array<Orb::Models::PlanCreateParams::Price::Matrix::MatrixConfig::MatrixValue>] Matrix values for specified matrix grouping keys
|
822
822
|
|
823
823
|
class MatrixValue < Orb::Internal::Type::BaseModel
|
824
824
|
# @!attribute dimension_values
|
@@ -837,8 +837,8 @@ module Orb
|
|
837
837
|
|
838
838
|
# @!method initialize(dimension_values:, unit_amount:)
|
839
839
|
# Some parameter documentations has been truncated, see
|
840
|
-
# {Orb::PlanCreateParams::Price::Matrix::MatrixConfig::MatrixValue} for
|
841
|
-
# details.
|
840
|
+
# {Orb::Models::PlanCreateParams::Price::Matrix::MatrixConfig::MatrixValue} for
|
841
|
+
# more details.
|
842
842
|
#
|
843
843
|
# @param dimension_values [Array<String, nil>] One or two matrix keys to filter usage to this Matrix value by. For example, ["r
|
844
844
|
#
|
@@ -846,7 +846,7 @@ module Orb
|
|
846
846
|
end
|
847
847
|
end
|
848
848
|
|
849
|
-
# @see Orb::PlanCreateParams::Price::Matrix#billing_cycle_configuration
|
849
|
+
# @see Orb::Models::PlanCreateParams::Price::Matrix#billing_cycle_configuration
|
850
850
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
851
851
|
# @!attribute duration
|
852
852
|
# The duration of the billing period.
|
@@ -857,7 +857,7 @@ module Orb
|
|
857
857
|
# @!attribute duration_unit
|
858
858
|
# The unit of billing period duration.
|
859
859
|
#
|
860
|
-
# @return [Symbol, Orb::PlanCreateParams::Price::Matrix::BillingCycleConfiguration::DurationUnit]
|
860
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::Matrix::BillingCycleConfiguration::DurationUnit]
|
861
861
|
required :duration_unit,
|
862
862
|
enum: -> {
|
863
863
|
Orb::PlanCreateParams::Price::Matrix::BillingCycleConfiguration::DurationUnit
|
@@ -869,11 +869,11 @@ module Orb
|
|
869
869
|
#
|
870
870
|
# @param duration [Integer] The duration of the billing period.
|
871
871
|
#
|
872
|
-
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::Matrix::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
872
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::Matrix::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
873
873
|
|
874
874
|
# The unit of billing period duration.
|
875
875
|
#
|
876
|
-
# @see Orb::PlanCreateParams::Price::Matrix::BillingCycleConfiguration#duration_unit
|
876
|
+
# @see Orb::Models::PlanCreateParams::Price::Matrix::BillingCycleConfiguration#duration_unit
|
877
877
|
module DurationUnit
|
878
878
|
extend Orb::Internal::Type::Enum
|
879
879
|
|
@@ -885,7 +885,7 @@ module Orb
|
|
885
885
|
end
|
886
886
|
end
|
887
887
|
|
888
|
-
# @see Orb::PlanCreateParams::Price::Matrix#invoicing_cycle_configuration
|
888
|
+
# @see Orb::Models::PlanCreateParams::Price::Matrix#invoicing_cycle_configuration
|
889
889
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
890
890
|
# @!attribute duration
|
891
891
|
# The duration of the billing period.
|
@@ -896,7 +896,7 @@ module Orb
|
|
896
896
|
# @!attribute duration_unit
|
897
897
|
# The unit of billing period duration.
|
898
898
|
#
|
899
|
-
# @return [Symbol, Orb::PlanCreateParams::Price::Matrix::InvoicingCycleConfiguration::DurationUnit]
|
899
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::Matrix::InvoicingCycleConfiguration::DurationUnit]
|
900
900
|
required :duration_unit,
|
901
901
|
enum: -> {
|
902
902
|
Orb::PlanCreateParams::Price::Matrix::InvoicingCycleConfiguration::DurationUnit
|
@@ -908,11 +908,11 @@ module Orb
|
|
908
908
|
#
|
909
909
|
# @param duration [Integer] The duration of the billing period.
|
910
910
|
#
|
911
|
-
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::Matrix::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
911
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::Matrix::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
912
912
|
|
913
913
|
# The unit of billing period duration.
|
914
914
|
#
|
915
|
-
# @see Orb::PlanCreateParams::Price::Matrix::InvoicingCycleConfiguration#duration_unit
|
915
|
+
# @see Orb::Models::PlanCreateParams::Price::Matrix::InvoicingCycleConfiguration#duration_unit
|
916
916
|
module DurationUnit
|
917
917
|
extend Orb::Internal::Type::Enum
|
918
918
|
|
@@ -929,7 +929,7 @@ module Orb
|
|
929
929
|
# @!attribute cadence
|
930
930
|
# The cadence to bill for this price on.
|
931
931
|
#
|
932
|
-
# @return [Symbol, Orb::PlanCreateParams::Price::Tiered::Cadence]
|
932
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::Tiered::Cadence]
|
933
933
|
required :cadence, enum: -> { Orb::PlanCreateParams::Price::Tiered::Cadence }
|
934
934
|
|
935
935
|
# @!attribute item_id
|
@@ -951,7 +951,7 @@ module Orb
|
|
951
951
|
|
952
952
|
# @!attribute tiered_config
|
953
953
|
#
|
954
|
-
# @return [Orb::PlanCreateParams::Price::Tiered::TieredConfig]
|
954
|
+
# @return [Orb::Models::PlanCreateParams::Price::Tiered::TieredConfig]
|
955
955
|
required :tiered_config, -> { Orb::PlanCreateParams::Price::Tiered::TieredConfig }
|
956
956
|
|
957
957
|
# @!attribute billable_metric_id
|
@@ -972,7 +972,7 @@ module Orb
|
|
972
972
|
# For custom cadence: specifies the duration of the billing period in days or
|
973
973
|
# months.
|
974
974
|
#
|
975
|
-
# @return [Orb::PlanCreateParams::Price::Tiered::BillingCycleConfiguration, nil]
|
975
|
+
# @return [Orb::Models::PlanCreateParams::Price::Tiered::BillingCycleConfiguration, nil]
|
976
976
|
optional :billing_cycle_configuration,
|
977
977
|
-> { Orb::PlanCreateParams::Price::Tiered::BillingCycleConfiguration },
|
978
978
|
nil?: true
|
@@ -1013,7 +1013,7 @@ module Orb
|
|
1013
1013
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
1014
1014
|
# If unspecified, a single invoice is produced per billing cycle.
|
1015
1015
|
#
|
1016
|
-
# @return [Orb::PlanCreateParams::Price::Tiered::InvoicingCycleConfiguration, nil]
|
1016
|
+
# @return [Orb::Models::PlanCreateParams::Price::Tiered::InvoicingCycleConfiguration, nil]
|
1017
1017
|
optional :invoicing_cycle_configuration,
|
1018
1018
|
-> { Orb::PlanCreateParams::Price::Tiered::InvoicingCycleConfiguration },
|
1019
1019
|
nil?: true
|
@@ -1028,21 +1028,21 @@ module Orb
|
|
1028
1028
|
|
1029
1029
|
# @!method initialize(cadence:, item_id:, name:, tiered_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :tiered)
|
1030
1030
|
# Some parameter documentations has been truncated, see
|
1031
|
-
# {Orb::PlanCreateParams::Price::Tiered} for more details.
|
1031
|
+
# {Orb::Models::PlanCreateParams::Price::Tiered} for more details.
|
1032
1032
|
#
|
1033
|
-
# @param cadence [Symbol, Orb::PlanCreateParams::Price::Tiered::Cadence] The cadence to bill for this price on.
|
1033
|
+
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::Tiered::Cadence] The cadence to bill for this price on.
|
1034
1034
|
#
|
1035
1035
|
# @param item_id [String] The id of the item the price will be associated with.
|
1036
1036
|
#
|
1037
1037
|
# @param name [String] The name of the price.
|
1038
1038
|
#
|
1039
|
-
# @param tiered_config [Orb::PlanCreateParams::Price::Tiered::TieredConfig]
|
1039
|
+
# @param tiered_config [Orb::Models::PlanCreateParams::Price::Tiered::TieredConfig]
|
1040
1040
|
#
|
1041
1041
|
# @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b
|
1042
1042
|
#
|
1043
1043
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
1044
1044
|
#
|
1045
|
-
# @param billing_cycle_configuration [Orb::PlanCreateParams::Price::Tiered::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
1045
|
+
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::Tiered::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
1046
1046
|
#
|
1047
1047
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
1048
1048
|
#
|
@@ -1054,7 +1054,7 @@ module Orb
|
|
1054
1054
|
#
|
1055
1055
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
1056
1056
|
#
|
1057
|
-
# @param invoicing_cycle_configuration [Orb::PlanCreateParams::Price::Tiered::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
1057
|
+
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::Tiered::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
1058
1058
|
#
|
1059
1059
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
1060
1060
|
#
|
@@ -1062,7 +1062,7 @@ module Orb
|
|
1062
1062
|
|
1063
1063
|
# The cadence to bill for this price on.
|
1064
1064
|
#
|
1065
|
-
# @see Orb::PlanCreateParams::Price::Tiered#cadence
|
1065
|
+
# @see Orb::Models::PlanCreateParams::Price::Tiered#cadence
|
1066
1066
|
module Cadence
|
1067
1067
|
extend Orb::Internal::Type::Enum
|
1068
1068
|
|
@@ -1077,19 +1077,19 @@ module Orb
|
|
1077
1077
|
# @return [Array<Symbol>]
|
1078
1078
|
end
|
1079
1079
|
|
1080
|
-
# @see Orb::PlanCreateParams::Price::Tiered#tiered_config
|
1080
|
+
# @see Orb::Models::PlanCreateParams::Price::Tiered#tiered_config
|
1081
1081
|
class TieredConfig < Orb::Internal::Type::BaseModel
|
1082
1082
|
# @!attribute tiers
|
1083
1083
|
# Tiers for rating based on total usage quantities into the specified tier
|
1084
1084
|
#
|
1085
|
-
# @return [Array<Orb::PlanCreateParams::Price::Tiered::TieredConfig::Tier>]
|
1085
|
+
# @return [Array<Orb::Models::PlanCreateParams::Price::Tiered::TieredConfig::Tier>]
|
1086
1086
|
required :tiers,
|
1087
1087
|
-> {
|
1088
1088
|
Orb::Internal::Type::ArrayOf[Orb::PlanCreateParams::Price::Tiered::TieredConfig::Tier]
|
1089
1089
|
}
|
1090
1090
|
|
1091
1091
|
# @!method initialize(tiers:)
|
1092
|
-
# @param tiers [Array<Orb::PlanCreateParams::Price::Tiered::TieredConfig::Tier>] Tiers for rating based on total usage quantities into the specified tier
|
1092
|
+
# @param tiers [Array<Orb::Models::PlanCreateParams::Price::Tiered::TieredConfig::Tier>] Tiers for rating based on total usage quantities into the specified tier
|
1093
1093
|
|
1094
1094
|
class Tier < Orb::Internal::Type::BaseModel
|
1095
1095
|
# @!attribute first_unit
|
@@ -1119,7 +1119,7 @@ module Orb
|
|
1119
1119
|
end
|
1120
1120
|
end
|
1121
1121
|
|
1122
|
-
# @see Orb::PlanCreateParams::Price::Tiered#billing_cycle_configuration
|
1122
|
+
# @see Orb::Models::PlanCreateParams::Price::Tiered#billing_cycle_configuration
|
1123
1123
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
1124
1124
|
# @!attribute duration
|
1125
1125
|
# The duration of the billing period.
|
@@ -1130,7 +1130,7 @@ module Orb
|
|
1130
1130
|
# @!attribute duration_unit
|
1131
1131
|
# The unit of billing period duration.
|
1132
1132
|
#
|
1133
|
-
# @return [Symbol, Orb::PlanCreateParams::Price::Tiered::BillingCycleConfiguration::DurationUnit]
|
1133
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::Tiered::BillingCycleConfiguration::DurationUnit]
|
1134
1134
|
required :duration_unit,
|
1135
1135
|
enum: -> {
|
1136
1136
|
Orb::PlanCreateParams::Price::Tiered::BillingCycleConfiguration::DurationUnit
|
@@ -1142,11 +1142,11 @@ module Orb
|
|
1142
1142
|
#
|
1143
1143
|
# @param duration [Integer] The duration of the billing period.
|
1144
1144
|
#
|
1145
|
-
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::Tiered::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
1145
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::Tiered::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
1146
1146
|
|
1147
1147
|
# The unit of billing period duration.
|
1148
1148
|
#
|
1149
|
-
# @see Orb::PlanCreateParams::Price::Tiered::BillingCycleConfiguration#duration_unit
|
1149
|
+
# @see Orb::Models::PlanCreateParams::Price::Tiered::BillingCycleConfiguration#duration_unit
|
1150
1150
|
module DurationUnit
|
1151
1151
|
extend Orb::Internal::Type::Enum
|
1152
1152
|
|
@@ -1158,7 +1158,7 @@ module Orb
|
|
1158
1158
|
end
|
1159
1159
|
end
|
1160
1160
|
|
1161
|
-
# @see Orb::PlanCreateParams::Price::Tiered#invoicing_cycle_configuration
|
1161
|
+
# @see Orb::Models::PlanCreateParams::Price::Tiered#invoicing_cycle_configuration
|
1162
1162
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
1163
1163
|
# @!attribute duration
|
1164
1164
|
# The duration of the billing period.
|
@@ -1169,7 +1169,7 @@ module Orb
|
|
1169
1169
|
# @!attribute duration_unit
|
1170
1170
|
# The unit of billing period duration.
|
1171
1171
|
#
|
1172
|
-
# @return [Symbol, Orb::PlanCreateParams::Price::Tiered::InvoicingCycleConfiguration::DurationUnit]
|
1172
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::Tiered::InvoicingCycleConfiguration::DurationUnit]
|
1173
1173
|
required :duration_unit,
|
1174
1174
|
enum: -> {
|
1175
1175
|
Orb::PlanCreateParams::Price::Tiered::InvoicingCycleConfiguration::DurationUnit
|
@@ -1181,11 +1181,11 @@ module Orb
|
|
1181
1181
|
#
|
1182
1182
|
# @param duration [Integer] The duration of the billing period.
|
1183
1183
|
#
|
1184
|
-
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::Tiered::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
1184
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::Tiered::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
1185
1185
|
|
1186
1186
|
# The unit of billing period duration.
|
1187
1187
|
#
|
1188
|
-
# @see Orb::PlanCreateParams::Price::Tiered::InvoicingCycleConfiguration#duration_unit
|
1188
|
+
# @see Orb::Models::PlanCreateParams::Price::Tiered::InvoicingCycleConfiguration#duration_unit
|
1189
1189
|
module DurationUnit
|
1190
1190
|
extend Orb::Internal::Type::Enum
|
1191
1191
|
|
@@ -1202,7 +1202,7 @@ module Orb
|
|
1202
1202
|
# @!attribute cadence
|
1203
1203
|
# The cadence to bill for this price on.
|
1204
1204
|
#
|
1205
|
-
# @return [Symbol, Orb::PlanCreateParams::Price::TieredBps::Cadence]
|
1205
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::TieredBps::Cadence]
|
1206
1206
|
required :cadence, enum: -> { Orb::PlanCreateParams::Price::TieredBps::Cadence }
|
1207
1207
|
|
1208
1208
|
# @!attribute item_id
|
@@ -1224,7 +1224,7 @@ module Orb
|
|
1224
1224
|
|
1225
1225
|
# @!attribute tiered_bps_config
|
1226
1226
|
#
|
1227
|
-
# @return [Orb::PlanCreateParams::Price::TieredBps::TieredBpsConfig]
|
1227
|
+
# @return [Orb::Models::PlanCreateParams::Price::TieredBps::TieredBpsConfig]
|
1228
1228
|
required :tiered_bps_config, -> { Orb::PlanCreateParams::Price::TieredBps::TieredBpsConfig }
|
1229
1229
|
|
1230
1230
|
# @!attribute billable_metric_id
|
@@ -1245,7 +1245,7 @@ module Orb
|
|
1245
1245
|
# For custom cadence: specifies the duration of the billing period in days or
|
1246
1246
|
# months.
|
1247
1247
|
#
|
1248
|
-
# @return [Orb::PlanCreateParams::Price::TieredBps::BillingCycleConfiguration, nil]
|
1248
|
+
# @return [Orb::Models::PlanCreateParams::Price::TieredBps::BillingCycleConfiguration, nil]
|
1249
1249
|
optional :billing_cycle_configuration,
|
1250
1250
|
-> { Orb::PlanCreateParams::Price::TieredBps::BillingCycleConfiguration },
|
1251
1251
|
nil?: true
|
@@ -1286,7 +1286,7 @@ module Orb
|
|
1286
1286
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
1287
1287
|
# If unspecified, a single invoice is produced per billing cycle.
|
1288
1288
|
#
|
1289
|
-
# @return [Orb::PlanCreateParams::Price::TieredBps::InvoicingCycleConfiguration, nil]
|
1289
|
+
# @return [Orb::Models::PlanCreateParams::Price::TieredBps::InvoicingCycleConfiguration, nil]
|
1290
1290
|
optional :invoicing_cycle_configuration,
|
1291
1291
|
-> { Orb::PlanCreateParams::Price::TieredBps::InvoicingCycleConfiguration },
|
1292
1292
|
nil?: true
|
@@ -1301,21 +1301,21 @@ module Orb
|
|
1301
1301
|
|
1302
1302
|
# @!method initialize(cadence:, item_id:, name:, tiered_bps_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :tiered_bps)
|
1303
1303
|
# Some parameter documentations has been truncated, see
|
1304
|
-
# {Orb::PlanCreateParams::Price::TieredBps} for more details.
|
1304
|
+
# {Orb::Models::PlanCreateParams::Price::TieredBps} for more details.
|
1305
1305
|
#
|
1306
|
-
# @param cadence [Symbol, Orb::PlanCreateParams::Price::TieredBps::Cadence] The cadence to bill for this price on.
|
1306
|
+
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::TieredBps::Cadence] The cadence to bill for this price on.
|
1307
1307
|
#
|
1308
1308
|
# @param item_id [String] The id of the item the price will be associated with.
|
1309
1309
|
#
|
1310
1310
|
# @param name [String] The name of the price.
|
1311
1311
|
#
|
1312
|
-
# @param tiered_bps_config [Orb::PlanCreateParams::Price::TieredBps::TieredBpsConfig]
|
1312
|
+
# @param tiered_bps_config [Orb::Models::PlanCreateParams::Price::TieredBps::TieredBpsConfig]
|
1313
1313
|
#
|
1314
1314
|
# @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b
|
1315
1315
|
#
|
1316
1316
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
1317
1317
|
#
|
1318
|
-
# @param billing_cycle_configuration [Orb::PlanCreateParams::Price::TieredBps::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
1318
|
+
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::TieredBps::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
1319
1319
|
#
|
1320
1320
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
1321
1321
|
#
|
@@ -1327,7 +1327,7 @@ module Orb
|
|
1327
1327
|
#
|
1328
1328
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
1329
1329
|
#
|
1330
|
-
# @param invoicing_cycle_configuration [Orb::PlanCreateParams::Price::TieredBps::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
1330
|
+
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::TieredBps::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
1331
1331
|
#
|
1332
1332
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
1333
1333
|
#
|
@@ -1335,7 +1335,7 @@ module Orb
|
|
1335
1335
|
|
1336
1336
|
# The cadence to bill for this price on.
|
1337
1337
|
#
|
1338
|
-
# @see Orb::PlanCreateParams::Price::TieredBps#cadence
|
1338
|
+
# @see Orb::Models::PlanCreateParams::Price::TieredBps#cadence
|
1339
1339
|
module Cadence
|
1340
1340
|
extend Orb::Internal::Type::Enum
|
1341
1341
|
|
@@ -1350,13 +1350,13 @@ module Orb
|
|
1350
1350
|
# @return [Array<Symbol>]
|
1351
1351
|
end
|
1352
1352
|
|
1353
|
-
# @see Orb::PlanCreateParams::Price::TieredBps#tiered_bps_config
|
1353
|
+
# @see Orb::Models::PlanCreateParams::Price::TieredBps#tiered_bps_config
|
1354
1354
|
class TieredBpsConfig < Orb::Internal::Type::BaseModel
|
1355
1355
|
# @!attribute tiers
|
1356
1356
|
# Tiers for a Graduated BPS pricing model, where usage is bucketed into specified
|
1357
1357
|
# tiers
|
1358
1358
|
#
|
1359
|
-
# @return [Array<Orb::PlanCreateParams::Price::TieredBps::TieredBpsConfig::Tier>]
|
1359
|
+
# @return [Array<Orb::Models::PlanCreateParams::Price::TieredBps::TieredBpsConfig::Tier>]
|
1360
1360
|
required :tiers,
|
1361
1361
|
-> {
|
1362
1362
|
Orb::Internal::Type::ArrayOf[Orb::PlanCreateParams::Price::TieredBps::TieredBpsConfig::Tier]
|
@@ -1364,9 +1364,10 @@ module Orb
|
|
1364
1364
|
|
1365
1365
|
# @!method initialize(tiers:)
|
1366
1366
|
# Some parameter documentations has been truncated, see
|
1367
|
-
# {Orb::PlanCreateParams::Price::TieredBps::TieredBpsConfig} for more
|
1367
|
+
# {Orb::Models::PlanCreateParams::Price::TieredBps::TieredBpsConfig} for more
|
1368
|
+
# details.
|
1368
1369
|
#
|
1369
|
-
# @param tiers [Array<Orb::PlanCreateParams::Price::TieredBps::TieredBpsConfig::Tier>] Tiers for a Graduated BPS pricing model, where usage is bucketed into specified
|
1370
|
+
# @param tiers [Array<Orb::Models::PlanCreateParams::Price::TieredBps::TieredBpsConfig::Tier>] Tiers for a Graduated BPS pricing model, where usage is bucketed into specified
|
1370
1371
|
|
1371
1372
|
class Tier < Orb::Internal::Type::BaseModel
|
1372
1373
|
# @!attribute bps
|
@@ -1404,7 +1405,7 @@ module Orb
|
|
1404
1405
|
end
|
1405
1406
|
end
|
1406
1407
|
|
1407
|
-
# @see Orb::PlanCreateParams::Price::TieredBps#billing_cycle_configuration
|
1408
|
+
# @see Orb::Models::PlanCreateParams::Price::TieredBps#billing_cycle_configuration
|
1408
1409
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
1409
1410
|
# @!attribute duration
|
1410
1411
|
# The duration of the billing period.
|
@@ -1415,7 +1416,7 @@ module Orb
|
|
1415
1416
|
# @!attribute duration_unit
|
1416
1417
|
# The unit of billing period duration.
|
1417
1418
|
#
|
1418
|
-
# @return [Symbol, Orb::PlanCreateParams::Price::TieredBps::BillingCycleConfiguration::DurationUnit]
|
1419
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::TieredBps::BillingCycleConfiguration::DurationUnit]
|
1419
1420
|
required :duration_unit,
|
1420
1421
|
enum: -> {
|
1421
1422
|
Orb::PlanCreateParams::Price::TieredBps::BillingCycleConfiguration::DurationUnit
|
@@ -1427,11 +1428,11 @@ module Orb
|
|
1427
1428
|
#
|
1428
1429
|
# @param duration [Integer] The duration of the billing period.
|
1429
1430
|
#
|
1430
|
-
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::TieredBps::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
1431
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::TieredBps::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
1431
1432
|
|
1432
1433
|
# The unit of billing period duration.
|
1433
1434
|
#
|
1434
|
-
# @see Orb::PlanCreateParams::Price::TieredBps::BillingCycleConfiguration#duration_unit
|
1435
|
+
# @see Orb::Models::PlanCreateParams::Price::TieredBps::BillingCycleConfiguration#duration_unit
|
1435
1436
|
module DurationUnit
|
1436
1437
|
extend Orb::Internal::Type::Enum
|
1437
1438
|
|
@@ -1443,7 +1444,7 @@ module Orb
|
|
1443
1444
|
end
|
1444
1445
|
end
|
1445
1446
|
|
1446
|
-
# @see Orb::PlanCreateParams::Price::TieredBps#invoicing_cycle_configuration
|
1447
|
+
# @see Orb::Models::PlanCreateParams::Price::TieredBps#invoicing_cycle_configuration
|
1447
1448
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
1448
1449
|
# @!attribute duration
|
1449
1450
|
# The duration of the billing period.
|
@@ -1454,7 +1455,7 @@ module Orb
|
|
1454
1455
|
# @!attribute duration_unit
|
1455
1456
|
# The unit of billing period duration.
|
1456
1457
|
#
|
1457
|
-
# @return [Symbol, Orb::PlanCreateParams::Price::TieredBps::InvoicingCycleConfiguration::DurationUnit]
|
1458
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::TieredBps::InvoicingCycleConfiguration::DurationUnit]
|
1458
1459
|
required :duration_unit,
|
1459
1460
|
enum: -> {
|
1460
1461
|
Orb::PlanCreateParams::Price::TieredBps::InvoicingCycleConfiguration::DurationUnit
|
@@ -1466,11 +1467,11 @@ module Orb
|
|
1466
1467
|
#
|
1467
1468
|
# @param duration [Integer] The duration of the billing period.
|
1468
1469
|
#
|
1469
|
-
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::TieredBps::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
1470
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::TieredBps::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
1470
1471
|
|
1471
1472
|
# The unit of billing period duration.
|
1472
1473
|
#
|
1473
|
-
# @see Orb::PlanCreateParams::Price::TieredBps::InvoicingCycleConfiguration#duration_unit
|
1474
|
+
# @see Orb::Models::PlanCreateParams::Price::TieredBps::InvoicingCycleConfiguration#duration_unit
|
1474
1475
|
module DurationUnit
|
1475
1476
|
extend Orb::Internal::Type::Enum
|
1476
1477
|
|
@@ -1486,13 +1487,13 @@ module Orb
|
|
1486
1487
|
class Bps < Orb::Internal::Type::BaseModel
|
1487
1488
|
# @!attribute bps_config
|
1488
1489
|
#
|
1489
|
-
# @return [Orb::PlanCreateParams::Price::Bps::BpsConfig]
|
1490
|
+
# @return [Orb::Models::PlanCreateParams::Price::Bps::BpsConfig]
|
1490
1491
|
required :bps_config, -> { Orb::PlanCreateParams::Price::Bps::BpsConfig }
|
1491
1492
|
|
1492
1493
|
# @!attribute cadence
|
1493
1494
|
# The cadence to bill for this price on.
|
1494
1495
|
#
|
1495
|
-
# @return [Symbol, Orb::PlanCreateParams::Price::Bps::Cadence]
|
1496
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::Bps::Cadence]
|
1496
1497
|
required :cadence, enum: -> { Orb::PlanCreateParams::Price::Bps::Cadence }
|
1497
1498
|
|
1498
1499
|
# @!attribute item_id
|
@@ -1530,7 +1531,7 @@ module Orb
|
|
1530
1531
|
# For custom cadence: specifies the duration of the billing period in days or
|
1531
1532
|
# months.
|
1532
1533
|
#
|
1533
|
-
# @return [Orb::PlanCreateParams::Price::Bps::BillingCycleConfiguration, nil]
|
1534
|
+
# @return [Orb::Models::PlanCreateParams::Price::Bps::BillingCycleConfiguration, nil]
|
1534
1535
|
optional :billing_cycle_configuration,
|
1535
1536
|
-> { Orb::PlanCreateParams::Price::Bps::BillingCycleConfiguration },
|
1536
1537
|
nil?: true
|
@@ -1571,7 +1572,7 @@ module Orb
|
|
1571
1572
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
1572
1573
|
# If unspecified, a single invoice is produced per billing cycle.
|
1573
1574
|
#
|
1574
|
-
# @return [Orb::PlanCreateParams::Price::Bps::InvoicingCycleConfiguration, nil]
|
1575
|
+
# @return [Orb::Models::PlanCreateParams::Price::Bps::InvoicingCycleConfiguration, nil]
|
1575
1576
|
optional :invoicing_cycle_configuration,
|
1576
1577
|
-> { Orb::PlanCreateParams::Price::Bps::InvoicingCycleConfiguration },
|
1577
1578
|
nil?: true
|
@@ -1586,11 +1587,11 @@ module Orb
|
|
1586
1587
|
|
1587
1588
|
# @!method initialize(bps_config:, cadence:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :bps)
|
1588
1589
|
# Some parameter documentations has been truncated, see
|
1589
|
-
# {Orb::PlanCreateParams::Price::Bps} for more details.
|
1590
|
+
# {Orb::Models::PlanCreateParams::Price::Bps} for more details.
|
1590
1591
|
#
|
1591
|
-
# @param bps_config [Orb::PlanCreateParams::Price::Bps::BpsConfig]
|
1592
|
+
# @param bps_config [Orb::Models::PlanCreateParams::Price::Bps::BpsConfig]
|
1592
1593
|
#
|
1593
|
-
# @param cadence [Symbol, Orb::PlanCreateParams::Price::Bps::Cadence] The cadence to bill for this price on.
|
1594
|
+
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::Bps::Cadence] The cadence to bill for this price on.
|
1594
1595
|
#
|
1595
1596
|
# @param item_id [String] The id of the item the price will be associated with.
|
1596
1597
|
#
|
@@ -1600,7 +1601,7 @@ module Orb
|
|
1600
1601
|
#
|
1601
1602
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
1602
1603
|
#
|
1603
|
-
# @param billing_cycle_configuration [Orb::PlanCreateParams::Price::Bps::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
1604
|
+
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::Bps::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
1604
1605
|
#
|
1605
1606
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
1606
1607
|
#
|
@@ -1612,13 +1613,13 @@ module Orb
|
|
1612
1613
|
#
|
1613
1614
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
1614
1615
|
#
|
1615
|
-
# @param invoicing_cycle_configuration [Orb::PlanCreateParams::Price::Bps::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
1616
|
+
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::Bps::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
1616
1617
|
#
|
1617
1618
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
1618
1619
|
#
|
1619
1620
|
# @param model_type [Symbol, :bps]
|
1620
1621
|
|
1621
|
-
# @see Orb::PlanCreateParams::Price::Bps#bps_config
|
1622
|
+
# @see Orb::Models::PlanCreateParams::Price::Bps#bps_config
|
1622
1623
|
class BpsConfig < Orb::Internal::Type::BaseModel
|
1623
1624
|
# @!attribute bps
|
1624
1625
|
# Basis point take rate per event
|
@@ -1640,7 +1641,7 @@ module Orb
|
|
1640
1641
|
|
1641
1642
|
# The cadence to bill for this price on.
|
1642
1643
|
#
|
1643
|
-
# @see Orb::PlanCreateParams::Price::Bps#cadence
|
1644
|
+
# @see Orb::Models::PlanCreateParams::Price::Bps#cadence
|
1644
1645
|
module Cadence
|
1645
1646
|
extend Orb::Internal::Type::Enum
|
1646
1647
|
|
@@ -1655,7 +1656,7 @@ module Orb
|
|
1655
1656
|
# @return [Array<Symbol>]
|
1656
1657
|
end
|
1657
1658
|
|
1658
|
-
# @see Orb::PlanCreateParams::Price::Bps#billing_cycle_configuration
|
1659
|
+
# @see Orb::Models::PlanCreateParams::Price::Bps#billing_cycle_configuration
|
1659
1660
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
1660
1661
|
# @!attribute duration
|
1661
1662
|
# The duration of the billing period.
|
@@ -1666,7 +1667,7 @@ module Orb
|
|
1666
1667
|
# @!attribute duration_unit
|
1667
1668
|
# The unit of billing period duration.
|
1668
1669
|
#
|
1669
|
-
# @return [Symbol, Orb::PlanCreateParams::Price::Bps::BillingCycleConfiguration::DurationUnit]
|
1670
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::Bps::BillingCycleConfiguration::DurationUnit]
|
1670
1671
|
required :duration_unit,
|
1671
1672
|
enum: -> { Orb::PlanCreateParams::Price::Bps::BillingCycleConfiguration::DurationUnit }
|
1672
1673
|
|
@@ -1676,11 +1677,11 @@ module Orb
|
|
1676
1677
|
#
|
1677
1678
|
# @param duration [Integer] The duration of the billing period.
|
1678
1679
|
#
|
1679
|
-
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::Bps::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
1680
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::Bps::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
1680
1681
|
|
1681
1682
|
# The unit of billing period duration.
|
1682
1683
|
#
|
1683
|
-
# @see Orb::PlanCreateParams::Price::Bps::BillingCycleConfiguration#duration_unit
|
1684
|
+
# @see Orb::Models::PlanCreateParams::Price::Bps::BillingCycleConfiguration#duration_unit
|
1684
1685
|
module DurationUnit
|
1685
1686
|
extend Orb::Internal::Type::Enum
|
1686
1687
|
|
@@ -1692,7 +1693,7 @@ module Orb
|
|
1692
1693
|
end
|
1693
1694
|
end
|
1694
1695
|
|
1695
|
-
# @see Orb::PlanCreateParams::Price::Bps#invoicing_cycle_configuration
|
1696
|
+
# @see Orb::Models::PlanCreateParams::Price::Bps#invoicing_cycle_configuration
|
1696
1697
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
1697
1698
|
# @!attribute duration
|
1698
1699
|
# The duration of the billing period.
|
@@ -1703,7 +1704,7 @@ module Orb
|
|
1703
1704
|
# @!attribute duration_unit
|
1704
1705
|
# The unit of billing period duration.
|
1705
1706
|
#
|
1706
|
-
# @return [Symbol, Orb::PlanCreateParams::Price::Bps::InvoicingCycleConfiguration::DurationUnit]
|
1707
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::Bps::InvoicingCycleConfiguration::DurationUnit]
|
1707
1708
|
required :duration_unit,
|
1708
1709
|
enum: -> { Orb::PlanCreateParams::Price::Bps::InvoicingCycleConfiguration::DurationUnit }
|
1709
1710
|
|
@@ -1713,11 +1714,11 @@ module Orb
|
|
1713
1714
|
#
|
1714
1715
|
# @param duration [Integer] The duration of the billing period.
|
1715
1716
|
#
|
1716
|
-
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::Bps::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
1717
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::Bps::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
1717
1718
|
|
1718
1719
|
# The unit of billing period duration.
|
1719
1720
|
#
|
1720
|
-
# @see Orb::PlanCreateParams::Price::Bps::InvoicingCycleConfiguration#duration_unit
|
1721
|
+
# @see Orb::Models::PlanCreateParams::Price::Bps::InvoicingCycleConfiguration#duration_unit
|
1721
1722
|
module DurationUnit
|
1722
1723
|
extend Orb::Internal::Type::Enum
|
1723
1724
|
|
@@ -1733,13 +1734,13 @@ module Orb
|
|
1733
1734
|
class BulkBps < Orb::Internal::Type::BaseModel
|
1734
1735
|
# @!attribute bulk_bps_config
|
1735
1736
|
#
|
1736
|
-
# @return [Orb::PlanCreateParams::Price::BulkBps::BulkBpsConfig]
|
1737
|
+
# @return [Orb::Models::PlanCreateParams::Price::BulkBps::BulkBpsConfig]
|
1737
1738
|
required :bulk_bps_config, -> { Orb::PlanCreateParams::Price::BulkBps::BulkBpsConfig }
|
1738
1739
|
|
1739
1740
|
# @!attribute cadence
|
1740
1741
|
# The cadence to bill for this price on.
|
1741
1742
|
#
|
1742
|
-
# @return [Symbol, Orb::PlanCreateParams::Price::BulkBps::Cadence]
|
1743
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::BulkBps::Cadence]
|
1743
1744
|
required :cadence, enum: -> { Orb::PlanCreateParams::Price::BulkBps::Cadence }
|
1744
1745
|
|
1745
1746
|
# @!attribute item_id
|
@@ -1777,7 +1778,7 @@ module Orb
|
|
1777
1778
|
# For custom cadence: specifies the duration of the billing period in days or
|
1778
1779
|
# months.
|
1779
1780
|
#
|
1780
|
-
# @return [Orb::PlanCreateParams::Price::BulkBps::BillingCycleConfiguration, nil]
|
1781
|
+
# @return [Orb::Models::PlanCreateParams::Price::BulkBps::BillingCycleConfiguration, nil]
|
1781
1782
|
optional :billing_cycle_configuration,
|
1782
1783
|
-> { Orb::PlanCreateParams::Price::BulkBps::BillingCycleConfiguration },
|
1783
1784
|
nil?: true
|
@@ -1818,7 +1819,7 @@ module Orb
|
|
1818
1819
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
1819
1820
|
# If unspecified, a single invoice is produced per billing cycle.
|
1820
1821
|
#
|
1821
|
-
# @return [Orb::PlanCreateParams::Price::BulkBps::InvoicingCycleConfiguration, nil]
|
1822
|
+
# @return [Orb::Models::PlanCreateParams::Price::BulkBps::InvoicingCycleConfiguration, nil]
|
1822
1823
|
optional :invoicing_cycle_configuration,
|
1823
1824
|
-> { Orb::PlanCreateParams::Price::BulkBps::InvoicingCycleConfiguration },
|
1824
1825
|
nil?: true
|
@@ -1833,11 +1834,11 @@ module Orb
|
|
1833
1834
|
|
1834
1835
|
# @!method initialize(bulk_bps_config:, cadence:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :bulk_bps)
|
1835
1836
|
# Some parameter documentations has been truncated, see
|
1836
|
-
# {Orb::PlanCreateParams::Price::BulkBps} for more details.
|
1837
|
+
# {Orb::Models::PlanCreateParams::Price::BulkBps} for more details.
|
1837
1838
|
#
|
1838
|
-
# @param bulk_bps_config [Orb::PlanCreateParams::Price::BulkBps::BulkBpsConfig]
|
1839
|
+
# @param bulk_bps_config [Orb::Models::PlanCreateParams::Price::BulkBps::BulkBpsConfig]
|
1839
1840
|
#
|
1840
|
-
# @param cadence [Symbol, Orb::PlanCreateParams::Price::BulkBps::Cadence] The cadence to bill for this price on.
|
1841
|
+
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::BulkBps::Cadence] The cadence to bill for this price on.
|
1841
1842
|
#
|
1842
1843
|
# @param item_id [String] The id of the item the price will be associated with.
|
1843
1844
|
#
|
@@ -1847,7 +1848,7 @@ module Orb
|
|
1847
1848
|
#
|
1848
1849
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
1849
1850
|
#
|
1850
|
-
# @param billing_cycle_configuration [Orb::PlanCreateParams::Price::BulkBps::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
1851
|
+
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::BulkBps::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
1851
1852
|
#
|
1852
1853
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
1853
1854
|
#
|
@@ -1859,19 +1860,19 @@ module Orb
|
|
1859
1860
|
#
|
1860
1861
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
1861
1862
|
#
|
1862
|
-
# @param invoicing_cycle_configuration [Orb::PlanCreateParams::Price::BulkBps::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
1863
|
+
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::BulkBps::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
1863
1864
|
#
|
1864
1865
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
1865
1866
|
#
|
1866
1867
|
# @param model_type [Symbol, :bulk_bps]
|
1867
1868
|
|
1868
|
-
# @see Orb::PlanCreateParams::Price::BulkBps#bulk_bps_config
|
1869
|
+
# @see Orb::Models::PlanCreateParams::Price::BulkBps#bulk_bps_config
|
1869
1870
|
class BulkBpsConfig < Orb::Internal::Type::BaseModel
|
1870
1871
|
# @!attribute tiers
|
1871
1872
|
# Tiers for a bulk BPS pricing model where all usage is aggregated to a single
|
1872
1873
|
# tier based on total volume
|
1873
1874
|
#
|
1874
|
-
# @return [Array<Orb::PlanCreateParams::Price::BulkBps::BulkBpsConfig::Tier>]
|
1875
|
+
# @return [Array<Orb::Models::PlanCreateParams::Price::BulkBps::BulkBpsConfig::Tier>]
|
1875
1876
|
required :tiers,
|
1876
1877
|
-> {
|
1877
1878
|
Orb::Internal::Type::ArrayOf[Orb::PlanCreateParams::Price::BulkBps::BulkBpsConfig::Tier]
|
@@ -1879,9 +1880,9 @@ module Orb
|
|
1879
1880
|
|
1880
1881
|
# @!method initialize(tiers:)
|
1881
1882
|
# Some parameter documentations has been truncated, see
|
1882
|
-
# {Orb::PlanCreateParams::Price::BulkBps::BulkBpsConfig} for more details.
|
1883
|
+
# {Orb::Models::PlanCreateParams::Price::BulkBps::BulkBpsConfig} for more details.
|
1883
1884
|
#
|
1884
|
-
# @param tiers [Array<Orb::PlanCreateParams::Price::BulkBps::BulkBpsConfig::Tier>] Tiers for a bulk BPS pricing model where all usage is aggregated to a single tie
|
1885
|
+
# @param tiers [Array<Orb::Models::PlanCreateParams::Price::BulkBps::BulkBpsConfig::Tier>] Tiers for a bulk BPS pricing model where all usage is aggregated to a single tie
|
1885
1886
|
|
1886
1887
|
class Tier < Orb::Internal::Type::BaseModel
|
1887
1888
|
# @!attribute bps
|
@@ -1913,7 +1914,7 @@ module Orb
|
|
1913
1914
|
|
1914
1915
|
# The cadence to bill for this price on.
|
1915
1916
|
#
|
1916
|
-
# @see Orb::PlanCreateParams::Price::BulkBps#cadence
|
1917
|
+
# @see Orb::Models::PlanCreateParams::Price::BulkBps#cadence
|
1917
1918
|
module Cadence
|
1918
1919
|
extend Orb::Internal::Type::Enum
|
1919
1920
|
|
@@ -1928,7 +1929,7 @@ module Orb
|
|
1928
1929
|
# @return [Array<Symbol>]
|
1929
1930
|
end
|
1930
1931
|
|
1931
|
-
# @see Orb::PlanCreateParams::Price::BulkBps#billing_cycle_configuration
|
1932
|
+
# @see Orb::Models::PlanCreateParams::Price::BulkBps#billing_cycle_configuration
|
1932
1933
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
1933
1934
|
# @!attribute duration
|
1934
1935
|
# The duration of the billing period.
|
@@ -1939,7 +1940,7 @@ module Orb
|
|
1939
1940
|
# @!attribute duration_unit
|
1940
1941
|
# The unit of billing period duration.
|
1941
1942
|
#
|
1942
|
-
# @return [Symbol, Orb::PlanCreateParams::Price::BulkBps::BillingCycleConfiguration::DurationUnit]
|
1943
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::BulkBps::BillingCycleConfiguration::DurationUnit]
|
1943
1944
|
required :duration_unit,
|
1944
1945
|
enum: -> {
|
1945
1946
|
Orb::PlanCreateParams::Price::BulkBps::BillingCycleConfiguration::DurationUnit
|
@@ -1951,11 +1952,11 @@ module Orb
|
|
1951
1952
|
#
|
1952
1953
|
# @param duration [Integer] The duration of the billing period.
|
1953
1954
|
#
|
1954
|
-
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::BulkBps::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
1955
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::BulkBps::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
1955
1956
|
|
1956
1957
|
# The unit of billing period duration.
|
1957
1958
|
#
|
1958
|
-
# @see Orb::PlanCreateParams::Price::BulkBps::BillingCycleConfiguration#duration_unit
|
1959
|
+
# @see Orb::Models::PlanCreateParams::Price::BulkBps::BillingCycleConfiguration#duration_unit
|
1959
1960
|
module DurationUnit
|
1960
1961
|
extend Orb::Internal::Type::Enum
|
1961
1962
|
|
@@ -1967,7 +1968,7 @@ module Orb
|
|
1967
1968
|
end
|
1968
1969
|
end
|
1969
1970
|
|
1970
|
-
# @see Orb::PlanCreateParams::Price::BulkBps#invoicing_cycle_configuration
|
1971
|
+
# @see Orb::Models::PlanCreateParams::Price::BulkBps#invoicing_cycle_configuration
|
1971
1972
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
1972
1973
|
# @!attribute duration
|
1973
1974
|
# The duration of the billing period.
|
@@ -1978,7 +1979,7 @@ module Orb
|
|
1978
1979
|
# @!attribute duration_unit
|
1979
1980
|
# The unit of billing period duration.
|
1980
1981
|
#
|
1981
|
-
# @return [Symbol, Orb::PlanCreateParams::Price::BulkBps::InvoicingCycleConfiguration::DurationUnit]
|
1982
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::BulkBps::InvoicingCycleConfiguration::DurationUnit]
|
1982
1983
|
required :duration_unit,
|
1983
1984
|
enum: -> {
|
1984
1985
|
Orb::PlanCreateParams::Price::BulkBps::InvoicingCycleConfiguration::DurationUnit
|
@@ -1990,11 +1991,11 @@ module Orb
|
|
1990
1991
|
#
|
1991
1992
|
# @param duration [Integer] The duration of the billing period.
|
1992
1993
|
#
|
1993
|
-
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::BulkBps::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
1994
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::BulkBps::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
1994
1995
|
|
1995
1996
|
# The unit of billing period duration.
|
1996
1997
|
#
|
1997
|
-
# @see Orb::PlanCreateParams::Price::BulkBps::InvoicingCycleConfiguration#duration_unit
|
1998
|
+
# @see Orb::Models::PlanCreateParams::Price::BulkBps::InvoicingCycleConfiguration#duration_unit
|
1998
1999
|
module DurationUnit
|
1999
2000
|
extend Orb::Internal::Type::Enum
|
2000
2001
|
|
@@ -2010,13 +2011,13 @@ module Orb
|
|
2010
2011
|
class Bulk < Orb::Internal::Type::BaseModel
|
2011
2012
|
# @!attribute bulk_config
|
2012
2013
|
#
|
2013
|
-
# @return [Orb::PlanCreateParams::Price::Bulk::BulkConfig]
|
2014
|
+
# @return [Orb::Models::PlanCreateParams::Price::Bulk::BulkConfig]
|
2014
2015
|
required :bulk_config, -> { Orb::PlanCreateParams::Price::Bulk::BulkConfig }
|
2015
2016
|
|
2016
2017
|
# @!attribute cadence
|
2017
2018
|
# The cadence to bill for this price on.
|
2018
2019
|
#
|
2019
|
-
# @return [Symbol, Orb::PlanCreateParams::Price::Bulk::Cadence]
|
2020
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::Bulk::Cadence]
|
2020
2021
|
required :cadence, enum: -> { Orb::PlanCreateParams::Price::Bulk::Cadence }
|
2021
2022
|
|
2022
2023
|
# @!attribute item_id
|
@@ -2054,7 +2055,7 @@ module Orb
|
|
2054
2055
|
# For custom cadence: specifies the duration of the billing period in days or
|
2055
2056
|
# months.
|
2056
2057
|
#
|
2057
|
-
# @return [Orb::PlanCreateParams::Price::Bulk::BillingCycleConfiguration, nil]
|
2058
|
+
# @return [Orb::Models::PlanCreateParams::Price::Bulk::BillingCycleConfiguration, nil]
|
2058
2059
|
optional :billing_cycle_configuration,
|
2059
2060
|
-> { Orb::PlanCreateParams::Price::Bulk::BillingCycleConfiguration },
|
2060
2061
|
nil?: true
|
@@ -2095,7 +2096,7 @@ module Orb
|
|
2095
2096
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
2096
2097
|
# If unspecified, a single invoice is produced per billing cycle.
|
2097
2098
|
#
|
2098
|
-
# @return [Orb::PlanCreateParams::Price::Bulk::InvoicingCycleConfiguration, nil]
|
2099
|
+
# @return [Orb::Models::PlanCreateParams::Price::Bulk::InvoicingCycleConfiguration, nil]
|
2099
2100
|
optional :invoicing_cycle_configuration,
|
2100
2101
|
-> { Orb::PlanCreateParams::Price::Bulk::InvoicingCycleConfiguration },
|
2101
2102
|
nil?: true
|
@@ -2110,11 +2111,11 @@ module Orb
|
|
2110
2111
|
|
2111
2112
|
# @!method initialize(bulk_config:, cadence:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :bulk)
|
2112
2113
|
# Some parameter documentations has been truncated, see
|
2113
|
-
# {Orb::PlanCreateParams::Price::Bulk} for more details.
|
2114
|
+
# {Orb::Models::PlanCreateParams::Price::Bulk} for more details.
|
2114
2115
|
#
|
2115
|
-
# @param bulk_config [Orb::PlanCreateParams::Price::Bulk::BulkConfig]
|
2116
|
+
# @param bulk_config [Orb::Models::PlanCreateParams::Price::Bulk::BulkConfig]
|
2116
2117
|
#
|
2117
|
-
# @param cadence [Symbol, Orb::PlanCreateParams::Price::Bulk::Cadence] The cadence to bill for this price on.
|
2118
|
+
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::Bulk::Cadence] The cadence to bill for this price on.
|
2118
2119
|
#
|
2119
2120
|
# @param item_id [String] The id of the item the price will be associated with.
|
2120
2121
|
#
|
@@ -2124,7 +2125,7 @@ module Orb
|
|
2124
2125
|
#
|
2125
2126
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
2126
2127
|
#
|
2127
|
-
# @param billing_cycle_configuration [Orb::PlanCreateParams::Price::Bulk::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
2128
|
+
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::Bulk::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
2128
2129
|
#
|
2129
2130
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
2130
2131
|
#
|
@@ -2136,25 +2137,25 @@ module Orb
|
|
2136
2137
|
#
|
2137
2138
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
2138
2139
|
#
|
2139
|
-
# @param invoicing_cycle_configuration [Orb::PlanCreateParams::Price::Bulk::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
2140
|
+
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::Bulk::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
2140
2141
|
#
|
2141
2142
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
2142
2143
|
#
|
2143
2144
|
# @param model_type [Symbol, :bulk]
|
2144
2145
|
|
2145
|
-
# @see Orb::PlanCreateParams::Price::Bulk#bulk_config
|
2146
|
+
# @see Orb::Models::PlanCreateParams::Price::Bulk#bulk_config
|
2146
2147
|
class BulkConfig < Orb::Internal::Type::BaseModel
|
2147
2148
|
# @!attribute tiers
|
2148
2149
|
# Bulk tiers for rating based on total usage volume
|
2149
2150
|
#
|
2150
|
-
# @return [Array<Orb::PlanCreateParams::Price::Bulk::BulkConfig::Tier>]
|
2151
|
+
# @return [Array<Orb::Models::PlanCreateParams::Price::Bulk::BulkConfig::Tier>]
|
2151
2152
|
required :tiers,
|
2152
2153
|
-> {
|
2153
2154
|
Orb::Internal::Type::ArrayOf[Orb::PlanCreateParams::Price::Bulk::BulkConfig::Tier]
|
2154
2155
|
}
|
2155
2156
|
|
2156
2157
|
# @!method initialize(tiers:)
|
2157
|
-
# @param tiers [Array<Orb::PlanCreateParams::Price::Bulk::BulkConfig::Tier>] Bulk tiers for rating based on total usage volume
|
2158
|
+
# @param tiers [Array<Orb::Models::PlanCreateParams::Price::Bulk::BulkConfig::Tier>] Bulk tiers for rating based on total usage volume
|
2158
2159
|
|
2159
2160
|
class Tier < Orb::Internal::Type::BaseModel
|
2160
2161
|
# @!attribute unit_amount
|
@@ -2178,7 +2179,7 @@ module Orb
|
|
2178
2179
|
|
2179
2180
|
# The cadence to bill for this price on.
|
2180
2181
|
#
|
2181
|
-
# @see Orb::PlanCreateParams::Price::Bulk#cadence
|
2182
|
+
# @see Orb::Models::PlanCreateParams::Price::Bulk#cadence
|
2182
2183
|
module Cadence
|
2183
2184
|
extend Orb::Internal::Type::Enum
|
2184
2185
|
|
@@ -2193,7 +2194,7 @@ module Orb
|
|
2193
2194
|
# @return [Array<Symbol>]
|
2194
2195
|
end
|
2195
2196
|
|
2196
|
-
# @see Orb::PlanCreateParams::Price::Bulk#billing_cycle_configuration
|
2197
|
+
# @see Orb::Models::PlanCreateParams::Price::Bulk#billing_cycle_configuration
|
2197
2198
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
2198
2199
|
# @!attribute duration
|
2199
2200
|
# The duration of the billing period.
|
@@ -2204,7 +2205,7 @@ module Orb
|
|
2204
2205
|
# @!attribute duration_unit
|
2205
2206
|
# The unit of billing period duration.
|
2206
2207
|
#
|
2207
|
-
# @return [Symbol, Orb::PlanCreateParams::Price::Bulk::BillingCycleConfiguration::DurationUnit]
|
2208
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::Bulk::BillingCycleConfiguration::DurationUnit]
|
2208
2209
|
required :duration_unit,
|
2209
2210
|
enum: -> { Orb::PlanCreateParams::Price::Bulk::BillingCycleConfiguration::DurationUnit }
|
2210
2211
|
|
@@ -2214,11 +2215,11 @@ module Orb
|
|
2214
2215
|
#
|
2215
2216
|
# @param duration [Integer] The duration of the billing period.
|
2216
2217
|
#
|
2217
|
-
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::Bulk::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
2218
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::Bulk::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
2218
2219
|
|
2219
2220
|
# The unit of billing period duration.
|
2220
2221
|
#
|
2221
|
-
# @see Orb::PlanCreateParams::Price::Bulk::BillingCycleConfiguration#duration_unit
|
2222
|
+
# @see Orb::Models::PlanCreateParams::Price::Bulk::BillingCycleConfiguration#duration_unit
|
2222
2223
|
module DurationUnit
|
2223
2224
|
extend Orb::Internal::Type::Enum
|
2224
2225
|
|
@@ -2230,7 +2231,7 @@ module Orb
|
|
2230
2231
|
end
|
2231
2232
|
end
|
2232
2233
|
|
2233
|
-
# @see Orb::PlanCreateParams::Price::Bulk#invoicing_cycle_configuration
|
2234
|
+
# @see Orb::Models::PlanCreateParams::Price::Bulk#invoicing_cycle_configuration
|
2234
2235
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
2235
2236
|
# @!attribute duration
|
2236
2237
|
# The duration of the billing period.
|
@@ -2241,7 +2242,7 @@ module Orb
|
|
2241
2242
|
# @!attribute duration_unit
|
2242
2243
|
# The unit of billing period duration.
|
2243
2244
|
#
|
2244
|
-
# @return [Symbol, Orb::PlanCreateParams::Price::Bulk::InvoicingCycleConfiguration::DurationUnit]
|
2245
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::Bulk::InvoicingCycleConfiguration::DurationUnit]
|
2245
2246
|
required :duration_unit,
|
2246
2247
|
enum: -> {
|
2247
2248
|
Orb::PlanCreateParams::Price::Bulk::InvoicingCycleConfiguration::DurationUnit
|
@@ -2253,11 +2254,11 @@ module Orb
|
|
2253
2254
|
#
|
2254
2255
|
# @param duration [Integer] The duration of the billing period.
|
2255
2256
|
#
|
2256
|
-
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::Bulk::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
2257
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::Bulk::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
2257
2258
|
|
2258
2259
|
# The unit of billing period duration.
|
2259
2260
|
#
|
2260
|
-
# @see Orb::PlanCreateParams::Price::Bulk::InvoicingCycleConfiguration#duration_unit
|
2261
|
+
# @see Orb::Models::PlanCreateParams::Price::Bulk::InvoicingCycleConfiguration#duration_unit
|
2261
2262
|
module DurationUnit
|
2262
2263
|
extend Orb::Internal::Type::Enum
|
2263
2264
|
|
@@ -2274,7 +2275,7 @@ module Orb
|
|
2274
2275
|
# @!attribute cadence
|
2275
2276
|
# The cadence to bill for this price on.
|
2276
2277
|
#
|
2277
|
-
# @return [Symbol, Orb::PlanCreateParams::Price::ThresholdTotalAmount::Cadence]
|
2278
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::ThresholdTotalAmount::Cadence]
|
2278
2279
|
required :cadence, enum: -> { Orb::PlanCreateParams::Price::ThresholdTotalAmount::Cadence }
|
2279
2280
|
|
2280
2281
|
# @!attribute item_id
|
@@ -2317,7 +2318,7 @@ module Orb
|
|
2317
2318
|
# For custom cadence: specifies the duration of the billing period in days or
|
2318
2319
|
# months.
|
2319
2320
|
#
|
2320
|
-
# @return [Orb::PlanCreateParams::Price::ThresholdTotalAmount::BillingCycleConfiguration, nil]
|
2321
|
+
# @return [Orb::Models::PlanCreateParams::Price::ThresholdTotalAmount::BillingCycleConfiguration, nil]
|
2321
2322
|
optional :billing_cycle_configuration,
|
2322
2323
|
-> { Orb::PlanCreateParams::Price::ThresholdTotalAmount::BillingCycleConfiguration },
|
2323
2324
|
nil?: true
|
@@ -2358,7 +2359,7 @@ module Orb
|
|
2358
2359
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
2359
2360
|
# If unspecified, a single invoice is produced per billing cycle.
|
2360
2361
|
#
|
2361
|
-
# @return [Orb::PlanCreateParams::Price::ThresholdTotalAmount::InvoicingCycleConfiguration, nil]
|
2362
|
+
# @return [Orb::Models::PlanCreateParams::Price::ThresholdTotalAmount::InvoicingCycleConfiguration, nil]
|
2362
2363
|
optional :invoicing_cycle_configuration,
|
2363
2364
|
-> { Orb::PlanCreateParams::Price::ThresholdTotalAmount::InvoicingCycleConfiguration },
|
2364
2365
|
nil?: true
|
@@ -2373,9 +2374,9 @@ module Orb
|
|
2373
2374
|
|
2374
2375
|
# @!method initialize(cadence:, item_id:, name:, threshold_total_amount_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :threshold_total_amount)
|
2375
2376
|
# Some parameter documentations has been truncated, see
|
2376
|
-
# {Orb::PlanCreateParams::Price::ThresholdTotalAmount} for more details.
|
2377
|
+
# {Orb::Models::PlanCreateParams::Price::ThresholdTotalAmount} for more details.
|
2377
2378
|
#
|
2378
|
-
# @param cadence [Symbol, Orb::PlanCreateParams::Price::ThresholdTotalAmount::Cadence] The cadence to bill for this price on.
|
2379
|
+
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::ThresholdTotalAmount::Cadence] The cadence to bill for this price on.
|
2379
2380
|
#
|
2380
2381
|
# @param item_id [String] The id of the item the price will be associated with.
|
2381
2382
|
#
|
@@ -2387,7 +2388,7 @@ module Orb
|
|
2387
2388
|
#
|
2388
2389
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
2389
2390
|
#
|
2390
|
-
# @param billing_cycle_configuration [Orb::PlanCreateParams::Price::ThresholdTotalAmount::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
2391
|
+
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::ThresholdTotalAmount::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
2391
2392
|
#
|
2392
2393
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
2393
2394
|
#
|
@@ -2399,7 +2400,7 @@ module Orb
|
|
2399
2400
|
#
|
2400
2401
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
2401
2402
|
#
|
2402
|
-
# @param invoicing_cycle_configuration [Orb::PlanCreateParams::Price::ThresholdTotalAmount::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
2403
|
+
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::ThresholdTotalAmount::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
2403
2404
|
#
|
2404
2405
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
2405
2406
|
#
|
@@ -2407,7 +2408,7 @@ module Orb
|
|
2407
2408
|
|
2408
2409
|
# The cadence to bill for this price on.
|
2409
2410
|
#
|
2410
|
-
# @see Orb::PlanCreateParams::Price::ThresholdTotalAmount#cadence
|
2411
|
+
# @see Orb::Models::PlanCreateParams::Price::ThresholdTotalAmount#cadence
|
2411
2412
|
module Cadence
|
2412
2413
|
extend Orb::Internal::Type::Enum
|
2413
2414
|
|
@@ -2422,7 +2423,7 @@ module Orb
|
|
2422
2423
|
# @return [Array<Symbol>]
|
2423
2424
|
end
|
2424
2425
|
|
2425
|
-
# @see Orb::PlanCreateParams::Price::ThresholdTotalAmount#billing_cycle_configuration
|
2426
|
+
# @see Orb::Models::PlanCreateParams::Price::ThresholdTotalAmount#billing_cycle_configuration
|
2426
2427
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
2427
2428
|
# @!attribute duration
|
2428
2429
|
# The duration of the billing period.
|
@@ -2433,7 +2434,7 @@ module Orb
|
|
2433
2434
|
# @!attribute duration_unit
|
2434
2435
|
# The unit of billing period duration.
|
2435
2436
|
#
|
2436
|
-
# @return [Symbol, Orb::PlanCreateParams::Price::ThresholdTotalAmount::BillingCycleConfiguration::DurationUnit]
|
2437
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::ThresholdTotalAmount::BillingCycleConfiguration::DurationUnit]
|
2437
2438
|
required :duration_unit,
|
2438
2439
|
enum: -> {
|
2439
2440
|
Orb::PlanCreateParams::Price::ThresholdTotalAmount::BillingCycleConfiguration::DurationUnit
|
@@ -2445,11 +2446,11 @@ module Orb
|
|
2445
2446
|
#
|
2446
2447
|
# @param duration [Integer] The duration of the billing period.
|
2447
2448
|
#
|
2448
|
-
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::ThresholdTotalAmount::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
2449
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::ThresholdTotalAmount::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
2449
2450
|
|
2450
2451
|
# The unit of billing period duration.
|
2451
2452
|
#
|
2452
|
-
# @see Orb::PlanCreateParams::Price::ThresholdTotalAmount::BillingCycleConfiguration#duration_unit
|
2453
|
+
# @see Orb::Models::PlanCreateParams::Price::ThresholdTotalAmount::BillingCycleConfiguration#duration_unit
|
2453
2454
|
module DurationUnit
|
2454
2455
|
extend Orb::Internal::Type::Enum
|
2455
2456
|
|
@@ -2461,7 +2462,7 @@ module Orb
|
|
2461
2462
|
end
|
2462
2463
|
end
|
2463
2464
|
|
2464
|
-
# @see Orb::PlanCreateParams::Price::ThresholdTotalAmount#invoicing_cycle_configuration
|
2465
|
+
# @see Orb::Models::PlanCreateParams::Price::ThresholdTotalAmount#invoicing_cycle_configuration
|
2465
2466
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
2466
2467
|
# @!attribute duration
|
2467
2468
|
# The duration of the billing period.
|
@@ -2472,7 +2473,7 @@ module Orb
|
|
2472
2473
|
# @!attribute duration_unit
|
2473
2474
|
# The unit of billing period duration.
|
2474
2475
|
#
|
2475
|
-
# @return [Symbol, Orb::PlanCreateParams::Price::ThresholdTotalAmount::InvoicingCycleConfiguration::DurationUnit]
|
2476
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::ThresholdTotalAmount::InvoicingCycleConfiguration::DurationUnit]
|
2476
2477
|
required :duration_unit,
|
2477
2478
|
enum: -> {
|
2478
2479
|
Orb::PlanCreateParams::Price::ThresholdTotalAmount::InvoicingCycleConfiguration::DurationUnit
|
@@ -2484,11 +2485,11 @@ module Orb
|
|
2484
2485
|
#
|
2485
2486
|
# @param duration [Integer] The duration of the billing period.
|
2486
2487
|
#
|
2487
|
-
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::ThresholdTotalAmount::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
2488
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::ThresholdTotalAmount::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
2488
2489
|
|
2489
2490
|
# The unit of billing period duration.
|
2490
2491
|
#
|
2491
|
-
# @see Orb::PlanCreateParams::Price::ThresholdTotalAmount::InvoicingCycleConfiguration#duration_unit
|
2492
|
+
# @see Orb::Models::PlanCreateParams::Price::ThresholdTotalAmount::InvoicingCycleConfiguration#duration_unit
|
2492
2493
|
module DurationUnit
|
2493
2494
|
extend Orb::Internal::Type::Enum
|
2494
2495
|
|
@@ -2505,7 +2506,7 @@ module Orb
|
|
2505
2506
|
# @!attribute cadence
|
2506
2507
|
# The cadence to bill for this price on.
|
2507
2508
|
#
|
2508
|
-
# @return [Symbol, Orb::PlanCreateParams::Price::TieredPackage::Cadence]
|
2509
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::TieredPackage::Cadence]
|
2509
2510
|
required :cadence, enum: -> { Orb::PlanCreateParams::Price::TieredPackage::Cadence }
|
2510
2511
|
|
2511
2512
|
# @!attribute item_id
|
@@ -2548,7 +2549,7 @@ module Orb
|
|
2548
2549
|
# For custom cadence: specifies the duration of the billing period in days or
|
2549
2550
|
# months.
|
2550
2551
|
#
|
2551
|
-
# @return [Orb::PlanCreateParams::Price::TieredPackage::BillingCycleConfiguration, nil]
|
2552
|
+
# @return [Orb::Models::PlanCreateParams::Price::TieredPackage::BillingCycleConfiguration, nil]
|
2552
2553
|
optional :billing_cycle_configuration,
|
2553
2554
|
-> { Orb::PlanCreateParams::Price::TieredPackage::BillingCycleConfiguration },
|
2554
2555
|
nil?: true
|
@@ -2589,7 +2590,7 @@ module Orb
|
|
2589
2590
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
2590
2591
|
# If unspecified, a single invoice is produced per billing cycle.
|
2591
2592
|
#
|
2592
|
-
# @return [Orb::PlanCreateParams::Price::TieredPackage::InvoicingCycleConfiguration, nil]
|
2593
|
+
# @return [Orb::Models::PlanCreateParams::Price::TieredPackage::InvoicingCycleConfiguration, nil]
|
2593
2594
|
optional :invoicing_cycle_configuration,
|
2594
2595
|
-> { Orb::PlanCreateParams::Price::TieredPackage::InvoicingCycleConfiguration },
|
2595
2596
|
nil?: true
|
@@ -2604,9 +2605,9 @@ module Orb
|
|
2604
2605
|
|
2605
2606
|
# @!method initialize(cadence:, item_id:, name:, tiered_package_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :tiered_package)
|
2606
2607
|
# Some parameter documentations has been truncated, see
|
2607
|
-
# {Orb::PlanCreateParams::Price::TieredPackage} for more details.
|
2608
|
+
# {Orb::Models::PlanCreateParams::Price::TieredPackage} for more details.
|
2608
2609
|
#
|
2609
|
-
# @param cadence [Symbol, Orb::PlanCreateParams::Price::TieredPackage::Cadence] The cadence to bill for this price on.
|
2610
|
+
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::TieredPackage::Cadence] The cadence to bill for this price on.
|
2610
2611
|
#
|
2611
2612
|
# @param item_id [String] The id of the item the price will be associated with.
|
2612
2613
|
#
|
@@ -2618,7 +2619,7 @@ module Orb
|
|
2618
2619
|
#
|
2619
2620
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
2620
2621
|
#
|
2621
|
-
# @param billing_cycle_configuration [Orb::PlanCreateParams::Price::TieredPackage::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
2622
|
+
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::TieredPackage::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
2622
2623
|
#
|
2623
2624
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
2624
2625
|
#
|
@@ -2630,7 +2631,7 @@ module Orb
|
|
2630
2631
|
#
|
2631
2632
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
2632
2633
|
#
|
2633
|
-
# @param invoicing_cycle_configuration [Orb::PlanCreateParams::Price::TieredPackage::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
2634
|
+
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::TieredPackage::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
2634
2635
|
#
|
2635
2636
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
2636
2637
|
#
|
@@ -2638,7 +2639,7 @@ module Orb
|
|
2638
2639
|
|
2639
2640
|
# The cadence to bill for this price on.
|
2640
2641
|
#
|
2641
|
-
# @see Orb::PlanCreateParams::Price::TieredPackage#cadence
|
2642
|
+
# @see Orb::Models::PlanCreateParams::Price::TieredPackage#cadence
|
2642
2643
|
module Cadence
|
2643
2644
|
extend Orb::Internal::Type::Enum
|
2644
2645
|
|
@@ -2653,7 +2654,7 @@ module Orb
|
|
2653
2654
|
# @return [Array<Symbol>]
|
2654
2655
|
end
|
2655
2656
|
|
2656
|
-
# @see Orb::PlanCreateParams::Price::TieredPackage#billing_cycle_configuration
|
2657
|
+
# @see Orb::Models::PlanCreateParams::Price::TieredPackage#billing_cycle_configuration
|
2657
2658
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
2658
2659
|
# @!attribute duration
|
2659
2660
|
# The duration of the billing period.
|
@@ -2664,7 +2665,7 @@ module Orb
|
|
2664
2665
|
# @!attribute duration_unit
|
2665
2666
|
# The unit of billing period duration.
|
2666
2667
|
#
|
2667
|
-
# @return [Symbol, Orb::PlanCreateParams::Price::TieredPackage::BillingCycleConfiguration::DurationUnit]
|
2668
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::TieredPackage::BillingCycleConfiguration::DurationUnit]
|
2668
2669
|
required :duration_unit,
|
2669
2670
|
enum: -> {
|
2670
2671
|
Orb::PlanCreateParams::Price::TieredPackage::BillingCycleConfiguration::DurationUnit
|
@@ -2676,11 +2677,11 @@ module Orb
|
|
2676
2677
|
#
|
2677
2678
|
# @param duration [Integer] The duration of the billing period.
|
2678
2679
|
#
|
2679
|
-
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::TieredPackage::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
2680
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::TieredPackage::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
2680
2681
|
|
2681
2682
|
# The unit of billing period duration.
|
2682
2683
|
#
|
2683
|
-
# @see Orb::PlanCreateParams::Price::TieredPackage::BillingCycleConfiguration#duration_unit
|
2684
|
+
# @see Orb::Models::PlanCreateParams::Price::TieredPackage::BillingCycleConfiguration#duration_unit
|
2684
2685
|
module DurationUnit
|
2685
2686
|
extend Orb::Internal::Type::Enum
|
2686
2687
|
|
@@ -2692,7 +2693,7 @@ module Orb
|
|
2692
2693
|
end
|
2693
2694
|
end
|
2694
2695
|
|
2695
|
-
# @see Orb::PlanCreateParams::Price::TieredPackage#invoicing_cycle_configuration
|
2696
|
+
# @see Orb::Models::PlanCreateParams::Price::TieredPackage#invoicing_cycle_configuration
|
2696
2697
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
2697
2698
|
# @!attribute duration
|
2698
2699
|
# The duration of the billing period.
|
@@ -2703,7 +2704,7 @@ module Orb
|
|
2703
2704
|
# @!attribute duration_unit
|
2704
2705
|
# The unit of billing period duration.
|
2705
2706
|
#
|
2706
|
-
# @return [Symbol, Orb::PlanCreateParams::Price::TieredPackage::InvoicingCycleConfiguration::DurationUnit]
|
2707
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::TieredPackage::InvoicingCycleConfiguration::DurationUnit]
|
2707
2708
|
required :duration_unit,
|
2708
2709
|
enum: -> {
|
2709
2710
|
Orb::PlanCreateParams::Price::TieredPackage::InvoicingCycleConfiguration::DurationUnit
|
@@ -2715,11 +2716,11 @@ module Orb
|
|
2715
2716
|
#
|
2716
2717
|
# @param duration [Integer] The duration of the billing period.
|
2717
2718
|
#
|
2718
|
-
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::TieredPackage::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
2719
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::TieredPackage::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
2719
2720
|
|
2720
2721
|
# The unit of billing period duration.
|
2721
2722
|
#
|
2722
|
-
# @see Orb::PlanCreateParams::Price::TieredPackage::InvoicingCycleConfiguration#duration_unit
|
2723
|
+
# @see Orb::Models::PlanCreateParams::Price::TieredPackage::InvoicingCycleConfiguration#duration_unit
|
2723
2724
|
module DurationUnit
|
2724
2725
|
extend Orb::Internal::Type::Enum
|
2725
2726
|
|
@@ -2736,7 +2737,7 @@ module Orb
|
|
2736
2737
|
# @!attribute cadence
|
2737
2738
|
# The cadence to bill for this price on.
|
2738
2739
|
#
|
2739
|
-
# @return [Symbol, Orb::PlanCreateParams::Price::TieredWithMinimum::Cadence]
|
2740
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::TieredWithMinimum::Cadence]
|
2740
2741
|
required :cadence, enum: -> { Orb::PlanCreateParams::Price::TieredWithMinimum::Cadence }
|
2741
2742
|
|
2742
2743
|
# @!attribute item_id
|
@@ -2779,7 +2780,7 @@ module Orb
|
|
2779
2780
|
# For custom cadence: specifies the duration of the billing period in days or
|
2780
2781
|
# months.
|
2781
2782
|
#
|
2782
|
-
# @return [Orb::PlanCreateParams::Price::TieredWithMinimum::BillingCycleConfiguration, nil]
|
2783
|
+
# @return [Orb::Models::PlanCreateParams::Price::TieredWithMinimum::BillingCycleConfiguration, nil]
|
2783
2784
|
optional :billing_cycle_configuration,
|
2784
2785
|
-> { Orb::PlanCreateParams::Price::TieredWithMinimum::BillingCycleConfiguration },
|
2785
2786
|
nil?: true
|
@@ -2820,7 +2821,7 @@ module Orb
|
|
2820
2821
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
2821
2822
|
# If unspecified, a single invoice is produced per billing cycle.
|
2822
2823
|
#
|
2823
|
-
# @return [Orb::PlanCreateParams::Price::TieredWithMinimum::InvoicingCycleConfiguration, nil]
|
2824
|
+
# @return [Orb::Models::PlanCreateParams::Price::TieredWithMinimum::InvoicingCycleConfiguration, nil]
|
2824
2825
|
optional :invoicing_cycle_configuration,
|
2825
2826
|
-> { Orb::PlanCreateParams::Price::TieredWithMinimum::InvoicingCycleConfiguration },
|
2826
2827
|
nil?: true
|
@@ -2835,9 +2836,9 @@ module Orb
|
|
2835
2836
|
|
2836
2837
|
# @!method initialize(cadence:, item_id:, name:, tiered_with_minimum_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :tiered_with_minimum)
|
2837
2838
|
# Some parameter documentations has been truncated, see
|
2838
|
-
# {Orb::PlanCreateParams::Price::TieredWithMinimum} for more details.
|
2839
|
+
# {Orb::Models::PlanCreateParams::Price::TieredWithMinimum} for more details.
|
2839
2840
|
#
|
2840
|
-
# @param cadence [Symbol, Orb::PlanCreateParams::Price::TieredWithMinimum::Cadence] The cadence to bill for this price on.
|
2841
|
+
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::TieredWithMinimum::Cadence] The cadence to bill for this price on.
|
2841
2842
|
#
|
2842
2843
|
# @param item_id [String] The id of the item the price will be associated with.
|
2843
2844
|
#
|
@@ -2849,7 +2850,7 @@ module Orb
|
|
2849
2850
|
#
|
2850
2851
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
2851
2852
|
#
|
2852
|
-
# @param billing_cycle_configuration [Orb::PlanCreateParams::Price::TieredWithMinimum::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
2853
|
+
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::TieredWithMinimum::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
2853
2854
|
#
|
2854
2855
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
2855
2856
|
#
|
@@ -2861,7 +2862,7 @@ module Orb
|
|
2861
2862
|
#
|
2862
2863
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
2863
2864
|
#
|
2864
|
-
# @param invoicing_cycle_configuration [Orb::PlanCreateParams::Price::TieredWithMinimum::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
2865
|
+
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::TieredWithMinimum::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
2865
2866
|
#
|
2866
2867
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
2867
2868
|
#
|
@@ -2869,7 +2870,7 @@ module Orb
|
|
2869
2870
|
|
2870
2871
|
# The cadence to bill for this price on.
|
2871
2872
|
#
|
2872
|
-
# @see Orb::PlanCreateParams::Price::TieredWithMinimum#cadence
|
2873
|
+
# @see Orb::Models::PlanCreateParams::Price::TieredWithMinimum#cadence
|
2873
2874
|
module Cadence
|
2874
2875
|
extend Orb::Internal::Type::Enum
|
2875
2876
|
|
@@ -2884,7 +2885,7 @@ module Orb
|
|
2884
2885
|
# @return [Array<Symbol>]
|
2885
2886
|
end
|
2886
2887
|
|
2887
|
-
# @see Orb::PlanCreateParams::Price::TieredWithMinimum#billing_cycle_configuration
|
2888
|
+
# @see Orb::Models::PlanCreateParams::Price::TieredWithMinimum#billing_cycle_configuration
|
2888
2889
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
2889
2890
|
# @!attribute duration
|
2890
2891
|
# The duration of the billing period.
|
@@ -2895,7 +2896,7 @@ module Orb
|
|
2895
2896
|
# @!attribute duration_unit
|
2896
2897
|
# The unit of billing period duration.
|
2897
2898
|
#
|
2898
|
-
# @return [Symbol, Orb::PlanCreateParams::Price::TieredWithMinimum::BillingCycleConfiguration::DurationUnit]
|
2899
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::TieredWithMinimum::BillingCycleConfiguration::DurationUnit]
|
2899
2900
|
required :duration_unit,
|
2900
2901
|
enum: -> {
|
2901
2902
|
Orb::PlanCreateParams::Price::TieredWithMinimum::BillingCycleConfiguration::DurationUnit
|
@@ -2907,11 +2908,11 @@ module Orb
|
|
2907
2908
|
#
|
2908
2909
|
# @param duration [Integer] The duration of the billing period.
|
2909
2910
|
#
|
2910
|
-
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::TieredWithMinimum::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
2911
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::TieredWithMinimum::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
2911
2912
|
|
2912
2913
|
# The unit of billing period duration.
|
2913
2914
|
#
|
2914
|
-
# @see Orb::PlanCreateParams::Price::TieredWithMinimum::BillingCycleConfiguration#duration_unit
|
2915
|
+
# @see Orb::Models::PlanCreateParams::Price::TieredWithMinimum::BillingCycleConfiguration#duration_unit
|
2915
2916
|
module DurationUnit
|
2916
2917
|
extend Orb::Internal::Type::Enum
|
2917
2918
|
|
@@ -2923,7 +2924,7 @@ module Orb
|
|
2923
2924
|
end
|
2924
2925
|
end
|
2925
2926
|
|
2926
|
-
# @see Orb::PlanCreateParams::Price::TieredWithMinimum#invoicing_cycle_configuration
|
2927
|
+
# @see Orb::Models::PlanCreateParams::Price::TieredWithMinimum#invoicing_cycle_configuration
|
2927
2928
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
2928
2929
|
# @!attribute duration
|
2929
2930
|
# The duration of the billing period.
|
@@ -2934,7 +2935,7 @@ module Orb
|
|
2934
2935
|
# @!attribute duration_unit
|
2935
2936
|
# The unit of billing period duration.
|
2936
2937
|
#
|
2937
|
-
# @return [Symbol, Orb::PlanCreateParams::Price::TieredWithMinimum::InvoicingCycleConfiguration::DurationUnit]
|
2938
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::TieredWithMinimum::InvoicingCycleConfiguration::DurationUnit]
|
2938
2939
|
required :duration_unit,
|
2939
2940
|
enum: -> {
|
2940
2941
|
Orb::PlanCreateParams::Price::TieredWithMinimum::InvoicingCycleConfiguration::DurationUnit
|
@@ -2946,11 +2947,11 @@ module Orb
|
|
2946
2947
|
#
|
2947
2948
|
# @param duration [Integer] The duration of the billing period.
|
2948
2949
|
#
|
2949
|
-
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::TieredWithMinimum::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
2950
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::TieredWithMinimum::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
2950
2951
|
|
2951
2952
|
# The unit of billing period duration.
|
2952
2953
|
#
|
2953
|
-
# @see Orb::PlanCreateParams::Price::TieredWithMinimum::InvoicingCycleConfiguration#duration_unit
|
2954
|
+
# @see Orb::Models::PlanCreateParams::Price::TieredWithMinimum::InvoicingCycleConfiguration#duration_unit
|
2954
2955
|
module DurationUnit
|
2955
2956
|
extend Orb::Internal::Type::Enum
|
2956
2957
|
|
@@ -2967,7 +2968,7 @@ module Orb
|
|
2967
2968
|
# @!attribute cadence
|
2968
2969
|
# The cadence to bill for this price on.
|
2969
2970
|
#
|
2970
|
-
# @return [Symbol, Orb::PlanCreateParams::Price::UnitWithPercent::Cadence]
|
2971
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::UnitWithPercent::Cadence]
|
2971
2972
|
required :cadence, enum: -> { Orb::PlanCreateParams::Price::UnitWithPercent::Cadence }
|
2972
2973
|
|
2973
2974
|
# @!attribute item_id
|
@@ -3010,7 +3011,7 @@ module Orb
|
|
3010
3011
|
# For custom cadence: specifies the duration of the billing period in days or
|
3011
3012
|
# months.
|
3012
3013
|
#
|
3013
|
-
# @return [Orb::PlanCreateParams::Price::UnitWithPercent::BillingCycleConfiguration, nil]
|
3014
|
+
# @return [Orb::Models::PlanCreateParams::Price::UnitWithPercent::BillingCycleConfiguration, nil]
|
3014
3015
|
optional :billing_cycle_configuration,
|
3015
3016
|
-> { Orb::PlanCreateParams::Price::UnitWithPercent::BillingCycleConfiguration },
|
3016
3017
|
nil?: true
|
@@ -3051,7 +3052,7 @@ module Orb
|
|
3051
3052
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
3052
3053
|
# If unspecified, a single invoice is produced per billing cycle.
|
3053
3054
|
#
|
3054
|
-
# @return [Orb::PlanCreateParams::Price::UnitWithPercent::InvoicingCycleConfiguration, nil]
|
3055
|
+
# @return [Orb::Models::PlanCreateParams::Price::UnitWithPercent::InvoicingCycleConfiguration, nil]
|
3055
3056
|
optional :invoicing_cycle_configuration,
|
3056
3057
|
-> { Orb::PlanCreateParams::Price::UnitWithPercent::InvoicingCycleConfiguration },
|
3057
3058
|
nil?: true
|
@@ -3066,9 +3067,9 @@ module Orb
|
|
3066
3067
|
|
3067
3068
|
# @!method initialize(cadence:, item_id:, name:, unit_with_percent_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :unit_with_percent)
|
3068
3069
|
# Some parameter documentations has been truncated, see
|
3069
|
-
# {Orb::PlanCreateParams::Price::UnitWithPercent} for more details.
|
3070
|
+
# {Orb::Models::PlanCreateParams::Price::UnitWithPercent} for more details.
|
3070
3071
|
#
|
3071
|
-
# @param cadence [Symbol, Orb::PlanCreateParams::Price::UnitWithPercent::Cadence] The cadence to bill for this price on.
|
3072
|
+
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::UnitWithPercent::Cadence] The cadence to bill for this price on.
|
3072
3073
|
#
|
3073
3074
|
# @param item_id [String] The id of the item the price will be associated with.
|
3074
3075
|
#
|
@@ -3080,7 +3081,7 @@ module Orb
|
|
3080
3081
|
#
|
3081
3082
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
3082
3083
|
#
|
3083
|
-
# @param billing_cycle_configuration [Orb::PlanCreateParams::Price::UnitWithPercent::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
3084
|
+
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::UnitWithPercent::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
3084
3085
|
#
|
3085
3086
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
3086
3087
|
#
|
@@ -3092,7 +3093,7 @@ module Orb
|
|
3092
3093
|
#
|
3093
3094
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
3094
3095
|
#
|
3095
|
-
# @param invoicing_cycle_configuration [Orb::PlanCreateParams::Price::UnitWithPercent::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
3096
|
+
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::UnitWithPercent::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
3096
3097
|
#
|
3097
3098
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
3098
3099
|
#
|
@@ -3100,7 +3101,7 @@ module Orb
|
|
3100
3101
|
|
3101
3102
|
# The cadence to bill for this price on.
|
3102
3103
|
#
|
3103
|
-
# @see Orb::PlanCreateParams::Price::UnitWithPercent#cadence
|
3104
|
+
# @see Orb::Models::PlanCreateParams::Price::UnitWithPercent#cadence
|
3104
3105
|
module Cadence
|
3105
3106
|
extend Orb::Internal::Type::Enum
|
3106
3107
|
|
@@ -3115,7 +3116,7 @@ module Orb
|
|
3115
3116
|
# @return [Array<Symbol>]
|
3116
3117
|
end
|
3117
3118
|
|
3118
|
-
# @see Orb::PlanCreateParams::Price::UnitWithPercent#billing_cycle_configuration
|
3119
|
+
# @see Orb::Models::PlanCreateParams::Price::UnitWithPercent#billing_cycle_configuration
|
3119
3120
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
3120
3121
|
# @!attribute duration
|
3121
3122
|
# The duration of the billing period.
|
@@ -3126,7 +3127,7 @@ module Orb
|
|
3126
3127
|
# @!attribute duration_unit
|
3127
3128
|
# The unit of billing period duration.
|
3128
3129
|
#
|
3129
|
-
# @return [Symbol, Orb::PlanCreateParams::Price::UnitWithPercent::BillingCycleConfiguration::DurationUnit]
|
3130
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::UnitWithPercent::BillingCycleConfiguration::DurationUnit]
|
3130
3131
|
required :duration_unit,
|
3131
3132
|
enum: -> {
|
3132
3133
|
Orb::PlanCreateParams::Price::UnitWithPercent::BillingCycleConfiguration::DurationUnit
|
@@ -3138,11 +3139,11 @@ module Orb
|
|
3138
3139
|
#
|
3139
3140
|
# @param duration [Integer] The duration of the billing period.
|
3140
3141
|
#
|
3141
|
-
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::UnitWithPercent::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
3142
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::UnitWithPercent::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
3142
3143
|
|
3143
3144
|
# The unit of billing period duration.
|
3144
3145
|
#
|
3145
|
-
# @see Orb::PlanCreateParams::Price::UnitWithPercent::BillingCycleConfiguration#duration_unit
|
3146
|
+
# @see Orb::Models::PlanCreateParams::Price::UnitWithPercent::BillingCycleConfiguration#duration_unit
|
3146
3147
|
module DurationUnit
|
3147
3148
|
extend Orb::Internal::Type::Enum
|
3148
3149
|
|
@@ -3154,7 +3155,7 @@ module Orb
|
|
3154
3155
|
end
|
3155
3156
|
end
|
3156
3157
|
|
3157
|
-
# @see Orb::PlanCreateParams::Price::UnitWithPercent#invoicing_cycle_configuration
|
3158
|
+
# @see Orb::Models::PlanCreateParams::Price::UnitWithPercent#invoicing_cycle_configuration
|
3158
3159
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
3159
3160
|
# @!attribute duration
|
3160
3161
|
# The duration of the billing period.
|
@@ -3165,7 +3166,7 @@ module Orb
|
|
3165
3166
|
# @!attribute duration_unit
|
3166
3167
|
# The unit of billing period duration.
|
3167
3168
|
#
|
3168
|
-
# @return [Symbol, Orb::PlanCreateParams::Price::UnitWithPercent::InvoicingCycleConfiguration::DurationUnit]
|
3169
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::UnitWithPercent::InvoicingCycleConfiguration::DurationUnit]
|
3169
3170
|
required :duration_unit,
|
3170
3171
|
enum: -> {
|
3171
3172
|
Orb::PlanCreateParams::Price::UnitWithPercent::InvoicingCycleConfiguration::DurationUnit
|
@@ -3177,11 +3178,11 @@ module Orb
|
|
3177
3178
|
#
|
3178
3179
|
# @param duration [Integer] The duration of the billing period.
|
3179
3180
|
#
|
3180
|
-
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::UnitWithPercent::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
3181
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::UnitWithPercent::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
3181
3182
|
|
3182
3183
|
# The unit of billing period duration.
|
3183
3184
|
#
|
3184
|
-
# @see Orb::PlanCreateParams::Price::UnitWithPercent::InvoicingCycleConfiguration#duration_unit
|
3185
|
+
# @see Orb::Models::PlanCreateParams::Price::UnitWithPercent::InvoicingCycleConfiguration#duration_unit
|
3185
3186
|
module DurationUnit
|
3186
3187
|
extend Orb::Internal::Type::Enum
|
3187
3188
|
|
@@ -3198,7 +3199,7 @@ module Orb
|
|
3198
3199
|
# @!attribute cadence
|
3199
3200
|
# The cadence to bill for this price on.
|
3200
3201
|
#
|
3201
|
-
# @return [Symbol, Orb::PlanCreateParams::Price::PackageWithAllocation::Cadence]
|
3202
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::PackageWithAllocation::Cadence]
|
3202
3203
|
required :cadence, enum: -> { Orb::PlanCreateParams::Price::PackageWithAllocation::Cadence }
|
3203
3204
|
|
3204
3205
|
# @!attribute item_id
|
@@ -3241,7 +3242,7 @@ module Orb
|
|
3241
3242
|
# For custom cadence: specifies the duration of the billing period in days or
|
3242
3243
|
# months.
|
3243
3244
|
#
|
3244
|
-
# @return [Orb::PlanCreateParams::Price::PackageWithAllocation::BillingCycleConfiguration, nil]
|
3245
|
+
# @return [Orb::Models::PlanCreateParams::Price::PackageWithAllocation::BillingCycleConfiguration, nil]
|
3245
3246
|
optional :billing_cycle_configuration,
|
3246
3247
|
-> { Orb::PlanCreateParams::Price::PackageWithAllocation::BillingCycleConfiguration },
|
3247
3248
|
nil?: true
|
@@ -3282,7 +3283,7 @@ module Orb
|
|
3282
3283
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
3283
3284
|
# If unspecified, a single invoice is produced per billing cycle.
|
3284
3285
|
#
|
3285
|
-
# @return [Orb::PlanCreateParams::Price::PackageWithAllocation::InvoicingCycleConfiguration, nil]
|
3286
|
+
# @return [Orb::Models::PlanCreateParams::Price::PackageWithAllocation::InvoicingCycleConfiguration, nil]
|
3286
3287
|
optional :invoicing_cycle_configuration,
|
3287
3288
|
-> { Orb::PlanCreateParams::Price::PackageWithAllocation::InvoicingCycleConfiguration },
|
3288
3289
|
nil?: true
|
@@ -3297,9 +3298,9 @@ module Orb
|
|
3297
3298
|
|
3298
3299
|
# @!method initialize(cadence:, item_id:, name:, package_with_allocation_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :package_with_allocation)
|
3299
3300
|
# Some parameter documentations has been truncated, see
|
3300
|
-
# {Orb::PlanCreateParams::Price::PackageWithAllocation} for more details.
|
3301
|
+
# {Orb::Models::PlanCreateParams::Price::PackageWithAllocation} for more details.
|
3301
3302
|
#
|
3302
|
-
# @param cadence [Symbol, Orb::PlanCreateParams::Price::PackageWithAllocation::Cadence] The cadence to bill for this price on.
|
3303
|
+
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::PackageWithAllocation::Cadence] The cadence to bill for this price on.
|
3303
3304
|
#
|
3304
3305
|
# @param item_id [String] The id of the item the price will be associated with.
|
3305
3306
|
#
|
@@ -3311,7 +3312,7 @@ module Orb
|
|
3311
3312
|
#
|
3312
3313
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
3313
3314
|
#
|
3314
|
-
# @param billing_cycle_configuration [Orb::PlanCreateParams::Price::PackageWithAllocation::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
3315
|
+
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::PackageWithAllocation::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
3315
3316
|
#
|
3316
3317
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
3317
3318
|
#
|
@@ -3323,7 +3324,7 @@ module Orb
|
|
3323
3324
|
#
|
3324
3325
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
3325
3326
|
#
|
3326
|
-
# @param invoicing_cycle_configuration [Orb::PlanCreateParams::Price::PackageWithAllocation::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
3327
|
+
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::PackageWithAllocation::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
3327
3328
|
#
|
3328
3329
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
3329
3330
|
#
|
@@ -3331,7 +3332,7 @@ module Orb
|
|
3331
3332
|
|
3332
3333
|
# The cadence to bill for this price on.
|
3333
3334
|
#
|
3334
|
-
# @see Orb::PlanCreateParams::Price::PackageWithAllocation#cadence
|
3335
|
+
# @see Orb::Models::PlanCreateParams::Price::PackageWithAllocation#cadence
|
3335
3336
|
module Cadence
|
3336
3337
|
extend Orb::Internal::Type::Enum
|
3337
3338
|
|
@@ -3346,7 +3347,7 @@ module Orb
|
|
3346
3347
|
# @return [Array<Symbol>]
|
3347
3348
|
end
|
3348
3349
|
|
3349
|
-
# @see Orb::PlanCreateParams::Price::PackageWithAllocation#billing_cycle_configuration
|
3350
|
+
# @see Orb::Models::PlanCreateParams::Price::PackageWithAllocation#billing_cycle_configuration
|
3350
3351
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
3351
3352
|
# @!attribute duration
|
3352
3353
|
# The duration of the billing period.
|
@@ -3357,7 +3358,7 @@ module Orb
|
|
3357
3358
|
# @!attribute duration_unit
|
3358
3359
|
# The unit of billing period duration.
|
3359
3360
|
#
|
3360
|
-
# @return [Symbol, Orb::PlanCreateParams::Price::PackageWithAllocation::BillingCycleConfiguration::DurationUnit]
|
3361
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::PackageWithAllocation::BillingCycleConfiguration::DurationUnit]
|
3361
3362
|
required :duration_unit,
|
3362
3363
|
enum: -> {
|
3363
3364
|
Orb::PlanCreateParams::Price::PackageWithAllocation::BillingCycleConfiguration::DurationUnit
|
@@ -3369,11 +3370,11 @@ module Orb
|
|
3369
3370
|
#
|
3370
3371
|
# @param duration [Integer] The duration of the billing period.
|
3371
3372
|
#
|
3372
|
-
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::PackageWithAllocation::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
3373
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::PackageWithAllocation::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
3373
3374
|
|
3374
3375
|
# The unit of billing period duration.
|
3375
3376
|
#
|
3376
|
-
# @see Orb::PlanCreateParams::Price::PackageWithAllocation::BillingCycleConfiguration#duration_unit
|
3377
|
+
# @see Orb::Models::PlanCreateParams::Price::PackageWithAllocation::BillingCycleConfiguration#duration_unit
|
3377
3378
|
module DurationUnit
|
3378
3379
|
extend Orb::Internal::Type::Enum
|
3379
3380
|
|
@@ -3385,7 +3386,7 @@ module Orb
|
|
3385
3386
|
end
|
3386
3387
|
end
|
3387
3388
|
|
3388
|
-
# @see Orb::PlanCreateParams::Price::PackageWithAllocation#invoicing_cycle_configuration
|
3389
|
+
# @see Orb::Models::PlanCreateParams::Price::PackageWithAllocation#invoicing_cycle_configuration
|
3389
3390
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
3390
3391
|
# @!attribute duration
|
3391
3392
|
# The duration of the billing period.
|
@@ -3396,7 +3397,7 @@ module Orb
|
|
3396
3397
|
# @!attribute duration_unit
|
3397
3398
|
# The unit of billing period duration.
|
3398
3399
|
#
|
3399
|
-
# @return [Symbol, Orb::PlanCreateParams::Price::PackageWithAllocation::InvoicingCycleConfiguration::DurationUnit]
|
3400
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::PackageWithAllocation::InvoicingCycleConfiguration::DurationUnit]
|
3400
3401
|
required :duration_unit,
|
3401
3402
|
enum: -> {
|
3402
3403
|
Orb::PlanCreateParams::Price::PackageWithAllocation::InvoicingCycleConfiguration::DurationUnit
|
@@ -3408,11 +3409,11 @@ module Orb
|
|
3408
3409
|
#
|
3409
3410
|
# @param duration [Integer] The duration of the billing period.
|
3410
3411
|
#
|
3411
|
-
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::PackageWithAllocation::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
3412
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::PackageWithAllocation::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
3412
3413
|
|
3413
3414
|
# The unit of billing period duration.
|
3414
3415
|
#
|
3415
|
-
# @see Orb::PlanCreateParams::Price::PackageWithAllocation::InvoicingCycleConfiguration#duration_unit
|
3416
|
+
# @see Orb::Models::PlanCreateParams::Price::PackageWithAllocation::InvoicingCycleConfiguration#duration_unit
|
3416
3417
|
module DurationUnit
|
3417
3418
|
extend Orb::Internal::Type::Enum
|
3418
3419
|
|
@@ -3429,7 +3430,7 @@ module Orb
|
|
3429
3430
|
# @!attribute cadence
|
3430
3431
|
# The cadence to bill for this price on.
|
3431
3432
|
#
|
3432
|
-
# @return [Symbol, Orb::PlanCreateParams::Price::TieredWithProration::Cadence]
|
3433
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::TieredWithProration::Cadence]
|
3433
3434
|
required :cadence, enum: -> { Orb::PlanCreateParams::Price::TieredWithProration::Cadence }
|
3434
3435
|
|
3435
3436
|
# @!attribute item_id
|
@@ -3472,7 +3473,7 @@ module Orb
|
|
3472
3473
|
# For custom cadence: specifies the duration of the billing period in days or
|
3473
3474
|
# months.
|
3474
3475
|
#
|
3475
|
-
# @return [Orb::PlanCreateParams::Price::TieredWithProration::BillingCycleConfiguration, nil]
|
3476
|
+
# @return [Orb::Models::PlanCreateParams::Price::TieredWithProration::BillingCycleConfiguration, nil]
|
3476
3477
|
optional :billing_cycle_configuration,
|
3477
3478
|
-> { Orb::PlanCreateParams::Price::TieredWithProration::BillingCycleConfiguration },
|
3478
3479
|
nil?: true
|
@@ -3513,7 +3514,7 @@ module Orb
|
|
3513
3514
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
3514
3515
|
# If unspecified, a single invoice is produced per billing cycle.
|
3515
3516
|
#
|
3516
|
-
# @return [Orb::PlanCreateParams::Price::TieredWithProration::InvoicingCycleConfiguration, nil]
|
3517
|
+
# @return [Orb::Models::PlanCreateParams::Price::TieredWithProration::InvoicingCycleConfiguration, nil]
|
3517
3518
|
optional :invoicing_cycle_configuration,
|
3518
3519
|
-> { Orb::PlanCreateParams::Price::TieredWithProration::InvoicingCycleConfiguration },
|
3519
3520
|
nil?: true
|
@@ -3528,9 +3529,9 @@ module Orb
|
|
3528
3529
|
|
3529
3530
|
# @!method initialize(cadence:, item_id:, name:, tiered_with_proration_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :tiered_with_proration)
|
3530
3531
|
# Some parameter documentations has been truncated, see
|
3531
|
-
# {Orb::PlanCreateParams::Price::TieredWithProration} for more details.
|
3532
|
+
# {Orb::Models::PlanCreateParams::Price::TieredWithProration} for more details.
|
3532
3533
|
#
|
3533
|
-
# @param cadence [Symbol, Orb::PlanCreateParams::Price::TieredWithProration::Cadence] The cadence to bill for this price on.
|
3534
|
+
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::TieredWithProration::Cadence] The cadence to bill for this price on.
|
3534
3535
|
#
|
3535
3536
|
# @param item_id [String] The id of the item the price will be associated with.
|
3536
3537
|
#
|
@@ -3542,7 +3543,7 @@ module Orb
|
|
3542
3543
|
#
|
3543
3544
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
3544
3545
|
#
|
3545
|
-
# @param billing_cycle_configuration [Orb::PlanCreateParams::Price::TieredWithProration::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
3546
|
+
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::TieredWithProration::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
3546
3547
|
#
|
3547
3548
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
3548
3549
|
#
|
@@ -3554,7 +3555,7 @@ module Orb
|
|
3554
3555
|
#
|
3555
3556
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
3556
3557
|
#
|
3557
|
-
# @param invoicing_cycle_configuration [Orb::PlanCreateParams::Price::TieredWithProration::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
3558
|
+
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::TieredWithProration::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
3558
3559
|
#
|
3559
3560
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
3560
3561
|
#
|
@@ -3562,7 +3563,7 @@ module Orb
|
|
3562
3563
|
|
3563
3564
|
# The cadence to bill for this price on.
|
3564
3565
|
#
|
3565
|
-
# @see Orb::PlanCreateParams::Price::TieredWithProration#cadence
|
3566
|
+
# @see Orb::Models::PlanCreateParams::Price::TieredWithProration#cadence
|
3566
3567
|
module Cadence
|
3567
3568
|
extend Orb::Internal::Type::Enum
|
3568
3569
|
|
@@ -3577,7 +3578,7 @@ module Orb
|
|
3577
3578
|
# @return [Array<Symbol>]
|
3578
3579
|
end
|
3579
3580
|
|
3580
|
-
# @see Orb::PlanCreateParams::Price::TieredWithProration#billing_cycle_configuration
|
3581
|
+
# @see Orb::Models::PlanCreateParams::Price::TieredWithProration#billing_cycle_configuration
|
3581
3582
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
3582
3583
|
# @!attribute duration
|
3583
3584
|
# The duration of the billing period.
|
@@ -3588,7 +3589,7 @@ module Orb
|
|
3588
3589
|
# @!attribute duration_unit
|
3589
3590
|
# The unit of billing period duration.
|
3590
3591
|
#
|
3591
|
-
# @return [Symbol, Orb::PlanCreateParams::Price::TieredWithProration::BillingCycleConfiguration::DurationUnit]
|
3592
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::TieredWithProration::BillingCycleConfiguration::DurationUnit]
|
3592
3593
|
required :duration_unit,
|
3593
3594
|
enum: -> {
|
3594
3595
|
Orb::PlanCreateParams::Price::TieredWithProration::BillingCycleConfiguration::DurationUnit
|
@@ -3600,11 +3601,11 @@ module Orb
|
|
3600
3601
|
#
|
3601
3602
|
# @param duration [Integer] The duration of the billing period.
|
3602
3603
|
#
|
3603
|
-
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::TieredWithProration::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
3604
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::TieredWithProration::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
3604
3605
|
|
3605
3606
|
# The unit of billing period duration.
|
3606
3607
|
#
|
3607
|
-
# @see Orb::PlanCreateParams::Price::TieredWithProration::BillingCycleConfiguration#duration_unit
|
3608
|
+
# @see Orb::Models::PlanCreateParams::Price::TieredWithProration::BillingCycleConfiguration#duration_unit
|
3608
3609
|
module DurationUnit
|
3609
3610
|
extend Orb::Internal::Type::Enum
|
3610
3611
|
|
@@ -3616,7 +3617,7 @@ module Orb
|
|
3616
3617
|
end
|
3617
3618
|
end
|
3618
3619
|
|
3619
|
-
# @see Orb::PlanCreateParams::Price::TieredWithProration#invoicing_cycle_configuration
|
3620
|
+
# @see Orb::Models::PlanCreateParams::Price::TieredWithProration#invoicing_cycle_configuration
|
3620
3621
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
3621
3622
|
# @!attribute duration
|
3622
3623
|
# The duration of the billing period.
|
@@ -3627,7 +3628,7 @@ module Orb
|
|
3627
3628
|
# @!attribute duration_unit
|
3628
3629
|
# The unit of billing period duration.
|
3629
3630
|
#
|
3630
|
-
# @return [Symbol, Orb::PlanCreateParams::Price::TieredWithProration::InvoicingCycleConfiguration::DurationUnit]
|
3631
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::TieredWithProration::InvoicingCycleConfiguration::DurationUnit]
|
3631
3632
|
required :duration_unit,
|
3632
3633
|
enum: -> {
|
3633
3634
|
Orb::PlanCreateParams::Price::TieredWithProration::InvoicingCycleConfiguration::DurationUnit
|
@@ -3639,11 +3640,11 @@ module Orb
|
|
3639
3640
|
#
|
3640
3641
|
# @param duration [Integer] The duration of the billing period.
|
3641
3642
|
#
|
3642
|
-
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::TieredWithProration::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
3643
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::TieredWithProration::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
3643
3644
|
|
3644
3645
|
# The unit of billing period duration.
|
3645
3646
|
#
|
3646
|
-
# @see Orb::PlanCreateParams::Price::TieredWithProration::InvoicingCycleConfiguration#duration_unit
|
3647
|
+
# @see Orb::Models::PlanCreateParams::Price::TieredWithProration::InvoicingCycleConfiguration#duration_unit
|
3647
3648
|
module DurationUnit
|
3648
3649
|
extend Orb::Internal::Type::Enum
|
3649
3650
|
|
@@ -3660,7 +3661,7 @@ module Orb
|
|
3660
3661
|
# @!attribute cadence
|
3661
3662
|
# The cadence to bill for this price on.
|
3662
3663
|
#
|
3663
|
-
# @return [Symbol, Orb::PlanCreateParams::Price::UnitWithProration::Cadence]
|
3664
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::UnitWithProration::Cadence]
|
3664
3665
|
required :cadence, enum: -> { Orb::PlanCreateParams::Price::UnitWithProration::Cadence }
|
3665
3666
|
|
3666
3667
|
# @!attribute item_id
|
@@ -3703,7 +3704,7 @@ module Orb
|
|
3703
3704
|
# For custom cadence: specifies the duration of the billing period in days or
|
3704
3705
|
# months.
|
3705
3706
|
#
|
3706
|
-
# @return [Orb::PlanCreateParams::Price::UnitWithProration::BillingCycleConfiguration, nil]
|
3707
|
+
# @return [Orb::Models::PlanCreateParams::Price::UnitWithProration::BillingCycleConfiguration, nil]
|
3707
3708
|
optional :billing_cycle_configuration,
|
3708
3709
|
-> { Orb::PlanCreateParams::Price::UnitWithProration::BillingCycleConfiguration },
|
3709
3710
|
nil?: true
|
@@ -3744,7 +3745,7 @@ module Orb
|
|
3744
3745
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
3745
3746
|
# If unspecified, a single invoice is produced per billing cycle.
|
3746
3747
|
#
|
3747
|
-
# @return [Orb::PlanCreateParams::Price::UnitWithProration::InvoicingCycleConfiguration, nil]
|
3748
|
+
# @return [Orb::Models::PlanCreateParams::Price::UnitWithProration::InvoicingCycleConfiguration, nil]
|
3748
3749
|
optional :invoicing_cycle_configuration,
|
3749
3750
|
-> { Orb::PlanCreateParams::Price::UnitWithProration::InvoicingCycleConfiguration },
|
3750
3751
|
nil?: true
|
@@ -3759,9 +3760,9 @@ module Orb
|
|
3759
3760
|
|
3760
3761
|
# @!method initialize(cadence:, item_id:, name:, unit_with_proration_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :unit_with_proration)
|
3761
3762
|
# Some parameter documentations has been truncated, see
|
3762
|
-
# {Orb::PlanCreateParams::Price::UnitWithProration} for more details.
|
3763
|
+
# {Orb::Models::PlanCreateParams::Price::UnitWithProration} for more details.
|
3763
3764
|
#
|
3764
|
-
# @param cadence [Symbol, Orb::PlanCreateParams::Price::UnitWithProration::Cadence] The cadence to bill for this price on.
|
3765
|
+
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::UnitWithProration::Cadence] The cadence to bill for this price on.
|
3765
3766
|
#
|
3766
3767
|
# @param item_id [String] The id of the item the price will be associated with.
|
3767
3768
|
#
|
@@ -3773,7 +3774,7 @@ module Orb
|
|
3773
3774
|
#
|
3774
3775
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
3775
3776
|
#
|
3776
|
-
# @param billing_cycle_configuration [Orb::PlanCreateParams::Price::UnitWithProration::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
3777
|
+
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::UnitWithProration::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
3777
3778
|
#
|
3778
3779
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
3779
3780
|
#
|
@@ -3785,7 +3786,7 @@ module Orb
|
|
3785
3786
|
#
|
3786
3787
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
3787
3788
|
#
|
3788
|
-
# @param invoicing_cycle_configuration [Orb::PlanCreateParams::Price::UnitWithProration::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
3789
|
+
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::UnitWithProration::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
3789
3790
|
#
|
3790
3791
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
3791
3792
|
#
|
@@ -3793,7 +3794,7 @@ module Orb
|
|
3793
3794
|
|
3794
3795
|
# The cadence to bill for this price on.
|
3795
3796
|
#
|
3796
|
-
# @see Orb::PlanCreateParams::Price::UnitWithProration#cadence
|
3797
|
+
# @see Orb::Models::PlanCreateParams::Price::UnitWithProration#cadence
|
3797
3798
|
module Cadence
|
3798
3799
|
extend Orb::Internal::Type::Enum
|
3799
3800
|
|
@@ -3808,7 +3809,7 @@ module Orb
|
|
3808
3809
|
# @return [Array<Symbol>]
|
3809
3810
|
end
|
3810
3811
|
|
3811
|
-
# @see Orb::PlanCreateParams::Price::UnitWithProration#billing_cycle_configuration
|
3812
|
+
# @see Orb::Models::PlanCreateParams::Price::UnitWithProration#billing_cycle_configuration
|
3812
3813
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
3813
3814
|
# @!attribute duration
|
3814
3815
|
# The duration of the billing period.
|
@@ -3819,7 +3820,7 @@ module Orb
|
|
3819
3820
|
# @!attribute duration_unit
|
3820
3821
|
# The unit of billing period duration.
|
3821
3822
|
#
|
3822
|
-
# @return [Symbol, Orb::PlanCreateParams::Price::UnitWithProration::BillingCycleConfiguration::DurationUnit]
|
3823
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::UnitWithProration::BillingCycleConfiguration::DurationUnit]
|
3823
3824
|
required :duration_unit,
|
3824
3825
|
enum: -> {
|
3825
3826
|
Orb::PlanCreateParams::Price::UnitWithProration::BillingCycleConfiguration::DurationUnit
|
@@ -3831,11 +3832,11 @@ module Orb
|
|
3831
3832
|
#
|
3832
3833
|
# @param duration [Integer] The duration of the billing period.
|
3833
3834
|
#
|
3834
|
-
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::UnitWithProration::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
3835
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::UnitWithProration::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
3835
3836
|
|
3836
3837
|
# The unit of billing period duration.
|
3837
3838
|
#
|
3838
|
-
# @see Orb::PlanCreateParams::Price::UnitWithProration::BillingCycleConfiguration#duration_unit
|
3839
|
+
# @see Orb::Models::PlanCreateParams::Price::UnitWithProration::BillingCycleConfiguration#duration_unit
|
3839
3840
|
module DurationUnit
|
3840
3841
|
extend Orb::Internal::Type::Enum
|
3841
3842
|
|
@@ -3847,7 +3848,7 @@ module Orb
|
|
3847
3848
|
end
|
3848
3849
|
end
|
3849
3850
|
|
3850
|
-
# @see Orb::PlanCreateParams::Price::UnitWithProration#invoicing_cycle_configuration
|
3851
|
+
# @see Orb::Models::PlanCreateParams::Price::UnitWithProration#invoicing_cycle_configuration
|
3851
3852
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
3852
3853
|
# @!attribute duration
|
3853
3854
|
# The duration of the billing period.
|
@@ -3858,7 +3859,7 @@ module Orb
|
|
3858
3859
|
# @!attribute duration_unit
|
3859
3860
|
# The unit of billing period duration.
|
3860
3861
|
#
|
3861
|
-
# @return [Symbol, Orb::PlanCreateParams::Price::UnitWithProration::InvoicingCycleConfiguration::DurationUnit]
|
3862
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::UnitWithProration::InvoicingCycleConfiguration::DurationUnit]
|
3862
3863
|
required :duration_unit,
|
3863
3864
|
enum: -> {
|
3864
3865
|
Orb::PlanCreateParams::Price::UnitWithProration::InvoicingCycleConfiguration::DurationUnit
|
@@ -3870,11 +3871,11 @@ module Orb
|
|
3870
3871
|
#
|
3871
3872
|
# @param duration [Integer] The duration of the billing period.
|
3872
3873
|
#
|
3873
|
-
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::UnitWithProration::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
3874
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::UnitWithProration::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
3874
3875
|
|
3875
3876
|
# The unit of billing period duration.
|
3876
3877
|
#
|
3877
|
-
# @see Orb::PlanCreateParams::Price::UnitWithProration::InvoicingCycleConfiguration#duration_unit
|
3878
|
+
# @see Orb::Models::PlanCreateParams::Price::UnitWithProration::InvoicingCycleConfiguration#duration_unit
|
3878
3879
|
module DurationUnit
|
3879
3880
|
extend Orb::Internal::Type::Enum
|
3880
3881
|
|
@@ -3891,7 +3892,7 @@ module Orb
|
|
3891
3892
|
# @!attribute cadence
|
3892
3893
|
# The cadence to bill for this price on.
|
3893
3894
|
#
|
3894
|
-
# @return [Symbol, Orb::PlanCreateParams::Price::GroupedAllocation::Cadence]
|
3895
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::GroupedAllocation::Cadence]
|
3895
3896
|
required :cadence, enum: -> { Orb::PlanCreateParams::Price::GroupedAllocation::Cadence }
|
3896
3897
|
|
3897
3898
|
# @!attribute grouped_allocation_config
|
@@ -3934,7 +3935,7 @@ module Orb
|
|
3934
3935
|
# For custom cadence: specifies the duration of the billing period in days or
|
3935
3936
|
# months.
|
3936
3937
|
#
|
3937
|
-
# @return [Orb::PlanCreateParams::Price::GroupedAllocation::BillingCycleConfiguration, nil]
|
3938
|
+
# @return [Orb::Models::PlanCreateParams::Price::GroupedAllocation::BillingCycleConfiguration, nil]
|
3938
3939
|
optional :billing_cycle_configuration,
|
3939
3940
|
-> { Orb::PlanCreateParams::Price::GroupedAllocation::BillingCycleConfiguration },
|
3940
3941
|
nil?: true
|
@@ -3975,7 +3976,7 @@ module Orb
|
|
3975
3976
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
3976
3977
|
# If unspecified, a single invoice is produced per billing cycle.
|
3977
3978
|
#
|
3978
|
-
# @return [Orb::PlanCreateParams::Price::GroupedAllocation::InvoicingCycleConfiguration, nil]
|
3979
|
+
# @return [Orb::Models::PlanCreateParams::Price::GroupedAllocation::InvoicingCycleConfiguration, nil]
|
3979
3980
|
optional :invoicing_cycle_configuration,
|
3980
3981
|
-> { Orb::PlanCreateParams::Price::GroupedAllocation::InvoicingCycleConfiguration },
|
3981
3982
|
nil?: true
|
@@ -3990,9 +3991,9 @@ module Orb
|
|
3990
3991
|
|
3991
3992
|
# @!method initialize(cadence:, grouped_allocation_config:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :grouped_allocation)
|
3992
3993
|
# Some parameter documentations has been truncated, see
|
3993
|
-
# {Orb::PlanCreateParams::Price::GroupedAllocation} for more details.
|
3994
|
+
# {Orb::Models::PlanCreateParams::Price::GroupedAllocation} for more details.
|
3994
3995
|
#
|
3995
|
-
# @param cadence [Symbol, Orb::PlanCreateParams::Price::GroupedAllocation::Cadence] The cadence to bill for this price on.
|
3996
|
+
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::GroupedAllocation::Cadence] The cadence to bill for this price on.
|
3996
3997
|
#
|
3997
3998
|
# @param grouped_allocation_config [Hash{Symbol=>Object}]
|
3998
3999
|
#
|
@@ -4004,7 +4005,7 @@ module Orb
|
|
4004
4005
|
#
|
4005
4006
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
4006
4007
|
#
|
4007
|
-
# @param billing_cycle_configuration [Orb::PlanCreateParams::Price::GroupedAllocation::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
4008
|
+
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::GroupedAllocation::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
4008
4009
|
#
|
4009
4010
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
4010
4011
|
#
|
@@ -4016,7 +4017,7 @@ module Orb
|
|
4016
4017
|
#
|
4017
4018
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
4018
4019
|
#
|
4019
|
-
# @param invoicing_cycle_configuration [Orb::PlanCreateParams::Price::GroupedAllocation::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
4020
|
+
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::GroupedAllocation::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
4020
4021
|
#
|
4021
4022
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
4022
4023
|
#
|
@@ -4024,7 +4025,7 @@ module Orb
|
|
4024
4025
|
|
4025
4026
|
# The cadence to bill for this price on.
|
4026
4027
|
#
|
4027
|
-
# @see Orb::PlanCreateParams::Price::GroupedAllocation#cadence
|
4028
|
+
# @see Orb::Models::PlanCreateParams::Price::GroupedAllocation#cadence
|
4028
4029
|
module Cadence
|
4029
4030
|
extend Orb::Internal::Type::Enum
|
4030
4031
|
|
@@ -4039,7 +4040,7 @@ module Orb
|
|
4039
4040
|
# @return [Array<Symbol>]
|
4040
4041
|
end
|
4041
4042
|
|
4042
|
-
# @see Orb::PlanCreateParams::Price::GroupedAllocation#billing_cycle_configuration
|
4043
|
+
# @see Orb::Models::PlanCreateParams::Price::GroupedAllocation#billing_cycle_configuration
|
4043
4044
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
4044
4045
|
# @!attribute duration
|
4045
4046
|
# The duration of the billing period.
|
@@ -4050,7 +4051,7 @@ module Orb
|
|
4050
4051
|
# @!attribute duration_unit
|
4051
4052
|
# The unit of billing period duration.
|
4052
4053
|
#
|
4053
|
-
# @return [Symbol, Orb::PlanCreateParams::Price::GroupedAllocation::BillingCycleConfiguration::DurationUnit]
|
4054
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::GroupedAllocation::BillingCycleConfiguration::DurationUnit]
|
4054
4055
|
required :duration_unit,
|
4055
4056
|
enum: -> {
|
4056
4057
|
Orb::PlanCreateParams::Price::GroupedAllocation::BillingCycleConfiguration::DurationUnit
|
@@ -4062,11 +4063,11 @@ module Orb
|
|
4062
4063
|
#
|
4063
4064
|
# @param duration [Integer] The duration of the billing period.
|
4064
4065
|
#
|
4065
|
-
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::GroupedAllocation::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
4066
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::GroupedAllocation::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
4066
4067
|
|
4067
4068
|
# The unit of billing period duration.
|
4068
4069
|
#
|
4069
|
-
# @see Orb::PlanCreateParams::Price::GroupedAllocation::BillingCycleConfiguration#duration_unit
|
4070
|
+
# @see Orb::Models::PlanCreateParams::Price::GroupedAllocation::BillingCycleConfiguration#duration_unit
|
4070
4071
|
module DurationUnit
|
4071
4072
|
extend Orb::Internal::Type::Enum
|
4072
4073
|
|
@@ -4078,7 +4079,7 @@ module Orb
|
|
4078
4079
|
end
|
4079
4080
|
end
|
4080
4081
|
|
4081
|
-
# @see Orb::PlanCreateParams::Price::GroupedAllocation#invoicing_cycle_configuration
|
4082
|
+
# @see Orb::Models::PlanCreateParams::Price::GroupedAllocation#invoicing_cycle_configuration
|
4082
4083
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
4083
4084
|
# @!attribute duration
|
4084
4085
|
# The duration of the billing period.
|
@@ -4089,7 +4090,7 @@ module Orb
|
|
4089
4090
|
# @!attribute duration_unit
|
4090
4091
|
# The unit of billing period duration.
|
4091
4092
|
#
|
4092
|
-
# @return [Symbol, Orb::PlanCreateParams::Price::GroupedAllocation::InvoicingCycleConfiguration::DurationUnit]
|
4093
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::GroupedAllocation::InvoicingCycleConfiguration::DurationUnit]
|
4093
4094
|
required :duration_unit,
|
4094
4095
|
enum: -> {
|
4095
4096
|
Orb::PlanCreateParams::Price::GroupedAllocation::InvoicingCycleConfiguration::DurationUnit
|
@@ -4101,11 +4102,11 @@ module Orb
|
|
4101
4102
|
#
|
4102
4103
|
# @param duration [Integer] The duration of the billing period.
|
4103
4104
|
#
|
4104
|
-
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::GroupedAllocation::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
4105
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::GroupedAllocation::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
4105
4106
|
|
4106
4107
|
# The unit of billing period duration.
|
4107
4108
|
#
|
4108
|
-
# @see Orb::PlanCreateParams::Price::GroupedAllocation::InvoicingCycleConfiguration#duration_unit
|
4109
|
+
# @see Orb::Models::PlanCreateParams::Price::GroupedAllocation::InvoicingCycleConfiguration#duration_unit
|
4109
4110
|
module DurationUnit
|
4110
4111
|
extend Orb::Internal::Type::Enum
|
4111
4112
|
|
@@ -4122,7 +4123,7 @@ module Orb
|
|
4122
4123
|
# @!attribute cadence
|
4123
4124
|
# The cadence to bill for this price on.
|
4124
4125
|
#
|
4125
|
-
# @return [Symbol, Orb::PlanCreateParams::Price::GroupedWithProratedMinimum::Cadence]
|
4126
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::GroupedWithProratedMinimum::Cadence]
|
4126
4127
|
required :cadence, enum: -> { Orb::PlanCreateParams::Price::GroupedWithProratedMinimum::Cadence }
|
4127
4128
|
|
4128
4129
|
# @!attribute grouped_with_prorated_minimum_config
|
@@ -4166,7 +4167,7 @@ module Orb
|
|
4166
4167
|
# For custom cadence: specifies the duration of the billing period in days or
|
4167
4168
|
# months.
|
4168
4169
|
#
|
4169
|
-
# @return [Orb::PlanCreateParams::Price::GroupedWithProratedMinimum::BillingCycleConfiguration, nil]
|
4170
|
+
# @return [Orb::Models::PlanCreateParams::Price::GroupedWithProratedMinimum::BillingCycleConfiguration, nil]
|
4170
4171
|
optional :billing_cycle_configuration,
|
4171
4172
|
-> { Orb::PlanCreateParams::Price::GroupedWithProratedMinimum::BillingCycleConfiguration },
|
4172
4173
|
nil?: true
|
@@ -4207,7 +4208,7 @@ module Orb
|
|
4207
4208
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
4208
4209
|
# If unspecified, a single invoice is produced per billing cycle.
|
4209
4210
|
#
|
4210
|
-
# @return [Orb::PlanCreateParams::Price::GroupedWithProratedMinimum::InvoicingCycleConfiguration, nil]
|
4211
|
+
# @return [Orb::Models::PlanCreateParams::Price::GroupedWithProratedMinimum::InvoicingCycleConfiguration, nil]
|
4211
4212
|
optional :invoicing_cycle_configuration,
|
4212
4213
|
-> {
|
4213
4214
|
Orb::PlanCreateParams::Price::GroupedWithProratedMinimum::InvoicingCycleConfiguration
|
@@ -4224,9 +4225,10 @@ module Orb
|
|
4224
4225
|
|
4225
4226
|
# @!method initialize(cadence:, grouped_with_prorated_minimum_config:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :grouped_with_prorated_minimum)
|
4226
4227
|
# Some parameter documentations has been truncated, see
|
4227
|
-
# {Orb::PlanCreateParams::Price::GroupedWithProratedMinimum} for more
|
4228
|
+
# {Orb::Models::PlanCreateParams::Price::GroupedWithProratedMinimum} for more
|
4229
|
+
# details.
|
4228
4230
|
#
|
4229
|
-
# @param cadence [Symbol, Orb::PlanCreateParams::Price::GroupedWithProratedMinimum::Cadence] The cadence to bill for this price on.
|
4231
|
+
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::GroupedWithProratedMinimum::Cadence] The cadence to bill for this price on.
|
4230
4232
|
#
|
4231
4233
|
# @param grouped_with_prorated_minimum_config [Hash{Symbol=>Object}]
|
4232
4234
|
#
|
@@ -4238,7 +4240,7 @@ module Orb
|
|
4238
4240
|
#
|
4239
4241
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
4240
4242
|
#
|
4241
|
-
# @param billing_cycle_configuration [Orb::PlanCreateParams::Price::GroupedWithProratedMinimum::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
4243
|
+
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::GroupedWithProratedMinimum::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
4242
4244
|
#
|
4243
4245
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
4244
4246
|
#
|
@@ -4250,7 +4252,7 @@ module Orb
|
|
4250
4252
|
#
|
4251
4253
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
4252
4254
|
#
|
4253
|
-
# @param invoicing_cycle_configuration [Orb::PlanCreateParams::Price::GroupedWithProratedMinimum::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
4255
|
+
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::GroupedWithProratedMinimum::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
4254
4256
|
#
|
4255
4257
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
4256
4258
|
#
|
@@ -4258,7 +4260,7 @@ module Orb
|
|
4258
4260
|
|
4259
4261
|
# The cadence to bill for this price on.
|
4260
4262
|
#
|
4261
|
-
# @see Orb::PlanCreateParams::Price::GroupedWithProratedMinimum#cadence
|
4263
|
+
# @see Orb::Models::PlanCreateParams::Price::GroupedWithProratedMinimum#cadence
|
4262
4264
|
module Cadence
|
4263
4265
|
extend Orb::Internal::Type::Enum
|
4264
4266
|
|
@@ -4273,7 +4275,7 @@ module Orb
|
|
4273
4275
|
# @return [Array<Symbol>]
|
4274
4276
|
end
|
4275
4277
|
|
4276
|
-
# @see Orb::PlanCreateParams::Price::GroupedWithProratedMinimum#billing_cycle_configuration
|
4278
|
+
# @see Orb::Models::PlanCreateParams::Price::GroupedWithProratedMinimum#billing_cycle_configuration
|
4277
4279
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
4278
4280
|
# @!attribute duration
|
4279
4281
|
# The duration of the billing period.
|
@@ -4284,7 +4286,7 @@ module Orb
|
|
4284
4286
|
# @!attribute duration_unit
|
4285
4287
|
# The unit of billing period duration.
|
4286
4288
|
#
|
4287
|
-
# @return [Symbol, Orb::PlanCreateParams::Price::GroupedWithProratedMinimum::BillingCycleConfiguration::DurationUnit]
|
4289
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::GroupedWithProratedMinimum::BillingCycleConfiguration::DurationUnit]
|
4288
4290
|
required :duration_unit,
|
4289
4291
|
enum: -> {
|
4290
4292
|
Orb::PlanCreateParams::Price::GroupedWithProratedMinimum::BillingCycleConfiguration::DurationUnit
|
@@ -4296,11 +4298,11 @@ module Orb
|
|
4296
4298
|
#
|
4297
4299
|
# @param duration [Integer] The duration of the billing period.
|
4298
4300
|
#
|
4299
|
-
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::GroupedWithProratedMinimum::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
4301
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::GroupedWithProratedMinimum::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
4300
4302
|
|
4301
4303
|
# The unit of billing period duration.
|
4302
4304
|
#
|
4303
|
-
# @see Orb::PlanCreateParams::Price::GroupedWithProratedMinimum::BillingCycleConfiguration#duration_unit
|
4305
|
+
# @see Orb::Models::PlanCreateParams::Price::GroupedWithProratedMinimum::BillingCycleConfiguration#duration_unit
|
4304
4306
|
module DurationUnit
|
4305
4307
|
extend Orb::Internal::Type::Enum
|
4306
4308
|
|
@@ -4312,7 +4314,7 @@ module Orb
|
|
4312
4314
|
end
|
4313
4315
|
end
|
4314
4316
|
|
4315
|
-
# @see Orb::PlanCreateParams::Price::GroupedWithProratedMinimum#invoicing_cycle_configuration
|
4317
|
+
# @see Orb::Models::PlanCreateParams::Price::GroupedWithProratedMinimum#invoicing_cycle_configuration
|
4316
4318
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
4317
4319
|
# @!attribute duration
|
4318
4320
|
# The duration of the billing period.
|
@@ -4323,7 +4325,7 @@ module Orb
|
|
4323
4325
|
# @!attribute duration_unit
|
4324
4326
|
# The unit of billing period duration.
|
4325
4327
|
#
|
4326
|
-
# @return [Symbol, Orb::PlanCreateParams::Price::GroupedWithProratedMinimum::InvoicingCycleConfiguration::DurationUnit]
|
4328
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::GroupedWithProratedMinimum::InvoicingCycleConfiguration::DurationUnit]
|
4327
4329
|
required :duration_unit,
|
4328
4330
|
enum: -> {
|
4329
4331
|
Orb::PlanCreateParams::Price::GroupedWithProratedMinimum::InvoicingCycleConfiguration::DurationUnit
|
@@ -4335,11 +4337,11 @@ module Orb
|
|
4335
4337
|
#
|
4336
4338
|
# @param duration [Integer] The duration of the billing period.
|
4337
4339
|
#
|
4338
|
-
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::GroupedWithProratedMinimum::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
4340
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::GroupedWithProratedMinimum::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
4339
4341
|
|
4340
4342
|
# The unit of billing period duration.
|
4341
4343
|
#
|
4342
|
-
# @see Orb::PlanCreateParams::Price::GroupedWithProratedMinimum::InvoicingCycleConfiguration#duration_unit
|
4344
|
+
# @see Orb::Models::PlanCreateParams::Price::GroupedWithProratedMinimum::InvoicingCycleConfiguration#duration_unit
|
4343
4345
|
module DurationUnit
|
4344
4346
|
extend Orb::Internal::Type::Enum
|
4345
4347
|
|
@@ -4356,7 +4358,7 @@ module Orb
|
|
4356
4358
|
# @!attribute cadence
|
4357
4359
|
# The cadence to bill for this price on.
|
4358
4360
|
#
|
4359
|
-
# @return [Symbol, Orb::PlanCreateParams::Price::GroupedWithMeteredMinimum::Cadence]
|
4361
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::GroupedWithMeteredMinimum::Cadence]
|
4360
4362
|
required :cadence, enum: -> { Orb::PlanCreateParams::Price::GroupedWithMeteredMinimum::Cadence }
|
4361
4363
|
|
4362
4364
|
# @!attribute grouped_with_metered_minimum_config
|
@@ -4400,7 +4402,7 @@ module Orb
|
|
4400
4402
|
# For custom cadence: specifies the duration of the billing period in days or
|
4401
4403
|
# months.
|
4402
4404
|
#
|
4403
|
-
# @return [Orb::PlanCreateParams::Price::GroupedWithMeteredMinimum::BillingCycleConfiguration, nil]
|
4405
|
+
# @return [Orb::Models::PlanCreateParams::Price::GroupedWithMeteredMinimum::BillingCycleConfiguration, nil]
|
4404
4406
|
optional :billing_cycle_configuration,
|
4405
4407
|
-> { Orb::PlanCreateParams::Price::GroupedWithMeteredMinimum::BillingCycleConfiguration },
|
4406
4408
|
nil?: true
|
@@ -4441,7 +4443,7 @@ module Orb
|
|
4441
4443
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
4442
4444
|
# If unspecified, a single invoice is produced per billing cycle.
|
4443
4445
|
#
|
4444
|
-
# @return [Orb::PlanCreateParams::Price::GroupedWithMeteredMinimum::InvoicingCycleConfiguration, nil]
|
4446
|
+
# @return [Orb::Models::PlanCreateParams::Price::GroupedWithMeteredMinimum::InvoicingCycleConfiguration, nil]
|
4445
4447
|
optional :invoicing_cycle_configuration,
|
4446
4448
|
-> {
|
4447
4449
|
Orb::PlanCreateParams::Price::GroupedWithMeteredMinimum::InvoicingCycleConfiguration
|
@@ -4458,9 +4460,10 @@ module Orb
|
|
4458
4460
|
|
4459
4461
|
# @!method initialize(cadence:, grouped_with_metered_minimum_config:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :grouped_with_metered_minimum)
|
4460
4462
|
# Some parameter documentations has been truncated, see
|
4461
|
-
# {Orb::PlanCreateParams::Price::GroupedWithMeteredMinimum} for more
|
4463
|
+
# {Orb::Models::PlanCreateParams::Price::GroupedWithMeteredMinimum} for more
|
4464
|
+
# details.
|
4462
4465
|
#
|
4463
|
-
# @param cadence [Symbol, Orb::PlanCreateParams::Price::GroupedWithMeteredMinimum::Cadence] The cadence to bill for this price on.
|
4466
|
+
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::GroupedWithMeteredMinimum::Cadence] The cadence to bill for this price on.
|
4464
4467
|
#
|
4465
4468
|
# @param grouped_with_metered_minimum_config [Hash{Symbol=>Object}]
|
4466
4469
|
#
|
@@ -4472,7 +4475,7 @@ module Orb
|
|
4472
4475
|
#
|
4473
4476
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
4474
4477
|
#
|
4475
|
-
# @param billing_cycle_configuration [Orb::PlanCreateParams::Price::GroupedWithMeteredMinimum::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
4478
|
+
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::GroupedWithMeteredMinimum::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
4476
4479
|
#
|
4477
4480
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
4478
4481
|
#
|
@@ -4484,7 +4487,7 @@ module Orb
|
|
4484
4487
|
#
|
4485
4488
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
4486
4489
|
#
|
4487
|
-
# @param invoicing_cycle_configuration [Orb::PlanCreateParams::Price::GroupedWithMeteredMinimum::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
4490
|
+
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::GroupedWithMeteredMinimum::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
4488
4491
|
#
|
4489
4492
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
4490
4493
|
#
|
@@ -4492,7 +4495,7 @@ module Orb
|
|
4492
4495
|
|
4493
4496
|
# The cadence to bill for this price on.
|
4494
4497
|
#
|
4495
|
-
# @see Orb::PlanCreateParams::Price::GroupedWithMeteredMinimum#cadence
|
4498
|
+
# @see Orb::Models::PlanCreateParams::Price::GroupedWithMeteredMinimum#cadence
|
4496
4499
|
module Cadence
|
4497
4500
|
extend Orb::Internal::Type::Enum
|
4498
4501
|
|
@@ -4507,7 +4510,7 @@ module Orb
|
|
4507
4510
|
# @return [Array<Symbol>]
|
4508
4511
|
end
|
4509
4512
|
|
4510
|
-
# @see Orb::PlanCreateParams::Price::GroupedWithMeteredMinimum#billing_cycle_configuration
|
4513
|
+
# @see Orb::Models::PlanCreateParams::Price::GroupedWithMeteredMinimum#billing_cycle_configuration
|
4511
4514
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
4512
4515
|
# @!attribute duration
|
4513
4516
|
# The duration of the billing period.
|
@@ -4518,7 +4521,7 @@ module Orb
|
|
4518
4521
|
# @!attribute duration_unit
|
4519
4522
|
# The unit of billing period duration.
|
4520
4523
|
#
|
4521
|
-
# @return [Symbol, Orb::PlanCreateParams::Price::GroupedWithMeteredMinimum::BillingCycleConfiguration::DurationUnit]
|
4524
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::GroupedWithMeteredMinimum::BillingCycleConfiguration::DurationUnit]
|
4522
4525
|
required :duration_unit,
|
4523
4526
|
enum: -> {
|
4524
4527
|
Orb::PlanCreateParams::Price::GroupedWithMeteredMinimum::BillingCycleConfiguration::DurationUnit
|
@@ -4530,11 +4533,11 @@ module Orb
|
|
4530
4533
|
#
|
4531
4534
|
# @param duration [Integer] The duration of the billing period.
|
4532
4535
|
#
|
4533
|
-
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::GroupedWithMeteredMinimum::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
4536
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::GroupedWithMeteredMinimum::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
4534
4537
|
|
4535
4538
|
# The unit of billing period duration.
|
4536
4539
|
#
|
4537
|
-
# @see Orb::PlanCreateParams::Price::GroupedWithMeteredMinimum::BillingCycleConfiguration#duration_unit
|
4540
|
+
# @see Orb::Models::PlanCreateParams::Price::GroupedWithMeteredMinimum::BillingCycleConfiguration#duration_unit
|
4538
4541
|
module DurationUnit
|
4539
4542
|
extend Orb::Internal::Type::Enum
|
4540
4543
|
|
@@ -4546,7 +4549,7 @@ module Orb
|
|
4546
4549
|
end
|
4547
4550
|
end
|
4548
4551
|
|
4549
|
-
# @see Orb::PlanCreateParams::Price::GroupedWithMeteredMinimum#invoicing_cycle_configuration
|
4552
|
+
# @see Orb::Models::PlanCreateParams::Price::GroupedWithMeteredMinimum#invoicing_cycle_configuration
|
4550
4553
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
4551
4554
|
# @!attribute duration
|
4552
4555
|
# The duration of the billing period.
|
@@ -4557,7 +4560,7 @@ module Orb
|
|
4557
4560
|
# @!attribute duration_unit
|
4558
4561
|
# The unit of billing period duration.
|
4559
4562
|
#
|
4560
|
-
# @return [Symbol, Orb::PlanCreateParams::Price::GroupedWithMeteredMinimum::InvoicingCycleConfiguration::DurationUnit]
|
4563
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::GroupedWithMeteredMinimum::InvoicingCycleConfiguration::DurationUnit]
|
4561
4564
|
required :duration_unit,
|
4562
4565
|
enum: -> {
|
4563
4566
|
Orb::PlanCreateParams::Price::GroupedWithMeteredMinimum::InvoicingCycleConfiguration::DurationUnit
|
@@ -4569,11 +4572,11 @@ module Orb
|
|
4569
4572
|
#
|
4570
4573
|
# @param duration [Integer] The duration of the billing period.
|
4571
4574
|
#
|
4572
|
-
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::GroupedWithMeteredMinimum::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
4575
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::GroupedWithMeteredMinimum::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
4573
4576
|
|
4574
4577
|
# The unit of billing period duration.
|
4575
4578
|
#
|
4576
|
-
# @see Orb::PlanCreateParams::Price::GroupedWithMeteredMinimum::InvoicingCycleConfiguration#duration_unit
|
4579
|
+
# @see Orb::Models::PlanCreateParams::Price::GroupedWithMeteredMinimum::InvoicingCycleConfiguration#duration_unit
|
4577
4580
|
module DurationUnit
|
4578
4581
|
extend Orb::Internal::Type::Enum
|
4579
4582
|
|
@@ -4590,7 +4593,7 @@ module Orb
|
|
4590
4593
|
# @!attribute cadence
|
4591
4594
|
# The cadence to bill for this price on.
|
4592
4595
|
#
|
4593
|
-
# @return [Symbol, Orb::PlanCreateParams::Price::MatrixWithDisplayName::Cadence]
|
4596
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::MatrixWithDisplayName::Cadence]
|
4594
4597
|
required :cadence, enum: -> { Orb::PlanCreateParams::Price::MatrixWithDisplayName::Cadence }
|
4595
4598
|
|
4596
4599
|
# @!attribute item_id
|
@@ -4633,7 +4636,7 @@ module Orb
|
|
4633
4636
|
# For custom cadence: specifies the duration of the billing period in days or
|
4634
4637
|
# months.
|
4635
4638
|
#
|
4636
|
-
# @return [Orb::PlanCreateParams::Price::MatrixWithDisplayName::BillingCycleConfiguration, nil]
|
4639
|
+
# @return [Orb::Models::PlanCreateParams::Price::MatrixWithDisplayName::BillingCycleConfiguration, nil]
|
4637
4640
|
optional :billing_cycle_configuration,
|
4638
4641
|
-> { Orb::PlanCreateParams::Price::MatrixWithDisplayName::BillingCycleConfiguration },
|
4639
4642
|
nil?: true
|
@@ -4674,7 +4677,7 @@ module Orb
|
|
4674
4677
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
4675
4678
|
# If unspecified, a single invoice is produced per billing cycle.
|
4676
4679
|
#
|
4677
|
-
# @return [Orb::PlanCreateParams::Price::MatrixWithDisplayName::InvoicingCycleConfiguration, nil]
|
4680
|
+
# @return [Orb::Models::PlanCreateParams::Price::MatrixWithDisplayName::InvoicingCycleConfiguration, nil]
|
4678
4681
|
optional :invoicing_cycle_configuration,
|
4679
4682
|
-> { Orb::PlanCreateParams::Price::MatrixWithDisplayName::InvoicingCycleConfiguration },
|
4680
4683
|
nil?: true
|
@@ -4689,9 +4692,9 @@ module Orb
|
|
4689
4692
|
|
4690
4693
|
# @!method initialize(cadence:, item_id:, matrix_with_display_name_config:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :matrix_with_display_name)
|
4691
4694
|
# Some parameter documentations has been truncated, see
|
4692
|
-
# {Orb::PlanCreateParams::Price::MatrixWithDisplayName} for more details.
|
4695
|
+
# {Orb::Models::PlanCreateParams::Price::MatrixWithDisplayName} for more details.
|
4693
4696
|
#
|
4694
|
-
# @param cadence [Symbol, Orb::PlanCreateParams::Price::MatrixWithDisplayName::Cadence] The cadence to bill for this price on.
|
4697
|
+
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::MatrixWithDisplayName::Cadence] The cadence to bill for this price on.
|
4695
4698
|
#
|
4696
4699
|
# @param item_id [String] The id of the item the price will be associated with.
|
4697
4700
|
#
|
@@ -4703,7 +4706,7 @@ module Orb
|
|
4703
4706
|
#
|
4704
4707
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
4705
4708
|
#
|
4706
|
-
# @param billing_cycle_configuration [Orb::PlanCreateParams::Price::MatrixWithDisplayName::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
4709
|
+
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::MatrixWithDisplayName::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
4707
4710
|
#
|
4708
4711
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
4709
4712
|
#
|
@@ -4715,7 +4718,7 @@ module Orb
|
|
4715
4718
|
#
|
4716
4719
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
4717
4720
|
#
|
4718
|
-
# @param invoicing_cycle_configuration [Orb::PlanCreateParams::Price::MatrixWithDisplayName::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
4721
|
+
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::MatrixWithDisplayName::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
4719
4722
|
#
|
4720
4723
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
4721
4724
|
#
|
@@ -4723,7 +4726,7 @@ module Orb
|
|
4723
4726
|
|
4724
4727
|
# The cadence to bill for this price on.
|
4725
4728
|
#
|
4726
|
-
# @see Orb::PlanCreateParams::Price::MatrixWithDisplayName#cadence
|
4729
|
+
# @see Orb::Models::PlanCreateParams::Price::MatrixWithDisplayName#cadence
|
4727
4730
|
module Cadence
|
4728
4731
|
extend Orb::Internal::Type::Enum
|
4729
4732
|
|
@@ -4738,7 +4741,7 @@ module Orb
|
|
4738
4741
|
# @return [Array<Symbol>]
|
4739
4742
|
end
|
4740
4743
|
|
4741
|
-
# @see Orb::PlanCreateParams::Price::MatrixWithDisplayName#billing_cycle_configuration
|
4744
|
+
# @see Orb::Models::PlanCreateParams::Price::MatrixWithDisplayName#billing_cycle_configuration
|
4742
4745
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
4743
4746
|
# @!attribute duration
|
4744
4747
|
# The duration of the billing period.
|
@@ -4749,7 +4752,7 @@ module Orb
|
|
4749
4752
|
# @!attribute duration_unit
|
4750
4753
|
# The unit of billing period duration.
|
4751
4754
|
#
|
4752
|
-
# @return [Symbol, Orb::PlanCreateParams::Price::MatrixWithDisplayName::BillingCycleConfiguration::DurationUnit]
|
4755
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::MatrixWithDisplayName::BillingCycleConfiguration::DurationUnit]
|
4753
4756
|
required :duration_unit,
|
4754
4757
|
enum: -> {
|
4755
4758
|
Orb::PlanCreateParams::Price::MatrixWithDisplayName::BillingCycleConfiguration::DurationUnit
|
@@ -4761,11 +4764,11 @@ module Orb
|
|
4761
4764
|
#
|
4762
4765
|
# @param duration [Integer] The duration of the billing period.
|
4763
4766
|
#
|
4764
|
-
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::MatrixWithDisplayName::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
4767
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::MatrixWithDisplayName::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
4765
4768
|
|
4766
4769
|
# The unit of billing period duration.
|
4767
4770
|
#
|
4768
|
-
# @see Orb::PlanCreateParams::Price::MatrixWithDisplayName::BillingCycleConfiguration#duration_unit
|
4771
|
+
# @see Orb::Models::PlanCreateParams::Price::MatrixWithDisplayName::BillingCycleConfiguration#duration_unit
|
4769
4772
|
module DurationUnit
|
4770
4773
|
extend Orb::Internal::Type::Enum
|
4771
4774
|
|
@@ -4777,7 +4780,7 @@ module Orb
|
|
4777
4780
|
end
|
4778
4781
|
end
|
4779
4782
|
|
4780
|
-
# @see Orb::PlanCreateParams::Price::MatrixWithDisplayName#invoicing_cycle_configuration
|
4783
|
+
# @see Orb::Models::PlanCreateParams::Price::MatrixWithDisplayName#invoicing_cycle_configuration
|
4781
4784
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
4782
4785
|
# @!attribute duration
|
4783
4786
|
# The duration of the billing period.
|
@@ -4788,7 +4791,7 @@ module Orb
|
|
4788
4791
|
# @!attribute duration_unit
|
4789
4792
|
# The unit of billing period duration.
|
4790
4793
|
#
|
4791
|
-
# @return [Symbol, Orb::PlanCreateParams::Price::MatrixWithDisplayName::InvoicingCycleConfiguration::DurationUnit]
|
4794
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::MatrixWithDisplayName::InvoicingCycleConfiguration::DurationUnit]
|
4792
4795
|
required :duration_unit,
|
4793
4796
|
enum: -> {
|
4794
4797
|
Orb::PlanCreateParams::Price::MatrixWithDisplayName::InvoicingCycleConfiguration::DurationUnit
|
@@ -4800,11 +4803,11 @@ module Orb
|
|
4800
4803
|
#
|
4801
4804
|
# @param duration [Integer] The duration of the billing period.
|
4802
4805
|
#
|
4803
|
-
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::MatrixWithDisplayName::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
4806
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::MatrixWithDisplayName::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
4804
4807
|
|
4805
4808
|
# The unit of billing period duration.
|
4806
4809
|
#
|
4807
|
-
# @see Orb::PlanCreateParams::Price::MatrixWithDisplayName::InvoicingCycleConfiguration#duration_unit
|
4810
|
+
# @see Orb::Models::PlanCreateParams::Price::MatrixWithDisplayName::InvoicingCycleConfiguration#duration_unit
|
4808
4811
|
module DurationUnit
|
4809
4812
|
extend Orb::Internal::Type::Enum
|
4810
4813
|
|
@@ -4826,7 +4829,7 @@ module Orb
|
|
4826
4829
|
# @!attribute cadence
|
4827
4830
|
# The cadence to bill for this price on.
|
4828
4831
|
#
|
4829
|
-
# @return [Symbol, Orb::PlanCreateParams::Price::BulkWithProration::Cadence]
|
4832
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::BulkWithProration::Cadence]
|
4830
4833
|
required :cadence, enum: -> { Orb::PlanCreateParams::Price::BulkWithProration::Cadence }
|
4831
4834
|
|
4832
4835
|
# @!attribute item_id
|
@@ -4864,7 +4867,7 @@ module Orb
|
|
4864
4867
|
# For custom cadence: specifies the duration of the billing period in days or
|
4865
4868
|
# months.
|
4866
4869
|
#
|
4867
|
-
# @return [Orb::PlanCreateParams::Price::BulkWithProration::BillingCycleConfiguration, nil]
|
4870
|
+
# @return [Orb::Models::PlanCreateParams::Price::BulkWithProration::BillingCycleConfiguration, nil]
|
4868
4871
|
optional :billing_cycle_configuration,
|
4869
4872
|
-> { Orb::PlanCreateParams::Price::BulkWithProration::BillingCycleConfiguration },
|
4870
4873
|
nil?: true
|
@@ -4905,7 +4908,7 @@ module Orb
|
|
4905
4908
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
4906
4909
|
# If unspecified, a single invoice is produced per billing cycle.
|
4907
4910
|
#
|
4908
|
-
# @return [Orb::PlanCreateParams::Price::BulkWithProration::InvoicingCycleConfiguration, nil]
|
4911
|
+
# @return [Orb::Models::PlanCreateParams::Price::BulkWithProration::InvoicingCycleConfiguration, nil]
|
4909
4912
|
optional :invoicing_cycle_configuration,
|
4910
4913
|
-> { Orb::PlanCreateParams::Price::BulkWithProration::InvoicingCycleConfiguration },
|
4911
4914
|
nil?: true
|
@@ -4920,11 +4923,11 @@ module Orb
|
|
4920
4923
|
|
4921
4924
|
# @!method initialize(bulk_with_proration_config:, cadence:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :bulk_with_proration)
|
4922
4925
|
# Some parameter documentations has been truncated, see
|
4923
|
-
# {Orb::PlanCreateParams::Price::BulkWithProration} for more details.
|
4926
|
+
# {Orb::Models::PlanCreateParams::Price::BulkWithProration} for more details.
|
4924
4927
|
#
|
4925
4928
|
# @param bulk_with_proration_config [Hash{Symbol=>Object}]
|
4926
4929
|
#
|
4927
|
-
# @param cadence [Symbol, Orb::PlanCreateParams::Price::BulkWithProration::Cadence] The cadence to bill for this price on.
|
4930
|
+
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::BulkWithProration::Cadence] The cadence to bill for this price on.
|
4928
4931
|
#
|
4929
4932
|
# @param item_id [String] The id of the item the price will be associated with.
|
4930
4933
|
#
|
@@ -4934,7 +4937,7 @@ module Orb
|
|
4934
4937
|
#
|
4935
4938
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
4936
4939
|
#
|
4937
|
-
# @param billing_cycle_configuration [Orb::PlanCreateParams::Price::BulkWithProration::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
4940
|
+
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::BulkWithProration::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
4938
4941
|
#
|
4939
4942
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
4940
4943
|
#
|
@@ -4946,7 +4949,7 @@ module Orb
|
|
4946
4949
|
#
|
4947
4950
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
4948
4951
|
#
|
4949
|
-
# @param invoicing_cycle_configuration [Orb::PlanCreateParams::Price::BulkWithProration::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
4952
|
+
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::BulkWithProration::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
4950
4953
|
#
|
4951
4954
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
4952
4955
|
#
|
@@ -4954,7 +4957,7 @@ module Orb
|
|
4954
4957
|
|
4955
4958
|
# The cadence to bill for this price on.
|
4956
4959
|
#
|
4957
|
-
# @see Orb::PlanCreateParams::Price::BulkWithProration#cadence
|
4960
|
+
# @see Orb::Models::PlanCreateParams::Price::BulkWithProration#cadence
|
4958
4961
|
module Cadence
|
4959
4962
|
extend Orb::Internal::Type::Enum
|
4960
4963
|
|
@@ -4969,7 +4972,7 @@ module Orb
|
|
4969
4972
|
# @return [Array<Symbol>]
|
4970
4973
|
end
|
4971
4974
|
|
4972
|
-
# @see Orb::PlanCreateParams::Price::BulkWithProration#billing_cycle_configuration
|
4975
|
+
# @see Orb::Models::PlanCreateParams::Price::BulkWithProration#billing_cycle_configuration
|
4973
4976
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
4974
4977
|
# @!attribute duration
|
4975
4978
|
# The duration of the billing period.
|
@@ -4980,7 +4983,7 @@ module Orb
|
|
4980
4983
|
# @!attribute duration_unit
|
4981
4984
|
# The unit of billing period duration.
|
4982
4985
|
#
|
4983
|
-
# @return [Symbol, Orb::PlanCreateParams::Price::BulkWithProration::BillingCycleConfiguration::DurationUnit]
|
4986
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::BulkWithProration::BillingCycleConfiguration::DurationUnit]
|
4984
4987
|
required :duration_unit,
|
4985
4988
|
enum: -> {
|
4986
4989
|
Orb::PlanCreateParams::Price::BulkWithProration::BillingCycleConfiguration::DurationUnit
|
@@ -4992,11 +4995,11 @@ module Orb
|
|
4992
4995
|
#
|
4993
4996
|
# @param duration [Integer] The duration of the billing period.
|
4994
4997
|
#
|
4995
|
-
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::BulkWithProration::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
4998
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::BulkWithProration::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
4996
4999
|
|
4997
5000
|
# The unit of billing period duration.
|
4998
5001
|
#
|
4999
|
-
# @see Orb::PlanCreateParams::Price::BulkWithProration::BillingCycleConfiguration#duration_unit
|
5002
|
+
# @see Orb::Models::PlanCreateParams::Price::BulkWithProration::BillingCycleConfiguration#duration_unit
|
5000
5003
|
module DurationUnit
|
5001
5004
|
extend Orb::Internal::Type::Enum
|
5002
5005
|
|
@@ -5008,7 +5011,7 @@ module Orb
|
|
5008
5011
|
end
|
5009
5012
|
end
|
5010
5013
|
|
5011
|
-
# @see Orb::PlanCreateParams::Price::BulkWithProration#invoicing_cycle_configuration
|
5014
|
+
# @see Orb::Models::PlanCreateParams::Price::BulkWithProration#invoicing_cycle_configuration
|
5012
5015
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
5013
5016
|
# @!attribute duration
|
5014
5017
|
# The duration of the billing period.
|
@@ -5019,7 +5022,7 @@ module Orb
|
|
5019
5022
|
# @!attribute duration_unit
|
5020
5023
|
# The unit of billing period duration.
|
5021
5024
|
#
|
5022
|
-
# @return [Symbol, Orb::PlanCreateParams::Price::BulkWithProration::InvoicingCycleConfiguration::DurationUnit]
|
5025
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::BulkWithProration::InvoicingCycleConfiguration::DurationUnit]
|
5023
5026
|
required :duration_unit,
|
5024
5027
|
enum: -> {
|
5025
5028
|
Orb::PlanCreateParams::Price::BulkWithProration::InvoicingCycleConfiguration::DurationUnit
|
@@ -5031,11 +5034,11 @@ module Orb
|
|
5031
5034
|
#
|
5032
5035
|
# @param duration [Integer] The duration of the billing period.
|
5033
5036
|
#
|
5034
|
-
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::BulkWithProration::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
5037
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::BulkWithProration::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
5035
5038
|
|
5036
5039
|
# The unit of billing period duration.
|
5037
5040
|
#
|
5038
|
-
# @see Orb::PlanCreateParams::Price::BulkWithProration::InvoicingCycleConfiguration#duration_unit
|
5041
|
+
# @see Orb::Models::PlanCreateParams::Price::BulkWithProration::InvoicingCycleConfiguration#duration_unit
|
5039
5042
|
module DurationUnit
|
5040
5043
|
extend Orb::Internal::Type::Enum
|
5041
5044
|
|
@@ -5052,7 +5055,7 @@ module Orb
|
|
5052
5055
|
# @!attribute cadence
|
5053
5056
|
# The cadence to bill for this price on.
|
5054
5057
|
#
|
5055
|
-
# @return [Symbol, Orb::PlanCreateParams::Price::GroupedTieredPackage::Cadence]
|
5058
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::GroupedTieredPackage::Cadence]
|
5056
5059
|
required :cadence, enum: -> { Orb::PlanCreateParams::Price::GroupedTieredPackage::Cadence }
|
5057
5060
|
|
5058
5061
|
# @!attribute grouped_tiered_package_config
|
@@ -5095,7 +5098,7 @@ module Orb
|
|
5095
5098
|
# For custom cadence: specifies the duration of the billing period in days or
|
5096
5099
|
# months.
|
5097
5100
|
#
|
5098
|
-
# @return [Orb::PlanCreateParams::Price::GroupedTieredPackage::BillingCycleConfiguration, nil]
|
5101
|
+
# @return [Orb::Models::PlanCreateParams::Price::GroupedTieredPackage::BillingCycleConfiguration, nil]
|
5099
5102
|
optional :billing_cycle_configuration,
|
5100
5103
|
-> { Orb::PlanCreateParams::Price::GroupedTieredPackage::BillingCycleConfiguration },
|
5101
5104
|
nil?: true
|
@@ -5136,7 +5139,7 @@ module Orb
|
|
5136
5139
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
5137
5140
|
# If unspecified, a single invoice is produced per billing cycle.
|
5138
5141
|
#
|
5139
|
-
# @return [Orb::PlanCreateParams::Price::GroupedTieredPackage::InvoicingCycleConfiguration, nil]
|
5142
|
+
# @return [Orb::Models::PlanCreateParams::Price::GroupedTieredPackage::InvoicingCycleConfiguration, nil]
|
5140
5143
|
optional :invoicing_cycle_configuration,
|
5141
5144
|
-> { Orb::PlanCreateParams::Price::GroupedTieredPackage::InvoicingCycleConfiguration },
|
5142
5145
|
nil?: true
|
@@ -5151,9 +5154,9 @@ module Orb
|
|
5151
5154
|
|
5152
5155
|
# @!method initialize(cadence:, grouped_tiered_package_config:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :grouped_tiered_package)
|
5153
5156
|
# Some parameter documentations has been truncated, see
|
5154
|
-
# {Orb::PlanCreateParams::Price::GroupedTieredPackage} for more details.
|
5157
|
+
# {Orb::Models::PlanCreateParams::Price::GroupedTieredPackage} for more details.
|
5155
5158
|
#
|
5156
|
-
# @param cadence [Symbol, Orb::PlanCreateParams::Price::GroupedTieredPackage::Cadence] The cadence to bill for this price on.
|
5159
|
+
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::GroupedTieredPackage::Cadence] The cadence to bill for this price on.
|
5157
5160
|
#
|
5158
5161
|
# @param grouped_tiered_package_config [Hash{Symbol=>Object}]
|
5159
5162
|
#
|
@@ -5165,7 +5168,7 @@ module Orb
|
|
5165
5168
|
#
|
5166
5169
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
5167
5170
|
#
|
5168
|
-
# @param billing_cycle_configuration [Orb::PlanCreateParams::Price::GroupedTieredPackage::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
5171
|
+
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::GroupedTieredPackage::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
5169
5172
|
#
|
5170
5173
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
5171
5174
|
#
|
@@ -5177,7 +5180,7 @@ module Orb
|
|
5177
5180
|
#
|
5178
5181
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
5179
5182
|
#
|
5180
|
-
# @param invoicing_cycle_configuration [Orb::PlanCreateParams::Price::GroupedTieredPackage::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
5183
|
+
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::GroupedTieredPackage::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
5181
5184
|
#
|
5182
5185
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
5183
5186
|
#
|
@@ -5185,7 +5188,7 @@ module Orb
|
|
5185
5188
|
|
5186
5189
|
# The cadence to bill for this price on.
|
5187
5190
|
#
|
5188
|
-
# @see Orb::PlanCreateParams::Price::GroupedTieredPackage#cadence
|
5191
|
+
# @see Orb::Models::PlanCreateParams::Price::GroupedTieredPackage#cadence
|
5189
5192
|
module Cadence
|
5190
5193
|
extend Orb::Internal::Type::Enum
|
5191
5194
|
|
@@ -5200,7 +5203,7 @@ module Orb
|
|
5200
5203
|
# @return [Array<Symbol>]
|
5201
5204
|
end
|
5202
5205
|
|
5203
|
-
# @see Orb::PlanCreateParams::Price::GroupedTieredPackage#billing_cycle_configuration
|
5206
|
+
# @see Orb::Models::PlanCreateParams::Price::GroupedTieredPackage#billing_cycle_configuration
|
5204
5207
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
5205
5208
|
# @!attribute duration
|
5206
5209
|
# The duration of the billing period.
|
@@ -5211,7 +5214,7 @@ module Orb
|
|
5211
5214
|
# @!attribute duration_unit
|
5212
5215
|
# The unit of billing period duration.
|
5213
5216
|
#
|
5214
|
-
# @return [Symbol, Orb::PlanCreateParams::Price::GroupedTieredPackage::BillingCycleConfiguration::DurationUnit]
|
5217
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::GroupedTieredPackage::BillingCycleConfiguration::DurationUnit]
|
5215
5218
|
required :duration_unit,
|
5216
5219
|
enum: -> {
|
5217
5220
|
Orb::PlanCreateParams::Price::GroupedTieredPackage::BillingCycleConfiguration::DurationUnit
|
@@ -5223,11 +5226,11 @@ module Orb
|
|
5223
5226
|
#
|
5224
5227
|
# @param duration [Integer] The duration of the billing period.
|
5225
5228
|
#
|
5226
|
-
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::GroupedTieredPackage::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
5229
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::GroupedTieredPackage::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
5227
5230
|
|
5228
5231
|
# The unit of billing period duration.
|
5229
5232
|
#
|
5230
|
-
# @see Orb::PlanCreateParams::Price::GroupedTieredPackage::BillingCycleConfiguration#duration_unit
|
5233
|
+
# @see Orb::Models::PlanCreateParams::Price::GroupedTieredPackage::BillingCycleConfiguration#duration_unit
|
5231
5234
|
module DurationUnit
|
5232
5235
|
extend Orb::Internal::Type::Enum
|
5233
5236
|
|
@@ -5239,7 +5242,7 @@ module Orb
|
|
5239
5242
|
end
|
5240
5243
|
end
|
5241
5244
|
|
5242
|
-
# @see Orb::PlanCreateParams::Price::GroupedTieredPackage#invoicing_cycle_configuration
|
5245
|
+
# @see Orb::Models::PlanCreateParams::Price::GroupedTieredPackage#invoicing_cycle_configuration
|
5243
5246
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
5244
5247
|
# @!attribute duration
|
5245
5248
|
# The duration of the billing period.
|
@@ -5250,7 +5253,7 @@ module Orb
|
|
5250
5253
|
# @!attribute duration_unit
|
5251
5254
|
# The unit of billing period duration.
|
5252
5255
|
#
|
5253
|
-
# @return [Symbol, Orb::PlanCreateParams::Price::GroupedTieredPackage::InvoicingCycleConfiguration::DurationUnit]
|
5256
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::GroupedTieredPackage::InvoicingCycleConfiguration::DurationUnit]
|
5254
5257
|
required :duration_unit,
|
5255
5258
|
enum: -> {
|
5256
5259
|
Orb::PlanCreateParams::Price::GroupedTieredPackage::InvoicingCycleConfiguration::DurationUnit
|
@@ -5262,11 +5265,11 @@ module Orb
|
|
5262
5265
|
#
|
5263
5266
|
# @param duration [Integer] The duration of the billing period.
|
5264
5267
|
#
|
5265
|
-
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::GroupedTieredPackage::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
5268
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::GroupedTieredPackage::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
5266
5269
|
|
5267
5270
|
# The unit of billing period duration.
|
5268
5271
|
#
|
5269
|
-
# @see Orb::PlanCreateParams::Price::GroupedTieredPackage::InvoicingCycleConfiguration#duration_unit
|
5272
|
+
# @see Orb::Models::PlanCreateParams::Price::GroupedTieredPackage::InvoicingCycleConfiguration#duration_unit
|
5270
5273
|
module DurationUnit
|
5271
5274
|
extend Orb::Internal::Type::Enum
|
5272
5275
|
|
@@ -5283,7 +5286,7 @@ module Orb
|
|
5283
5286
|
# @!attribute cadence
|
5284
5287
|
# The cadence to bill for this price on.
|
5285
5288
|
#
|
5286
|
-
# @return [Symbol, Orb::PlanCreateParams::Price::MaxGroupTieredPackage::Cadence]
|
5289
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::MaxGroupTieredPackage::Cadence]
|
5287
5290
|
required :cadence, enum: -> { Orb::PlanCreateParams::Price::MaxGroupTieredPackage::Cadence }
|
5288
5291
|
|
5289
5292
|
# @!attribute item_id
|
@@ -5326,7 +5329,7 @@ module Orb
|
|
5326
5329
|
# For custom cadence: specifies the duration of the billing period in days or
|
5327
5330
|
# months.
|
5328
5331
|
#
|
5329
|
-
# @return [Orb::PlanCreateParams::Price::MaxGroupTieredPackage::BillingCycleConfiguration, nil]
|
5332
|
+
# @return [Orb::Models::PlanCreateParams::Price::MaxGroupTieredPackage::BillingCycleConfiguration, nil]
|
5330
5333
|
optional :billing_cycle_configuration,
|
5331
5334
|
-> { Orb::PlanCreateParams::Price::MaxGroupTieredPackage::BillingCycleConfiguration },
|
5332
5335
|
nil?: true
|
@@ -5367,7 +5370,7 @@ module Orb
|
|
5367
5370
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
5368
5371
|
# If unspecified, a single invoice is produced per billing cycle.
|
5369
5372
|
#
|
5370
|
-
# @return [Orb::PlanCreateParams::Price::MaxGroupTieredPackage::InvoicingCycleConfiguration, nil]
|
5373
|
+
# @return [Orb::Models::PlanCreateParams::Price::MaxGroupTieredPackage::InvoicingCycleConfiguration, nil]
|
5371
5374
|
optional :invoicing_cycle_configuration,
|
5372
5375
|
-> { Orb::PlanCreateParams::Price::MaxGroupTieredPackage::InvoicingCycleConfiguration },
|
5373
5376
|
nil?: true
|
@@ -5382,9 +5385,9 @@ module Orb
|
|
5382
5385
|
|
5383
5386
|
# @!method initialize(cadence:, item_id:, max_group_tiered_package_config:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :max_group_tiered_package)
|
5384
5387
|
# Some parameter documentations has been truncated, see
|
5385
|
-
# {Orb::PlanCreateParams::Price::MaxGroupTieredPackage} for more details.
|
5388
|
+
# {Orb::Models::PlanCreateParams::Price::MaxGroupTieredPackage} for more details.
|
5386
5389
|
#
|
5387
|
-
# @param cadence [Symbol, Orb::PlanCreateParams::Price::MaxGroupTieredPackage::Cadence] The cadence to bill for this price on.
|
5390
|
+
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::MaxGroupTieredPackage::Cadence] The cadence to bill for this price on.
|
5388
5391
|
#
|
5389
5392
|
# @param item_id [String] The id of the item the price will be associated with.
|
5390
5393
|
#
|
@@ -5396,7 +5399,7 @@ module Orb
|
|
5396
5399
|
#
|
5397
5400
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
5398
5401
|
#
|
5399
|
-
# @param billing_cycle_configuration [Orb::PlanCreateParams::Price::MaxGroupTieredPackage::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
5402
|
+
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::MaxGroupTieredPackage::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
5400
5403
|
#
|
5401
5404
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
5402
5405
|
#
|
@@ -5408,7 +5411,7 @@ module Orb
|
|
5408
5411
|
#
|
5409
5412
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
5410
5413
|
#
|
5411
|
-
# @param invoicing_cycle_configuration [Orb::PlanCreateParams::Price::MaxGroupTieredPackage::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
5414
|
+
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::MaxGroupTieredPackage::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
5412
5415
|
#
|
5413
5416
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
5414
5417
|
#
|
@@ -5416,7 +5419,7 @@ module Orb
|
|
5416
5419
|
|
5417
5420
|
# The cadence to bill for this price on.
|
5418
5421
|
#
|
5419
|
-
# @see Orb::PlanCreateParams::Price::MaxGroupTieredPackage#cadence
|
5422
|
+
# @see Orb::Models::PlanCreateParams::Price::MaxGroupTieredPackage#cadence
|
5420
5423
|
module Cadence
|
5421
5424
|
extend Orb::Internal::Type::Enum
|
5422
5425
|
|
@@ -5431,7 +5434,7 @@ module Orb
|
|
5431
5434
|
# @return [Array<Symbol>]
|
5432
5435
|
end
|
5433
5436
|
|
5434
|
-
# @see Orb::PlanCreateParams::Price::MaxGroupTieredPackage#billing_cycle_configuration
|
5437
|
+
# @see Orb::Models::PlanCreateParams::Price::MaxGroupTieredPackage#billing_cycle_configuration
|
5435
5438
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
5436
5439
|
# @!attribute duration
|
5437
5440
|
# The duration of the billing period.
|
@@ -5442,7 +5445,7 @@ module Orb
|
|
5442
5445
|
# @!attribute duration_unit
|
5443
5446
|
# The unit of billing period duration.
|
5444
5447
|
#
|
5445
|
-
# @return [Symbol, Orb::PlanCreateParams::Price::MaxGroupTieredPackage::BillingCycleConfiguration::DurationUnit]
|
5448
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::MaxGroupTieredPackage::BillingCycleConfiguration::DurationUnit]
|
5446
5449
|
required :duration_unit,
|
5447
5450
|
enum: -> {
|
5448
5451
|
Orb::PlanCreateParams::Price::MaxGroupTieredPackage::BillingCycleConfiguration::DurationUnit
|
@@ -5454,11 +5457,11 @@ module Orb
|
|
5454
5457
|
#
|
5455
5458
|
# @param duration [Integer] The duration of the billing period.
|
5456
5459
|
#
|
5457
|
-
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::MaxGroupTieredPackage::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
5460
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::MaxGroupTieredPackage::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
5458
5461
|
|
5459
5462
|
# The unit of billing period duration.
|
5460
5463
|
#
|
5461
|
-
# @see Orb::PlanCreateParams::Price::MaxGroupTieredPackage::BillingCycleConfiguration#duration_unit
|
5464
|
+
# @see Orb::Models::PlanCreateParams::Price::MaxGroupTieredPackage::BillingCycleConfiguration#duration_unit
|
5462
5465
|
module DurationUnit
|
5463
5466
|
extend Orb::Internal::Type::Enum
|
5464
5467
|
|
@@ -5470,7 +5473,7 @@ module Orb
|
|
5470
5473
|
end
|
5471
5474
|
end
|
5472
5475
|
|
5473
|
-
# @see Orb::PlanCreateParams::Price::MaxGroupTieredPackage#invoicing_cycle_configuration
|
5476
|
+
# @see Orb::Models::PlanCreateParams::Price::MaxGroupTieredPackage#invoicing_cycle_configuration
|
5474
5477
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
5475
5478
|
# @!attribute duration
|
5476
5479
|
# The duration of the billing period.
|
@@ -5481,7 +5484,7 @@ module Orb
|
|
5481
5484
|
# @!attribute duration_unit
|
5482
5485
|
# The unit of billing period duration.
|
5483
5486
|
#
|
5484
|
-
# @return [Symbol, Orb::PlanCreateParams::Price::MaxGroupTieredPackage::InvoicingCycleConfiguration::DurationUnit]
|
5487
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::MaxGroupTieredPackage::InvoicingCycleConfiguration::DurationUnit]
|
5485
5488
|
required :duration_unit,
|
5486
5489
|
enum: -> {
|
5487
5490
|
Orb::PlanCreateParams::Price::MaxGroupTieredPackage::InvoicingCycleConfiguration::DurationUnit
|
@@ -5493,11 +5496,11 @@ module Orb
|
|
5493
5496
|
#
|
5494
5497
|
# @param duration [Integer] The duration of the billing period.
|
5495
5498
|
#
|
5496
|
-
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::MaxGroupTieredPackage::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
5499
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::MaxGroupTieredPackage::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
5497
5500
|
|
5498
5501
|
# The unit of billing period duration.
|
5499
5502
|
#
|
5500
|
-
# @see Orb::PlanCreateParams::Price::MaxGroupTieredPackage::InvoicingCycleConfiguration#duration_unit
|
5503
|
+
# @see Orb::Models::PlanCreateParams::Price::MaxGroupTieredPackage::InvoicingCycleConfiguration#duration_unit
|
5501
5504
|
module DurationUnit
|
5502
5505
|
extend Orb::Internal::Type::Enum
|
5503
5506
|
|
@@ -5514,7 +5517,7 @@ module Orb
|
|
5514
5517
|
# @!attribute cadence
|
5515
5518
|
# The cadence to bill for this price on.
|
5516
5519
|
#
|
5517
|
-
# @return [Symbol, Orb::PlanCreateParams::Price::ScalableMatrixWithUnitPricing::Cadence]
|
5520
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::ScalableMatrixWithUnitPricing::Cadence]
|
5518
5521
|
required :cadence, enum: -> { Orb::PlanCreateParams::Price::ScalableMatrixWithUnitPricing::Cadence }
|
5519
5522
|
|
5520
5523
|
# @!attribute item_id
|
@@ -5558,7 +5561,7 @@ module Orb
|
|
5558
5561
|
# For custom cadence: specifies the duration of the billing period in days or
|
5559
5562
|
# months.
|
5560
5563
|
#
|
5561
|
-
# @return [Orb::PlanCreateParams::Price::ScalableMatrixWithUnitPricing::BillingCycleConfiguration, nil]
|
5564
|
+
# @return [Orb::Models::PlanCreateParams::Price::ScalableMatrixWithUnitPricing::BillingCycleConfiguration, nil]
|
5562
5565
|
optional :billing_cycle_configuration,
|
5563
5566
|
-> {
|
5564
5567
|
Orb::PlanCreateParams::Price::ScalableMatrixWithUnitPricing::BillingCycleConfiguration
|
@@ -5601,7 +5604,7 @@ module Orb
|
|
5601
5604
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
5602
5605
|
# If unspecified, a single invoice is produced per billing cycle.
|
5603
5606
|
#
|
5604
|
-
# @return [Orb::PlanCreateParams::Price::ScalableMatrixWithUnitPricing::InvoicingCycleConfiguration, nil]
|
5607
|
+
# @return [Orb::Models::PlanCreateParams::Price::ScalableMatrixWithUnitPricing::InvoicingCycleConfiguration, nil]
|
5605
5608
|
optional :invoicing_cycle_configuration,
|
5606
5609
|
-> {
|
5607
5610
|
Orb::PlanCreateParams::Price::ScalableMatrixWithUnitPricing::InvoicingCycleConfiguration
|
@@ -5618,9 +5621,10 @@ module Orb
|
|
5618
5621
|
|
5619
5622
|
# @!method initialize(cadence:, item_id:, name:, scalable_matrix_with_unit_pricing_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :scalable_matrix_with_unit_pricing)
|
5620
5623
|
# Some parameter documentations has been truncated, see
|
5621
|
-
# {Orb::PlanCreateParams::Price::ScalableMatrixWithUnitPricing} for more
|
5624
|
+
# {Orb::Models::PlanCreateParams::Price::ScalableMatrixWithUnitPricing} for more
|
5625
|
+
# details.
|
5622
5626
|
#
|
5623
|
-
# @param cadence [Symbol, Orb::PlanCreateParams::Price::ScalableMatrixWithUnitPricing::Cadence] The cadence to bill for this price on.
|
5627
|
+
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::ScalableMatrixWithUnitPricing::Cadence] The cadence to bill for this price on.
|
5624
5628
|
#
|
5625
5629
|
# @param item_id [String] The id of the item the price will be associated with.
|
5626
5630
|
#
|
@@ -5632,7 +5636,7 @@ module Orb
|
|
5632
5636
|
#
|
5633
5637
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
5634
5638
|
#
|
5635
|
-
# @param billing_cycle_configuration [Orb::PlanCreateParams::Price::ScalableMatrixWithUnitPricing::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
5639
|
+
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::ScalableMatrixWithUnitPricing::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
5636
5640
|
#
|
5637
5641
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
5638
5642
|
#
|
@@ -5644,7 +5648,7 @@ module Orb
|
|
5644
5648
|
#
|
5645
5649
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
5646
5650
|
#
|
5647
|
-
# @param invoicing_cycle_configuration [Orb::PlanCreateParams::Price::ScalableMatrixWithUnitPricing::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
5651
|
+
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::ScalableMatrixWithUnitPricing::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
5648
5652
|
#
|
5649
5653
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
5650
5654
|
#
|
@@ -5652,7 +5656,7 @@ module Orb
|
|
5652
5656
|
|
5653
5657
|
# The cadence to bill for this price on.
|
5654
5658
|
#
|
5655
|
-
# @see Orb::PlanCreateParams::Price::ScalableMatrixWithUnitPricing#cadence
|
5659
|
+
# @see Orb::Models::PlanCreateParams::Price::ScalableMatrixWithUnitPricing#cadence
|
5656
5660
|
module Cadence
|
5657
5661
|
extend Orb::Internal::Type::Enum
|
5658
5662
|
|
@@ -5667,7 +5671,7 @@ module Orb
|
|
5667
5671
|
# @return [Array<Symbol>]
|
5668
5672
|
end
|
5669
5673
|
|
5670
|
-
# @see Orb::PlanCreateParams::Price::ScalableMatrixWithUnitPricing#billing_cycle_configuration
|
5674
|
+
# @see Orb::Models::PlanCreateParams::Price::ScalableMatrixWithUnitPricing#billing_cycle_configuration
|
5671
5675
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
5672
5676
|
# @!attribute duration
|
5673
5677
|
# The duration of the billing period.
|
@@ -5678,7 +5682,7 @@ module Orb
|
|
5678
5682
|
# @!attribute duration_unit
|
5679
5683
|
# The unit of billing period duration.
|
5680
5684
|
#
|
5681
|
-
# @return [Symbol, Orb::PlanCreateParams::Price::ScalableMatrixWithUnitPricing::BillingCycleConfiguration::DurationUnit]
|
5685
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::ScalableMatrixWithUnitPricing::BillingCycleConfiguration::DurationUnit]
|
5682
5686
|
required :duration_unit,
|
5683
5687
|
enum: -> {
|
5684
5688
|
Orb::PlanCreateParams::Price::ScalableMatrixWithUnitPricing::BillingCycleConfiguration::DurationUnit
|
@@ -5690,11 +5694,11 @@ module Orb
|
|
5690
5694
|
#
|
5691
5695
|
# @param duration [Integer] The duration of the billing period.
|
5692
5696
|
#
|
5693
|
-
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::ScalableMatrixWithUnitPricing::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
5697
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::ScalableMatrixWithUnitPricing::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
5694
5698
|
|
5695
5699
|
# The unit of billing period duration.
|
5696
5700
|
#
|
5697
|
-
# @see Orb::PlanCreateParams::Price::ScalableMatrixWithUnitPricing::BillingCycleConfiguration#duration_unit
|
5701
|
+
# @see Orb::Models::PlanCreateParams::Price::ScalableMatrixWithUnitPricing::BillingCycleConfiguration#duration_unit
|
5698
5702
|
module DurationUnit
|
5699
5703
|
extend Orb::Internal::Type::Enum
|
5700
5704
|
|
@@ -5706,7 +5710,7 @@ module Orb
|
|
5706
5710
|
end
|
5707
5711
|
end
|
5708
5712
|
|
5709
|
-
# @see Orb::PlanCreateParams::Price::ScalableMatrixWithUnitPricing#invoicing_cycle_configuration
|
5713
|
+
# @see Orb::Models::PlanCreateParams::Price::ScalableMatrixWithUnitPricing#invoicing_cycle_configuration
|
5710
5714
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
5711
5715
|
# @!attribute duration
|
5712
5716
|
# The duration of the billing period.
|
@@ -5717,7 +5721,7 @@ module Orb
|
|
5717
5721
|
# @!attribute duration_unit
|
5718
5722
|
# The unit of billing period duration.
|
5719
5723
|
#
|
5720
|
-
# @return [Symbol, Orb::PlanCreateParams::Price::ScalableMatrixWithUnitPricing::InvoicingCycleConfiguration::DurationUnit]
|
5724
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::ScalableMatrixWithUnitPricing::InvoicingCycleConfiguration::DurationUnit]
|
5721
5725
|
required :duration_unit,
|
5722
5726
|
enum: -> {
|
5723
5727
|
Orb::PlanCreateParams::Price::ScalableMatrixWithUnitPricing::InvoicingCycleConfiguration::DurationUnit
|
@@ -5729,11 +5733,11 @@ module Orb
|
|
5729
5733
|
#
|
5730
5734
|
# @param duration [Integer] The duration of the billing period.
|
5731
5735
|
#
|
5732
|
-
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::ScalableMatrixWithUnitPricing::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
5736
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::ScalableMatrixWithUnitPricing::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
5733
5737
|
|
5734
5738
|
# The unit of billing period duration.
|
5735
5739
|
#
|
5736
|
-
# @see Orb::PlanCreateParams::Price::ScalableMatrixWithUnitPricing::InvoicingCycleConfiguration#duration_unit
|
5740
|
+
# @see Orb::Models::PlanCreateParams::Price::ScalableMatrixWithUnitPricing::InvoicingCycleConfiguration#duration_unit
|
5737
5741
|
module DurationUnit
|
5738
5742
|
extend Orb::Internal::Type::Enum
|
5739
5743
|
|
@@ -5750,7 +5754,7 @@ module Orb
|
|
5750
5754
|
# @!attribute cadence
|
5751
5755
|
# The cadence to bill for this price on.
|
5752
5756
|
#
|
5753
|
-
# @return [Symbol, Orb::PlanCreateParams::Price::ScalableMatrixWithTieredPricing::Cadence]
|
5757
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::ScalableMatrixWithTieredPricing::Cadence]
|
5754
5758
|
required :cadence,
|
5755
5759
|
enum: -> {
|
5756
5760
|
Orb::PlanCreateParams::Price::ScalableMatrixWithTieredPricing::Cadence
|
@@ -5797,7 +5801,7 @@ module Orb
|
|
5797
5801
|
# For custom cadence: specifies the duration of the billing period in days or
|
5798
5802
|
# months.
|
5799
5803
|
#
|
5800
|
-
# @return [Orb::PlanCreateParams::Price::ScalableMatrixWithTieredPricing::BillingCycleConfiguration, nil]
|
5804
|
+
# @return [Orb::Models::PlanCreateParams::Price::ScalableMatrixWithTieredPricing::BillingCycleConfiguration, nil]
|
5801
5805
|
optional :billing_cycle_configuration,
|
5802
5806
|
-> {
|
5803
5807
|
Orb::PlanCreateParams::Price::ScalableMatrixWithTieredPricing::BillingCycleConfiguration
|
@@ -5840,7 +5844,7 @@ module Orb
|
|
5840
5844
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
5841
5845
|
# If unspecified, a single invoice is produced per billing cycle.
|
5842
5846
|
#
|
5843
|
-
# @return [Orb::PlanCreateParams::Price::ScalableMatrixWithTieredPricing::InvoicingCycleConfiguration, nil]
|
5847
|
+
# @return [Orb::Models::PlanCreateParams::Price::ScalableMatrixWithTieredPricing::InvoicingCycleConfiguration, nil]
|
5844
5848
|
optional :invoicing_cycle_configuration,
|
5845
5849
|
-> {
|
5846
5850
|
Orb::PlanCreateParams::Price::ScalableMatrixWithTieredPricing::InvoicingCycleConfiguration
|
@@ -5857,10 +5861,10 @@ module Orb
|
|
5857
5861
|
|
5858
5862
|
# @!method initialize(cadence:, item_id:, name:, scalable_matrix_with_tiered_pricing_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :scalable_matrix_with_tiered_pricing)
|
5859
5863
|
# Some parameter documentations has been truncated, see
|
5860
|
-
# {Orb::PlanCreateParams::Price::ScalableMatrixWithTieredPricing} for more
|
5864
|
+
# {Orb::Models::PlanCreateParams::Price::ScalableMatrixWithTieredPricing} for more
|
5861
5865
|
# details.
|
5862
5866
|
#
|
5863
|
-
# @param cadence [Symbol, Orb::PlanCreateParams::Price::ScalableMatrixWithTieredPricing::Cadence] The cadence to bill for this price on.
|
5867
|
+
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::ScalableMatrixWithTieredPricing::Cadence] The cadence to bill for this price on.
|
5864
5868
|
#
|
5865
5869
|
# @param item_id [String] The id of the item the price will be associated with.
|
5866
5870
|
#
|
@@ -5872,7 +5876,7 @@ module Orb
|
|
5872
5876
|
#
|
5873
5877
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
5874
5878
|
#
|
5875
|
-
# @param billing_cycle_configuration [Orb::PlanCreateParams::Price::ScalableMatrixWithTieredPricing::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
5879
|
+
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::ScalableMatrixWithTieredPricing::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
5876
5880
|
#
|
5877
5881
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
5878
5882
|
#
|
@@ -5884,7 +5888,7 @@ module Orb
|
|
5884
5888
|
#
|
5885
5889
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
5886
5890
|
#
|
5887
|
-
# @param invoicing_cycle_configuration [Orb::PlanCreateParams::Price::ScalableMatrixWithTieredPricing::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
5891
|
+
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::ScalableMatrixWithTieredPricing::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
5888
5892
|
#
|
5889
5893
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
5890
5894
|
#
|
@@ -5892,7 +5896,7 @@ module Orb
|
|
5892
5896
|
|
5893
5897
|
# The cadence to bill for this price on.
|
5894
5898
|
#
|
5895
|
-
# @see Orb::PlanCreateParams::Price::ScalableMatrixWithTieredPricing#cadence
|
5899
|
+
# @see Orb::Models::PlanCreateParams::Price::ScalableMatrixWithTieredPricing#cadence
|
5896
5900
|
module Cadence
|
5897
5901
|
extend Orb::Internal::Type::Enum
|
5898
5902
|
|
@@ -5907,7 +5911,7 @@ module Orb
|
|
5907
5911
|
# @return [Array<Symbol>]
|
5908
5912
|
end
|
5909
5913
|
|
5910
|
-
# @see Orb::PlanCreateParams::Price::ScalableMatrixWithTieredPricing#billing_cycle_configuration
|
5914
|
+
# @see Orb::Models::PlanCreateParams::Price::ScalableMatrixWithTieredPricing#billing_cycle_configuration
|
5911
5915
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
5912
5916
|
# @!attribute duration
|
5913
5917
|
# The duration of the billing period.
|
@@ -5918,7 +5922,7 @@ module Orb
|
|
5918
5922
|
# @!attribute duration_unit
|
5919
5923
|
# The unit of billing period duration.
|
5920
5924
|
#
|
5921
|
-
# @return [Symbol, Orb::PlanCreateParams::Price::ScalableMatrixWithTieredPricing::BillingCycleConfiguration::DurationUnit]
|
5925
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::ScalableMatrixWithTieredPricing::BillingCycleConfiguration::DurationUnit]
|
5922
5926
|
required :duration_unit,
|
5923
5927
|
enum: -> {
|
5924
5928
|
Orb::PlanCreateParams::Price::ScalableMatrixWithTieredPricing::BillingCycleConfiguration::DurationUnit
|
@@ -5930,11 +5934,11 @@ module Orb
|
|
5930
5934
|
#
|
5931
5935
|
# @param duration [Integer] The duration of the billing period.
|
5932
5936
|
#
|
5933
|
-
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::ScalableMatrixWithTieredPricing::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
5937
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::ScalableMatrixWithTieredPricing::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
5934
5938
|
|
5935
5939
|
# The unit of billing period duration.
|
5936
5940
|
#
|
5937
|
-
# @see Orb::PlanCreateParams::Price::ScalableMatrixWithTieredPricing::BillingCycleConfiguration#duration_unit
|
5941
|
+
# @see Orb::Models::PlanCreateParams::Price::ScalableMatrixWithTieredPricing::BillingCycleConfiguration#duration_unit
|
5938
5942
|
module DurationUnit
|
5939
5943
|
extend Orb::Internal::Type::Enum
|
5940
5944
|
|
@@ -5946,7 +5950,7 @@ module Orb
|
|
5946
5950
|
end
|
5947
5951
|
end
|
5948
5952
|
|
5949
|
-
# @see Orb::PlanCreateParams::Price::ScalableMatrixWithTieredPricing#invoicing_cycle_configuration
|
5953
|
+
# @see Orb::Models::PlanCreateParams::Price::ScalableMatrixWithTieredPricing#invoicing_cycle_configuration
|
5950
5954
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
5951
5955
|
# @!attribute duration
|
5952
5956
|
# The duration of the billing period.
|
@@ -5957,7 +5961,7 @@ module Orb
|
|
5957
5961
|
# @!attribute duration_unit
|
5958
5962
|
# The unit of billing period duration.
|
5959
5963
|
#
|
5960
|
-
# @return [Symbol, Orb::PlanCreateParams::Price::ScalableMatrixWithTieredPricing::InvoicingCycleConfiguration::DurationUnit]
|
5964
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::ScalableMatrixWithTieredPricing::InvoicingCycleConfiguration::DurationUnit]
|
5961
5965
|
required :duration_unit,
|
5962
5966
|
enum: -> {
|
5963
5967
|
Orb::PlanCreateParams::Price::ScalableMatrixWithTieredPricing::InvoicingCycleConfiguration::DurationUnit
|
@@ -5969,11 +5973,11 @@ module Orb
|
|
5969
5973
|
#
|
5970
5974
|
# @param duration [Integer] The duration of the billing period.
|
5971
5975
|
#
|
5972
|
-
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::ScalableMatrixWithTieredPricing::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
5976
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::ScalableMatrixWithTieredPricing::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
5973
5977
|
|
5974
5978
|
# The unit of billing period duration.
|
5975
5979
|
#
|
5976
|
-
# @see Orb::PlanCreateParams::Price::ScalableMatrixWithTieredPricing::InvoicingCycleConfiguration#duration_unit
|
5980
|
+
# @see Orb::Models::PlanCreateParams::Price::ScalableMatrixWithTieredPricing::InvoicingCycleConfiguration#duration_unit
|
5977
5981
|
module DurationUnit
|
5978
5982
|
extend Orb::Internal::Type::Enum
|
5979
5983
|
|
@@ -5990,7 +5994,7 @@ module Orb
|
|
5990
5994
|
# @!attribute cadence
|
5991
5995
|
# The cadence to bill for this price on.
|
5992
5996
|
#
|
5993
|
-
# @return [Symbol, Orb::PlanCreateParams::Price::CumulativeGroupedBulk::Cadence]
|
5997
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::CumulativeGroupedBulk::Cadence]
|
5994
5998
|
required :cadence, enum: -> { Orb::PlanCreateParams::Price::CumulativeGroupedBulk::Cadence }
|
5995
5999
|
|
5996
6000
|
# @!attribute cumulative_grouped_bulk_config
|
@@ -6033,7 +6037,7 @@ module Orb
|
|
6033
6037
|
# For custom cadence: specifies the duration of the billing period in days or
|
6034
6038
|
# months.
|
6035
6039
|
#
|
6036
|
-
# @return [Orb::PlanCreateParams::Price::CumulativeGroupedBulk::BillingCycleConfiguration, nil]
|
6040
|
+
# @return [Orb::Models::PlanCreateParams::Price::CumulativeGroupedBulk::BillingCycleConfiguration, nil]
|
6037
6041
|
optional :billing_cycle_configuration,
|
6038
6042
|
-> { Orb::PlanCreateParams::Price::CumulativeGroupedBulk::BillingCycleConfiguration },
|
6039
6043
|
nil?: true
|
@@ -6074,7 +6078,7 @@ module Orb
|
|
6074
6078
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
6075
6079
|
# If unspecified, a single invoice is produced per billing cycle.
|
6076
6080
|
#
|
6077
|
-
# @return [Orb::PlanCreateParams::Price::CumulativeGroupedBulk::InvoicingCycleConfiguration, nil]
|
6081
|
+
# @return [Orb::Models::PlanCreateParams::Price::CumulativeGroupedBulk::InvoicingCycleConfiguration, nil]
|
6078
6082
|
optional :invoicing_cycle_configuration,
|
6079
6083
|
-> { Orb::PlanCreateParams::Price::CumulativeGroupedBulk::InvoicingCycleConfiguration },
|
6080
6084
|
nil?: true
|
@@ -6089,9 +6093,9 @@ module Orb
|
|
6089
6093
|
|
6090
6094
|
# @!method initialize(cadence:, cumulative_grouped_bulk_config:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :cumulative_grouped_bulk)
|
6091
6095
|
# Some parameter documentations has been truncated, see
|
6092
|
-
# {Orb::PlanCreateParams::Price::CumulativeGroupedBulk} for more details.
|
6096
|
+
# {Orb::Models::PlanCreateParams::Price::CumulativeGroupedBulk} for more details.
|
6093
6097
|
#
|
6094
|
-
# @param cadence [Symbol, Orb::PlanCreateParams::Price::CumulativeGroupedBulk::Cadence] The cadence to bill for this price on.
|
6098
|
+
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::CumulativeGroupedBulk::Cadence] The cadence to bill for this price on.
|
6095
6099
|
#
|
6096
6100
|
# @param cumulative_grouped_bulk_config [Hash{Symbol=>Object}]
|
6097
6101
|
#
|
@@ -6103,7 +6107,7 @@ module Orb
|
|
6103
6107
|
#
|
6104
6108
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
6105
6109
|
#
|
6106
|
-
# @param billing_cycle_configuration [Orb::PlanCreateParams::Price::CumulativeGroupedBulk::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
6110
|
+
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::CumulativeGroupedBulk::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
6107
6111
|
#
|
6108
6112
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
6109
6113
|
#
|
@@ -6115,7 +6119,7 @@ module Orb
|
|
6115
6119
|
#
|
6116
6120
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
6117
6121
|
#
|
6118
|
-
# @param invoicing_cycle_configuration [Orb::PlanCreateParams::Price::CumulativeGroupedBulk::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
6122
|
+
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::CumulativeGroupedBulk::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
6119
6123
|
#
|
6120
6124
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
6121
6125
|
#
|
@@ -6123,7 +6127,7 @@ module Orb
|
|
6123
6127
|
|
6124
6128
|
# The cadence to bill for this price on.
|
6125
6129
|
#
|
6126
|
-
# @see Orb::PlanCreateParams::Price::CumulativeGroupedBulk#cadence
|
6130
|
+
# @see Orb::Models::PlanCreateParams::Price::CumulativeGroupedBulk#cadence
|
6127
6131
|
module Cadence
|
6128
6132
|
extend Orb::Internal::Type::Enum
|
6129
6133
|
|
@@ -6138,7 +6142,7 @@ module Orb
|
|
6138
6142
|
# @return [Array<Symbol>]
|
6139
6143
|
end
|
6140
6144
|
|
6141
|
-
# @see Orb::PlanCreateParams::Price::CumulativeGroupedBulk#billing_cycle_configuration
|
6145
|
+
# @see Orb::Models::PlanCreateParams::Price::CumulativeGroupedBulk#billing_cycle_configuration
|
6142
6146
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
6143
6147
|
# @!attribute duration
|
6144
6148
|
# The duration of the billing period.
|
@@ -6149,7 +6153,7 @@ module Orb
|
|
6149
6153
|
# @!attribute duration_unit
|
6150
6154
|
# The unit of billing period duration.
|
6151
6155
|
#
|
6152
|
-
# @return [Symbol, Orb::PlanCreateParams::Price::CumulativeGroupedBulk::BillingCycleConfiguration::DurationUnit]
|
6156
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::CumulativeGroupedBulk::BillingCycleConfiguration::DurationUnit]
|
6153
6157
|
required :duration_unit,
|
6154
6158
|
enum: -> {
|
6155
6159
|
Orb::PlanCreateParams::Price::CumulativeGroupedBulk::BillingCycleConfiguration::DurationUnit
|
@@ -6161,11 +6165,11 @@ module Orb
|
|
6161
6165
|
#
|
6162
6166
|
# @param duration [Integer] The duration of the billing period.
|
6163
6167
|
#
|
6164
|
-
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::CumulativeGroupedBulk::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
6168
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::CumulativeGroupedBulk::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
6165
6169
|
|
6166
6170
|
# The unit of billing period duration.
|
6167
6171
|
#
|
6168
|
-
# @see Orb::PlanCreateParams::Price::CumulativeGroupedBulk::BillingCycleConfiguration#duration_unit
|
6172
|
+
# @see Orb::Models::PlanCreateParams::Price::CumulativeGroupedBulk::BillingCycleConfiguration#duration_unit
|
6169
6173
|
module DurationUnit
|
6170
6174
|
extend Orb::Internal::Type::Enum
|
6171
6175
|
|
@@ -6177,7 +6181,7 @@ module Orb
|
|
6177
6181
|
end
|
6178
6182
|
end
|
6179
6183
|
|
6180
|
-
# @see Orb::PlanCreateParams::Price::CumulativeGroupedBulk#invoicing_cycle_configuration
|
6184
|
+
# @see Orb::Models::PlanCreateParams::Price::CumulativeGroupedBulk#invoicing_cycle_configuration
|
6181
6185
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
6182
6186
|
# @!attribute duration
|
6183
6187
|
# The duration of the billing period.
|
@@ -6188,7 +6192,7 @@ module Orb
|
|
6188
6192
|
# @!attribute duration_unit
|
6189
6193
|
# The unit of billing period duration.
|
6190
6194
|
#
|
6191
|
-
# @return [Symbol, Orb::PlanCreateParams::Price::CumulativeGroupedBulk::InvoicingCycleConfiguration::DurationUnit]
|
6195
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::CumulativeGroupedBulk::InvoicingCycleConfiguration::DurationUnit]
|
6192
6196
|
required :duration_unit,
|
6193
6197
|
enum: -> {
|
6194
6198
|
Orb::PlanCreateParams::Price::CumulativeGroupedBulk::InvoicingCycleConfiguration::DurationUnit
|
@@ -6200,11 +6204,11 @@ module Orb
|
|
6200
6204
|
#
|
6201
6205
|
# @param duration [Integer] The duration of the billing period.
|
6202
6206
|
#
|
6203
|
-
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::CumulativeGroupedBulk::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
6207
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::CumulativeGroupedBulk::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
6204
6208
|
|
6205
6209
|
# The unit of billing period duration.
|
6206
6210
|
#
|
6207
|
-
# @see Orb::PlanCreateParams::Price::CumulativeGroupedBulk::InvoicingCycleConfiguration#duration_unit
|
6211
|
+
# @see Orb::Models::PlanCreateParams::Price::CumulativeGroupedBulk::InvoicingCycleConfiguration#duration_unit
|
6208
6212
|
module DurationUnit
|
6209
6213
|
extend Orb::Internal::Type::Enum
|
6210
6214
|
|
@@ -6218,7 +6222,7 @@ module Orb
|
|
6218
6222
|
end
|
6219
6223
|
|
6220
6224
|
# @!method self.variants
|
6221
|
-
# @return [Array(Orb::PlanCreateParams::Price::Unit, Orb::PlanCreateParams::Price::Package, Orb::PlanCreateParams::Price::Matrix, Orb::PlanCreateParams::Price::Tiered, Orb::PlanCreateParams::Price::TieredBps, Orb::PlanCreateParams::Price::Bps, Orb::PlanCreateParams::Price::BulkBps, Orb::PlanCreateParams::Price::Bulk, Orb::PlanCreateParams::Price::ThresholdTotalAmount, Orb::PlanCreateParams::Price::TieredPackage, Orb::PlanCreateParams::Price::TieredWithMinimum, Orb::PlanCreateParams::Price::UnitWithPercent, Orb::PlanCreateParams::Price::PackageWithAllocation, Orb::PlanCreateParams::Price::TieredWithProration, Orb::PlanCreateParams::Price::UnitWithProration, Orb::PlanCreateParams::Price::GroupedAllocation, Orb::PlanCreateParams::Price::GroupedWithProratedMinimum, Orb::PlanCreateParams::Price::GroupedWithMeteredMinimum, Orb::PlanCreateParams::Price::MatrixWithDisplayName, Orb::PlanCreateParams::Price::BulkWithProration, Orb::PlanCreateParams::Price::GroupedTieredPackage, Orb::PlanCreateParams::Price::MaxGroupTieredPackage, Orb::PlanCreateParams::Price::ScalableMatrixWithUnitPricing, Orb::PlanCreateParams::Price::ScalableMatrixWithTieredPricing, Orb::PlanCreateParams::Price::CumulativeGroupedBulk)]
|
6225
|
+
# @return [Array(Orb::Models::PlanCreateParams::Price::Unit, Orb::Models::PlanCreateParams::Price::Package, Orb::Models::PlanCreateParams::Price::Matrix, Orb::Models::PlanCreateParams::Price::Tiered, Orb::Models::PlanCreateParams::Price::TieredBps, Orb::Models::PlanCreateParams::Price::Bps, Orb::Models::PlanCreateParams::Price::BulkBps, Orb::Models::PlanCreateParams::Price::Bulk, Orb::Models::PlanCreateParams::Price::ThresholdTotalAmount, Orb::Models::PlanCreateParams::Price::TieredPackage, Orb::Models::PlanCreateParams::Price::TieredWithMinimum, Orb::Models::PlanCreateParams::Price::UnitWithPercent, Orb::Models::PlanCreateParams::Price::PackageWithAllocation, Orb::Models::PlanCreateParams::Price::TieredWithProration, Orb::Models::PlanCreateParams::Price::UnitWithProration, Orb::Models::PlanCreateParams::Price::GroupedAllocation, Orb::Models::PlanCreateParams::Price::GroupedWithProratedMinimum, Orb::Models::PlanCreateParams::Price::GroupedWithMeteredMinimum, Orb::Models::PlanCreateParams::Price::MatrixWithDisplayName, Orb::Models::PlanCreateParams::Price::BulkWithProration, Orb::Models::PlanCreateParams::Price::GroupedTieredPackage, Orb::Models::PlanCreateParams::Price::MaxGroupTieredPackage, Orb::Models::PlanCreateParams::Price::ScalableMatrixWithUnitPricing, Orb::Models::PlanCreateParams::Price::ScalableMatrixWithTieredPricing, Orb::Models::PlanCreateParams::Price::CumulativeGroupedBulk)]
|
6222
6226
|
end
|
6223
6227
|
|
6224
6228
|
# The status of the plan to create (either active or draft). If not specified,
|