orb-billing 0.5.1 → 0.5.3
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 +26 -0
- data/README.md +4 -4
- data/SECURITY.md +2 -2
- data/lib/orb/internal/type/array_of.rb +8 -0
- data/lib/orb/internal/type/base_model.rb +7 -0
- data/lib/orb/internal/type/boolean.rb +8 -0
- data/lib/orb/internal/type/enum.rb +12 -0
- data/lib/orb/internal/type/file_input.rb +7 -0
- data/lib/orb/internal/type/hash_of.rb +8 -0
- data/lib/orb/internal/type/union.rb +12 -0
- data/lib/orb/internal/type/unknown.rb +8 -0
- data/lib/orb/internal/util.rb +45 -0
- 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 -10
- data/lib/orb/models/coupon_create_params.rb +3 -9
- 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 -35
- data/lib/orb/models/customer_update_by_external_id_params.rb +26 -35
- data/lib/orb/models/customer_update_params.rb +26 -35
- 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_by_external_id_response.rb +0 -14
- data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +8 -8
- data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +0 -14
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +4 -4
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +0 -14
- data/lib/orb/models/customers/credits/ledger_list_params.rb +4 -4
- data/lib/orb/models/customers/credits/ledger_list_response.rb +0 -14
- 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 -7
- data/lib/orb/models/evaluate_price_group.rb +0 -4
- 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 -135
- data/lib/orb/models/invoice_create_params.rb +10 -10
- data/lib/orb/models/invoice_fetch_upcoming_response.rb +6 -28
- data/lib/orb/models/invoice_level_discount.rb +1 -5
- data/lib/orb/models/invoice_line_item_create_response.rb +4 -26
- 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 -70
- data/lib/orb/models/plan_create_params.rb +448 -476
- data/lib/orb/models/plan_list_params.rb +2 -2
- data/lib/orb/models/price.rb +1204 -1239
- 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 -78
- data/lib/orb/models/subscription_cancel_params.rb +2 -2
- data/lib/orb/models/subscription_cancel_response.rb +14 -36
- data/lib/orb/models/subscription_change_apply_response.rb +14 -36
- data/lib/orb/models/subscription_change_cancel_response.rb +14 -36
- data/lib/orb/models/subscription_change_retrieve_response.rb +14 -36
- data/lib/orb/models/subscription_create_params.rb +1002 -1075
- data/lib/orb/models/subscription_create_response.rb +14 -36
- 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 -674
- data/lib/orb/models/subscription_price_intervals_response.rb +14 -36
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +973 -1059
- data/lib/orb/models/subscription_schedule_plan_change_response.rb +14 -36
- data/lib/orb/models/subscription_trigger_phase_response.rb +14 -36
- data/lib/orb/models/subscription_unschedule_cancellation_response.rb +14 -36
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +14 -36
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +14 -36
- 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 -36
- data/lib/orb/models/subscription_update_trial_params.rb +3 -3
- data/lib/orb/models/subscription_update_trial_response.rb +14 -36
- data/lib/orb/models/subscription_usage.rb +26 -35
- 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/models.rb +30 -16
- 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/type/array_of.rbi +6 -0
- data/rbi/orb/internal/type/base_model.rbi +5 -0
- data/rbi/orb/internal/type/boolean.rbi +6 -0
- data/rbi/orb/internal/type/enum.rbi +5 -0
- data/rbi/orb/internal/type/file_input.rbi +5 -0
- data/rbi/orb/internal/type/hash_of.rbi +6 -0
- data/rbi/orb/internal/type/union.rbi +5 -0
- data/rbi/orb/internal/type/unknown.rbi +6 -0
- data/rbi/orb/internal/util.rbi +30 -0
- data/rbi/orb/internal.rbi +3 -0
- data/rbi/orb/models/coupon.rbi +2 -2
- data/rbi/orb/models/customers/cost_list_by_external_id_response.rbi +2 -65
- data/rbi/orb/models/customers/cost_list_response.rbi +2 -65
- data/rbi/orb/models/evaluate_price_group.rbi +7 -3
- data/rbi/orb/models/invoice.rbi +10 -149
- data/rbi/orb/models/invoice_fetch_upcoming_response.rbi +10 -133
- data/rbi/orb/models/invoice_line_item_create_response.rbi +8 -114
- data/rbi/orb/models/plan.rbi +8 -134
- data/rbi/orb/models/price.rbi +56 -588
- data/rbi/orb/models/subscription.rbi +6 -99
- data/rbi/orb/models/subscription_cancel_response.rbi +6 -89
- data/rbi/orb/models/subscription_change_apply_response.rbi +6 -89
- data/rbi/orb/models/subscription_change_cancel_response.rbi +6 -89
- data/rbi/orb/models/subscription_change_retrieve_response.rbi +6 -89
- data/rbi/orb/models/subscription_create_response.rbi +6 -89
- data/rbi/orb/models/subscription_fetch_costs_response.rbi +2 -65
- data/rbi/orb/models/subscription_price_intervals_response.rbi +6 -89
- data/rbi/orb/models/subscription_schedule_plan_change_response.rbi +6 -89
- data/rbi/orb/models/subscription_trigger_phase_response.rbi +6 -89
- data/rbi/orb/models/subscription_unschedule_cancellation_response.rbi +6 -89
- data/rbi/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +6 -89
- data/rbi/orb/models/subscription_unschedule_pending_plan_changes_response.rbi +6 -89
- data/rbi/orb/models/subscription_update_fixed_fee_quantity_response.rbi +6 -89
- data/rbi/orb/models/subscription_update_trial_response.rbi +6 -89
- data/rbi/orb/resources/customers/credits/ledger.rbi +4 -36
- data/rbi/orb/resources/prices/external_price_id.rbi +2 -64
- data/rbi/orb/resources/prices.rbi +4 -130
- data/rbi/orb/resources/subscriptions.rbi +1 -6
- data/sig/orb/internal/page.rbs +2 -0
- data/sig/orb/internal/type/array_of.rbs +3 -0
- data/sig/orb/internal/type/base_model.rbs +2 -0
- data/sig/orb/internal/type/boolean.rbs +3 -0
- data/sig/orb/internal/type/enum.rbs +2 -0
- data/sig/orb/internal/type/file_input.rbs +2 -0
- data/sig/orb/internal/type/hash_of.rbs +3 -0
- data/sig/orb/internal/type/union.rbs +2 -0
- data/sig/orb/internal/type/unknown.rbs +3 -0
- data/sig/orb/internal/util.rbs +12 -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
@@ -10,13 +10,13 @@ module Orb
|
|
10
10
|
# @!attribute add
|
11
11
|
# A list of price intervals to add to the subscription.
|
12
12
|
#
|
13
|
-
# @return [Array<Orb::SubscriptionPriceIntervalsParams::Add>, nil]
|
13
|
+
# @return [Array<Orb::Models::SubscriptionPriceIntervalsParams::Add>, nil]
|
14
14
|
optional :add, -> { Orb::Internal::Type::ArrayOf[Orb::SubscriptionPriceIntervalsParams::Add] }
|
15
15
|
|
16
16
|
# @!attribute add_adjustments
|
17
17
|
# A list of adjustments to add to the subscription.
|
18
18
|
#
|
19
|
-
# @return [Array<Orb::SubscriptionPriceIntervalsParams::AddAdjustment>, nil]
|
19
|
+
# @return [Array<Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment>, nil]
|
20
20
|
optional :add_adjustments,
|
21
21
|
-> { Orb::Internal::Type::ArrayOf[Orb::SubscriptionPriceIntervalsParams::AddAdjustment] }
|
22
22
|
|
@@ -31,13 +31,13 @@ module Orb
|
|
31
31
|
# @!attribute edit
|
32
32
|
# A list of price intervals to edit on the subscription.
|
33
33
|
#
|
34
|
-
# @return [Array<Orb::SubscriptionPriceIntervalsParams::Edit>, nil]
|
34
|
+
# @return [Array<Orb::Models::SubscriptionPriceIntervalsParams::Edit>, nil]
|
35
35
|
optional :edit, -> { Orb::Internal::Type::ArrayOf[Orb::SubscriptionPriceIntervalsParams::Edit] }
|
36
36
|
|
37
37
|
# @!attribute edit_adjustments
|
38
38
|
# A list of adjustments to edit on the subscription.
|
39
39
|
#
|
40
|
-
# @return [Array<Orb::SubscriptionPriceIntervalsParams::EditAdjustment>, nil]
|
40
|
+
# @return [Array<Orb::Models::SubscriptionPriceIntervalsParams::EditAdjustment>, nil]
|
41
41
|
optional :edit_adjustments,
|
42
42
|
-> { Orb::Internal::Type::ArrayOf[Orb::SubscriptionPriceIntervalsParams::EditAdjustment] }
|
43
43
|
|
@@ -45,15 +45,15 @@ module Orb
|
|
45
45
|
# Some parameter documentations has been truncated, see
|
46
46
|
# {Orb::Models::SubscriptionPriceIntervalsParams} for more details.
|
47
47
|
#
|
48
|
-
# @param add [Array<Orb::SubscriptionPriceIntervalsParams::Add>] A list of price intervals to add to the subscription.
|
48
|
+
# @param add [Array<Orb::Models::SubscriptionPriceIntervalsParams::Add>] A list of price intervals to add to the subscription.
|
49
49
|
#
|
50
|
-
# @param add_adjustments [Array<Orb::SubscriptionPriceIntervalsParams::AddAdjustment>] A list of adjustments to add to the subscription.
|
50
|
+
# @param add_adjustments [Array<Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment>] A list of adjustments to add to the subscription.
|
51
51
|
#
|
52
52
|
# @param allow_invoice_credit_or_void [Boolean, nil] If false, this request will fail if it would void an issued invoice or create a
|
53
53
|
#
|
54
|
-
# @param edit [Array<Orb::SubscriptionPriceIntervalsParams::Edit>] A list of price intervals to edit on the subscription.
|
54
|
+
# @param edit [Array<Orb::Models::SubscriptionPriceIntervalsParams::Edit>] A list of price intervals to edit on the subscription.
|
55
55
|
#
|
56
|
-
# @param edit_adjustments [Array<Orb::SubscriptionPriceIntervalsParams::EditAdjustment>] A list of adjustments to edit on the subscription.
|
56
|
+
# @param edit_adjustments [Array<Orb::Models::SubscriptionPriceIntervalsParams::EditAdjustment>] A list of adjustments to edit on the subscription.
|
57
57
|
#
|
58
58
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
59
59
|
|
@@ -62,13 +62,13 @@ module Orb
|
|
62
62
|
# The start date of the price interval. This is the date that the price will start
|
63
63
|
# billing on the subscription.
|
64
64
|
#
|
65
|
-
# @return [Time, Symbol, Orb::BillingCycleRelativeDate]
|
65
|
+
# @return [Time, Symbol, Orb::Models::BillingCycleRelativeDate]
|
66
66
|
required :start_date, union: -> { Orb::SubscriptionPriceIntervalsParams::Add::StartDate }
|
67
67
|
|
68
68
|
# @!attribute allocation_price
|
69
69
|
# The definition of a new allocation price to create and add to the subscription.
|
70
70
|
#
|
71
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::AllocationPrice, nil]
|
71
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::AllocationPrice, nil]
|
72
72
|
optional :allocation_price,
|
73
73
|
-> {
|
74
74
|
Orb::SubscriptionPriceIntervalsParams::Add::AllocationPrice
|
@@ -78,7 +78,7 @@ module Orb
|
|
78
78
|
# @!attribute discounts
|
79
79
|
# A list of discounts to initialize on the price interval.
|
80
80
|
#
|
81
|
-
# @return [Array<Orb::SubscriptionPriceIntervalsParams::Add::Discount::Amount, Orb::SubscriptionPriceIntervalsParams::Add::Discount::Percentage, Orb::SubscriptionPriceIntervalsParams::Add::Discount::Usage>, nil]
|
81
|
+
# @return [Array<Orb::Models::SubscriptionPriceIntervalsParams::Add::Discount::Amount, Orb::Models::SubscriptionPriceIntervalsParams::Add::Discount::Percentage, Orb::Models::SubscriptionPriceIntervalsParams::Add::Discount::Usage>, nil]
|
82
82
|
optional :discounts,
|
83
83
|
-> {
|
84
84
|
Orb::Internal::Type::ArrayOf[union: Orb::SubscriptionPriceIntervalsParams::Add::Discount]
|
@@ -89,7 +89,7 @@ module Orb
|
|
89
89
|
# The end date of the price interval. This is the date that the price will stop
|
90
90
|
# billing on the subscription.
|
91
91
|
#
|
92
|
-
# @return [Time, Symbol, Orb::BillingCycleRelativeDate, nil]
|
92
|
+
# @return [Time, Symbol, Orb::Models::BillingCycleRelativeDate, nil]
|
93
93
|
optional :end_date, union: -> { Orb::SubscriptionPriceIntervalsParams::Add::EndDate }, nil?: true
|
94
94
|
|
95
95
|
# @!attribute external_price_id
|
@@ -110,7 +110,7 @@ module Orb
|
|
110
110
|
# @!attribute fixed_fee_quantity_transitions
|
111
111
|
# A list of fixed fee quantity transitions to initialize on the price interval.
|
112
112
|
#
|
113
|
-
# @return [Array<Orb::SubscriptionPriceIntervalsParams::Add::FixedFeeQuantityTransition>, nil]
|
113
|
+
# @return [Array<Orb::Models::SubscriptionPriceIntervalsParams::Add::FixedFeeQuantityTransition>, nil]
|
114
114
|
optional :fixed_fee_quantity_transitions,
|
115
115
|
-> {
|
116
116
|
Orb::Internal::Type::ArrayOf[Orb::SubscriptionPriceIntervalsParams::Add::FixedFeeQuantityTransition]
|
@@ -134,7 +134,7 @@ module Orb
|
|
134
134
|
# @!attribute price
|
135
135
|
# The definition of a new price to create and add to the subscription.
|
136
136
|
#
|
137
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::Unit, Orb::SubscriptionPriceIntervalsParams::Add::Price::Package, Orb::SubscriptionPriceIntervalsParams::Add::Price::Matrix, Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation, Orb::SubscriptionPriceIntervalsParams::Add::Price::Tiered, Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredBps, Orb::SubscriptionPriceIntervalsParams::Add::Price::Bps, Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkBps, Orb::SubscriptionPriceIntervalsParams::Add::Price::Bulk, Orb::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount, Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage, Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered, Orb::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage, Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum, Orb::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation, Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum, Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent, Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration, Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration, Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation, Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum, Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum, Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName, Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration, Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage, Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing, Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing, Orb::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk, nil]
|
137
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Unit, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Package, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Matrix, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Tiered, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredBps, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bps, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkBps, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bulk, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk, nil]
|
138
138
|
optional :price, union: -> { Orb::SubscriptionPriceIntervalsParams::Add::Price }, nil?: true
|
139
139
|
|
140
140
|
# @!attribute price_id
|
@@ -156,27 +156,27 @@ module Orb
|
|
156
156
|
|
157
157
|
# @!method initialize(start_date:, allocation_price: nil, discounts: nil, end_date: nil, external_price_id: nil, filter: nil, fixed_fee_quantity_transitions: nil, maximum_amount: nil, minimum_amount: nil, price: nil, price_id: nil, usage_customer_ids: nil)
|
158
158
|
# Some parameter documentations has been truncated, see
|
159
|
-
# {Orb::SubscriptionPriceIntervalsParams::Add} for more details.
|
159
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add} for more details.
|
160
160
|
#
|
161
|
-
# @param start_date [Time, Symbol, Orb::BillingCycleRelativeDate] The start date of the price interval. This is the date that the price will start
|
161
|
+
# @param start_date [Time, Symbol, Orb::Models::BillingCycleRelativeDate] The start date of the price interval. This is the date that the price will start
|
162
162
|
#
|
163
|
-
# @param allocation_price [Orb::SubscriptionPriceIntervalsParams::Add::AllocationPrice, nil] The definition of a new allocation price to create and add to the subscription.
|
163
|
+
# @param allocation_price [Orb::Models::SubscriptionPriceIntervalsParams::Add::AllocationPrice, nil] The definition of a new allocation price to create and add to the subscription.
|
164
164
|
#
|
165
|
-
# @param discounts [Array<Orb::SubscriptionPriceIntervalsParams::Add::Discount::Amount, Orb::SubscriptionPriceIntervalsParams::Add::Discount::Percentage, Orb::SubscriptionPriceIntervalsParams::Add::Discount::Usage>, nil] A list of discounts to initialize on the price interval.
|
165
|
+
# @param discounts [Array<Orb::Models::SubscriptionPriceIntervalsParams::Add::Discount::Amount, Orb::Models::SubscriptionPriceIntervalsParams::Add::Discount::Percentage, Orb::Models::SubscriptionPriceIntervalsParams::Add::Discount::Usage>, nil] A list of discounts to initialize on the price interval.
|
166
166
|
#
|
167
|
-
# @param end_date [Time, Symbol, Orb::BillingCycleRelativeDate, nil] The end date of the price interval. This is the date that the price will stop bi
|
167
|
+
# @param end_date [Time, Symbol, Orb::Models::BillingCycleRelativeDate, nil] The end date of the price interval. This is the date that the price will stop bi
|
168
168
|
#
|
169
169
|
# @param external_price_id [String, nil] The external price id of the price to add to the subscription.
|
170
170
|
#
|
171
171
|
# @param filter [String, nil] An additional filter to apply to usage queries. This filter must be expressed as
|
172
172
|
#
|
173
|
-
# @param fixed_fee_quantity_transitions [Array<Orb::SubscriptionPriceIntervalsParams::Add::FixedFeeQuantityTransition>, nil] A list of fixed fee quantity transitions to initialize on the price interval.
|
173
|
+
# @param fixed_fee_quantity_transitions [Array<Orb::Models::SubscriptionPriceIntervalsParams::Add::FixedFeeQuantityTransition>, nil] A list of fixed fee quantity transitions to initialize on the price interval.
|
174
174
|
#
|
175
175
|
# @param maximum_amount [Float, nil] The maximum amount that will be billed for this price interval for a given billi
|
176
176
|
#
|
177
177
|
# @param minimum_amount [Float, nil] The minimum amount that will be billed for this price interval for a given billi
|
178
178
|
#
|
179
|
-
# @param price [Orb::SubscriptionPriceIntervalsParams::Add::Price::Unit, Orb::SubscriptionPriceIntervalsParams::Add::Price::Package, Orb::SubscriptionPriceIntervalsParams::Add::Price::Matrix, Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation, Orb::SubscriptionPriceIntervalsParams::Add::Price::Tiered, Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredBps, Orb::SubscriptionPriceIntervalsParams::Add::Price::Bps, Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkBps, Orb::SubscriptionPriceIntervalsParams::Add::Price::Bulk, Orb::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount, Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage, Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered, Orb::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage, Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum, Orb::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation, Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum, Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent, Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration, Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration, Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation, Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum, Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum, Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName, Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration, Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage, Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing, Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing, Orb::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk, nil] The definition of a new price to create and add to the subscription.
|
179
|
+
# @param price [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Unit, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Package, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Matrix, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Tiered, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredBps, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bps, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkBps, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bulk, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk, nil] The definition of a new price to create and add to the subscription.
|
180
180
|
#
|
181
181
|
# @param price_id [String, nil] The id of the price to add to the subscription.
|
182
182
|
#
|
@@ -185,7 +185,7 @@ module Orb
|
|
185
185
|
# The start date of the price interval. This is the date that the price will start
|
186
186
|
# billing on the subscription.
|
187
187
|
#
|
188
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add#start_date
|
188
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add#start_date
|
189
189
|
module StartDate
|
190
190
|
extend Orb::Internal::Type::Union
|
191
191
|
|
@@ -194,14 +194,10 @@ module Orb
|
|
194
194
|
variant enum: -> { Orb::BillingCycleRelativeDate }
|
195
195
|
|
196
196
|
# @!method self.variants
|
197
|
-
# @return [Array(Time, Symbol, Orb::BillingCycleRelativeDate)]
|
198
|
-
|
199
|
-
define_sorbet_constant!(:Variants) do
|
200
|
-
T.type_alias { T.any(Time, Orb::BillingCycleRelativeDate::TaggedSymbol) }
|
201
|
-
end
|
197
|
+
# @return [Array(Time, Symbol, Orb::Models::BillingCycleRelativeDate)]
|
202
198
|
end
|
203
199
|
|
204
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add#allocation_price
|
200
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add#allocation_price
|
205
201
|
class AllocationPrice < Orb::Internal::Type::BaseModel
|
206
202
|
# @!attribute amount
|
207
203
|
# An amount of the currency to allocate to the customer at the specified cadence.
|
@@ -212,7 +208,7 @@ module Orb
|
|
212
208
|
# @!attribute cadence
|
213
209
|
# The cadence at which to allocate the amount to the customer.
|
214
210
|
#
|
215
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::AllocationPrice::Cadence]
|
211
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::AllocationPrice::Cadence]
|
216
212
|
required :cadence, enum: -> { Orb::SubscriptionPriceIntervalsParams::Add::AllocationPrice::Cadence }
|
217
213
|
|
218
214
|
# @!attribute currency
|
@@ -231,13 +227,14 @@ module Orb
|
|
231
227
|
|
232
228
|
# @!method initialize(amount:, cadence:, currency:, expires_at_end_of_cadence:)
|
233
229
|
# Some parameter documentations has been truncated, see
|
234
|
-
# {Orb::SubscriptionPriceIntervalsParams::Add::AllocationPrice} for more
|
230
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::AllocationPrice} for more
|
231
|
+
# details.
|
235
232
|
#
|
236
233
|
# The definition of a new allocation price to create and add to the subscription.
|
237
234
|
#
|
238
235
|
# @param amount [String] An amount of the currency to allocate to the customer at the specified cadence.
|
239
236
|
#
|
240
|
-
# @param cadence [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::AllocationPrice::Cadence] The cadence at which to allocate the amount to the customer.
|
237
|
+
# @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::AllocationPrice::Cadence] The cadence at which to allocate the amount to the customer.
|
241
238
|
#
|
242
239
|
# @param currency [String] An ISO 4217 currency string or a custom pricing unit identifier in which to bill
|
243
240
|
#
|
@@ -245,7 +242,7 @@ module Orb
|
|
245
242
|
|
246
243
|
# The cadence at which to allocate the amount to the customer.
|
247
244
|
#
|
248
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::AllocationPrice#cadence
|
245
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::AllocationPrice#cadence
|
249
246
|
module Cadence
|
250
247
|
extend Orb::Internal::Type::Enum
|
251
248
|
|
@@ -305,8 +302,8 @@ module Orb
|
|
305
302
|
|
306
303
|
# @!method initialize(percentage_discount:, discount_type: :percentage)
|
307
304
|
# Some parameter documentations has been truncated, see
|
308
|
-
# {Orb::SubscriptionPriceIntervalsParams::Add::Discount::Percentage} for
|
309
|
-
# details.
|
305
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Discount::Percentage} for
|
306
|
+
# more details.
|
310
307
|
#
|
311
308
|
# @param percentage_discount [Float] Only available if discount_type is `percentage`. This is a number between 0 and
|
312
309
|
#
|
@@ -328,7 +325,8 @@ module Orb
|
|
328
325
|
|
329
326
|
# @!method initialize(usage_discount:, discount_type: :usage)
|
330
327
|
# Some parameter documentations has been truncated, see
|
331
|
-
# {Orb::SubscriptionPriceIntervalsParams::Add::Discount::Usage} for more
|
328
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Discount::Usage} for more
|
329
|
+
# details.
|
332
330
|
#
|
333
331
|
# @param usage_discount [Float] Only available if discount_type is `usage`. Number of usage units that this disc
|
334
332
|
#
|
@@ -336,23 +334,13 @@ module Orb
|
|
336
334
|
end
|
337
335
|
|
338
336
|
# @!method self.variants
|
339
|
-
# @return [Array(Orb::SubscriptionPriceIntervalsParams::Add::Discount::Amount, Orb::SubscriptionPriceIntervalsParams::Add::Discount::Percentage, Orb::SubscriptionPriceIntervalsParams::Add::Discount::Usage)]
|
340
|
-
|
341
|
-
define_sorbet_constant!(:Variants) do
|
342
|
-
T.type_alias do
|
343
|
-
T.any(
|
344
|
-
Orb::SubscriptionPriceIntervalsParams::Add::Discount::Amount,
|
345
|
-
Orb::SubscriptionPriceIntervalsParams::Add::Discount::Percentage,
|
346
|
-
Orb::SubscriptionPriceIntervalsParams::Add::Discount::Usage
|
347
|
-
)
|
348
|
-
end
|
349
|
-
end
|
337
|
+
# @return [Array(Orb::Models::SubscriptionPriceIntervalsParams::Add::Discount::Amount, Orb::Models::SubscriptionPriceIntervalsParams::Add::Discount::Percentage, Orb::Models::SubscriptionPriceIntervalsParams::Add::Discount::Usage)]
|
350
338
|
end
|
351
339
|
|
352
340
|
# The end date of the price interval. This is the date that the price will stop
|
353
341
|
# billing on the subscription.
|
354
342
|
#
|
355
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add#end_date
|
343
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add#end_date
|
356
344
|
module EndDate
|
357
345
|
extend Orb::Internal::Type::Union
|
358
346
|
|
@@ -361,11 +349,7 @@ module Orb
|
|
361
349
|
variant enum: -> { Orb::BillingCycleRelativeDate }
|
362
350
|
|
363
351
|
# @!method self.variants
|
364
|
-
# @return [Array(Time, Symbol, Orb::BillingCycleRelativeDate)]
|
365
|
-
|
366
|
-
define_sorbet_constant!(:Variants) do
|
367
|
-
T.type_alias { T.any(Time, Orb::BillingCycleRelativeDate::TaggedSymbol) }
|
368
|
-
end
|
352
|
+
# @return [Array(Time, Symbol, Orb::Models::BillingCycleRelativeDate)]
|
369
353
|
end
|
370
354
|
|
371
355
|
class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel
|
@@ -389,7 +373,7 @@ module Orb
|
|
389
373
|
|
390
374
|
# The definition of a new price to create and add to the subscription.
|
391
375
|
#
|
392
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add#price
|
376
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add#price
|
393
377
|
module Price
|
394
378
|
extend Orb::Internal::Type::Union
|
395
379
|
|
@@ -483,7 +467,7 @@ module Orb
|
|
483
467
|
# @!attribute cadence
|
484
468
|
# The cadence to bill for this price on.
|
485
469
|
#
|
486
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::Unit::Cadence]
|
470
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Unit::Cadence]
|
487
471
|
required :cadence, enum: -> { Orb::SubscriptionPriceIntervalsParams::Add::Price::Unit::Cadence }
|
488
472
|
|
489
473
|
# @!attribute currency
|
@@ -511,7 +495,7 @@ module Orb
|
|
511
495
|
|
512
496
|
# @!attribute unit_config
|
513
497
|
#
|
514
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::Unit::UnitConfig]
|
498
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Unit::UnitConfig]
|
515
499
|
required :unit_config, -> { Orb::SubscriptionPriceIntervalsParams::Add::Price::Unit::UnitConfig }
|
516
500
|
|
517
501
|
# @!attribute billable_metric_id
|
@@ -532,7 +516,7 @@ module Orb
|
|
532
516
|
# For custom cadence: specifies the duration of the billing period in days or
|
533
517
|
# months.
|
534
518
|
#
|
535
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::Unit::BillingCycleConfiguration, nil]
|
519
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Unit::BillingCycleConfiguration, nil]
|
536
520
|
optional :billing_cycle_configuration,
|
537
521
|
-> {
|
538
522
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::Unit::BillingCycleConfiguration
|
@@ -568,7 +552,7 @@ module Orb
|
|
568
552
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
569
553
|
# If unspecified, a single invoice is produced per billing cycle.
|
570
554
|
#
|
571
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::Unit::InvoicingCycleConfiguration, nil]
|
555
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Unit::InvoicingCycleConfiguration, nil]
|
572
556
|
optional :invoicing_cycle_configuration,
|
573
557
|
-> {
|
574
558
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::Unit::InvoicingCycleConfiguration
|
@@ -585,9 +569,10 @@ module Orb
|
|
585
569
|
|
586
570
|
# @!method initialize(cadence:, currency:, item_id:, name:, unit_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :unit)
|
587
571
|
# Some parameter documentations has been truncated, see
|
588
|
-
# {Orb::SubscriptionPriceIntervalsParams::Add::Price::Unit} for more
|
572
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Unit} for more
|
573
|
+
# details.
|
589
574
|
#
|
590
|
-
# @param cadence [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::Unit::Cadence] The cadence to bill for this price on.
|
575
|
+
# @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Unit::Cadence] The cadence to bill for this price on.
|
591
576
|
#
|
592
577
|
# @param currency [String] An ISO 4217 currency string for which this price is billed in.
|
593
578
|
#
|
@@ -595,13 +580,13 @@ module Orb
|
|
595
580
|
#
|
596
581
|
# @param name [String] The name of the price.
|
597
582
|
#
|
598
|
-
# @param unit_config [Orb::SubscriptionPriceIntervalsParams::Add::Price::Unit::UnitConfig]
|
583
|
+
# @param unit_config [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Unit::UnitConfig]
|
599
584
|
#
|
600
585
|
# @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b
|
601
586
|
#
|
602
587
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
603
588
|
#
|
604
|
-
# @param billing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::Unit::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
589
|
+
# @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Unit::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
605
590
|
#
|
606
591
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
607
592
|
#
|
@@ -611,7 +596,7 @@ module Orb
|
|
611
596
|
#
|
612
597
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
613
598
|
#
|
614
|
-
# @param invoicing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::Unit::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
599
|
+
# @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Unit::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
615
600
|
#
|
616
601
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
617
602
|
#
|
@@ -619,7 +604,7 @@ module Orb
|
|
619
604
|
|
620
605
|
# The cadence to bill for this price on.
|
621
606
|
#
|
622
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::Unit#cadence
|
607
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Unit#cadence
|
623
608
|
module Cadence
|
624
609
|
extend Orb::Internal::Type::Enum
|
625
610
|
|
@@ -634,7 +619,7 @@ module Orb
|
|
634
619
|
# @return [Array<Symbol>]
|
635
620
|
end
|
636
621
|
|
637
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::Unit#unit_config
|
622
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Unit#unit_config
|
638
623
|
class UnitConfig < Orb::Internal::Type::BaseModel
|
639
624
|
# @!attribute unit_amount
|
640
625
|
# Rate per unit of usage
|
@@ -646,7 +631,7 @@ module Orb
|
|
646
631
|
# @param unit_amount [String] Rate per unit of usage
|
647
632
|
end
|
648
633
|
|
649
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::Unit#billing_cycle_configuration
|
634
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Unit#billing_cycle_configuration
|
650
635
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
651
636
|
# @!attribute duration
|
652
637
|
# The duration of the billing period.
|
@@ -657,7 +642,7 @@ module Orb
|
|
657
642
|
# @!attribute duration_unit
|
658
643
|
# The unit of billing period duration.
|
659
644
|
#
|
660
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::Unit::BillingCycleConfiguration::DurationUnit]
|
645
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Unit::BillingCycleConfiguration::DurationUnit]
|
661
646
|
required :duration_unit,
|
662
647
|
enum: -> {
|
663
648
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::Unit::BillingCycleConfiguration::DurationUnit
|
@@ -669,11 +654,11 @@ module Orb
|
|
669
654
|
#
|
670
655
|
# @param duration [Integer] The duration of the billing period.
|
671
656
|
#
|
672
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::Unit::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
657
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Unit::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
673
658
|
|
674
659
|
# The unit of billing period duration.
|
675
660
|
#
|
676
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::Unit::BillingCycleConfiguration#duration_unit
|
661
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Unit::BillingCycleConfiguration#duration_unit
|
677
662
|
module DurationUnit
|
678
663
|
extend Orb::Internal::Type::Enum
|
679
664
|
|
@@ -685,7 +670,7 @@ module Orb
|
|
685
670
|
end
|
686
671
|
end
|
687
672
|
|
688
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::Unit#invoicing_cycle_configuration
|
673
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Unit#invoicing_cycle_configuration
|
689
674
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
690
675
|
# @!attribute duration
|
691
676
|
# The duration of the billing period.
|
@@ -696,7 +681,7 @@ module Orb
|
|
696
681
|
# @!attribute duration_unit
|
697
682
|
# The unit of billing period duration.
|
698
683
|
#
|
699
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::Unit::InvoicingCycleConfiguration::DurationUnit]
|
684
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Unit::InvoicingCycleConfiguration::DurationUnit]
|
700
685
|
required :duration_unit,
|
701
686
|
enum: -> {
|
702
687
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::Unit::InvoicingCycleConfiguration::DurationUnit
|
@@ -708,11 +693,11 @@ module Orb
|
|
708
693
|
#
|
709
694
|
# @param duration [Integer] The duration of the billing period.
|
710
695
|
#
|
711
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::Unit::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
696
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Unit::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
712
697
|
|
713
698
|
# The unit of billing period duration.
|
714
699
|
#
|
715
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::Unit::InvoicingCycleConfiguration#duration_unit
|
700
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Unit::InvoicingCycleConfiguration#duration_unit
|
716
701
|
module DurationUnit
|
717
702
|
extend Orb::Internal::Type::Enum
|
718
703
|
|
@@ -729,7 +714,7 @@ module Orb
|
|
729
714
|
# @!attribute cadence
|
730
715
|
# The cadence to bill for this price on.
|
731
716
|
#
|
732
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::Package::Cadence]
|
717
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Package::Cadence]
|
733
718
|
required :cadence,
|
734
719
|
enum: -> {
|
735
720
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::Package::Cadence
|
@@ -760,7 +745,7 @@ module Orb
|
|
760
745
|
|
761
746
|
# @!attribute package_config
|
762
747
|
#
|
763
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::Package::PackageConfig]
|
748
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Package::PackageConfig]
|
764
749
|
required :package_config,
|
765
750
|
-> {
|
766
751
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::Package::PackageConfig
|
@@ -784,7 +769,7 @@ module Orb
|
|
784
769
|
# For custom cadence: specifies the duration of the billing period in days or
|
785
770
|
# months.
|
786
771
|
#
|
787
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::Package::BillingCycleConfiguration, nil]
|
772
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Package::BillingCycleConfiguration, nil]
|
788
773
|
optional :billing_cycle_configuration,
|
789
774
|
-> {
|
790
775
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::Package::BillingCycleConfiguration
|
@@ -820,7 +805,7 @@ module Orb
|
|
820
805
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
821
806
|
# If unspecified, a single invoice is produced per billing cycle.
|
822
807
|
#
|
823
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::Package::InvoicingCycleConfiguration, nil]
|
808
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Package::InvoicingCycleConfiguration, nil]
|
824
809
|
optional :invoicing_cycle_configuration,
|
825
810
|
-> {
|
826
811
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::Package::InvoicingCycleConfiguration
|
@@ -837,9 +822,10 @@ module Orb
|
|
837
822
|
|
838
823
|
# @!method initialize(cadence:, currency:, item_id:, name:, package_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :package)
|
839
824
|
# Some parameter documentations has been truncated, see
|
840
|
-
# {Orb::SubscriptionPriceIntervalsParams::Add::Price::Package} for more
|
825
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Package} for more
|
826
|
+
# details.
|
841
827
|
#
|
842
|
-
# @param cadence [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::Package::Cadence] The cadence to bill for this price on.
|
828
|
+
# @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Package::Cadence] The cadence to bill for this price on.
|
843
829
|
#
|
844
830
|
# @param currency [String] An ISO 4217 currency string for which this price is billed in.
|
845
831
|
#
|
@@ -847,13 +833,13 @@ module Orb
|
|
847
833
|
#
|
848
834
|
# @param name [String] The name of the price.
|
849
835
|
#
|
850
|
-
# @param package_config [Orb::SubscriptionPriceIntervalsParams::Add::Price::Package::PackageConfig]
|
836
|
+
# @param package_config [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Package::PackageConfig]
|
851
837
|
#
|
852
838
|
# @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b
|
853
839
|
#
|
854
840
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
855
841
|
#
|
856
|
-
# @param billing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::Package::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
842
|
+
# @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Package::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
857
843
|
#
|
858
844
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
859
845
|
#
|
@@ -863,7 +849,7 @@ module Orb
|
|
863
849
|
#
|
864
850
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
865
851
|
#
|
866
|
-
# @param invoicing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::Package::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
852
|
+
# @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Package::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
867
853
|
#
|
868
854
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
869
855
|
#
|
@@ -871,7 +857,7 @@ module Orb
|
|
871
857
|
|
872
858
|
# The cadence to bill for this price on.
|
873
859
|
#
|
874
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::Package#cadence
|
860
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Package#cadence
|
875
861
|
module Cadence
|
876
862
|
extend Orb::Internal::Type::Enum
|
877
863
|
|
@@ -886,7 +872,7 @@ module Orb
|
|
886
872
|
# @return [Array<Symbol>]
|
887
873
|
end
|
888
874
|
|
889
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::Package#package_config
|
875
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Package#package_config
|
890
876
|
class PackageConfig < Orb::Internal::Type::BaseModel
|
891
877
|
# @!attribute package_amount
|
892
878
|
# A currency amount to rate usage by
|
@@ -903,15 +889,15 @@ module Orb
|
|
903
889
|
|
904
890
|
# @!method initialize(package_amount:, package_size:)
|
905
891
|
# Some parameter documentations has been truncated, see
|
906
|
-
# {Orb::SubscriptionPriceIntervalsParams::Add::Price::Package::PackageConfig}
|
907
|
-
# more details.
|
892
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Package::PackageConfig}
|
893
|
+
# for more details.
|
908
894
|
#
|
909
895
|
# @param package_amount [String] A currency amount to rate usage by
|
910
896
|
#
|
911
897
|
# @param package_size [Integer] An integer amount to represent package size. For example, 1000 here would divide
|
912
898
|
end
|
913
899
|
|
914
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::Package#billing_cycle_configuration
|
900
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Package#billing_cycle_configuration
|
915
901
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
916
902
|
# @!attribute duration
|
917
903
|
# The duration of the billing period.
|
@@ -922,7 +908,7 @@ module Orb
|
|
922
908
|
# @!attribute duration_unit
|
923
909
|
# The unit of billing period duration.
|
924
910
|
#
|
925
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::Package::BillingCycleConfiguration::DurationUnit]
|
911
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Package::BillingCycleConfiguration::DurationUnit]
|
926
912
|
required :duration_unit,
|
927
913
|
enum: -> {
|
928
914
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::Package::BillingCycleConfiguration::DurationUnit
|
@@ -934,11 +920,11 @@ module Orb
|
|
934
920
|
#
|
935
921
|
# @param duration [Integer] The duration of the billing period.
|
936
922
|
#
|
937
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::Package::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
923
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Package::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
938
924
|
|
939
925
|
# The unit of billing period duration.
|
940
926
|
#
|
941
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::Package::BillingCycleConfiguration#duration_unit
|
927
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Package::BillingCycleConfiguration#duration_unit
|
942
928
|
module DurationUnit
|
943
929
|
extend Orb::Internal::Type::Enum
|
944
930
|
|
@@ -950,7 +936,7 @@ module Orb
|
|
950
936
|
end
|
951
937
|
end
|
952
938
|
|
953
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::Package#invoicing_cycle_configuration
|
939
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Package#invoicing_cycle_configuration
|
954
940
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
955
941
|
# @!attribute duration
|
956
942
|
# The duration of the billing period.
|
@@ -961,7 +947,7 @@ module Orb
|
|
961
947
|
# @!attribute duration_unit
|
962
948
|
# The unit of billing period duration.
|
963
949
|
#
|
964
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::Package::InvoicingCycleConfiguration::DurationUnit]
|
950
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Package::InvoicingCycleConfiguration::DurationUnit]
|
965
951
|
required :duration_unit,
|
966
952
|
enum: -> {
|
967
953
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::Package::InvoicingCycleConfiguration::DurationUnit
|
@@ -973,11 +959,11 @@ module Orb
|
|
973
959
|
#
|
974
960
|
# @param duration [Integer] The duration of the billing period.
|
975
961
|
#
|
976
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::Package::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
962
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Package::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
977
963
|
|
978
964
|
# The unit of billing period duration.
|
979
965
|
#
|
980
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::Package::InvoicingCycleConfiguration#duration_unit
|
966
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Package::InvoicingCycleConfiguration#duration_unit
|
981
967
|
module DurationUnit
|
982
968
|
extend Orb::Internal::Type::Enum
|
983
969
|
|
@@ -994,7 +980,7 @@ module Orb
|
|
994
980
|
# @!attribute cadence
|
995
981
|
# The cadence to bill for this price on.
|
996
982
|
#
|
997
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::Matrix::Cadence]
|
983
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Matrix::Cadence]
|
998
984
|
required :cadence, enum: -> { Orb::SubscriptionPriceIntervalsParams::Add::Price::Matrix::Cadence }
|
999
985
|
|
1000
986
|
# @!attribute currency
|
@@ -1011,7 +997,7 @@ module Orb
|
|
1011
997
|
|
1012
998
|
# @!attribute matrix_config
|
1013
999
|
#
|
1014
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::Matrix::MatrixConfig]
|
1000
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Matrix::MatrixConfig]
|
1015
1001
|
required :matrix_config,
|
1016
1002
|
-> {
|
1017
1003
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::Matrix::MatrixConfig
|
@@ -1046,7 +1032,7 @@ module Orb
|
|
1046
1032
|
# For custom cadence: specifies the duration of the billing period in days or
|
1047
1033
|
# months.
|
1048
1034
|
#
|
1049
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::Matrix::BillingCycleConfiguration, nil]
|
1035
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Matrix::BillingCycleConfiguration, nil]
|
1050
1036
|
optional :billing_cycle_configuration,
|
1051
1037
|
-> {
|
1052
1038
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::Matrix::BillingCycleConfiguration
|
@@ -1082,7 +1068,7 @@ module Orb
|
|
1082
1068
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
1083
1069
|
# If unspecified, a single invoice is produced per billing cycle.
|
1084
1070
|
#
|
1085
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::Matrix::InvoicingCycleConfiguration, nil]
|
1071
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Matrix::InvoicingCycleConfiguration, nil]
|
1086
1072
|
optional :invoicing_cycle_configuration,
|
1087
1073
|
-> {
|
1088
1074
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::Matrix::InvoicingCycleConfiguration
|
@@ -1099,15 +1085,16 @@ module Orb
|
|
1099
1085
|
|
1100
1086
|
# @!method initialize(cadence:, currency:, item_id:, matrix_config:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :matrix)
|
1101
1087
|
# Some parameter documentations has been truncated, see
|
1102
|
-
# {Orb::SubscriptionPriceIntervalsParams::Add::Price::Matrix} for more
|
1088
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Matrix} for more
|
1089
|
+
# details.
|
1103
1090
|
#
|
1104
|
-
# @param cadence [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::Matrix::Cadence] The cadence to bill for this price on.
|
1091
|
+
# @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Matrix::Cadence] The cadence to bill for this price on.
|
1105
1092
|
#
|
1106
1093
|
# @param currency [String] An ISO 4217 currency string for which this price is billed in.
|
1107
1094
|
#
|
1108
1095
|
# @param item_id [String] The id of the item the price will be associated with.
|
1109
1096
|
#
|
1110
|
-
# @param matrix_config [Orb::SubscriptionPriceIntervalsParams::Add::Price::Matrix::MatrixConfig]
|
1097
|
+
# @param matrix_config [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Matrix::MatrixConfig]
|
1111
1098
|
#
|
1112
1099
|
# @param name [String] The name of the price.
|
1113
1100
|
#
|
@@ -1115,7 +1102,7 @@ module Orb
|
|
1115
1102
|
#
|
1116
1103
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
1117
1104
|
#
|
1118
|
-
# @param billing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::Matrix::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
1105
|
+
# @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Matrix::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
1119
1106
|
#
|
1120
1107
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
1121
1108
|
#
|
@@ -1125,7 +1112,7 @@ module Orb
|
|
1125
1112
|
#
|
1126
1113
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
1127
1114
|
#
|
1128
|
-
# @param invoicing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::Matrix::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
1115
|
+
# @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Matrix::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
1129
1116
|
#
|
1130
1117
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
1131
1118
|
#
|
@@ -1133,7 +1120,7 @@ module Orb
|
|
1133
1120
|
|
1134
1121
|
# The cadence to bill for this price on.
|
1135
1122
|
#
|
1136
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::Matrix#cadence
|
1123
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Matrix#cadence
|
1137
1124
|
module Cadence
|
1138
1125
|
extend Orb::Internal::Type::Enum
|
1139
1126
|
|
@@ -1148,7 +1135,7 @@ module Orb
|
|
1148
1135
|
# @return [Array<Symbol>]
|
1149
1136
|
end
|
1150
1137
|
|
1151
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::Matrix#matrix_config
|
1138
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Matrix#matrix_config
|
1152
1139
|
class MatrixConfig < Orb::Internal::Type::BaseModel
|
1153
1140
|
# @!attribute default_unit_amount
|
1154
1141
|
# Default per unit rate for any usage not bucketed into a specified matrix_value
|
@@ -1165,7 +1152,7 @@ module Orb
|
|
1165
1152
|
# @!attribute matrix_values
|
1166
1153
|
# Matrix values for specified matrix grouping keys
|
1167
1154
|
#
|
1168
|
-
# @return [Array<Orb::SubscriptionPriceIntervalsParams::Add::Price::Matrix::MatrixConfig::MatrixValue>]
|
1155
|
+
# @return [Array<Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Matrix::MatrixConfig::MatrixValue>]
|
1169
1156
|
required :matrix_values,
|
1170
1157
|
-> {
|
1171
1158
|
Orb::Internal::Type::ArrayOf[Orb::SubscriptionPriceIntervalsParams::Add::Price::Matrix::MatrixConfig::MatrixValue]
|
@@ -1176,7 +1163,7 @@ module Orb
|
|
1176
1163
|
#
|
1177
1164
|
# @param dimensions [Array<String, nil>] One or two event property values to evaluate matrix groups by
|
1178
1165
|
#
|
1179
|
-
# @param matrix_values [Array<Orb::SubscriptionPriceIntervalsParams::Add::Price::Matrix::MatrixConfig::MatrixValue>] Matrix values for specified matrix grouping keys
|
1166
|
+
# @param matrix_values [Array<Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Matrix::MatrixConfig::MatrixValue>] Matrix values for specified matrix grouping keys
|
1180
1167
|
|
1181
1168
|
class MatrixValue < Orb::Internal::Type::BaseModel
|
1182
1169
|
# @!attribute dimension_values
|
@@ -1195,7 +1182,7 @@ module Orb
|
|
1195
1182
|
|
1196
1183
|
# @!method initialize(dimension_values:, unit_amount:)
|
1197
1184
|
# Some parameter documentations has been truncated, see
|
1198
|
-
# {Orb::SubscriptionPriceIntervalsParams::Add::Price::Matrix::MatrixConfig::MatrixValue}
|
1185
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Matrix::MatrixConfig::MatrixValue}
|
1199
1186
|
# for more details.
|
1200
1187
|
#
|
1201
1188
|
# @param dimension_values [Array<String, nil>] One or two matrix keys to filter usage to this Matrix value by. For example, ["r
|
@@ -1204,7 +1191,7 @@ module Orb
|
|
1204
1191
|
end
|
1205
1192
|
end
|
1206
1193
|
|
1207
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::Matrix#billing_cycle_configuration
|
1194
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Matrix#billing_cycle_configuration
|
1208
1195
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
1209
1196
|
# @!attribute duration
|
1210
1197
|
# The duration of the billing period.
|
@@ -1215,7 +1202,7 @@ module Orb
|
|
1215
1202
|
# @!attribute duration_unit
|
1216
1203
|
# The unit of billing period duration.
|
1217
1204
|
#
|
1218
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::Matrix::BillingCycleConfiguration::DurationUnit]
|
1205
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Matrix::BillingCycleConfiguration::DurationUnit]
|
1219
1206
|
required :duration_unit,
|
1220
1207
|
enum: -> {
|
1221
1208
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::Matrix::BillingCycleConfiguration::DurationUnit
|
@@ -1227,11 +1214,11 @@ module Orb
|
|
1227
1214
|
#
|
1228
1215
|
# @param duration [Integer] The duration of the billing period.
|
1229
1216
|
#
|
1230
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::Matrix::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
1217
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Matrix::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
1231
1218
|
|
1232
1219
|
# The unit of billing period duration.
|
1233
1220
|
#
|
1234
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::Matrix::BillingCycleConfiguration#duration_unit
|
1221
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Matrix::BillingCycleConfiguration#duration_unit
|
1235
1222
|
module DurationUnit
|
1236
1223
|
extend Orb::Internal::Type::Enum
|
1237
1224
|
|
@@ -1243,7 +1230,7 @@ module Orb
|
|
1243
1230
|
end
|
1244
1231
|
end
|
1245
1232
|
|
1246
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::Matrix#invoicing_cycle_configuration
|
1233
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Matrix#invoicing_cycle_configuration
|
1247
1234
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
1248
1235
|
# @!attribute duration
|
1249
1236
|
# The duration of the billing period.
|
@@ -1254,7 +1241,7 @@ module Orb
|
|
1254
1241
|
# @!attribute duration_unit
|
1255
1242
|
# The unit of billing period duration.
|
1256
1243
|
#
|
1257
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::Matrix::InvoicingCycleConfiguration::DurationUnit]
|
1244
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Matrix::InvoicingCycleConfiguration::DurationUnit]
|
1258
1245
|
required :duration_unit,
|
1259
1246
|
enum: -> {
|
1260
1247
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::Matrix::InvoicingCycleConfiguration::DurationUnit
|
@@ -1266,11 +1253,11 @@ module Orb
|
|
1266
1253
|
#
|
1267
1254
|
# @param duration [Integer] The duration of the billing period.
|
1268
1255
|
#
|
1269
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::Matrix::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
1256
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Matrix::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
1270
1257
|
|
1271
1258
|
# The unit of billing period duration.
|
1272
1259
|
#
|
1273
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::Matrix::InvoicingCycleConfiguration#duration_unit
|
1260
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Matrix::InvoicingCycleConfiguration#duration_unit
|
1274
1261
|
module DurationUnit
|
1275
1262
|
extend Orb::Internal::Type::Enum
|
1276
1263
|
|
@@ -1287,7 +1274,7 @@ module Orb
|
|
1287
1274
|
# @!attribute cadence
|
1288
1275
|
# The cadence to bill for this price on.
|
1289
1276
|
#
|
1290
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation::Cadence]
|
1277
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation::Cadence]
|
1291
1278
|
required :cadence,
|
1292
1279
|
enum: -> {
|
1293
1280
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation::Cadence
|
@@ -1307,7 +1294,7 @@ module Orb
|
|
1307
1294
|
|
1308
1295
|
# @!attribute matrix_with_allocation_config
|
1309
1296
|
#
|
1310
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation::MatrixWithAllocationConfig]
|
1297
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation::MatrixWithAllocationConfig]
|
1311
1298
|
required :matrix_with_allocation_config,
|
1312
1299
|
-> {
|
1313
1300
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation::MatrixWithAllocationConfig
|
@@ -1342,7 +1329,7 @@ module Orb
|
|
1342
1329
|
# For custom cadence: specifies the duration of the billing period in days or
|
1343
1330
|
# months.
|
1344
1331
|
#
|
1345
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation::BillingCycleConfiguration, nil]
|
1332
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation::BillingCycleConfiguration, nil]
|
1346
1333
|
optional :billing_cycle_configuration,
|
1347
1334
|
-> {
|
1348
1335
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation::BillingCycleConfiguration
|
@@ -1378,7 +1365,7 @@ module Orb
|
|
1378
1365
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
1379
1366
|
# If unspecified, a single invoice is produced per billing cycle.
|
1380
1367
|
#
|
1381
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation::InvoicingCycleConfiguration, nil]
|
1368
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation::InvoicingCycleConfiguration, nil]
|
1382
1369
|
optional :invoicing_cycle_configuration,
|
1383
1370
|
-> {
|
1384
1371
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation::InvoicingCycleConfiguration
|
@@ -1395,16 +1382,16 @@ module Orb
|
|
1395
1382
|
|
1396
1383
|
# @!method initialize(cadence:, currency:, item_id:, matrix_with_allocation_config:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :matrix_with_allocation)
|
1397
1384
|
# Some parameter documentations has been truncated, see
|
1398
|
-
# {Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation}
|
1399
|
-
# more details.
|
1385
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation}
|
1386
|
+
# for more details.
|
1400
1387
|
#
|
1401
|
-
# @param cadence [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation::Cadence] The cadence to bill for this price on.
|
1388
|
+
# @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation::Cadence] The cadence to bill for this price on.
|
1402
1389
|
#
|
1403
1390
|
# @param currency [String] An ISO 4217 currency string for which this price is billed in.
|
1404
1391
|
#
|
1405
1392
|
# @param item_id [String] The id of the item the price will be associated with.
|
1406
1393
|
#
|
1407
|
-
# @param matrix_with_allocation_config [Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation::MatrixWithAllocationConfig]
|
1394
|
+
# @param matrix_with_allocation_config [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation::MatrixWithAllocationConfig]
|
1408
1395
|
#
|
1409
1396
|
# @param name [String] The name of the price.
|
1410
1397
|
#
|
@@ -1412,7 +1399,7 @@ module Orb
|
|
1412
1399
|
#
|
1413
1400
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
1414
1401
|
#
|
1415
|
-
# @param billing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
1402
|
+
# @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
1416
1403
|
#
|
1417
1404
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
1418
1405
|
#
|
@@ -1422,7 +1409,7 @@ module Orb
|
|
1422
1409
|
#
|
1423
1410
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
1424
1411
|
#
|
1425
|
-
# @param invoicing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
1412
|
+
# @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
1426
1413
|
#
|
1427
1414
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
1428
1415
|
#
|
@@ -1430,7 +1417,7 @@ module Orb
|
|
1430
1417
|
|
1431
1418
|
# The cadence to bill for this price on.
|
1432
1419
|
#
|
1433
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation#cadence
|
1420
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation#cadence
|
1434
1421
|
module Cadence
|
1435
1422
|
extend Orb::Internal::Type::Enum
|
1436
1423
|
|
@@ -1445,7 +1432,7 @@ module Orb
|
|
1445
1432
|
# @return [Array<Symbol>]
|
1446
1433
|
end
|
1447
1434
|
|
1448
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation#matrix_with_allocation_config
|
1435
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation#matrix_with_allocation_config
|
1449
1436
|
class MatrixWithAllocationConfig < Orb::Internal::Type::BaseModel
|
1450
1437
|
# @!attribute allocation
|
1451
1438
|
# Allocation to be used to calculate the price
|
@@ -1468,7 +1455,7 @@ module Orb
|
|
1468
1455
|
# @!attribute matrix_values
|
1469
1456
|
# Matrix values for specified matrix grouping keys
|
1470
1457
|
#
|
1471
|
-
# @return [Array<Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation::MatrixWithAllocationConfig::MatrixValue>]
|
1458
|
+
# @return [Array<Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation::MatrixWithAllocationConfig::MatrixValue>]
|
1472
1459
|
required :matrix_values,
|
1473
1460
|
-> do
|
1474
1461
|
Orb::Internal::Type::ArrayOf[
|
@@ -1483,7 +1470,7 @@ module Orb
|
|
1483
1470
|
#
|
1484
1471
|
# @param dimensions [Array<String, nil>] One or two event property values to evaluate matrix groups by
|
1485
1472
|
#
|
1486
|
-
# @param matrix_values [Array<Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation::MatrixWithAllocationConfig::MatrixValue>] Matrix values for specified matrix grouping keys
|
1473
|
+
# @param matrix_values [Array<Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation::MatrixWithAllocationConfig::MatrixValue>] Matrix values for specified matrix grouping keys
|
1487
1474
|
|
1488
1475
|
class MatrixValue < Orb::Internal::Type::BaseModel
|
1489
1476
|
# @!attribute dimension_values
|
@@ -1502,7 +1489,7 @@ module Orb
|
|
1502
1489
|
|
1503
1490
|
# @!method initialize(dimension_values:, unit_amount:)
|
1504
1491
|
# Some parameter documentations has been truncated, see
|
1505
|
-
# {Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation::MatrixWithAllocationConfig::MatrixValue}
|
1492
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation::MatrixWithAllocationConfig::MatrixValue}
|
1506
1493
|
# for more details.
|
1507
1494
|
#
|
1508
1495
|
# @param dimension_values [Array<String, nil>] One or two matrix keys to filter usage to this Matrix value by. For example, ["r
|
@@ -1511,7 +1498,7 @@ module Orb
|
|
1511
1498
|
end
|
1512
1499
|
end
|
1513
1500
|
|
1514
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation#billing_cycle_configuration
|
1501
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation#billing_cycle_configuration
|
1515
1502
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
1516
1503
|
# @!attribute duration
|
1517
1504
|
# The duration of the billing period.
|
@@ -1522,7 +1509,7 @@ module Orb
|
|
1522
1509
|
# @!attribute duration_unit
|
1523
1510
|
# The unit of billing period duration.
|
1524
1511
|
#
|
1525
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation::BillingCycleConfiguration::DurationUnit]
|
1512
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation::BillingCycleConfiguration::DurationUnit]
|
1526
1513
|
required :duration_unit,
|
1527
1514
|
enum: -> {
|
1528
1515
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation::BillingCycleConfiguration::DurationUnit
|
@@ -1534,11 +1521,11 @@ module Orb
|
|
1534
1521
|
#
|
1535
1522
|
# @param duration [Integer] The duration of the billing period.
|
1536
1523
|
#
|
1537
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
1524
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
1538
1525
|
|
1539
1526
|
# The unit of billing period duration.
|
1540
1527
|
#
|
1541
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation::BillingCycleConfiguration#duration_unit
|
1528
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation::BillingCycleConfiguration#duration_unit
|
1542
1529
|
module DurationUnit
|
1543
1530
|
extend Orb::Internal::Type::Enum
|
1544
1531
|
|
@@ -1550,7 +1537,7 @@ module Orb
|
|
1550
1537
|
end
|
1551
1538
|
end
|
1552
1539
|
|
1553
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation#invoicing_cycle_configuration
|
1540
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation#invoicing_cycle_configuration
|
1554
1541
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
1555
1542
|
# @!attribute duration
|
1556
1543
|
# The duration of the billing period.
|
@@ -1561,7 +1548,7 @@ module Orb
|
|
1561
1548
|
# @!attribute duration_unit
|
1562
1549
|
# The unit of billing period duration.
|
1563
1550
|
#
|
1564
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation::InvoicingCycleConfiguration::DurationUnit]
|
1551
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation::InvoicingCycleConfiguration::DurationUnit]
|
1565
1552
|
required :duration_unit,
|
1566
1553
|
enum: -> {
|
1567
1554
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation::InvoicingCycleConfiguration::DurationUnit
|
@@ -1573,11 +1560,11 @@ module Orb
|
|
1573
1560
|
#
|
1574
1561
|
# @param duration [Integer] The duration of the billing period.
|
1575
1562
|
#
|
1576
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
1563
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
1577
1564
|
|
1578
1565
|
# The unit of billing period duration.
|
1579
1566
|
#
|
1580
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation::InvoicingCycleConfiguration#duration_unit
|
1567
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation::InvoicingCycleConfiguration#duration_unit
|
1581
1568
|
module DurationUnit
|
1582
1569
|
extend Orb::Internal::Type::Enum
|
1583
1570
|
|
@@ -1594,7 +1581,7 @@ module Orb
|
|
1594
1581
|
# @!attribute cadence
|
1595
1582
|
# The cadence to bill for this price on.
|
1596
1583
|
#
|
1597
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::Tiered::Cadence]
|
1584
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Tiered::Cadence]
|
1598
1585
|
required :cadence, enum: -> { Orb::SubscriptionPriceIntervalsParams::Add::Price::Tiered::Cadence }
|
1599
1586
|
|
1600
1587
|
# @!attribute currency
|
@@ -1622,7 +1609,7 @@ module Orb
|
|
1622
1609
|
|
1623
1610
|
# @!attribute tiered_config
|
1624
1611
|
#
|
1625
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::Tiered::TieredConfig]
|
1612
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Tiered::TieredConfig]
|
1626
1613
|
required :tiered_config,
|
1627
1614
|
-> {
|
1628
1615
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::Tiered::TieredConfig
|
@@ -1646,7 +1633,7 @@ module Orb
|
|
1646
1633
|
# For custom cadence: specifies the duration of the billing period in days or
|
1647
1634
|
# months.
|
1648
1635
|
#
|
1649
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::Tiered::BillingCycleConfiguration, nil]
|
1636
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Tiered::BillingCycleConfiguration, nil]
|
1650
1637
|
optional :billing_cycle_configuration,
|
1651
1638
|
-> {
|
1652
1639
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::Tiered::BillingCycleConfiguration
|
@@ -1682,7 +1669,7 @@ module Orb
|
|
1682
1669
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
1683
1670
|
# If unspecified, a single invoice is produced per billing cycle.
|
1684
1671
|
#
|
1685
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::Tiered::InvoicingCycleConfiguration, nil]
|
1672
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Tiered::InvoicingCycleConfiguration, nil]
|
1686
1673
|
optional :invoicing_cycle_configuration,
|
1687
1674
|
-> {
|
1688
1675
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::Tiered::InvoicingCycleConfiguration
|
@@ -1699,9 +1686,10 @@ module Orb
|
|
1699
1686
|
|
1700
1687
|
# @!method initialize(cadence:, currency:, item_id:, name:, tiered_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :tiered)
|
1701
1688
|
# Some parameter documentations has been truncated, see
|
1702
|
-
# {Orb::SubscriptionPriceIntervalsParams::Add::Price::Tiered} for more
|
1689
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Tiered} for more
|
1690
|
+
# details.
|
1703
1691
|
#
|
1704
|
-
# @param cadence [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::Tiered::Cadence] The cadence to bill for this price on.
|
1692
|
+
# @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Tiered::Cadence] The cadence to bill for this price on.
|
1705
1693
|
#
|
1706
1694
|
# @param currency [String] An ISO 4217 currency string for which this price is billed in.
|
1707
1695
|
#
|
@@ -1709,13 +1697,13 @@ module Orb
|
|
1709
1697
|
#
|
1710
1698
|
# @param name [String] The name of the price.
|
1711
1699
|
#
|
1712
|
-
# @param tiered_config [Orb::SubscriptionPriceIntervalsParams::Add::Price::Tiered::TieredConfig]
|
1700
|
+
# @param tiered_config [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Tiered::TieredConfig]
|
1713
1701
|
#
|
1714
1702
|
# @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b
|
1715
1703
|
#
|
1716
1704
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
1717
1705
|
#
|
1718
|
-
# @param billing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::Tiered::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
1706
|
+
# @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Tiered::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
1719
1707
|
#
|
1720
1708
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
1721
1709
|
#
|
@@ -1725,7 +1713,7 @@ module Orb
|
|
1725
1713
|
#
|
1726
1714
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
1727
1715
|
#
|
1728
|
-
# @param invoicing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::Tiered::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
1716
|
+
# @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Tiered::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
1729
1717
|
#
|
1730
1718
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
1731
1719
|
#
|
@@ -1733,7 +1721,7 @@ module Orb
|
|
1733
1721
|
|
1734
1722
|
# The cadence to bill for this price on.
|
1735
1723
|
#
|
1736
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::Tiered#cadence
|
1724
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Tiered#cadence
|
1737
1725
|
module Cadence
|
1738
1726
|
extend Orb::Internal::Type::Enum
|
1739
1727
|
|
@@ -1748,19 +1736,19 @@ module Orb
|
|
1748
1736
|
# @return [Array<Symbol>]
|
1749
1737
|
end
|
1750
1738
|
|
1751
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::Tiered#tiered_config
|
1739
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Tiered#tiered_config
|
1752
1740
|
class TieredConfig < Orb::Internal::Type::BaseModel
|
1753
1741
|
# @!attribute tiers
|
1754
1742
|
# Tiers for rating based on total usage quantities into the specified tier
|
1755
1743
|
#
|
1756
|
-
# @return [Array<Orb::SubscriptionPriceIntervalsParams::Add::Price::Tiered::TieredConfig::Tier>]
|
1744
|
+
# @return [Array<Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Tiered::TieredConfig::Tier>]
|
1757
1745
|
required :tiers,
|
1758
1746
|
-> {
|
1759
1747
|
Orb::Internal::Type::ArrayOf[Orb::SubscriptionPriceIntervalsParams::Add::Price::Tiered::TieredConfig::Tier]
|
1760
1748
|
}
|
1761
1749
|
|
1762
1750
|
# @!method initialize(tiers:)
|
1763
|
-
# @param tiers [Array<Orb::SubscriptionPriceIntervalsParams::Add::Price::Tiered::TieredConfig::Tier>] Tiers for rating based on total usage quantities into the specified tier
|
1751
|
+
# @param tiers [Array<Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Tiered::TieredConfig::Tier>] Tiers for rating based on total usage quantities into the specified tier
|
1764
1752
|
|
1765
1753
|
class Tier < Orb::Internal::Type::BaseModel
|
1766
1754
|
# @!attribute first_unit
|
@@ -1790,7 +1778,7 @@ module Orb
|
|
1790
1778
|
end
|
1791
1779
|
end
|
1792
1780
|
|
1793
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::Tiered#billing_cycle_configuration
|
1781
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Tiered#billing_cycle_configuration
|
1794
1782
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
1795
1783
|
# @!attribute duration
|
1796
1784
|
# The duration of the billing period.
|
@@ -1801,7 +1789,7 @@ module Orb
|
|
1801
1789
|
# @!attribute duration_unit
|
1802
1790
|
# The unit of billing period duration.
|
1803
1791
|
#
|
1804
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::Tiered::BillingCycleConfiguration::DurationUnit]
|
1792
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Tiered::BillingCycleConfiguration::DurationUnit]
|
1805
1793
|
required :duration_unit,
|
1806
1794
|
enum: -> {
|
1807
1795
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::Tiered::BillingCycleConfiguration::DurationUnit
|
@@ -1813,11 +1801,11 @@ module Orb
|
|
1813
1801
|
#
|
1814
1802
|
# @param duration [Integer] The duration of the billing period.
|
1815
1803
|
#
|
1816
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::Tiered::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
1804
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Tiered::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
1817
1805
|
|
1818
1806
|
# The unit of billing period duration.
|
1819
1807
|
#
|
1820
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::Tiered::BillingCycleConfiguration#duration_unit
|
1808
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Tiered::BillingCycleConfiguration#duration_unit
|
1821
1809
|
module DurationUnit
|
1822
1810
|
extend Orb::Internal::Type::Enum
|
1823
1811
|
|
@@ -1829,7 +1817,7 @@ module Orb
|
|
1829
1817
|
end
|
1830
1818
|
end
|
1831
1819
|
|
1832
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::Tiered#invoicing_cycle_configuration
|
1820
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Tiered#invoicing_cycle_configuration
|
1833
1821
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
1834
1822
|
# @!attribute duration
|
1835
1823
|
# The duration of the billing period.
|
@@ -1840,7 +1828,7 @@ module Orb
|
|
1840
1828
|
# @!attribute duration_unit
|
1841
1829
|
# The unit of billing period duration.
|
1842
1830
|
#
|
1843
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::Tiered::InvoicingCycleConfiguration::DurationUnit]
|
1831
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Tiered::InvoicingCycleConfiguration::DurationUnit]
|
1844
1832
|
required :duration_unit,
|
1845
1833
|
enum: -> {
|
1846
1834
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::Tiered::InvoicingCycleConfiguration::DurationUnit
|
@@ -1852,11 +1840,11 @@ module Orb
|
|
1852
1840
|
#
|
1853
1841
|
# @param duration [Integer] The duration of the billing period.
|
1854
1842
|
#
|
1855
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::Tiered::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
1843
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Tiered::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
1856
1844
|
|
1857
1845
|
# The unit of billing period duration.
|
1858
1846
|
#
|
1859
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::Tiered::InvoicingCycleConfiguration#duration_unit
|
1847
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Tiered::InvoicingCycleConfiguration#duration_unit
|
1860
1848
|
module DurationUnit
|
1861
1849
|
extend Orb::Internal::Type::Enum
|
1862
1850
|
|
@@ -1873,7 +1861,7 @@ module Orb
|
|
1873
1861
|
# @!attribute cadence
|
1874
1862
|
# The cadence to bill for this price on.
|
1875
1863
|
#
|
1876
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredBps::Cadence]
|
1864
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredBps::Cadence]
|
1877
1865
|
required :cadence,
|
1878
1866
|
enum: -> {
|
1879
1867
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredBps::Cadence
|
@@ -1904,7 +1892,7 @@ module Orb
|
|
1904
1892
|
|
1905
1893
|
# @!attribute tiered_bps_config
|
1906
1894
|
#
|
1907
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredBps::TieredBpsConfig]
|
1895
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredBps::TieredBpsConfig]
|
1908
1896
|
required :tiered_bps_config,
|
1909
1897
|
-> { Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredBps::TieredBpsConfig }
|
1910
1898
|
|
@@ -1926,7 +1914,7 @@ module Orb
|
|
1926
1914
|
# For custom cadence: specifies the duration of the billing period in days or
|
1927
1915
|
# months.
|
1928
1916
|
#
|
1929
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredBps::BillingCycleConfiguration, nil]
|
1917
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredBps::BillingCycleConfiguration, nil]
|
1930
1918
|
optional :billing_cycle_configuration,
|
1931
1919
|
-> {
|
1932
1920
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredBps::BillingCycleConfiguration
|
@@ -1962,7 +1950,7 @@ module Orb
|
|
1962
1950
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
1963
1951
|
# If unspecified, a single invoice is produced per billing cycle.
|
1964
1952
|
#
|
1965
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredBps::InvoicingCycleConfiguration, nil]
|
1953
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredBps::InvoicingCycleConfiguration, nil]
|
1966
1954
|
optional :invoicing_cycle_configuration,
|
1967
1955
|
-> {
|
1968
1956
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredBps::InvoicingCycleConfiguration
|
@@ -1979,9 +1967,10 @@ module Orb
|
|
1979
1967
|
|
1980
1968
|
# @!method initialize(cadence:, currency:, item_id:, name:, tiered_bps_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :tiered_bps)
|
1981
1969
|
# Some parameter documentations has been truncated, see
|
1982
|
-
# {Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredBps} for more
|
1970
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredBps} for more
|
1971
|
+
# details.
|
1983
1972
|
#
|
1984
|
-
# @param cadence [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredBps::Cadence] The cadence to bill for this price on.
|
1973
|
+
# @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredBps::Cadence] The cadence to bill for this price on.
|
1985
1974
|
#
|
1986
1975
|
# @param currency [String] An ISO 4217 currency string for which this price is billed in.
|
1987
1976
|
#
|
@@ -1989,13 +1978,13 @@ module Orb
|
|
1989
1978
|
#
|
1990
1979
|
# @param name [String] The name of the price.
|
1991
1980
|
#
|
1992
|
-
# @param tiered_bps_config [Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredBps::TieredBpsConfig]
|
1981
|
+
# @param tiered_bps_config [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredBps::TieredBpsConfig]
|
1993
1982
|
#
|
1994
1983
|
# @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b
|
1995
1984
|
#
|
1996
1985
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
1997
1986
|
#
|
1998
|
-
# @param billing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredBps::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
1987
|
+
# @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredBps::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
1999
1988
|
#
|
2000
1989
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
2001
1990
|
#
|
@@ -2005,7 +1994,7 @@ module Orb
|
|
2005
1994
|
#
|
2006
1995
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
2007
1996
|
#
|
2008
|
-
# @param invoicing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredBps::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
1997
|
+
# @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredBps::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
2009
1998
|
#
|
2010
1999
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
2011
2000
|
#
|
@@ -2013,7 +2002,7 @@ module Orb
|
|
2013
2002
|
|
2014
2003
|
# The cadence to bill for this price on.
|
2015
2004
|
#
|
2016
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredBps#cadence
|
2005
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredBps#cadence
|
2017
2006
|
module Cadence
|
2018
2007
|
extend Orb::Internal::Type::Enum
|
2019
2008
|
|
@@ -2028,13 +2017,13 @@ module Orb
|
|
2028
2017
|
# @return [Array<Symbol>]
|
2029
2018
|
end
|
2030
2019
|
|
2031
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredBps#tiered_bps_config
|
2020
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredBps#tiered_bps_config
|
2032
2021
|
class TieredBpsConfig < Orb::Internal::Type::BaseModel
|
2033
2022
|
# @!attribute tiers
|
2034
2023
|
# Tiers for a Graduated BPS pricing model, where usage is bucketed into specified
|
2035
2024
|
# tiers
|
2036
2025
|
#
|
2037
|
-
# @return [Array<Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredBps::TieredBpsConfig::Tier>]
|
2026
|
+
# @return [Array<Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredBps::TieredBpsConfig::Tier>]
|
2038
2027
|
required :tiers,
|
2039
2028
|
-> {
|
2040
2029
|
Orb::Internal::Type::ArrayOf[Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredBps::TieredBpsConfig::Tier]
|
@@ -2042,10 +2031,10 @@ module Orb
|
|
2042
2031
|
|
2043
2032
|
# @!method initialize(tiers:)
|
2044
2033
|
# Some parameter documentations has been truncated, see
|
2045
|
-
# {Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredBps::TieredBpsConfig}
|
2034
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredBps::TieredBpsConfig}
|
2046
2035
|
# for more details.
|
2047
2036
|
#
|
2048
|
-
# @param tiers [Array<Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredBps::TieredBpsConfig::Tier>] Tiers for a Graduated BPS pricing model, where usage is bucketed into specified
|
2037
|
+
# @param tiers [Array<Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredBps::TieredBpsConfig::Tier>] Tiers for a Graduated BPS pricing model, where usage is bucketed into specified
|
2049
2038
|
|
2050
2039
|
class Tier < Orb::Internal::Type::BaseModel
|
2051
2040
|
# @!attribute bps
|
@@ -2083,7 +2072,7 @@ module Orb
|
|
2083
2072
|
end
|
2084
2073
|
end
|
2085
2074
|
|
2086
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredBps#billing_cycle_configuration
|
2075
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredBps#billing_cycle_configuration
|
2087
2076
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
2088
2077
|
# @!attribute duration
|
2089
2078
|
# The duration of the billing period.
|
@@ -2094,7 +2083,7 @@ module Orb
|
|
2094
2083
|
# @!attribute duration_unit
|
2095
2084
|
# The unit of billing period duration.
|
2096
2085
|
#
|
2097
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredBps::BillingCycleConfiguration::DurationUnit]
|
2086
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredBps::BillingCycleConfiguration::DurationUnit]
|
2098
2087
|
required :duration_unit,
|
2099
2088
|
enum: -> {
|
2100
2089
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredBps::BillingCycleConfiguration::DurationUnit
|
@@ -2106,11 +2095,11 @@ module Orb
|
|
2106
2095
|
#
|
2107
2096
|
# @param duration [Integer] The duration of the billing period.
|
2108
2097
|
#
|
2109
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredBps::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
2098
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredBps::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
2110
2099
|
|
2111
2100
|
# The unit of billing period duration.
|
2112
2101
|
#
|
2113
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredBps::BillingCycleConfiguration#duration_unit
|
2102
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredBps::BillingCycleConfiguration#duration_unit
|
2114
2103
|
module DurationUnit
|
2115
2104
|
extend Orb::Internal::Type::Enum
|
2116
2105
|
|
@@ -2122,7 +2111,7 @@ module Orb
|
|
2122
2111
|
end
|
2123
2112
|
end
|
2124
2113
|
|
2125
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredBps#invoicing_cycle_configuration
|
2114
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredBps#invoicing_cycle_configuration
|
2126
2115
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
2127
2116
|
# @!attribute duration
|
2128
2117
|
# The duration of the billing period.
|
@@ -2133,7 +2122,7 @@ module Orb
|
|
2133
2122
|
# @!attribute duration_unit
|
2134
2123
|
# The unit of billing period duration.
|
2135
2124
|
#
|
2136
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredBps::InvoicingCycleConfiguration::DurationUnit]
|
2125
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredBps::InvoicingCycleConfiguration::DurationUnit]
|
2137
2126
|
required :duration_unit,
|
2138
2127
|
enum: -> {
|
2139
2128
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredBps::InvoicingCycleConfiguration::DurationUnit
|
@@ -2145,11 +2134,11 @@ module Orb
|
|
2145
2134
|
#
|
2146
2135
|
# @param duration [Integer] The duration of the billing period.
|
2147
2136
|
#
|
2148
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredBps::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
2137
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredBps::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
2149
2138
|
|
2150
2139
|
# The unit of billing period duration.
|
2151
2140
|
#
|
2152
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredBps::InvoicingCycleConfiguration#duration_unit
|
2141
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredBps::InvoicingCycleConfiguration#duration_unit
|
2153
2142
|
module DurationUnit
|
2154
2143
|
extend Orb::Internal::Type::Enum
|
2155
2144
|
|
@@ -2165,13 +2154,13 @@ module Orb
|
|
2165
2154
|
class Bps < Orb::Internal::Type::BaseModel
|
2166
2155
|
# @!attribute bps_config
|
2167
2156
|
#
|
2168
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::Bps::BpsConfig]
|
2157
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bps::BpsConfig]
|
2169
2158
|
required :bps_config, -> { Orb::SubscriptionPriceIntervalsParams::Add::Price::Bps::BpsConfig }
|
2170
2159
|
|
2171
2160
|
# @!attribute cadence
|
2172
2161
|
# The cadence to bill for this price on.
|
2173
2162
|
#
|
2174
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::Bps::Cadence]
|
2163
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bps::Cadence]
|
2175
2164
|
required :cadence, enum: -> { Orb::SubscriptionPriceIntervalsParams::Add::Price::Bps::Cadence }
|
2176
2165
|
|
2177
2166
|
# @!attribute currency
|
@@ -2215,7 +2204,7 @@ module Orb
|
|
2215
2204
|
# For custom cadence: specifies the duration of the billing period in days or
|
2216
2205
|
# months.
|
2217
2206
|
#
|
2218
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::Bps::BillingCycleConfiguration, nil]
|
2207
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bps::BillingCycleConfiguration, nil]
|
2219
2208
|
optional :billing_cycle_configuration,
|
2220
2209
|
-> { Orb::SubscriptionPriceIntervalsParams::Add::Price::Bps::BillingCycleConfiguration },
|
2221
2210
|
nil?: true
|
@@ -2249,7 +2238,7 @@ module Orb
|
|
2249
2238
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
2250
2239
|
# If unspecified, a single invoice is produced per billing cycle.
|
2251
2240
|
#
|
2252
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::Bps::InvoicingCycleConfiguration, nil]
|
2241
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bps::InvoicingCycleConfiguration, nil]
|
2253
2242
|
optional :invoicing_cycle_configuration,
|
2254
2243
|
-> {
|
2255
2244
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::Bps::InvoicingCycleConfiguration
|
@@ -2266,11 +2255,12 @@ module Orb
|
|
2266
2255
|
|
2267
2256
|
# @!method initialize(bps_config:, cadence:, currency:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :bps)
|
2268
2257
|
# Some parameter documentations has been truncated, see
|
2269
|
-
# {Orb::SubscriptionPriceIntervalsParams::Add::Price::Bps} for more
|
2258
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bps} for more
|
2259
|
+
# details.
|
2270
2260
|
#
|
2271
|
-
# @param bps_config [Orb::SubscriptionPriceIntervalsParams::Add::Price::Bps::BpsConfig]
|
2261
|
+
# @param bps_config [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bps::BpsConfig]
|
2272
2262
|
#
|
2273
|
-
# @param cadence [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::Bps::Cadence] The cadence to bill for this price on.
|
2263
|
+
# @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bps::Cadence] The cadence to bill for this price on.
|
2274
2264
|
#
|
2275
2265
|
# @param currency [String] An ISO 4217 currency string for which this price is billed in.
|
2276
2266
|
#
|
@@ -2282,7 +2272,7 @@ module Orb
|
|
2282
2272
|
#
|
2283
2273
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
2284
2274
|
#
|
2285
|
-
# @param billing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::Bps::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
2275
|
+
# @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bps::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
2286
2276
|
#
|
2287
2277
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
2288
2278
|
#
|
@@ -2292,13 +2282,13 @@ module Orb
|
|
2292
2282
|
#
|
2293
2283
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
2294
2284
|
#
|
2295
|
-
# @param invoicing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::Bps::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
2285
|
+
# @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bps::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
2296
2286
|
#
|
2297
2287
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
2298
2288
|
#
|
2299
2289
|
# @param model_type [Symbol, :bps]
|
2300
2290
|
|
2301
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::Bps#bps_config
|
2291
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bps#bps_config
|
2302
2292
|
class BpsConfig < Orb::Internal::Type::BaseModel
|
2303
2293
|
# @!attribute bps
|
2304
2294
|
# Basis point take rate per event
|
@@ -2320,7 +2310,7 @@ module Orb
|
|
2320
2310
|
|
2321
2311
|
# The cadence to bill for this price on.
|
2322
2312
|
#
|
2323
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::Bps#cadence
|
2313
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bps#cadence
|
2324
2314
|
module Cadence
|
2325
2315
|
extend Orb::Internal::Type::Enum
|
2326
2316
|
|
@@ -2335,7 +2325,7 @@ module Orb
|
|
2335
2325
|
# @return [Array<Symbol>]
|
2336
2326
|
end
|
2337
2327
|
|
2338
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::Bps#billing_cycle_configuration
|
2328
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bps#billing_cycle_configuration
|
2339
2329
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
2340
2330
|
# @!attribute duration
|
2341
2331
|
# The duration of the billing period.
|
@@ -2346,7 +2336,7 @@ module Orb
|
|
2346
2336
|
# @!attribute duration_unit
|
2347
2337
|
# The unit of billing period duration.
|
2348
2338
|
#
|
2349
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::Bps::BillingCycleConfiguration::DurationUnit]
|
2339
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bps::BillingCycleConfiguration::DurationUnit]
|
2350
2340
|
required :duration_unit,
|
2351
2341
|
enum: -> {
|
2352
2342
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::Bps::BillingCycleConfiguration::DurationUnit
|
@@ -2358,11 +2348,11 @@ module Orb
|
|
2358
2348
|
#
|
2359
2349
|
# @param duration [Integer] The duration of the billing period.
|
2360
2350
|
#
|
2361
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::Bps::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
2351
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bps::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
2362
2352
|
|
2363
2353
|
# The unit of billing period duration.
|
2364
2354
|
#
|
2365
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::Bps::BillingCycleConfiguration#duration_unit
|
2355
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bps::BillingCycleConfiguration#duration_unit
|
2366
2356
|
module DurationUnit
|
2367
2357
|
extend Orb::Internal::Type::Enum
|
2368
2358
|
|
@@ -2374,7 +2364,7 @@ module Orb
|
|
2374
2364
|
end
|
2375
2365
|
end
|
2376
2366
|
|
2377
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::Bps#invoicing_cycle_configuration
|
2367
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bps#invoicing_cycle_configuration
|
2378
2368
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
2379
2369
|
# @!attribute duration
|
2380
2370
|
# The duration of the billing period.
|
@@ -2385,7 +2375,7 @@ module Orb
|
|
2385
2375
|
# @!attribute duration_unit
|
2386
2376
|
# The unit of billing period duration.
|
2387
2377
|
#
|
2388
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::Bps::InvoicingCycleConfiguration::DurationUnit]
|
2378
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bps::InvoicingCycleConfiguration::DurationUnit]
|
2389
2379
|
required :duration_unit,
|
2390
2380
|
enum: -> {
|
2391
2381
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::Bps::InvoicingCycleConfiguration::DurationUnit
|
@@ -2397,11 +2387,11 @@ module Orb
|
|
2397
2387
|
#
|
2398
2388
|
# @param duration [Integer] The duration of the billing period.
|
2399
2389
|
#
|
2400
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::Bps::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
2390
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bps::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
2401
2391
|
|
2402
2392
|
# The unit of billing period duration.
|
2403
2393
|
#
|
2404
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::Bps::InvoicingCycleConfiguration#duration_unit
|
2394
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bps::InvoicingCycleConfiguration#duration_unit
|
2405
2395
|
module DurationUnit
|
2406
2396
|
extend Orb::Internal::Type::Enum
|
2407
2397
|
|
@@ -2417,14 +2407,14 @@ module Orb
|
|
2417
2407
|
class BulkBps < Orb::Internal::Type::BaseModel
|
2418
2408
|
# @!attribute bulk_bps_config
|
2419
2409
|
#
|
2420
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkBps::BulkBpsConfig]
|
2410
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkBps::BulkBpsConfig]
|
2421
2411
|
required :bulk_bps_config,
|
2422
2412
|
-> { Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkBps::BulkBpsConfig }
|
2423
2413
|
|
2424
2414
|
# @!attribute cadence
|
2425
2415
|
# The cadence to bill for this price on.
|
2426
2416
|
#
|
2427
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkBps::Cadence]
|
2417
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkBps::Cadence]
|
2428
2418
|
required :cadence,
|
2429
2419
|
enum: -> {
|
2430
2420
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkBps::Cadence
|
@@ -2471,7 +2461,7 @@ module Orb
|
|
2471
2461
|
# For custom cadence: specifies the duration of the billing period in days or
|
2472
2462
|
# months.
|
2473
2463
|
#
|
2474
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkBps::BillingCycleConfiguration, nil]
|
2464
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkBps::BillingCycleConfiguration, nil]
|
2475
2465
|
optional :billing_cycle_configuration,
|
2476
2466
|
-> {
|
2477
2467
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkBps::BillingCycleConfiguration
|
@@ -2507,7 +2497,7 @@ module Orb
|
|
2507
2497
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
2508
2498
|
# If unspecified, a single invoice is produced per billing cycle.
|
2509
2499
|
#
|
2510
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkBps::InvoicingCycleConfiguration, nil]
|
2500
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkBps::InvoicingCycleConfiguration, nil]
|
2511
2501
|
optional :invoicing_cycle_configuration,
|
2512
2502
|
-> {
|
2513
2503
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkBps::InvoicingCycleConfiguration
|
@@ -2524,11 +2514,12 @@ module Orb
|
|
2524
2514
|
|
2525
2515
|
# @!method initialize(bulk_bps_config:, cadence:, currency:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :bulk_bps)
|
2526
2516
|
# Some parameter documentations has been truncated, see
|
2527
|
-
# {Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkBps} for more
|
2517
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkBps} for more
|
2518
|
+
# details.
|
2528
2519
|
#
|
2529
|
-
# @param bulk_bps_config [Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkBps::BulkBpsConfig]
|
2520
|
+
# @param bulk_bps_config [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkBps::BulkBpsConfig]
|
2530
2521
|
#
|
2531
|
-
# @param cadence [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkBps::Cadence] The cadence to bill for this price on.
|
2522
|
+
# @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkBps::Cadence] The cadence to bill for this price on.
|
2532
2523
|
#
|
2533
2524
|
# @param currency [String] An ISO 4217 currency string for which this price is billed in.
|
2534
2525
|
#
|
@@ -2540,7 +2531,7 @@ module Orb
|
|
2540
2531
|
#
|
2541
2532
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
2542
2533
|
#
|
2543
|
-
# @param billing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkBps::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
2534
|
+
# @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkBps::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
2544
2535
|
#
|
2545
2536
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
2546
2537
|
#
|
@@ -2550,19 +2541,19 @@ module Orb
|
|
2550
2541
|
#
|
2551
2542
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
2552
2543
|
#
|
2553
|
-
# @param invoicing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkBps::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
2544
|
+
# @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkBps::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
2554
2545
|
#
|
2555
2546
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
2556
2547
|
#
|
2557
2548
|
# @param model_type [Symbol, :bulk_bps]
|
2558
2549
|
|
2559
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkBps#bulk_bps_config
|
2550
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkBps#bulk_bps_config
|
2560
2551
|
class BulkBpsConfig < Orb::Internal::Type::BaseModel
|
2561
2552
|
# @!attribute tiers
|
2562
2553
|
# Tiers for a bulk BPS pricing model where all usage is aggregated to a single
|
2563
2554
|
# tier based on total volume
|
2564
2555
|
#
|
2565
|
-
# @return [Array<Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkBps::BulkBpsConfig::Tier>]
|
2556
|
+
# @return [Array<Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkBps::BulkBpsConfig::Tier>]
|
2566
2557
|
required :tiers,
|
2567
2558
|
-> {
|
2568
2559
|
Orb::Internal::Type::ArrayOf[Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkBps::BulkBpsConfig::Tier]
|
@@ -2570,10 +2561,10 @@ module Orb
|
|
2570
2561
|
|
2571
2562
|
# @!method initialize(tiers:)
|
2572
2563
|
# Some parameter documentations has been truncated, see
|
2573
|
-
# {Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkBps::BulkBpsConfig}
|
2574
|
-
# more details.
|
2564
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkBps::BulkBpsConfig}
|
2565
|
+
# for more details.
|
2575
2566
|
#
|
2576
|
-
# @param tiers [Array<Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkBps::BulkBpsConfig::Tier>] Tiers for a bulk BPS pricing model where all usage is aggregated to a single tie
|
2567
|
+
# @param tiers [Array<Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkBps::BulkBpsConfig::Tier>] Tiers for a bulk BPS pricing model where all usage is aggregated to a single tie
|
2577
2568
|
|
2578
2569
|
class Tier < Orb::Internal::Type::BaseModel
|
2579
2570
|
# @!attribute bps
|
@@ -2605,7 +2596,7 @@ module Orb
|
|
2605
2596
|
|
2606
2597
|
# The cadence to bill for this price on.
|
2607
2598
|
#
|
2608
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkBps#cadence
|
2599
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkBps#cadence
|
2609
2600
|
module Cadence
|
2610
2601
|
extend Orb::Internal::Type::Enum
|
2611
2602
|
|
@@ -2620,7 +2611,7 @@ module Orb
|
|
2620
2611
|
# @return [Array<Symbol>]
|
2621
2612
|
end
|
2622
2613
|
|
2623
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkBps#billing_cycle_configuration
|
2614
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkBps#billing_cycle_configuration
|
2624
2615
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
2625
2616
|
# @!attribute duration
|
2626
2617
|
# The duration of the billing period.
|
@@ -2631,7 +2622,7 @@ module Orb
|
|
2631
2622
|
# @!attribute duration_unit
|
2632
2623
|
# The unit of billing period duration.
|
2633
2624
|
#
|
2634
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkBps::BillingCycleConfiguration::DurationUnit]
|
2625
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkBps::BillingCycleConfiguration::DurationUnit]
|
2635
2626
|
required :duration_unit,
|
2636
2627
|
enum: -> {
|
2637
2628
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkBps::BillingCycleConfiguration::DurationUnit
|
@@ -2643,11 +2634,11 @@ module Orb
|
|
2643
2634
|
#
|
2644
2635
|
# @param duration [Integer] The duration of the billing period.
|
2645
2636
|
#
|
2646
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkBps::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
2637
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkBps::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
2647
2638
|
|
2648
2639
|
# The unit of billing period duration.
|
2649
2640
|
#
|
2650
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkBps::BillingCycleConfiguration#duration_unit
|
2641
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkBps::BillingCycleConfiguration#duration_unit
|
2651
2642
|
module DurationUnit
|
2652
2643
|
extend Orb::Internal::Type::Enum
|
2653
2644
|
|
@@ -2659,7 +2650,7 @@ module Orb
|
|
2659
2650
|
end
|
2660
2651
|
end
|
2661
2652
|
|
2662
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkBps#invoicing_cycle_configuration
|
2653
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkBps#invoicing_cycle_configuration
|
2663
2654
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
2664
2655
|
# @!attribute duration
|
2665
2656
|
# The duration of the billing period.
|
@@ -2670,7 +2661,7 @@ module Orb
|
|
2670
2661
|
# @!attribute duration_unit
|
2671
2662
|
# The unit of billing period duration.
|
2672
2663
|
#
|
2673
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkBps::InvoicingCycleConfiguration::DurationUnit]
|
2664
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkBps::InvoicingCycleConfiguration::DurationUnit]
|
2674
2665
|
required :duration_unit,
|
2675
2666
|
enum: -> {
|
2676
2667
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkBps::InvoicingCycleConfiguration::DurationUnit
|
@@ -2682,11 +2673,11 @@ module Orb
|
|
2682
2673
|
#
|
2683
2674
|
# @param duration [Integer] The duration of the billing period.
|
2684
2675
|
#
|
2685
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkBps::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
2676
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkBps::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
2686
2677
|
|
2687
2678
|
# The unit of billing period duration.
|
2688
2679
|
#
|
2689
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkBps::InvoicingCycleConfiguration#duration_unit
|
2680
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkBps::InvoicingCycleConfiguration#duration_unit
|
2690
2681
|
module DurationUnit
|
2691
2682
|
extend Orb::Internal::Type::Enum
|
2692
2683
|
|
@@ -2702,13 +2693,13 @@ module Orb
|
|
2702
2693
|
class Bulk < Orb::Internal::Type::BaseModel
|
2703
2694
|
# @!attribute bulk_config
|
2704
2695
|
#
|
2705
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::Bulk::BulkConfig]
|
2696
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bulk::BulkConfig]
|
2706
2697
|
required :bulk_config, -> { Orb::SubscriptionPriceIntervalsParams::Add::Price::Bulk::BulkConfig }
|
2707
2698
|
|
2708
2699
|
# @!attribute cadence
|
2709
2700
|
# The cadence to bill for this price on.
|
2710
2701
|
#
|
2711
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::Bulk::Cadence]
|
2702
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bulk::Cadence]
|
2712
2703
|
required :cadence, enum: -> { Orb::SubscriptionPriceIntervalsParams::Add::Price::Bulk::Cadence }
|
2713
2704
|
|
2714
2705
|
# @!attribute currency
|
@@ -2752,7 +2743,7 @@ module Orb
|
|
2752
2743
|
# For custom cadence: specifies the duration of the billing period in days or
|
2753
2744
|
# months.
|
2754
2745
|
#
|
2755
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::Bulk::BillingCycleConfiguration, nil]
|
2746
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bulk::BillingCycleConfiguration, nil]
|
2756
2747
|
optional :billing_cycle_configuration,
|
2757
2748
|
-> {
|
2758
2749
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::Bulk::BillingCycleConfiguration
|
@@ -2788,7 +2779,7 @@ module Orb
|
|
2788
2779
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
2789
2780
|
# If unspecified, a single invoice is produced per billing cycle.
|
2790
2781
|
#
|
2791
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::Bulk::InvoicingCycleConfiguration, nil]
|
2782
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bulk::InvoicingCycleConfiguration, nil]
|
2792
2783
|
optional :invoicing_cycle_configuration,
|
2793
2784
|
-> {
|
2794
2785
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::Bulk::InvoicingCycleConfiguration
|
@@ -2805,11 +2796,12 @@ module Orb
|
|
2805
2796
|
|
2806
2797
|
# @!method initialize(bulk_config:, cadence:, currency:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :bulk)
|
2807
2798
|
# Some parameter documentations has been truncated, see
|
2808
|
-
# {Orb::SubscriptionPriceIntervalsParams::Add::Price::Bulk} for more
|
2799
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bulk} for more
|
2800
|
+
# details.
|
2809
2801
|
#
|
2810
|
-
# @param bulk_config [Orb::SubscriptionPriceIntervalsParams::Add::Price::Bulk::BulkConfig]
|
2802
|
+
# @param bulk_config [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bulk::BulkConfig]
|
2811
2803
|
#
|
2812
|
-
# @param cadence [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::Bulk::Cadence] The cadence to bill for this price on.
|
2804
|
+
# @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bulk::Cadence] The cadence to bill for this price on.
|
2813
2805
|
#
|
2814
2806
|
# @param currency [String] An ISO 4217 currency string for which this price is billed in.
|
2815
2807
|
#
|
@@ -2821,7 +2813,7 @@ module Orb
|
|
2821
2813
|
#
|
2822
2814
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
2823
2815
|
#
|
2824
|
-
# @param billing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::Bulk::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
2816
|
+
# @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bulk::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
2825
2817
|
#
|
2826
2818
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
2827
2819
|
#
|
@@ -2831,25 +2823,25 @@ module Orb
|
|
2831
2823
|
#
|
2832
2824
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
2833
2825
|
#
|
2834
|
-
# @param invoicing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::Bulk::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
2826
|
+
# @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bulk::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
2835
2827
|
#
|
2836
2828
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
2837
2829
|
#
|
2838
2830
|
# @param model_type [Symbol, :bulk]
|
2839
2831
|
|
2840
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::Bulk#bulk_config
|
2832
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bulk#bulk_config
|
2841
2833
|
class BulkConfig < Orb::Internal::Type::BaseModel
|
2842
2834
|
# @!attribute tiers
|
2843
2835
|
# Bulk tiers for rating based on total usage volume
|
2844
2836
|
#
|
2845
|
-
# @return [Array<Orb::SubscriptionPriceIntervalsParams::Add::Price::Bulk::BulkConfig::Tier>]
|
2837
|
+
# @return [Array<Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bulk::BulkConfig::Tier>]
|
2846
2838
|
required :tiers,
|
2847
2839
|
-> {
|
2848
2840
|
Orb::Internal::Type::ArrayOf[Orb::SubscriptionPriceIntervalsParams::Add::Price::Bulk::BulkConfig::Tier]
|
2849
2841
|
}
|
2850
2842
|
|
2851
2843
|
# @!method initialize(tiers:)
|
2852
|
-
# @param tiers [Array<Orb::SubscriptionPriceIntervalsParams::Add::Price::Bulk::BulkConfig::Tier>] Bulk tiers for rating based on total usage volume
|
2844
|
+
# @param tiers [Array<Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bulk::BulkConfig::Tier>] Bulk tiers for rating based on total usage volume
|
2853
2845
|
|
2854
2846
|
class Tier < Orb::Internal::Type::BaseModel
|
2855
2847
|
# @!attribute unit_amount
|
@@ -2873,7 +2865,7 @@ module Orb
|
|
2873
2865
|
|
2874
2866
|
# The cadence to bill for this price on.
|
2875
2867
|
#
|
2876
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::Bulk#cadence
|
2868
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bulk#cadence
|
2877
2869
|
module Cadence
|
2878
2870
|
extend Orb::Internal::Type::Enum
|
2879
2871
|
|
@@ -2888,7 +2880,7 @@ module Orb
|
|
2888
2880
|
# @return [Array<Symbol>]
|
2889
2881
|
end
|
2890
2882
|
|
2891
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::Bulk#billing_cycle_configuration
|
2883
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bulk#billing_cycle_configuration
|
2892
2884
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
2893
2885
|
# @!attribute duration
|
2894
2886
|
# The duration of the billing period.
|
@@ -2899,7 +2891,7 @@ module Orb
|
|
2899
2891
|
# @!attribute duration_unit
|
2900
2892
|
# The unit of billing period duration.
|
2901
2893
|
#
|
2902
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::Bulk::BillingCycleConfiguration::DurationUnit]
|
2894
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bulk::BillingCycleConfiguration::DurationUnit]
|
2903
2895
|
required :duration_unit,
|
2904
2896
|
enum: -> {
|
2905
2897
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::Bulk::BillingCycleConfiguration::DurationUnit
|
@@ -2911,11 +2903,11 @@ module Orb
|
|
2911
2903
|
#
|
2912
2904
|
# @param duration [Integer] The duration of the billing period.
|
2913
2905
|
#
|
2914
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::Bulk::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
2906
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bulk::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
2915
2907
|
|
2916
2908
|
# The unit of billing period duration.
|
2917
2909
|
#
|
2918
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::Bulk::BillingCycleConfiguration#duration_unit
|
2910
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bulk::BillingCycleConfiguration#duration_unit
|
2919
2911
|
module DurationUnit
|
2920
2912
|
extend Orb::Internal::Type::Enum
|
2921
2913
|
|
@@ -2927,7 +2919,7 @@ module Orb
|
|
2927
2919
|
end
|
2928
2920
|
end
|
2929
2921
|
|
2930
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::Bulk#invoicing_cycle_configuration
|
2922
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bulk#invoicing_cycle_configuration
|
2931
2923
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
2932
2924
|
# @!attribute duration
|
2933
2925
|
# The duration of the billing period.
|
@@ -2938,7 +2930,7 @@ module Orb
|
|
2938
2930
|
# @!attribute duration_unit
|
2939
2931
|
# The unit of billing period duration.
|
2940
2932
|
#
|
2941
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::Bulk::InvoicingCycleConfiguration::DurationUnit]
|
2933
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bulk::InvoicingCycleConfiguration::DurationUnit]
|
2942
2934
|
required :duration_unit,
|
2943
2935
|
enum: -> {
|
2944
2936
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::Bulk::InvoicingCycleConfiguration::DurationUnit
|
@@ -2950,11 +2942,11 @@ module Orb
|
|
2950
2942
|
#
|
2951
2943
|
# @param duration [Integer] The duration of the billing period.
|
2952
2944
|
#
|
2953
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::Bulk::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
2945
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bulk::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
2954
2946
|
|
2955
2947
|
# The unit of billing period duration.
|
2956
2948
|
#
|
2957
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::Bulk::InvoicingCycleConfiguration#duration_unit
|
2949
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bulk::InvoicingCycleConfiguration#duration_unit
|
2958
2950
|
module DurationUnit
|
2959
2951
|
extend Orb::Internal::Type::Enum
|
2960
2952
|
|
@@ -2971,7 +2963,7 @@ module Orb
|
|
2971
2963
|
# @!attribute cadence
|
2972
2964
|
# The cadence to bill for this price on.
|
2973
2965
|
#
|
2974
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount::Cadence]
|
2966
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount::Cadence]
|
2975
2967
|
required :cadence,
|
2976
2968
|
enum: -> {
|
2977
2969
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount::Cadence
|
@@ -3023,7 +3015,7 @@ module Orb
|
|
3023
3015
|
# For custom cadence: specifies the duration of the billing period in days or
|
3024
3016
|
# months.
|
3025
3017
|
#
|
3026
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount::BillingCycleConfiguration, nil]
|
3018
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount::BillingCycleConfiguration, nil]
|
3027
3019
|
optional :billing_cycle_configuration,
|
3028
3020
|
-> {
|
3029
3021
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount::BillingCycleConfiguration
|
@@ -3059,7 +3051,7 @@ module Orb
|
|
3059
3051
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
3060
3052
|
# If unspecified, a single invoice is produced per billing cycle.
|
3061
3053
|
#
|
3062
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount::InvoicingCycleConfiguration, nil]
|
3054
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount::InvoicingCycleConfiguration, nil]
|
3063
3055
|
optional :invoicing_cycle_configuration,
|
3064
3056
|
-> {
|
3065
3057
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount::InvoicingCycleConfiguration
|
@@ -3076,10 +3068,10 @@ module Orb
|
|
3076
3068
|
|
3077
3069
|
# @!method initialize(cadence:, currency:, item_id:, name:, threshold_total_amount_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :threshold_total_amount)
|
3078
3070
|
# Some parameter documentations has been truncated, see
|
3079
|
-
# {Orb::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount}
|
3080
|
-
# more details.
|
3071
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount}
|
3072
|
+
# for more details.
|
3081
3073
|
#
|
3082
|
-
# @param cadence [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount::Cadence] The cadence to bill for this price on.
|
3074
|
+
# @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount::Cadence] The cadence to bill for this price on.
|
3083
3075
|
#
|
3084
3076
|
# @param currency [String] An ISO 4217 currency string for which this price is billed in.
|
3085
3077
|
#
|
@@ -3093,7 +3085,7 @@ module Orb
|
|
3093
3085
|
#
|
3094
3086
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
3095
3087
|
#
|
3096
|
-
# @param billing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
3088
|
+
# @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
3097
3089
|
#
|
3098
3090
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
3099
3091
|
#
|
@@ -3103,7 +3095,7 @@ module Orb
|
|
3103
3095
|
#
|
3104
3096
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
3105
3097
|
#
|
3106
|
-
# @param invoicing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
3098
|
+
# @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
3107
3099
|
#
|
3108
3100
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
3109
3101
|
#
|
@@ -3111,7 +3103,7 @@ module Orb
|
|
3111
3103
|
|
3112
3104
|
# The cadence to bill for this price on.
|
3113
3105
|
#
|
3114
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount#cadence
|
3106
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount#cadence
|
3115
3107
|
module Cadence
|
3116
3108
|
extend Orb::Internal::Type::Enum
|
3117
3109
|
|
@@ -3126,7 +3118,7 @@ module Orb
|
|
3126
3118
|
# @return [Array<Symbol>]
|
3127
3119
|
end
|
3128
3120
|
|
3129
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount#billing_cycle_configuration
|
3121
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount#billing_cycle_configuration
|
3130
3122
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
3131
3123
|
# @!attribute duration
|
3132
3124
|
# The duration of the billing period.
|
@@ -3137,7 +3129,7 @@ module Orb
|
|
3137
3129
|
# @!attribute duration_unit
|
3138
3130
|
# The unit of billing period duration.
|
3139
3131
|
#
|
3140
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount::BillingCycleConfiguration::DurationUnit]
|
3132
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount::BillingCycleConfiguration::DurationUnit]
|
3141
3133
|
required :duration_unit,
|
3142
3134
|
enum: -> {
|
3143
3135
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount::BillingCycleConfiguration::DurationUnit
|
@@ -3149,11 +3141,11 @@ module Orb
|
|
3149
3141
|
#
|
3150
3142
|
# @param duration [Integer] The duration of the billing period.
|
3151
3143
|
#
|
3152
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
3144
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
3153
3145
|
|
3154
3146
|
# The unit of billing period duration.
|
3155
3147
|
#
|
3156
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount::BillingCycleConfiguration#duration_unit
|
3148
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount::BillingCycleConfiguration#duration_unit
|
3157
3149
|
module DurationUnit
|
3158
3150
|
extend Orb::Internal::Type::Enum
|
3159
3151
|
|
@@ -3165,7 +3157,7 @@ module Orb
|
|
3165
3157
|
end
|
3166
3158
|
end
|
3167
3159
|
|
3168
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount#invoicing_cycle_configuration
|
3160
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount#invoicing_cycle_configuration
|
3169
3161
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
3170
3162
|
# @!attribute duration
|
3171
3163
|
# The duration of the billing period.
|
@@ -3176,7 +3168,7 @@ module Orb
|
|
3176
3168
|
# @!attribute duration_unit
|
3177
3169
|
# The unit of billing period duration.
|
3178
3170
|
#
|
3179
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount::InvoicingCycleConfiguration::DurationUnit]
|
3171
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount::InvoicingCycleConfiguration::DurationUnit]
|
3180
3172
|
required :duration_unit,
|
3181
3173
|
enum: -> {
|
3182
3174
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount::InvoicingCycleConfiguration::DurationUnit
|
@@ -3188,11 +3180,11 @@ module Orb
|
|
3188
3180
|
#
|
3189
3181
|
# @param duration [Integer] The duration of the billing period.
|
3190
3182
|
#
|
3191
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
3183
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
3192
3184
|
|
3193
3185
|
# The unit of billing period duration.
|
3194
3186
|
#
|
3195
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount::InvoicingCycleConfiguration#duration_unit
|
3187
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount::InvoicingCycleConfiguration#duration_unit
|
3196
3188
|
module DurationUnit
|
3197
3189
|
extend Orb::Internal::Type::Enum
|
3198
3190
|
|
@@ -3209,7 +3201,7 @@ module Orb
|
|
3209
3201
|
# @!attribute cadence
|
3210
3202
|
# The cadence to bill for this price on.
|
3211
3203
|
#
|
3212
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage::Cadence]
|
3204
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage::Cadence]
|
3213
3205
|
required :cadence,
|
3214
3206
|
enum: -> {
|
3215
3207
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage::Cadence
|
@@ -3261,7 +3253,7 @@ module Orb
|
|
3261
3253
|
# For custom cadence: specifies the duration of the billing period in days or
|
3262
3254
|
# months.
|
3263
3255
|
#
|
3264
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage::BillingCycleConfiguration, nil]
|
3256
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage::BillingCycleConfiguration, nil]
|
3265
3257
|
optional :billing_cycle_configuration,
|
3266
3258
|
-> {
|
3267
3259
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage::BillingCycleConfiguration
|
@@ -3297,7 +3289,7 @@ module Orb
|
|
3297
3289
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
3298
3290
|
# If unspecified, a single invoice is produced per billing cycle.
|
3299
3291
|
#
|
3300
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage::InvoicingCycleConfiguration, nil]
|
3292
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage::InvoicingCycleConfiguration, nil]
|
3301
3293
|
optional :invoicing_cycle_configuration,
|
3302
3294
|
-> {
|
3303
3295
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage::InvoicingCycleConfiguration
|
@@ -3314,10 +3306,10 @@ module Orb
|
|
3314
3306
|
|
3315
3307
|
# @!method initialize(cadence:, currency:, item_id:, name:, tiered_package_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :tiered_package)
|
3316
3308
|
# Some parameter documentations has been truncated, see
|
3317
|
-
# {Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage} for
|
3318
|
-
# details.
|
3309
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage} for
|
3310
|
+
# more details.
|
3319
3311
|
#
|
3320
|
-
# @param cadence [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage::Cadence] The cadence to bill for this price on.
|
3312
|
+
# @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage::Cadence] The cadence to bill for this price on.
|
3321
3313
|
#
|
3322
3314
|
# @param currency [String] An ISO 4217 currency string for which this price is billed in.
|
3323
3315
|
#
|
@@ -3331,7 +3323,7 @@ module Orb
|
|
3331
3323
|
#
|
3332
3324
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
3333
3325
|
#
|
3334
|
-
# @param billing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
3326
|
+
# @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
3335
3327
|
#
|
3336
3328
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
3337
3329
|
#
|
@@ -3341,7 +3333,7 @@ module Orb
|
|
3341
3333
|
#
|
3342
3334
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
3343
3335
|
#
|
3344
|
-
# @param invoicing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
3336
|
+
# @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
3345
3337
|
#
|
3346
3338
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
3347
3339
|
#
|
@@ -3349,7 +3341,7 @@ module Orb
|
|
3349
3341
|
|
3350
3342
|
# The cadence to bill for this price on.
|
3351
3343
|
#
|
3352
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage#cadence
|
3344
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage#cadence
|
3353
3345
|
module Cadence
|
3354
3346
|
extend Orb::Internal::Type::Enum
|
3355
3347
|
|
@@ -3364,7 +3356,7 @@ module Orb
|
|
3364
3356
|
# @return [Array<Symbol>]
|
3365
3357
|
end
|
3366
3358
|
|
3367
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage#billing_cycle_configuration
|
3359
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage#billing_cycle_configuration
|
3368
3360
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
3369
3361
|
# @!attribute duration
|
3370
3362
|
# The duration of the billing period.
|
@@ -3375,7 +3367,7 @@ module Orb
|
|
3375
3367
|
# @!attribute duration_unit
|
3376
3368
|
# The unit of billing period duration.
|
3377
3369
|
#
|
3378
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage::BillingCycleConfiguration::DurationUnit]
|
3370
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage::BillingCycleConfiguration::DurationUnit]
|
3379
3371
|
required :duration_unit,
|
3380
3372
|
enum: -> {
|
3381
3373
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage::BillingCycleConfiguration::DurationUnit
|
@@ -3387,11 +3379,11 @@ module Orb
|
|
3387
3379
|
#
|
3388
3380
|
# @param duration [Integer] The duration of the billing period.
|
3389
3381
|
#
|
3390
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
3382
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
3391
3383
|
|
3392
3384
|
# The unit of billing period duration.
|
3393
3385
|
#
|
3394
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage::BillingCycleConfiguration#duration_unit
|
3386
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage::BillingCycleConfiguration#duration_unit
|
3395
3387
|
module DurationUnit
|
3396
3388
|
extend Orb::Internal::Type::Enum
|
3397
3389
|
|
@@ -3403,7 +3395,7 @@ module Orb
|
|
3403
3395
|
end
|
3404
3396
|
end
|
3405
3397
|
|
3406
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage#invoicing_cycle_configuration
|
3398
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage#invoicing_cycle_configuration
|
3407
3399
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
3408
3400
|
# @!attribute duration
|
3409
3401
|
# The duration of the billing period.
|
@@ -3414,7 +3406,7 @@ module Orb
|
|
3414
3406
|
# @!attribute duration_unit
|
3415
3407
|
# The unit of billing period duration.
|
3416
3408
|
#
|
3417
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage::InvoicingCycleConfiguration::DurationUnit]
|
3409
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage::InvoicingCycleConfiguration::DurationUnit]
|
3418
3410
|
required :duration_unit,
|
3419
3411
|
enum: -> {
|
3420
3412
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage::InvoicingCycleConfiguration::DurationUnit
|
@@ -3426,11 +3418,11 @@ module Orb
|
|
3426
3418
|
#
|
3427
3419
|
# @param duration [Integer] The duration of the billing period.
|
3428
3420
|
#
|
3429
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
3421
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
3430
3422
|
|
3431
3423
|
# The unit of billing period duration.
|
3432
3424
|
#
|
3433
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage::InvoicingCycleConfiguration#duration_unit
|
3425
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage::InvoicingCycleConfiguration#duration_unit
|
3434
3426
|
module DurationUnit
|
3435
3427
|
extend Orb::Internal::Type::Enum
|
3436
3428
|
|
@@ -3447,7 +3439,7 @@ module Orb
|
|
3447
3439
|
# @!attribute cadence
|
3448
3440
|
# The cadence to bill for this price on.
|
3449
3441
|
#
|
3450
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered::Cadence]
|
3442
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered::Cadence]
|
3451
3443
|
required :cadence,
|
3452
3444
|
enum: -> {
|
3453
3445
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered::Cadence
|
@@ -3499,7 +3491,7 @@ module Orb
|
|
3499
3491
|
# For custom cadence: specifies the duration of the billing period in days or
|
3500
3492
|
# months.
|
3501
3493
|
#
|
3502
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered::BillingCycleConfiguration, nil]
|
3494
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered::BillingCycleConfiguration, nil]
|
3503
3495
|
optional :billing_cycle_configuration,
|
3504
3496
|
-> {
|
3505
3497
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered::BillingCycleConfiguration
|
@@ -3535,7 +3527,7 @@ module Orb
|
|
3535
3527
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
3536
3528
|
# If unspecified, a single invoice is produced per billing cycle.
|
3537
3529
|
#
|
3538
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered::InvoicingCycleConfiguration, nil]
|
3530
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered::InvoicingCycleConfiguration, nil]
|
3539
3531
|
optional :invoicing_cycle_configuration,
|
3540
3532
|
-> {
|
3541
3533
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered::InvoicingCycleConfiguration
|
@@ -3552,10 +3544,10 @@ module Orb
|
|
3552
3544
|
|
3553
3545
|
# @!method initialize(cadence:, currency:, grouped_tiered_config:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :grouped_tiered)
|
3554
3546
|
# Some parameter documentations has been truncated, see
|
3555
|
-
# {Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered} for
|
3556
|
-
# details.
|
3547
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered} for
|
3548
|
+
# more details.
|
3557
3549
|
#
|
3558
|
-
# @param cadence [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered::Cadence] The cadence to bill for this price on.
|
3550
|
+
# @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered::Cadence] The cadence to bill for this price on.
|
3559
3551
|
#
|
3560
3552
|
# @param currency [String] An ISO 4217 currency string for which this price is billed in.
|
3561
3553
|
#
|
@@ -3569,7 +3561,7 @@ module Orb
|
|
3569
3561
|
#
|
3570
3562
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
3571
3563
|
#
|
3572
|
-
# @param billing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
3564
|
+
# @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
3573
3565
|
#
|
3574
3566
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
3575
3567
|
#
|
@@ -3579,7 +3571,7 @@ module Orb
|
|
3579
3571
|
#
|
3580
3572
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
3581
3573
|
#
|
3582
|
-
# @param invoicing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
3574
|
+
# @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
3583
3575
|
#
|
3584
3576
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
3585
3577
|
#
|
@@ -3587,7 +3579,7 @@ module Orb
|
|
3587
3579
|
|
3588
3580
|
# The cadence to bill for this price on.
|
3589
3581
|
#
|
3590
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered#cadence
|
3582
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered#cadence
|
3591
3583
|
module Cadence
|
3592
3584
|
extend Orb::Internal::Type::Enum
|
3593
3585
|
|
@@ -3602,7 +3594,7 @@ module Orb
|
|
3602
3594
|
# @return [Array<Symbol>]
|
3603
3595
|
end
|
3604
3596
|
|
3605
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered#billing_cycle_configuration
|
3597
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered#billing_cycle_configuration
|
3606
3598
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
3607
3599
|
# @!attribute duration
|
3608
3600
|
# The duration of the billing period.
|
@@ -3613,7 +3605,7 @@ module Orb
|
|
3613
3605
|
# @!attribute duration_unit
|
3614
3606
|
# The unit of billing period duration.
|
3615
3607
|
#
|
3616
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered::BillingCycleConfiguration::DurationUnit]
|
3608
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered::BillingCycleConfiguration::DurationUnit]
|
3617
3609
|
required :duration_unit,
|
3618
3610
|
enum: -> {
|
3619
3611
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered::BillingCycleConfiguration::DurationUnit
|
@@ -3625,11 +3617,11 @@ module Orb
|
|
3625
3617
|
#
|
3626
3618
|
# @param duration [Integer] The duration of the billing period.
|
3627
3619
|
#
|
3628
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
3620
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
3629
3621
|
|
3630
3622
|
# The unit of billing period duration.
|
3631
3623
|
#
|
3632
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered::BillingCycleConfiguration#duration_unit
|
3624
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered::BillingCycleConfiguration#duration_unit
|
3633
3625
|
module DurationUnit
|
3634
3626
|
extend Orb::Internal::Type::Enum
|
3635
3627
|
|
@@ -3641,7 +3633,7 @@ module Orb
|
|
3641
3633
|
end
|
3642
3634
|
end
|
3643
3635
|
|
3644
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered#invoicing_cycle_configuration
|
3636
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered#invoicing_cycle_configuration
|
3645
3637
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
3646
3638
|
# @!attribute duration
|
3647
3639
|
# The duration of the billing period.
|
@@ -3652,7 +3644,7 @@ module Orb
|
|
3652
3644
|
# @!attribute duration_unit
|
3653
3645
|
# The unit of billing period duration.
|
3654
3646
|
#
|
3655
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered::InvoicingCycleConfiguration::DurationUnit]
|
3647
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered::InvoicingCycleConfiguration::DurationUnit]
|
3656
3648
|
required :duration_unit,
|
3657
3649
|
enum: -> {
|
3658
3650
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered::InvoicingCycleConfiguration::DurationUnit
|
@@ -3664,11 +3656,11 @@ module Orb
|
|
3664
3656
|
#
|
3665
3657
|
# @param duration [Integer] The duration of the billing period.
|
3666
3658
|
#
|
3667
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
3659
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
3668
3660
|
|
3669
3661
|
# The unit of billing period duration.
|
3670
3662
|
#
|
3671
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered::InvoicingCycleConfiguration#duration_unit
|
3663
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered::InvoicingCycleConfiguration#duration_unit
|
3672
3664
|
module DurationUnit
|
3673
3665
|
extend Orb::Internal::Type::Enum
|
3674
3666
|
|
@@ -3685,7 +3677,7 @@ module Orb
|
|
3685
3677
|
# @!attribute cadence
|
3686
3678
|
# The cadence to bill for this price on.
|
3687
3679
|
#
|
3688
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage::Cadence]
|
3680
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage::Cadence]
|
3689
3681
|
required :cadence,
|
3690
3682
|
enum: -> {
|
3691
3683
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage::Cadence
|
@@ -3738,7 +3730,7 @@ module Orb
|
|
3738
3730
|
# For custom cadence: specifies the duration of the billing period in days or
|
3739
3731
|
# months.
|
3740
3732
|
#
|
3741
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage::BillingCycleConfiguration, nil]
|
3733
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage::BillingCycleConfiguration, nil]
|
3742
3734
|
optional :billing_cycle_configuration,
|
3743
3735
|
-> {
|
3744
3736
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage::BillingCycleConfiguration
|
@@ -3774,7 +3766,7 @@ module Orb
|
|
3774
3766
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
3775
3767
|
# If unspecified, a single invoice is produced per billing cycle.
|
3776
3768
|
#
|
3777
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage::InvoicingCycleConfiguration, nil]
|
3769
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage::InvoicingCycleConfiguration, nil]
|
3778
3770
|
optional :invoicing_cycle_configuration,
|
3779
3771
|
-> {
|
3780
3772
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage::InvoicingCycleConfiguration
|
@@ -3791,10 +3783,10 @@ module Orb
|
|
3791
3783
|
|
3792
3784
|
# @!method initialize(cadence:, currency:, item_id:, max_group_tiered_package_config:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: 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)
|
3793
3785
|
# Some parameter documentations has been truncated, see
|
3794
|
-
# {Orb::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage}
|
3795
|
-
# more details.
|
3786
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage}
|
3787
|
+
# for more details.
|
3796
3788
|
#
|
3797
|
-
# @param cadence [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage::Cadence] The cadence to bill for this price on.
|
3789
|
+
# @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage::Cadence] The cadence to bill for this price on.
|
3798
3790
|
#
|
3799
3791
|
# @param currency [String] An ISO 4217 currency string for which this price is billed in.
|
3800
3792
|
#
|
@@ -3808,7 +3800,7 @@ module Orb
|
|
3808
3800
|
#
|
3809
3801
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
3810
3802
|
#
|
3811
|
-
# @param billing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
3803
|
+
# @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
3812
3804
|
#
|
3813
3805
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
3814
3806
|
#
|
@@ -3818,7 +3810,7 @@ module Orb
|
|
3818
3810
|
#
|
3819
3811
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
3820
3812
|
#
|
3821
|
-
# @param invoicing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
3813
|
+
# @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
3822
3814
|
#
|
3823
3815
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
3824
3816
|
#
|
@@ -3826,7 +3818,7 @@ module Orb
|
|
3826
3818
|
|
3827
3819
|
# The cadence to bill for this price on.
|
3828
3820
|
#
|
3829
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage#cadence
|
3821
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage#cadence
|
3830
3822
|
module Cadence
|
3831
3823
|
extend Orb::Internal::Type::Enum
|
3832
3824
|
|
@@ -3841,7 +3833,7 @@ module Orb
|
|
3841
3833
|
# @return [Array<Symbol>]
|
3842
3834
|
end
|
3843
3835
|
|
3844
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage#billing_cycle_configuration
|
3836
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage#billing_cycle_configuration
|
3845
3837
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
3846
3838
|
# @!attribute duration
|
3847
3839
|
# The duration of the billing period.
|
@@ -3852,7 +3844,7 @@ module Orb
|
|
3852
3844
|
# @!attribute duration_unit
|
3853
3845
|
# The unit of billing period duration.
|
3854
3846
|
#
|
3855
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage::BillingCycleConfiguration::DurationUnit]
|
3847
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage::BillingCycleConfiguration::DurationUnit]
|
3856
3848
|
required :duration_unit,
|
3857
3849
|
enum: -> {
|
3858
3850
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage::BillingCycleConfiguration::DurationUnit
|
@@ -3864,11 +3856,11 @@ module Orb
|
|
3864
3856
|
#
|
3865
3857
|
# @param duration [Integer] The duration of the billing period.
|
3866
3858
|
#
|
3867
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
3859
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
3868
3860
|
|
3869
3861
|
# The unit of billing period duration.
|
3870
3862
|
#
|
3871
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage::BillingCycleConfiguration#duration_unit
|
3863
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage::BillingCycleConfiguration#duration_unit
|
3872
3864
|
module DurationUnit
|
3873
3865
|
extend Orb::Internal::Type::Enum
|
3874
3866
|
|
@@ -3880,7 +3872,7 @@ module Orb
|
|
3880
3872
|
end
|
3881
3873
|
end
|
3882
3874
|
|
3883
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage#invoicing_cycle_configuration
|
3875
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage#invoicing_cycle_configuration
|
3884
3876
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
3885
3877
|
# @!attribute duration
|
3886
3878
|
# The duration of the billing period.
|
@@ -3891,7 +3883,7 @@ module Orb
|
|
3891
3883
|
# @!attribute duration_unit
|
3892
3884
|
# The unit of billing period duration.
|
3893
3885
|
#
|
3894
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage::InvoicingCycleConfiguration::DurationUnit]
|
3886
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage::InvoicingCycleConfiguration::DurationUnit]
|
3895
3887
|
required :duration_unit,
|
3896
3888
|
enum: -> {
|
3897
3889
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage::InvoicingCycleConfiguration::DurationUnit
|
@@ -3903,11 +3895,11 @@ module Orb
|
|
3903
3895
|
#
|
3904
3896
|
# @param duration [Integer] The duration of the billing period.
|
3905
3897
|
#
|
3906
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
3898
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
3907
3899
|
|
3908
3900
|
# The unit of billing period duration.
|
3909
3901
|
#
|
3910
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage::InvoicingCycleConfiguration#duration_unit
|
3902
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage::InvoicingCycleConfiguration#duration_unit
|
3911
3903
|
module DurationUnit
|
3912
3904
|
extend Orb::Internal::Type::Enum
|
3913
3905
|
|
@@ -3924,7 +3916,7 @@ module Orb
|
|
3924
3916
|
# @!attribute cadence
|
3925
3917
|
# The cadence to bill for this price on.
|
3926
3918
|
#
|
3927
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum::Cadence]
|
3919
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum::Cadence]
|
3928
3920
|
required :cadence,
|
3929
3921
|
enum: -> {
|
3930
3922
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum::Cadence
|
@@ -3976,7 +3968,7 @@ module Orb
|
|
3976
3968
|
# For custom cadence: specifies the duration of the billing period in days or
|
3977
3969
|
# months.
|
3978
3970
|
#
|
3979
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum::BillingCycleConfiguration, nil]
|
3971
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum::BillingCycleConfiguration, nil]
|
3980
3972
|
optional :billing_cycle_configuration,
|
3981
3973
|
-> {
|
3982
3974
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum::BillingCycleConfiguration
|
@@ -4012,7 +4004,7 @@ module Orb
|
|
4012
4004
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
4013
4005
|
# If unspecified, a single invoice is produced per billing cycle.
|
4014
4006
|
#
|
4015
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum::InvoicingCycleConfiguration, nil]
|
4007
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum::InvoicingCycleConfiguration, nil]
|
4016
4008
|
optional :invoicing_cycle_configuration,
|
4017
4009
|
-> {
|
4018
4010
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum::InvoicingCycleConfiguration
|
@@ -4029,10 +4021,10 @@ module Orb
|
|
4029
4021
|
|
4030
4022
|
# @!method initialize(cadence:, currency:, item_id:, name:, tiered_with_minimum_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :tiered_with_minimum)
|
4031
4023
|
# Some parameter documentations has been truncated, see
|
4032
|
-
# {Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum}
|
4033
|
-
# details.
|
4024
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum}
|
4025
|
+
# for more details.
|
4034
4026
|
#
|
4035
|
-
# @param cadence [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum::Cadence] The cadence to bill for this price on.
|
4027
|
+
# @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum::Cadence] The cadence to bill for this price on.
|
4036
4028
|
#
|
4037
4029
|
# @param currency [String] An ISO 4217 currency string for which this price is billed in.
|
4038
4030
|
#
|
@@ -4046,7 +4038,7 @@ module Orb
|
|
4046
4038
|
#
|
4047
4039
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
4048
4040
|
#
|
4049
|
-
# @param billing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
4041
|
+
# @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
4050
4042
|
#
|
4051
4043
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
4052
4044
|
#
|
@@ -4056,7 +4048,7 @@ module Orb
|
|
4056
4048
|
#
|
4057
4049
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
4058
4050
|
#
|
4059
|
-
# @param invoicing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
4051
|
+
# @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
4060
4052
|
#
|
4061
4053
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
4062
4054
|
#
|
@@ -4064,7 +4056,7 @@ module Orb
|
|
4064
4056
|
|
4065
4057
|
# The cadence to bill for this price on.
|
4066
4058
|
#
|
4067
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum#cadence
|
4059
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum#cadence
|
4068
4060
|
module Cadence
|
4069
4061
|
extend Orb::Internal::Type::Enum
|
4070
4062
|
|
@@ -4079,7 +4071,7 @@ module Orb
|
|
4079
4071
|
# @return [Array<Symbol>]
|
4080
4072
|
end
|
4081
4073
|
|
4082
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum#billing_cycle_configuration
|
4074
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum#billing_cycle_configuration
|
4083
4075
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
4084
4076
|
# @!attribute duration
|
4085
4077
|
# The duration of the billing period.
|
@@ -4090,7 +4082,7 @@ module Orb
|
|
4090
4082
|
# @!attribute duration_unit
|
4091
4083
|
# The unit of billing period duration.
|
4092
4084
|
#
|
4093
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum::BillingCycleConfiguration::DurationUnit]
|
4085
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum::BillingCycleConfiguration::DurationUnit]
|
4094
4086
|
required :duration_unit,
|
4095
4087
|
enum: -> {
|
4096
4088
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum::BillingCycleConfiguration::DurationUnit
|
@@ -4102,11 +4094,11 @@ module Orb
|
|
4102
4094
|
#
|
4103
4095
|
# @param duration [Integer] The duration of the billing period.
|
4104
4096
|
#
|
4105
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
4097
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
4106
4098
|
|
4107
4099
|
# The unit of billing period duration.
|
4108
4100
|
#
|
4109
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum::BillingCycleConfiguration#duration_unit
|
4101
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum::BillingCycleConfiguration#duration_unit
|
4110
4102
|
module DurationUnit
|
4111
4103
|
extend Orb::Internal::Type::Enum
|
4112
4104
|
|
@@ -4118,7 +4110,7 @@ module Orb
|
|
4118
4110
|
end
|
4119
4111
|
end
|
4120
4112
|
|
4121
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum#invoicing_cycle_configuration
|
4113
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum#invoicing_cycle_configuration
|
4122
4114
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
4123
4115
|
# @!attribute duration
|
4124
4116
|
# The duration of the billing period.
|
@@ -4129,7 +4121,7 @@ module Orb
|
|
4129
4121
|
# @!attribute duration_unit
|
4130
4122
|
# The unit of billing period duration.
|
4131
4123
|
#
|
4132
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum::InvoicingCycleConfiguration::DurationUnit]
|
4124
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum::InvoicingCycleConfiguration::DurationUnit]
|
4133
4125
|
required :duration_unit,
|
4134
4126
|
enum: -> {
|
4135
4127
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum::InvoicingCycleConfiguration::DurationUnit
|
@@ -4141,11 +4133,11 @@ module Orb
|
|
4141
4133
|
#
|
4142
4134
|
# @param duration [Integer] The duration of the billing period.
|
4143
4135
|
#
|
4144
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
4136
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
4145
4137
|
|
4146
4138
|
# The unit of billing period duration.
|
4147
4139
|
#
|
4148
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum::InvoicingCycleConfiguration#duration_unit
|
4140
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum::InvoicingCycleConfiguration#duration_unit
|
4149
4141
|
module DurationUnit
|
4150
4142
|
extend Orb::Internal::Type::Enum
|
4151
4143
|
|
@@ -4162,7 +4154,7 @@ module Orb
|
|
4162
4154
|
# @!attribute cadence
|
4163
4155
|
# The cadence to bill for this price on.
|
4164
4156
|
#
|
4165
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation::Cadence]
|
4157
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation::Cadence]
|
4166
4158
|
required :cadence,
|
4167
4159
|
enum: -> {
|
4168
4160
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation::Cadence
|
@@ -4215,7 +4207,7 @@ module Orb
|
|
4215
4207
|
# For custom cadence: specifies the duration of the billing period in days or
|
4216
4208
|
# months.
|
4217
4209
|
#
|
4218
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation::BillingCycleConfiguration, nil]
|
4210
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation::BillingCycleConfiguration, nil]
|
4219
4211
|
optional :billing_cycle_configuration,
|
4220
4212
|
-> {
|
4221
4213
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation::BillingCycleConfiguration
|
@@ -4251,7 +4243,7 @@ module Orb
|
|
4251
4243
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
4252
4244
|
# If unspecified, a single invoice is produced per billing cycle.
|
4253
4245
|
#
|
4254
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation::InvoicingCycleConfiguration, nil]
|
4246
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation::InvoicingCycleConfiguration, nil]
|
4255
4247
|
optional :invoicing_cycle_configuration,
|
4256
4248
|
-> {
|
4257
4249
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation::InvoicingCycleConfiguration
|
@@ -4268,10 +4260,10 @@ module Orb
|
|
4268
4260
|
|
4269
4261
|
# @!method initialize(cadence:, currency:, item_id:, name:, package_with_allocation_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :package_with_allocation)
|
4270
4262
|
# Some parameter documentations has been truncated, see
|
4271
|
-
# {Orb::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation}
|
4272
|
-
# more details.
|
4263
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation}
|
4264
|
+
# for more details.
|
4273
4265
|
#
|
4274
|
-
# @param cadence [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation::Cadence] The cadence to bill for this price on.
|
4266
|
+
# @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation::Cadence] The cadence to bill for this price on.
|
4275
4267
|
#
|
4276
4268
|
# @param currency [String] An ISO 4217 currency string for which this price is billed in.
|
4277
4269
|
#
|
@@ -4285,7 +4277,7 @@ module Orb
|
|
4285
4277
|
#
|
4286
4278
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
4287
4279
|
#
|
4288
|
-
# @param billing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
4280
|
+
# @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
4289
4281
|
#
|
4290
4282
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
4291
4283
|
#
|
@@ -4295,7 +4287,7 @@ module Orb
|
|
4295
4287
|
#
|
4296
4288
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
4297
4289
|
#
|
4298
|
-
# @param invoicing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
4290
|
+
# @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
4299
4291
|
#
|
4300
4292
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
4301
4293
|
#
|
@@ -4303,7 +4295,7 @@ module Orb
|
|
4303
4295
|
|
4304
4296
|
# The cadence to bill for this price on.
|
4305
4297
|
#
|
4306
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation#cadence
|
4298
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation#cadence
|
4307
4299
|
module Cadence
|
4308
4300
|
extend Orb::Internal::Type::Enum
|
4309
4301
|
|
@@ -4318,7 +4310,7 @@ module Orb
|
|
4318
4310
|
# @return [Array<Symbol>]
|
4319
4311
|
end
|
4320
4312
|
|
4321
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation#billing_cycle_configuration
|
4313
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation#billing_cycle_configuration
|
4322
4314
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
4323
4315
|
# @!attribute duration
|
4324
4316
|
# The duration of the billing period.
|
@@ -4329,7 +4321,7 @@ module Orb
|
|
4329
4321
|
# @!attribute duration_unit
|
4330
4322
|
# The unit of billing period duration.
|
4331
4323
|
#
|
4332
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation::BillingCycleConfiguration::DurationUnit]
|
4324
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation::BillingCycleConfiguration::DurationUnit]
|
4333
4325
|
required :duration_unit,
|
4334
4326
|
enum: -> {
|
4335
4327
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation::BillingCycleConfiguration::DurationUnit
|
@@ -4341,11 +4333,11 @@ module Orb
|
|
4341
4333
|
#
|
4342
4334
|
# @param duration [Integer] The duration of the billing period.
|
4343
4335
|
#
|
4344
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
4336
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
4345
4337
|
|
4346
4338
|
# The unit of billing period duration.
|
4347
4339
|
#
|
4348
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation::BillingCycleConfiguration#duration_unit
|
4340
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation::BillingCycleConfiguration#duration_unit
|
4349
4341
|
module DurationUnit
|
4350
4342
|
extend Orb::Internal::Type::Enum
|
4351
4343
|
|
@@ -4357,7 +4349,7 @@ module Orb
|
|
4357
4349
|
end
|
4358
4350
|
end
|
4359
4351
|
|
4360
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation#invoicing_cycle_configuration
|
4352
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation#invoicing_cycle_configuration
|
4361
4353
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
4362
4354
|
# @!attribute duration
|
4363
4355
|
# The duration of the billing period.
|
@@ -4368,7 +4360,7 @@ module Orb
|
|
4368
4360
|
# @!attribute duration_unit
|
4369
4361
|
# The unit of billing period duration.
|
4370
4362
|
#
|
4371
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation::InvoicingCycleConfiguration::DurationUnit]
|
4363
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation::InvoicingCycleConfiguration::DurationUnit]
|
4372
4364
|
required :duration_unit,
|
4373
4365
|
enum: -> {
|
4374
4366
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation::InvoicingCycleConfiguration::DurationUnit
|
@@ -4380,11 +4372,11 @@ module Orb
|
|
4380
4372
|
#
|
4381
4373
|
# @param duration [Integer] The duration of the billing period.
|
4382
4374
|
#
|
4383
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
4375
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
4384
4376
|
|
4385
4377
|
# The unit of billing period duration.
|
4386
4378
|
#
|
4387
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation::InvoicingCycleConfiguration#duration_unit
|
4379
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation::InvoicingCycleConfiguration#duration_unit
|
4388
4380
|
module DurationUnit
|
4389
4381
|
extend Orb::Internal::Type::Enum
|
4390
4382
|
|
@@ -4401,7 +4393,7 @@ module Orb
|
|
4401
4393
|
# @!attribute cadence
|
4402
4394
|
# The cadence to bill for this price on.
|
4403
4395
|
#
|
4404
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum::Cadence]
|
4396
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum::Cadence]
|
4405
4397
|
required :cadence,
|
4406
4398
|
enum: -> {
|
4407
4399
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum::Cadence
|
@@ -4454,7 +4446,7 @@ module Orb
|
|
4454
4446
|
# For custom cadence: specifies the duration of the billing period in days or
|
4455
4447
|
# months.
|
4456
4448
|
#
|
4457
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum::BillingCycleConfiguration, nil]
|
4449
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum::BillingCycleConfiguration, nil]
|
4458
4450
|
optional :billing_cycle_configuration,
|
4459
4451
|
-> {
|
4460
4452
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum::BillingCycleConfiguration
|
@@ -4490,7 +4482,7 @@ module Orb
|
|
4490
4482
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
4491
4483
|
# If unspecified, a single invoice is produced per billing cycle.
|
4492
4484
|
#
|
4493
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum::InvoicingCycleConfiguration, nil]
|
4485
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum::InvoicingCycleConfiguration, nil]
|
4494
4486
|
optional :invoicing_cycle_configuration,
|
4495
4487
|
-> {
|
4496
4488
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum::InvoicingCycleConfiguration
|
@@ -4507,10 +4499,10 @@ module Orb
|
|
4507
4499
|
|
4508
4500
|
# @!method initialize(cadence:, currency:, item_id:, name:, tiered_package_with_minimum_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :tiered_package_with_minimum)
|
4509
4501
|
# Some parameter documentations has been truncated, see
|
4510
|
-
# {Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum}
|
4502
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum}
|
4511
4503
|
# for more details.
|
4512
4504
|
#
|
4513
|
-
# @param cadence [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum::Cadence] The cadence to bill for this price on.
|
4505
|
+
# @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum::Cadence] The cadence to bill for this price on.
|
4514
4506
|
#
|
4515
4507
|
# @param currency [String] An ISO 4217 currency string for which this price is billed in.
|
4516
4508
|
#
|
@@ -4524,7 +4516,7 @@ module Orb
|
|
4524
4516
|
#
|
4525
4517
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
4526
4518
|
#
|
4527
|
-
# @param billing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
4519
|
+
# @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
4528
4520
|
#
|
4529
4521
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
4530
4522
|
#
|
@@ -4534,7 +4526,7 @@ module Orb
|
|
4534
4526
|
#
|
4535
4527
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
4536
4528
|
#
|
4537
|
-
# @param invoicing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
4529
|
+
# @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
4538
4530
|
#
|
4539
4531
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
4540
4532
|
#
|
@@ -4542,7 +4534,7 @@ module Orb
|
|
4542
4534
|
|
4543
4535
|
# The cadence to bill for this price on.
|
4544
4536
|
#
|
4545
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum#cadence
|
4537
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum#cadence
|
4546
4538
|
module Cadence
|
4547
4539
|
extend Orb::Internal::Type::Enum
|
4548
4540
|
|
@@ -4557,7 +4549,7 @@ module Orb
|
|
4557
4549
|
# @return [Array<Symbol>]
|
4558
4550
|
end
|
4559
4551
|
|
4560
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum#billing_cycle_configuration
|
4552
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum#billing_cycle_configuration
|
4561
4553
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
4562
4554
|
# @!attribute duration
|
4563
4555
|
# The duration of the billing period.
|
@@ -4568,7 +4560,7 @@ module Orb
|
|
4568
4560
|
# @!attribute duration_unit
|
4569
4561
|
# The unit of billing period duration.
|
4570
4562
|
#
|
4571
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum::BillingCycleConfiguration::DurationUnit]
|
4563
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum::BillingCycleConfiguration::DurationUnit]
|
4572
4564
|
required :duration_unit,
|
4573
4565
|
enum: -> {
|
4574
4566
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum::BillingCycleConfiguration::DurationUnit
|
@@ -4580,11 +4572,11 @@ module Orb
|
|
4580
4572
|
#
|
4581
4573
|
# @param duration [Integer] The duration of the billing period.
|
4582
4574
|
#
|
4583
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
4575
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
4584
4576
|
|
4585
4577
|
# The unit of billing period duration.
|
4586
4578
|
#
|
4587
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum::BillingCycleConfiguration#duration_unit
|
4579
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum::BillingCycleConfiguration#duration_unit
|
4588
4580
|
module DurationUnit
|
4589
4581
|
extend Orb::Internal::Type::Enum
|
4590
4582
|
|
@@ -4596,7 +4588,7 @@ module Orb
|
|
4596
4588
|
end
|
4597
4589
|
end
|
4598
4590
|
|
4599
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum#invoicing_cycle_configuration
|
4591
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum#invoicing_cycle_configuration
|
4600
4592
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
4601
4593
|
# @!attribute duration
|
4602
4594
|
# The duration of the billing period.
|
@@ -4607,7 +4599,7 @@ module Orb
|
|
4607
4599
|
# @!attribute duration_unit
|
4608
4600
|
# The unit of billing period duration.
|
4609
4601
|
#
|
4610
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum::InvoicingCycleConfiguration::DurationUnit]
|
4602
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum::InvoicingCycleConfiguration::DurationUnit]
|
4611
4603
|
required :duration_unit,
|
4612
4604
|
enum: -> {
|
4613
4605
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum::InvoicingCycleConfiguration::DurationUnit
|
@@ -4619,11 +4611,11 @@ module Orb
|
|
4619
4611
|
#
|
4620
4612
|
# @param duration [Integer] The duration of the billing period.
|
4621
4613
|
#
|
4622
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
4614
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
4623
4615
|
|
4624
4616
|
# The unit of billing period duration.
|
4625
4617
|
#
|
4626
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum::InvoicingCycleConfiguration#duration_unit
|
4618
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum::InvoicingCycleConfiguration#duration_unit
|
4627
4619
|
module DurationUnit
|
4628
4620
|
extend Orb::Internal::Type::Enum
|
4629
4621
|
|
@@ -4640,7 +4632,7 @@ module Orb
|
|
4640
4632
|
# @!attribute cadence
|
4641
4633
|
# The cadence to bill for this price on.
|
4642
4634
|
#
|
4643
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent::Cadence]
|
4635
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent::Cadence]
|
4644
4636
|
required :cadence,
|
4645
4637
|
enum: -> { Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent::Cadence }
|
4646
4638
|
|
@@ -4690,7 +4682,7 @@ module Orb
|
|
4690
4682
|
# For custom cadence: specifies the duration of the billing period in days or
|
4691
4683
|
# months.
|
4692
4684
|
#
|
4693
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent::BillingCycleConfiguration, nil]
|
4685
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent::BillingCycleConfiguration, nil]
|
4694
4686
|
optional :billing_cycle_configuration,
|
4695
4687
|
-> {
|
4696
4688
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent::BillingCycleConfiguration
|
@@ -4726,7 +4718,7 @@ module Orb
|
|
4726
4718
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
4727
4719
|
# If unspecified, a single invoice is produced per billing cycle.
|
4728
4720
|
#
|
4729
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent::InvoicingCycleConfiguration, nil]
|
4721
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent::InvoicingCycleConfiguration, nil]
|
4730
4722
|
optional :invoicing_cycle_configuration,
|
4731
4723
|
-> {
|
4732
4724
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent::InvoicingCycleConfiguration
|
@@ -4743,10 +4735,10 @@ module Orb
|
|
4743
4735
|
|
4744
4736
|
# @!method initialize(cadence:, currency:, item_id:, name:, unit_with_percent_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :unit_with_percent)
|
4745
4737
|
# Some parameter documentations has been truncated, see
|
4746
|
-
# {Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent} for
|
4747
|
-
# details.
|
4738
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent} for
|
4739
|
+
# more details.
|
4748
4740
|
#
|
4749
|
-
# @param cadence [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent::Cadence] The cadence to bill for this price on.
|
4741
|
+
# @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent::Cadence] The cadence to bill for this price on.
|
4750
4742
|
#
|
4751
4743
|
# @param currency [String] An ISO 4217 currency string for which this price is billed in.
|
4752
4744
|
#
|
@@ -4760,7 +4752,7 @@ module Orb
|
|
4760
4752
|
#
|
4761
4753
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
4762
4754
|
#
|
4763
|
-
# @param billing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
4755
|
+
# @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
4764
4756
|
#
|
4765
4757
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
4766
4758
|
#
|
@@ -4770,7 +4762,7 @@ module Orb
|
|
4770
4762
|
#
|
4771
4763
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
4772
4764
|
#
|
4773
|
-
# @param invoicing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
4765
|
+
# @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
4774
4766
|
#
|
4775
4767
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
4776
4768
|
#
|
@@ -4778,7 +4770,7 @@ module Orb
|
|
4778
4770
|
|
4779
4771
|
# The cadence to bill for this price on.
|
4780
4772
|
#
|
4781
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent#cadence
|
4773
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent#cadence
|
4782
4774
|
module Cadence
|
4783
4775
|
extend Orb::Internal::Type::Enum
|
4784
4776
|
|
@@ -4793,7 +4785,7 @@ module Orb
|
|
4793
4785
|
# @return [Array<Symbol>]
|
4794
4786
|
end
|
4795
4787
|
|
4796
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent#billing_cycle_configuration
|
4788
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent#billing_cycle_configuration
|
4797
4789
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
4798
4790
|
# @!attribute duration
|
4799
4791
|
# The duration of the billing period.
|
@@ -4804,7 +4796,7 @@ module Orb
|
|
4804
4796
|
# @!attribute duration_unit
|
4805
4797
|
# The unit of billing period duration.
|
4806
4798
|
#
|
4807
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent::BillingCycleConfiguration::DurationUnit]
|
4799
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent::BillingCycleConfiguration::DurationUnit]
|
4808
4800
|
required :duration_unit,
|
4809
4801
|
enum: -> {
|
4810
4802
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent::BillingCycleConfiguration::DurationUnit
|
@@ -4816,11 +4808,11 @@ module Orb
|
|
4816
4808
|
#
|
4817
4809
|
# @param duration [Integer] The duration of the billing period.
|
4818
4810
|
#
|
4819
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
4811
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
4820
4812
|
|
4821
4813
|
# The unit of billing period duration.
|
4822
4814
|
#
|
4823
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent::BillingCycleConfiguration#duration_unit
|
4815
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent::BillingCycleConfiguration#duration_unit
|
4824
4816
|
module DurationUnit
|
4825
4817
|
extend Orb::Internal::Type::Enum
|
4826
4818
|
|
@@ -4832,7 +4824,7 @@ module Orb
|
|
4832
4824
|
end
|
4833
4825
|
end
|
4834
4826
|
|
4835
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent#invoicing_cycle_configuration
|
4827
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent#invoicing_cycle_configuration
|
4836
4828
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
4837
4829
|
# @!attribute duration
|
4838
4830
|
# The duration of the billing period.
|
@@ -4843,7 +4835,7 @@ module Orb
|
|
4843
4835
|
# @!attribute duration_unit
|
4844
4836
|
# The unit of billing period duration.
|
4845
4837
|
#
|
4846
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent::InvoicingCycleConfiguration::DurationUnit]
|
4838
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent::InvoicingCycleConfiguration::DurationUnit]
|
4847
4839
|
required :duration_unit,
|
4848
4840
|
enum: -> {
|
4849
4841
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent::InvoicingCycleConfiguration::DurationUnit
|
@@ -4855,11 +4847,11 @@ module Orb
|
|
4855
4847
|
#
|
4856
4848
|
# @param duration [Integer] The duration of the billing period.
|
4857
4849
|
#
|
4858
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
4850
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
4859
4851
|
|
4860
4852
|
# The unit of billing period duration.
|
4861
4853
|
#
|
4862
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent::InvoicingCycleConfiguration#duration_unit
|
4854
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent::InvoicingCycleConfiguration#duration_unit
|
4863
4855
|
module DurationUnit
|
4864
4856
|
extend Orb::Internal::Type::Enum
|
4865
4857
|
|
@@ -4876,7 +4868,7 @@ module Orb
|
|
4876
4868
|
# @!attribute cadence
|
4877
4869
|
# The cadence to bill for this price on.
|
4878
4870
|
#
|
4879
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration::Cadence]
|
4871
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration::Cadence]
|
4880
4872
|
required :cadence,
|
4881
4873
|
enum: -> {
|
4882
4874
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration::Cadence
|
@@ -4928,7 +4920,7 @@ module Orb
|
|
4928
4920
|
# For custom cadence: specifies the duration of the billing period in days or
|
4929
4921
|
# months.
|
4930
4922
|
#
|
4931
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration::BillingCycleConfiguration, nil]
|
4923
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration::BillingCycleConfiguration, nil]
|
4932
4924
|
optional :billing_cycle_configuration,
|
4933
4925
|
-> {
|
4934
4926
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration::BillingCycleConfiguration
|
@@ -4964,7 +4956,7 @@ module Orb
|
|
4964
4956
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
4965
4957
|
# If unspecified, a single invoice is produced per billing cycle.
|
4966
4958
|
#
|
4967
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration::InvoicingCycleConfiguration, nil]
|
4959
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration::InvoicingCycleConfiguration, nil]
|
4968
4960
|
optional :invoicing_cycle_configuration,
|
4969
4961
|
-> {
|
4970
4962
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration::InvoicingCycleConfiguration
|
@@ -4981,10 +4973,10 @@ module Orb
|
|
4981
4973
|
|
4982
4974
|
# @!method initialize(cadence:, currency:, item_id:, name:, tiered_with_proration_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :tiered_with_proration)
|
4983
4975
|
# Some parameter documentations has been truncated, see
|
4984
|
-
# {Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration}
|
4985
|
-
# more details.
|
4976
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration}
|
4977
|
+
# for more details.
|
4986
4978
|
#
|
4987
|
-
# @param cadence [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration::Cadence] The cadence to bill for this price on.
|
4979
|
+
# @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration::Cadence] The cadence to bill for this price on.
|
4988
4980
|
#
|
4989
4981
|
# @param currency [String] An ISO 4217 currency string for which this price is billed in.
|
4990
4982
|
#
|
@@ -4998,7 +4990,7 @@ module Orb
|
|
4998
4990
|
#
|
4999
4991
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
5000
4992
|
#
|
5001
|
-
# @param billing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
4993
|
+
# @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
5002
4994
|
#
|
5003
4995
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
5004
4996
|
#
|
@@ -5008,7 +5000,7 @@ module Orb
|
|
5008
5000
|
#
|
5009
5001
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
5010
5002
|
#
|
5011
|
-
# @param invoicing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
5003
|
+
# @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
5012
5004
|
#
|
5013
5005
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
5014
5006
|
#
|
@@ -5016,7 +5008,7 @@ module Orb
|
|
5016
5008
|
|
5017
5009
|
# The cadence to bill for this price on.
|
5018
5010
|
#
|
5019
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration#cadence
|
5011
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration#cadence
|
5020
5012
|
module Cadence
|
5021
5013
|
extend Orb::Internal::Type::Enum
|
5022
5014
|
|
@@ -5031,7 +5023,7 @@ module Orb
|
|
5031
5023
|
# @return [Array<Symbol>]
|
5032
5024
|
end
|
5033
5025
|
|
5034
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration#billing_cycle_configuration
|
5026
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration#billing_cycle_configuration
|
5035
5027
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
5036
5028
|
# @!attribute duration
|
5037
5029
|
# The duration of the billing period.
|
@@ -5042,7 +5034,7 @@ module Orb
|
|
5042
5034
|
# @!attribute duration_unit
|
5043
5035
|
# The unit of billing period duration.
|
5044
5036
|
#
|
5045
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration::BillingCycleConfiguration::DurationUnit]
|
5037
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration::BillingCycleConfiguration::DurationUnit]
|
5046
5038
|
required :duration_unit,
|
5047
5039
|
enum: -> {
|
5048
5040
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration::BillingCycleConfiguration::DurationUnit
|
@@ -5054,11 +5046,11 @@ module Orb
|
|
5054
5046
|
#
|
5055
5047
|
# @param duration [Integer] The duration of the billing period.
|
5056
5048
|
#
|
5057
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
5049
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
5058
5050
|
|
5059
5051
|
# The unit of billing period duration.
|
5060
5052
|
#
|
5061
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration::BillingCycleConfiguration#duration_unit
|
5053
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration::BillingCycleConfiguration#duration_unit
|
5062
5054
|
module DurationUnit
|
5063
5055
|
extend Orb::Internal::Type::Enum
|
5064
5056
|
|
@@ -5070,7 +5062,7 @@ module Orb
|
|
5070
5062
|
end
|
5071
5063
|
end
|
5072
5064
|
|
5073
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration#invoicing_cycle_configuration
|
5065
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration#invoicing_cycle_configuration
|
5074
5066
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
5075
5067
|
# @!attribute duration
|
5076
5068
|
# The duration of the billing period.
|
@@ -5081,7 +5073,7 @@ module Orb
|
|
5081
5073
|
# @!attribute duration_unit
|
5082
5074
|
# The unit of billing period duration.
|
5083
5075
|
#
|
5084
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration::InvoicingCycleConfiguration::DurationUnit]
|
5076
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration::InvoicingCycleConfiguration::DurationUnit]
|
5085
5077
|
required :duration_unit,
|
5086
5078
|
enum: -> {
|
5087
5079
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration::InvoicingCycleConfiguration::DurationUnit
|
@@ -5093,11 +5085,11 @@ module Orb
|
|
5093
5085
|
#
|
5094
5086
|
# @param duration [Integer] The duration of the billing period.
|
5095
5087
|
#
|
5096
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
5088
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
5097
5089
|
|
5098
5090
|
# The unit of billing period duration.
|
5099
5091
|
#
|
5100
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration::InvoicingCycleConfiguration#duration_unit
|
5092
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration::InvoicingCycleConfiguration#duration_unit
|
5101
5093
|
module DurationUnit
|
5102
5094
|
extend Orb::Internal::Type::Enum
|
5103
5095
|
|
@@ -5114,7 +5106,7 @@ module Orb
|
|
5114
5106
|
# @!attribute cadence
|
5115
5107
|
# The cadence to bill for this price on.
|
5116
5108
|
#
|
5117
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration::Cadence]
|
5109
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration::Cadence]
|
5118
5110
|
required :cadence,
|
5119
5111
|
enum: -> {
|
5120
5112
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration::Cadence
|
@@ -5166,7 +5158,7 @@ module Orb
|
|
5166
5158
|
# For custom cadence: specifies the duration of the billing period in days or
|
5167
5159
|
# months.
|
5168
5160
|
#
|
5169
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration::BillingCycleConfiguration, nil]
|
5161
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration::BillingCycleConfiguration, nil]
|
5170
5162
|
optional :billing_cycle_configuration,
|
5171
5163
|
-> {
|
5172
5164
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration::BillingCycleConfiguration
|
@@ -5202,7 +5194,7 @@ module Orb
|
|
5202
5194
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
5203
5195
|
# If unspecified, a single invoice is produced per billing cycle.
|
5204
5196
|
#
|
5205
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration::InvoicingCycleConfiguration, nil]
|
5197
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration::InvoicingCycleConfiguration, nil]
|
5206
5198
|
optional :invoicing_cycle_configuration,
|
5207
5199
|
-> {
|
5208
5200
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration::InvoicingCycleConfiguration
|
@@ -5219,10 +5211,10 @@ module Orb
|
|
5219
5211
|
|
5220
5212
|
# @!method initialize(cadence:, currency:, item_id:, name:, unit_with_proration_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :unit_with_proration)
|
5221
5213
|
# Some parameter documentations has been truncated, see
|
5222
|
-
# {Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration}
|
5223
|
-
# details.
|
5214
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration}
|
5215
|
+
# for more details.
|
5224
5216
|
#
|
5225
|
-
# @param cadence [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration::Cadence] The cadence to bill for this price on.
|
5217
|
+
# @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration::Cadence] The cadence to bill for this price on.
|
5226
5218
|
#
|
5227
5219
|
# @param currency [String] An ISO 4217 currency string for which this price is billed in.
|
5228
5220
|
#
|
@@ -5236,7 +5228,7 @@ module Orb
|
|
5236
5228
|
#
|
5237
5229
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
5238
5230
|
#
|
5239
|
-
# @param billing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
5231
|
+
# @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
5240
5232
|
#
|
5241
5233
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
5242
5234
|
#
|
@@ -5246,7 +5238,7 @@ module Orb
|
|
5246
5238
|
#
|
5247
5239
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
5248
5240
|
#
|
5249
|
-
# @param invoicing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
5241
|
+
# @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
5250
5242
|
#
|
5251
5243
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
5252
5244
|
#
|
@@ -5254,7 +5246,7 @@ module Orb
|
|
5254
5246
|
|
5255
5247
|
# The cadence to bill for this price on.
|
5256
5248
|
#
|
5257
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration#cadence
|
5249
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration#cadence
|
5258
5250
|
module Cadence
|
5259
5251
|
extend Orb::Internal::Type::Enum
|
5260
5252
|
|
@@ -5269,7 +5261,7 @@ module Orb
|
|
5269
5261
|
# @return [Array<Symbol>]
|
5270
5262
|
end
|
5271
5263
|
|
5272
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration#billing_cycle_configuration
|
5264
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration#billing_cycle_configuration
|
5273
5265
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
5274
5266
|
# @!attribute duration
|
5275
5267
|
# The duration of the billing period.
|
@@ -5280,7 +5272,7 @@ module Orb
|
|
5280
5272
|
# @!attribute duration_unit
|
5281
5273
|
# The unit of billing period duration.
|
5282
5274
|
#
|
5283
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration::BillingCycleConfiguration::DurationUnit]
|
5275
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration::BillingCycleConfiguration::DurationUnit]
|
5284
5276
|
required :duration_unit,
|
5285
5277
|
enum: -> {
|
5286
5278
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration::BillingCycleConfiguration::DurationUnit
|
@@ -5292,11 +5284,11 @@ module Orb
|
|
5292
5284
|
#
|
5293
5285
|
# @param duration [Integer] The duration of the billing period.
|
5294
5286
|
#
|
5295
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
5287
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
5296
5288
|
|
5297
5289
|
# The unit of billing period duration.
|
5298
5290
|
#
|
5299
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration::BillingCycleConfiguration#duration_unit
|
5291
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration::BillingCycleConfiguration#duration_unit
|
5300
5292
|
module DurationUnit
|
5301
5293
|
extend Orb::Internal::Type::Enum
|
5302
5294
|
|
@@ -5308,7 +5300,7 @@ module Orb
|
|
5308
5300
|
end
|
5309
5301
|
end
|
5310
5302
|
|
5311
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration#invoicing_cycle_configuration
|
5303
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration#invoicing_cycle_configuration
|
5312
5304
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
5313
5305
|
# @!attribute duration
|
5314
5306
|
# The duration of the billing period.
|
@@ -5319,7 +5311,7 @@ module Orb
|
|
5319
5311
|
# @!attribute duration_unit
|
5320
5312
|
# The unit of billing period duration.
|
5321
5313
|
#
|
5322
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration::InvoicingCycleConfiguration::DurationUnit]
|
5314
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration::InvoicingCycleConfiguration::DurationUnit]
|
5323
5315
|
required :duration_unit,
|
5324
5316
|
enum: -> {
|
5325
5317
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration::InvoicingCycleConfiguration::DurationUnit
|
@@ -5331,11 +5323,11 @@ module Orb
|
|
5331
5323
|
#
|
5332
5324
|
# @param duration [Integer] The duration of the billing period.
|
5333
5325
|
#
|
5334
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
5326
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
5335
5327
|
|
5336
5328
|
# The unit of billing period duration.
|
5337
5329
|
#
|
5338
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration::InvoicingCycleConfiguration#duration_unit
|
5330
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration::InvoicingCycleConfiguration#duration_unit
|
5339
5331
|
module DurationUnit
|
5340
5332
|
extend Orb::Internal::Type::Enum
|
5341
5333
|
|
@@ -5352,7 +5344,7 @@ module Orb
|
|
5352
5344
|
# @!attribute cadence
|
5353
5345
|
# The cadence to bill for this price on.
|
5354
5346
|
#
|
5355
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation::Cadence]
|
5347
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation::Cadence]
|
5356
5348
|
required :cadence,
|
5357
5349
|
enum: -> {
|
5358
5350
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation::Cadence
|
@@ -5404,7 +5396,7 @@ module Orb
|
|
5404
5396
|
# For custom cadence: specifies the duration of the billing period in days or
|
5405
5397
|
# months.
|
5406
5398
|
#
|
5407
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation::BillingCycleConfiguration, nil]
|
5399
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation::BillingCycleConfiguration, nil]
|
5408
5400
|
optional :billing_cycle_configuration,
|
5409
5401
|
-> {
|
5410
5402
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation::BillingCycleConfiguration
|
@@ -5440,7 +5432,7 @@ module Orb
|
|
5440
5432
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
5441
5433
|
# If unspecified, a single invoice is produced per billing cycle.
|
5442
5434
|
#
|
5443
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation::InvoicingCycleConfiguration, nil]
|
5435
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation::InvoicingCycleConfiguration, nil]
|
5444
5436
|
optional :invoicing_cycle_configuration,
|
5445
5437
|
-> {
|
5446
5438
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation::InvoicingCycleConfiguration
|
@@ -5457,10 +5449,10 @@ module Orb
|
|
5457
5449
|
|
5458
5450
|
# @!method initialize(cadence:, currency:, grouped_allocation_config:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :grouped_allocation)
|
5459
5451
|
# Some parameter documentations has been truncated, see
|
5460
|
-
# {Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation}
|
5461
|
-
# details.
|
5452
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation}
|
5453
|
+
# for more details.
|
5462
5454
|
#
|
5463
|
-
# @param cadence [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation::Cadence] The cadence to bill for this price on.
|
5455
|
+
# @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation::Cadence] The cadence to bill for this price on.
|
5464
5456
|
#
|
5465
5457
|
# @param currency [String] An ISO 4217 currency string for which this price is billed in.
|
5466
5458
|
#
|
@@ -5474,7 +5466,7 @@ module Orb
|
|
5474
5466
|
#
|
5475
5467
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
5476
5468
|
#
|
5477
|
-
# @param billing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
5469
|
+
# @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
5478
5470
|
#
|
5479
5471
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
5480
5472
|
#
|
@@ -5484,7 +5476,7 @@ module Orb
|
|
5484
5476
|
#
|
5485
5477
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
5486
5478
|
#
|
5487
|
-
# @param invoicing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
5479
|
+
# @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
5488
5480
|
#
|
5489
5481
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
5490
5482
|
#
|
@@ -5492,7 +5484,7 @@ module Orb
|
|
5492
5484
|
|
5493
5485
|
# The cadence to bill for this price on.
|
5494
5486
|
#
|
5495
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation#cadence
|
5487
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation#cadence
|
5496
5488
|
module Cadence
|
5497
5489
|
extend Orb::Internal::Type::Enum
|
5498
5490
|
|
@@ -5507,7 +5499,7 @@ module Orb
|
|
5507
5499
|
# @return [Array<Symbol>]
|
5508
5500
|
end
|
5509
5501
|
|
5510
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation#billing_cycle_configuration
|
5502
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation#billing_cycle_configuration
|
5511
5503
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
5512
5504
|
# @!attribute duration
|
5513
5505
|
# The duration of the billing period.
|
@@ -5518,7 +5510,7 @@ module Orb
|
|
5518
5510
|
# @!attribute duration_unit
|
5519
5511
|
# The unit of billing period duration.
|
5520
5512
|
#
|
5521
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation::BillingCycleConfiguration::DurationUnit]
|
5513
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation::BillingCycleConfiguration::DurationUnit]
|
5522
5514
|
required :duration_unit,
|
5523
5515
|
enum: -> {
|
5524
5516
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation::BillingCycleConfiguration::DurationUnit
|
@@ -5530,11 +5522,11 @@ module Orb
|
|
5530
5522
|
#
|
5531
5523
|
# @param duration [Integer] The duration of the billing period.
|
5532
5524
|
#
|
5533
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
5525
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
5534
5526
|
|
5535
5527
|
# The unit of billing period duration.
|
5536
5528
|
#
|
5537
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation::BillingCycleConfiguration#duration_unit
|
5529
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation::BillingCycleConfiguration#duration_unit
|
5538
5530
|
module DurationUnit
|
5539
5531
|
extend Orb::Internal::Type::Enum
|
5540
5532
|
|
@@ -5546,7 +5538,7 @@ module Orb
|
|
5546
5538
|
end
|
5547
5539
|
end
|
5548
5540
|
|
5549
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation#invoicing_cycle_configuration
|
5541
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation#invoicing_cycle_configuration
|
5550
5542
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
5551
5543
|
# @!attribute duration
|
5552
5544
|
# The duration of the billing period.
|
@@ -5557,7 +5549,7 @@ module Orb
|
|
5557
5549
|
# @!attribute duration_unit
|
5558
5550
|
# The unit of billing period duration.
|
5559
5551
|
#
|
5560
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation::InvoicingCycleConfiguration::DurationUnit]
|
5552
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation::InvoicingCycleConfiguration::DurationUnit]
|
5561
5553
|
required :duration_unit,
|
5562
5554
|
enum: -> {
|
5563
5555
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation::InvoicingCycleConfiguration::DurationUnit
|
@@ -5569,11 +5561,11 @@ module Orb
|
|
5569
5561
|
#
|
5570
5562
|
# @param duration [Integer] The duration of the billing period.
|
5571
5563
|
#
|
5572
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
5564
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
5573
5565
|
|
5574
5566
|
# The unit of billing period duration.
|
5575
5567
|
#
|
5576
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation::InvoicingCycleConfiguration#duration_unit
|
5568
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation::InvoicingCycleConfiguration#duration_unit
|
5577
5569
|
module DurationUnit
|
5578
5570
|
extend Orb::Internal::Type::Enum
|
5579
5571
|
|
@@ -5590,7 +5582,7 @@ module Orb
|
|
5590
5582
|
# @!attribute cadence
|
5591
5583
|
# The cadence to bill for this price on.
|
5592
5584
|
#
|
5593
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum::Cadence]
|
5585
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum::Cadence]
|
5594
5586
|
required :cadence,
|
5595
5587
|
enum: -> {
|
5596
5588
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum::Cadence
|
@@ -5643,7 +5635,7 @@ module Orb
|
|
5643
5635
|
# For custom cadence: specifies the duration of the billing period in days or
|
5644
5636
|
# months.
|
5645
5637
|
#
|
5646
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum::BillingCycleConfiguration, nil]
|
5638
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum::BillingCycleConfiguration, nil]
|
5647
5639
|
optional :billing_cycle_configuration,
|
5648
5640
|
-> {
|
5649
5641
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum::BillingCycleConfiguration
|
@@ -5679,7 +5671,7 @@ module Orb
|
|
5679
5671
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
5680
5672
|
# If unspecified, a single invoice is produced per billing cycle.
|
5681
5673
|
#
|
5682
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum::InvoicingCycleConfiguration, nil]
|
5674
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum::InvoicingCycleConfiguration, nil]
|
5683
5675
|
optional :invoicing_cycle_configuration,
|
5684
5676
|
-> {
|
5685
5677
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum::InvoicingCycleConfiguration
|
@@ -5696,10 +5688,10 @@ module Orb
|
|
5696
5688
|
|
5697
5689
|
# @!method initialize(cadence:, currency:, grouped_with_prorated_minimum_config:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: 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)
|
5698
5690
|
# Some parameter documentations has been truncated, see
|
5699
|
-
# {Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum}
|
5691
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum}
|
5700
5692
|
# for more details.
|
5701
5693
|
#
|
5702
|
-
# @param cadence [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum::Cadence] The cadence to bill for this price on.
|
5694
|
+
# @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum::Cadence] The cadence to bill for this price on.
|
5703
5695
|
#
|
5704
5696
|
# @param currency [String] An ISO 4217 currency string for which this price is billed in.
|
5705
5697
|
#
|
@@ -5713,7 +5705,7 @@ module Orb
|
|
5713
5705
|
#
|
5714
5706
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
5715
5707
|
#
|
5716
|
-
# @param billing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
5708
|
+
# @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
5717
5709
|
#
|
5718
5710
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
5719
5711
|
#
|
@@ -5723,7 +5715,7 @@ module Orb
|
|
5723
5715
|
#
|
5724
5716
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
5725
5717
|
#
|
5726
|
-
# @param invoicing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
5718
|
+
# @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
5727
5719
|
#
|
5728
5720
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
5729
5721
|
#
|
@@ -5731,7 +5723,7 @@ module Orb
|
|
5731
5723
|
|
5732
5724
|
# The cadence to bill for this price on.
|
5733
5725
|
#
|
5734
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum#cadence
|
5726
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum#cadence
|
5735
5727
|
module Cadence
|
5736
5728
|
extend Orb::Internal::Type::Enum
|
5737
5729
|
|
@@ -5746,7 +5738,7 @@ module Orb
|
|
5746
5738
|
# @return [Array<Symbol>]
|
5747
5739
|
end
|
5748
5740
|
|
5749
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum#billing_cycle_configuration
|
5741
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum#billing_cycle_configuration
|
5750
5742
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
5751
5743
|
# @!attribute duration
|
5752
5744
|
# The duration of the billing period.
|
@@ -5757,7 +5749,7 @@ module Orb
|
|
5757
5749
|
# @!attribute duration_unit
|
5758
5750
|
# The unit of billing period duration.
|
5759
5751
|
#
|
5760
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum::BillingCycleConfiguration::DurationUnit]
|
5752
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum::BillingCycleConfiguration::DurationUnit]
|
5761
5753
|
required :duration_unit,
|
5762
5754
|
enum: -> {
|
5763
5755
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum::BillingCycleConfiguration::DurationUnit
|
@@ -5769,11 +5761,11 @@ module Orb
|
|
5769
5761
|
#
|
5770
5762
|
# @param duration [Integer] The duration of the billing period.
|
5771
5763
|
#
|
5772
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
5764
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
5773
5765
|
|
5774
5766
|
# The unit of billing period duration.
|
5775
5767
|
#
|
5776
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum::BillingCycleConfiguration#duration_unit
|
5768
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum::BillingCycleConfiguration#duration_unit
|
5777
5769
|
module DurationUnit
|
5778
5770
|
extend Orb::Internal::Type::Enum
|
5779
5771
|
|
@@ -5785,7 +5777,7 @@ module Orb
|
|
5785
5777
|
end
|
5786
5778
|
end
|
5787
5779
|
|
5788
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum#invoicing_cycle_configuration
|
5780
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum#invoicing_cycle_configuration
|
5789
5781
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
5790
5782
|
# @!attribute duration
|
5791
5783
|
# The duration of the billing period.
|
@@ -5796,7 +5788,7 @@ module Orb
|
|
5796
5788
|
# @!attribute duration_unit
|
5797
5789
|
# The unit of billing period duration.
|
5798
5790
|
#
|
5799
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum::InvoicingCycleConfiguration::DurationUnit]
|
5791
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum::InvoicingCycleConfiguration::DurationUnit]
|
5800
5792
|
required :duration_unit,
|
5801
5793
|
enum: -> {
|
5802
5794
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum::InvoicingCycleConfiguration::DurationUnit
|
@@ -5808,11 +5800,11 @@ module Orb
|
|
5808
5800
|
#
|
5809
5801
|
# @param duration [Integer] The duration of the billing period.
|
5810
5802
|
#
|
5811
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
5803
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
5812
5804
|
|
5813
5805
|
# The unit of billing period duration.
|
5814
5806
|
#
|
5815
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum::InvoicingCycleConfiguration#duration_unit
|
5807
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum::InvoicingCycleConfiguration#duration_unit
|
5816
5808
|
module DurationUnit
|
5817
5809
|
extend Orb::Internal::Type::Enum
|
5818
5810
|
|
@@ -5829,7 +5821,7 @@ module Orb
|
|
5829
5821
|
# @!attribute cadence
|
5830
5822
|
# The cadence to bill for this price on.
|
5831
5823
|
#
|
5832
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum::Cadence]
|
5824
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum::Cadence]
|
5833
5825
|
required :cadence,
|
5834
5826
|
enum: -> {
|
5835
5827
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum::Cadence
|
@@ -5882,7 +5874,7 @@ module Orb
|
|
5882
5874
|
# For custom cadence: specifies the duration of the billing period in days or
|
5883
5875
|
# months.
|
5884
5876
|
#
|
5885
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum::BillingCycleConfiguration, nil]
|
5877
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum::BillingCycleConfiguration, nil]
|
5886
5878
|
optional :billing_cycle_configuration,
|
5887
5879
|
-> {
|
5888
5880
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum::BillingCycleConfiguration
|
@@ -5918,7 +5910,7 @@ module Orb
|
|
5918
5910
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
5919
5911
|
# If unspecified, a single invoice is produced per billing cycle.
|
5920
5912
|
#
|
5921
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum::InvoicingCycleConfiguration, nil]
|
5913
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum::InvoicingCycleConfiguration, nil]
|
5922
5914
|
optional :invoicing_cycle_configuration,
|
5923
5915
|
-> {
|
5924
5916
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum::InvoicingCycleConfiguration
|
@@ -5935,10 +5927,10 @@ module Orb
|
|
5935
5927
|
|
5936
5928
|
# @!method initialize(cadence:, currency:, grouped_with_metered_minimum_config:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: 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)
|
5937
5929
|
# Some parameter documentations has been truncated, see
|
5938
|
-
# {Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum}
|
5930
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum}
|
5939
5931
|
# for more details.
|
5940
5932
|
#
|
5941
|
-
# @param cadence [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum::Cadence] The cadence to bill for this price on.
|
5933
|
+
# @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum::Cadence] The cadence to bill for this price on.
|
5942
5934
|
#
|
5943
5935
|
# @param currency [String] An ISO 4217 currency string for which this price is billed in.
|
5944
5936
|
#
|
@@ -5952,7 +5944,7 @@ module Orb
|
|
5952
5944
|
#
|
5953
5945
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
5954
5946
|
#
|
5955
|
-
# @param billing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
5947
|
+
# @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
5956
5948
|
#
|
5957
5949
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
5958
5950
|
#
|
@@ -5962,7 +5954,7 @@ module Orb
|
|
5962
5954
|
#
|
5963
5955
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
5964
5956
|
#
|
5965
|
-
# @param invoicing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
5957
|
+
# @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
5966
5958
|
#
|
5967
5959
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
5968
5960
|
#
|
@@ -5970,7 +5962,7 @@ module Orb
|
|
5970
5962
|
|
5971
5963
|
# The cadence to bill for this price on.
|
5972
5964
|
#
|
5973
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum#cadence
|
5965
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum#cadence
|
5974
5966
|
module Cadence
|
5975
5967
|
extend Orb::Internal::Type::Enum
|
5976
5968
|
|
@@ -5985,7 +5977,7 @@ module Orb
|
|
5985
5977
|
# @return [Array<Symbol>]
|
5986
5978
|
end
|
5987
5979
|
|
5988
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum#billing_cycle_configuration
|
5980
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum#billing_cycle_configuration
|
5989
5981
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
5990
5982
|
# @!attribute duration
|
5991
5983
|
# The duration of the billing period.
|
@@ -5996,7 +5988,7 @@ module Orb
|
|
5996
5988
|
# @!attribute duration_unit
|
5997
5989
|
# The unit of billing period duration.
|
5998
5990
|
#
|
5999
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum::BillingCycleConfiguration::DurationUnit]
|
5991
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum::BillingCycleConfiguration::DurationUnit]
|
6000
5992
|
required :duration_unit,
|
6001
5993
|
enum: -> {
|
6002
5994
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum::BillingCycleConfiguration::DurationUnit
|
@@ -6008,11 +6000,11 @@ module Orb
|
|
6008
6000
|
#
|
6009
6001
|
# @param duration [Integer] The duration of the billing period.
|
6010
6002
|
#
|
6011
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
6003
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
6012
6004
|
|
6013
6005
|
# The unit of billing period duration.
|
6014
6006
|
#
|
6015
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum::BillingCycleConfiguration#duration_unit
|
6007
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum::BillingCycleConfiguration#duration_unit
|
6016
6008
|
module DurationUnit
|
6017
6009
|
extend Orb::Internal::Type::Enum
|
6018
6010
|
|
@@ -6024,7 +6016,7 @@ module Orb
|
|
6024
6016
|
end
|
6025
6017
|
end
|
6026
6018
|
|
6027
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum#invoicing_cycle_configuration
|
6019
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum#invoicing_cycle_configuration
|
6028
6020
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
6029
6021
|
# @!attribute duration
|
6030
6022
|
# The duration of the billing period.
|
@@ -6035,7 +6027,7 @@ module Orb
|
|
6035
6027
|
# @!attribute duration_unit
|
6036
6028
|
# The unit of billing period duration.
|
6037
6029
|
#
|
6038
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum::InvoicingCycleConfiguration::DurationUnit]
|
6030
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum::InvoicingCycleConfiguration::DurationUnit]
|
6039
6031
|
required :duration_unit,
|
6040
6032
|
enum: -> {
|
6041
6033
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum::InvoicingCycleConfiguration::DurationUnit
|
@@ -6047,11 +6039,11 @@ module Orb
|
|
6047
6039
|
#
|
6048
6040
|
# @param duration [Integer] The duration of the billing period.
|
6049
6041
|
#
|
6050
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
6042
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
6051
6043
|
|
6052
6044
|
# The unit of billing period duration.
|
6053
6045
|
#
|
6054
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum::InvoicingCycleConfiguration#duration_unit
|
6046
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum::InvoicingCycleConfiguration#duration_unit
|
6055
6047
|
module DurationUnit
|
6056
6048
|
extend Orb::Internal::Type::Enum
|
6057
6049
|
|
@@ -6068,7 +6060,7 @@ module Orb
|
|
6068
6060
|
# @!attribute cadence
|
6069
6061
|
# The cadence to bill for this price on.
|
6070
6062
|
#
|
6071
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName::Cadence]
|
6063
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName::Cadence]
|
6072
6064
|
required :cadence,
|
6073
6065
|
enum: -> {
|
6074
6066
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName::Cadence
|
@@ -6121,7 +6113,7 @@ module Orb
|
|
6121
6113
|
# For custom cadence: specifies the duration of the billing period in days or
|
6122
6114
|
# months.
|
6123
6115
|
#
|
6124
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName::BillingCycleConfiguration, nil]
|
6116
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName::BillingCycleConfiguration, nil]
|
6125
6117
|
optional :billing_cycle_configuration,
|
6126
6118
|
-> {
|
6127
6119
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName::BillingCycleConfiguration
|
@@ -6157,7 +6149,7 @@ module Orb
|
|
6157
6149
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
6158
6150
|
# If unspecified, a single invoice is produced per billing cycle.
|
6159
6151
|
#
|
6160
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName::InvoicingCycleConfiguration, nil]
|
6152
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName::InvoicingCycleConfiguration, nil]
|
6161
6153
|
optional :invoicing_cycle_configuration,
|
6162
6154
|
-> {
|
6163
6155
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName::InvoicingCycleConfiguration
|
@@ -6174,10 +6166,10 @@ module Orb
|
|
6174
6166
|
|
6175
6167
|
# @!method initialize(cadence:, currency:, item_id:, matrix_with_display_name_config:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: 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)
|
6176
6168
|
# Some parameter documentations has been truncated, see
|
6177
|
-
# {Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName}
|
6178
|
-
# more details.
|
6169
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName}
|
6170
|
+
# for more details.
|
6179
6171
|
#
|
6180
|
-
# @param cadence [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName::Cadence] The cadence to bill for this price on.
|
6172
|
+
# @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName::Cadence] The cadence to bill for this price on.
|
6181
6173
|
#
|
6182
6174
|
# @param currency [String] An ISO 4217 currency string for which this price is billed in.
|
6183
6175
|
#
|
@@ -6191,7 +6183,7 @@ module Orb
|
|
6191
6183
|
#
|
6192
6184
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
6193
6185
|
#
|
6194
|
-
# @param billing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
6186
|
+
# @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
6195
6187
|
#
|
6196
6188
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
6197
6189
|
#
|
@@ -6201,7 +6193,7 @@ module Orb
|
|
6201
6193
|
#
|
6202
6194
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
6203
6195
|
#
|
6204
|
-
# @param invoicing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
6196
|
+
# @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
6205
6197
|
#
|
6206
6198
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
6207
6199
|
#
|
@@ -6209,7 +6201,7 @@ module Orb
|
|
6209
6201
|
|
6210
6202
|
# The cadence to bill for this price on.
|
6211
6203
|
#
|
6212
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName#cadence
|
6204
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName#cadence
|
6213
6205
|
module Cadence
|
6214
6206
|
extend Orb::Internal::Type::Enum
|
6215
6207
|
|
@@ -6224,7 +6216,7 @@ module Orb
|
|
6224
6216
|
# @return [Array<Symbol>]
|
6225
6217
|
end
|
6226
6218
|
|
6227
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName#billing_cycle_configuration
|
6219
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName#billing_cycle_configuration
|
6228
6220
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
6229
6221
|
# @!attribute duration
|
6230
6222
|
# The duration of the billing period.
|
@@ -6235,7 +6227,7 @@ module Orb
|
|
6235
6227
|
# @!attribute duration_unit
|
6236
6228
|
# The unit of billing period duration.
|
6237
6229
|
#
|
6238
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName::BillingCycleConfiguration::DurationUnit]
|
6230
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName::BillingCycleConfiguration::DurationUnit]
|
6239
6231
|
required :duration_unit,
|
6240
6232
|
enum: -> {
|
6241
6233
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName::BillingCycleConfiguration::DurationUnit
|
@@ -6247,11 +6239,11 @@ module Orb
|
|
6247
6239
|
#
|
6248
6240
|
# @param duration [Integer] The duration of the billing period.
|
6249
6241
|
#
|
6250
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
6242
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
6251
6243
|
|
6252
6244
|
# The unit of billing period duration.
|
6253
6245
|
#
|
6254
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName::BillingCycleConfiguration#duration_unit
|
6246
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName::BillingCycleConfiguration#duration_unit
|
6255
6247
|
module DurationUnit
|
6256
6248
|
extend Orb::Internal::Type::Enum
|
6257
6249
|
|
@@ -6263,7 +6255,7 @@ module Orb
|
|
6263
6255
|
end
|
6264
6256
|
end
|
6265
6257
|
|
6266
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName#invoicing_cycle_configuration
|
6258
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName#invoicing_cycle_configuration
|
6267
6259
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
6268
6260
|
# @!attribute duration
|
6269
6261
|
# The duration of the billing period.
|
@@ -6274,7 +6266,7 @@ module Orb
|
|
6274
6266
|
# @!attribute duration_unit
|
6275
6267
|
# The unit of billing period duration.
|
6276
6268
|
#
|
6277
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName::InvoicingCycleConfiguration::DurationUnit]
|
6269
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName::InvoicingCycleConfiguration::DurationUnit]
|
6278
6270
|
required :duration_unit,
|
6279
6271
|
enum: -> {
|
6280
6272
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName::InvoicingCycleConfiguration::DurationUnit
|
@@ -6286,11 +6278,11 @@ module Orb
|
|
6286
6278
|
#
|
6287
6279
|
# @param duration [Integer] The duration of the billing period.
|
6288
6280
|
#
|
6289
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
6281
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
6290
6282
|
|
6291
6283
|
# The unit of billing period duration.
|
6292
6284
|
#
|
6293
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName::InvoicingCycleConfiguration#duration_unit
|
6285
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName::InvoicingCycleConfiguration#duration_unit
|
6294
6286
|
module DurationUnit
|
6295
6287
|
extend Orb::Internal::Type::Enum
|
6296
6288
|
|
@@ -6312,7 +6304,7 @@ module Orb
|
|
6312
6304
|
# @!attribute cadence
|
6313
6305
|
# The cadence to bill for this price on.
|
6314
6306
|
#
|
6315
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration::Cadence]
|
6307
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration::Cadence]
|
6316
6308
|
required :cadence,
|
6317
6309
|
enum: -> {
|
6318
6310
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration::Cadence
|
@@ -6359,7 +6351,7 @@ module Orb
|
|
6359
6351
|
# For custom cadence: specifies the duration of the billing period in days or
|
6360
6352
|
# months.
|
6361
6353
|
#
|
6362
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration::BillingCycleConfiguration, nil]
|
6354
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration::BillingCycleConfiguration, nil]
|
6363
6355
|
optional :billing_cycle_configuration,
|
6364
6356
|
-> {
|
6365
6357
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration::BillingCycleConfiguration
|
@@ -6395,7 +6387,7 @@ module Orb
|
|
6395
6387
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
6396
6388
|
# If unspecified, a single invoice is produced per billing cycle.
|
6397
6389
|
#
|
6398
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration::InvoicingCycleConfiguration, nil]
|
6390
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration::InvoicingCycleConfiguration, nil]
|
6399
6391
|
optional :invoicing_cycle_configuration,
|
6400
6392
|
-> {
|
6401
6393
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration::InvoicingCycleConfiguration
|
@@ -6412,12 +6404,12 @@ module Orb
|
|
6412
6404
|
|
6413
6405
|
# @!method initialize(bulk_with_proration_config:, cadence:, currency:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :bulk_with_proration)
|
6414
6406
|
# Some parameter documentations has been truncated, see
|
6415
|
-
# {Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration}
|
6416
|
-
# details.
|
6407
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration}
|
6408
|
+
# for more details.
|
6417
6409
|
#
|
6418
6410
|
# @param bulk_with_proration_config [Hash{Symbol=>Object}]
|
6419
6411
|
#
|
6420
|
-
# @param cadence [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration::Cadence] The cadence to bill for this price on.
|
6412
|
+
# @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration::Cadence] The cadence to bill for this price on.
|
6421
6413
|
#
|
6422
6414
|
# @param currency [String] An ISO 4217 currency string for which this price is billed in.
|
6423
6415
|
#
|
@@ -6429,7 +6421,7 @@ module Orb
|
|
6429
6421
|
#
|
6430
6422
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
6431
6423
|
#
|
6432
|
-
# @param billing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
6424
|
+
# @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
6433
6425
|
#
|
6434
6426
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
6435
6427
|
#
|
@@ -6439,7 +6431,7 @@ module Orb
|
|
6439
6431
|
#
|
6440
6432
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
6441
6433
|
#
|
6442
|
-
# @param invoicing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
6434
|
+
# @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
6443
6435
|
#
|
6444
6436
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
6445
6437
|
#
|
@@ -6447,7 +6439,7 @@ module Orb
|
|
6447
6439
|
|
6448
6440
|
# The cadence to bill for this price on.
|
6449
6441
|
#
|
6450
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration#cadence
|
6442
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration#cadence
|
6451
6443
|
module Cadence
|
6452
6444
|
extend Orb::Internal::Type::Enum
|
6453
6445
|
|
@@ -6462,7 +6454,7 @@ module Orb
|
|
6462
6454
|
# @return [Array<Symbol>]
|
6463
6455
|
end
|
6464
6456
|
|
6465
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration#billing_cycle_configuration
|
6457
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration#billing_cycle_configuration
|
6466
6458
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
6467
6459
|
# @!attribute duration
|
6468
6460
|
# The duration of the billing period.
|
@@ -6473,7 +6465,7 @@ module Orb
|
|
6473
6465
|
# @!attribute duration_unit
|
6474
6466
|
# The unit of billing period duration.
|
6475
6467
|
#
|
6476
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration::BillingCycleConfiguration::DurationUnit]
|
6468
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration::BillingCycleConfiguration::DurationUnit]
|
6477
6469
|
required :duration_unit,
|
6478
6470
|
enum: -> {
|
6479
6471
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration::BillingCycleConfiguration::DurationUnit
|
@@ -6485,11 +6477,11 @@ module Orb
|
|
6485
6477
|
#
|
6486
6478
|
# @param duration [Integer] The duration of the billing period.
|
6487
6479
|
#
|
6488
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
6480
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
6489
6481
|
|
6490
6482
|
# The unit of billing period duration.
|
6491
6483
|
#
|
6492
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration::BillingCycleConfiguration#duration_unit
|
6484
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration::BillingCycleConfiguration#duration_unit
|
6493
6485
|
module DurationUnit
|
6494
6486
|
extend Orb::Internal::Type::Enum
|
6495
6487
|
|
@@ -6501,7 +6493,7 @@ module Orb
|
|
6501
6493
|
end
|
6502
6494
|
end
|
6503
6495
|
|
6504
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration#invoicing_cycle_configuration
|
6496
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration#invoicing_cycle_configuration
|
6505
6497
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
6506
6498
|
# @!attribute duration
|
6507
6499
|
# The duration of the billing period.
|
@@ -6512,7 +6504,7 @@ module Orb
|
|
6512
6504
|
# @!attribute duration_unit
|
6513
6505
|
# The unit of billing period duration.
|
6514
6506
|
#
|
6515
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration::InvoicingCycleConfiguration::DurationUnit]
|
6507
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration::InvoicingCycleConfiguration::DurationUnit]
|
6516
6508
|
required :duration_unit,
|
6517
6509
|
enum: -> {
|
6518
6510
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration::InvoicingCycleConfiguration::DurationUnit
|
@@ -6524,11 +6516,11 @@ module Orb
|
|
6524
6516
|
#
|
6525
6517
|
# @param duration [Integer] The duration of the billing period.
|
6526
6518
|
#
|
6527
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
6519
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
6528
6520
|
|
6529
6521
|
# The unit of billing period duration.
|
6530
6522
|
#
|
6531
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration::InvoicingCycleConfiguration#duration_unit
|
6523
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration::InvoicingCycleConfiguration#duration_unit
|
6532
6524
|
module DurationUnit
|
6533
6525
|
extend Orb::Internal::Type::Enum
|
6534
6526
|
|
@@ -6545,7 +6537,7 @@ module Orb
|
|
6545
6537
|
# @!attribute cadence
|
6546
6538
|
# The cadence to bill for this price on.
|
6547
6539
|
#
|
6548
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage::Cadence]
|
6540
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage::Cadence]
|
6549
6541
|
required :cadence,
|
6550
6542
|
enum: -> {
|
6551
6543
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage::Cadence
|
@@ -6597,7 +6589,7 @@ module Orb
|
|
6597
6589
|
# For custom cadence: specifies the duration of the billing period in days or
|
6598
6590
|
# months.
|
6599
6591
|
#
|
6600
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage::BillingCycleConfiguration, nil]
|
6592
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage::BillingCycleConfiguration, nil]
|
6601
6593
|
optional :billing_cycle_configuration,
|
6602
6594
|
-> {
|
6603
6595
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage::BillingCycleConfiguration
|
@@ -6633,7 +6625,7 @@ module Orb
|
|
6633
6625
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
6634
6626
|
# If unspecified, a single invoice is produced per billing cycle.
|
6635
6627
|
#
|
6636
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage::InvoicingCycleConfiguration, nil]
|
6628
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage::InvoicingCycleConfiguration, nil]
|
6637
6629
|
optional :invoicing_cycle_configuration,
|
6638
6630
|
-> {
|
6639
6631
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage::InvoicingCycleConfiguration
|
@@ -6650,10 +6642,10 @@ module Orb
|
|
6650
6642
|
|
6651
6643
|
# @!method initialize(cadence:, currency:, grouped_tiered_package_config:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :grouped_tiered_package)
|
6652
6644
|
# Some parameter documentations has been truncated, see
|
6653
|
-
# {Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage}
|
6654
|
-
# more details.
|
6645
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage}
|
6646
|
+
# for more details.
|
6655
6647
|
#
|
6656
|
-
# @param cadence [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage::Cadence] The cadence to bill for this price on.
|
6648
|
+
# @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage::Cadence] The cadence to bill for this price on.
|
6657
6649
|
#
|
6658
6650
|
# @param currency [String] An ISO 4217 currency string for which this price is billed in.
|
6659
6651
|
#
|
@@ -6667,7 +6659,7 @@ module Orb
|
|
6667
6659
|
#
|
6668
6660
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
6669
6661
|
#
|
6670
|
-
# @param billing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
6662
|
+
# @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
6671
6663
|
#
|
6672
6664
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
6673
6665
|
#
|
@@ -6677,7 +6669,7 @@ module Orb
|
|
6677
6669
|
#
|
6678
6670
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
6679
6671
|
#
|
6680
|
-
# @param invoicing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
6672
|
+
# @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
6681
6673
|
#
|
6682
6674
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
6683
6675
|
#
|
@@ -6685,7 +6677,7 @@ module Orb
|
|
6685
6677
|
|
6686
6678
|
# The cadence to bill for this price on.
|
6687
6679
|
#
|
6688
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage#cadence
|
6680
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage#cadence
|
6689
6681
|
module Cadence
|
6690
6682
|
extend Orb::Internal::Type::Enum
|
6691
6683
|
|
@@ -6700,7 +6692,7 @@ module Orb
|
|
6700
6692
|
# @return [Array<Symbol>]
|
6701
6693
|
end
|
6702
6694
|
|
6703
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage#billing_cycle_configuration
|
6695
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage#billing_cycle_configuration
|
6704
6696
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
6705
6697
|
# @!attribute duration
|
6706
6698
|
# The duration of the billing period.
|
@@ -6711,7 +6703,7 @@ module Orb
|
|
6711
6703
|
# @!attribute duration_unit
|
6712
6704
|
# The unit of billing period duration.
|
6713
6705
|
#
|
6714
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage::BillingCycleConfiguration::DurationUnit]
|
6706
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage::BillingCycleConfiguration::DurationUnit]
|
6715
6707
|
required :duration_unit,
|
6716
6708
|
enum: -> {
|
6717
6709
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage::BillingCycleConfiguration::DurationUnit
|
@@ -6723,11 +6715,11 @@ module Orb
|
|
6723
6715
|
#
|
6724
6716
|
# @param duration [Integer] The duration of the billing period.
|
6725
6717
|
#
|
6726
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
6718
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
6727
6719
|
|
6728
6720
|
# The unit of billing period duration.
|
6729
6721
|
#
|
6730
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage::BillingCycleConfiguration#duration_unit
|
6722
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage::BillingCycleConfiguration#duration_unit
|
6731
6723
|
module DurationUnit
|
6732
6724
|
extend Orb::Internal::Type::Enum
|
6733
6725
|
|
@@ -6739,7 +6731,7 @@ module Orb
|
|
6739
6731
|
end
|
6740
6732
|
end
|
6741
6733
|
|
6742
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage#invoicing_cycle_configuration
|
6734
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage#invoicing_cycle_configuration
|
6743
6735
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
6744
6736
|
# @!attribute duration
|
6745
6737
|
# The duration of the billing period.
|
@@ -6750,7 +6742,7 @@ module Orb
|
|
6750
6742
|
# @!attribute duration_unit
|
6751
6743
|
# The unit of billing period duration.
|
6752
6744
|
#
|
6753
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage::InvoicingCycleConfiguration::DurationUnit]
|
6745
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage::InvoicingCycleConfiguration::DurationUnit]
|
6754
6746
|
required :duration_unit,
|
6755
6747
|
enum: -> {
|
6756
6748
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage::InvoicingCycleConfiguration::DurationUnit
|
@@ -6762,11 +6754,11 @@ module Orb
|
|
6762
6754
|
#
|
6763
6755
|
# @param duration [Integer] The duration of the billing period.
|
6764
6756
|
#
|
6765
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
6757
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
6766
6758
|
|
6767
6759
|
# The unit of billing period duration.
|
6768
6760
|
#
|
6769
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage::InvoicingCycleConfiguration#duration_unit
|
6761
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage::InvoicingCycleConfiguration#duration_unit
|
6770
6762
|
module DurationUnit
|
6771
6763
|
extend Orb::Internal::Type::Enum
|
6772
6764
|
|
@@ -6783,7 +6775,7 @@ module Orb
|
|
6783
6775
|
# @!attribute cadence
|
6784
6776
|
# The cadence to bill for this price on.
|
6785
6777
|
#
|
6786
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing::Cadence]
|
6778
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing::Cadence]
|
6787
6779
|
required :cadence,
|
6788
6780
|
enum: -> {
|
6789
6781
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing::Cadence
|
@@ -6836,7 +6828,7 @@ module Orb
|
|
6836
6828
|
# For custom cadence: specifies the duration of the billing period in days or
|
6837
6829
|
# months.
|
6838
6830
|
#
|
6839
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing::BillingCycleConfiguration, nil]
|
6831
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing::BillingCycleConfiguration, nil]
|
6840
6832
|
optional :billing_cycle_configuration,
|
6841
6833
|
-> {
|
6842
6834
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing::BillingCycleConfiguration
|
@@ -6872,7 +6864,7 @@ module Orb
|
|
6872
6864
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
6873
6865
|
# If unspecified, a single invoice is produced per billing cycle.
|
6874
6866
|
#
|
6875
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing::InvoicingCycleConfiguration, nil]
|
6867
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing::InvoicingCycleConfiguration, nil]
|
6876
6868
|
optional :invoicing_cycle_configuration,
|
6877
6869
|
-> {
|
6878
6870
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing::InvoicingCycleConfiguration
|
@@ -6889,10 +6881,10 @@ module Orb
|
|
6889
6881
|
|
6890
6882
|
# @!method initialize(cadence:, currency:, item_id:, name:, scalable_matrix_with_unit_pricing_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: 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)
|
6891
6883
|
# Some parameter documentations has been truncated, see
|
6892
|
-
# {Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing}
|
6884
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing}
|
6893
6885
|
# for more details.
|
6894
6886
|
#
|
6895
|
-
# @param cadence [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing::Cadence] The cadence to bill for this price on.
|
6887
|
+
# @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing::Cadence] The cadence to bill for this price on.
|
6896
6888
|
#
|
6897
6889
|
# @param currency [String] An ISO 4217 currency string for which this price is billed in.
|
6898
6890
|
#
|
@@ -6906,7 +6898,7 @@ module Orb
|
|
6906
6898
|
#
|
6907
6899
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
6908
6900
|
#
|
6909
|
-
# @param billing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
6901
|
+
# @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
6910
6902
|
#
|
6911
6903
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
6912
6904
|
#
|
@@ -6916,7 +6908,7 @@ module Orb
|
|
6916
6908
|
#
|
6917
6909
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
6918
6910
|
#
|
6919
|
-
# @param invoicing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
6911
|
+
# @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
6920
6912
|
#
|
6921
6913
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
6922
6914
|
#
|
@@ -6924,7 +6916,7 @@ module Orb
|
|
6924
6916
|
|
6925
6917
|
# The cadence to bill for this price on.
|
6926
6918
|
#
|
6927
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing#cadence
|
6919
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing#cadence
|
6928
6920
|
module Cadence
|
6929
6921
|
extend Orb::Internal::Type::Enum
|
6930
6922
|
|
@@ -6939,7 +6931,7 @@ module Orb
|
|
6939
6931
|
# @return [Array<Symbol>]
|
6940
6932
|
end
|
6941
6933
|
|
6942
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing#billing_cycle_configuration
|
6934
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing#billing_cycle_configuration
|
6943
6935
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
6944
6936
|
# @!attribute duration
|
6945
6937
|
# The duration of the billing period.
|
@@ -6950,7 +6942,7 @@ module Orb
|
|
6950
6942
|
# @!attribute duration_unit
|
6951
6943
|
# The unit of billing period duration.
|
6952
6944
|
#
|
6953
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing::BillingCycleConfiguration::DurationUnit]
|
6945
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing::BillingCycleConfiguration::DurationUnit]
|
6954
6946
|
required :duration_unit,
|
6955
6947
|
enum: -> {
|
6956
6948
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing::BillingCycleConfiguration::DurationUnit
|
@@ -6962,11 +6954,11 @@ module Orb
|
|
6962
6954
|
#
|
6963
6955
|
# @param duration [Integer] The duration of the billing period.
|
6964
6956
|
#
|
6965
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
6957
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
6966
6958
|
|
6967
6959
|
# The unit of billing period duration.
|
6968
6960
|
#
|
6969
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing::BillingCycleConfiguration#duration_unit
|
6961
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing::BillingCycleConfiguration#duration_unit
|
6970
6962
|
module DurationUnit
|
6971
6963
|
extend Orb::Internal::Type::Enum
|
6972
6964
|
|
@@ -6978,7 +6970,7 @@ module Orb
|
|
6978
6970
|
end
|
6979
6971
|
end
|
6980
6972
|
|
6981
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing#invoicing_cycle_configuration
|
6973
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing#invoicing_cycle_configuration
|
6982
6974
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
6983
6975
|
# @!attribute duration
|
6984
6976
|
# The duration of the billing period.
|
@@ -6989,7 +6981,7 @@ module Orb
|
|
6989
6981
|
# @!attribute duration_unit
|
6990
6982
|
# The unit of billing period duration.
|
6991
6983
|
#
|
6992
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing::InvoicingCycleConfiguration::DurationUnit]
|
6984
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing::InvoicingCycleConfiguration::DurationUnit]
|
6993
6985
|
required :duration_unit,
|
6994
6986
|
enum: -> {
|
6995
6987
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing::InvoicingCycleConfiguration::DurationUnit
|
@@ -7001,11 +6993,11 @@ module Orb
|
|
7001
6993
|
#
|
7002
6994
|
# @param duration [Integer] The duration of the billing period.
|
7003
6995
|
#
|
7004
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
6996
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
7005
6997
|
|
7006
6998
|
# The unit of billing period duration.
|
7007
6999
|
#
|
7008
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing::InvoicingCycleConfiguration#duration_unit
|
7000
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing::InvoicingCycleConfiguration#duration_unit
|
7009
7001
|
module DurationUnit
|
7010
7002
|
extend Orb::Internal::Type::Enum
|
7011
7003
|
|
@@ -7022,7 +7014,7 @@ module Orb
|
|
7022
7014
|
# @!attribute cadence
|
7023
7015
|
# The cadence to bill for this price on.
|
7024
7016
|
#
|
7025
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing::Cadence]
|
7017
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing::Cadence]
|
7026
7018
|
required :cadence,
|
7027
7019
|
enum: -> {
|
7028
7020
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing::Cadence
|
@@ -7075,7 +7067,7 @@ module Orb
|
|
7075
7067
|
# For custom cadence: specifies the duration of the billing period in days or
|
7076
7068
|
# months.
|
7077
7069
|
#
|
7078
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing::BillingCycleConfiguration, nil]
|
7070
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing::BillingCycleConfiguration, nil]
|
7079
7071
|
optional :billing_cycle_configuration,
|
7080
7072
|
-> {
|
7081
7073
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing::BillingCycleConfiguration
|
@@ -7111,7 +7103,7 @@ module Orb
|
|
7111
7103
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
7112
7104
|
# If unspecified, a single invoice is produced per billing cycle.
|
7113
7105
|
#
|
7114
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing::InvoicingCycleConfiguration, nil]
|
7106
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing::InvoicingCycleConfiguration, nil]
|
7115
7107
|
optional :invoicing_cycle_configuration,
|
7116
7108
|
-> {
|
7117
7109
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing::InvoicingCycleConfiguration
|
@@ -7128,10 +7120,10 @@ module Orb
|
|
7128
7120
|
|
7129
7121
|
# @!method initialize(cadence:, currency:, item_id:, name:, scalable_matrix_with_tiered_pricing_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: 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)
|
7130
7122
|
# Some parameter documentations has been truncated, see
|
7131
|
-
# {Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing}
|
7123
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing}
|
7132
7124
|
# for more details.
|
7133
7125
|
#
|
7134
|
-
# @param cadence [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing::Cadence] The cadence to bill for this price on.
|
7126
|
+
# @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing::Cadence] The cadence to bill for this price on.
|
7135
7127
|
#
|
7136
7128
|
# @param currency [String] An ISO 4217 currency string for which this price is billed in.
|
7137
7129
|
#
|
@@ -7145,7 +7137,7 @@ module Orb
|
|
7145
7137
|
#
|
7146
7138
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
7147
7139
|
#
|
7148
|
-
# @param billing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
7140
|
+
# @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
7149
7141
|
#
|
7150
7142
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
7151
7143
|
#
|
@@ -7155,7 +7147,7 @@ module Orb
|
|
7155
7147
|
#
|
7156
7148
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
7157
7149
|
#
|
7158
|
-
# @param invoicing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
7150
|
+
# @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
7159
7151
|
#
|
7160
7152
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
7161
7153
|
#
|
@@ -7163,7 +7155,7 @@ module Orb
|
|
7163
7155
|
|
7164
7156
|
# The cadence to bill for this price on.
|
7165
7157
|
#
|
7166
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing#cadence
|
7158
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing#cadence
|
7167
7159
|
module Cadence
|
7168
7160
|
extend Orb::Internal::Type::Enum
|
7169
7161
|
|
@@ -7178,7 +7170,7 @@ module Orb
|
|
7178
7170
|
# @return [Array<Symbol>]
|
7179
7171
|
end
|
7180
7172
|
|
7181
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing#billing_cycle_configuration
|
7173
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing#billing_cycle_configuration
|
7182
7174
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
7183
7175
|
# @!attribute duration
|
7184
7176
|
# The duration of the billing period.
|
@@ -7189,7 +7181,7 @@ module Orb
|
|
7189
7181
|
# @!attribute duration_unit
|
7190
7182
|
# The unit of billing period duration.
|
7191
7183
|
#
|
7192
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing::BillingCycleConfiguration::DurationUnit]
|
7184
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing::BillingCycleConfiguration::DurationUnit]
|
7193
7185
|
required :duration_unit,
|
7194
7186
|
enum: -> {
|
7195
7187
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing::BillingCycleConfiguration::DurationUnit
|
@@ -7201,11 +7193,11 @@ module Orb
|
|
7201
7193
|
#
|
7202
7194
|
# @param duration [Integer] The duration of the billing period.
|
7203
7195
|
#
|
7204
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
7196
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
7205
7197
|
|
7206
7198
|
# The unit of billing period duration.
|
7207
7199
|
#
|
7208
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing::BillingCycleConfiguration#duration_unit
|
7200
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing::BillingCycleConfiguration#duration_unit
|
7209
7201
|
module DurationUnit
|
7210
7202
|
extend Orb::Internal::Type::Enum
|
7211
7203
|
|
@@ -7217,7 +7209,7 @@ module Orb
|
|
7217
7209
|
end
|
7218
7210
|
end
|
7219
7211
|
|
7220
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing#invoicing_cycle_configuration
|
7212
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing#invoicing_cycle_configuration
|
7221
7213
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
7222
7214
|
# @!attribute duration
|
7223
7215
|
# The duration of the billing period.
|
@@ -7228,7 +7220,7 @@ module Orb
|
|
7228
7220
|
# @!attribute duration_unit
|
7229
7221
|
# The unit of billing period duration.
|
7230
7222
|
#
|
7231
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing::InvoicingCycleConfiguration::DurationUnit]
|
7223
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing::InvoicingCycleConfiguration::DurationUnit]
|
7232
7224
|
required :duration_unit,
|
7233
7225
|
enum: -> {
|
7234
7226
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing::InvoicingCycleConfiguration::DurationUnit
|
@@ -7240,11 +7232,11 @@ module Orb
|
|
7240
7232
|
#
|
7241
7233
|
# @param duration [Integer] The duration of the billing period.
|
7242
7234
|
#
|
7243
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
7235
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
7244
7236
|
|
7245
7237
|
# The unit of billing period duration.
|
7246
7238
|
#
|
7247
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing::InvoicingCycleConfiguration#duration_unit
|
7239
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing::InvoicingCycleConfiguration#duration_unit
|
7248
7240
|
module DurationUnit
|
7249
7241
|
extend Orb::Internal::Type::Enum
|
7250
7242
|
|
@@ -7261,7 +7253,7 @@ module Orb
|
|
7261
7253
|
# @!attribute cadence
|
7262
7254
|
# The cadence to bill for this price on.
|
7263
7255
|
#
|
7264
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk::Cadence]
|
7256
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk::Cadence]
|
7265
7257
|
required :cadence,
|
7266
7258
|
enum: -> {
|
7267
7259
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk::Cadence
|
@@ -7314,7 +7306,7 @@ module Orb
|
|
7314
7306
|
# For custom cadence: specifies the duration of the billing period in days or
|
7315
7307
|
# months.
|
7316
7308
|
#
|
7317
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk::BillingCycleConfiguration, nil]
|
7309
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk::BillingCycleConfiguration, nil]
|
7318
7310
|
optional :billing_cycle_configuration,
|
7319
7311
|
-> {
|
7320
7312
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk::BillingCycleConfiguration
|
@@ -7350,7 +7342,7 @@ module Orb
|
|
7350
7342
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
7351
7343
|
# If unspecified, a single invoice is produced per billing cycle.
|
7352
7344
|
#
|
7353
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk::InvoicingCycleConfiguration, nil]
|
7345
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk::InvoicingCycleConfiguration, nil]
|
7354
7346
|
optional :invoicing_cycle_configuration,
|
7355
7347
|
-> {
|
7356
7348
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk::InvoicingCycleConfiguration
|
@@ -7367,10 +7359,10 @@ module Orb
|
|
7367
7359
|
|
7368
7360
|
# @!method initialize(cadence:, cumulative_grouped_bulk_config:, currency:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :cumulative_grouped_bulk)
|
7369
7361
|
# Some parameter documentations has been truncated, see
|
7370
|
-
# {Orb::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk}
|
7371
|
-
# more details.
|
7362
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk}
|
7363
|
+
# for more details.
|
7372
7364
|
#
|
7373
|
-
# @param cadence [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk::Cadence] The cadence to bill for this price on.
|
7365
|
+
# @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk::Cadence] The cadence to bill for this price on.
|
7374
7366
|
#
|
7375
7367
|
# @param cumulative_grouped_bulk_config [Hash{Symbol=>Object}]
|
7376
7368
|
#
|
@@ -7384,7 +7376,7 @@ module Orb
|
|
7384
7376
|
#
|
7385
7377
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
7386
7378
|
#
|
7387
|
-
# @param billing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
7379
|
+
# @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
7388
7380
|
#
|
7389
7381
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
7390
7382
|
#
|
@@ -7394,7 +7386,7 @@ module Orb
|
|
7394
7386
|
#
|
7395
7387
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
7396
7388
|
#
|
7397
|
-
# @param invoicing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
7389
|
+
# @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
7398
7390
|
#
|
7399
7391
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
7400
7392
|
#
|
@@ -7402,7 +7394,7 @@ module Orb
|
|
7402
7394
|
|
7403
7395
|
# The cadence to bill for this price on.
|
7404
7396
|
#
|
7405
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk#cadence
|
7397
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk#cadence
|
7406
7398
|
module Cadence
|
7407
7399
|
extend Orb::Internal::Type::Enum
|
7408
7400
|
|
@@ -7417,7 +7409,7 @@ module Orb
|
|
7417
7409
|
# @return [Array<Symbol>]
|
7418
7410
|
end
|
7419
7411
|
|
7420
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk#billing_cycle_configuration
|
7412
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk#billing_cycle_configuration
|
7421
7413
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
7422
7414
|
# @!attribute duration
|
7423
7415
|
# The duration of the billing period.
|
@@ -7428,7 +7420,7 @@ module Orb
|
|
7428
7420
|
# @!attribute duration_unit
|
7429
7421
|
# The unit of billing period duration.
|
7430
7422
|
#
|
7431
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk::BillingCycleConfiguration::DurationUnit]
|
7423
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk::BillingCycleConfiguration::DurationUnit]
|
7432
7424
|
required :duration_unit,
|
7433
7425
|
enum: -> {
|
7434
7426
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk::BillingCycleConfiguration::DurationUnit
|
@@ -7440,11 +7432,11 @@ module Orb
|
|
7440
7432
|
#
|
7441
7433
|
# @param duration [Integer] The duration of the billing period.
|
7442
7434
|
#
|
7443
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
7435
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
7444
7436
|
|
7445
7437
|
# The unit of billing period duration.
|
7446
7438
|
#
|
7447
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk::BillingCycleConfiguration#duration_unit
|
7439
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk::BillingCycleConfiguration#duration_unit
|
7448
7440
|
module DurationUnit
|
7449
7441
|
extend Orb::Internal::Type::Enum
|
7450
7442
|
|
@@ -7456,7 +7448,7 @@ module Orb
|
|
7456
7448
|
end
|
7457
7449
|
end
|
7458
7450
|
|
7459
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk#invoicing_cycle_configuration
|
7451
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk#invoicing_cycle_configuration
|
7460
7452
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
7461
7453
|
# @!attribute duration
|
7462
7454
|
# The duration of the billing period.
|
@@ -7467,7 +7459,7 @@ module Orb
|
|
7467
7459
|
# @!attribute duration_unit
|
7468
7460
|
# The unit of billing period duration.
|
7469
7461
|
#
|
7470
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk::InvoicingCycleConfiguration::DurationUnit]
|
7462
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk::InvoicingCycleConfiguration::DurationUnit]
|
7471
7463
|
required :duration_unit,
|
7472
7464
|
enum: -> {
|
7473
7465
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk::InvoicingCycleConfiguration::DurationUnit
|
@@ -7479,11 +7471,11 @@ module Orb
|
|
7479
7471
|
#
|
7480
7472
|
# @param duration [Integer] The duration of the billing period.
|
7481
7473
|
#
|
7482
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
7474
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
7483
7475
|
|
7484
7476
|
# The unit of billing period duration.
|
7485
7477
|
#
|
7486
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk::InvoicingCycleConfiguration#duration_unit
|
7478
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk::InvoicingCycleConfiguration#duration_unit
|
7487
7479
|
module DurationUnit
|
7488
7480
|
extend Orb::Internal::Type::Enum
|
7489
7481
|
|
@@ -7497,42 +7489,7 @@ module Orb
|
|
7497
7489
|
end
|
7498
7490
|
|
7499
7491
|
# @!method self.variants
|
7500
|
-
# @return [Array(Orb::SubscriptionPriceIntervalsParams::Add::Price::Unit, Orb::SubscriptionPriceIntervalsParams::Add::Price::Package, Orb::SubscriptionPriceIntervalsParams::Add::Price::Matrix, Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation, Orb::SubscriptionPriceIntervalsParams::Add::Price::Tiered, Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredBps, Orb::SubscriptionPriceIntervalsParams::Add::Price::Bps, Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkBps, Orb::SubscriptionPriceIntervalsParams::Add::Price::Bulk, Orb::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount, Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage, Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered, Orb::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage, Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum, Orb::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation, Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum, Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent, Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration, Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration, Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation, Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum, Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum, Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName, Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration, Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage, Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing, Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing, Orb::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk)]
|
7501
|
-
|
7502
|
-
define_sorbet_constant!(:Variants) do
|
7503
|
-
T.type_alias do
|
7504
|
-
T.any(
|
7505
|
-
Orb::SubscriptionPriceIntervalsParams::Add::Price::Unit,
|
7506
|
-
Orb::SubscriptionPriceIntervalsParams::Add::Price::Package,
|
7507
|
-
Orb::SubscriptionPriceIntervalsParams::Add::Price::Matrix,
|
7508
|
-
Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation,
|
7509
|
-
Orb::SubscriptionPriceIntervalsParams::Add::Price::Tiered,
|
7510
|
-
Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredBps,
|
7511
|
-
Orb::SubscriptionPriceIntervalsParams::Add::Price::Bps,
|
7512
|
-
Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkBps,
|
7513
|
-
Orb::SubscriptionPriceIntervalsParams::Add::Price::Bulk,
|
7514
|
-
Orb::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount,
|
7515
|
-
Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage,
|
7516
|
-
Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered,
|
7517
|
-
Orb::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage,
|
7518
|
-
Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum,
|
7519
|
-
Orb::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation,
|
7520
|
-
Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum,
|
7521
|
-
Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent,
|
7522
|
-
Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration,
|
7523
|
-
Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration,
|
7524
|
-
Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation,
|
7525
|
-
Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum,
|
7526
|
-
Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum,
|
7527
|
-
Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName,
|
7528
|
-
Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration,
|
7529
|
-
Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage,
|
7530
|
-
Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing,
|
7531
|
-
Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing,
|
7532
|
-
Orb::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk
|
7533
|
-
)
|
7534
|
-
end
|
7535
|
-
end
|
7492
|
+
# @return [Array(Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Unit, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Package, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Matrix, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Tiered, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredBps, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bps, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkBps, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bulk, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk)]
|
7536
7493
|
end
|
7537
7494
|
end
|
7538
7495
|
|
@@ -7540,7 +7497,7 @@ module Orb
|
|
7540
7497
|
# @!attribute adjustment
|
7541
7498
|
# The definition of a new adjustment to create and add to the subscription.
|
7542
7499
|
#
|
7543
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::PercentageDiscount, Orb::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::UsageDiscount, Orb::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::AmountDiscount, Orb::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::Minimum, Orb::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::Maximum]
|
7500
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::PercentageDiscount, Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::UsageDiscount, Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::AmountDiscount, Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::Minimum, Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::Maximum]
|
7544
7501
|
required :adjustment, union: -> { Orb::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment }
|
7545
7502
|
|
7546
7503
|
# @!attribute start_date
|
@@ -7549,7 +7506,7 @@ module Orb
|
|
7549
7506
|
# invoice dates that overlap with this `start_date`. This `start_date` is treated
|
7550
7507
|
# as inclusive for in-advance prices, and exclusive for in-arrears prices.
|
7551
7508
|
#
|
7552
|
-
# @return [Time, Symbol, Orb::BillingCycleRelativeDate]
|
7509
|
+
# @return [Time, Symbol, Orb::Models::BillingCycleRelativeDate]
|
7553
7510
|
required :start_date, union: -> { Orb::SubscriptionPriceIntervalsParams::AddAdjustment::StartDate }
|
7554
7511
|
|
7555
7512
|
# @!attribute end_date
|
@@ -7558,24 +7515,24 @@ module Orb
|
|
7558
7515
|
# invoice dates that overlap with this `end_date`.This `end_date` is treated as
|
7559
7516
|
# exclusive for in-advance prices, and inclusive for in-arrears prices.
|
7560
7517
|
#
|
7561
|
-
# @return [Time, Symbol, Orb::BillingCycleRelativeDate, nil]
|
7518
|
+
# @return [Time, Symbol, Orb::Models::BillingCycleRelativeDate, nil]
|
7562
7519
|
optional :end_date,
|
7563
7520
|
union: -> { Orb::SubscriptionPriceIntervalsParams::AddAdjustment::EndDate },
|
7564
7521
|
nil?: true
|
7565
7522
|
|
7566
7523
|
# @!method initialize(adjustment:, start_date:, end_date: nil)
|
7567
7524
|
# Some parameter documentations has been truncated, see
|
7568
|
-
# {Orb::SubscriptionPriceIntervalsParams::AddAdjustment} for more details.
|
7525
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment} for more details.
|
7569
7526
|
#
|
7570
|
-
# @param adjustment [Orb::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::PercentageDiscount, Orb::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::UsageDiscount, Orb::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::AmountDiscount, Orb::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::Minimum, Orb::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::Maximum] The definition of a new adjustment to create and add to the subscription.
|
7527
|
+
# @param adjustment [Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::PercentageDiscount, Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::UsageDiscount, Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::AmountDiscount, Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::Minimum, Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::Maximum] The definition of a new adjustment to create and add to the subscription.
|
7571
7528
|
#
|
7572
|
-
# @param start_date [Time, Symbol, Orb::BillingCycleRelativeDate] The start date of the adjustment interval. This is the date that the adjustment
|
7529
|
+
# @param start_date [Time, Symbol, Orb::Models::BillingCycleRelativeDate] The start date of the adjustment interval. This is the date that the adjustment
|
7573
7530
|
#
|
7574
|
-
# @param end_date [Time, Symbol, Orb::BillingCycleRelativeDate, nil] The end date of the adjustment interval. This is the date that the adjustment wi
|
7531
|
+
# @param end_date [Time, Symbol, Orb::Models::BillingCycleRelativeDate, nil] The end date of the adjustment interval. This is the date that the adjustment wi
|
7575
7532
|
|
7576
7533
|
# The definition of a new adjustment to create and add to the subscription.
|
7577
7534
|
#
|
7578
|
-
# @see Orb::SubscriptionPriceIntervalsParams::AddAdjustment#adjustment
|
7535
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment#adjustment
|
7579
7536
|
module Adjustment
|
7580
7537
|
extend Orb::Internal::Type::Union
|
7581
7538
|
|
@@ -7620,7 +7577,7 @@ module Orb
|
|
7620
7577
|
|
7621
7578
|
# @!method initialize(applies_to_price_ids:, percentage_discount:, is_invoice_level: nil, adjustment_type: :percentage_discount)
|
7622
7579
|
# Some parameter documentations has been truncated, see
|
7623
|
-
# {Orb::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::PercentageDiscount}
|
7580
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::PercentageDiscount}
|
7624
7581
|
# for more details.
|
7625
7582
|
#
|
7626
7583
|
# @param applies_to_price_ids [Array<String>] The set of price IDs to which this adjustment applies.
|
@@ -7658,7 +7615,7 @@ module Orb
|
|
7658
7615
|
|
7659
7616
|
# @!method initialize(applies_to_price_ids:, usage_discount:, is_invoice_level: nil, adjustment_type: :usage_discount)
|
7660
7617
|
# Some parameter documentations has been truncated, see
|
7661
|
-
# {Orb::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::UsageDiscount}
|
7618
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::UsageDiscount}
|
7662
7619
|
# for more details.
|
7663
7620
|
#
|
7664
7621
|
# @param applies_to_price_ids [Array<String>] The set of price IDs to which this adjustment applies.
|
@@ -7696,7 +7653,7 @@ module Orb
|
|
7696
7653
|
|
7697
7654
|
# @!method initialize(amount_discount:, applies_to_price_ids:, is_invoice_level: nil, adjustment_type: :amount_discount)
|
7698
7655
|
# Some parameter documentations has been truncated, see
|
7699
|
-
# {Orb::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::AmountDiscount}
|
7656
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::AmountDiscount}
|
7700
7657
|
# for more details.
|
7701
7658
|
#
|
7702
7659
|
# @param amount_discount [String]
|
@@ -7740,8 +7697,8 @@ module Orb
|
|
7740
7697
|
|
7741
7698
|
# @!method initialize(applies_to_price_ids:, item_id:, minimum_amount:, is_invoice_level: nil, adjustment_type: :minimum)
|
7742
7699
|
# Some parameter documentations has been truncated, see
|
7743
|
-
# {Orb::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::Minimum}
|
7744
|
-
# more details.
|
7700
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::Minimum}
|
7701
|
+
# for more details.
|
7745
7702
|
#
|
7746
7703
|
# @param applies_to_price_ids [Array<String>] The set of price IDs to which this adjustment applies.
|
7747
7704
|
#
|
@@ -7780,8 +7737,8 @@ module Orb
|
|
7780
7737
|
|
7781
7738
|
# @!method initialize(applies_to_price_ids:, maximum_amount:, is_invoice_level: nil, adjustment_type: :maximum)
|
7782
7739
|
# Some parameter documentations has been truncated, see
|
7783
|
-
# {Orb::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::Maximum}
|
7784
|
-
# more details.
|
7740
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::Maximum}
|
7741
|
+
# for more details.
|
7785
7742
|
#
|
7786
7743
|
# @param applies_to_price_ids [Array<String>] The set of price IDs to which this adjustment applies.
|
7787
7744
|
#
|
@@ -7793,19 +7750,7 @@ module Orb
|
|
7793
7750
|
end
|
7794
7751
|
|
7795
7752
|
# @!method self.variants
|
7796
|
-
# @return [Array(Orb::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::PercentageDiscount, Orb::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::UsageDiscount, Orb::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::AmountDiscount, Orb::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::Minimum, Orb::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::Maximum)]
|
7797
|
-
|
7798
|
-
define_sorbet_constant!(:Variants) do
|
7799
|
-
T.type_alias do
|
7800
|
-
T.any(
|
7801
|
-
Orb::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::PercentageDiscount,
|
7802
|
-
Orb::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::UsageDiscount,
|
7803
|
-
Orb::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::AmountDiscount,
|
7804
|
-
Orb::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::Minimum,
|
7805
|
-
Orb::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::Maximum
|
7806
|
-
)
|
7807
|
-
end
|
7808
|
-
end
|
7753
|
+
# @return [Array(Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::PercentageDiscount, Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::UsageDiscount, Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::AmountDiscount, Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::Minimum, Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::Maximum)]
|
7809
7754
|
end
|
7810
7755
|
|
7811
7756
|
# The start date of the adjustment interval. This is the date that the adjustment
|
@@ -7813,7 +7758,7 @@ module Orb
|
|
7813
7758
|
# invoice dates that overlap with this `start_date`. This `start_date` is treated
|
7814
7759
|
# as inclusive for in-advance prices, and exclusive for in-arrears prices.
|
7815
7760
|
#
|
7816
|
-
# @see Orb::SubscriptionPriceIntervalsParams::AddAdjustment#start_date
|
7761
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment#start_date
|
7817
7762
|
module StartDate
|
7818
7763
|
extend Orb::Internal::Type::Union
|
7819
7764
|
|
@@ -7822,11 +7767,7 @@ module Orb
|
|
7822
7767
|
variant enum: -> { Orb::BillingCycleRelativeDate }
|
7823
7768
|
|
7824
7769
|
# @!method self.variants
|
7825
|
-
# @return [Array(Time, Symbol, Orb::BillingCycleRelativeDate)]
|
7826
|
-
|
7827
|
-
define_sorbet_constant!(:Variants) do
|
7828
|
-
T.type_alias { T.any(Time, Orb::BillingCycleRelativeDate::TaggedSymbol) }
|
7829
|
-
end
|
7770
|
+
# @return [Array(Time, Symbol, Orb::Models::BillingCycleRelativeDate)]
|
7830
7771
|
end
|
7831
7772
|
|
7832
7773
|
# The end date of the adjustment interval. This is the date that the adjustment
|
@@ -7834,7 +7775,7 @@ module Orb
|
|
7834
7775
|
# invoice dates that overlap with this `end_date`.This `end_date` is treated as
|
7835
7776
|
# exclusive for in-advance prices, and inclusive for in-arrears prices.
|
7836
7777
|
#
|
7837
|
-
# @see Orb::SubscriptionPriceIntervalsParams::AddAdjustment#end_date
|
7778
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment#end_date
|
7838
7779
|
module EndDate
|
7839
7780
|
extend Orb::Internal::Type::Union
|
7840
7781
|
|
@@ -7843,11 +7784,7 @@ module Orb
|
|
7843
7784
|
variant enum: -> { Orb::BillingCycleRelativeDate }
|
7844
7785
|
|
7845
7786
|
# @!method self.variants
|
7846
|
-
# @return [Array(Time, Symbol, Orb::BillingCycleRelativeDate)]
|
7847
|
-
|
7848
|
-
define_sorbet_constant!(:Variants) do
|
7849
|
-
T.type_alias { T.any(Time, Orb::BillingCycleRelativeDate::TaggedSymbol) }
|
7850
|
-
end
|
7787
|
+
# @return [Array(Time, Symbol, Orb::Models::BillingCycleRelativeDate)]
|
7851
7788
|
end
|
7852
7789
|
end
|
7853
7790
|
|
@@ -7870,7 +7807,7 @@ module Orb
|
|
7870
7807
|
# The updated end date of this price interval. If not specified, the start date
|
7871
7808
|
# will not be updated.
|
7872
7809
|
#
|
7873
|
-
# @return [Time, Symbol, Orb::BillingCycleRelativeDate, nil]
|
7810
|
+
# @return [Time, Symbol, Orb::Models::BillingCycleRelativeDate, nil]
|
7874
7811
|
optional :end_date, union: -> { Orb::SubscriptionPriceIntervalsParams::Edit::EndDate }, nil?: true
|
7875
7812
|
|
7876
7813
|
# @!attribute filter
|
@@ -7887,7 +7824,7 @@ module Orb
|
|
7887
7824
|
# that this list will overwrite all existing fixed fee quantity transitions on the
|
7888
7825
|
# price interval.
|
7889
7826
|
#
|
7890
|
-
# @return [Array<Orb::SubscriptionPriceIntervalsParams::Edit::FixedFeeQuantityTransition>, nil]
|
7827
|
+
# @return [Array<Orb::Models::SubscriptionPriceIntervalsParams::Edit::FixedFeeQuantityTransition>, nil]
|
7891
7828
|
optional :fixed_fee_quantity_transitions,
|
7892
7829
|
-> {
|
7893
7830
|
Orb::Internal::Type::ArrayOf[Orb::SubscriptionPriceIntervalsParams::Edit::FixedFeeQuantityTransition]
|
@@ -7898,7 +7835,7 @@ module Orb
|
|
7898
7835
|
# The updated start date of this price interval. If not specified, the start date
|
7899
7836
|
# will not be updated.
|
7900
7837
|
#
|
7901
|
-
# @return [Time, Symbol, Orb::BillingCycleRelativeDate, nil]
|
7838
|
+
# @return [Time, Symbol, Orb::Models::BillingCycleRelativeDate, nil]
|
7902
7839
|
optional :start_date, union: -> { Orb::SubscriptionPriceIntervalsParams::Edit::StartDate }
|
7903
7840
|
|
7904
7841
|
# @!attribute usage_customer_ids
|
@@ -7914,26 +7851,26 @@ module Orb
|
|
7914
7851
|
|
7915
7852
|
# @!method initialize(price_interval_id:, billing_cycle_day: nil, end_date: nil, filter: nil, fixed_fee_quantity_transitions: nil, start_date: nil, usage_customer_ids: nil)
|
7916
7853
|
# Some parameter documentations has been truncated, see
|
7917
|
-
# {Orb::SubscriptionPriceIntervalsParams::Edit} for more details.
|
7854
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Edit} for more details.
|
7918
7855
|
#
|
7919
7856
|
# @param price_interval_id [String] The id of the price interval to edit.
|
7920
7857
|
#
|
7921
7858
|
# @param billing_cycle_day [Integer, nil] The updated billing cycle day for this price interval. If not specified, the bil
|
7922
7859
|
#
|
7923
|
-
# @param end_date [Time, Symbol, Orb::BillingCycleRelativeDate, nil] The updated end date of this price interval. If not specified, the start date wi
|
7860
|
+
# @param end_date [Time, Symbol, Orb::Models::BillingCycleRelativeDate, nil] The updated end date of this price interval. If not specified, the start date wi
|
7924
7861
|
#
|
7925
7862
|
# @param filter [String, nil] An additional filter to apply to usage queries. This filter must be expressed as
|
7926
7863
|
#
|
7927
|
-
# @param fixed_fee_quantity_transitions [Array<Orb::SubscriptionPriceIntervalsParams::Edit::FixedFeeQuantityTransition>, nil] A list of fixed fee quantity transitions to use for this price interval. Note th
|
7864
|
+
# @param fixed_fee_quantity_transitions [Array<Orb::Models::SubscriptionPriceIntervalsParams::Edit::FixedFeeQuantityTransition>, nil] A list of fixed fee quantity transitions to use for this price interval. Note th
|
7928
7865
|
#
|
7929
|
-
# @param start_date [Time, Symbol, Orb::BillingCycleRelativeDate] The updated start date of this price interval. If not specified, the start date
|
7866
|
+
# @param start_date [Time, Symbol, Orb::Models::BillingCycleRelativeDate] The updated start date of this price interval. If not specified, the start date
|
7930
7867
|
#
|
7931
7868
|
# @param usage_customer_ids [Array<String>, nil] A list of customer IDs whose usage events will be aggregated and billed under th
|
7932
7869
|
|
7933
7870
|
# The updated end date of this price interval. If not specified, the start date
|
7934
7871
|
# will not be updated.
|
7935
7872
|
#
|
7936
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Edit#end_date
|
7873
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Edit#end_date
|
7937
7874
|
module EndDate
|
7938
7875
|
extend Orb::Internal::Type::Union
|
7939
7876
|
|
@@ -7942,11 +7879,7 @@ module Orb
|
|
7942
7879
|
variant enum: -> { Orb::BillingCycleRelativeDate }
|
7943
7880
|
|
7944
7881
|
# @!method self.variants
|
7945
|
-
# @return [Array(Time, Symbol, Orb::BillingCycleRelativeDate)]
|
7946
|
-
|
7947
|
-
define_sorbet_constant!(:Variants) do
|
7948
|
-
T.type_alias { T.any(Time, Orb::BillingCycleRelativeDate::TaggedSymbol) }
|
7949
|
-
end
|
7882
|
+
# @return [Array(Time, Symbol, Orb::Models::BillingCycleRelativeDate)]
|
7950
7883
|
end
|
7951
7884
|
|
7952
7885
|
class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel
|
@@ -7971,7 +7904,7 @@ module Orb
|
|
7971
7904
|
# The updated start date of this price interval. If not specified, the start date
|
7972
7905
|
# will not be updated.
|
7973
7906
|
#
|
7974
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Edit#start_date
|
7907
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Edit#start_date
|
7975
7908
|
module StartDate
|
7976
7909
|
extend Orb::Internal::Type::Union
|
7977
7910
|
|
@@ -7980,11 +7913,7 @@ module Orb
|
|
7980
7913
|
variant enum: -> { Orb::BillingCycleRelativeDate }
|
7981
7914
|
|
7982
7915
|
# @!method self.variants
|
7983
|
-
# @return [Array(Time, Symbol, Orb::BillingCycleRelativeDate)]
|
7984
|
-
|
7985
|
-
define_sorbet_constant!(:Variants) do
|
7986
|
-
T.type_alias { T.any(Time, Orb::BillingCycleRelativeDate::TaggedSymbol) }
|
7987
|
-
end
|
7916
|
+
# @return [Array(Time, Symbol, Orb::Models::BillingCycleRelativeDate)]
|
7988
7917
|
end
|
7989
7918
|
end
|
7990
7919
|
|
@@ -7999,7 +7928,7 @@ module Orb
|
|
7999
7928
|
# The updated end date of this adjustment interval. If not specified, the start
|
8000
7929
|
# date will not be updated.
|
8001
7930
|
#
|
8002
|
-
# @return [Time, Symbol, Orb::BillingCycleRelativeDate, nil]
|
7931
|
+
# @return [Time, Symbol, Orb::Models::BillingCycleRelativeDate, nil]
|
8003
7932
|
optional :end_date,
|
8004
7933
|
union: -> { Orb::SubscriptionPriceIntervalsParams::EditAdjustment::EndDate },
|
8005
7934
|
nil?: true
|
@@ -8008,23 +7937,24 @@ module Orb
|
|
8008
7937
|
# The updated start date of this adjustment interval. If not specified, the start
|
8009
7938
|
# date will not be updated.
|
8010
7939
|
#
|
8011
|
-
# @return [Time, Symbol, Orb::BillingCycleRelativeDate, nil]
|
7940
|
+
# @return [Time, Symbol, Orb::Models::BillingCycleRelativeDate, nil]
|
8012
7941
|
optional :start_date, union: -> { Orb::SubscriptionPriceIntervalsParams::EditAdjustment::StartDate }
|
8013
7942
|
|
8014
7943
|
# @!method initialize(adjustment_interval_id:, end_date: nil, start_date: nil)
|
8015
7944
|
# Some parameter documentations has been truncated, see
|
8016
|
-
# {Orb::SubscriptionPriceIntervalsParams::EditAdjustment} for more
|
7945
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::EditAdjustment} for more
|
7946
|
+
# details.
|
8017
7947
|
#
|
8018
7948
|
# @param adjustment_interval_id [String] The id of the adjustment interval to edit.
|
8019
7949
|
#
|
8020
|
-
# @param end_date [Time, Symbol, Orb::BillingCycleRelativeDate, nil] The updated end date of this adjustment interval. If not specified, the start da
|
7950
|
+
# @param end_date [Time, Symbol, Orb::Models::BillingCycleRelativeDate, nil] The updated end date of this adjustment interval. If not specified, the start da
|
8021
7951
|
#
|
8022
|
-
# @param start_date [Time, Symbol, Orb::BillingCycleRelativeDate] The updated start date of this adjustment interval. If not specified, the start
|
7952
|
+
# @param start_date [Time, Symbol, Orb::Models::BillingCycleRelativeDate] The updated start date of this adjustment interval. If not specified, the start
|
8023
7953
|
|
8024
7954
|
# The updated end date of this adjustment interval. If not specified, the start
|
8025
7955
|
# date will not be updated.
|
8026
7956
|
#
|
8027
|
-
# @see Orb::SubscriptionPriceIntervalsParams::EditAdjustment#end_date
|
7957
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::EditAdjustment#end_date
|
8028
7958
|
module EndDate
|
8029
7959
|
extend Orb::Internal::Type::Union
|
8030
7960
|
|
@@ -8033,17 +7963,13 @@ module Orb
|
|
8033
7963
|
variant enum: -> { Orb::BillingCycleRelativeDate }
|
8034
7964
|
|
8035
7965
|
# @!method self.variants
|
8036
|
-
# @return [Array(Time, Symbol, Orb::BillingCycleRelativeDate)]
|
8037
|
-
|
8038
|
-
define_sorbet_constant!(:Variants) do
|
8039
|
-
T.type_alias { T.any(Time, Orb::BillingCycleRelativeDate::TaggedSymbol) }
|
8040
|
-
end
|
7966
|
+
# @return [Array(Time, Symbol, Orb::Models::BillingCycleRelativeDate)]
|
8041
7967
|
end
|
8042
7968
|
|
8043
7969
|
# The updated start date of this adjustment interval. If not specified, the start
|
8044
7970
|
# date will not be updated.
|
8045
7971
|
#
|
8046
|
-
# @see Orb::SubscriptionPriceIntervalsParams::EditAdjustment#start_date
|
7972
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::EditAdjustment#start_date
|
8047
7973
|
module StartDate
|
8048
7974
|
extend Orb::Internal::Type::Union
|
8049
7975
|
|
@@ -8052,11 +7978,7 @@ module Orb
|
|
8052
7978
|
variant enum: -> { Orb::BillingCycleRelativeDate }
|
8053
7979
|
|
8054
7980
|
# @!method self.variants
|
8055
|
-
# @return [Array(Time, Symbol, Orb::BillingCycleRelativeDate)]
|
8056
|
-
|
8057
|
-
define_sorbet_constant!(:Variants) do
|
8058
|
-
T.type_alias { T.any(Time, Orb::BillingCycleRelativeDate::TaggedSymbol) }
|
8059
|
-
end
|
7981
|
+
# @return [Array(Time, Symbol, Orb::Models::BillingCycleRelativeDate)]
|
8060
7982
|
end
|
8061
7983
|
end
|
8062
7984
|
end
|