orb-billing 0.3.1 → 0.3.2
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 +14 -0
- data/README.md +3 -3
- data/lib/orb/file_part.rb +2 -2
- data/lib/orb/internal/type/enum.rb +3 -3
- data/lib/orb/internal/type/request_parameters.rb +4 -4
- data/lib/orb/internal/type/union.rb +4 -4
- data/lib/orb/internal/util.rb +1 -1
- data/lib/orb/models/alert.rb +29 -32
- data/lib/orb/models/alert_create_for_customer_params.rb +7 -8
- data/lib/orb/models/alert_create_for_external_customer_params.rb +7 -8
- data/lib/orb/models/alert_create_for_subscription_params.rb +7 -8
- data/lib/orb/models/alert_list_params.rb +0 -1
- data/lib/orb/models/alert_update_params.rb +4 -5
- data/lib/orb/models/amount_discount.rb +6 -7
- data/lib/orb/models/billable_metric.rb +9 -11
- data/lib/orb/models/coupon.rb +9 -12
- data/lib/orb/models/coupon_create_params.rb +6 -8
- data/lib/orb/models/coupon_list_params.rb +0 -2
- data/lib/orb/models/coupons/subscription_list_params.rb +0 -1
- data/lib/orb/models/credit_note.rb +48 -46
- data/lib/orb/models/credit_note_create_params.rb +6 -6
- data/lib/orb/models/credit_note_list_params.rb +0 -1
- data/lib/orb/models/customer.rb +54 -61
- data/lib/orb/models/customer_create_params.rb +41 -53
- data/lib/orb/models/customer_list_params.rb +0 -1
- data/lib/orb/models/customer_update_by_external_id_params.rb +41 -53
- data/lib/orb/models/customer_update_params.rb +41 -51
- data/lib/orb/models/customers/balance_transaction_create_params.rb +3 -3
- data/lib/orb/models/customers/balance_transaction_create_response.rb +0 -2
- data/lib/orb/models/customers/balance_transaction_list_params.rb +0 -1
- data/lib/orb/models/customers/balance_transaction_list_response.rb +0 -2
- data/lib/orb/models/customers/cost_list_by_external_id_params.rb +3 -4
- data/lib/orb/models/customers/cost_list_by_external_id_response.rb +3 -3
- data/lib/orb/models/customers/cost_list_params.rb +3 -4
- data/lib/orb/models/customers/cost_list_response.rb +3 -3
- data/lib/orb/models/customers/credit_list_by_external_id_params.rb +0 -2
- data/lib/orb/models/customers/credit_list_params.rb +0 -2
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +12 -21
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +0 -7
- data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +11 -22
- data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +0 -7
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +6 -7
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +0 -7
- data/lib/orb/models/customers/credits/ledger_list_params.rb +8 -9
- data/lib/orb/models/customers/credits/ledger_list_response.rb +0 -7
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +10 -15
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb +0 -6
- data/lib/orb/models/customers/credits/top_up_create_params.rb +7 -15
- data/lib/orb/models/customers/credits/top_up_create_response.rb +0 -6
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rb +0 -1
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb +0 -6
- data/lib/orb/models/customers/credits/top_up_list_params.rb +0 -1
- data/lib/orb/models/customers/credits/top_up_list_response.rb +0 -6
- data/lib/orb/models/dimensional_price_group.rb +1 -3
- data/lib/orb/models/dimensional_price_group_create_params.rb +0 -1
- data/lib/orb/models/dimensional_price_group_list_params.rb +0 -1
- data/lib/orb/models/dimensional_price_groups.rb +6 -6
- data/lib/orb/models/discount.rb +5 -5
- data/lib/orb/models/evaluate_price_group.rb +1 -1
- data/lib/orb/models/event_ingest_params.rb +4 -9
- data/lib/orb/models/event_ingest_response.rb +0 -3
- data/lib/orb/models/event_search_params.rb +0 -3
- data/lib/orb/models/event_search_response.rb +0 -4
- data/lib/orb/models/event_update_params.rb +0 -3
- data/lib/orb/models/events/backfill_close_response.rb +0 -4
- data/lib/orb/models/events/backfill_create_params.rb +0 -7
- data/lib/orb/models/events/backfill_create_response.rb +0 -4
- data/lib/orb/models/events/backfill_fetch_response.rb +0 -4
- data/lib/orb/models/events/backfill_list_params.rb +0 -1
- data/lib/orb/models/events/backfill_list_response.rb +0 -4
- data/lib/orb/models/events/backfill_revert_response.rb +0 -4
- data/lib/orb/models/events/event_volumes.rb +3 -3
- data/lib/orb/models/events/volume_list_params.rb +0 -3
- data/lib/orb/models/invoice.rb +157 -202
- data/lib/orb/models/invoice_create_params.rb +14 -21
- data/lib/orb/models/invoice_fetch_upcoming_response.rb +9 -54
- data/lib/orb/models/invoice_issue_params.rb +0 -1
- data/lib/orb/models/invoice_level_discount.rb +4 -4
- data/lib/orb/models/invoice_line_item_create_params.rb +0 -1
- data/lib/orb/models/invoice_line_item_create_response.rb +6 -26
- data/lib/orb/models/invoice_list_params.rb +6 -10
- data/lib/orb/models/invoice_update_params.rb +0 -1
- data/lib/orb/models/item.rb +7 -8
- data/lib/orb/models/item_list_params.rb +0 -1
- data/lib/orb/models/item_update_params.rb +7 -7
- data/lib/orb/models/metric_create_params.rb +0 -1
- data/lib/orb/models/metric_list_params.rb +0 -1
- data/lib/orb/models/metric_update_params.rb +0 -1
- data/lib/orb/models/percentage_discount.rb +6 -8
- data/lib/orb/models/plan.rb +78 -103
- data/lib/orb/models/plan_create_params.rb +727 -800
- data/lib/orb/models/plan_list_params.rb +3 -4
- data/lib/orb/models/plan_update_params.rb +0 -2
- data/lib/orb/models/plans/external_plan_id_update_params.rb +0 -2
- data/lib/orb/models/price.rb +1671 -1724
- data/lib/orb/models/price_create_params.rb +75 -84
- data/lib/orb/models/price_evaluate_params.rb +0 -2
- data/lib/orb/models/price_evaluate_response.rb +3 -3
- data/lib/orb/models/price_list_params.rb +0 -1
- data/lib/orb/models/price_update_params.rb +0 -1
- data/lib/orb/models/prices/external_price_id_update_params.rb +0 -1
- data/lib/orb/models/subscription.rb +86 -122
- data/lib/orb/models/subscription_cancel_params.rb +3 -5
- data/lib/orb/models/subscription_cancel_response.rb +21 -57
- data/lib/orb/models/subscription_change_apply_response.rb +21 -58
- data/lib/orb/models/subscription_change_cancel_response.rb +21 -58
- data/lib/orb/models/subscription_change_retrieve_response.rb +21 -58
- data/lib/orb/models/subscription_create_params.rb +1865 -1815
- data/lib/orb/models/subscription_create_response.rb +21 -57
- data/lib/orb/models/subscription_fetch_costs_params.rb +3 -4
- data/lib/orb/models/subscription_fetch_costs_response.rb +3 -3
- data/lib/orb/models/subscription_fetch_schedule_params.rb +0 -1
- data/lib/orb/models/subscription_fetch_schedule_response.rb +0 -1
- data/lib/orb/models/subscription_fetch_usage_params.rb +6 -8
- data/lib/orb/models/subscription_list_params.rb +3 -4
- data/lib/orb/models/subscription_price_intervals_params.rb +1105 -1017
- data/lib/orb/models/subscription_price_intervals_response.rb +21 -57
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +1906 -1791
- data/lib/orb/models/subscription_schedule_plan_change_response.rb +21 -57
- data/lib/orb/models/subscription_trigger_phase_params.rb +0 -2
- data/lib/orb/models/subscription_trigger_phase_response.rb +21 -57
- data/lib/orb/models/subscription_unschedule_cancellation_response.rb +21 -57
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +21 -57
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +21 -57
- data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +3 -6
- data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +21 -57
- data/lib/orb/models/subscription_update_params.rb +0 -5
- data/lib/orb/models/subscription_update_trial_params.rb +4 -6
- data/lib/orb/models/subscription_update_trial_response.rb +21 -57
- data/lib/orb/models/subscription_usage.rb +46 -39
- data/lib/orb/models/subscriptions.rb +6 -6
- data/lib/orb/models/trial_discount.rb +6 -7
- data/lib/orb/models/usage_discount.rb +6 -8
- data/lib/orb/resources/alerts.rb +30 -31
- data/lib/orb/resources/coupons/subscriptions.rb +3 -4
- data/lib/orb/resources/coupons.rb +11 -21
- data/lib/orb/resources/credit_notes.rb +10 -11
- data/lib/orb/resources/customers/balance_transactions.rb +3 -4
- data/lib/orb/resources/customers/costs.rb +4 -6
- data/lib/orb/resources/customers/credits/ledger.rb +14 -33
- data/lib/orb/resources/customers/credits/top_ups.rb +10 -20
- data/lib/orb/resources/customers/credits.rb +2 -6
- data/lib/orb/resources/customers.rb +40 -67
- data/lib/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rb +2 -2
- data/lib/orb/resources/dimensional_price_groups.rb +8 -10
- data/lib/orb/resources/events/backfills.rb +2 -10
- data/lib/orb/resources/events/volume.rb +3 -6
- data/lib/orb/resources/events.rb +4 -12
- data/lib/orb/resources/invoice_line_items.rb +1 -2
- data/lib/orb/resources/invoices.rb +26 -43
- data/lib/orb/resources/items.rb +12 -13
- data/lib/orb/resources/metrics.rb +11 -14
- data/lib/orb/resources/plans/external_plan_id.rb +5 -7
- data/lib/orb/resources/plans.rb +14 -23
- data/lib/orb/resources/prices/external_price_id.rb +5 -6
- data/lib/orb/resources/prices.rb +25 -35
- data/lib/orb/resources/subscription_changes.rb +1 -1
- data/lib/orb/resources/subscriptions.rb +49 -107
- data/lib/orb/version.rb +1 -1
- data/lib/orb.rb +1 -0
- data/rbi/orb/client.rbi +5 -4
- data/rbi/orb/errors.rbi +59 -28
- data/rbi/orb/file_part.rbi +9 -6
- data/rbi/orb/internal/page.rbi +19 -6
- data/rbi/orb/internal/transport/base_client.rbi +131 -73
- data/rbi/orb/internal/transport/pooled_net_requester.rbi +25 -12
- data/rbi/orb/internal/type/array_of.rbi +42 -34
- data/rbi/orb/internal/type/base_model.rbi +124 -65
- data/rbi/orb/internal/type/base_page.rbi +11 -7
- data/rbi/orb/internal/type/boolean.rbi +16 -10
- data/rbi/orb/internal/type/converter.rbi +66 -31
- data/rbi/orb/internal/type/enum.rbi +27 -15
- data/rbi/orb/internal/type/file_input.rbi +12 -10
- data/rbi/orb/internal/type/hash_of.rbi +34 -24
- data/rbi/orb/internal/type/request_parameters.rbi +12 -4
- data/rbi/orb/internal/type/union.rbi +60 -25
- data/rbi/orb/internal/type/unknown.rbi +20 -12
- data/rbi/orb/internal/util.rbi +210 -89
- data/rbi/orb/models/alert.rbi +107 -70
- data/rbi/orb/models/alert_create_for_customer_params.rbi +60 -27
- data/rbi/orb/models/alert_create_for_external_customer_params.rbi +68 -29
- data/rbi/orb/models/alert_create_for_subscription_params.rbi +53 -26
- data/rbi/orb/models/alert_disable_params.rbi +17 -6
- data/rbi/orb/models/alert_enable_params.rbi +17 -6
- data/rbi/orb/models/alert_list_params.rbi +23 -20
- data/rbi/orb/models/alert_retrieve_params.rbi +10 -4
- data/rbi/orb/models/alert_update_params.rbi +25 -14
- data/rbi/orb/models/amount_discount.rbi +28 -19
- data/rbi/orb/models/billable_metric.rbi +33 -26
- data/rbi/orb/models/billing_cycle_relative_date.rbi +11 -5
- data/rbi/orb/models/coupon.rbi +28 -20
- data/rbi/orb/models/coupon_archive_params.rbi +10 -4
- data/rbi/orb/models/coupon_create_params.rbi +72 -38
- data/rbi/orb/models/coupon_fetch_params.rbi +10 -4
- data/rbi/orb/models/coupon_list_params.rbi +18 -15
- data/rbi/orb/models/coupons/subscription_list_params.rbi +16 -6
- data/rbi/orb/models/credit_note.rbi +293 -158
- data/rbi/orb/models/credit_note_create_params.rbi +58 -29
- data/rbi/orb/models/credit_note_fetch_params.rbi +10 -4
- data/rbi/orb/models/credit_note_list_params.rbi +20 -17
- data/rbi/orb/models/customer.rbi +430 -329
- data/rbi/orb/models/customer_create_params.rbi +662 -325
- data/rbi/orb/models/customer_delete_params.rbi +10 -4
- data/rbi/orb/models/customer_fetch_by_external_id_params.rbi +10 -4
- data/rbi/orb/models/customer_fetch_params.rbi +10 -4
- data/rbi/orb/models/customer_list_params.rbi +20 -17
- data/rbi/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi +10 -4
- data/rbi/orb/models/customer_sync_payment_methods_from_gateway_params.rbi +10 -4
- data/rbi/orb/models/customer_update_by_external_id_params.rbi +1136 -336
- data/rbi/orb/models/customer_update_params.rbi +661 -324
- data/rbi/orb/models/customers/balance_transaction_create_params.rbi +50 -21
- data/rbi/orb/models/customers/balance_transaction_create_response.rbi +154 -61
- data/rbi/orb/models/customers/balance_transaction_list_params.rbi +20 -17
- data/rbi/orb/models/customers/balance_transaction_list_response.rbi +164 -59
- data/rbi/orb/models/customers/cost_list_by_external_id_params.rbi +56 -22
- data/rbi/orb/models/customers/cost_list_by_external_id_response.rbi +162 -124
- data/rbi/orb/models/customers/cost_list_params.rbi +45 -22
- data/rbi/orb/models/customers/cost_list_response.rbi +154 -123
- data/rbi/orb/models/customers/credit_list_by_external_id_params.rbi +18 -15
- data/rbi/orb/models/customers/credit_list_by_external_id_response.rbi +48 -22
- data/rbi/orb/models/customers/credit_list_params.rbi +18 -15
- data/rbi/orb/models/customers/credit_list_response.rbi +44 -21
- data/rbi/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +106 -68
- data/rbi/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi +643 -434
- data/rbi/orb/models/customers/credits/ledger_create_entry_params.rbi +117 -59
- data/rbi/orb/models/customers/credits/ledger_create_entry_response.rbi +700 -425
- data/rbi/orb/models/customers/credits/ledger_list_by_external_id_params.rbi +102 -44
- data/rbi/orb/models/customers/credits/ledger_list_by_external_id_response.rbi +681 -432
- data/rbi/orb/models/customers/credits/ledger_list_params.rbi +123 -40
- data/rbi/orb/models/customers/credits/ledger_list_response.rbi +735 -389
- data/rbi/orb/models/customers/credits/top_up_create_by_external_id_params.rbi +74 -53
- data/rbi/orb/models/customers/credits/top_up_create_by_external_id_response.rbi +65 -48
- data/rbi/orb/models/customers/credits/top_up_create_params.rbi +84 -45
- data/rbi/orb/models/customers/credits/top_up_create_response.rbi +83 -43
- data/rbi/orb/models/customers/credits/top_up_delete_by_external_id_params.rbi +16 -6
- data/rbi/orb/models/customers/credits/top_up_delete_params.rbi +15 -5
- data/rbi/orb/models/customers/credits/top_up_list_by_external_id_params.rbi +9 -5
- data/rbi/orb/models/customers/credits/top_up_list_by_external_id_response.rbi +70 -49
- data/rbi/orb/models/customers/credits/top_up_list_params.rbi +9 -5
- data/rbi/orb/models/customers/credits/top_up_list_response.rbi +84 -43
- data/rbi/orb/models/dimensional_price_group.rbi +18 -15
- data/rbi/orb/models/dimensional_price_group_create_params.rbi +19 -16
- data/rbi/orb/models/dimensional_price_group_list_params.rbi +16 -6
- data/rbi/orb/models/dimensional_price_group_retrieve_params.rbi +10 -4
- data/rbi/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi +10 -9
- data/rbi/orb/models/dimensional_price_groups.rbi +18 -13
- data/rbi/orb/models/discount.rbi +11 -5
- data/rbi/orb/models/evaluate_price_group.rbi +28 -12
- data/rbi/orb/models/event_deprecate_params.rbi +10 -4
- data/rbi/orb/models/event_deprecate_response.rbi +8 -3
- data/rbi/orb/models/event_ingest_params.rbi +37 -31
- data/rbi/orb/models/event_ingest_response.rbi +63 -23
- data/rbi/orb/models/event_search_params.rbi +17 -14
- data/rbi/orb/models/event_search_response.rbi +33 -21
- data/rbi/orb/models/event_update_params.rbi +19 -16
- data/rbi/orb/models/event_update_response.rbi +8 -3
- data/rbi/orb/models/events/backfill_close_params.rbi +10 -9
- data/rbi/orb/models/events/backfill_close_response.rbi +64 -29
- data/rbi/orb/models/events/backfill_create_params.rbi +21 -18
- data/rbi/orb/models/events/backfill_create_response.rbi +63 -29
- data/rbi/orb/models/events/backfill_fetch_params.rbi +10 -9
- data/rbi/orb/models/events/backfill_fetch_response.rbi +64 -29
- data/rbi/orb/models/events/backfill_list_params.rbi +16 -6
- data/rbi/orb/models/events/backfill_list_response.rbi +62 -28
- data/rbi/orb/models/events/backfill_revert_params.rbi +10 -9
- data/rbi/orb/models/events/backfill_revert_response.rbi +63 -29
- data/rbi/orb/models/events/event_volumes.rbi +32 -10
- data/rbi/orb/models/events/volume_list_params.rbi +18 -15
- data/rbi/orb/models/invoice.rbi +1286 -805
- data/rbi/orb/models/invoice_create_params.rbi +97 -69
- data/rbi/orb/models/invoice_fetch_params.rbi +10 -4
- data/rbi/orb/models/invoice_fetch_upcoming_params.rbi +15 -5
- data/rbi/orb/models/invoice_fetch_upcoming_response.rbi +1991 -861
- data/rbi/orb/models/invoice_issue_params.rbi +16 -5
- data/rbi/orb/models/invoice_level_discount.rbi +11 -4
- data/rbi/orb/models/invoice_line_item_create_params.rbi +20 -17
- data/rbi/orb/models/invoice_line_item_create_response.rbi +573 -376
- data/rbi/orb/models/invoice_list_params.rbi +67 -47
- data/rbi/orb/models/invoice_mark_paid_params.rbi +17 -14
- data/rbi/orb/models/invoice_pay_params.rbi +10 -4
- data/rbi/orb/models/invoice_update_params.rbi +15 -10
- data/rbi/orb/models/invoice_void_params.rbi +10 -4
- data/rbi/orb/models/item.rbi +87 -39
- data/rbi/orb/models/item_create_params.rbi +14 -5
- data/rbi/orb/models/item_fetch_params.rbi +10 -4
- data/rbi/orb/models/item_list_params.rbi +16 -6
- data/rbi/orb/models/item_update_params.rbi +79 -39
- data/rbi/orb/models/metric_create_params.rbi +19 -16
- data/rbi/orb/models/metric_fetch_params.rbi +10 -4
- data/rbi/orb/models/metric_list_params.rbi +20 -17
- data/rbi/orb/models/metric_update_params.rbi +15 -10
- data/rbi/orb/models/pagination_metadata.rbi +16 -4
- data/rbi/orb/models/percentage_discount.rbi +32 -19
- data/rbi/orb/models/plan.rbi +496 -365
- data/rbi/orb/models/plan_create_params.rbi +4785 -2875
- data/rbi/orb/models/plan_fetch_params.rbi +10 -4
- data/rbi/orb/models/plan_list_params.rbi +34 -27
- data/rbi/orb/models/plan_update_params.rbi +16 -13
- data/rbi/orb/models/plans/external_plan_id_fetch_params.rbi +10 -9
- data/rbi/orb/models/plans/external_plan_id_update_params.rbi +16 -13
- data/rbi/orb/models/price.rbi +9969 -5024
- data/rbi/orb/models/price_create_params.rbi +501 -245
- data/rbi/orb/models/price_evaluate_params.rbi +20 -17
- data/rbi/orb/models/price_evaluate_response.rbi +11 -6
- data/rbi/orb/models/price_fetch_params.rbi +10 -4
- data/rbi/orb/models/price_list_params.rbi +16 -6
- data/rbi/orb/models/price_update_params.rbi +15 -10
- data/rbi/orb/models/prices/external_price_id_fetch_params.rbi +10 -9
- data/rbi/orb/models/prices/external_price_id_update_params.rbi +15 -10
- data/rbi/orb/models/subscription.rbi +578 -420
- data/rbi/orb/models/subscription_cancel_params.rbi +44 -22
- data/rbi/orb/models/subscription_cancel_response.rbi +700 -438
- data/rbi/orb/models/subscription_change_apply_params.rbi +16 -13
- data/rbi/orb/models/subscription_change_apply_response.rbi +784 -504
- data/rbi/orb/models/subscription_change_cancel_params.rbi +10 -4
- data/rbi/orb/models/subscription_change_cancel_response.rbi +783 -514
- data/rbi/orb/models/subscription_change_retrieve_params.rbi +10 -4
- data/rbi/orb/models/subscription_change_retrieve_response.rbi +782 -524
- data/rbi/orb/models/subscription_create_params.rbi +9021 -6730
- data/rbi/orb/models/subscription_create_response.rbi +700 -438
- data/rbi/orb/models/subscription_fetch_costs_params.rbi +47 -22
- data/rbi/orb/models/subscription_fetch_costs_response.rbi +154 -123
- data/rbi/orb/models/subscription_fetch_params.rbi +10 -4
- data/rbi/orb/models/subscription_fetch_schedule_params.rbi +20 -17
- data/rbi/orb/models/subscription_fetch_schedule_response.rbi +33 -19
- data/rbi/orb/models/subscription_fetch_usage_params.rbi +81 -34
- data/rbi/orb/models/subscription_list_params.rbi +39 -28
- data/rbi/orb/models/subscription_price_intervals_params.rbi +5181 -3822
- data/rbi/orb/models/subscription_price_intervals_response.rbi +720 -453
- data/rbi/orb/models/subscription_schedule_plan_change_params.rbi +8602 -6910
- data/rbi/orb/models/subscription_schedule_plan_change_response.rbi +718 -467
- data/rbi/orb/models/subscription_trigger_phase_params.rbi +16 -13
- data/rbi/orb/models/subscription_trigger_phase_response.rbi +712 -448
- data/rbi/orb/models/subscription_unschedule_cancellation_params.rbi +10 -4
- data/rbi/orb/models/subscription_unschedule_cancellation_response.rbi +719 -467
- data/rbi/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +16 -5
- data/rbi/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +693 -502
- data/rbi/orb/models/subscription_unschedule_pending_plan_changes_params.rbi +10 -4
- data/rbi/orb/models/subscription_unschedule_pending_plan_changes_response.rbi +708 -497
- data/rbi/orb/models/subscription_update_fixed_fee_quantity_params.rbi +57 -26
- data/rbi/orb/models/subscription_update_fixed_fee_quantity_response.rbi +719 -467
- data/rbi/orb/models/subscription_update_params.rbi +19 -16
- data/rbi/orb/models/subscription_update_trial_params.rbi +57 -19
- data/rbi/orb/models/subscription_update_trial_response.rbi +712 -447
- data/rbi/orb/models/subscription_usage.rbi +271 -121
- data/rbi/orb/models/subscriptions.rbi +18 -11
- data/rbi/orb/models/top_level_ping_params.rbi +10 -4
- data/rbi/orb/models/top_level_ping_response.rbi +7 -3
- data/rbi/orb/models/trial_discount.rbi +29 -20
- data/rbi/orb/models/usage_discount.rbi +28 -19
- data/rbi/orb/models.rbi +22 -11
- data/rbi/orb/request_options.rbi +12 -6
- data/rbi/orb/resources/alerts.rbi +61 -40
- data/rbi/orb/resources/coupons/subscriptions.rbi +7 -5
- data/rbi/orb/resources/coupons.rbi +33 -18
- data/rbi/orb/resources/credit_notes.rbi +22 -13
- data/rbi/orb/resources/customers/balance_transactions.rbi +17 -9
- data/rbi/orb/resources/customers/costs.rbi +18 -11
- data/rbi/orb/resources/customers/credits/ledger.rbi +98 -74
- data/rbi/orb/resources/customers/credits/top_ups.rbi +61 -25
- data/rbi/orb/resources/customers/credits.rbi +16 -7
- data/rbi/orb/resources/customers.rbi +137 -72
- data/rbi/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rbi +8 -4
- data/rbi/orb/resources/dimensional_price_groups.rbi +26 -12
- data/rbi/orb/resources/events/backfills.rbi +35 -17
- data/rbi/orb/resources/events/volume.rbi +7 -5
- data/rbi/orb/resources/events.rbi +26 -16
- data/rbi/orb/resources/invoice_line_items.rbi +7 -5
- data/rbi/orb/resources/invoices.rbi +72 -41
- data/rbi/orb/resources/items.rbi +40 -13
- data/rbi/orb/resources/metrics.rbi +25 -15
- data/rbi/orb/resources/plans/external_plan_id.rbi +15 -7
- data/rbi/orb/resources/plans.rbi +57 -47
- data/rbi/orb/resources/prices/external_price_id.rbi +73 -68
- data/rbi/orb/resources/prices.rbi +176 -156
- data/rbi/orb/resources/subscription_changes.rbi +19 -11
- data/rbi/orb/resources/subscriptions.rbi +200 -114
- data/rbi/orb/resources/top_level.rbi +9 -3
- data/sig/orb/internal/page.rbs +0 -2
- data/sig/orb/internal/type/request_parameters.rbs +3 -1
- data/sig/orb/models/alert.rbs +19 -31
- data/sig/orb/models/alert_create_for_customer_params.rbs +3 -7
- data/sig/orb/models/alert_create_for_external_customer_params.rbs +3 -7
- data/sig/orb/models/alert_create_for_subscription_params.rbs +3 -7
- data/sig/orb/models/alert_disable_params.rbs +0 -2
- data/sig/orb/models/alert_enable_params.rbs +0 -2
- data/sig/orb/models/alert_list_params.rbs +0 -2
- data/sig/orb/models/alert_retrieve_params.rbs +0 -2
- data/sig/orb/models/alert_update_params.rbs +3 -7
- data/sig/orb/models/amount_discount.rbs +4 -6
- data/sig/orb/models/billable_metric.rbs +7 -9
- data/sig/orb/models/coupon.rbs +5 -8
- data/sig/orb/models/coupon_archive_params.rbs +0 -2
- data/sig/orb/models/coupon_create_params.rbs +3 -9
- data/sig/orb/models/coupon_fetch_params.rbs +0 -2
- data/sig/orb/models/coupon_list_params.rbs +0 -2
- data/sig/orb/models/coupons/subscription_list_params.rbs +0 -2
- data/sig/orb/models/credit_note.rbs +48 -66
- data/sig/orb/models/credit_note_create_params.rbs +3 -7
- data/sig/orb/models/credit_note_fetch_params.rbs +0 -2
- data/sig/orb/models/credit_note_list_params.rbs +0 -2
- data/sig/orb/models/customer.rbs +43 -63
- data/sig/orb/models/customer_create_params.rbs +32 -52
- data/sig/orb/models/customer_delete_params.rbs +0 -2
- data/sig/orb/models/customer_fetch_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customer_fetch_params.rbs +0 -2
- data/sig/orb/models/customer_list_params.rbs +0 -2
- data/sig/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbs +0 -2
- data/sig/orb/models/customer_sync_payment_methods_from_gateway_params.rbs +0 -2
- data/sig/orb/models/customer_update_by_external_id_params.rbs +32 -52
- data/sig/orb/models/customer_update_params.rbs +32 -52
- data/sig/orb/models/customers/balance_transaction_create_params.rbs +0 -2
- data/sig/orb/models/customers/balance_transaction_create_response.rbs +0 -6
- data/sig/orb/models/customers/balance_transaction_list_params.rbs +0 -2
- data/sig/orb/models/customers/balance_transaction_list_response.rbs +0 -6
- data/sig/orb/models/customers/cost_list_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customers/cost_list_by_external_id_response.rbs +0 -6
- data/sig/orb/models/customers/cost_list_params.rbs +0 -2
- data/sig/orb/models/customers/cost_list_response.rbs +0 -6
- data/sig/orb/models/customers/credit_list_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customers/credit_list_by_external_id_response.rbs +0 -2
- data/sig/orb/models/customers/credit_list_params.rbs +0 -2
- data/sig/orb/models/customers/credit_list_response.rbs +0 -2
- data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbs +3 -7
- data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbs +1 -43
- data/sig/orb/models/customers/credits/ledger_create_entry_params.rbs +3 -7
- data/sig/orb/models/customers/credits/ledger_create_entry_response.rbs +1 -43
- data/sig/orb/models/customers/credits/ledger_list_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customers/credits/ledger_list_by_external_id_response.rbs +1 -43
- data/sig/orb/models/customers/credits/ledger_list_params.rbs +0 -2
- data/sig/orb/models/customers/credits/ledger_list_response.rbs +1 -43
- data/sig/orb/models/customers/credits/top_up_create_by_external_id_params.rbs +3 -7
- data/sig/orb/models/customers/credits/top_up_create_by_external_id_response.rbs +0 -4
- data/sig/orb/models/customers/credits/top_up_create_params.rbs +3 -7
- data/sig/orb/models/customers/credits/top_up_create_response.rbs +0 -4
- data/sig/orb/models/customers/credits/top_up_delete_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customers/credits/top_up_delete_params.rbs +0 -2
- data/sig/orb/models/customers/credits/top_up_list_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customers/credits/top_up_list_by_external_id_response.rbs +0 -4
- data/sig/orb/models/customers/credits/top_up_list_params.rbs +0 -2
- data/sig/orb/models/customers/credits/top_up_list_response.rbs +0 -4
- data/sig/orb/models/dimensional_price_group.rbs +0 -2
- data/sig/orb/models/dimensional_price_group_create_params.rbs +0 -2
- data/sig/orb/models/dimensional_price_group_list_params.rbs +0 -2
- data/sig/orb/models/dimensional_price_group_retrieve_params.rbs +0 -2
- data/sig/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbs +0 -2
- data/sig/orb/models/dimensional_price_groups.rbs +6 -8
- data/sig/orb/models/discount.rbs +5 -5
- data/sig/orb/models/evaluate_price_group.rbs +4 -6
- data/sig/orb/models/event_deprecate_params.rbs +0 -2
- data/sig/orb/models/event_deprecate_response.rbs +0 -2
- data/sig/orb/models/event_ingest_params.rbs +3 -7
- data/sig/orb/models/event_ingest_response.rbs +0 -6
- data/sig/orb/models/event_search_params.rbs +0 -2
- data/sig/orb/models/event_search_response.rbs +0 -4
- data/sig/orb/models/event_update_params.rbs +0 -2
- data/sig/orb/models/event_update_response.rbs +0 -2
- data/sig/orb/models/events/backfill_close_params.rbs +0 -2
- data/sig/orb/models/events/backfill_close_response.rbs +0 -2
- data/sig/orb/models/events/backfill_create_params.rbs +0 -2
- data/sig/orb/models/events/backfill_create_response.rbs +0 -2
- data/sig/orb/models/events/backfill_fetch_params.rbs +0 -2
- data/sig/orb/models/events/backfill_fetch_response.rbs +0 -2
- data/sig/orb/models/events/backfill_list_params.rbs +0 -2
- data/sig/orb/models/events/backfill_list_response.rbs +0 -2
- data/sig/orb/models/events/backfill_revert_params.rbs +0 -2
- data/sig/orb/models/events/backfill_revert_response.rbs +0 -2
- data/sig/orb/models/events/event_volumes.rbs +3 -10
- data/sig/orb/models/events/volume_list_params.rbs +0 -2
- data/sig/orb/models/invoice.rbs +110 -172
- data/sig/orb/models/invoice_create_params.rbs +10 -16
- data/sig/orb/models/invoice_fetch_params.rbs +0 -2
- data/sig/orb/models/invoice_fetch_upcoming_params.rbs +0 -2
- data/sig/orb/models/invoice_fetch_upcoming_response.rbs +2 -64
- data/sig/orb/models/invoice_issue_params.rbs +0 -2
- data/sig/orb/models/invoice_level_discount.rbs +2 -4
- data/sig/orb/models/invoice_line_item_create_params.rbs +0 -2
- data/sig/orb/models/invoice_line_item_create_response.rbs +2 -36
- data/sig/orb/models/invoice_list_params.rbs +4 -6
- data/sig/orb/models/invoice_mark_paid_params.rbs +0 -2
- data/sig/orb/models/invoice_pay_params.rbs +0 -2
- data/sig/orb/models/invoice_update_params.rbs +0 -2
- data/sig/orb/models/invoice_void_params.rbs +0 -2
- data/sig/orb/models/item.rbs +7 -11
- data/sig/orb/models/item_create_params.rbs +0 -2
- data/sig/orb/models/item_fetch_params.rbs +0 -2
- data/sig/orb/models/item_list_params.rbs +0 -2
- data/sig/orb/models/item_update_params.rbs +7 -11
- data/sig/orb/models/metric_create_params.rbs +0 -2
- data/sig/orb/models/metric_fetch_params.rbs +0 -2
- data/sig/orb/models/metric_list_params.rbs +0 -2
- data/sig/orb/models/metric_update_params.rbs +0 -2
- data/sig/orb/models/pagination_metadata.rbs +0 -2
- data/sig/orb/models/percentage_discount.rbs +4 -6
- data/sig/orb/models/plan.rbs +45 -73
- data/sig/orb/models/plan_create_params.rbs +518 -696
- data/sig/orb/models/plan_fetch_params.rbs +0 -2
- data/sig/orb/models/plan_list_params.rbs +0 -2
- data/sig/orb/models/plan_update_params.rbs +0 -2
- data/sig/orb/models/plans/external_plan_id_fetch_params.rbs +0 -2
- data/sig/orb/models/plans/external_plan_id_update_params.rbs +0 -2
- data/sig/orb/models/price.rbs +1194 -1730
- data/sig/orb/models/price_create_params.rbs +59 -97
- data/sig/orb/models/price_evaluate_params.rbs +0 -2
- data/sig/orb/models/price_evaluate_response.rbs +3 -6
- data/sig/orb/models/price_fetch_params.rbs +0 -2
- data/sig/orb/models/price_list_params.rbs +0 -2
- data/sig/orb/models/price_update_params.rbs +0 -2
- data/sig/orb/models/prices/external_price_id_fetch_params.rbs +0 -2
- data/sig/orb/models/prices/external_price_id_update_params.rbs +0 -2
- data/sig/orb/models/subscription.rbs +56 -94
- data/sig/orb/models/subscription_cancel_params.rbs +0 -2
- data/sig/orb/models/subscription_cancel_response.rbs +20 -60
- data/sig/orb/models/subscription_change_apply_params.rbs +0 -2
- data/sig/orb/models/subscription_change_apply_response.rbs +20 -62
- data/sig/orb/models/subscription_change_cancel_params.rbs +0 -2
- data/sig/orb/models/subscription_change_cancel_response.rbs +20 -62
- data/sig/orb/models/subscription_change_retrieve_params.rbs +0 -2
- data/sig/orb/models/subscription_change_retrieve_response.rbs +20 -62
- data/sig/orb/models/subscription_create_params.rbs +1103 -1499
- data/sig/orb/models/subscription_create_response.rbs +20 -60
- data/sig/orb/models/subscription_fetch_costs_params.rbs +0 -2
- data/sig/orb/models/subscription_fetch_costs_response.rbs +0 -6
- data/sig/orb/models/subscription_fetch_params.rbs +0 -2
- data/sig/orb/models/subscription_fetch_schedule_params.rbs +0 -2
- data/sig/orb/models/subscription_fetch_schedule_response.rbs +0 -4
- data/sig/orb/models/subscription_fetch_usage_params.rbs +0 -2
- data/sig/orb/models/subscription_list_params.rbs +0 -2
- data/sig/orb/models/subscription_price_intervals_params.rbs +666 -896
- data/sig/orb/models/subscription_price_intervals_response.rbs +20 -60
- data/sig/orb/models/subscription_schedule_plan_change_params.rbs +1103 -1499
- data/sig/orb/models/subscription_schedule_plan_change_response.rbs +20 -60
- data/sig/orb/models/subscription_trigger_phase_params.rbs +0 -2
- data/sig/orb/models/subscription_trigger_phase_response.rbs +20 -60
- data/sig/orb/models/subscription_unschedule_cancellation_params.rbs +0 -2
- data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +20 -60
- data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbs +0 -2
- data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +20 -60
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_params.rbs +0 -2
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +20 -60
- data/sig/orb/models/subscription_update_fixed_fee_quantity_params.rbs +0 -2
- data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +20 -60
- data/sig/orb/models/subscription_update_params.rbs +0 -2
- data/sig/orb/models/subscription_update_trial_params.rbs +1 -3
- data/sig/orb/models/subscription_update_trial_response.rbs +20 -60
- data/sig/orb/models/subscription_usage.rbs +35 -53
- data/sig/orb/models/subscriptions.rbs +6 -8
- data/sig/orb/models/top_level_ping_params.rbs +0 -2
- data/sig/orb/models/top_level_ping_response.rbs +0 -2
- data/sig/orb/models/trial_discount.rbs +4 -6
- data/sig/orb/models/usage_discount.rbs +4 -6
- data/sig/orb/request_options.rbs +1 -1
- data/sig/orb/resources/alerts.rbs +12 -12
- data/sig/orb/resources/coupons/subscriptions.rbs +1 -1
- data/sig/orb/resources/coupons.rbs +4 -4
- data/sig/orb/resources/credit_notes.rbs +4 -4
- data/sig/orb/resources/customers/credits/ledger.rbs +2 -2
- data/sig/orb/resources/customers/credits/top_ups.rbs +2 -2
- data/sig/orb/resources/customers.rbs +24 -24
- data/sig/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rbs +1 -1
- data/sig/orb/resources/dimensional_price_groups.rbs +3 -3
- data/sig/orb/resources/events/volume.rbs +1 -1
- data/sig/orb/resources/events.rbs +1 -1
- data/sig/orb/resources/invoices.rbs +10 -10
- data/sig/orb/resources/items.rbs +5 -5
- data/sig/orb/resources/metrics.rbs +4 -4
- data/sig/orb/resources/plans/external_plan_id.rbs +2 -2
- data/sig/orb/resources/plans.rbs +5 -5
- data/sig/orb/resources/prices.rbs +11 -11
- data/sig/orb/resources/subscriptions.rbs +21 -21
- metadata +2 -2
@@ -23,8 +23,8 @@ module Orb
|
|
23
23
|
# Prices for this plan. If the plan has phases, this includes prices across all
|
24
24
|
# phases of the plan.
|
25
25
|
#
|
26
|
-
# @return [Array<Orb::
|
27
|
-
required :prices, -> { Orb::Internal::Type::ArrayOf[union: Orb::
|
26
|
+
# @return [Array<Orb::PlanCreateParams::Price::Unit, Orb::PlanCreateParams::Price::Package, Orb::PlanCreateParams::Price::Matrix, Orb::PlanCreateParams::Price::Tiered, Orb::PlanCreateParams::Price::TieredBps, Orb::PlanCreateParams::Price::Bps, Orb::PlanCreateParams::Price::BulkBps, Orb::PlanCreateParams::Price::Bulk, Orb::PlanCreateParams::Price::ThresholdTotalAmount, Orb::PlanCreateParams::Price::TieredPackage, Orb::PlanCreateParams::Price::TieredWithMinimum, Orb::PlanCreateParams::Price::UnitWithPercent, Orb::PlanCreateParams::Price::PackageWithAllocation, Orb::PlanCreateParams::Price::TieredWithProration, Orb::PlanCreateParams::Price::UnitWithProration, Orb::PlanCreateParams::Price::GroupedAllocation, Orb::PlanCreateParams::Price::GroupedWithProratedMinimum, Orb::PlanCreateParams::Price::GroupedWithMeteredMinimum, Orb::PlanCreateParams::Price::MatrixWithDisplayName, Orb::PlanCreateParams::Price::BulkWithProration, Orb::PlanCreateParams::Price::GroupedTieredPackage, Orb::PlanCreateParams::Price::MaxGroupTieredPackage, Orb::PlanCreateParams::Price::ScalableMatrixWithUnitPricing, Orb::PlanCreateParams::Price::ScalableMatrixWithTieredPricing, Orb::PlanCreateParams::Price::CumulativeGroupedBulk>]
|
27
|
+
required :prices, -> { Orb::Internal::Type::ArrayOf[union: Orb::PlanCreateParams::Price] }
|
28
28
|
|
29
29
|
# @!attribute default_invoice_memo
|
30
30
|
# Free-form text which is available on the invoice PDF and the Orb invoice portal.
|
@@ -57,34 +57,28 @@ module Orb
|
|
57
57
|
# The status of the plan to create (either active or draft). If not specified,
|
58
58
|
# this defaults to active.
|
59
59
|
#
|
60
|
-
# @return [Symbol, Orb::
|
61
|
-
optional :status, enum: -> { Orb::
|
60
|
+
# @return [Symbol, Orb::PlanCreateParams::Status, nil]
|
61
|
+
optional :status, enum: -> { Orb::PlanCreateParams::Status }
|
62
62
|
|
63
63
|
# @!method initialize(currency:, name:, prices:, default_invoice_memo: nil, external_plan_id: nil, metadata: nil, net_terms: nil, status: nil, request_options: {})
|
64
64
|
# Some parameter documentations has been truncated, see
|
65
65
|
# {Orb::Models::PlanCreateParams} for more details.
|
66
66
|
#
|
67
67
|
# @param currency [String] An ISO 4217 currency string for invoices generated by subscriptions on this plan
|
68
|
-
# ...
|
69
68
|
#
|
70
69
|
# @param name [String]
|
71
70
|
#
|
72
|
-
# @param prices [Array<Orb::
|
73
|
-
# ...
|
71
|
+
# @param prices [Array<Orb::PlanCreateParams::Price::Unit, Orb::PlanCreateParams::Price::Package, Orb::PlanCreateParams::Price::Matrix, Orb::PlanCreateParams::Price::Tiered, Orb::PlanCreateParams::Price::TieredBps, Orb::PlanCreateParams::Price::Bps, Orb::PlanCreateParams::Price::BulkBps, Orb::PlanCreateParams::Price::Bulk, Orb::PlanCreateParams::Price::ThresholdTotalAmount, Orb::PlanCreateParams::Price::TieredPackage, Orb::PlanCreateParams::Price::TieredWithMinimum, Orb::PlanCreateParams::Price::UnitWithPercent, Orb::PlanCreateParams::Price::PackageWithAllocation, Orb::PlanCreateParams::Price::TieredWithProration, Orb::PlanCreateParams::Price::UnitWithProration, Orb::PlanCreateParams::Price::GroupedAllocation, Orb::PlanCreateParams::Price::GroupedWithProratedMinimum, Orb::PlanCreateParams::Price::GroupedWithMeteredMinimum, Orb::PlanCreateParams::Price::MatrixWithDisplayName, Orb::PlanCreateParams::Price::BulkWithProration, Orb::PlanCreateParams::Price::GroupedTieredPackage, Orb::PlanCreateParams::Price::MaxGroupTieredPackage, Orb::PlanCreateParams::Price::ScalableMatrixWithUnitPricing, Orb::PlanCreateParams::Price::ScalableMatrixWithTieredPricing, Orb::PlanCreateParams::Price::CumulativeGroupedBulk>] Prices for this plan. If the plan has phases, this includes prices across all ph
|
74
72
|
#
|
75
73
|
# @param default_invoice_memo [String, nil] Free-form text which is available on the invoice PDF and the Orb invoice portal.
|
76
|
-
# ...
|
77
74
|
#
|
78
75
|
# @param external_plan_id [String, nil]
|
79
76
|
#
|
80
77
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
81
|
-
# ...
|
82
78
|
#
|
83
79
|
# @param net_terms [Integer, nil] The net terms determines the difference between the invoice date and the issue d
|
84
|
-
# ...
|
85
80
|
#
|
86
|
-
# @param status [Symbol, Orb::
|
87
|
-
# ...
|
81
|
+
# @param status [Symbol, Orb::PlanCreateParams::Status] The status of the plan to create (either active or draft). If not specified, thi
|
88
82
|
#
|
89
83
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
90
84
|
|
@@ -93,66 +87,67 @@ module Orb
|
|
93
87
|
|
94
88
|
discriminator :model_type
|
95
89
|
|
96
|
-
variant :unit, -> { Orb::
|
90
|
+
variant :unit, -> { Orb::PlanCreateParams::Price::Unit }
|
97
91
|
|
98
|
-
variant :package, -> { Orb::
|
92
|
+
variant :package, -> { Orb::PlanCreateParams::Price::Package }
|
99
93
|
|
100
|
-
variant :matrix, -> { Orb::
|
94
|
+
variant :matrix, -> { Orb::PlanCreateParams::Price::Matrix }
|
101
95
|
|
102
|
-
variant :tiered, -> { Orb::
|
96
|
+
variant :tiered, -> { Orb::PlanCreateParams::Price::Tiered }
|
103
97
|
|
104
|
-
variant :tiered_bps, -> { Orb::
|
98
|
+
variant :tiered_bps, -> { Orb::PlanCreateParams::Price::TieredBps }
|
105
99
|
|
106
|
-
variant :bps, -> { Orb::
|
100
|
+
variant :bps, -> { Orb::PlanCreateParams::Price::Bps }
|
107
101
|
|
108
|
-
variant :bulk_bps, -> { Orb::
|
102
|
+
variant :bulk_bps, -> { Orb::PlanCreateParams::Price::BulkBps }
|
109
103
|
|
110
|
-
variant :bulk, -> { Orb::
|
104
|
+
variant :bulk, -> { Orb::PlanCreateParams::Price::Bulk }
|
111
105
|
|
112
|
-
variant :threshold_total_amount, -> { Orb::
|
106
|
+
variant :threshold_total_amount, -> { Orb::PlanCreateParams::Price::ThresholdTotalAmount }
|
113
107
|
|
114
|
-
variant :tiered_package, -> { Orb::
|
108
|
+
variant :tiered_package, -> { Orb::PlanCreateParams::Price::TieredPackage }
|
115
109
|
|
116
|
-
variant :tiered_with_minimum, -> { Orb::
|
110
|
+
variant :tiered_with_minimum, -> { Orb::PlanCreateParams::Price::TieredWithMinimum }
|
117
111
|
|
118
|
-
variant :unit_with_percent, -> { Orb::
|
112
|
+
variant :unit_with_percent, -> { Orb::PlanCreateParams::Price::UnitWithPercent }
|
119
113
|
|
120
|
-
variant :package_with_allocation, -> { Orb::
|
114
|
+
variant :package_with_allocation, -> { Orb::PlanCreateParams::Price::PackageWithAllocation }
|
121
115
|
|
122
|
-
variant :tiered_with_proration, -> { Orb::
|
116
|
+
variant :tiered_with_proration, -> { Orb::PlanCreateParams::Price::TieredWithProration }
|
123
117
|
|
124
|
-
variant :unit_with_proration, -> { Orb::
|
118
|
+
variant :unit_with_proration, -> { Orb::PlanCreateParams::Price::UnitWithProration }
|
125
119
|
|
126
|
-
variant :grouped_allocation, -> { Orb::
|
120
|
+
variant :grouped_allocation, -> { Orb::PlanCreateParams::Price::GroupedAllocation }
|
127
121
|
|
128
122
|
variant :grouped_with_prorated_minimum,
|
129
|
-
-> {
|
123
|
+
-> {
|
124
|
+
Orb::PlanCreateParams::Price::GroupedWithProratedMinimum
|
125
|
+
}
|
130
126
|
|
131
|
-
variant :grouped_with_metered_minimum,
|
132
|
-
-> { Orb::Models::PlanCreateParams::Price::GroupedWithMeteredMinimum }
|
127
|
+
variant :grouped_with_metered_minimum, -> { Orb::PlanCreateParams::Price::GroupedWithMeteredMinimum }
|
133
128
|
|
134
|
-
variant :matrix_with_display_name, -> { Orb::
|
129
|
+
variant :matrix_with_display_name, -> { Orb::PlanCreateParams::Price::MatrixWithDisplayName }
|
135
130
|
|
136
|
-
variant :bulk_with_proration, -> { Orb::
|
131
|
+
variant :bulk_with_proration, -> { Orb::PlanCreateParams::Price::BulkWithProration }
|
137
132
|
|
138
|
-
variant :grouped_tiered_package, -> { Orb::
|
133
|
+
variant :grouped_tiered_package, -> { Orb::PlanCreateParams::Price::GroupedTieredPackage }
|
139
134
|
|
140
|
-
variant :max_group_tiered_package, -> { Orb::
|
135
|
+
variant :max_group_tiered_package, -> { Orb::PlanCreateParams::Price::MaxGroupTieredPackage }
|
141
136
|
|
142
137
|
variant :scalable_matrix_with_unit_pricing,
|
143
|
-
-> { Orb::
|
138
|
+
-> { Orb::PlanCreateParams::Price::ScalableMatrixWithUnitPricing }
|
144
139
|
|
145
140
|
variant :scalable_matrix_with_tiered_pricing,
|
146
|
-
-> { Orb::
|
141
|
+
-> { Orb::PlanCreateParams::Price::ScalableMatrixWithTieredPricing }
|
147
142
|
|
148
|
-
variant :cumulative_grouped_bulk, -> { Orb::
|
143
|
+
variant :cumulative_grouped_bulk, -> { Orb::PlanCreateParams::Price::CumulativeGroupedBulk }
|
149
144
|
|
150
145
|
class Unit < Orb::Internal::Type::BaseModel
|
151
146
|
# @!attribute cadence
|
152
147
|
# The cadence to bill for this price on.
|
153
148
|
#
|
154
|
-
# @return [Symbol, Orb::
|
155
|
-
required :cadence, enum: -> { Orb::
|
149
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::Unit::Cadence]
|
150
|
+
required :cadence, enum: -> { Orb::PlanCreateParams::Price::Unit::Cadence }
|
156
151
|
|
157
152
|
# @!attribute item_id
|
158
153
|
# The id of the item the price will be associated with.
|
@@ -173,8 +168,8 @@ module Orb
|
|
173
168
|
|
174
169
|
# @!attribute unit_config
|
175
170
|
#
|
176
|
-
# @return [Orb::
|
177
|
-
required :unit_config, -> { Orb::
|
171
|
+
# @return [Orb::PlanCreateParams::Price::Unit::UnitConfig]
|
172
|
+
required :unit_config, -> { Orb::PlanCreateParams::Price::Unit::UnitConfig }
|
178
173
|
|
179
174
|
# @!attribute billable_metric_id
|
180
175
|
# The id of the billable metric for the price. Only needed if the price is
|
@@ -194,9 +189,9 @@ module Orb
|
|
194
189
|
# For custom cadence: specifies the duration of the billing period in days or
|
195
190
|
# months.
|
196
191
|
#
|
197
|
-
# @return [Orb::
|
192
|
+
# @return [Orb::PlanCreateParams::Price::Unit::BillingCycleConfiguration, nil]
|
198
193
|
optional :billing_cycle_configuration,
|
199
|
-
-> { Orb::
|
194
|
+
-> { Orb::PlanCreateParams::Price::Unit::BillingCycleConfiguration },
|
200
195
|
nil?: true
|
201
196
|
|
202
197
|
# @!attribute conversion_rate
|
@@ -235,9 +230,9 @@ module Orb
|
|
235
230
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
236
231
|
# If unspecified, a single invoice is produced per billing cycle.
|
237
232
|
#
|
238
|
-
# @return [Orb::
|
233
|
+
# @return [Orb::PlanCreateParams::Price::Unit::InvoicingCycleConfiguration, nil]
|
239
234
|
optional :invoicing_cycle_configuration,
|
240
|
-
-> { Orb::
|
235
|
+
-> { Orb::PlanCreateParams::Price::Unit::InvoicingCycleConfiguration },
|
241
236
|
nil?: true
|
242
237
|
|
243
238
|
# @!attribute metadata
|
@@ -250,48 +245,41 @@ module Orb
|
|
250
245
|
|
251
246
|
# @!method initialize(cadence:, item_id:, name:, unit_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :unit)
|
252
247
|
# Some parameter documentations has been truncated, see
|
253
|
-
# {Orb::
|
248
|
+
# {Orb::PlanCreateParams::Price::Unit} for more details.
|
254
249
|
#
|
255
|
-
# @param cadence [Symbol, Orb::
|
250
|
+
# @param cadence [Symbol, Orb::PlanCreateParams::Price::Unit::Cadence] The cadence to bill for this price on.
|
256
251
|
#
|
257
252
|
# @param item_id [String] The id of the item the price will be associated with.
|
258
253
|
#
|
259
254
|
# @param name [String] The name of the price.
|
260
255
|
#
|
261
|
-
# @param unit_config [Orb::
|
256
|
+
# @param unit_config [Orb::PlanCreateParams::Price::Unit::UnitConfig]
|
262
257
|
#
|
263
258
|
# @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b
|
264
|
-
# ...
|
265
259
|
#
|
266
260
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
267
|
-
# ...
|
268
261
|
#
|
269
|
-
# @param billing_cycle_configuration [Orb::
|
270
|
-
# ...
|
262
|
+
# @param billing_cycle_configuration [Orb::PlanCreateParams::Price::Unit::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
271
263
|
#
|
272
264
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
273
265
|
#
|
274
266
|
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
275
|
-
# ...
|
276
267
|
#
|
277
268
|
# @param external_price_id [String, nil] An alias for the price.
|
278
269
|
#
|
279
270
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
280
|
-
# ...
|
281
271
|
#
|
282
272
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
283
273
|
#
|
284
|
-
# @param invoicing_cycle_configuration [Orb::
|
285
|
-
# ...
|
274
|
+
# @param invoicing_cycle_configuration [Orb::PlanCreateParams::Price::Unit::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
286
275
|
#
|
287
276
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
288
|
-
# ...
|
289
277
|
#
|
290
278
|
# @param model_type [Symbol, :unit]
|
291
279
|
|
292
280
|
# The cadence to bill for this price on.
|
293
281
|
#
|
294
|
-
# @see Orb::
|
282
|
+
# @see Orb::PlanCreateParams::Price::Unit#cadence
|
295
283
|
module Cadence
|
296
284
|
extend Orb::Internal::Type::Enum
|
297
285
|
|
@@ -306,7 +294,7 @@ module Orb
|
|
306
294
|
# @return [Array<Symbol>]
|
307
295
|
end
|
308
296
|
|
309
|
-
# @see Orb::
|
297
|
+
# @see Orb::PlanCreateParams::Price::Unit#unit_config
|
310
298
|
class UnitConfig < Orb::Internal::Type::BaseModel
|
311
299
|
# @!attribute unit_amount
|
312
300
|
# Rate per unit of usage
|
@@ -318,7 +306,7 @@ module Orb
|
|
318
306
|
# @param unit_amount [String] Rate per unit of usage
|
319
307
|
end
|
320
308
|
|
321
|
-
# @see Orb::
|
309
|
+
# @see Orb::PlanCreateParams::Price::Unit#billing_cycle_configuration
|
322
310
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
323
311
|
# @!attribute duration
|
324
312
|
# The duration of the billing period.
|
@@ -329,9 +317,9 @@ module Orb
|
|
329
317
|
# @!attribute duration_unit
|
330
318
|
# The unit of billing period duration.
|
331
319
|
#
|
332
|
-
# @return [Symbol, Orb::
|
320
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::Unit::BillingCycleConfiguration::DurationUnit]
|
333
321
|
required :duration_unit,
|
334
|
-
enum: -> { Orb::
|
322
|
+
enum: -> { Orb::PlanCreateParams::Price::Unit::BillingCycleConfiguration::DurationUnit }
|
335
323
|
|
336
324
|
# @!method initialize(duration:, duration_unit:)
|
337
325
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -339,11 +327,11 @@ module Orb
|
|
339
327
|
#
|
340
328
|
# @param duration [Integer] The duration of the billing period.
|
341
329
|
#
|
342
|
-
# @param duration_unit [Symbol, Orb::
|
330
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::Unit::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
343
331
|
|
344
332
|
# The unit of billing period duration.
|
345
333
|
#
|
346
|
-
# @see Orb::
|
334
|
+
# @see Orb::PlanCreateParams::Price::Unit::BillingCycleConfiguration#duration_unit
|
347
335
|
module DurationUnit
|
348
336
|
extend Orb::Internal::Type::Enum
|
349
337
|
|
@@ -355,7 +343,7 @@ module Orb
|
|
355
343
|
end
|
356
344
|
end
|
357
345
|
|
358
|
-
# @see Orb::
|
346
|
+
# @see Orb::PlanCreateParams::Price::Unit#invoicing_cycle_configuration
|
359
347
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
360
348
|
# @!attribute duration
|
361
349
|
# The duration of the billing period.
|
@@ -366,9 +354,11 @@ module Orb
|
|
366
354
|
# @!attribute duration_unit
|
367
355
|
# The unit of billing period duration.
|
368
356
|
#
|
369
|
-
# @return [Symbol, Orb::
|
357
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::Unit::InvoicingCycleConfiguration::DurationUnit]
|
370
358
|
required :duration_unit,
|
371
|
-
enum: -> {
|
359
|
+
enum: -> {
|
360
|
+
Orb::PlanCreateParams::Price::Unit::InvoicingCycleConfiguration::DurationUnit
|
361
|
+
}
|
372
362
|
|
373
363
|
# @!method initialize(duration:, duration_unit:)
|
374
364
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
@@ -376,11 +366,11 @@ module Orb
|
|
376
366
|
#
|
377
367
|
# @param duration [Integer] The duration of the billing period.
|
378
368
|
#
|
379
|
-
# @param duration_unit [Symbol, Orb::
|
369
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::Unit::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
380
370
|
|
381
371
|
# The unit of billing period duration.
|
382
372
|
#
|
383
|
-
# @see Orb::
|
373
|
+
# @see Orb::PlanCreateParams::Price::Unit::InvoicingCycleConfiguration#duration_unit
|
384
374
|
module DurationUnit
|
385
375
|
extend Orb::Internal::Type::Enum
|
386
376
|
|
@@ -397,8 +387,8 @@ module Orb
|
|
397
387
|
# @!attribute cadence
|
398
388
|
# The cadence to bill for this price on.
|
399
389
|
#
|
400
|
-
# @return [Symbol, Orb::
|
401
|
-
required :cadence, enum: -> { Orb::
|
390
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::Package::Cadence]
|
391
|
+
required :cadence, enum: -> { Orb::PlanCreateParams::Price::Package::Cadence }
|
402
392
|
|
403
393
|
# @!attribute item_id
|
404
394
|
# The id of the item the price will be associated with.
|
@@ -419,8 +409,8 @@ module Orb
|
|
419
409
|
|
420
410
|
# @!attribute package_config
|
421
411
|
#
|
422
|
-
# @return [Orb::
|
423
|
-
required :package_config, -> { Orb::
|
412
|
+
# @return [Orb::PlanCreateParams::Price::Package::PackageConfig]
|
413
|
+
required :package_config, -> { Orb::PlanCreateParams::Price::Package::PackageConfig }
|
424
414
|
|
425
415
|
# @!attribute billable_metric_id
|
426
416
|
# The id of the billable metric for the price. Only needed if the price is
|
@@ -440,9 +430,9 @@ module Orb
|
|
440
430
|
# For custom cadence: specifies the duration of the billing period in days or
|
441
431
|
# months.
|
442
432
|
#
|
443
|
-
# @return [Orb::
|
433
|
+
# @return [Orb::PlanCreateParams::Price::Package::BillingCycleConfiguration, nil]
|
444
434
|
optional :billing_cycle_configuration,
|
445
|
-
-> { Orb::
|
435
|
+
-> { Orb::PlanCreateParams::Price::Package::BillingCycleConfiguration },
|
446
436
|
nil?: true
|
447
437
|
|
448
438
|
# @!attribute conversion_rate
|
@@ -481,9 +471,9 @@ module Orb
|
|
481
471
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
482
472
|
# If unspecified, a single invoice is produced per billing cycle.
|
483
473
|
#
|
484
|
-
# @return [Orb::
|
474
|
+
# @return [Orb::PlanCreateParams::Price::Package::InvoicingCycleConfiguration, nil]
|
485
475
|
optional :invoicing_cycle_configuration,
|
486
|
-
-> { Orb::
|
476
|
+
-> { Orb::PlanCreateParams::Price::Package::InvoicingCycleConfiguration },
|
487
477
|
nil?: true
|
488
478
|
|
489
479
|
# @!attribute metadata
|
@@ -496,48 +486,41 @@ module Orb
|
|
496
486
|
|
497
487
|
# @!method initialize(cadence:, item_id:, name:, package_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :package)
|
498
488
|
# Some parameter documentations has been truncated, see
|
499
|
-
# {Orb::
|
489
|
+
# {Orb::PlanCreateParams::Price::Package} for more details.
|
500
490
|
#
|
501
|
-
# @param cadence [Symbol, Orb::
|
491
|
+
# @param cadence [Symbol, Orb::PlanCreateParams::Price::Package::Cadence] The cadence to bill for this price on.
|
502
492
|
#
|
503
493
|
# @param item_id [String] The id of the item the price will be associated with.
|
504
494
|
#
|
505
495
|
# @param name [String] The name of the price.
|
506
496
|
#
|
507
|
-
# @param package_config [Orb::
|
497
|
+
# @param package_config [Orb::PlanCreateParams::Price::Package::PackageConfig]
|
508
498
|
#
|
509
499
|
# @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b
|
510
|
-
# ...
|
511
500
|
#
|
512
501
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
513
|
-
# ...
|
514
502
|
#
|
515
|
-
# @param billing_cycle_configuration [Orb::
|
516
|
-
# ...
|
503
|
+
# @param billing_cycle_configuration [Orb::PlanCreateParams::Price::Package::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
517
504
|
#
|
518
505
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
519
506
|
#
|
520
507
|
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
521
|
-
# ...
|
522
508
|
#
|
523
509
|
# @param external_price_id [String, nil] An alias for the price.
|
524
510
|
#
|
525
511
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
526
|
-
# ...
|
527
512
|
#
|
528
513
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
529
514
|
#
|
530
|
-
# @param invoicing_cycle_configuration [Orb::
|
531
|
-
# ...
|
515
|
+
# @param invoicing_cycle_configuration [Orb::PlanCreateParams::Price::Package::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
532
516
|
#
|
533
517
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
534
|
-
# ...
|
535
518
|
#
|
536
519
|
# @param model_type [Symbol, :package]
|
537
520
|
|
538
521
|
# The cadence to bill for this price on.
|
539
522
|
#
|
540
|
-
# @see Orb::
|
523
|
+
# @see Orb::PlanCreateParams::Price::Package#cadence
|
541
524
|
module Cadence
|
542
525
|
extend Orb::Internal::Type::Enum
|
543
526
|
|
@@ -552,7 +535,7 @@ module Orb
|
|
552
535
|
# @return [Array<Symbol>]
|
553
536
|
end
|
554
537
|
|
555
|
-
# @see Orb::
|
538
|
+
# @see Orb::PlanCreateParams::Price::Package#package_config
|
556
539
|
class PackageConfig < Orb::Internal::Type::BaseModel
|
557
540
|
# @!attribute package_amount
|
558
541
|
# A currency amount to rate usage by
|
@@ -569,15 +552,14 @@ module Orb
|
|
569
552
|
|
570
553
|
# @!method initialize(package_amount:, package_size:)
|
571
554
|
# Some parameter documentations has been truncated, see
|
572
|
-
# {Orb::
|
555
|
+
# {Orb::PlanCreateParams::Price::Package::PackageConfig} for more details.
|
573
556
|
#
|
574
557
|
# @param package_amount [String] A currency amount to rate usage by
|
575
558
|
#
|
576
559
|
# @param package_size [Integer] An integer amount to represent package size. For example, 1000 here would divide
|
577
|
-
# ...
|
578
560
|
end
|
579
561
|
|
580
|
-
# @see Orb::
|
562
|
+
# @see Orb::PlanCreateParams::Price::Package#billing_cycle_configuration
|
581
563
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
582
564
|
# @!attribute duration
|
583
565
|
# The duration of the billing period.
|
@@ -588,9 +570,11 @@ module Orb
|
|
588
570
|
# @!attribute duration_unit
|
589
571
|
# The unit of billing period duration.
|
590
572
|
#
|
591
|
-
# @return [Symbol, Orb::
|
573
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::Package::BillingCycleConfiguration::DurationUnit]
|
592
574
|
required :duration_unit,
|
593
|
-
enum: -> {
|
575
|
+
enum: -> {
|
576
|
+
Orb::PlanCreateParams::Price::Package::BillingCycleConfiguration::DurationUnit
|
577
|
+
}
|
594
578
|
|
595
579
|
# @!method initialize(duration:, duration_unit:)
|
596
580
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -598,11 +582,11 @@ module Orb
|
|
598
582
|
#
|
599
583
|
# @param duration [Integer] The duration of the billing period.
|
600
584
|
#
|
601
|
-
# @param duration_unit [Symbol, Orb::
|
585
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::Package::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
602
586
|
|
603
587
|
# The unit of billing period duration.
|
604
588
|
#
|
605
|
-
# @see Orb::
|
589
|
+
# @see Orb::PlanCreateParams::Price::Package::BillingCycleConfiguration#duration_unit
|
606
590
|
module DurationUnit
|
607
591
|
extend Orb::Internal::Type::Enum
|
608
592
|
|
@@ -614,7 +598,7 @@ module Orb
|
|
614
598
|
end
|
615
599
|
end
|
616
600
|
|
617
|
-
# @see Orb::
|
601
|
+
# @see Orb::PlanCreateParams::Price::Package#invoicing_cycle_configuration
|
618
602
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
619
603
|
# @!attribute duration
|
620
604
|
# The duration of the billing period.
|
@@ -625,9 +609,11 @@ module Orb
|
|
625
609
|
# @!attribute duration_unit
|
626
610
|
# The unit of billing period duration.
|
627
611
|
#
|
628
|
-
# @return [Symbol, Orb::
|
612
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::Package::InvoicingCycleConfiguration::DurationUnit]
|
629
613
|
required :duration_unit,
|
630
|
-
enum: -> {
|
614
|
+
enum: -> {
|
615
|
+
Orb::PlanCreateParams::Price::Package::InvoicingCycleConfiguration::DurationUnit
|
616
|
+
}
|
631
617
|
|
632
618
|
# @!method initialize(duration:, duration_unit:)
|
633
619
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
@@ -635,11 +621,11 @@ module Orb
|
|
635
621
|
#
|
636
622
|
# @param duration [Integer] The duration of the billing period.
|
637
623
|
#
|
638
|
-
# @param duration_unit [Symbol, Orb::
|
624
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::Package::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
639
625
|
|
640
626
|
# The unit of billing period duration.
|
641
627
|
#
|
642
|
-
# @see Orb::
|
628
|
+
# @see Orb::PlanCreateParams::Price::Package::InvoicingCycleConfiguration#duration_unit
|
643
629
|
module DurationUnit
|
644
630
|
extend Orb::Internal::Type::Enum
|
645
631
|
|
@@ -656,8 +642,8 @@ module Orb
|
|
656
642
|
# @!attribute cadence
|
657
643
|
# The cadence to bill for this price on.
|
658
644
|
#
|
659
|
-
# @return [Symbol, Orb::
|
660
|
-
required :cadence, enum: -> { Orb::
|
645
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::Matrix::Cadence]
|
646
|
+
required :cadence, enum: -> { Orb::PlanCreateParams::Price::Matrix::Cadence }
|
661
647
|
|
662
648
|
# @!attribute item_id
|
663
649
|
# The id of the item the price will be associated with.
|
@@ -667,8 +653,8 @@ module Orb
|
|
667
653
|
|
668
654
|
# @!attribute matrix_config
|
669
655
|
#
|
670
|
-
# @return [Orb::
|
671
|
-
required :matrix_config, -> { Orb::
|
656
|
+
# @return [Orb::PlanCreateParams::Price::Matrix::MatrixConfig]
|
657
|
+
required :matrix_config, -> { Orb::PlanCreateParams::Price::Matrix::MatrixConfig }
|
672
658
|
|
673
659
|
# @!attribute model_type
|
674
660
|
#
|
@@ -699,9 +685,9 @@ module Orb
|
|
699
685
|
# For custom cadence: specifies the duration of the billing period in days or
|
700
686
|
# months.
|
701
687
|
#
|
702
|
-
# @return [Orb::
|
688
|
+
# @return [Orb::PlanCreateParams::Price::Matrix::BillingCycleConfiguration, nil]
|
703
689
|
optional :billing_cycle_configuration,
|
704
|
-
-> { Orb::
|
690
|
+
-> { Orb::PlanCreateParams::Price::Matrix::BillingCycleConfiguration },
|
705
691
|
nil?: true
|
706
692
|
|
707
693
|
# @!attribute conversion_rate
|
@@ -740,9 +726,9 @@ module Orb
|
|
740
726
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
741
727
|
# If unspecified, a single invoice is produced per billing cycle.
|
742
728
|
#
|
743
|
-
# @return [Orb::
|
729
|
+
# @return [Orb::PlanCreateParams::Price::Matrix::InvoicingCycleConfiguration, nil]
|
744
730
|
optional :invoicing_cycle_configuration,
|
745
|
-
-> { Orb::
|
731
|
+
-> { Orb::PlanCreateParams::Price::Matrix::InvoicingCycleConfiguration },
|
746
732
|
nil?: true
|
747
733
|
|
748
734
|
# @!attribute metadata
|
@@ -755,48 +741,41 @@ module Orb
|
|
755
741
|
|
756
742
|
# @!method initialize(cadence:, item_id:, matrix_config:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :matrix)
|
757
743
|
# Some parameter documentations has been truncated, see
|
758
|
-
# {Orb::
|
744
|
+
# {Orb::PlanCreateParams::Price::Matrix} for more details.
|
759
745
|
#
|
760
|
-
# @param cadence [Symbol, Orb::
|
746
|
+
# @param cadence [Symbol, Orb::PlanCreateParams::Price::Matrix::Cadence] The cadence to bill for this price on.
|
761
747
|
#
|
762
748
|
# @param item_id [String] The id of the item the price will be associated with.
|
763
749
|
#
|
764
|
-
# @param matrix_config [Orb::
|
750
|
+
# @param matrix_config [Orb::PlanCreateParams::Price::Matrix::MatrixConfig]
|
765
751
|
#
|
766
752
|
# @param name [String] The name of the price.
|
767
753
|
#
|
768
754
|
# @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b
|
769
|
-
# ...
|
770
755
|
#
|
771
756
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
772
|
-
# ...
|
773
757
|
#
|
774
|
-
# @param billing_cycle_configuration [Orb::
|
775
|
-
# ...
|
758
|
+
# @param billing_cycle_configuration [Orb::PlanCreateParams::Price::Matrix::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
776
759
|
#
|
777
760
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
778
761
|
#
|
779
762
|
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
780
|
-
# ...
|
781
763
|
#
|
782
764
|
# @param external_price_id [String, nil] An alias for the price.
|
783
765
|
#
|
784
766
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
785
|
-
# ...
|
786
767
|
#
|
787
768
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
788
769
|
#
|
789
|
-
# @param invoicing_cycle_configuration [Orb::
|
790
|
-
# ...
|
770
|
+
# @param invoicing_cycle_configuration [Orb::PlanCreateParams::Price::Matrix::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
791
771
|
#
|
792
772
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
793
|
-
# ...
|
794
773
|
#
|
795
774
|
# @param model_type [Symbol, :matrix]
|
796
775
|
|
797
776
|
# The cadence to bill for this price on.
|
798
777
|
#
|
799
|
-
# @see Orb::
|
778
|
+
# @see Orb::PlanCreateParams::Price::Matrix#cadence
|
800
779
|
module Cadence
|
801
780
|
extend Orb::Internal::Type::Enum
|
802
781
|
|
@@ -811,7 +790,7 @@ module Orb
|
|
811
790
|
# @return [Array<Symbol>]
|
812
791
|
end
|
813
792
|
|
814
|
-
# @see Orb::
|
793
|
+
# @see Orb::PlanCreateParams::Price::Matrix#matrix_config
|
815
794
|
class MatrixConfig < Orb::Internal::Type::BaseModel
|
816
795
|
# @!attribute default_unit_amount
|
817
796
|
# Default per unit rate for any usage not bucketed into a specified matrix_value
|
@@ -828,16 +807,18 @@ module Orb
|
|
828
807
|
# @!attribute matrix_values
|
829
808
|
# Matrix values for specified matrix grouping keys
|
830
809
|
#
|
831
|
-
# @return [Array<Orb::
|
810
|
+
# @return [Array<Orb::PlanCreateParams::Price::Matrix::MatrixConfig::MatrixValue>]
|
832
811
|
required :matrix_values,
|
833
|
-
-> {
|
812
|
+
-> {
|
813
|
+
Orb::Internal::Type::ArrayOf[Orb::PlanCreateParams::Price::Matrix::MatrixConfig::MatrixValue]
|
814
|
+
}
|
834
815
|
|
835
816
|
# @!method initialize(default_unit_amount:, dimensions:, matrix_values:)
|
836
817
|
# @param default_unit_amount [String] Default per unit rate for any usage not bucketed into a specified matrix_value
|
837
818
|
#
|
838
819
|
# @param dimensions [Array<String, nil>] One or two event property values to evaluate matrix groups by
|
839
820
|
#
|
840
|
-
# @param matrix_values [Array<Orb::
|
821
|
+
# @param matrix_values [Array<Orb::PlanCreateParams::Price::Matrix::MatrixConfig::MatrixValue>] Matrix values for specified matrix grouping keys
|
841
822
|
|
842
823
|
class MatrixValue < Orb::Internal::Type::BaseModel
|
843
824
|
# @!attribute dimension_values
|
@@ -856,17 +837,16 @@ module Orb
|
|
856
837
|
|
857
838
|
# @!method initialize(dimension_values:, unit_amount:)
|
858
839
|
# Some parameter documentations has been truncated, see
|
859
|
-
# {Orb::
|
860
|
-
#
|
840
|
+
# {Orb::PlanCreateParams::Price::Matrix::MatrixConfig::MatrixValue} for more
|
841
|
+
# details.
|
861
842
|
#
|
862
843
|
# @param dimension_values [Array<String, nil>] One or two matrix keys to filter usage to this Matrix value by. For example, ["r
|
863
|
-
# ...
|
864
844
|
#
|
865
845
|
# @param unit_amount [String] Unit price for the specified dimension_values
|
866
846
|
end
|
867
847
|
end
|
868
848
|
|
869
|
-
# @see Orb::
|
849
|
+
# @see Orb::PlanCreateParams::Price::Matrix#billing_cycle_configuration
|
870
850
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
871
851
|
# @!attribute duration
|
872
852
|
# The duration of the billing period.
|
@@ -877,9 +857,11 @@ module Orb
|
|
877
857
|
# @!attribute duration_unit
|
878
858
|
# The unit of billing period duration.
|
879
859
|
#
|
880
|
-
# @return [Symbol, Orb::
|
860
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::Matrix::BillingCycleConfiguration::DurationUnit]
|
881
861
|
required :duration_unit,
|
882
|
-
enum: -> {
|
862
|
+
enum: -> {
|
863
|
+
Orb::PlanCreateParams::Price::Matrix::BillingCycleConfiguration::DurationUnit
|
864
|
+
}
|
883
865
|
|
884
866
|
# @!method initialize(duration:, duration_unit:)
|
885
867
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -887,11 +869,11 @@ module Orb
|
|
887
869
|
#
|
888
870
|
# @param duration [Integer] The duration of the billing period.
|
889
871
|
#
|
890
|
-
# @param duration_unit [Symbol, Orb::
|
872
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::Matrix::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
891
873
|
|
892
874
|
# The unit of billing period duration.
|
893
875
|
#
|
894
|
-
# @see Orb::
|
876
|
+
# @see Orb::PlanCreateParams::Price::Matrix::BillingCycleConfiguration#duration_unit
|
895
877
|
module DurationUnit
|
896
878
|
extend Orb::Internal::Type::Enum
|
897
879
|
|
@@ -903,7 +885,7 @@ module Orb
|
|
903
885
|
end
|
904
886
|
end
|
905
887
|
|
906
|
-
# @see Orb::
|
888
|
+
# @see Orb::PlanCreateParams::Price::Matrix#invoicing_cycle_configuration
|
907
889
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
908
890
|
# @!attribute duration
|
909
891
|
# The duration of the billing period.
|
@@ -914,9 +896,11 @@ module Orb
|
|
914
896
|
# @!attribute duration_unit
|
915
897
|
# The unit of billing period duration.
|
916
898
|
#
|
917
|
-
# @return [Symbol, Orb::
|
899
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::Matrix::InvoicingCycleConfiguration::DurationUnit]
|
918
900
|
required :duration_unit,
|
919
|
-
enum: -> {
|
901
|
+
enum: -> {
|
902
|
+
Orb::PlanCreateParams::Price::Matrix::InvoicingCycleConfiguration::DurationUnit
|
903
|
+
}
|
920
904
|
|
921
905
|
# @!method initialize(duration:, duration_unit:)
|
922
906
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
@@ -924,11 +908,11 @@ module Orb
|
|
924
908
|
#
|
925
909
|
# @param duration [Integer] The duration of the billing period.
|
926
910
|
#
|
927
|
-
# @param duration_unit [Symbol, Orb::
|
911
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::Matrix::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
928
912
|
|
929
913
|
# The unit of billing period duration.
|
930
914
|
#
|
931
|
-
# @see Orb::
|
915
|
+
# @see Orb::PlanCreateParams::Price::Matrix::InvoicingCycleConfiguration#duration_unit
|
932
916
|
module DurationUnit
|
933
917
|
extend Orb::Internal::Type::Enum
|
934
918
|
|
@@ -945,8 +929,8 @@ module Orb
|
|
945
929
|
# @!attribute cadence
|
946
930
|
# The cadence to bill for this price on.
|
947
931
|
#
|
948
|
-
# @return [Symbol, Orb::
|
949
|
-
required :cadence, enum: -> { Orb::
|
932
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::Tiered::Cadence]
|
933
|
+
required :cadence, enum: -> { Orb::PlanCreateParams::Price::Tiered::Cadence }
|
950
934
|
|
951
935
|
# @!attribute item_id
|
952
936
|
# The id of the item the price will be associated with.
|
@@ -967,8 +951,8 @@ module Orb
|
|
967
951
|
|
968
952
|
# @!attribute tiered_config
|
969
953
|
#
|
970
|
-
# @return [Orb::
|
971
|
-
required :tiered_config, -> { Orb::
|
954
|
+
# @return [Orb::PlanCreateParams::Price::Tiered::TieredConfig]
|
955
|
+
required :tiered_config, -> { Orb::PlanCreateParams::Price::Tiered::TieredConfig }
|
972
956
|
|
973
957
|
# @!attribute billable_metric_id
|
974
958
|
# The id of the billable metric for the price. Only needed if the price is
|
@@ -988,9 +972,9 @@ module Orb
|
|
988
972
|
# For custom cadence: specifies the duration of the billing period in days or
|
989
973
|
# months.
|
990
974
|
#
|
991
|
-
# @return [Orb::
|
975
|
+
# @return [Orb::PlanCreateParams::Price::Tiered::BillingCycleConfiguration, nil]
|
992
976
|
optional :billing_cycle_configuration,
|
993
|
-
-> { Orb::
|
977
|
+
-> { Orb::PlanCreateParams::Price::Tiered::BillingCycleConfiguration },
|
994
978
|
nil?: true
|
995
979
|
|
996
980
|
# @!attribute conversion_rate
|
@@ -1029,9 +1013,9 @@ module Orb
|
|
1029
1013
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
1030
1014
|
# If unspecified, a single invoice is produced per billing cycle.
|
1031
1015
|
#
|
1032
|
-
# @return [Orb::
|
1016
|
+
# @return [Orb::PlanCreateParams::Price::Tiered::InvoicingCycleConfiguration, nil]
|
1033
1017
|
optional :invoicing_cycle_configuration,
|
1034
|
-
-> { Orb::
|
1018
|
+
-> { Orb::PlanCreateParams::Price::Tiered::InvoicingCycleConfiguration },
|
1035
1019
|
nil?: true
|
1036
1020
|
|
1037
1021
|
# @!attribute metadata
|
@@ -1044,48 +1028,41 @@ module Orb
|
|
1044
1028
|
|
1045
1029
|
# @!method initialize(cadence:, item_id:, name:, tiered_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :tiered)
|
1046
1030
|
# Some parameter documentations has been truncated, see
|
1047
|
-
# {Orb::
|
1031
|
+
# {Orb::PlanCreateParams::Price::Tiered} for more details.
|
1048
1032
|
#
|
1049
|
-
# @param cadence [Symbol, Orb::
|
1033
|
+
# @param cadence [Symbol, Orb::PlanCreateParams::Price::Tiered::Cadence] The cadence to bill for this price on.
|
1050
1034
|
#
|
1051
1035
|
# @param item_id [String] The id of the item the price will be associated with.
|
1052
1036
|
#
|
1053
1037
|
# @param name [String] The name of the price.
|
1054
1038
|
#
|
1055
|
-
# @param tiered_config [Orb::
|
1039
|
+
# @param tiered_config [Orb::PlanCreateParams::Price::Tiered::TieredConfig]
|
1056
1040
|
#
|
1057
1041
|
# @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b
|
1058
|
-
# ...
|
1059
1042
|
#
|
1060
1043
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
1061
|
-
# ...
|
1062
1044
|
#
|
1063
|
-
# @param billing_cycle_configuration [Orb::
|
1064
|
-
# ...
|
1045
|
+
# @param billing_cycle_configuration [Orb::PlanCreateParams::Price::Tiered::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
1065
1046
|
#
|
1066
1047
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
1067
1048
|
#
|
1068
1049
|
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
1069
|
-
# ...
|
1070
1050
|
#
|
1071
1051
|
# @param external_price_id [String, nil] An alias for the price.
|
1072
1052
|
#
|
1073
1053
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
1074
|
-
# ...
|
1075
1054
|
#
|
1076
1055
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
1077
1056
|
#
|
1078
|
-
# @param invoicing_cycle_configuration [Orb::
|
1079
|
-
# ...
|
1057
|
+
# @param invoicing_cycle_configuration [Orb::PlanCreateParams::Price::Tiered::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
1080
1058
|
#
|
1081
1059
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
1082
|
-
# ...
|
1083
1060
|
#
|
1084
1061
|
# @param model_type [Symbol, :tiered]
|
1085
1062
|
|
1086
1063
|
# The cadence to bill for this price on.
|
1087
1064
|
#
|
1088
|
-
# @see Orb::
|
1065
|
+
# @see Orb::PlanCreateParams::Price::Tiered#cadence
|
1089
1066
|
module Cadence
|
1090
1067
|
extend Orb::Internal::Type::Enum
|
1091
1068
|
|
@@ -1100,17 +1077,19 @@ module Orb
|
|
1100
1077
|
# @return [Array<Symbol>]
|
1101
1078
|
end
|
1102
1079
|
|
1103
|
-
# @see Orb::
|
1080
|
+
# @see Orb::PlanCreateParams::Price::Tiered#tiered_config
|
1104
1081
|
class TieredConfig < Orb::Internal::Type::BaseModel
|
1105
1082
|
# @!attribute tiers
|
1106
1083
|
# Tiers for rating based on total usage quantities into the specified tier
|
1107
1084
|
#
|
1108
|
-
# @return [Array<Orb::
|
1085
|
+
# @return [Array<Orb::PlanCreateParams::Price::Tiered::TieredConfig::Tier>]
|
1109
1086
|
required :tiers,
|
1110
|
-
-> {
|
1087
|
+
-> {
|
1088
|
+
Orb::Internal::Type::ArrayOf[Orb::PlanCreateParams::Price::Tiered::TieredConfig::Tier]
|
1089
|
+
}
|
1111
1090
|
|
1112
1091
|
# @!method initialize(tiers:)
|
1113
|
-
# @param tiers [Array<Orb::
|
1092
|
+
# @param tiers [Array<Orb::PlanCreateParams::Price::Tiered::TieredConfig::Tier>] Tiers for rating based on total usage quantities into the specified tier
|
1114
1093
|
|
1115
1094
|
class Tier < Orb::Internal::Type::BaseModel
|
1116
1095
|
# @!attribute first_unit
|
@@ -1140,7 +1119,7 @@ module Orb
|
|
1140
1119
|
end
|
1141
1120
|
end
|
1142
1121
|
|
1143
|
-
# @see Orb::
|
1122
|
+
# @see Orb::PlanCreateParams::Price::Tiered#billing_cycle_configuration
|
1144
1123
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
1145
1124
|
# @!attribute duration
|
1146
1125
|
# The duration of the billing period.
|
@@ -1151,9 +1130,11 @@ module Orb
|
|
1151
1130
|
# @!attribute duration_unit
|
1152
1131
|
# The unit of billing period duration.
|
1153
1132
|
#
|
1154
|
-
# @return [Symbol, Orb::
|
1133
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::Tiered::BillingCycleConfiguration::DurationUnit]
|
1155
1134
|
required :duration_unit,
|
1156
|
-
enum: -> {
|
1135
|
+
enum: -> {
|
1136
|
+
Orb::PlanCreateParams::Price::Tiered::BillingCycleConfiguration::DurationUnit
|
1137
|
+
}
|
1157
1138
|
|
1158
1139
|
# @!method initialize(duration:, duration_unit:)
|
1159
1140
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -1161,11 +1142,11 @@ module Orb
|
|
1161
1142
|
#
|
1162
1143
|
# @param duration [Integer] The duration of the billing period.
|
1163
1144
|
#
|
1164
|
-
# @param duration_unit [Symbol, Orb::
|
1145
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::Tiered::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
1165
1146
|
|
1166
1147
|
# The unit of billing period duration.
|
1167
1148
|
#
|
1168
|
-
# @see Orb::
|
1149
|
+
# @see Orb::PlanCreateParams::Price::Tiered::BillingCycleConfiguration#duration_unit
|
1169
1150
|
module DurationUnit
|
1170
1151
|
extend Orb::Internal::Type::Enum
|
1171
1152
|
|
@@ -1177,7 +1158,7 @@ module Orb
|
|
1177
1158
|
end
|
1178
1159
|
end
|
1179
1160
|
|
1180
|
-
# @see Orb::
|
1161
|
+
# @see Orb::PlanCreateParams::Price::Tiered#invoicing_cycle_configuration
|
1181
1162
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
1182
1163
|
# @!attribute duration
|
1183
1164
|
# The duration of the billing period.
|
@@ -1188,9 +1169,11 @@ module Orb
|
|
1188
1169
|
# @!attribute duration_unit
|
1189
1170
|
# The unit of billing period duration.
|
1190
1171
|
#
|
1191
|
-
# @return [Symbol, Orb::
|
1172
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::Tiered::InvoicingCycleConfiguration::DurationUnit]
|
1192
1173
|
required :duration_unit,
|
1193
|
-
enum: -> {
|
1174
|
+
enum: -> {
|
1175
|
+
Orb::PlanCreateParams::Price::Tiered::InvoicingCycleConfiguration::DurationUnit
|
1176
|
+
}
|
1194
1177
|
|
1195
1178
|
# @!method initialize(duration:, duration_unit:)
|
1196
1179
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
@@ -1198,11 +1181,11 @@ module Orb
|
|
1198
1181
|
#
|
1199
1182
|
# @param duration [Integer] The duration of the billing period.
|
1200
1183
|
#
|
1201
|
-
# @param duration_unit [Symbol, Orb::
|
1184
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::Tiered::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
1202
1185
|
|
1203
1186
|
# The unit of billing period duration.
|
1204
1187
|
#
|
1205
|
-
# @see Orb::
|
1188
|
+
# @see Orb::PlanCreateParams::Price::Tiered::InvoicingCycleConfiguration#duration_unit
|
1206
1189
|
module DurationUnit
|
1207
1190
|
extend Orb::Internal::Type::Enum
|
1208
1191
|
|
@@ -1219,8 +1202,8 @@ module Orb
|
|
1219
1202
|
# @!attribute cadence
|
1220
1203
|
# The cadence to bill for this price on.
|
1221
1204
|
#
|
1222
|
-
# @return [Symbol, Orb::
|
1223
|
-
required :cadence, enum: -> { Orb::
|
1205
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::TieredBps::Cadence]
|
1206
|
+
required :cadence, enum: -> { Orb::PlanCreateParams::Price::TieredBps::Cadence }
|
1224
1207
|
|
1225
1208
|
# @!attribute item_id
|
1226
1209
|
# The id of the item the price will be associated with.
|
@@ -1241,8 +1224,8 @@ module Orb
|
|
1241
1224
|
|
1242
1225
|
# @!attribute tiered_bps_config
|
1243
1226
|
#
|
1244
|
-
# @return [Orb::
|
1245
|
-
required :tiered_bps_config, -> { Orb::
|
1227
|
+
# @return [Orb::PlanCreateParams::Price::TieredBps::TieredBpsConfig]
|
1228
|
+
required :tiered_bps_config, -> { Orb::PlanCreateParams::Price::TieredBps::TieredBpsConfig }
|
1246
1229
|
|
1247
1230
|
# @!attribute billable_metric_id
|
1248
1231
|
# The id of the billable metric for the price. Only needed if the price is
|
@@ -1262,9 +1245,9 @@ module Orb
|
|
1262
1245
|
# For custom cadence: specifies the duration of the billing period in days or
|
1263
1246
|
# months.
|
1264
1247
|
#
|
1265
|
-
# @return [Orb::
|
1248
|
+
# @return [Orb::PlanCreateParams::Price::TieredBps::BillingCycleConfiguration, nil]
|
1266
1249
|
optional :billing_cycle_configuration,
|
1267
|
-
-> { Orb::
|
1250
|
+
-> { Orb::PlanCreateParams::Price::TieredBps::BillingCycleConfiguration },
|
1268
1251
|
nil?: true
|
1269
1252
|
|
1270
1253
|
# @!attribute conversion_rate
|
@@ -1303,9 +1286,9 @@ module Orb
|
|
1303
1286
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
1304
1287
|
# If unspecified, a single invoice is produced per billing cycle.
|
1305
1288
|
#
|
1306
|
-
# @return [Orb::
|
1289
|
+
# @return [Orb::PlanCreateParams::Price::TieredBps::InvoicingCycleConfiguration, nil]
|
1307
1290
|
optional :invoicing_cycle_configuration,
|
1308
|
-
-> { Orb::
|
1291
|
+
-> { Orb::PlanCreateParams::Price::TieredBps::InvoicingCycleConfiguration },
|
1309
1292
|
nil?: true
|
1310
1293
|
|
1311
1294
|
# @!attribute metadata
|
@@ -1318,48 +1301,41 @@ module Orb
|
|
1318
1301
|
|
1319
1302
|
# @!method initialize(cadence:, item_id:, name:, tiered_bps_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :tiered_bps)
|
1320
1303
|
# Some parameter documentations has been truncated, see
|
1321
|
-
# {Orb::
|
1304
|
+
# {Orb::PlanCreateParams::Price::TieredBps} for more details.
|
1322
1305
|
#
|
1323
|
-
# @param cadence [Symbol, Orb::
|
1306
|
+
# @param cadence [Symbol, Orb::PlanCreateParams::Price::TieredBps::Cadence] The cadence to bill for this price on.
|
1324
1307
|
#
|
1325
1308
|
# @param item_id [String] The id of the item the price will be associated with.
|
1326
1309
|
#
|
1327
1310
|
# @param name [String] The name of the price.
|
1328
1311
|
#
|
1329
|
-
# @param tiered_bps_config [Orb::
|
1312
|
+
# @param tiered_bps_config [Orb::PlanCreateParams::Price::TieredBps::TieredBpsConfig]
|
1330
1313
|
#
|
1331
1314
|
# @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b
|
1332
|
-
# ...
|
1333
1315
|
#
|
1334
1316
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
1335
|
-
# ...
|
1336
1317
|
#
|
1337
|
-
# @param billing_cycle_configuration [Orb::
|
1338
|
-
# ...
|
1318
|
+
# @param billing_cycle_configuration [Orb::PlanCreateParams::Price::TieredBps::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
1339
1319
|
#
|
1340
1320
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
1341
1321
|
#
|
1342
1322
|
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
1343
|
-
# ...
|
1344
1323
|
#
|
1345
1324
|
# @param external_price_id [String, nil] An alias for the price.
|
1346
1325
|
#
|
1347
1326
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
1348
|
-
# ...
|
1349
1327
|
#
|
1350
1328
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
1351
1329
|
#
|
1352
|
-
# @param invoicing_cycle_configuration [Orb::
|
1353
|
-
# ...
|
1330
|
+
# @param invoicing_cycle_configuration [Orb::PlanCreateParams::Price::TieredBps::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
1354
1331
|
#
|
1355
1332
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
1356
|
-
# ...
|
1357
1333
|
#
|
1358
1334
|
# @param model_type [Symbol, :tiered_bps]
|
1359
1335
|
|
1360
1336
|
# The cadence to bill for this price on.
|
1361
1337
|
#
|
1362
|
-
# @see Orb::
|
1338
|
+
# @see Orb::PlanCreateParams::Price::TieredBps#cadence
|
1363
1339
|
module Cadence
|
1364
1340
|
extend Orb::Internal::Type::Enum
|
1365
1341
|
|
@@ -1374,23 +1350,23 @@ module Orb
|
|
1374
1350
|
# @return [Array<Symbol>]
|
1375
1351
|
end
|
1376
1352
|
|
1377
|
-
# @see Orb::
|
1353
|
+
# @see Orb::PlanCreateParams::Price::TieredBps#tiered_bps_config
|
1378
1354
|
class TieredBpsConfig < Orb::Internal::Type::BaseModel
|
1379
1355
|
# @!attribute tiers
|
1380
1356
|
# Tiers for a Graduated BPS pricing model, where usage is bucketed into specified
|
1381
1357
|
# tiers
|
1382
1358
|
#
|
1383
|
-
# @return [Array<Orb::
|
1359
|
+
# @return [Array<Orb::PlanCreateParams::Price::TieredBps::TieredBpsConfig::Tier>]
|
1384
1360
|
required :tiers,
|
1385
|
-
-> {
|
1361
|
+
-> {
|
1362
|
+
Orb::Internal::Type::ArrayOf[Orb::PlanCreateParams::Price::TieredBps::TieredBpsConfig::Tier]
|
1363
|
+
}
|
1386
1364
|
|
1387
1365
|
# @!method initialize(tiers:)
|
1388
1366
|
# Some parameter documentations has been truncated, see
|
1389
|
-
# {Orb::
|
1390
|
-
# details.
|
1367
|
+
# {Orb::PlanCreateParams::Price::TieredBps::TieredBpsConfig} for more details.
|
1391
1368
|
#
|
1392
|
-
# @param tiers [Array<Orb::
|
1393
|
-
# ...
|
1369
|
+
# @param tiers [Array<Orb::PlanCreateParams::Price::TieredBps::TieredBpsConfig::Tier>] Tiers for a Graduated BPS pricing model, where usage is bucketed into specified
|
1394
1370
|
|
1395
1371
|
class Tier < Orb::Internal::Type::BaseModel
|
1396
1372
|
# @!attribute bps
|
@@ -1428,7 +1404,7 @@ module Orb
|
|
1428
1404
|
end
|
1429
1405
|
end
|
1430
1406
|
|
1431
|
-
# @see Orb::
|
1407
|
+
# @see Orb::PlanCreateParams::Price::TieredBps#billing_cycle_configuration
|
1432
1408
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
1433
1409
|
# @!attribute duration
|
1434
1410
|
# The duration of the billing period.
|
@@ -1439,9 +1415,11 @@ module Orb
|
|
1439
1415
|
# @!attribute duration_unit
|
1440
1416
|
# The unit of billing period duration.
|
1441
1417
|
#
|
1442
|
-
# @return [Symbol, Orb::
|
1418
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::TieredBps::BillingCycleConfiguration::DurationUnit]
|
1443
1419
|
required :duration_unit,
|
1444
|
-
enum: -> {
|
1420
|
+
enum: -> {
|
1421
|
+
Orb::PlanCreateParams::Price::TieredBps::BillingCycleConfiguration::DurationUnit
|
1422
|
+
}
|
1445
1423
|
|
1446
1424
|
# @!method initialize(duration:, duration_unit:)
|
1447
1425
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -1449,11 +1427,11 @@ module Orb
|
|
1449
1427
|
#
|
1450
1428
|
# @param duration [Integer] The duration of the billing period.
|
1451
1429
|
#
|
1452
|
-
# @param duration_unit [Symbol, Orb::
|
1430
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::TieredBps::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
1453
1431
|
|
1454
1432
|
# The unit of billing period duration.
|
1455
1433
|
#
|
1456
|
-
# @see Orb::
|
1434
|
+
# @see Orb::PlanCreateParams::Price::TieredBps::BillingCycleConfiguration#duration_unit
|
1457
1435
|
module DurationUnit
|
1458
1436
|
extend Orb::Internal::Type::Enum
|
1459
1437
|
|
@@ -1465,7 +1443,7 @@ module Orb
|
|
1465
1443
|
end
|
1466
1444
|
end
|
1467
1445
|
|
1468
|
-
# @see Orb::
|
1446
|
+
# @see Orb::PlanCreateParams::Price::TieredBps#invoicing_cycle_configuration
|
1469
1447
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
1470
1448
|
# @!attribute duration
|
1471
1449
|
# The duration of the billing period.
|
@@ -1476,9 +1454,11 @@ module Orb
|
|
1476
1454
|
# @!attribute duration_unit
|
1477
1455
|
# The unit of billing period duration.
|
1478
1456
|
#
|
1479
|
-
# @return [Symbol, Orb::
|
1457
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::TieredBps::InvoicingCycleConfiguration::DurationUnit]
|
1480
1458
|
required :duration_unit,
|
1481
|
-
enum: -> {
|
1459
|
+
enum: -> {
|
1460
|
+
Orb::PlanCreateParams::Price::TieredBps::InvoicingCycleConfiguration::DurationUnit
|
1461
|
+
}
|
1482
1462
|
|
1483
1463
|
# @!method initialize(duration:, duration_unit:)
|
1484
1464
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
@@ -1486,11 +1466,11 @@ module Orb
|
|
1486
1466
|
#
|
1487
1467
|
# @param duration [Integer] The duration of the billing period.
|
1488
1468
|
#
|
1489
|
-
# @param duration_unit [Symbol, Orb::
|
1469
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::TieredBps::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
1490
1470
|
|
1491
1471
|
# The unit of billing period duration.
|
1492
1472
|
#
|
1493
|
-
# @see Orb::
|
1473
|
+
# @see Orb::PlanCreateParams::Price::TieredBps::InvoicingCycleConfiguration#duration_unit
|
1494
1474
|
module DurationUnit
|
1495
1475
|
extend Orb::Internal::Type::Enum
|
1496
1476
|
|
@@ -1506,14 +1486,14 @@ module Orb
|
|
1506
1486
|
class Bps < Orb::Internal::Type::BaseModel
|
1507
1487
|
# @!attribute bps_config
|
1508
1488
|
#
|
1509
|
-
# @return [Orb::
|
1510
|
-
required :bps_config, -> { Orb::
|
1489
|
+
# @return [Orb::PlanCreateParams::Price::Bps::BpsConfig]
|
1490
|
+
required :bps_config, -> { Orb::PlanCreateParams::Price::Bps::BpsConfig }
|
1511
1491
|
|
1512
1492
|
# @!attribute cadence
|
1513
1493
|
# The cadence to bill for this price on.
|
1514
1494
|
#
|
1515
|
-
# @return [Symbol, Orb::
|
1516
|
-
required :cadence, enum: -> { Orb::
|
1495
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::Bps::Cadence]
|
1496
|
+
required :cadence, enum: -> { Orb::PlanCreateParams::Price::Bps::Cadence }
|
1517
1497
|
|
1518
1498
|
# @!attribute item_id
|
1519
1499
|
# The id of the item the price will be associated with.
|
@@ -1550,9 +1530,9 @@ module Orb
|
|
1550
1530
|
# For custom cadence: specifies the duration of the billing period in days or
|
1551
1531
|
# months.
|
1552
1532
|
#
|
1553
|
-
# @return [Orb::
|
1533
|
+
# @return [Orb::PlanCreateParams::Price::Bps::BillingCycleConfiguration, nil]
|
1554
1534
|
optional :billing_cycle_configuration,
|
1555
|
-
-> { Orb::
|
1535
|
+
-> { Orb::PlanCreateParams::Price::Bps::BillingCycleConfiguration },
|
1556
1536
|
nil?: true
|
1557
1537
|
|
1558
1538
|
# @!attribute conversion_rate
|
@@ -1591,9 +1571,9 @@ module Orb
|
|
1591
1571
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
1592
1572
|
# If unspecified, a single invoice is produced per billing cycle.
|
1593
1573
|
#
|
1594
|
-
# @return [Orb::
|
1574
|
+
# @return [Orb::PlanCreateParams::Price::Bps::InvoicingCycleConfiguration, nil]
|
1595
1575
|
optional :invoicing_cycle_configuration,
|
1596
|
-
-> { Orb::
|
1576
|
+
-> { Orb::PlanCreateParams::Price::Bps::InvoicingCycleConfiguration },
|
1597
1577
|
nil?: true
|
1598
1578
|
|
1599
1579
|
# @!attribute metadata
|
@@ -1606,46 +1586,39 @@ module Orb
|
|
1606
1586
|
|
1607
1587
|
# @!method initialize(bps_config:, cadence:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :bps)
|
1608
1588
|
# Some parameter documentations has been truncated, see
|
1609
|
-
# {Orb::
|
1589
|
+
# {Orb::PlanCreateParams::Price::Bps} for more details.
|
1610
1590
|
#
|
1611
|
-
# @param bps_config [Orb::
|
1591
|
+
# @param bps_config [Orb::PlanCreateParams::Price::Bps::BpsConfig]
|
1612
1592
|
#
|
1613
|
-
# @param cadence [Symbol, Orb::
|
1593
|
+
# @param cadence [Symbol, Orb::PlanCreateParams::Price::Bps::Cadence] The cadence to bill for this price on.
|
1614
1594
|
#
|
1615
1595
|
# @param item_id [String] The id of the item the price will be associated with.
|
1616
1596
|
#
|
1617
1597
|
# @param name [String] The name of the price.
|
1618
1598
|
#
|
1619
1599
|
# @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b
|
1620
|
-
# ...
|
1621
1600
|
#
|
1622
1601
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
1623
|
-
# ...
|
1624
1602
|
#
|
1625
|
-
# @param billing_cycle_configuration [Orb::
|
1626
|
-
# ...
|
1603
|
+
# @param billing_cycle_configuration [Orb::PlanCreateParams::Price::Bps::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
1627
1604
|
#
|
1628
1605
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
1629
1606
|
#
|
1630
1607
|
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
1631
|
-
# ...
|
1632
1608
|
#
|
1633
1609
|
# @param external_price_id [String, nil] An alias for the price.
|
1634
1610
|
#
|
1635
1611
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
1636
|
-
# ...
|
1637
1612
|
#
|
1638
1613
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
1639
1614
|
#
|
1640
|
-
# @param invoicing_cycle_configuration [Orb::
|
1641
|
-
# ...
|
1615
|
+
# @param invoicing_cycle_configuration [Orb::PlanCreateParams::Price::Bps::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
1642
1616
|
#
|
1643
1617
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
1644
|
-
# ...
|
1645
1618
|
#
|
1646
1619
|
# @param model_type [Symbol, :bps]
|
1647
1620
|
|
1648
|
-
# @see Orb::
|
1621
|
+
# @see Orb::PlanCreateParams::Price::Bps#bps_config
|
1649
1622
|
class BpsConfig < Orb::Internal::Type::BaseModel
|
1650
1623
|
# @!attribute bps
|
1651
1624
|
# Basis point take rate per event
|
@@ -1667,7 +1640,7 @@ module Orb
|
|
1667
1640
|
|
1668
1641
|
# The cadence to bill for this price on.
|
1669
1642
|
#
|
1670
|
-
# @see Orb::
|
1643
|
+
# @see Orb::PlanCreateParams::Price::Bps#cadence
|
1671
1644
|
module Cadence
|
1672
1645
|
extend Orb::Internal::Type::Enum
|
1673
1646
|
|
@@ -1682,7 +1655,7 @@ module Orb
|
|
1682
1655
|
# @return [Array<Symbol>]
|
1683
1656
|
end
|
1684
1657
|
|
1685
|
-
# @see Orb::
|
1658
|
+
# @see Orb::PlanCreateParams::Price::Bps#billing_cycle_configuration
|
1686
1659
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
1687
1660
|
# @!attribute duration
|
1688
1661
|
# The duration of the billing period.
|
@@ -1693,9 +1666,9 @@ module Orb
|
|
1693
1666
|
# @!attribute duration_unit
|
1694
1667
|
# The unit of billing period duration.
|
1695
1668
|
#
|
1696
|
-
# @return [Symbol, Orb::
|
1669
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::Bps::BillingCycleConfiguration::DurationUnit]
|
1697
1670
|
required :duration_unit,
|
1698
|
-
enum: -> { Orb::
|
1671
|
+
enum: -> { Orb::PlanCreateParams::Price::Bps::BillingCycleConfiguration::DurationUnit }
|
1699
1672
|
|
1700
1673
|
# @!method initialize(duration:, duration_unit:)
|
1701
1674
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -1703,11 +1676,11 @@ module Orb
|
|
1703
1676
|
#
|
1704
1677
|
# @param duration [Integer] The duration of the billing period.
|
1705
1678
|
#
|
1706
|
-
# @param duration_unit [Symbol, Orb::
|
1679
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::Bps::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
1707
1680
|
|
1708
1681
|
# The unit of billing period duration.
|
1709
1682
|
#
|
1710
|
-
# @see Orb::
|
1683
|
+
# @see Orb::PlanCreateParams::Price::Bps::BillingCycleConfiguration#duration_unit
|
1711
1684
|
module DurationUnit
|
1712
1685
|
extend Orb::Internal::Type::Enum
|
1713
1686
|
|
@@ -1719,7 +1692,7 @@ module Orb
|
|
1719
1692
|
end
|
1720
1693
|
end
|
1721
1694
|
|
1722
|
-
# @see Orb::
|
1695
|
+
# @see Orb::PlanCreateParams::Price::Bps#invoicing_cycle_configuration
|
1723
1696
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
1724
1697
|
# @!attribute duration
|
1725
1698
|
# The duration of the billing period.
|
@@ -1730,9 +1703,9 @@ module Orb
|
|
1730
1703
|
# @!attribute duration_unit
|
1731
1704
|
# The unit of billing period duration.
|
1732
1705
|
#
|
1733
|
-
# @return [Symbol, Orb::
|
1706
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::Bps::InvoicingCycleConfiguration::DurationUnit]
|
1734
1707
|
required :duration_unit,
|
1735
|
-
enum: -> { Orb::
|
1708
|
+
enum: -> { Orb::PlanCreateParams::Price::Bps::InvoicingCycleConfiguration::DurationUnit }
|
1736
1709
|
|
1737
1710
|
# @!method initialize(duration:, duration_unit:)
|
1738
1711
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
@@ -1740,11 +1713,11 @@ module Orb
|
|
1740
1713
|
#
|
1741
1714
|
# @param duration [Integer] The duration of the billing period.
|
1742
1715
|
#
|
1743
|
-
# @param duration_unit [Symbol, Orb::
|
1716
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::Bps::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
1744
1717
|
|
1745
1718
|
# The unit of billing period duration.
|
1746
1719
|
#
|
1747
|
-
# @see Orb::
|
1720
|
+
# @see Orb::PlanCreateParams::Price::Bps::InvoicingCycleConfiguration#duration_unit
|
1748
1721
|
module DurationUnit
|
1749
1722
|
extend Orb::Internal::Type::Enum
|
1750
1723
|
|
@@ -1760,14 +1733,14 @@ module Orb
|
|
1760
1733
|
class BulkBps < Orb::Internal::Type::BaseModel
|
1761
1734
|
# @!attribute bulk_bps_config
|
1762
1735
|
#
|
1763
|
-
# @return [Orb::
|
1764
|
-
required :bulk_bps_config, -> { Orb::
|
1736
|
+
# @return [Orb::PlanCreateParams::Price::BulkBps::BulkBpsConfig]
|
1737
|
+
required :bulk_bps_config, -> { Orb::PlanCreateParams::Price::BulkBps::BulkBpsConfig }
|
1765
1738
|
|
1766
1739
|
# @!attribute cadence
|
1767
1740
|
# The cadence to bill for this price on.
|
1768
1741
|
#
|
1769
|
-
# @return [Symbol, Orb::
|
1770
|
-
required :cadence, enum: -> { Orb::
|
1742
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::BulkBps::Cadence]
|
1743
|
+
required :cadence, enum: -> { Orb::PlanCreateParams::Price::BulkBps::Cadence }
|
1771
1744
|
|
1772
1745
|
# @!attribute item_id
|
1773
1746
|
# The id of the item the price will be associated with.
|
@@ -1804,9 +1777,9 @@ module Orb
|
|
1804
1777
|
# For custom cadence: specifies the duration of the billing period in days or
|
1805
1778
|
# months.
|
1806
1779
|
#
|
1807
|
-
# @return [Orb::
|
1780
|
+
# @return [Orb::PlanCreateParams::Price::BulkBps::BillingCycleConfiguration, nil]
|
1808
1781
|
optional :billing_cycle_configuration,
|
1809
|
-
-> { Orb::
|
1782
|
+
-> { Orb::PlanCreateParams::Price::BulkBps::BillingCycleConfiguration },
|
1810
1783
|
nil?: true
|
1811
1784
|
|
1812
1785
|
# @!attribute conversion_rate
|
@@ -1845,9 +1818,9 @@ module Orb
|
|
1845
1818
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
1846
1819
|
# If unspecified, a single invoice is produced per billing cycle.
|
1847
1820
|
#
|
1848
|
-
# @return [Orb::
|
1821
|
+
# @return [Orb::PlanCreateParams::Price::BulkBps::InvoicingCycleConfiguration, nil]
|
1849
1822
|
optional :invoicing_cycle_configuration,
|
1850
|
-
-> { Orb::
|
1823
|
+
-> { Orb::PlanCreateParams::Price::BulkBps::InvoicingCycleConfiguration },
|
1851
1824
|
nil?: true
|
1852
1825
|
|
1853
1826
|
# @!attribute metadata
|
@@ -1860,61 +1833,55 @@ module Orb
|
|
1860
1833
|
|
1861
1834
|
# @!method initialize(bulk_bps_config:, cadence:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :bulk_bps)
|
1862
1835
|
# Some parameter documentations has been truncated, see
|
1863
|
-
# {Orb::
|
1836
|
+
# {Orb::PlanCreateParams::Price::BulkBps} for more details.
|
1864
1837
|
#
|
1865
|
-
# @param bulk_bps_config [Orb::
|
1838
|
+
# @param bulk_bps_config [Orb::PlanCreateParams::Price::BulkBps::BulkBpsConfig]
|
1866
1839
|
#
|
1867
|
-
# @param cadence [Symbol, Orb::
|
1840
|
+
# @param cadence [Symbol, Orb::PlanCreateParams::Price::BulkBps::Cadence] The cadence to bill for this price on.
|
1868
1841
|
#
|
1869
1842
|
# @param item_id [String] The id of the item the price will be associated with.
|
1870
1843
|
#
|
1871
1844
|
# @param name [String] The name of the price.
|
1872
1845
|
#
|
1873
1846
|
# @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b
|
1874
|
-
# ...
|
1875
1847
|
#
|
1876
1848
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
1877
|
-
# ...
|
1878
1849
|
#
|
1879
|
-
# @param billing_cycle_configuration [Orb::
|
1880
|
-
# ...
|
1850
|
+
# @param billing_cycle_configuration [Orb::PlanCreateParams::Price::BulkBps::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
1881
1851
|
#
|
1882
1852
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
1883
1853
|
#
|
1884
1854
|
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
1885
|
-
# ...
|
1886
1855
|
#
|
1887
1856
|
# @param external_price_id [String, nil] An alias for the price.
|
1888
1857
|
#
|
1889
1858
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
1890
|
-
# ...
|
1891
1859
|
#
|
1892
1860
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
1893
1861
|
#
|
1894
|
-
# @param invoicing_cycle_configuration [Orb::
|
1895
|
-
# ...
|
1862
|
+
# @param invoicing_cycle_configuration [Orb::PlanCreateParams::Price::BulkBps::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
1896
1863
|
#
|
1897
1864
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
1898
|
-
# ...
|
1899
1865
|
#
|
1900
1866
|
# @param model_type [Symbol, :bulk_bps]
|
1901
1867
|
|
1902
|
-
# @see Orb::
|
1868
|
+
# @see Orb::PlanCreateParams::Price::BulkBps#bulk_bps_config
|
1903
1869
|
class BulkBpsConfig < Orb::Internal::Type::BaseModel
|
1904
1870
|
# @!attribute tiers
|
1905
1871
|
# Tiers for a bulk BPS pricing model where all usage is aggregated to a single
|
1906
1872
|
# tier based on total volume
|
1907
1873
|
#
|
1908
|
-
# @return [Array<Orb::
|
1874
|
+
# @return [Array<Orb::PlanCreateParams::Price::BulkBps::BulkBpsConfig::Tier>]
|
1909
1875
|
required :tiers,
|
1910
|
-
-> {
|
1876
|
+
-> {
|
1877
|
+
Orb::Internal::Type::ArrayOf[Orb::PlanCreateParams::Price::BulkBps::BulkBpsConfig::Tier]
|
1878
|
+
}
|
1911
1879
|
|
1912
1880
|
# @!method initialize(tiers:)
|
1913
1881
|
# Some parameter documentations has been truncated, see
|
1914
|
-
# {Orb::
|
1882
|
+
# {Orb::PlanCreateParams::Price::BulkBps::BulkBpsConfig} for more details.
|
1915
1883
|
#
|
1916
|
-
# @param tiers [Array<Orb::
|
1917
|
-
# ...
|
1884
|
+
# @param tiers [Array<Orb::PlanCreateParams::Price::BulkBps::BulkBpsConfig::Tier>] Tiers for a bulk BPS pricing model where all usage is aggregated to a single tie
|
1918
1885
|
|
1919
1886
|
class Tier < Orb::Internal::Type::BaseModel
|
1920
1887
|
# @!attribute bps
|
@@ -1946,7 +1913,7 @@ module Orb
|
|
1946
1913
|
|
1947
1914
|
# The cadence to bill for this price on.
|
1948
1915
|
#
|
1949
|
-
# @see Orb::
|
1916
|
+
# @see Orb::PlanCreateParams::Price::BulkBps#cadence
|
1950
1917
|
module Cadence
|
1951
1918
|
extend Orb::Internal::Type::Enum
|
1952
1919
|
|
@@ -1961,7 +1928,7 @@ module Orb
|
|
1961
1928
|
# @return [Array<Symbol>]
|
1962
1929
|
end
|
1963
1930
|
|
1964
|
-
# @see Orb::
|
1931
|
+
# @see Orb::PlanCreateParams::Price::BulkBps#billing_cycle_configuration
|
1965
1932
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
1966
1933
|
# @!attribute duration
|
1967
1934
|
# The duration of the billing period.
|
@@ -1972,9 +1939,11 @@ module Orb
|
|
1972
1939
|
# @!attribute duration_unit
|
1973
1940
|
# The unit of billing period duration.
|
1974
1941
|
#
|
1975
|
-
# @return [Symbol, Orb::
|
1942
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::BulkBps::BillingCycleConfiguration::DurationUnit]
|
1976
1943
|
required :duration_unit,
|
1977
|
-
enum: -> {
|
1944
|
+
enum: -> {
|
1945
|
+
Orb::PlanCreateParams::Price::BulkBps::BillingCycleConfiguration::DurationUnit
|
1946
|
+
}
|
1978
1947
|
|
1979
1948
|
# @!method initialize(duration:, duration_unit:)
|
1980
1949
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -1982,11 +1951,11 @@ module Orb
|
|
1982
1951
|
#
|
1983
1952
|
# @param duration [Integer] The duration of the billing period.
|
1984
1953
|
#
|
1985
|
-
# @param duration_unit [Symbol, Orb::
|
1954
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::BulkBps::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
1986
1955
|
|
1987
1956
|
# The unit of billing period duration.
|
1988
1957
|
#
|
1989
|
-
# @see Orb::
|
1958
|
+
# @see Orb::PlanCreateParams::Price::BulkBps::BillingCycleConfiguration#duration_unit
|
1990
1959
|
module DurationUnit
|
1991
1960
|
extend Orb::Internal::Type::Enum
|
1992
1961
|
|
@@ -1998,7 +1967,7 @@ module Orb
|
|
1998
1967
|
end
|
1999
1968
|
end
|
2000
1969
|
|
2001
|
-
# @see Orb::
|
1970
|
+
# @see Orb::PlanCreateParams::Price::BulkBps#invoicing_cycle_configuration
|
2002
1971
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
2003
1972
|
# @!attribute duration
|
2004
1973
|
# The duration of the billing period.
|
@@ -2009,9 +1978,11 @@ module Orb
|
|
2009
1978
|
# @!attribute duration_unit
|
2010
1979
|
# The unit of billing period duration.
|
2011
1980
|
#
|
2012
|
-
# @return [Symbol, Orb::
|
1981
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::BulkBps::InvoicingCycleConfiguration::DurationUnit]
|
2013
1982
|
required :duration_unit,
|
2014
|
-
enum: -> {
|
1983
|
+
enum: -> {
|
1984
|
+
Orb::PlanCreateParams::Price::BulkBps::InvoicingCycleConfiguration::DurationUnit
|
1985
|
+
}
|
2015
1986
|
|
2016
1987
|
# @!method initialize(duration:, duration_unit:)
|
2017
1988
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
@@ -2019,11 +1990,11 @@ module Orb
|
|
2019
1990
|
#
|
2020
1991
|
# @param duration [Integer] The duration of the billing period.
|
2021
1992
|
#
|
2022
|
-
# @param duration_unit [Symbol, Orb::
|
1993
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::BulkBps::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
2023
1994
|
|
2024
1995
|
# The unit of billing period duration.
|
2025
1996
|
#
|
2026
|
-
# @see Orb::
|
1997
|
+
# @see Orb::PlanCreateParams::Price::BulkBps::InvoicingCycleConfiguration#duration_unit
|
2027
1998
|
module DurationUnit
|
2028
1999
|
extend Orb::Internal::Type::Enum
|
2029
2000
|
|
@@ -2039,14 +2010,14 @@ module Orb
|
|
2039
2010
|
class Bulk < Orb::Internal::Type::BaseModel
|
2040
2011
|
# @!attribute bulk_config
|
2041
2012
|
#
|
2042
|
-
# @return [Orb::
|
2043
|
-
required :bulk_config, -> { Orb::
|
2013
|
+
# @return [Orb::PlanCreateParams::Price::Bulk::BulkConfig]
|
2014
|
+
required :bulk_config, -> { Orb::PlanCreateParams::Price::Bulk::BulkConfig }
|
2044
2015
|
|
2045
2016
|
# @!attribute cadence
|
2046
2017
|
# The cadence to bill for this price on.
|
2047
2018
|
#
|
2048
|
-
# @return [Symbol, Orb::
|
2049
|
-
required :cadence, enum: -> { Orb::
|
2019
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::Bulk::Cadence]
|
2020
|
+
required :cadence, enum: -> { Orb::PlanCreateParams::Price::Bulk::Cadence }
|
2050
2021
|
|
2051
2022
|
# @!attribute item_id
|
2052
2023
|
# The id of the item the price will be associated with.
|
@@ -2083,9 +2054,9 @@ module Orb
|
|
2083
2054
|
# For custom cadence: specifies the duration of the billing period in days or
|
2084
2055
|
# months.
|
2085
2056
|
#
|
2086
|
-
# @return [Orb::
|
2057
|
+
# @return [Orb::PlanCreateParams::Price::Bulk::BillingCycleConfiguration, nil]
|
2087
2058
|
optional :billing_cycle_configuration,
|
2088
|
-
-> { Orb::
|
2059
|
+
-> { Orb::PlanCreateParams::Price::Bulk::BillingCycleConfiguration },
|
2089
2060
|
nil?: true
|
2090
2061
|
|
2091
2062
|
# @!attribute conversion_rate
|
@@ -2124,9 +2095,9 @@ module Orb
|
|
2124
2095
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
2125
2096
|
# If unspecified, a single invoice is produced per billing cycle.
|
2126
2097
|
#
|
2127
|
-
# @return [Orb::
|
2098
|
+
# @return [Orb::PlanCreateParams::Price::Bulk::InvoicingCycleConfiguration, nil]
|
2128
2099
|
optional :invoicing_cycle_configuration,
|
2129
|
-
-> { Orb::
|
2100
|
+
-> { Orb::PlanCreateParams::Price::Bulk::InvoicingCycleConfiguration },
|
2130
2101
|
nil?: true
|
2131
2102
|
|
2132
2103
|
# @!attribute metadata
|
@@ -2139,56 +2110,51 @@ module Orb
|
|
2139
2110
|
|
2140
2111
|
# @!method initialize(bulk_config:, cadence:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :bulk)
|
2141
2112
|
# Some parameter documentations has been truncated, see
|
2142
|
-
# {Orb::
|
2113
|
+
# {Orb::PlanCreateParams::Price::Bulk} for more details.
|
2143
2114
|
#
|
2144
|
-
# @param bulk_config [Orb::
|
2115
|
+
# @param bulk_config [Orb::PlanCreateParams::Price::Bulk::BulkConfig]
|
2145
2116
|
#
|
2146
|
-
# @param cadence [Symbol, Orb::
|
2117
|
+
# @param cadence [Symbol, Orb::PlanCreateParams::Price::Bulk::Cadence] The cadence to bill for this price on.
|
2147
2118
|
#
|
2148
2119
|
# @param item_id [String] The id of the item the price will be associated with.
|
2149
2120
|
#
|
2150
2121
|
# @param name [String] The name of the price.
|
2151
2122
|
#
|
2152
2123
|
# @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b
|
2153
|
-
# ...
|
2154
2124
|
#
|
2155
2125
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
2156
|
-
# ...
|
2157
2126
|
#
|
2158
|
-
# @param billing_cycle_configuration [Orb::
|
2159
|
-
# ...
|
2127
|
+
# @param billing_cycle_configuration [Orb::PlanCreateParams::Price::Bulk::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
2160
2128
|
#
|
2161
2129
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
2162
2130
|
#
|
2163
2131
|
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
2164
|
-
# ...
|
2165
2132
|
#
|
2166
2133
|
# @param external_price_id [String, nil] An alias for the price.
|
2167
2134
|
#
|
2168
2135
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
2169
|
-
# ...
|
2170
2136
|
#
|
2171
2137
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
2172
2138
|
#
|
2173
|
-
# @param invoicing_cycle_configuration [Orb::
|
2174
|
-
# ...
|
2139
|
+
# @param invoicing_cycle_configuration [Orb::PlanCreateParams::Price::Bulk::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
2175
2140
|
#
|
2176
2141
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
2177
|
-
# ...
|
2178
2142
|
#
|
2179
2143
|
# @param model_type [Symbol, :bulk]
|
2180
2144
|
|
2181
|
-
# @see Orb::
|
2145
|
+
# @see Orb::PlanCreateParams::Price::Bulk#bulk_config
|
2182
2146
|
class BulkConfig < Orb::Internal::Type::BaseModel
|
2183
2147
|
# @!attribute tiers
|
2184
2148
|
# Bulk tiers for rating based on total usage volume
|
2185
2149
|
#
|
2186
|
-
# @return [Array<Orb::
|
2150
|
+
# @return [Array<Orb::PlanCreateParams::Price::Bulk::BulkConfig::Tier>]
|
2187
2151
|
required :tiers,
|
2188
|
-
-> {
|
2152
|
+
-> {
|
2153
|
+
Orb::Internal::Type::ArrayOf[Orb::PlanCreateParams::Price::Bulk::BulkConfig::Tier]
|
2154
|
+
}
|
2189
2155
|
|
2190
2156
|
# @!method initialize(tiers:)
|
2191
|
-
# @param tiers [Array<Orb::
|
2157
|
+
# @param tiers [Array<Orb::PlanCreateParams::Price::Bulk::BulkConfig::Tier>] Bulk tiers for rating based on total usage volume
|
2192
2158
|
|
2193
2159
|
class Tier < Orb::Internal::Type::BaseModel
|
2194
2160
|
# @!attribute unit_amount
|
@@ -2212,7 +2178,7 @@ module Orb
|
|
2212
2178
|
|
2213
2179
|
# The cadence to bill for this price on.
|
2214
2180
|
#
|
2215
|
-
# @see Orb::
|
2181
|
+
# @see Orb::PlanCreateParams::Price::Bulk#cadence
|
2216
2182
|
module Cadence
|
2217
2183
|
extend Orb::Internal::Type::Enum
|
2218
2184
|
|
@@ -2227,7 +2193,7 @@ module Orb
|
|
2227
2193
|
# @return [Array<Symbol>]
|
2228
2194
|
end
|
2229
2195
|
|
2230
|
-
# @see Orb::
|
2196
|
+
# @see Orb::PlanCreateParams::Price::Bulk#billing_cycle_configuration
|
2231
2197
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
2232
2198
|
# @!attribute duration
|
2233
2199
|
# The duration of the billing period.
|
@@ -2238,9 +2204,9 @@ module Orb
|
|
2238
2204
|
# @!attribute duration_unit
|
2239
2205
|
# The unit of billing period duration.
|
2240
2206
|
#
|
2241
|
-
# @return [Symbol, Orb::
|
2207
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::Bulk::BillingCycleConfiguration::DurationUnit]
|
2242
2208
|
required :duration_unit,
|
2243
|
-
enum: -> { Orb::
|
2209
|
+
enum: -> { Orb::PlanCreateParams::Price::Bulk::BillingCycleConfiguration::DurationUnit }
|
2244
2210
|
|
2245
2211
|
# @!method initialize(duration:, duration_unit:)
|
2246
2212
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -2248,11 +2214,11 @@ module Orb
|
|
2248
2214
|
#
|
2249
2215
|
# @param duration [Integer] The duration of the billing period.
|
2250
2216
|
#
|
2251
|
-
# @param duration_unit [Symbol, Orb::
|
2217
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::Bulk::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
2252
2218
|
|
2253
2219
|
# The unit of billing period duration.
|
2254
2220
|
#
|
2255
|
-
# @see Orb::
|
2221
|
+
# @see Orb::PlanCreateParams::Price::Bulk::BillingCycleConfiguration#duration_unit
|
2256
2222
|
module DurationUnit
|
2257
2223
|
extend Orb::Internal::Type::Enum
|
2258
2224
|
|
@@ -2264,7 +2230,7 @@ module Orb
|
|
2264
2230
|
end
|
2265
2231
|
end
|
2266
2232
|
|
2267
|
-
# @see Orb::
|
2233
|
+
# @see Orb::PlanCreateParams::Price::Bulk#invoicing_cycle_configuration
|
2268
2234
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
2269
2235
|
# @!attribute duration
|
2270
2236
|
# The duration of the billing period.
|
@@ -2275,9 +2241,11 @@ module Orb
|
|
2275
2241
|
# @!attribute duration_unit
|
2276
2242
|
# The unit of billing period duration.
|
2277
2243
|
#
|
2278
|
-
# @return [Symbol, Orb::
|
2244
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::Bulk::InvoicingCycleConfiguration::DurationUnit]
|
2279
2245
|
required :duration_unit,
|
2280
|
-
enum: -> {
|
2246
|
+
enum: -> {
|
2247
|
+
Orb::PlanCreateParams::Price::Bulk::InvoicingCycleConfiguration::DurationUnit
|
2248
|
+
}
|
2281
2249
|
|
2282
2250
|
# @!method initialize(duration:, duration_unit:)
|
2283
2251
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
@@ -2285,11 +2253,11 @@ module Orb
|
|
2285
2253
|
#
|
2286
2254
|
# @param duration [Integer] The duration of the billing period.
|
2287
2255
|
#
|
2288
|
-
# @param duration_unit [Symbol, Orb::
|
2256
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::Bulk::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
2289
2257
|
|
2290
2258
|
# The unit of billing period duration.
|
2291
2259
|
#
|
2292
|
-
# @see Orb::
|
2260
|
+
# @see Orb::PlanCreateParams::Price::Bulk::InvoicingCycleConfiguration#duration_unit
|
2293
2261
|
module DurationUnit
|
2294
2262
|
extend Orb::Internal::Type::Enum
|
2295
2263
|
|
@@ -2306,8 +2274,8 @@ module Orb
|
|
2306
2274
|
# @!attribute cadence
|
2307
2275
|
# The cadence to bill for this price on.
|
2308
2276
|
#
|
2309
|
-
# @return [Symbol, Orb::
|
2310
|
-
required :cadence, enum: -> { Orb::
|
2277
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::ThresholdTotalAmount::Cadence]
|
2278
|
+
required :cadence, enum: -> { Orb::PlanCreateParams::Price::ThresholdTotalAmount::Cadence }
|
2311
2279
|
|
2312
2280
|
# @!attribute item_id
|
2313
2281
|
# The id of the item the price will be associated with.
|
@@ -2349,9 +2317,9 @@ module Orb
|
|
2349
2317
|
# For custom cadence: specifies the duration of the billing period in days or
|
2350
2318
|
# months.
|
2351
2319
|
#
|
2352
|
-
# @return [Orb::
|
2320
|
+
# @return [Orb::PlanCreateParams::Price::ThresholdTotalAmount::BillingCycleConfiguration, nil]
|
2353
2321
|
optional :billing_cycle_configuration,
|
2354
|
-
-> { Orb::
|
2322
|
+
-> { Orb::PlanCreateParams::Price::ThresholdTotalAmount::BillingCycleConfiguration },
|
2355
2323
|
nil?: true
|
2356
2324
|
|
2357
2325
|
# @!attribute conversion_rate
|
@@ -2390,9 +2358,9 @@ module Orb
|
|
2390
2358
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
2391
2359
|
# If unspecified, a single invoice is produced per billing cycle.
|
2392
2360
|
#
|
2393
|
-
# @return [Orb::
|
2361
|
+
# @return [Orb::PlanCreateParams::Price::ThresholdTotalAmount::InvoicingCycleConfiguration, nil]
|
2394
2362
|
optional :invoicing_cycle_configuration,
|
2395
|
-
-> { Orb::
|
2363
|
+
-> { Orb::PlanCreateParams::Price::ThresholdTotalAmount::InvoicingCycleConfiguration },
|
2396
2364
|
nil?: true
|
2397
2365
|
|
2398
2366
|
# @!attribute metadata
|
@@ -2405,9 +2373,9 @@ module Orb
|
|
2405
2373
|
|
2406
2374
|
# @!method initialize(cadence:, item_id:, name:, threshold_total_amount_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :threshold_total_amount)
|
2407
2375
|
# Some parameter documentations has been truncated, see
|
2408
|
-
# {Orb::
|
2376
|
+
# {Orb::PlanCreateParams::Price::ThresholdTotalAmount} for more details.
|
2409
2377
|
#
|
2410
|
-
# @param cadence [Symbol, Orb::
|
2378
|
+
# @param cadence [Symbol, Orb::PlanCreateParams::Price::ThresholdTotalAmount::Cadence] The cadence to bill for this price on.
|
2411
2379
|
#
|
2412
2380
|
# @param item_id [String] The id of the item the price will be associated with.
|
2413
2381
|
#
|
@@ -2416,37 +2384,30 @@ module Orb
|
|
2416
2384
|
# @param threshold_total_amount_config [Hash{Symbol=>Object}]
|
2417
2385
|
#
|
2418
2386
|
# @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b
|
2419
|
-
# ...
|
2420
2387
|
#
|
2421
2388
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
2422
|
-
# ...
|
2423
2389
|
#
|
2424
|
-
# @param billing_cycle_configuration [Orb::
|
2425
|
-
# ...
|
2390
|
+
# @param billing_cycle_configuration [Orb::PlanCreateParams::Price::ThresholdTotalAmount::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
2426
2391
|
#
|
2427
2392
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
2428
2393
|
#
|
2429
2394
|
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
2430
|
-
# ...
|
2431
2395
|
#
|
2432
2396
|
# @param external_price_id [String, nil] An alias for the price.
|
2433
2397
|
#
|
2434
2398
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
2435
|
-
# ...
|
2436
2399
|
#
|
2437
2400
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
2438
2401
|
#
|
2439
|
-
# @param invoicing_cycle_configuration [Orb::
|
2440
|
-
# ...
|
2402
|
+
# @param invoicing_cycle_configuration [Orb::PlanCreateParams::Price::ThresholdTotalAmount::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
2441
2403
|
#
|
2442
2404
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
2443
|
-
# ...
|
2444
2405
|
#
|
2445
2406
|
# @param model_type [Symbol, :threshold_total_amount]
|
2446
2407
|
|
2447
2408
|
# The cadence to bill for this price on.
|
2448
2409
|
#
|
2449
|
-
# @see Orb::
|
2410
|
+
# @see Orb::PlanCreateParams::Price::ThresholdTotalAmount#cadence
|
2450
2411
|
module Cadence
|
2451
2412
|
extend Orb::Internal::Type::Enum
|
2452
2413
|
|
@@ -2461,7 +2422,7 @@ module Orb
|
|
2461
2422
|
# @return [Array<Symbol>]
|
2462
2423
|
end
|
2463
2424
|
|
2464
|
-
# @see Orb::
|
2425
|
+
# @see Orb::PlanCreateParams::Price::ThresholdTotalAmount#billing_cycle_configuration
|
2465
2426
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
2466
2427
|
# @!attribute duration
|
2467
2428
|
# The duration of the billing period.
|
@@ -2472,9 +2433,11 @@ module Orb
|
|
2472
2433
|
# @!attribute duration_unit
|
2473
2434
|
# The unit of billing period duration.
|
2474
2435
|
#
|
2475
|
-
# @return [Symbol, Orb::
|
2436
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::ThresholdTotalAmount::BillingCycleConfiguration::DurationUnit]
|
2476
2437
|
required :duration_unit,
|
2477
|
-
enum: -> {
|
2438
|
+
enum: -> {
|
2439
|
+
Orb::PlanCreateParams::Price::ThresholdTotalAmount::BillingCycleConfiguration::DurationUnit
|
2440
|
+
}
|
2478
2441
|
|
2479
2442
|
# @!method initialize(duration:, duration_unit:)
|
2480
2443
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -2482,11 +2445,11 @@ module Orb
|
|
2482
2445
|
#
|
2483
2446
|
# @param duration [Integer] The duration of the billing period.
|
2484
2447
|
#
|
2485
|
-
# @param duration_unit [Symbol, Orb::
|
2448
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::ThresholdTotalAmount::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
2486
2449
|
|
2487
2450
|
# The unit of billing period duration.
|
2488
2451
|
#
|
2489
|
-
# @see Orb::
|
2452
|
+
# @see Orb::PlanCreateParams::Price::ThresholdTotalAmount::BillingCycleConfiguration#duration_unit
|
2490
2453
|
module DurationUnit
|
2491
2454
|
extend Orb::Internal::Type::Enum
|
2492
2455
|
|
@@ -2498,7 +2461,7 @@ module Orb
|
|
2498
2461
|
end
|
2499
2462
|
end
|
2500
2463
|
|
2501
|
-
# @see Orb::
|
2464
|
+
# @see Orb::PlanCreateParams::Price::ThresholdTotalAmount#invoicing_cycle_configuration
|
2502
2465
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
2503
2466
|
# @!attribute duration
|
2504
2467
|
# The duration of the billing period.
|
@@ -2509,9 +2472,11 @@ module Orb
|
|
2509
2472
|
# @!attribute duration_unit
|
2510
2473
|
# The unit of billing period duration.
|
2511
2474
|
#
|
2512
|
-
# @return [Symbol, Orb::
|
2475
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::ThresholdTotalAmount::InvoicingCycleConfiguration::DurationUnit]
|
2513
2476
|
required :duration_unit,
|
2514
|
-
enum: -> {
|
2477
|
+
enum: -> {
|
2478
|
+
Orb::PlanCreateParams::Price::ThresholdTotalAmount::InvoicingCycleConfiguration::DurationUnit
|
2479
|
+
}
|
2515
2480
|
|
2516
2481
|
# @!method initialize(duration:, duration_unit:)
|
2517
2482
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
@@ -2519,11 +2484,11 @@ module Orb
|
|
2519
2484
|
#
|
2520
2485
|
# @param duration [Integer] The duration of the billing period.
|
2521
2486
|
#
|
2522
|
-
# @param duration_unit [Symbol, Orb::
|
2487
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::ThresholdTotalAmount::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
2523
2488
|
|
2524
2489
|
# The unit of billing period duration.
|
2525
2490
|
#
|
2526
|
-
# @see Orb::
|
2491
|
+
# @see Orb::PlanCreateParams::Price::ThresholdTotalAmount::InvoicingCycleConfiguration#duration_unit
|
2527
2492
|
module DurationUnit
|
2528
2493
|
extend Orb::Internal::Type::Enum
|
2529
2494
|
|
@@ -2540,8 +2505,8 @@ module Orb
|
|
2540
2505
|
# @!attribute cadence
|
2541
2506
|
# The cadence to bill for this price on.
|
2542
2507
|
#
|
2543
|
-
# @return [Symbol, Orb::
|
2544
|
-
required :cadence, enum: -> { Orb::
|
2508
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::TieredPackage::Cadence]
|
2509
|
+
required :cadence, enum: -> { Orb::PlanCreateParams::Price::TieredPackage::Cadence }
|
2545
2510
|
|
2546
2511
|
# @!attribute item_id
|
2547
2512
|
# The id of the item the price will be associated with.
|
@@ -2583,9 +2548,9 @@ module Orb
|
|
2583
2548
|
# For custom cadence: specifies the duration of the billing period in days or
|
2584
2549
|
# months.
|
2585
2550
|
#
|
2586
|
-
# @return [Orb::
|
2551
|
+
# @return [Orb::PlanCreateParams::Price::TieredPackage::BillingCycleConfiguration, nil]
|
2587
2552
|
optional :billing_cycle_configuration,
|
2588
|
-
-> { Orb::
|
2553
|
+
-> { Orb::PlanCreateParams::Price::TieredPackage::BillingCycleConfiguration },
|
2589
2554
|
nil?: true
|
2590
2555
|
|
2591
2556
|
# @!attribute conversion_rate
|
@@ -2624,9 +2589,9 @@ module Orb
|
|
2624
2589
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
2625
2590
|
# If unspecified, a single invoice is produced per billing cycle.
|
2626
2591
|
#
|
2627
|
-
# @return [Orb::
|
2592
|
+
# @return [Orb::PlanCreateParams::Price::TieredPackage::InvoicingCycleConfiguration, nil]
|
2628
2593
|
optional :invoicing_cycle_configuration,
|
2629
|
-
-> { Orb::
|
2594
|
+
-> { Orb::PlanCreateParams::Price::TieredPackage::InvoicingCycleConfiguration },
|
2630
2595
|
nil?: true
|
2631
2596
|
|
2632
2597
|
# @!attribute metadata
|
@@ -2639,9 +2604,9 @@ module Orb
|
|
2639
2604
|
|
2640
2605
|
# @!method initialize(cadence:, item_id:, name:, tiered_package_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :tiered_package)
|
2641
2606
|
# Some parameter documentations has been truncated, see
|
2642
|
-
# {Orb::
|
2607
|
+
# {Orb::PlanCreateParams::Price::TieredPackage} for more details.
|
2643
2608
|
#
|
2644
|
-
# @param cadence [Symbol, Orb::
|
2609
|
+
# @param cadence [Symbol, Orb::PlanCreateParams::Price::TieredPackage::Cadence] The cadence to bill for this price on.
|
2645
2610
|
#
|
2646
2611
|
# @param item_id [String] The id of the item the price will be associated with.
|
2647
2612
|
#
|
@@ -2650,37 +2615,30 @@ module Orb
|
|
2650
2615
|
# @param tiered_package_config [Hash{Symbol=>Object}]
|
2651
2616
|
#
|
2652
2617
|
# @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b
|
2653
|
-
# ...
|
2654
2618
|
#
|
2655
2619
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
2656
|
-
# ...
|
2657
2620
|
#
|
2658
|
-
# @param billing_cycle_configuration [Orb::
|
2659
|
-
# ...
|
2621
|
+
# @param billing_cycle_configuration [Orb::PlanCreateParams::Price::TieredPackage::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
2660
2622
|
#
|
2661
2623
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
2662
2624
|
#
|
2663
2625
|
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
2664
|
-
# ...
|
2665
2626
|
#
|
2666
2627
|
# @param external_price_id [String, nil] An alias for the price.
|
2667
2628
|
#
|
2668
2629
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
2669
|
-
# ...
|
2670
2630
|
#
|
2671
2631
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
2672
2632
|
#
|
2673
|
-
# @param invoicing_cycle_configuration [Orb::
|
2674
|
-
# ...
|
2633
|
+
# @param invoicing_cycle_configuration [Orb::PlanCreateParams::Price::TieredPackage::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
2675
2634
|
#
|
2676
2635
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
2677
|
-
# ...
|
2678
2636
|
#
|
2679
2637
|
# @param model_type [Symbol, :tiered_package]
|
2680
2638
|
|
2681
2639
|
# The cadence to bill for this price on.
|
2682
2640
|
#
|
2683
|
-
# @see Orb::
|
2641
|
+
# @see Orb::PlanCreateParams::Price::TieredPackage#cadence
|
2684
2642
|
module Cadence
|
2685
2643
|
extend Orb::Internal::Type::Enum
|
2686
2644
|
|
@@ -2695,7 +2653,7 @@ module Orb
|
|
2695
2653
|
# @return [Array<Symbol>]
|
2696
2654
|
end
|
2697
2655
|
|
2698
|
-
# @see Orb::
|
2656
|
+
# @see Orb::PlanCreateParams::Price::TieredPackage#billing_cycle_configuration
|
2699
2657
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
2700
2658
|
# @!attribute duration
|
2701
2659
|
# The duration of the billing period.
|
@@ -2706,9 +2664,11 @@ module Orb
|
|
2706
2664
|
# @!attribute duration_unit
|
2707
2665
|
# The unit of billing period duration.
|
2708
2666
|
#
|
2709
|
-
# @return [Symbol, Orb::
|
2667
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::TieredPackage::BillingCycleConfiguration::DurationUnit]
|
2710
2668
|
required :duration_unit,
|
2711
|
-
enum: -> {
|
2669
|
+
enum: -> {
|
2670
|
+
Orb::PlanCreateParams::Price::TieredPackage::BillingCycleConfiguration::DurationUnit
|
2671
|
+
}
|
2712
2672
|
|
2713
2673
|
# @!method initialize(duration:, duration_unit:)
|
2714
2674
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -2716,11 +2676,11 @@ module Orb
|
|
2716
2676
|
#
|
2717
2677
|
# @param duration [Integer] The duration of the billing period.
|
2718
2678
|
#
|
2719
|
-
# @param duration_unit [Symbol, Orb::
|
2679
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::TieredPackage::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
2720
2680
|
|
2721
2681
|
# The unit of billing period duration.
|
2722
2682
|
#
|
2723
|
-
# @see Orb::
|
2683
|
+
# @see Orb::PlanCreateParams::Price::TieredPackage::BillingCycleConfiguration#duration_unit
|
2724
2684
|
module DurationUnit
|
2725
2685
|
extend Orb::Internal::Type::Enum
|
2726
2686
|
|
@@ -2732,7 +2692,7 @@ module Orb
|
|
2732
2692
|
end
|
2733
2693
|
end
|
2734
2694
|
|
2735
|
-
# @see Orb::
|
2695
|
+
# @see Orb::PlanCreateParams::Price::TieredPackage#invoicing_cycle_configuration
|
2736
2696
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
2737
2697
|
# @!attribute duration
|
2738
2698
|
# The duration of the billing period.
|
@@ -2743,9 +2703,11 @@ module Orb
|
|
2743
2703
|
# @!attribute duration_unit
|
2744
2704
|
# The unit of billing period duration.
|
2745
2705
|
#
|
2746
|
-
# @return [Symbol, Orb::
|
2706
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::TieredPackage::InvoicingCycleConfiguration::DurationUnit]
|
2747
2707
|
required :duration_unit,
|
2748
|
-
enum: -> {
|
2708
|
+
enum: -> {
|
2709
|
+
Orb::PlanCreateParams::Price::TieredPackage::InvoicingCycleConfiguration::DurationUnit
|
2710
|
+
}
|
2749
2711
|
|
2750
2712
|
# @!method initialize(duration:, duration_unit:)
|
2751
2713
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
@@ -2753,11 +2715,11 @@ module Orb
|
|
2753
2715
|
#
|
2754
2716
|
# @param duration [Integer] The duration of the billing period.
|
2755
2717
|
#
|
2756
|
-
# @param duration_unit [Symbol, Orb::
|
2718
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::TieredPackage::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
2757
2719
|
|
2758
2720
|
# The unit of billing period duration.
|
2759
2721
|
#
|
2760
|
-
# @see Orb::
|
2722
|
+
# @see Orb::PlanCreateParams::Price::TieredPackage::InvoicingCycleConfiguration#duration_unit
|
2761
2723
|
module DurationUnit
|
2762
2724
|
extend Orb::Internal::Type::Enum
|
2763
2725
|
|
@@ -2774,8 +2736,8 @@ module Orb
|
|
2774
2736
|
# @!attribute cadence
|
2775
2737
|
# The cadence to bill for this price on.
|
2776
2738
|
#
|
2777
|
-
# @return [Symbol, Orb::
|
2778
|
-
required :cadence, enum: -> { Orb::
|
2739
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::TieredWithMinimum::Cadence]
|
2740
|
+
required :cadence, enum: -> { Orb::PlanCreateParams::Price::TieredWithMinimum::Cadence }
|
2779
2741
|
|
2780
2742
|
# @!attribute item_id
|
2781
2743
|
# The id of the item the price will be associated with.
|
@@ -2817,9 +2779,9 @@ module Orb
|
|
2817
2779
|
# For custom cadence: specifies the duration of the billing period in days or
|
2818
2780
|
# months.
|
2819
2781
|
#
|
2820
|
-
# @return [Orb::
|
2782
|
+
# @return [Orb::PlanCreateParams::Price::TieredWithMinimum::BillingCycleConfiguration, nil]
|
2821
2783
|
optional :billing_cycle_configuration,
|
2822
|
-
-> { Orb::
|
2784
|
+
-> { Orb::PlanCreateParams::Price::TieredWithMinimum::BillingCycleConfiguration },
|
2823
2785
|
nil?: true
|
2824
2786
|
|
2825
2787
|
# @!attribute conversion_rate
|
@@ -2858,9 +2820,9 @@ module Orb
|
|
2858
2820
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
2859
2821
|
# If unspecified, a single invoice is produced per billing cycle.
|
2860
2822
|
#
|
2861
|
-
# @return [Orb::
|
2823
|
+
# @return [Orb::PlanCreateParams::Price::TieredWithMinimum::InvoicingCycleConfiguration, nil]
|
2862
2824
|
optional :invoicing_cycle_configuration,
|
2863
|
-
-> { Orb::
|
2825
|
+
-> { Orb::PlanCreateParams::Price::TieredWithMinimum::InvoicingCycleConfiguration },
|
2864
2826
|
nil?: true
|
2865
2827
|
|
2866
2828
|
# @!attribute metadata
|
@@ -2873,9 +2835,9 @@ module Orb
|
|
2873
2835
|
|
2874
2836
|
# @!method initialize(cadence:, item_id:, name:, tiered_with_minimum_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :tiered_with_minimum)
|
2875
2837
|
# Some parameter documentations has been truncated, see
|
2876
|
-
# {Orb::
|
2838
|
+
# {Orb::PlanCreateParams::Price::TieredWithMinimum} for more details.
|
2877
2839
|
#
|
2878
|
-
# @param cadence [Symbol, Orb::
|
2840
|
+
# @param cadence [Symbol, Orb::PlanCreateParams::Price::TieredWithMinimum::Cadence] The cadence to bill for this price on.
|
2879
2841
|
#
|
2880
2842
|
# @param item_id [String] The id of the item the price will be associated with.
|
2881
2843
|
#
|
@@ -2884,37 +2846,30 @@ module Orb
|
|
2884
2846
|
# @param tiered_with_minimum_config [Hash{Symbol=>Object}]
|
2885
2847
|
#
|
2886
2848
|
# @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b
|
2887
|
-
# ...
|
2888
2849
|
#
|
2889
2850
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
2890
|
-
# ...
|
2891
2851
|
#
|
2892
|
-
# @param billing_cycle_configuration [Orb::
|
2893
|
-
# ...
|
2852
|
+
# @param billing_cycle_configuration [Orb::PlanCreateParams::Price::TieredWithMinimum::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
2894
2853
|
#
|
2895
2854
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
2896
2855
|
#
|
2897
2856
|
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
2898
|
-
# ...
|
2899
2857
|
#
|
2900
2858
|
# @param external_price_id [String, nil] An alias for the price.
|
2901
2859
|
#
|
2902
2860
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
2903
|
-
# ...
|
2904
2861
|
#
|
2905
2862
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
2906
2863
|
#
|
2907
|
-
# @param invoicing_cycle_configuration [Orb::
|
2908
|
-
# ...
|
2864
|
+
# @param invoicing_cycle_configuration [Orb::PlanCreateParams::Price::TieredWithMinimum::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
2909
2865
|
#
|
2910
2866
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
2911
|
-
# ...
|
2912
2867
|
#
|
2913
2868
|
# @param model_type [Symbol, :tiered_with_minimum]
|
2914
2869
|
|
2915
2870
|
# The cadence to bill for this price on.
|
2916
2871
|
#
|
2917
|
-
# @see Orb::
|
2872
|
+
# @see Orb::PlanCreateParams::Price::TieredWithMinimum#cadence
|
2918
2873
|
module Cadence
|
2919
2874
|
extend Orb::Internal::Type::Enum
|
2920
2875
|
|
@@ -2929,7 +2884,7 @@ module Orb
|
|
2929
2884
|
# @return [Array<Symbol>]
|
2930
2885
|
end
|
2931
2886
|
|
2932
|
-
# @see Orb::
|
2887
|
+
# @see Orb::PlanCreateParams::Price::TieredWithMinimum#billing_cycle_configuration
|
2933
2888
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
2934
2889
|
# @!attribute duration
|
2935
2890
|
# The duration of the billing period.
|
@@ -2940,9 +2895,11 @@ module Orb
|
|
2940
2895
|
# @!attribute duration_unit
|
2941
2896
|
# The unit of billing period duration.
|
2942
2897
|
#
|
2943
|
-
# @return [Symbol, Orb::
|
2898
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::TieredWithMinimum::BillingCycleConfiguration::DurationUnit]
|
2944
2899
|
required :duration_unit,
|
2945
|
-
enum: -> {
|
2900
|
+
enum: -> {
|
2901
|
+
Orb::PlanCreateParams::Price::TieredWithMinimum::BillingCycleConfiguration::DurationUnit
|
2902
|
+
}
|
2946
2903
|
|
2947
2904
|
# @!method initialize(duration:, duration_unit:)
|
2948
2905
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -2950,11 +2907,11 @@ module Orb
|
|
2950
2907
|
#
|
2951
2908
|
# @param duration [Integer] The duration of the billing period.
|
2952
2909
|
#
|
2953
|
-
# @param duration_unit [Symbol, Orb::
|
2910
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::TieredWithMinimum::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
2954
2911
|
|
2955
2912
|
# The unit of billing period duration.
|
2956
2913
|
#
|
2957
|
-
# @see Orb::
|
2914
|
+
# @see Orb::PlanCreateParams::Price::TieredWithMinimum::BillingCycleConfiguration#duration_unit
|
2958
2915
|
module DurationUnit
|
2959
2916
|
extend Orb::Internal::Type::Enum
|
2960
2917
|
|
@@ -2966,7 +2923,7 @@ module Orb
|
|
2966
2923
|
end
|
2967
2924
|
end
|
2968
2925
|
|
2969
|
-
# @see Orb::
|
2926
|
+
# @see Orb::PlanCreateParams::Price::TieredWithMinimum#invoicing_cycle_configuration
|
2970
2927
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
2971
2928
|
# @!attribute duration
|
2972
2929
|
# The duration of the billing period.
|
@@ -2977,9 +2934,11 @@ module Orb
|
|
2977
2934
|
# @!attribute duration_unit
|
2978
2935
|
# The unit of billing period duration.
|
2979
2936
|
#
|
2980
|
-
# @return [Symbol, Orb::
|
2937
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::TieredWithMinimum::InvoicingCycleConfiguration::DurationUnit]
|
2981
2938
|
required :duration_unit,
|
2982
|
-
enum: -> {
|
2939
|
+
enum: -> {
|
2940
|
+
Orb::PlanCreateParams::Price::TieredWithMinimum::InvoicingCycleConfiguration::DurationUnit
|
2941
|
+
}
|
2983
2942
|
|
2984
2943
|
# @!method initialize(duration:, duration_unit:)
|
2985
2944
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
@@ -2987,11 +2946,11 @@ module Orb
|
|
2987
2946
|
#
|
2988
2947
|
# @param duration [Integer] The duration of the billing period.
|
2989
2948
|
#
|
2990
|
-
# @param duration_unit [Symbol, Orb::
|
2949
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::TieredWithMinimum::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
2991
2950
|
|
2992
2951
|
# The unit of billing period duration.
|
2993
2952
|
#
|
2994
|
-
# @see Orb::
|
2953
|
+
# @see Orb::PlanCreateParams::Price::TieredWithMinimum::InvoicingCycleConfiguration#duration_unit
|
2995
2954
|
module DurationUnit
|
2996
2955
|
extend Orb::Internal::Type::Enum
|
2997
2956
|
|
@@ -3008,8 +2967,8 @@ module Orb
|
|
3008
2967
|
# @!attribute cadence
|
3009
2968
|
# The cadence to bill for this price on.
|
3010
2969
|
#
|
3011
|
-
# @return [Symbol, Orb::
|
3012
|
-
required :cadence, enum: -> { Orb::
|
2970
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::UnitWithPercent::Cadence]
|
2971
|
+
required :cadence, enum: -> { Orb::PlanCreateParams::Price::UnitWithPercent::Cadence }
|
3013
2972
|
|
3014
2973
|
# @!attribute item_id
|
3015
2974
|
# The id of the item the price will be associated with.
|
@@ -3051,9 +3010,9 @@ module Orb
|
|
3051
3010
|
# For custom cadence: specifies the duration of the billing period in days or
|
3052
3011
|
# months.
|
3053
3012
|
#
|
3054
|
-
# @return [Orb::
|
3013
|
+
# @return [Orb::PlanCreateParams::Price::UnitWithPercent::BillingCycleConfiguration, nil]
|
3055
3014
|
optional :billing_cycle_configuration,
|
3056
|
-
-> { Orb::
|
3015
|
+
-> { Orb::PlanCreateParams::Price::UnitWithPercent::BillingCycleConfiguration },
|
3057
3016
|
nil?: true
|
3058
3017
|
|
3059
3018
|
# @!attribute conversion_rate
|
@@ -3092,9 +3051,9 @@ module Orb
|
|
3092
3051
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
3093
3052
|
# If unspecified, a single invoice is produced per billing cycle.
|
3094
3053
|
#
|
3095
|
-
# @return [Orb::
|
3054
|
+
# @return [Orb::PlanCreateParams::Price::UnitWithPercent::InvoicingCycleConfiguration, nil]
|
3096
3055
|
optional :invoicing_cycle_configuration,
|
3097
|
-
-> { Orb::
|
3056
|
+
-> { Orb::PlanCreateParams::Price::UnitWithPercent::InvoicingCycleConfiguration },
|
3098
3057
|
nil?: true
|
3099
3058
|
|
3100
3059
|
# @!attribute metadata
|
@@ -3107,9 +3066,9 @@ module Orb
|
|
3107
3066
|
|
3108
3067
|
# @!method initialize(cadence:, item_id:, name:, unit_with_percent_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :unit_with_percent)
|
3109
3068
|
# Some parameter documentations has been truncated, see
|
3110
|
-
# {Orb::
|
3069
|
+
# {Orb::PlanCreateParams::Price::UnitWithPercent} for more details.
|
3111
3070
|
#
|
3112
|
-
# @param cadence [Symbol, Orb::
|
3071
|
+
# @param cadence [Symbol, Orb::PlanCreateParams::Price::UnitWithPercent::Cadence] The cadence to bill for this price on.
|
3113
3072
|
#
|
3114
3073
|
# @param item_id [String] The id of the item the price will be associated with.
|
3115
3074
|
#
|
@@ -3118,37 +3077,30 @@ module Orb
|
|
3118
3077
|
# @param unit_with_percent_config [Hash{Symbol=>Object}]
|
3119
3078
|
#
|
3120
3079
|
# @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b
|
3121
|
-
# ...
|
3122
3080
|
#
|
3123
3081
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
3124
|
-
# ...
|
3125
3082
|
#
|
3126
|
-
# @param billing_cycle_configuration [Orb::
|
3127
|
-
# ...
|
3083
|
+
# @param billing_cycle_configuration [Orb::PlanCreateParams::Price::UnitWithPercent::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
3128
3084
|
#
|
3129
3085
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
3130
3086
|
#
|
3131
3087
|
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
3132
|
-
# ...
|
3133
3088
|
#
|
3134
3089
|
# @param external_price_id [String, nil] An alias for the price.
|
3135
3090
|
#
|
3136
3091
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
3137
|
-
# ...
|
3138
3092
|
#
|
3139
3093
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
3140
3094
|
#
|
3141
|
-
# @param invoicing_cycle_configuration [Orb::
|
3142
|
-
# ...
|
3095
|
+
# @param invoicing_cycle_configuration [Orb::PlanCreateParams::Price::UnitWithPercent::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
3143
3096
|
#
|
3144
3097
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
3145
|
-
# ...
|
3146
3098
|
#
|
3147
3099
|
# @param model_type [Symbol, :unit_with_percent]
|
3148
3100
|
|
3149
3101
|
# The cadence to bill for this price on.
|
3150
3102
|
#
|
3151
|
-
# @see Orb::
|
3103
|
+
# @see Orb::PlanCreateParams::Price::UnitWithPercent#cadence
|
3152
3104
|
module Cadence
|
3153
3105
|
extend Orb::Internal::Type::Enum
|
3154
3106
|
|
@@ -3163,7 +3115,7 @@ module Orb
|
|
3163
3115
|
# @return [Array<Symbol>]
|
3164
3116
|
end
|
3165
3117
|
|
3166
|
-
# @see Orb::
|
3118
|
+
# @see Orb::PlanCreateParams::Price::UnitWithPercent#billing_cycle_configuration
|
3167
3119
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
3168
3120
|
# @!attribute duration
|
3169
3121
|
# The duration of the billing period.
|
@@ -3174,9 +3126,11 @@ module Orb
|
|
3174
3126
|
# @!attribute duration_unit
|
3175
3127
|
# The unit of billing period duration.
|
3176
3128
|
#
|
3177
|
-
# @return [Symbol, Orb::
|
3129
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::UnitWithPercent::BillingCycleConfiguration::DurationUnit]
|
3178
3130
|
required :duration_unit,
|
3179
|
-
enum: -> {
|
3131
|
+
enum: -> {
|
3132
|
+
Orb::PlanCreateParams::Price::UnitWithPercent::BillingCycleConfiguration::DurationUnit
|
3133
|
+
}
|
3180
3134
|
|
3181
3135
|
# @!method initialize(duration:, duration_unit:)
|
3182
3136
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -3184,11 +3138,11 @@ module Orb
|
|
3184
3138
|
#
|
3185
3139
|
# @param duration [Integer] The duration of the billing period.
|
3186
3140
|
#
|
3187
|
-
# @param duration_unit [Symbol, Orb::
|
3141
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::UnitWithPercent::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
3188
3142
|
|
3189
3143
|
# The unit of billing period duration.
|
3190
3144
|
#
|
3191
|
-
# @see Orb::
|
3145
|
+
# @see Orb::PlanCreateParams::Price::UnitWithPercent::BillingCycleConfiguration#duration_unit
|
3192
3146
|
module DurationUnit
|
3193
3147
|
extend Orb::Internal::Type::Enum
|
3194
3148
|
|
@@ -3200,7 +3154,7 @@ module Orb
|
|
3200
3154
|
end
|
3201
3155
|
end
|
3202
3156
|
|
3203
|
-
# @see Orb::
|
3157
|
+
# @see Orb::PlanCreateParams::Price::UnitWithPercent#invoicing_cycle_configuration
|
3204
3158
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
3205
3159
|
# @!attribute duration
|
3206
3160
|
# The duration of the billing period.
|
@@ -3211,9 +3165,11 @@ module Orb
|
|
3211
3165
|
# @!attribute duration_unit
|
3212
3166
|
# The unit of billing period duration.
|
3213
3167
|
#
|
3214
|
-
# @return [Symbol, Orb::
|
3168
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::UnitWithPercent::InvoicingCycleConfiguration::DurationUnit]
|
3215
3169
|
required :duration_unit,
|
3216
|
-
enum: -> {
|
3170
|
+
enum: -> {
|
3171
|
+
Orb::PlanCreateParams::Price::UnitWithPercent::InvoicingCycleConfiguration::DurationUnit
|
3172
|
+
}
|
3217
3173
|
|
3218
3174
|
# @!method initialize(duration:, duration_unit:)
|
3219
3175
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
@@ -3221,11 +3177,11 @@ module Orb
|
|
3221
3177
|
#
|
3222
3178
|
# @param duration [Integer] The duration of the billing period.
|
3223
3179
|
#
|
3224
|
-
# @param duration_unit [Symbol, Orb::
|
3180
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::UnitWithPercent::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
3225
3181
|
|
3226
3182
|
# The unit of billing period duration.
|
3227
3183
|
#
|
3228
|
-
# @see Orb::
|
3184
|
+
# @see Orb::PlanCreateParams::Price::UnitWithPercent::InvoicingCycleConfiguration#duration_unit
|
3229
3185
|
module DurationUnit
|
3230
3186
|
extend Orb::Internal::Type::Enum
|
3231
3187
|
|
@@ -3242,8 +3198,8 @@ module Orb
|
|
3242
3198
|
# @!attribute cadence
|
3243
3199
|
# The cadence to bill for this price on.
|
3244
3200
|
#
|
3245
|
-
# @return [Symbol, Orb::
|
3246
|
-
required :cadence, enum: -> { Orb::
|
3201
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::PackageWithAllocation::Cadence]
|
3202
|
+
required :cadence, enum: -> { Orb::PlanCreateParams::Price::PackageWithAllocation::Cadence }
|
3247
3203
|
|
3248
3204
|
# @!attribute item_id
|
3249
3205
|
# The id of the item the price will be associated with.
|
@@ -3285,9 +3241,9 @@ module Orb
|
|
3285
3241
|
# For custom cadence: specifies the duration of the billing period in days or
|
3286
3242
|
# months.
|
3287
3243
|
#
|
3288
|
-
# @return [Orb::
|
3244
|
+
# @return [Orb::PlanCreateParams::Price::PackageWithAllocation::BillingCycleConfiguration, nil]
|
3289
3245
|
optional :billing_cycle_configuration,
|
3290
|
-
-> { Orb::
|
3246
|
+
-> { Orb::PlanCreateParams::Price::PackageWithAllocation::BillingCycleConfiguration },
|
3291
3247
|
nil?: true
|
3292
3248
|
|
3293
3249
|
# @!attribute conversion_rate
|
@@ -3326,9 +3282,9 @@ module Orb
|
|
3326
3282
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
3327
3283
|
# If unspecified, a single invoice is produced per billing cycle.
|
3328
3284
|
#
|
3329
|
-
# @return [Orb::
|
3285
|
+
# @return [Orb::PlanCreateParams::Price::PackageWithAllocation::InvoicingCycleConfiguration, nil]
|
3330
3286
|
optional :invoicing_cycle_configuration,
|
3331
|
-
-> { Orb::
|
3287
|
+
-> { Orb::PlanCreateParams::Price::PackageWithAllocation::InvoicingCycleConfiguration },
|
3332
3288
|
nil?: true
|
3333
3289
|
|
3334
3290
|
# @!attribute metadata
|
@@ -3341,9 +3297,9 @@ module Orb
|
|
3341
3297
|
|
3342
3298
|
# @!method initialize(cadence:, item_id:, name:, package_with_allocation_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :package_with_allocation)
|
3343
3299
|
# Some parameter documentations has been truncated, see
|
3344
|
-
# {Orb::
|
3300
|
+
# {Orb::PlanCreateParams::Price::PackageWithAllocation} for more details.
|
3345
3301
|
#
|
3346
|
-
# @param cadence [Symbol, Orb::
|
3302
|
+
# @param cadence [Symbol, Orb::PlanCreateParams::Price::PackageWithAllocation::Cadence] The cadence to bill for this price on.
|
3347
3303
|
#
|
3348
3304
|
# @param item_id [String] The id of the item the price will be associated with.
|
3349
3305
|
#
|
@@ -3352,37 +3308,30 @@ module Orb
|
|
3352
3308
|
# @param package_with_allocation_config [Hash{Symbol=>Object}]
|
3353
3309
|
#
|
3354
3310
|
# @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b
|
3355
|
-
# ...
|
3356
3311
|
#
|
3357
3312
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
3358
|
-
# ...
|
3359
3313
|
#
|
3360
|
-
# @param billing_cycle_configuration [Orb::
|
3361
|
-
# ...
|
3314
|
+
# @param billing_cycle_configuration [Orb::PlanCreateParams::Price::PackageWithAllocation::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
3362
3315
|
#
|
3363
3316
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
3364
3317
|
#
|
3365
3318
|
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
3366
|
-
# ...
|
3367
3319
|
#
|
3368
3320
|
# @param external_price_id [String, nil] An alias for the price.
|
3369
3321
|
#
|
3370
3322
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
3371
|
-
# ...
|
3372
3323
|
#
|
3373
3324
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
3374
3325
|
#
|
3375
|
-
# @param invoicing_cycle_configuration [Orb::
|
3376
|
-
# ...
|
3326
|
+
# @param invoicing_cycle_configuration [Orb::PlanCreateParams::Price::PackageWithAllocation::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
3377
3327
|
#
|
3378
3328
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
3379
|
-
# ...
|
3380
3329
|
#
|
3381
3330
|
# @param model_type [Symbol, :package_with_allocation]
|
3382
3331
|
|
3383
3332
|
# The cadence to bill for this price on.
|
3384
3333
|
#
|
3385
|
-
# @see Orb::
|
3334
|
+
# @see Orb::PlanCreateParams::Price::PackageWithAllocation#cadence
|
3386
3335
|
module Cadence
|
3387
3336
|
extend Orb::Internal::Type::Enum
|
3388
3337
|
|
@@ -3397,7 +3346,7 @@ module Orb
|
|
3397
3346
|
# @return [Array<Symbol>]
|
3398
3347
|
end
|
3399
3348
|
|
3400
|
-
# @see Orb::
|
3349
|
+
# @see Orb::PlanCreateParams::Price::PackageWithAllocation#billing_cycle_configuration
|
3401
3350
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
3402
3351
|
# @!attribute duration
|
3403
3352
|
# The duration of the billing period.
|
@@ -3408,9 +3357,11 @@ module Orb
|
|
3408
3357
|
# @!attribute duration_unit
|
3409
3358
|
# The unit of billing period duration.
|
3410
3359
|
#
|
3411
|
-
# @return [Symbol, Orb::
|
3360
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::PackageWithAllocation::BillingCycleConfiguration::DurationUnit]
|
3412
3361
|
required :duration_unit,
|
3413
|
-
enum: -> {
|
3362
|
+
enum: -> {
|
3363
|
+
Orb::PlanCreateParams::Price::PackageWithAllocation::BillingCycleConfiguration::DurationUnit
|
3364
|
+
}
|
3414
3365
|
|
3415
3366
|
# @!method initialize(duration:, duration_unit:)
|
3416
3367
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -3418,11 +3369,11 @@ module Orb
|
|
3418
3369
|
#
|
3419
3370
|
# @param duration [Integer] The duration of the billing period.
|
3420
3371
|
#
|
3421
|
-
# @param duration_unit [Symbol, Orb::
|
3372
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::PackageWithAllocation::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
3422
3373
|
|
3423
3374
|
# The unit of billing period duration.
|
3424
3375
|
#
|
3425
|
-
# @see Orb::
|
3376
|
+
# @see Orb::PlanCreateParams::Price::PackageWithAllocation::BillingCycleConfiguration#duration_unit
|
3426
3377
|
module DurationUnit
|
3427
3378
|
extend Orb::Internal::Type::Enum
|
3428
3379
|
|
@@ -3434,7 +3385,7 @@ module Orb
|
|
3434
3385
|
end
|
3435
3386
|
end
|
3436
3387
|
|
3437
|
-
# @see Orb::
|
3388
|
+
# @see Orb::PlanCreateParams::Price::PackageWithAllocation#invoicing_cycle_configuration
|
3438
3389
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
3439
3390
|
# @!attribute duration
|
3440
3391
|
# The duration of the billing period.
|
@@ -3445,9 +3396,11 @@ module Orb
|
|
3445
3396
|
# @!attribute duration_unit
|
3446
3397
|
# The unit of billing period duration.
|
3447
3398
|
#
|
3448
|
-
# @return [Symbol, Orb::
|
3399
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::PackageWithAllocation::InvoicingCycleConfiguration::DurationUnit]
|
3449
3400
|
required :duration_unit,
|
3450
|
-
enum: -> {
|
3401
|
+
enum: -> {
|
3402
|
+
Orb::PlanCreateParams::Price::PackageWithAllocation::InvoicingCycleConfiguration::DurationUnit
|
3403
|
+
}
|
3451
3404
|
|
3452
3405
|
# @!method initialize(duration:, duration_unit:)
|
3453
3406
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
@@ -3455,11 +3408,11 @@ module Orb
|
|
3455
3408
|
#
|
3456
3409
|
# @param duration [Integer] The duration of the billing period.
|
3457
3410
|
#
|
3458
|
-
# @param duration_unit [Symbol, Orb::
|
3411
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::PackageWithAllocation::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
3459
3412
|
|
3460
3413
|
# The unit of billing period duration.
|
3461
3414
|
#
|
3462
|
-
# @see Orb::
|
3415
|
+
# @see Orb::PlanCreateParams::Price::PackageWithAllocation::InvoicingCycleConfiguration#duration_unit
|
3463
3416
|
module DurationUnit
|
3464
3417
|
extend Orb::Internal::Type::Enum
|
3465
3418
|
|
@@ -3476,8 +3429,8 @@ module Orb
|
|
3476
3429
|
# @!attribute cadence
|
3477
3430
|
# The cadence to bill for this price on.
|
3478
3431
|
#
|
3479
|
-
# @return [Symbol, Orb::
|
3480
|
-
required :cadence, enum: -> { Orb::
|
3432
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::TieredWithProration::Cadence]
|
3433
|
+
required :cadence, enum: -> { Orb::PlanCreateParams::Price::TieredWithProration::Cadence }
|
3481
3434
|
|
3482
3435
|
# @!attribute item_id
|
3483
3436
|
# The id of the item the price will be associated with.
|
@@ -3519,9 +3472,9 @@ module Orb
|
|
3519
3472
|
# For custom cadence: specifies the duration of the billing period in days or
|
3520
3473
|
# months.
|
3521
3474
|
#
|
3522
|
-
# @return [Orb::
|
3475
|
+
# @return [Orb::PlanCreateParams::Price::TieredWithProration::BillingCycleConfiguration, nil]
|
3523
3476
|
optional :billing_cycle_configuration,
|
3524
|
-
-> { Orb::
|
3477
|
+
-> { Orb::PlanCreateParams::Price::TieredWithProration::BillingCycleConfiguration },
|
3525
3478
|
nil?: true
|
3526
3479
|
|
3527
3480
|
# @!attribute conversion_rate
|
@@ -3560,9 +3513,9 @@ module Orb
|
|
3560
3513
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
3561
3514
|
# If unspecified, a single invoice is produced per billing cycle.
|
3562
3515
|
#
|
3563
|
-
# @return [Orb::
|
3516
|
+
# @return [Orb::PlanCreateParams::Price::TieredWithProration::InvoicingCycleConfiguration, nil]
|
3564
3517
|
optional :invoicing_cycle_configuration,
|
3565
|
-
-> { Orb::
|
3518
|
+
-> { Orb::PlanCreateParams::Price::TieredWithProration::InvoicingCycleConfiguration },
|
3566
3519
|
nil?: true
|
3567
3520
|
|
3568
3521
|
# @!attribute metadata
|
@@ -3575,9 +3528,9 @@ module Orb
|
|
3575
3528
|
|
3576
3529
|
# @!method initialize(cadence:, item_id:, name:, tiered_with_proration_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :tiered_with_proration)
|
3577
3530
|
# Some parameter documentations has been truncated, see
|
3578
|
-
# {Orb::
|
3531
|
+
# {Orb::PlanCreateParams::Price::TieredWithProration} for more details.
|
3579
3532
|
#
|
3580
|
-
# @param cadence [Symbol, Orb::
|
3533
|
+
# @param cadence [Symbol, Orb::PlanCreateParams::Price::TieredWithProration::Cadence] The cadence to bill for this price on.
|
3581
3534
|
#
|
3582
3535
|
# @param item_id [String] The id of the item the price will be associated with.
|
3583
3536
|
#
|
@@ -3586,37 +3539,30 @@ module Orb
|
|
3586
3539
|
# @param tiered_with_proration_config [Hash{Symbol=>Object}]
|
3587
3540
|
#
|
3588
3541
|
# @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b
|
3589
|
-
# ...
|
3590
3542
|
#
|
3591
3543
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
3592
|
-
# ...
|
3593
3544
|
#
|
3594
|
-
# @param billing_cycle_configuration [Orb::
|
3595
|
-
# ...
|
3545
|
+
# @param billing_cycle_configuration [Orb::PlanCreateParams::Price::TieredWithProration::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
3596
3546
|
#
|
3597
3547
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
3598
3548
|
#
|
3599
3549
|
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
3600
|
-
# ...
|
3601
3550
|
#
|
3602
3551
|
# @param external_price_id [String, nil] An alias for the price.
|
3603
3552
|
#
|
3604
3553
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
3605
|
-
# ...
|
3606
3554
|
#
|
3607
3555
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
3608
3556
|
#
|
3609
|
-
# @param invoicing_cycle_configuration [Orb::
|
3610
|
-
# ...
|
3557
|
+
# @param invoicing_cycle_configuration [Orb::PlanCreateParams::Price::TieredWithProration::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
3611
3558
|
#
|
3612
3559
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
3613
|
-
# ...
|
3614
3560
|
#
|
3615
3561
|
# @param model_type [Symbol, :tiered_with_proration]
|
3616
3562
|
|
3617
3563
|
# The cadence to bill for this price on.
|
3618
3564
|
#
|
3619
|
-
# @see Orb::
|
3565
|
+
# @see Orb::PlanCreateParams::Price::TieredWithProration#cadence
|
3620
3566
|
module Cadence
|
3621
3567
|
extend Orb::Internal::Type::Enum
|
3622
3568
|
|
@@ -3631,7 +3577,7 @@ module Orb
|
|
3631
3577
|
# @return [Array<Symbol>]
|
3632
3578
|
end
|
3633
3579
|
|
3634
|
-
# @see Orb::
|
3580
|
+
# @see Orb::PlanCreateParams::Price::TieredWithProration#billing_cycle_configuration
|
3635
3581
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
3636
3582
|
# @!attribute duration
|
3637
3583
|
# The duration of the billing period.
|
@@ -3642,9 +3588,11 @@ module Orb
|
|
3642
3588
|
# @!attribute duration_unit
|
3643
3589
|
# The unit of billing period duration.
|
3644
3590
|
#
|
3645
|
-
# @return [Symbol, Orb::
|
3591
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::TieredWithProration::BillingCycleConfiguration::DurationUnit]
|
3646
3592
|
required :duration_unit,
|
3647
|
-
enum: -> {
|
3593
|
+
enum: -> {
|
3594
|
+
Orb::PlanCreateParams::Price::TieredWithProration::BillingCycleConfiguration::DurationUnit
|
3595
|
+
}
|
3648
3596
|
|
3649
3597
|
# @!method initialize(duration:, duration_unit:)
|
3650
3598
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -3652,11 +3600,11 @@ module Orb
|
|
3652
3600
|
#
|
3653
3601
|
# @param duration [Integer] The duration of the billing period.
|
3654
3602
|
#
|
3655
|
-
# @param duration_unit [Symbol, Orb::
|
3603
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::TieredWithProration::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
3656
3604
|
|
3657
3605
|
# The unit of billing period duration.
|
3658
3606
|
#
|
3659
|
-
# @see Orb::
|
3607
|
+
# @see Orb::PlanCreateParams::Price::TieredWithProration::BillingCycleConfiguration#duration_unit
|
3660
3608
|
module DurationUnit
|
3661
3609
|
extend Orb::Internal::Type::Enum
|
3662
3610
|
|
@@ -3668,7 +3616,7 @@ module Orb
|
|
3668
3616
|
end
|
3669
3617
|
end
|
3670
3618
|
|
3671
|
-
# @see Orb::
|
3619
|
+
# @see Orb::PlanCreateParams::Price::TieredWithProration#invoicing_cycle_configuration
|
3672
3620
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
3673
3621
|
# @!attribute duration
|
3674
3622
|
# The duration of the billing period.
|
@@ -3679,9 +3627,11 @@ module Orb
|
|
3679
3627
|
# @!attribute duration_unit
|
3680
3628
|
# The unit of billing period duration.
|
3681
3629
|
#
|
3682
|
-
# @return [Symbol, Orb::
|
3630
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::TieredWithProration::InvoicingCycleConfiguration::DurationUnit]
|
3683
3631
|
required :duration_unit,
|
3684
|
-
enum: -> {
|
3632
|
+
enum: -> {
|
3633
|
+
Orb::PlanCreateParams::Price::TieredWithProration::InvoicingCycleConfiguration::DurationUnit
|
3634
|
+
}
|
3685
3635
|
|
3686
3636
|
# @!method initialize(duration:, duration_unit:)
|
3687
3637
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
@@ -3689,11 +3639,11 @@ module Orb
|
|
3689
3639
|
#
|
3690
3640
|
# @param duration [Integer] The duration of the billing period.
|
3691
3641
|
#
|
3692
|
-
# @param duration_unit [Symbol, Orb::
|
3642
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::TieredWithProration::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
3693
3643
|
|
3694
3644
|
# The unit of billing period duration.
|
3695
3645
|
#
|
3696
|
-
# @see Orb::
|
3646
|
+
# @see Orb::PlanCreateParams::Price::TieredWithProration::InvoicingCycleConfiguration#duration_unit
|
3697
3647
|
module DurationUnit
|
3698
3648
|
extend Orb::Internal::Type::Enum
|
3699
3649
|
|
@@ -3710,8 +3660,8 @@ module Orb
|
|
3710
3660
|
# @!attribute cadence
|
3711
3661
|
# The cadence to bill for this price on.
|
3712
3662
|
#
|
3713
|
-
# @return [Symbol, Orb::
|
3714
|
-
required :cadence, enum: -> { Orb::
|
3663
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::UnitWithProration::Cadence]
|
3664
|
+
required :cadence, enum: -> { Orb::PlanCreateParams::Price::UnitWithProration::Cadence }
|
3715
3665
|
|
3716
3666
|
# @!attribute item_id
|
3717
3667
|
# The id of the item the price will be associated with.
|
@@ -3753,9 +3703,9 @@ module Orb
|
|
3753
3703
|
# For custom cadence: specifies the duration of the billing period in days or
|
3754
3704
|
# months.
|
3755
3705
|
#
|
3756
|
-
# @return [Orb::
|
3706
|
+
# @return [Orb::PlanCreateParams::Price::UnitWithProration::BillingCycleConfiguration, nil]
|
3757
3707
|
optional :billing_cycle_configuration,
|
3758
|
-
-> { Orb::
|
3708
|
+
-> { Orb::PlanCreateParams::Price::UnitWithProration::BillingCycleConfiguration },
|
3759
3709
|
nil?: true
|
3760
3710
|
|
3761
3711
|
# @!attribute conversion_rate
|
@@ -3794,9 +3744,9 @@ module Orb
|
|
3794
3744
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
3795
3745
|
# If unspecified, a single invoice is produced per billing cycle.
|
3796
3746
|
#
|
3797
|
-
# @return [Orb::
|
3747
|
+
# @return [Orb::PlanCreateParams::Price::UnitWithProration::InvoicingCycleConfiguration, nil]
|
3798
3748
|
optional :invoicing_cycle_configuration,
|
3799
|
-
-> { Orb::
|
3749
|
+
-> { Orb::PlanCreateParams::Price::UnitWithProration::InvoicingCycleConfiguration },
|
3800
3750
|
nil?: true
|
3801
3751
|
|
3802
3752
|
# @!attribute metadata
|
@@ -3809,9 +3759,9 @@ module Orb
|
|
3809
3759
|
|
3810
3760
|
# @!method initialize(cadence:, item_id:, name:, unit_with_proration_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :unit_with_proration)
|
3811
3761
|
# Some parameter documentations has been truncated, see
|
3812
|
-
# {Orb::
|
3762
|
+
# {Orb::PlanCreateParams::Price::UnitWithProration} for more details.
|
3813
3763
|
#
|
3814
|
-
# @param cadence [Symbol, Orb::
|
3764
|
+
# @param cadence [Symbol, Orb::PlanCreateParams::Price::UnitWithProration::Cadence] The cadence to bill for this price on.
|
3815
3765
|
#
|
3816
3766
|
# @param item_id [String] The id of the item the price will be associated with.
|
3817
3767
|
#
|
@@ -3820,37 +3770,30 @@ module Orb
|
|
3820
3770
|
# @param unit_with_proration_config [Hash{Symbol=>Object}]
|
3821
3771
|
#
|
3822
3772
|
# @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b
|
3823
|
-
# ...
|
3824
3773
|
#
|
3825
3774
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
3826
|
-
# ...
|
3827
3775
|
#
|
3828
|
-
# @param billing_cycle_configuration [Orb::
|
3829
|
-
# ...
|
3776
|
+
# @param billing_cycle_configuration [Orb::PlanCreateParams::Price::UnitWithProration::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
3830
3777
|
#
|
3831
3778
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
3832
3779
|
#
|
3833
3780
|
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
3834
|
-
# ...
|
3835
3781
|
#
|
3836
3782
|
# @param external_price_id [String, nil] An alias for the price.
|
3837
3783
|
#
|
3838
3784
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
3839
|
-
# ...
|
3840
3785
|
#
|
3841
3786
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
3842
3787
|
#
|
3843
|
-
# @param invoicing_cycle_configuration [Orb::
|
3844
|
-
# ...
|
3788
|
+
# @param invoicing_cycle_configuration [Orb::PlanCreateParams::Price::UnitWithProration::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
3845
3789
|
#
|
3846
3790
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
3847
|
-
# ...
|
3848
3791
|
#
|
3849
3792
|
# @param model_type [Symbol, :unit_with_proration]
|
3850
3793
|
|
3851
3794
|
# The cadence to bill for this price on.
|
3852
3795
|
#
|
3853
|
-
# @see Orb::
|
3796
|
+
# @see Orb::PlanCreateParams::Price::UnitWithProration#cadence
|
3854
3797
|
module Cadence
|
3855
3798
|
extend Orb::Internal::Type::Enum
|
3856
3799
|
|
@@ -3865,7 +3808,7 @@ module Orb
|
|
3865
3808
|
# @return [Array<Symbol>]
|
3866
3809
|
end
|
3867
3810
|
|
3868
|
-
# @see Orb::
|
3811
|
+
# @see Orb::PlanCreateParams::Price::UnitWithProration#billing_cycle_configuration
|
3869
3812
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
3870
3813
|
# @!attribute duration
|
3871
3814
|
# The duration of the billing period.
|
@@ -3876,9 +3819,11 @@ module Orb
|
|
3876
3819
|
# @!attribute duration_unit
|
3877
3820
|
# The unit of billing period duration.
|
3878
3821
|
#
|
3879
|
-
# @return [Symbol, Orb::
|
3822
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::UnitWithProration::BillingCycleConfiguration::DurationUnit]
|
3880
3823
|
required :duration_unit,
|
3881
|
-
enum: -> {
|
3824
|
+
enum: -> {
|
3825
|
+
Orb::PlanCreateParams::Price::UnitWithProration::BillingCycleConfiguration::DurationUnit
|
3826
|
+
}
|
3882
3827
|
|
3883
3828
|
# @!method initialize(duration:, duration_unit:)
|
3884
3829
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -3886,11 +3831,11 @@ module Orb
|
|
3886
3831
|
#
|
3887
3832
|
# @param duration [Integer] The duration of the billing period.
|
3888
3833
|
#
|
3889
|
-
# @param duration_unit [Symbol, Orb::
|
3834
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::UnitWithProration::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
3890
3835
|
|
3891
3836
|
# The unit of billing period duration.
|
3892
3837
|
#
|
3893
|
-
# @see Orb::
|
3838
|
+
# @see Orb::PlanCreateParams::Price::UnitWithProration::BillingCycleConfiguration#duration_unit
|
3894
3839
|
module DurationUnit
|
3895
3840
|
extend Orb::Internal::Type::Enum
|
3896
3841
|
|
@@ -3902,7 +3847,7 @@ module Orb
|
|
3902
3847
|
end
|
3903
3848
|
end
|
3904
3849
|
|
3905
|
-
# @see Orb::
|
3850
|
+
# @see Orb::PlanCreateParams::Price::UnitWithProration#invoicing_cycle_configuration
|
3906
3851
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
3907
3852
|
# @!attribute duration
|
3908
3853
|
# The duration of the billing period.
|
@@ -3913,9 +3858,11 @@ module Orb
|
|
3913
3858
|
# @!attribute duration_unit
|
3914
3859
|
# The unit of billing period duration.
|
3915
3860
|
#
|
3916
|
-
# @return [Symbol, Orb::
|
3861
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::UnitWithProration::InvoicingCycleConfiguration::DurationUnit]
|
3917
3862
|
required :duration_unit,
|
3918
|
-
enum: -> {
|
3863
|
+
enum: -> {
|
3864
|
+
Orb::PlanCreateParams::Price::UnitWithProration::InvoicingCycleConfiguration::DurationUnit
|
3865
|
+
}
|
3919
3866
|
|
3920
3867
|
# @!method initialize(duration:, duration_unit:)
|
3921
3868
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
@@ -3923,11 +3870,11 @@ module Orb
|
|
3923
3870
|
#
|
3924
3871
|
# @param duration [Integer] The duration of the billing period.
|
3925
3872
|
#
|
3926
|
-
# @param duration_unit [Symbol, Orb::
|
3873
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::UnitWithProration::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
3927
3874
|
|
3928
3875
|
# The unit of billing period duration.
|
3929
3876
|
#
|
3930
|
-
# @see Orb::
|
3877
|
+
# @see Orb::PlanCreateParams::Price::UnitWithProration::InvoicingCycleConfiguration#duration_unit
|
3931
3878
|
module DurationUnit
|
3932
3879
|
extend Orb::Internal::Type::Enum
|
3933
3880
|
|
@@ -3944,8 +3891,8 @@ module Orb
|
|
3944
3891
|
# @!attribute cadence
|
3945
3892
|
# The cadence to bill for this price on.
|
3946
3893
|
#
|
3947
|
-
# @return [Symbol, Orb::
|
3948
|
-
required :cadence, enum: -> { Orb::
|
3894
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::GroupedAllocation::Cadence]
|
3895
|
+
required :cadence, enum: -> { Orb::PlanCreateParams::Price::GroupedAllocation::Cadence }
|
3949
3896
|
|
3950
3897
|
# @!attribute grouped_allocation_config
|
3951
3898
|
#
|
@@ -3987,9 +3934,9 @@ module Orb
|
|
3987
3934
|
# For custom cadence: specifies the duration of the billing period in days or
|
3988
3935
|
# months.
|
3989
3936
|
#
|
3990
|
-
# @return [Orb::
|
3937
|
+
# @return [Orb::PlanCreateParams::Price::GroupedAllocation::BillingCycleConfiguration, nil]
|
3991
3938
|
optional :billing_cycle_configuration,
|
3992
|
-
-> { Orb::
|
3939
|
+
-> { Orb::PlanCreateParams::Price::GroupedAllocation::BillingCycleConfiguration },
|
3993
3940
|
nil?: true
|
3994
3941
|
|
3995
3942
|
# @!attribute conversion_rate
|
@@ -4028,9 +3975,9 @@ module Orb
|
|
4028
3975
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
4029
3976
|
# If unspecified, a single invoice is produced per billing cycle.
|
4030
3977
|
#
|
4031
|
-
# @return [Orb::
|
3978
|
+
# @return [Orb::PlanCreateParams::Price::GroupedAllocation::InvoicingCycleConfiguration, nil]
|
4032
3979
|
optional :invoicing_cycle_configuration,
|
4033
|
-
-> { Orb::
|
3980
|
+
-> { Orb::PlanCreateParams::Price::GroupedAllocation::InvoicingCycleConfiguration },
|
4034
3981
|
nil?: true
|
4035
3982
|
|
4036
3983
|
# @!attribute metadata
|
@@ -4043,9 +3990,9 @@ module Orb
|
|
4043
3990
|
|
4044
3991
|
# @!method initialize(cadence:, grouped_allocation_config:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :grouped_allocation)
|
4045
3992
|
# Some parameter documentations has been truncated, see
|
4046
|
-
# {Orb::
|
3993
|
+
# {Orb::PlanCreateParams::Price::GroupedAllocation} for more details.
|
4047
3994
|
#
|
4048
|
-
# @param cadence [Symbol, Orb::
|
3995
|
+
# @param cadence [Symbol, Orb::PlanCreateParams::Price::GroupedAllocation::Cadence] The cadence to bill for this price on.
|
4049
3996
|
#
|
4050
3997
|
# @param grouped_allocation_config [Hash{Symbol=>Object}]
|
4051
3998
|
#
|
@@ -4054,37 +4001,30 @@ module Orb
|
|
4054
4001
|
# @param name [String] The name of the price.
|
4055
4002
|
#
|
4056
4003
|
# @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b
|
4057
|
-
# ...
|
4058
4004
|
#
|
4059
4005
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
4060
|
-
# ...
|
4061
4006
|
#
|
4062
|
-
# @param billing_cycle_configuration [Orb::
|
4063
|
-
# ...
|
4007
|
+
# @param billing_cycle_configuration [Orb::PlanCreateParams::Price::GroupedAllocation::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
4064
4008
|
#
|
4065
4009
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
4066
4010
|
#
|
4067
4011
|
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
4068
|
-
# ...
|
4069
4012
|
#
|
4070
4013
|
# @param external_price_id [String, nil] An alias for the price.
|
4071
4014
|
#
|
4072
4015
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
4073
|
-
# ...
|
4074
4016
|
#
|
4075
4017
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
4076
4018
|
#
|
4077
|
-
# @param invoicing_cycle_configuration [Orb::
|
4078
|
-
# ...
|
4019
|
+
# @param invoicing_cycle_configuration [Orb::PlanCreateParams::Price::GroupedAllocation::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
4079
4020
|
#
|
4080
4021
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
4081
|
-
# ...
|
4082
4022
|
#
|
4083
4023
|
# @param model_type [Symbol, :grouped_allocation]
|
4084
4024
|
|
4085
4025
|
# The cadence to bill for this price on.
|
4086
4026
|
#
|
4087
|
-
# @see Orb::
|
4027
|
+
# @see Orb::PlanCreateParams::Price::GroupedAllocation#cadence
|
4088
4028
|
module Cadence
|
4089
4029
|
extend Orb::Internal::Type::Enum
|
4090
4030
|
|
@@ -4099,7 +4039,7 @@ module Orb
|
|
4099
4039
|
# @return [Array<Symbol>]
|
4100
4040
|
end
|
4101
4041
|
|
4102
|
-
# @see Orb::
|
4042
|
+
# @see Orb::PlanCreateParams::Price::GroupedAllocation#billing_cycle_configuration
|
4103
4043
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
4104
4044
|
# @!attribute duration
|
4105
4045
|
# The duration of the billing period.
|
@@ -4110,9 +4050,11 @@ module Orb
|
|
4110
4050
|
# @!attribute duration_unit
|
4111
4051
|
# The unit of billing period duration.
|
4112
4052
|
#
|
4113
|
-
# @return [Symbol, Orb::
|
4053
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::GroupedAllocation::BillingCycleConfiguration::DurationUnit]
|
4114
4054
|
required :duration_unit,
|
4115
|
-
enum: -> {
|
4055
|
+
enum: -> {
|
4056
|
+
Orb::PlanCreateParams::Price::GroupedAllocation::BillingCycleConfiguration::DurationUnit
|
4057
|
+
}
|
4116
4058
|
|
4117
4059
|
# @!method initialize(duration:, duration_unit:)
|
4118
4060
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -4120,11 +4062,11 @@ module Orb
|
|
4120
4062
|
#
|
4121
4063
|
# @param duration [Integer] The duration of the billing period.
|
4122
4064
|
#
|
4123
|
-
# @param duration_unit [Symbol, Orb::
|
4065
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::GroupedAllocation::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
4124
4066
|
|
4125
4067
|
# The unit of billing period duration.
|
4126
4068
|
#
|
4127
|
-
# @see Orb::
|
4069
|
+
# @see Orb::PlanCreateParams::Price::GroupedAllocation::BillingCycleConfiguration#duration_unit
|
4128
4070
|
module DurationUnit
|
4129
4071
|
extend Orb::Internal::Type::Enum
|
4130
4072
|
|
@@ -4136,7 +4078,7 @@ module Orb
|
|
4136
4078
|
end
|
4137
4079
|
end
|
4138
4080
|
|
4139
|
-
# @see Orb::
|
4081
|
+
# @see Orb::PlanCreateParams::Price::GroupedAllocation#invoicing_cycle_configuration
|
4140
4082
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
4141
4083
|
# @!attribute duration
|
4142
4084
|
# The duration of the billing period.
|
@@ -4147,9 +4089,11 @@ module Orb
|
|
4147
4089
|
# @!attribute duration_unit
|
4148
4090
|
# The unit of billing period duration.
|
4149
4091
|
#
|
4150
|
-
# @return [Symbol, Orb::
|
4092
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::GroupedAllocation::InvoicingCycleConfiguration::DurationUnit]
|
4151
4093
|
required :duration_unit,
|
4152
|
-
enum: -> {
|
4094
|
+
enum: -> {
|
4095
|
+
Orb::PlanCreateParams::Price::GroupedAllocation::InvoicingCycleConfiguration::DurationUnit
|
4096
|
+
}
|
4153
4097
|
|
4154
4098
|
# @!method initialize(duration:, duration_unit:)
|
4155
4099
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
@@ -4157,11 +4101,11 @@ module Orb
|
|
4157
4101
|
#
|
4158
4102
|
# @param duration [Integer] The duration of the billing period.
|
4159
4103
|
#
|
4160
|
-
# @param duration_unit [Symbol, Orb::
|
4104
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::GroupedAllocation::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
4161
4105
|
|
4162
4106
|
# The unit of billing period duration.
|
4163
4107
|
#
|
4164
|
-
# @see Orb::
|
4108
|
+
# @see Orb::PlanCreateParams::Price::GroupedAllocation::InvoicingCycleConfiguration#duration_unit
|
4165
4109
|
module DurationUnit
|
4166
4110
|
extend Orb::Internal::Type::Enum
|
4167
4111
|
|
@@ -4178,8 +4122,8 @@ module Orb
|
|
4178
4122
|
# @!attribute cadence
|
4179
4123
|
# The cadence to bill for this price on.
|
4180
4124
|
#
|
4181
|
-
# @return [Symbol, Orb::
|
4182
|
-
required :cadence, enum: -> { Orb::
|
4125
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::GroupedWithProratedMinimum::Cadence]
|
4126
|
+
required :cadence, enum: -> { Orb::PlanCreateParams::Price::GroupedWithProratedMinimum::Cadence }
|
4183
4127
|
|
4184
4128
|
# @!attribute grouped_with_prorated_minimum_config
|
4185
4129
|
#
|
@@ -4222,9 +4166,9 @@ module Orb
|
|
4222
4166
|
# For custom cadence: specifies the duration of the billing period in days or
|
4223
4167
|
# months.
|
4224
4168
|
#
|
4225
|
-
# @return [Orb::
|
4169
|
+
# @return [Orb::PlanCreateParams::Price::GroupedWithProratedMinimum::BillingCycleConfiguration, nil]
|
4226
4170
|
optional :billing_cycle_configuration,
|
4227
|
-
-> { Orb::
|
4171
|
+
-> { Orb::PlanCreateParams::Price::GroupedWithProratedMinimum::BillingCycleConfiguration },
|
4228
4172
|
nil?: true
|
4229
4173
|
|
4230
4174
|
# @!attribute conversion_rate
|
@@ -4263,9 +4207,11 @@ module Orb
|
|
4263
4207
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
4264
4208
|
# If unspecified, a single invoice is produced per billing cycle.
|
4265
4209
|
#
|
4266
|
-
# @return [Orb::
|
4210
|
+
# @return [Orb::PlanCreateParams::Price::GroupedWithProratedMinimum::InvoicingCycleConfiguration, nil]
|
4267
4211
|
optional :invoicing_cycle_configuration,
|
4268
|
-
-> {
|
4212
|
+
-> {
|
4213
|
+
Orb::PlanCreateParams::Price::GroupedWithProratedMinimum::InvoicingCycleConfiguration
|
4214
|
+
},
|
4269
4215
|
nil?: true
|
4270
4216
|
|
4271
4217
|
# @!attribute metadata
|
@@ -4278,10 +4224,9 @@ module Orb
|
|
4278
4224
|
|
4279
4225
|
# @!method initialize(cadence:, grouped_with_prorated_minimum_config:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :grouped_with_prorated_minimum)
|
4280
4226
|
# Some parameter documentations has been truncated, see
|
4281
|
-
# {Orb::
|
4282
|
-
# details.
|
4227
|
+
# {Orb::PlanCreateParams::Price::GroupedWithProratedMinimum} for more details.
|
4283
4228
|
#
|
4284
|
-
# @param cadence [Symbol, Orb::
|
4229
|
+
# @param cadence [Symbol, Orb::PlanCreateParams::Price::GroupedWithProratedMinimum::Cadence] The cadence to bill for this price on.
|
4285
4230
|
#
|
4286
4231
|
# @param grouped_with_prorated_minimum_config [Hash{Symbol=>Object}]
|
4287
4232
|
#
|
@@ -4290,37 +4235,30 @@ module Orb
|
|
4290
4235
|
# @param name [String] The name of the price.
|
4291
4236
|
#
|
4292
4237
|
# @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b
|
4293
|
-
# ...
|
4294
4238
|
#
|
4295
4239
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
4296
|
-
# ...
|
4297
4240
|
#
|
4298
|
-
# @param billing_cycle_configuration [Orb::
|
4299
|
-
# ...
|
4241
|
+
# @param billing_cycle_configuration [Orb::PlanCreateParams::Price::GroupedWithProratedMinimum::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
4300
4242
|
#
|
4301
4243
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
4302
4244
|
#
|
4303
4245
|
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
4304
|
-
# ...
|
4305
4246
|
#
|
4306
4247
|
# @param external_price_id [String, nil] An alias for the price.
|
4307
4248
|
#
|
4308
4249
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
4309
|
-
# ...
|
4310
4250
|
#
|
4311
4251
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
4312
4252
|
#
|
4313
|
-
# @param invoicing_cycle_configuration [Orb::
|
4314
|
-
# ...
|
4253
|
+
# @param invoicing_cycle_configuration [Orb::PlanCreateParams::Price::GroupedWithProratedMinimum::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
4315
4254
|
#
|
4316
4255
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
4317
|
-
# ...
|
4318
4256
|
#
|
4319
4257
|
# @param model_type [Symbol, :grouped_with_prorated_minimum]
|
4320
4258
|
|
4321
4259
|
# The cadence to bill for this price on.
|
4322
4260
|
#
|
4323
|
-
# @see Orb::
|
4261
|
+
# @see Orb::PlanCreateParams::Price::GroupedWithProratedMinimum#cadence
|
4324
4262
|
module Cadence
|
4325
4263
|
extend Orb::Internal::Type::Enum
|
4326
4264
|
|
@@ -4335,7 +4273,7 @@ module Orb
|
|
4335
4273
|
# @return [Array<Symbol>]
|
4336
4274
|
end
|
4337
4275
|
|
4338
|
-
# @see Orb::
|
4276
|
+
# @see Orb::PlanCreateParams::Price::GroupedWithProratedMinimum#billing_cycle_configuration
|
4339
4277
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
4340
4278
|
# @!attribute duration
|
4341
4279
|
# The duration of the billing period.
|
@@ -4346,9 +4284,11 @@ module Orb
|
|
4346
4284
|
# @!attribute duration_unit
|
4347
4285
|
# The unit of billing period duration.
|
4348
4286
|
#
|
4349
|
-
# @return [Symbol, Orb::
|
4287
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::GroupedWithProratedMinimum::BillingCycleConfiguration::DurationUnit]
|
4350
4288
|
required :duration_unit,
|
4351
|
-
enum: -> {
|
4289
|
+
enum: -> {
|
4290
|
+
Orb::PlanCreateParams::Price::GroupedWithProratedMinimum::BillingCycleConfiguration::DurationUnit
|
4291
|
+
}
|
4352
4292
|
|
4353
4293
|
# @!method initialize(duration:, duration_unit:)
|
4354
4294
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -4356,11 +4296,11 @@ module Orb
|
|
4356
4296
|
#
|
4357
4297
|
# @param duration [Integer] The duration of the billing period.
|
4358
4298
|
#
|
4359
|
-
# @param duration_unit [Symbol, Orb::
|
4299
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::GroupedWithProratedMinimum::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
4360
4300
|
|
4361
4301
|
# The unit of billing period duration.
|
4362
4302
|
#
|
4363
|
-
# @see Orb::
|
4303
|
+
# @see Orb::PlanCreateParams::Price::GroupedWithProratedMinimum::BillingCycleConfiguration#duration_unit
|
4364
4304
|
module DurationUnit
|
4365
4305
|
extend Orb::Internal::Type::Enum
|
4366
4306
|
|
@@ -4372,7 +4312,7 @@ module Orb
|
|
4372
4312
|
end
|
4373
4313
|
end
|
4374
4314
|
|
4375
|
-
# @see Orb::
|
4315
|
+
# @see Orb::PlanCreateParams::Price::GroupedWithProratedMinimum#invoicing_cycle_configuration
|
4376
4316
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
4377
4317
|
# @!attribute duration
|
4378
4318
|
# The duration of the billing period.
|
@@ -4383,9 +4323,11 @@ module Orb
|
|
4383
4323
|
# @!attribute duration_unit
|
4384
4324
|
# The unit of billing period duration.
|
4385
4325
|
#
|
4386
|
-
# @return [Symbol, Orb::
|
4326
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::GroupedWithProratedMinimum::InvoicingCycleConfiguration::DurationUnit]
|
4387
4327
|
required :duration_unit,
|
4388
|
-
enum: -> {
|
4328
|
+
enum: -> {
|
4329
|
+
Orb::PlanCreateParams::Price::GroupedWithProratedMinimum::InvoicingCycleConfiguration::DurationUnit
|
4330
|
+
}
|
4389
4331
|
|
4390
4332
|
# @!method initialize(duration:, duration_unit:)
|
4391
4333
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
@@ -4393,11 +4335,11 @@ module Orb
|
|
4393
4335
|
#
|
4394
4336
|
# @param duration [Integer] The duration of the billing period.
|
4395
4337
|
#
|
4396
|
-
# @param duration_unit [Symbol, Orb::
|
4338
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::GroupedWithProratedMinimum::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
4397
4339
|
|
4398
4340
|
# The unit of billing period duration.
|
4399
4341
|
#
|
4400
|
-
# @see Orb::
|
4342
|
+
# @see Orb::PlanCreateParams::Price::GroupedWithProratedMinimum::InvoicingCycleConfiguration#duration_unit
|
4401
4343
|
module DurationUnit
|
4402
4344
|
extend Orb::Internal::Type::Enum
|
4403
4345
|
|
@@ -4414,8 +4356,8 @@ module Orb
|
|
4414
4356
|
# @!attribute cadence
|
4415
4357
|
# The cadence to bill for this price on.
|
4416
4358
|
#
|
4417
|
-
# @return [Symbol, Orb::
|
4418
|
-
required :cadence, enum: -> { Orb::
|
4359
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::GroupedWithMeteredMinimum::Cadence]
|
4360
|
+
required :cadence, enum: -> { Orb::PlanCreateParams::Price::GroupedWithMeteredMinimum::Cadence }
|
4419
4361
|
|
4420
4362
|
# @!attribute grouped_with_metered_minimum_config
|
4421
4363
|
#
|
@@ -4458,9 +4400,9 @@ module Orb
|
|
4458
4400
|
# For custom cadence: specifies the duration of the billing period in days or
|
4459
4401
|
# months.
|
4460
4402
|
#
|
4461
|
-
# @return [Orb::
|
4403
|
+
# @return [Orb::PlanCreateParams::Price::GroupedWithMeteredMinimum::BillingCycleConfiguration, nil]
|
4462
4404
|
optional :billing_cycle_configuration,
|
4463
|
-
-> { Orb::
|
4405
|
+
-> { Orb::PlanCreateParams::Price::GroupedWithMeteredMinimum::BillingCycleConfiguration },
|
4464
4406
|
nil?: true
|
4465
4407
|
|
4466
4408
|
# @!attribute conversion_rate
|
@@ -4499,9 +4441,11 @@ module Orb
|
|
4499
4441
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
4500
4442
|
# If unspecified, a single invoice is produced per billing cycle.
|
4501
4443
|
#
|
4502
|
-
# @return [Orb::
|
4444
|
+
# @return [Orb::PlanCreateParams::Price::GroupedWithMeteredMinimum::InvoicingCycleConfiguration, nil]
|
4503
4445
|
optional :invoicing_cycle_configuration,
|
4504
|
-
-> {
|
4446
|
+
-> {
|
4447
|
+
Orb::PlanCreateParams::Price::GroupedWithMeteredMinimum::InvoicingCycleConfiguration
|
4448
|
+
},
|
4505
4449
|
nil?: true
|
4506
4450
|
|
4507
4451
|
# @!attribute metadata
|
@@ -4514,10 +4458,9 @@ module Orb
|
|
4514
4458
|
|
4515
4459
|
# @!method initialize(cadence:, grouped_with_metered_minimum_config:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :grouped_with_metered_minimum)
|
4516
4460
|
# Some parameter documentations has been truncated, see
|
4517
|
-
# {Orb::
|
4518
|
-
# details.
|
4461
|
+
# {Orb::PlanCreateParams::Price::GroupedWithMeteredMinimum} for more details.
|
4519
4462
|
#
|
4520
|
-
# @param cadence [Symbol, Orb::
|
4463
|
+
# @param cadence [Symbol, Orb::PlanCreateParams::Price::GroupedWithMeteredMinimum::Cadence] The cadence to bill for this price on.
|
4521
4464
|
#
|
4522
4465
|
# @param grouped_with_metered_minimum_config [Hash{Symbol=>Object}]
|
4523
4466
|
#
|
@@ -4526,37 +4469,30 @@ module Orb
|
|
4526
4469
|
# @param name [String] The name of the price.
|
4527
4470
|
#
|
4528
4471
|
# @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b
|
4529
|
-
# ...
|
4530
4472
|
#
|
4531
4473
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
4532
|
-
# ...
|
4533
4474
|
#
|
4534
|
-
# @param billing_cycle_configuration [Orb::
|
4535
|
-
# ...
|
4475
|
+
# @param billing_cycle_configuration [Orb::PlanCreateParams::Price::GroupedWithMeteredMinimum::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
4536
4476
|
#
|
4537
4477
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
4538
4478
|
#
|
4539
4479
|
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
4540
|
-
# ...
|
4541
4480
|
#
|
4542
4481
|
# @param external_price_id [String, nil] An alias for the price.
|
4543
4482
|
#
|
4544
4483
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
4545
|
-
# ...
|
4546
4484
|
#
|
4547
4485
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
4548
4486
|
#
|
4549
|
-
# @param invoicing_cycle_configuration [Orb::
|
4550
|
-
# ...
|
4487
|
+
# @param invoicing_cycle_configuration [Orb::PlanCreateParams::Price::GroupedWithMeteredMinimum::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
4551
4488
|
#
|
4552
4489
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
4553
|
-
# ...
|
4554
4490
|
#
|
4555
4491
|
# @param model_type [Symbol, :grouped_with_metered_minimum]
|
4556
4492
|
|
4557
4493
|
# The cadence to bill for this price on.
|
4558
4494
|
#
|
4559
|
-
# @see Orb::
|
4495
|
+
# @see Orb::PlanCreateParams::Price::GroupedWithMeteredMinimum#cadence
|
4560
4496
|
module Cadence
|
4561
4497
|
extend Orb::Internal::Type::Enum
|
4562
4498
|
|
@@ -4571,7 +4507,7 @@ module Orb
|
|
4571
4507
|
# @return [Array<Symbol>]
|
4572
4508
|
end
|
4573
4509
|
|
4574
|
-
# @see Orb::
|
4510
|
+
# @see Orb::PlanCreateParams::Price::GroupedWithMeteredMinimum#billing_cycle_configuration
|
4575
4511
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
4576
4512
|
# @!attribute duration
|
4577
4513
|
# The duration of the billing period.
|
@@ -4582,9 +4518,11 @@ module Orb
|
|
4582
4518
|
# @!attribute duration_unit
|
4583
4519
|
# The unit of billing period duration.
|
4584
4520
|
#
|
4585
|
-
# @return [Symbol, Orb::
|
4521
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::GroupedWithMeteredMinimum::BillingCycleConfiguration::DurationUnit]
|
4586
4522
|
required :duration_unit,
|
4587
|
-
enum: -> {
|
4523
|
+
enum: -> {
|
4524
|
+
Orb::PlanCreateParams::Price::GroupedWithMeteredMinimum::BillingCycleConfiguration::DurationUnit
|
4525
|
+
}
|
4588
4526
|
|
4589
4527
|
# @!method initialize(duration:, duration_unit:)
|
4590
4528
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -4592,11 +4530,11 @@ module Orb
|
|
4592
4530
|
#
|
4593
4531
|
# @param duration [Integer] The duration of the billing period.
|
4594
4532
|
#
|
4595
|
-
# @param duration_unit [Symbol, Orb::
|
4533
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::GroupedWithMeteredMinimum::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
4596
4534
|
|
4597
4535
|
# The unit of billing period duration.
|
4598
4536
|
#
|
4599
|
-
# @see Orb::
|
4537
|
+
# @see Orb::PlanCreateParams::Price::GroupedWithMeteredMinimum::BillingCycleConfiguration#duration_unit
|
4600
4538
|
module DurationUnit
|
4601
4539
|
extend Orb::Internal::Type::Enum
|
4602
4540
|
|
@@ -4608,7 +4546,7 @@ module Orb
|
|
4608
4546
|
end
|
4609
4547
|
end
|
4610
4548
|
|
4611
|
-
# @see Orb::
|
4549
|
+
# @see Orb::PlanCreateParams::Price::GroupedWithMeteredMinimum#invoicing_cycle_configuration
|
4612
4550
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
4613
4551
|
# @!attribute duration
|
4614
4552
|
# The duration of the billing period.
|
@@ -4619,9 +4557,11 @@ module Orb
|
|
4619
4557
|
# @!attribute duration_unit
|
4620
4558
|
# The unit of billing period duration.
|
4621
4559
|
#
|
4622
|
-
# @return [Symbol, Orb::
|
4560
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::GroupedWithMeteredMinimum::InvoicingCycleConfiguration::DurationUnit]
|
4623
4561
|
required :duration_unit,
|
4624
|
-
enum: -> {
|
4562
|
+
enum: -> {
|
4563
|
+
Orb::PlanCreateParams::Price::GroupedWithMeteredMinimum::InvoicingCycleConfiguration::DurationUnit
|
4564
|
+
}
|
4625
4565
|
|
4626
4566
|
# @!method initialize(duration:, duration_unit:)
|
4627
4567
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
@@ -4629,11 +4569,11 @@ module Orb
|
|
4629
4569
|
#
|
4630
4570
|
# @param duration [Integer] The duration of the billing period.
|
4631
4571
|
#
|
4632
|
-
# @param duration_unit [Symbol, Orb::
|
4572
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::GroupedWithMeteredMinimum::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
4633
4573
|
|
4634
4574
|
# The unit of billing period duration.
|
4635
4575
|
#
|
4636
|
-
# @see Orb::
|
4576
|
+
# @see Orb::PlanCreateParams::Price::GroupedWithMeteredMinimum::InvoicingCycleConfiguration#duration_unit
|
4637
4577
|
module DurationUnit
|
4638
4578
|
extend Orb::Internal::Type::Enum
|
4639
4579
|
|
@@ -4650,8 +4590,8 @@ module Orb
|
|
4650
4590
|
# @!attribute cadence
|
4651
4591
|
# The cadence to bill for this price on.
|
4652
4592
|
#
|
4653
|
-
# @return [Symbol, Orb::
|
4654
|
-
required :cadence, enum: -> { Orb::
|
4593
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::MatrixWithDisplayName::Cadence]
|
4594
|
+
required :cadence, enum: -> { Orb::PlanCreateParams::Price::MatrixWithDisplayName::Cadence }
|
4655
4595
|
|
4656
4596
|
# @!attribute item_id
|
4657
4597
|
# The id of the item the price will be associated with.
|
@@ -4693,9 +4633,9 @@ module Orb
|
|
4693
4633
|
# For custom cadence: specifies the duration of the billing period in days or
|
4694
4634
|
# months.
|
4695
4635
|
#
|
4696
|
-
# @return [Orb::
|
4636
|
+
# @return [Orb::PlanCreateParams::Price::MatrixWithDisplayName::BillingCycleConfiguration, nil]
|
4697
4637
|
optional :billing_cycle_configuration,
|
4698
|
-
-> { Orb::
|
4638
|
+
-> { Orb::PlanCreateParams::Price::MatrixWithDisplayName::BillingCycleConfiguration },
|
4699
4639
|
nil?: true
|
4700
4640
|
|
4701
4641
|
# @!attribute conversion_rate
|
@@ -4734,9 +4674,9 @@ module Orb
|
|
4734
4674
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
4735
4675
|
# If unspecified, a single invoice is produced per billing cycle.
|
4736
4676
|
#
|
4737
|
-
# @return [Orb::
|
4677
|
+
# @return [Orb::PlanCreateParams::Price::MatrixWithDisplayName::InvoicingCycleConfiguration, nil]
|
4738
4678
|
optional :invoicing_cycle_configuration,
|
4739
|
-
-> { Orb::
|
4679
|
+
-> { Orb::PlanCreateParams::Price::MatrixWithDisplayName::InvoicingCycleConfiguration },
|
4740
4680
|
nil?: true
|
4741
4681
|
|
4742
4682
|
# @!attribute metadata
|
@@ -4749,9 +4689,9 @@ module Orb
|
|
4749
4689
|
|
4750
4690
|
# @!method initialize(cadence:, item_id:, matrix_with_display_name_config:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :matrix_with_display_name)
|
4751
4691
|
# Some parameter documentations has been truncated, see
|
4752
|
-
# {Orb::
|
4692
|
+
# {Orb::PlanCreateParams::Price::MatrixWithDisplayName} for more details.
|
4753
4693
|
#
|
4754
|
-
# @param cadence [Symbol, Orb::
|
4694
|
+
# @param cadence [Symbol, Orb::PlanCreateParams::Price::MatrixWithDisplayName::Cadence] The cadence to bill for this price on.
|
4755
4695
|
#
|
4756
4696
|
# @param item_id [String] The id of the item the price will be associated with.
|
4757
4697
|
#
|
@@ -4760,37 +4700,30 @@ module Orb
|
|
4760
4700
|
# @param name [String] The name of the price.
|
4761
4701
|
#
|
4762
4702
|
# @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b
|
4763
|
-
# ...
|
4764
4703
|
#
|
4765
4704
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
4766
|
-
# ...
|
4767
4705
|
#
|
4768
|
-
# @param billing_cycle_configuration [Orb::
|
4769
|
-
# ...
|
4706
|
+
# @param billing_cycle_configuration [Orb::PlanCreateParams::Price::MatrixWithDisplayName::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
4770
4707
|
#
|
4771
4708
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
4772
4709
|
#
|
4773
4710
|
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
4774
|
-
# ...
|
4775
4711
|
#
|
4776
4712
|
# @param external_price_id [String, nil] An alias for the price.
|
4777
4713
|
#
|
4778
4714
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
4779
|
-
# ...
|
4780
4715
|
#
|
4781
4716
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
4782
4717
|
#
|
4783
|
-
# @param invoicing_cycle_configuration [Orb::
|
4784
|
-
# ...
|
4718
|
+
# @param invoicing_cycle_configuration [Orb::PlanCreateParams::Price::MatrixWithDisplayName::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
4785
4719
|
#
|
4786
4720
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
4787
|
-
# ...
|
4788
4721
|
#
|
4789
4722
|
# @param model_type [Symbol, :matrix_with_display_name]
|
4790
4723
|
|
4791
4724
|
# The cadence to bill for this price on.
|
4792
4725
|
#
|
4793
|
-
# @see Orb::
|
4726
|
+
# @see Orb::PlanCreateParams::Price::MatrixWithDisplayName#cadence
|
4794
4727
|
module Cadence
|
4795
4728
|
extend Orb::Internal::Type::Enum
|
4796
4729
|
|
@@ -4805,7 +4738,7 @@ module Orb
|
|
4805
4738
|
# @return [Array<Symbol>]
|
4806
4739
|
end
|
4807
4740
|
|
4808
|
-
# @see Orb::
|
4741
|
+
# @see Orb::PlanCreateParams::Price::MatrixWithDisplayName#billing_cycle_configuration
|
4809
4742
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
4810
4743
|
# @!attribute duration
|
4811
4744
|
# The duration of the billing period.
|
@@ -4816,9 +4749,11 @@ module Orb
|
|
4816
4749
|
# @!attribute duration_unit
|
4817
4750
|
# The unit of billing period duration.
|
4818
4751
|
#
|
4819
|
-
# @return [Symbol, Orb::
|
4752
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::MatrixWithDisplayName::BillingCycleConfiguration::DurationUnit]
|
4820
4753
|
required :duration_unit,
|
4821
|
-
enum: -> {
|
4754
|
+
enum: -> {
|
4755
|
+
Orb::PlanCreateParams::Price::MatrixWithDisplayName::BillingCycleConfiguration::DurationUnit
|
4756
|
+
}
|
4822
4757
|
|
4823
4758
|
# @!method initialize(duration:, duration_unit:)
|
4824
4759
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -4826,11 +4761,11 @@ module Orb
|
|
4826
4761
|
#
|
4827
4762
|
# @param duration [Integer] The duration of the billing period.
|
4828
4763
|
#
|
4829
|
-
# @param duration_unit [Symbol, Orb::
|
4764
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::MatrixWithDisplayName::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
4830
4765
|
|
4831
4766
|
# The unit of billing period duration.
|
4832
4767
|
#
|
4833
|
-
# @see Orb::
|
4768
|
+
# @see Orb::PlanCreateParams::Price::MatrixWithDisplayName::BillingCycleConfiguration#duration_unit
|
4834
4769
|
module DurationUnit
|
4835
4770
|
extend Orb::Internal::Type::Enum
|
4836
4771
|
|
@@ -4842,7 +4777,7 @@ module Orb
|
|
4842
4777
|
end
|
4843
4778
|
end
|
4844
4779
|
|
4845
|
-
# @see Orb::
|
4780
|
+
# @see Orb::PlanCreateParams::Price::MatrixWithDisplayName#invoicing_cycle_configuration
|
4846
4781
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
4847
4782
|
# @!attribute duration
|
4848
4783
|
# The duration of the billing period.
|
@@ -4853,9 +4788,11 @@ module Orb
|
|
4853
4788
|
# @!attribute duration_unit
|
4854
4789
|
# The unit of billing period duration.
|
4855
4790
|
#
|
4856
|
-
# @return [Symbol, Orb::
|
4791
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::MatrixWithDisplayName::InvoicingCycleConfiguration::DurationUnit]
|
4857
4792
|
required :duration_unit,
|
4858
|
-
enum: -> {
|
4793
|
+
enum: -> {
|
4794
|
+
Orb::PlanCreateParams::Price::MatrixWithDisplayName::InvoicingCycleConfiguration::DurationUnit
|
4795
|
+
}
|
4859
4796
|
|
4860
4797
|
# @!method initialize(duration:, duration_unit:)
|
4861
4798
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
@@ -4863,11 +4800,11 @@ module Orb
|
|
4863
4800
|
#
|
4864
4801
|
# @param duration [Integer] The duration of the billing period.
|
4865
4802
|
#
|
4866
|
-
# @param duration_unit [Symbol, Orb::
|
4803
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::MatrixWithDisplayName::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
4867
4804
|
|
4868
4805
|
# The unit of billing period duration.
|
4869
4806
|
#
|
4870
|
-
# @see Orb::
|
4807
|
+
# @see Orb::PlanCreateParams::Price::MatrixWithDisplayName::InvoicingCycleConfiguration#duration_unit
|
4871
4808
|
module DurationUnit
|
4872
4809
|
extend Orb::Internal::Type::Enum
|
4873
4810
|
|
@@ -4889,8 +4826,8 @@ module Orb
|
|
4889
4826
|
# @!attribute cadence
|
4890
4827
|
# The cadence to bill for this price on.
|
4891
4828
|
#
|
4892
|
-
# @return [Symbol, Orb::
|
4893
|
-
required :cadence, enum: -> { Orb::
|
4829
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::BulkWithProration::Cadence]
|
4830
|
+
required :cadence, enum: -> { Orb::PlanCreateParams::Price::BulkWithProration::Cadence }
|
4894
4831
|
|
4895
4832
|
# @!attribute item_id
|
4896
4833
|
# The id of the item the price will be associated with.
|
@@ -4927,9 +4864,9 @@ module Orb
|
|
4927
4864
|
# For custom cadence: specifies the duration of the billing period in days or
|
4928
4865
|
# months.
|
4929
4866
|
#
|
4930
|
-
# @return [Orb::
|
4867
|
+
# @return [Orb::PlanCreateParams::Price::BulkWithProration::BillingCycleConfiguration, nil]
|
4931
4868
|
optional :billing_cycle_configuration,
|
4932
|
-
-> { Orb::
|
4869
|
+
-> { Orb::PlanCreateParams::Price::BulkWithProration::BillingCycleConfiguration },
|
4933
4870
|
nil?: true
|
4934
4871
|
|
4935
4872
|
# @!attribute conversion_rate
|
@@ -4968,9 +4905,9 @@ module Orb
|
|
4968
4905
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
4969
4906
|
# If unspecified, a single invoice is produced per billing cycle.
|
4970
4907
|
#
|
4971
|
-
# @return [Orb::
|
4908
|
+
# @return [Orb::PlanCreateParams::Price::BulkWithProration::InvoicingCycleConfiguration, nil]
|
4972
4909
|
optional :invoicing_cycle_configuration,
|
4973
|
-
-> { Orb::
|
4910
|
+
-> { Orb::PlanCreateParams::Price::BulkWithProration::InvoicingCycleConfiguration },
|
4974
4911
|
nil?: true
|
4975
4912
|
|
4976
4913
|
# @!attribute metadata
|
@@ -4983,48 +4920,41 @@ module Orb
|
|
4983
4920
|
|
4984
4921
|
# @!method initialize(bulk_with_proration_config:, cadence:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :bulk_with_proration)
|
4985
4922
|
# Some parameter documentations has been truncated, see
|
4986
|
-
# {Orb::
|
4923
|
+
# {Orb::PlanCreateParams::Price::BulkWithProration} for more details.
|
4987
4924
|
#
|
4988
4925
|
# @param bulk_with_proration_config [Hash{Symbol=>Object}]
|
4989
4926
|
#
|
4990
|
-
# @param cadence [Symbol, Orb::
|
4927
|
+
# @param cadence [Symbol, Orb::PlanCreateParams::Price::BulkWithProration::Cadence] The cadence to bill for this price on.
|
4991
4928
|
#
|
4992
4929
|
# @param item_id [String] The id of the item the price will be associated with.
|
4993
4930
|
#
|
4994
4931
|
# @param name [String] The name of the price.
|
4995
4932
|
#
|
4996
4933
|
# @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b
|
4997
|
-
# ...
|
4998
4934
|
#
|
4999
4935
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
5000
|
-
# ...
|
5001
4936
|
#
|
5002
|
-
# @param billing_cycle_configuration [Orb::
|
5003
|
-
# ...
|
4937
|
+
# @param billing_cycle_configuration [Orb::PlanCreateParams::Price::BulkWithProration::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
5004
4938
|
#
|
5005
4939
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
5006
4940
|
#
|
5007
4941
|
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
5008
|
-
# ...
|
5009
4942
|
#
|
5010
4943
|
# @param external_price_id [String, nil] An alias for the price.
|
5011
4944
|
#
|
5012
4945
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
5013
|
-
# ...
|
5014
4946
|
#
|
5015
4947
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
5016
4948
|
#
|
5017
|
-
# @param invoicing_cycle_configuration [Orb::
|
5018
|
-
# ...
|
4949
|
+
# @param invoicing_cycle_configuration [Orb::PlanCreateParams::Price::BulkWithProration::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
5019
4950
|
#
|
5020
4951
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
5021
|
-
# ...
|
5022
4952
|
#
|
5023
4953
|
# @param model_type [Symbol, :bulk_with_proration]
|
5024
4954
|
|
5025
4955
|
# The cadence to bill for this price on.
|
5026
4956
|
#
|
5027
|
-
# @see Orb::
|
4957
|
+
# @see Orb::PlanCreateParams::Price::BulkWithProration#cadence
|
5028
4958
|
module Cadence
|
5029
4959
|
extend Orb::Internal::Type::Enum
|
5030
4960
|
|
@@ -5039,7 +4969,7 @@ module Orb
|
|
5039
4969
|
# @return [Array<Symbol>]
|
5040
4970
|
end
|
5041
4971
|
|
5042
|
-
# @see Orb::
|
4972
|
+
# @see Orb::PlanCreateParams::Price::BulkWithProration#billing_cycle_configuration
|
5043
4973
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
5044
4974
|
# @!attribute duration
|
5045
4975
|
# The duration of the billing period.
|
@@ -5050,9 +4980,11 @@ module Orb
|
|
5050
4980
|
# @!attribute duration_unit
|
5051
4981
|
# The unit of billing period duration.
|
5052
4982
|
#
|
5053
|
-
# @return [Symbol, Orb::
|
4983
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::BulkWithProration::BillingCycleConfiguration::DurationUnit]
|
5054
4984
|
required :duration_unit,
|
5055
|
-
enum: -> {
|
4985
|
+
enum: -> {
|
4986
|
+
Orb::PlanCreateParams::Price::BulkWithProration::BillingCycleConfiguration::DurationUnit
|
4987
|
+
}
|
5056
4988
|
|
5057
4989
|
# @!method initialize(duration:, duration_unit:)
|
5058
4990
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -5060,11 +4992,11 @@ module Orb
|
|
5060
4992
|
#
|
5061
4993
|
# @param duration [Integer] The duration of the billing period.
|
5062
4994
|
#
|
5063
|
-
# @param duration_unit [Symbol, Orb::
|
4995
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::BulkWithProration::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
5064
4996
|
|
5065
4997
|
# The unit of billing period duration.
|
5066
4998
|
#
|
5067
|
-
# @see Orb::
|
4999
|
+
# @see Orb::PlanCreateParams::Price::BulkWithProration::BillingCycleConfiguration#duration_unit
|
5068
5000
|
module DurationUnit
|
5069
5001
|
extend Orb::Internal::Type::Enum
|
5070
5002
|
|
@@ -5076,7 +5008,7 @@ module Orb
|
|
5076
5008
|
end
|
5077
5009
|
end
|
5078
5010
|
|
5079
|
-
# @see Orb::
|
5011
|
+
# @see Orb::PlanCreateParams::Price::BulkWithProration#invoicing_cycle_configuration
|
5080
5012
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
5081
5013
|
# @!attribute duration
|
5082
5014
|
# The duration of the billing period.
|
@@ -5087,9 +5019,11 @@ module Orb
|
|
5087
5019
|
# @!attribute duration_unit
|
5088
5020
|
# The unit of billing period duration.
|
5089
5021
|
#
|
5090
|
-
# @return [Symbol, Orb::
|
5022
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::BulkWithProration::InvoicingCycleConfiguration::DurationUnit]
|
5091
5023
|
required :duration_unit,
|
5092
|
-
enum: -> {
|
5024
|
+
enum: -> {
|
5025
|
+
Orb::PlanCreateParams::Price::BulkWithProration::InvoicingCycleConfiguration::DurationUnit
|
5026
|
+
}
|
5093
5027
|
|
5094
5028
|
# @!method initialize(duration:, duration_unit:)
|
5095
5029
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
@@ -5097,11 +5031,11 @@ module Orb
|
|
5097
5031
|
#
|
5098
5032
|
# @param duration [Integer] The duration of the billing period.
|
5099
5033
|
#
|
5100
|
-
# @param duration_unit [Symbol, Orb::
|
5034
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::BulkWithProration::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
5101
5035
|
|
5102
5036
|
# The unit of billing period duration.
|
5103
5037
|
#
|
5104
|
-
# @see Orb::
|
5038
|
+
# @see Orb::PlanCreateParams::Price::BulkWithProration::InvoicingCycleConfiguration#duration_unit
|
5105
5039
|
module DurationUnit
|
5106
5040
|
extend Orb::Internal::Type::Enum
|
5107
5041
|
|
@@ -5118,8 +5052,8 @@ module Orb
|
|
5118
5052
|
# @!attribute cadence
|
5119
5053
|
# The cadence to bill for this price on.
|
5120
5054
|
#
|
5121
|
-
# @return [Symbol, Orb::
|
5122
|
-
required :cadence, enum: -> { Orb::
|
5055
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::GroupedTieredPackage::Cadence]
|
5056
|
+
required :cadence, enum: -> { Orb::PlanCreateParams::Price::GroupedTieredPackage::Cadence }
|
5123
5057
|
|
5124
5058
|
# @!attribute grouped_tiered_package_config
|
5125
5059
|
#
|
@@ -5161,9 +5095,9 @@ module Orb
|
|
5161
5095
|
# For custom cadence: specifies the duration of the billing period in days or
|
5162
5096
|
# months.
|
5163
5097
|
#
|
5164
|
-
# @return [Orb::
|
5098
|
+
# @return [Orb::PlanCreateParams::Price::GroupedTieredPackage::BillingCycleConfiguration, nil]
|
5165
5099
|
optional :billing_cycle_configuration,
|
5166
|
-
-> { Orb::
|
5100
|
+
-> { Orb::PlanCreateParams::Price::GroupedTieredPackage::BillingCycleConfiguration },
|
5167
5101
|
nil?: true
|
5168
5102
|
|
5169
5103
|
# @!attribute conversion_rate
|
@@ -5202,9 +5136,9 @@ module Orb
|
|
5202
5136
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
5203
5137
|
# If unspecified, a single invoice is produced per billing cycle.
|
5204
5138
|
#
|
5205
|
-
# @return [Orb::
|
5139
|
+
# @return [Orb::PlanCreateParams::Price::GroupedTieredPackage::InvoicingCycleConfiguration, nil]
|
5206
5140
|
optional :invoicing_cycle_configuration,
|
5207
|
-
-> { Orb::
|
5141
|
+
-> { Orb::PlanCreateParams::Price::GroupedTieredPackage::InvoicingCycleConfiguration },
|
5208
5142
|
nil?: true
|
5209
5143
|
|
5210
5144
|
# @!attribute metadata
|
@@ -5217,9 +5151,9 @@ module Orb
|
|
5217
5151
|
|
5218
5152
|
# @!method initialize(cadence:, grouped_tiered_package_config:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :grouped_tiered_package)
|
5219
5153
|
# Some parameter documentations has been truncated, see
|
5220
|
-
# {Orb::
|
5154
|
+
# {Orb::PlanCreateParams::Price::GroupedTieredPackage} for more details.
|
5221
5155
|
#
|
5222
|
-
# @param cadence [Symbol, Orb::
|
5156
|
+
# @param cadence [Symbol, Orb::PlanCreateParams::Price::GroupedTieredPackage::Cadence] The cadence to bill for this price on.
|
5223
5157
|
#
|
5224
5158
|
# @param grouped_tiered_package_config [Hash{Symbol=>Object}]
|
5225
5159
|
#
|
@@ -5228,37 +5162,30 @@ module Orb
|
|
5228
5162
|
# @param name [String] The name of the price.
|
5229
5163
|
#
|
5230
5164
|
# @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b
|
5231
|
-
# ...
|
5232
5165
|
#
|
5233
5166
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
5234
|
-
# ...
|
5235
5167
|
#
|
5236
|
-
# @param billing_cycle_configuration [Orb::
|
5237
|
-
# ...
|
5168
|
+
# @param billing_cycle_configuration [Orb::PlanCreateParams::Price::GroupedTieredPackage::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
5238
5169
|
#
|
5239
5170
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
5240
5171
|
#
|
5241
5172
|
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
5242
|
-
# ...
|
5243
5173
|
#
|
5244
5174
|
# @param external_price_id [String, nil] An alias for the price.
|
5245
5175
|
#
|
5246
5176
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
5247
|
-
# ...
|
5248
5177
|
#
|
5249
5178
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
5250
5179
|
#
|
5251
|
-
# @param invoicing_cycle_configuration [Orb::
|
5252
|
-
# ...
|
5180
|
+
# @param invoicing_cycle_configuration [Orb::PlanCreateParams::Price::GroupedTieredPackage::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
5253
5181
|
#
|
5254
5182
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
5255
|
-
# ...
|
5256
5183
|
#
|
5257
5184
|
# @param model_type [Symbol, :grouped_tiered_package]
|
5258
5185
|
|
5259
5186
|
# The cadence to bill for this price on.
|
5260
5187
|
#
|
5261
|
-
# @see Orb::
|
5188
|
+
# @see Orb::PlanCreateParams::Price::GroupedTieredPackage#cadence
|
5262
5189
|
module Cadence
|
5263
5190
|
extend Orb::Internal::Type::Enum
|
5264
5191
|
|
@@ -5273,7 +5200,7 @@ module Orb
|
|
5273
5200
|
# @return [Array<Symbol>]
|
5274
5201
|
end
|
5275
5202
|
|
5276
|
-
# @see Orb::
|
5203
|
+
# @see Orb::PlanCreateParams::Price::GroupedTieredPackage#billing_cycle_configuration
|
5277
5204
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
5278
5205
|
# @!attribute duration
|
5279
5206
|
# The duration of the billing period.
|
@@ -5284,9 +5211,11 @@ module Orb
|
|
5284
5211
|
# @!attribute duration_unit
|
5285
5212
|
# The unit of billing period duration.
|
5286
5213
|
#
|
5287
|
-
# @return [Symbol, Orb::
|
5214
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::GroupedTieredPackage::BillingCycleConfiguration::DurationUnit]
|
5288
5215
|
required :duration_unit,
|
5289
|
-
enum: -> {
|
5216
|
+
enum: -> {
|
5217
|
+
Orb::PlanCreateParams::Price::GroupedTieredPackage::BillingCycleConfiguration::DurationUnit
|
5218
|
+
}
|
5290
5219
|
|
5291
5220
|
# @!method initialize(duration:, duration_unit:)
|
5292
5221
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -5294,11 +5223,11 @@ module Orb
|
|
5294
5223
|
#
|
5295
5224
|
# @param duration [Integer] The duration of the billing period.
|
5296
5225
|
#
|
5297
|
-
# @param duration_unit [Symbol, Orb::
|
5226
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::GroupedTieredPackage::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
5298
5227
|
|
5299
5228
|
# The unit of billing period duration.
|
5300
5229
|
#
|
5301
|
-
# @see Orb::
|
5230
|
+
# @see Orb::PlanCreateParams::Price::GroupedTieredPackage::BillingCycleConfiguration#duration_unit
|
5302
5231
|
module DurationUnit
|
5303
5232
|
extend Orb::Internal::Type::Enum
|
5304
5233
|
|
@@ -5310,7 +5239,7 @@ module Orb
|
|
5310
5239
|
end
|
5311
5240
|
end
|
5312
5241
|
|
5313
|
-
# @see Orb::
|
5242
|
+
# @see Orb::PlanCreateParams::Price::GroupedTieredPackage#invoicing_cycle_configuration
|
5314
5243
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
5315
5244
|
# @!attribute duration
|
5316
5245
|
# The duration of the billing period.
|
@@ -5321,9 +5250,11 @@ module Orb
|
|
5321
5250
|
# @!attribute duration_unit
|
5322
5251
|
# The unit of billing period duration.
|
5323
5252
|
#
|
5324
|
-
# @return [Symbol, Orb::
|
5253
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::GroupedTieredPackage::InvoicingCycleConfiguration::DurationUnit]
|
5325
5254
|
required :duration_unit,
|
5326
|
-
enum: -> {
|
5255
|
+
enum: -> {
|
5256
|
+
Orb::PlanCreateParams::Price::GroupedTieredPackage::InvoicingCycleConfiguration::DurationUnit
|
5257
|
+
}
|
5327
5258
|
|
5328
5259
|
# @!method initialize(duration:, duration_unit:)
|
5329
5260
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
@@ -5331,11 +5262,11 @@ module Orb
|
|
5331
5262
|
#
|
5332
5263
|
# @param duration [Integer] The duration of the billing period.
|
5333
5264
|
#
|
5334
|
-
# @param duration_unit [Symbol, Orb::
|
5265
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::GroupedTieredPackage::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
5335
5266
|
|
5336
5267
|
# The unit of billing period duration.
|
5337
5268
|
#
|
5338
|
-
# @see Orb::
|
5269
|
+
# @see Orb::PlanCreateParams::Price::GroupedTieredPackage::InvoicingCycleConfiguration#duration_unit
|
5339
5270
|
module DurationUnit
|
5340
5271
|
extend Orb::Internal::Type::Enum
|
5341
5272
|
|
@@ -5352,8 +5283,8 @@ module Orb
|
|
5352
5283
|
# @!attribute cadence
|
5353
5284
|
# The cadence to bill for this price on.
|
5354
5285
|
#
|
5355
|
-
# @return [Symbol, Orb::
|
5356
|
-
required :cadence, enum: -> { Orb::
|
5286
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::MaxGroupTieredPackage::Cadence]
|
5287
|
+
required :cadence, enum: -> { Orb::PlanCreateParams::Price::MaxGroupTieredPackage::Cadence }
|
5357
5288
|
|
5358
5289
|
# @!attribute item_id
|
5359
5290
|
# The id of the item the price will be associated with.
|
@@ -5395,9 +5326,9 @@ module Orb
|
|
5395
5326
|
# For custom cadence: specifies the duration of the billing period in days or
|
5396
5327
|
# months.
|
5397
5328
|
#
|
5398
|
-
# @return [Orb::
|
5329
|
+
# @return [Orb::PlanCreateParams::Price::MaxGroupTieredPackage::BillingCycleConfiguration, nil]
|
5399
5330
|
optional :billing_cycle_configuration,
|
5400
|
-
-> { Orb::
|
5331
|
+
-> { Orb::PlanCreateParams::Price::MaxGroupTieredPackage::BillingCycleConfiguration },
|
5401
5332
|
nil?: true
|
5402
5333
|
|
5403
5334
|
# @!attribute conversion_rate
|
@@ -5436,9 +5367,9 @@ module Orb
|
|
5436
5367
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
5437
5368
|
# If unspecified, a single invoice is produced per billing cycle.
|
5438
5369
|
#
|
5439
|
-
# @return [Orb::
|
5370
|
+
# @return [Orb::PlanCreateParams::Price::MaxGroupTieredPackage::InvoicingCycleConfiguration, nil]
|
5440
5371
|
optional :invoicing_cycle_configuration,
|
5441
|
-
-> { Orb::
|
5372
|
+
-> { Orb::PlanCreateParams::Price::MaxGroupTieredPackage::InvoicingCycleConfiguration },
|
5442
5373
|
nil?: true
|
5443
5374
|
|
5444
5375
|
# @!attribute metadata
|
@@ -5451,9 +5382,9 @@ module Orb
|
|
5451
5382
|
|
5452
5383
|
# @!method initialize(cadence:, item_id:, max_group_tiered_package_config:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :max_group_tiered_package)
|
5453
5384
|
# Some parameter documentations has been truncated, see
|
5454
|
-
# {Orb::
|
5385
|
+
# {Orb::PlanCreateParams::Price::MaxGroupTieredPackage} for more details.
|
5455
5386
|
#
|
5456
|
-
# @param cadence [Symbol, Orb::
|
5387
|
+
# @param cadence [Symbol, Orb::PlanCreateParams::Price::MaxGroupTieredPackage::Cadence] The cadence to bill for this price on.
|
5457
5388
|
#
|
5458
5389
|
# @param item_id [String] The id of the item the price will be associated with.
|
5459
5390
|
#
|
@@ -5462,37 +5393,30 @@ module Orb
|
|
5462
5393
|
# @param name [String] The name of the price.
|
5463
5394
|
#
|
5464
5395
|
# @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b
|
5465
|
-
# ...
|
5466
5396
|
#
|
5467
5397
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
5468
|
-
# ...
|
5469
5398
|
#
|
5470
|
-
# @param billing_cycle_configuration [Orb::
|
5471
|
-
# ...
|
5399
|
+
# @param billing_cycle_configuration [Orb::PlanCreateParams::Price::MaxGroupTieredPackage::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
5472
5400
|
#
|
5473
5401
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
5474
5402
|
#
|
5475
5403
|
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
5476
|
-
# ...
|
5477
5404
|
#
|
5478
5405
|
# @param external_price_id [String, nil] An alias for the price.
|
5479
5406
|
#
|
5480
5407
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
5481
|
-
# ...
|
5482
5408
|
#
|
5483
5409
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
5484
5410
|
#
|
5485
|
-
# @param invoicing_cycle_configuration [Orb::
|
5486
|
-
# ...
|
5411
|
+
# @param invoicing_cycle_configuration [Orb::PlanCreateParams::Price::MaxGroupTieredPackage::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
5487
5412
|
#
|
5488
5413
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
5489
|
-
# ...
|
5490
5414
|
#
|
5491
5415
|
# @param model_type [Symbol, :max_group_tiered_package]
|
5492
5416
|
|
5493
5417
|
# The cadence to bill for this price on.
|
5494
5418
|
#
|
5495
|
-
# @see Orb::
|
5419
|
+
# @see Orb::PlanCreateParams::Price::MaxGroupTieredPackage#cadence
|
5496
5420
|
module Cadence
|
5497
5421
|
extend Orb::Internal::Type::Enum
|
5498
5422
|
|
@@ -5507,7 +5431,7 @@ module Orb
|
|
5507
5431
|
# @return [Array<Symbol>]
|
5508
5432
|
end
|
5509
5433
|
|
5510
|
-
# @see Orb::
|
5434
|
+
# @see Orb::PlanCreateParams::Price::MaxGroupTieredPackage#billing_cycle_configuration
|
5511
5435
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
5512
5436
|
# @!attribute duration
|
5513
5437
|
# The duration of the billing period.
|
@@ -5518,9 +5442,11 @@ module Orb
|
|
5518
5442
|
# @!attribute duration_unit
|
5519
5443
|
# The unit of billing period duration.
|
5520
5444
|
#
|
5521
|
-
# @return [Symbol, Orb::
|
5445
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::MaxGroupTieredPackage::BillingCycleConfiguration::DurationUnit]
|
5522
5446
|
required :duration_unit,
|
5523
|
-
enum: -> {
|
5447
|
+
enum: -> {
|
5448
|
+
Orb::PlanCreateParams::Price::MaxGroupTieredPackage::BillingCycleConfiguration::DurationUnit
|
5449
|
+
}
|
5524
5450
|
|
5525
5451
|
# @!method initialize(duration:, duration_unit:)
|
5526
5452
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -5528,11 +5454,11 @@ module Orb
|
|
5528
5454
|
#
|
5529
5455
|
# @param duration [Integer] The duration of the billing period.
|
5530
5456
|
#
|
5531
|
-
# @param duration_unit [Symbol, Orb::
|
5457
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::MaxGroupTieredPackage::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
5532
5458
|
|
5533
5459
|
# The unit of billing period duration.
|
5534
5460
|
#
|
5535
|
-
# @see Orb::
|
5461
|
+
# @see Orb::PlanCreateParams::Price::MaxGroupTieredPackage::BillingCycleConfiguration#duration_unit
|
5536
5462
|
module DurationUnit
|
5537
5463
|
extend Orb::Internal::Type::Enum
|
5538
5464
|
|
@@ -5544,7 +5470,7 @@ module Orb
|
|
5544
5470
|
end
|
5545
5471
|
end
|
5546
5472
|
|
5547
|
-
# @see Orb::
|
5473
|
+
# @see Orb::PlanCreateParams::Price::MaxGroupTieredPackage#invoicing_cycle_configuration
|
5548
5474
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
5549
5475
|
# @!attribute duration
|
5550
5476
|
# The duration of the billing period.
|
@@ -5555,9 +5481,11 @@ module Orb
|
|
5555
5481
|
# @!attribute duration_unit
|
5556
5482
|
# The unit of billing period duration.
|
5557
5483
|
#
|
5558
|
-
# @return [Symbol, Orb::
|
5484
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::MaxGroupTieredPackage::InvoicingCycleConfiguration::DurationUnit]
|
5559
5485
|
required :duration_unit,
|
5560
|
-
enum: -> {
|
5486
|
+
enum: -> {
|
5487
|
+
Orb::PlanCreateParams::Price::MaxGroupTieredPackage::InvoicingCycleConfiguration::DurationUnit
|
5488
|
+
}
|
5561
5489
|
|
5562
5490
|
# @!method initialize(duration:, duration_unit:)
|
5563
5491
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
@@ -5565,11 +5493,11 @@ module Orb
|
|
5565
5493
|
#
|
5566
5494
|
# @param duration [Integer] The duration of the billing period.
|
5567
5495
|
#
|
5568
|
-
# @param duration_unit [Symbol, Orb::
|
5496
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::MaxGroupTieredPackage::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
5569
5497
|
|
5570
5498
|
# The unit of billing period duration.
|
5571
5499
|
#
|
5572
|
-
# @see Orb::
|
5500
|
+
# @see Orb::PlanCreateParams::Price::MaxGroupTieredPackage::InvoicingCycleConfiguration#duration_unit
|
5573
5501
|
module DurationUnit
|
5574
5502
|
extend Orb::Internal::Type::Enum
|
5575
5503
|
|
@@ -5586,9 +5514,8 @@ module Orb
|
|
5586
5514
|
# @!attribute cadence
|
5587
5515
|
# The cadence to bill for this price on.
|
5588
5516
|
#
|
5589
|
-
# @return [Symbol, Orb::
|
5590
|
-
required :cadence,
|
5591
|
-
enum: -> { Orb::Models::PlanCreateParams::Price::ScalableMatrixWithUnitPricing::Cadence }
|
5517
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::ScalableMatrixWithUnitPricing::Cadence]
|
5518
|
+
required :cadence, enum: -> { Orb::PlanCreateParams::Price::ScalableMatrixWithUnitPricing::Cadence }
|
5592
5519
|
|
5593
5520
|
# @!attribute item_id
|
5594
5521
|
# The id of the item the price will be associated with.
|
@@ -5631,9 +5558,11 @@ module Orb
|
|
5631
5558
|
# For custom cadence: specifies the duration of the billing period in days or
|
5632
5559
|
# months.
|
5633
5560
|
#
|
5634
|
-
# @return [Orb::
|
5561
|
+
# @return [Orb::PlanCreateParams::Price::ScalableMatrixWithUnitPricing::BillingCycleConfiguration, nil]
|
5635
5562
|
optional :billing_cycle_configuration,
|
5636
|
-
-> {
|
5563
|
+
-> {
|
5564
|
+
Orb::PlanCreateParams::Price::ScalableMatrixWithUnitPricing::BillingCycleConfiguration
|
5565
|
+
},
|
5637
5566
|
nil?: true
|
5638
5567
|
|
5639
5568
|
# @!attribute conversion_rate
|
@@ -5672,9 +5601,11 @@ module Orb
|
|
5672
5601
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
5673
5602
|
# If unspecified, a single invoice is produced per billing cycle.
|
5674
5603
|
#
|
5675
|
-
# @return [Orb::
|
5604
|
+
# @return [Orb::PlanCreateParams::Price::ScalableMatrixWithUnitPricing::InvoicingCycleConfiguration, nil]
|
5676
5605
|
optional :invoicing_cycle_configuration,
|
5677
|
-
-> {
|
5606
|
+
-> {
|
5607
|
+
Orb::PlanCreateParams::Price::ScalableMatrixWithUnitPricing::InvoicingCycleConfiguration
|
5608
|
+
},
|
5678
5609
|
nil?: true
|
5679
5610
|
|
5680
5611
|
# @!attribute metadata
|
@@ -5687,10 +5618,9 @@ module Orb
|
|
5687
5618
|
|
5688
5619
|
# @!method initialize(cadence:, item_id:, name:, scalable_matrix_with_unit_pricing_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :scalable_matrix_with_unit_pricing)
|
5689
5620
|
# Some parameter documentations has been truncated, see
|
5690
|
-
# {Orb::
|
5691
|
-
# details.
|
5621
|
+
# {Orb::PlanCreateParams::Price::ScalableMatrixWithUnitPricing} for more details.
|
5692
5622
|
#
|
5693
|
-
# @param cadence [Symbol, Orb::
|
5623
|
+
# @param cadence [Symbol, Orb::PlanCreateParams::Price::ScalableMatrixWithUnitPricing::Cadence] The cadence to bill for this price on.
|
5694
5624
|
#
|
5695
5625
|
# @param item_id [String] The id of the item the price will be associated with.
|
5696
5626
|
#
|
@@ -5699,37 +5629,30 @@ module Orb
|
|
5699
5629
|
# @param scalable_matrix_with_unit_pricing_config [Hash{Symbol=>Object}]
|
5700
5630
|
#
|
5701
5631
|
# @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b
|
5702
|
-
# ...
|
5703
5632
|
#
|
5704
5633
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
5705
|
-
# ...
|
5706
5634
|
#
|
5707
|
-
# @param billing_cycle_configuration [Orb::
|
5708
|
-
# ...
|
5635
|
+
# @param billing_cycle_configuration [Orb::PlanCreateParams::Price::ScalableMatrixWithUnitPricing::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
5709
5636
|
#
|
5710
5637
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
5711
5638
|
#
|
5712
5639
|
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
5713
|
-
# ...
|
5714
5640
|
#
|
5715
5641
|
# @param external_price_id [String, nil] An alias for the price.
|
5716
5642
|
#
|
5717
5643
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
5718
|
-
# ...
|
5719
5644
|
#
|
5720
5645
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
5721
5646
|
#
|
5722
|
-
# @param invoicing_cycle_configuration [Orb::
|
5723
|
-
# ...
|
5647
|
+
# @param invoicing_cycle_configuration [Orb::PlanCreateParams::Price::ScalableMatrixWithUnitPricing::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
5724
5648
|
#
|
5725
5649
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
5726
|
-
# ...
|
5727
5650
|
#
|
5728
5651
|
# @param model_type [Symbol, :scalable_matrix_with_unit_pricing]
|
5729
5652
|
|
5730
5653
|
# The cadence to bill for this price on.
|
5731
5654
|
#
|
5732
|
-
# @see Orb::
|
5655
|
+
# @see Orb::PlanCreateParams::Price::ScalableMatrixWithUnitPricing#cadence
|
5733
5656
|
module Cadence
|
5734
5657
|
extend Orb::Internal::Type::Enum
|
5735
5658
|
|
@@ -5744,7 +5667,7 @@ module Orb
|
|
5744
5667
|
# @return [Array<Symbol>]
|
5745
5668
|
end
|
5746
5669
|
|
5747
|
-
# @see Orb::
|
5670
|
+
# @see Orb::PlanCreateParams::Price::ScalableMatrixWithUnitPricing#billing_cycle_configuration
|
5748
5671
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
5749
5672
|
# @!attribute duration
|
5750
5673
|
# The duration of the billing period.
|
@@ -5755,9 +5678,11 @@ module Orb
|
|
5755
5678
|
# @!attribute duration_unit
|
5756
5679
|
# The unit of billing period duration.
|
5757
5680
|
#
|
5758
|
-
# @return [Symbol, Orb::
|
5681
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::ScalableMatrixWithUnitPricing::BillingCycleConfiguration::DurationUnit]
|
5759
5682
|
required :duration_unit,
|
5760
|
-
enum: -> {
|
5683
|
+
enum: -> {
|
5684
|
+
Orb::PlanCreateParams::Price::ScalableMatrixWithUnitPricing::BillingCycleConfiguration::DurationUnit
|
5685
|
+
}
|
5761
5686
|
|
5762
5687
|
# @!method initialize(duration:, duration_unit:)
|
5763
5688
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -5765,11 +5690,11 @@ module Orb
|
|
5765
5690
|
#
|
5766
5691
|
# @param duration [Integer] The duration of the billing period.
|
5767
5692
|
#
|
5768
|
-
# @param duration_unit [Symbol, Orb::
|
5693
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::ScalableMatrixWithUnitPricing::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
5769
5694
|
|
5770
5695
|
# The unit of billing period duration.
|
5771
5696
|
#
|
5772
|
-
# @see Orb::
|
5697
|
+
# @see Orb::PlanCreateParams::Price::ScalableMatrixWithUnitPricing::BillingCycleConfiguration#duration_unit
|
5773
5698
|
module DurationUnit
|
5774
5699
|
extend Orb::Internal::Type::Enum
|
5775
5700
|
|
@@ -5781,7 +5706,7 @@ module Orb
|
|
5781
5706
|
end
|
5782
5707
|
end
|
5783
5708
|
|
5784
|
-
# @see Orb::
|
5709
|
+
# @see Orb::PlanCreateParams::Price::ScalableMatrixWithUnitPricing#invoicing_cycle_configuration
|
5785
5710
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
5786
5711
|
# @!attribute duration
|
5787
5712
|
# The duration of the billing period.
|
@@ -5792,9 +5717,11 @@ module Orb
|
|
5792
5717
|
# @!attribute duration_unit
|
5793
5718
|
# The unit of billing period duration.
|
5794
5719
|
#
|
5795
|
-
# @return [Symbol, Orb::
|
5720
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::ScalableMatrixWithUnitPricing::InvoicingCycleConfiguration::DurationUnit]
|
5796
5721
|
required :duration_unit,
|
5797
|
-
enum: -> {
|
5722
|
+
enum: -> {
|
5723
|
+
Orb::PlanCreateParams::Price::ScalableMatrixWithUnitPricing::InvoicingCycleConfiguration::DurationUnit
|
5724
|
+
}
|
5798
5725
|
|
5799
5726
|
# @!method initialize(duration:, duration_unit:)
|
5800
5727
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
@@ -5802,11 +5729,11 @@ module Orb
|
|
5802
5729
|
#
|
5803
5730
|
# @param duration [Integer] The duration of the billing period.
|
5804
5731
|
#
|
5805
|
-
# @param duration_unit [Symbol, Orb::
|
5732
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::ScalableMatrixWithUnitPricing::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
5806
5733
|
|
5807
5734
|
# The unit of billing period duration.
|
5808
5735
|
#
|
5809
|
-
# @see Orb::
|
5736
|
+
# @see Orb::PlanCreateParams::Price::ScalableMatrixWithUnitPricing::InvoicingCycleConfiguration#duration_unit
|
5810
5737
|
module DurationUnit
|
5811
5738
|
extend Orb::Internal::Type::Enum
|
5812
5739
|
|
@@ -5823,9 +5750,11 @@ module Orb
|
|
5823
5750
|
# @!attribute cadence
|
5824
5751
|
# The cadence to bill for this price on.
|
5825
5752
|
#
|
5826
|
-
# @return [Symbol, Orb::
|
5753
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::ScalableMatrixWithTieredPricing::Cadence]
|
5827
5754
|
required :cadence,
|
5828
|
-
enum: -> {
|
5755
|
+
enum: -> {
|
5756
|
+
Orb::PlanCreateParams::Price::ScalableMatrixWithTieredPricing::Cadence
|
5757
|
+
}
|
5829
5758
|
|
5830
5759
|
# @!attribute item_id
|
5831
5760
|
# The id of the item the price will be associated with.
|
@@ -5868,9 +5797,11 @@ module Orb
|
|
5868
5797
|
# For custom cadence: specifies the duration of the billing period in days or
|
5869
5798
|
# months.
|
5870
5799
|
#
|
5871
|
-
# @return [Orb::
|
5800
|
+
# @return [Orb::PlanCreateParams::Price::ScalableMatrixWithTieredPricing::BillingCycleConfiguration, nil]
|
5872
5801
|
optional :billing_cycle_configuration,
|
5873
|
-
-> {
|
5802
|
+
-> {
|
5803
|
+
Orb::PlanCreateParams::Price::ScalableMatrixWithTieredPricing::BillingCycleConfiguration
|
5804
|
+
},
|
5874
5805
|
nil?: true
|
5875
5806
|
|
5876
5807
|
# @!attribute conversion_rate
|
@@ -5909,9 +5840,11 @@ module Orb
|
|
5909
5840
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
5910
5841
|
# If unspecified, a single invoice is produced per billing cycle.
|
5911
5842
|
#
|
5912
|
-
# @return [Orb::
|
5843
|
+
# @return [Orb::PlanCreateParams::Price::ScalableMatrixWithTieredPricing::InvoicingCycleConfiguration, nil]
|
5913
5844
|
optional :invoicing_cycle_configuration,
|
5914
|
-
-> {
|
5845
|
+
-> {
|
5846
|
+
Orb::PlanCreateParams::Price::ScalableMatrixWithTieredPricing::InvoicingCycleConfiguration
|
5847
|
+
},
|
5915
5848
|
nil?: true
|
5916
5849
|
|
5917
5850
|
# @!attribute metadata
|
@@ -5924,10 +5857,10 @@ module Orb
|
|
5924
5857
|
|
5925
5858
|
# @!method initialize(cadence:, item_id:, name:, scalable_matrix_with_tiered_pricing_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :scalable_matrix_with_tiered_pricing)
|
5926
5859
|
# Some parameter documentations has been truncated, see
|
5927
|
-
# {Orb::
|
5860
|
+
# {Orb::PlanCreateParams::Price::ScalableMatrixWithTieredPricing} for more
|
5928
5861
|
# details.
|
5929
5862
|
#
|
5930
|
-
# @param cadence [Symbol, Orb::
|
5863
|
+
# @param cadence [Symbol, Orb::PlanCreateParams::Price::ScalableMatrixWithTieredPricing::Cadence] The cadence to bill for this price on.
|
5931
5864
|
#
|
5932
5865
|
# @param item_id [String] The id of the item the price will be associated with.
|
5933
5866
|
#
|
@@ -5936,37 +5869,30 @@ module Orb
|
|
5936
5869
|
# @param scalable_matrix_with_tiered_pricing_config [Hash{Symbol=>Object}]
|
5937
5870
|
#
|
5938
5871
|
# @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b
|
5939
|
-
# ...
|
5940
5872
|
#
|
5941
5873
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
5942
|
-
# ...
|
5943
5874
|
#
|
5944
|
-
# @param billing_cycle_configuration [Orb::
|
5945
|
-
# ...
|
5875
|
+
# @param billing_cycle_configuration [Orb::PlanCreateParams::Price::ScalableMatrixWithTieredPricing::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
5946
5876
|
#
|
5947
5877
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
5948
5878
|
#
|
5949
5879
|
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
5950
|
-
# ...
|
5951
5880
|
#
|
5952
5881
|
# @param external_price_id [String, nil] An alias for the price.
|
5953
5882
|
#
|
5954
5883
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
5955
|
-
# ...
|
5956
5884
|
#
|
5957
5885
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
5958
5886
|
#
|
5959
|
-
# @param invoicing_cycle_configuration [Orb::
|
5960
|
-
# ...
|
5887
|
+
# @param invoicing_cycle_configuration [Orb::PlanCreateParams::Price::ScalableMatrixWithTieredPricing::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
5961
5888
|
#
|
5962
5889
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
5963
|
-
# ...
|
5964
5890
|
#
|
5965
5891
|
# @param model_type [Symbol, :scalable_matrix_with_tiered_pricing]
|
5966
5892
|
|
5967
5893
|
# The cadence to bill for this price on.
|
5968
5894
|
#
|
5969
|
-
# @see Orb::
|
5895
|
+
# @see Orb::PlanCreateParams::Price::ScalableMatrixWithTieredPricing#cadence
|
5970
5896
|
module Cadence
|
5971
5897
|
extend Orb::Internal::Type::Enum
|
5972
5898
|
|
@@ -5981,7 +5907,7 @@ module Orb
|
|
5981
5907
|
# @return [Array<Symbol>]
|
5982
5908
|
end
|
5983
5909
|
|
5984
|
-
# @see Orb::
|
5910
|
+
# @see Orb::PlanCreateParams::Price::ScalableMatrixWithTieredPricing#billing_cycle_configuration
|
5985
5911
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
5986
5912
|
# @!attribute duration
|
5987
5913
|
# The duration of the billing period.
|
@@ -5992,9 +5918,11 @@ module Orb
|
|
5992
5918
|
# @!attribute duration_unit
|
5993
5919
|
# The unit of billing period duration.
|
5994
5920
|
#
|
5995
|
-
# @return [Symbol, Orb::
|
5921
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::ScalableMatrixWithTieredPricing::BillingCycleConfiguration::DurationUnit]
|
5996
5922
|
required :duration_unit,
|
5997
|
-
enum: -> {
|
5923
|
+
enum: -> {
|
5924
|
+
Orb::PlanCreateParams::Price::ScalableMatrixWithTieredPricing::BillingCycleConfiguration::DurationUnit
|
5925
|
+
}
|
5998
5926
|
|
5999
5927
|
# @!method initialize(duration:, duration_unit:)
|
6000
5928
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -6002,11 +5930,11 @@ module Orb
|
|
6002
5930
|
#
|
6003
5931
|
# @param duration [Integer] The duration of the billing period.
|
6004
5932
|
#
|
6005
|
-
# @param duration_unit [Symbol, Orb::
|
5933
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::ScalableMatrixWithTieredPricing::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
6006
5934
|
|
6007
5935
|
# The unit of billing period duration.
|
6008
5936
|
#
|
6009
|
-
# @see Orb::
|
5937
|
+
# @see Orb::PlanCreateParams::Price::ScalableMatrixWithTieredPricing::BillingCycleConfiguration#duration_unit
|
6010
5938
|
module DurationUnit
|
6011
5939
|
extend Orb::Internal::Type::Enum
|
6012
5940
|
|
@@ -6018,7 +5946,7 @@ module Orb
|
|
6018
5946
|
end
|
6019
5947
|
end
|
6020
5948
|
|
6021
|
-
# @see Orb::
|
5949
|
+
# @see Orb::PlanCreateParams::Price::ScalableMatrixWithTieredPricing#invoicing_cycle_configuration
|
6022
5950
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
6023
5951
|
# @!attribute duration
|
6024
5952
|
# The duration of the billing period.
|
@@ -6029,9 +5957,11 @@ module Orb
|
|
6029
5957
|
# @!attribute duration_unit
|
6030
5958
|
# The unit of billing period duration.
|
6031
5959
|
#
|
6032
|
-
# @return [Symbol, Orb::
|
5960
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::ScalableMatrixWithTieredPricing::InvoicingCycleConfiguration::DurationUnit]
|
6033
5961
|
required :duration_unit,
|
6034
|
-
enum: -> {
|
5962
|
+
enum: -> {
|
5963
|
+
Orb::PlanCreateParams::Price::ScalableMatrixWithTieredPricing::InvoicingCycleConfiguration::DurationUnit
|
5964
|
+
}
|
6035
5965
|
|
6036
5966
|
# @!method initialize(duration:, duration_unit:)
|
6037
5967
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
@@ -6039,11 +5969,11 @@ module Orb
|
|
6039
5969
|
#
|
6040
5970
|
# @param duration [Integer] The duration of the billing period.
|
6041
5971
|
#
|
6042
|
-
# @param duration_unit [Symbol, Orb::
|
5972
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::ScalableMatrixWithTieredPricing::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
6043
5973
|
|
6044
5974
|
# The unit of billing period duration.
|
6045
5975
|
#
|
6046
|
-
# @see Orb::
|
5976
|
+
# @see Orb::PlanCreateParams::Price::ScalableMatrixWithTieredPricing::InvoicingCycleConfiguration#duration_unit
|
6047
5977
|
module DurationUnit
|
6048
5978
|
extend Orb::Internal::Type::Enum
|
6049
5979
|
|
@@ -6060,8 +5990,8 @@ module Orb
|
|
6060
5990
|
# @!attribute cadence
|
6061
5991
|
# The cadence to bill for this price on.
|
6062
5992
|
#
|
6063
|
-
# @return [Symbol, Orb::
|
6064
|
-
required :cadence, enum: -> { Orb::
|
5993
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::CumulativeGroupedBulk::Cadence]
|
5994
|
+
required :cadence, enum: -> { Orb::PlanCreateParams::Price::CumulativeGroupedBulk::Cadence }
|
6065
5995
|
|
6066
5996
|
# @!attribute cumulative_grouped_bulk_config
|
6067
5997
|
#
|
@@ -6103,9 +6033,9 @@ module Orb
|
|
6103
6033
|
# For custom cadence: specifies the duration of the billing period in days or
|
6104
6034
|
# months.
|
6105
6035
|
#
|
6106
|
-
# @return [Orb::
|
6036
|
+
# @return [Orb::PlanCreateParams::Price::CumulativeGroupedBulk::BillingCycleConfiguration, nil]
|
6107
6037
|
optional :billing_cycle_configuration,
|
6108
|
-
-> { Orb::
|
6038
|
+
-> { Orb::PlanCreateParams::Price::CumulativeGroupedBulk::BillingCycleConfiguration },
|
6109
6039
|
nil?: true
|
6110
6040
|
|
6111
6041
|
# @!attribute conversion_rate
|
@@ -6144,9 +6074,9 @@ module Orb
|
|
6144
6074
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
6145
6075
|
# If unspecified, a single invoice is produced per billing cycle.
|
6146
6076
|
#
|
6147
|
-
# @return [Orb::
|
6077
|
+
# @return [Orb::PlanCreateParams::Price::CumulativeGroupedBulk::InvoicingCycleConfiguration, nil]
|
6148
6078
|
optional :invoicing_cycle_configuration,
|
6149
|
-
-> { Orb::
|
6079
|
+
-> { Orb::PlanCreateParams::Price::CumulativeGroupedBulk::InvoicingCycleConfiguration },
|
6150
6080
|
nil?: true
|
6151
6081
|
|
6152
6082
|
# @!attribute metadata
|
@@ -6159,9 +6089,9 @@ module Orb
|
|
6159
6089
|
|
6160
6090
|
# @!method initialize(cadence:, cumulative_grouped_bulk_config:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :cumulative_grouped_bulk)
|
6161
6091
|
# Some parameter documentations has been truncated, see
|
6162
|
-
# {Orb::
|
6092
|
+
# {Orb::PlanCreateParams::Price::CumulativeGroupedBulk} for more details.
|
6163
6093
|
#
|
6164
|
-
# @param cadence [Symbol, Orb::
|
6094
|
+
# @param cadence [Symbol, Orb::PlanCreateParams::Price::CumulativeGroupedBulk::Cadence] The cadence to bill for this price on.
|
6165
6095
|
#
|
6166
6096
|
# @param cumulative_grouped_bulk_config [Hash{Symbol=>Object}]
|
6167
6097
|
#
|
@@ -6170,37 +6100,30 @@ module Orb
|
|
6170
6100
|
# @param name [String] The name of the price.
|
6171
6101
|
#
|
6172
6102
|
# @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b
|
6173
|
-
# ...
|
6174
6103
|
#
|
6175
6104
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
6176
|
-
# ...
|
6177
6105
|
#
|
6178
|
-
# @param billing_cycle_configuration [Orb::
|
6179
|
-
# ...
|
6106
|
+
# @param billing_cycle_configuration [Orb::PlanCreateParams::Price::CumulativeGroupedBulk::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
6180
6107
|
#
|
6181
6108
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
6182
6109
|
#
|
6183
6110
|
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
6184
|
-
# ...
|
6185
6111
|
#
|
6186
6112
|
# @param external_price_id [String, nil] An alias for the price.
|
6187
6113
|
#
|
6188
6114
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
6189
|
-
# ...
|
6190
6115
|
#
|
6191
6116
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
6192
6117
|
#
|
6193
|
-
# @param invoicing_cycle_configuration [Orb::
|
6194
|
-
# ...
|
6118
|
+
# @param invoicing_cycle_configuration [Orb::PlanCreateParams::Price::CumulativeGroupedBulk::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
6195
6119
|
#
|
6196
6120
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
6197
|
-
# ...
|
6198
6121
|
#
|
6199
6122
|
# @param model_type [Symbol, :cumulative_grouped_bulk]
|
6200
6123
|
|
6201
6124
|
# The cadence to bill for this price on.
|
6202
6125
|
#
|
6203
|
-
# @see Orb::
|
6126
|
+
# @see Orb::PlanCreateParams::Price::CumulativeGroupedBulk#cadence
|
6204
6127
|
module Cadence
|
6205
6128
|
extend Orb::Internal::Type::Enum
|
6206
6129
|
|
@@ -6215,7 +6138,7 @@ module Orb
|
|
6215
6138
|
# @return [Array<Symbol>]
|
6216
6139
|
end
|
6217
6140
|
|
6218
|
-
# @see Orb::
|
6141
|
+
# @see Orb::PlanCreateParams::Price::CumulativeGroupedBulk#billing_cycle_configuration
|
6219
6142
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
6220
6143
|
# @!attribute duration
|
6221
6144
|
# The duration of the billing period.
|
@@ -6226,9 +6149,11 @@ module Orb
|
|
6226
6149
|
# @!attribute duration_unit
|
6227
6150
|
# The unit of billing period duration.
|
6228
6151
|
#
|
6229
|
-
# @return [Symbol, Orb::
|
6152
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::CumulativeGroupedBulk::BillingCycleConfiguration::DurationUnit]
|
6230
6153
|
required :duration_unit,
|
6231
|
-
enum: -> {
|
6154
|
+
enum: -> {
|
6155
|
+
Orb::PlanCreateParams::Price::CumulativeGroupedBulk::BillingCycleConfiguration::DurationUnit
|
6156
|
+
}
|
6232
6157
|
|
6233
6158
|
# @!method initialize(duration:, duration_unit:)
|
6234
6159
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -6236,11 +6161,11 @@ module Orb
|
|
6236
6161
|
#
|
6237
6162
|
# @param duration [Integer] The duration of the billing period.
|
6238
6163
|
#
|
6239
|
-
# @param duration_unit [Symbol, Orb::
|
6164
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::CumulativeGroupedBulk::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
6240
6165
|
|
6241
6166
|
# The unit of billing period duration.
|
6242
6167
|
#
|
6243
|
-
# @see Orb::
|
6168
|
+
# @see Orb::PlanCreateParams::Price::CumulativeGroupedBulk::BillingCycleConfiguration#duration_unit
|
6244
6169
|
module DurationUnit
|
6245
6170
|
extend Orb::Internal::Type::Enum
|
6246
6171
|
|
@@ -6252,7 +6177,7 @@ module Orb
|
|
6252
6177
|
end
|
6253
6178
|
end
|
6254
6179
|
|
6255
|
-
# @see Orb::
|
6180
|
+
# @see Orb::PlanCreateParams::Price::CumulativeGroupedBulk#invoicing_cycle_configuration
|
6256
6181
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
6257
6182
|
# @!attribute duration
|
6258
6183
|
# The duration of the billing period.
|
@@ -6263,9 +6188,11 @@ module Orb
|
|
6263
6188
|
# @!attribute duration_unit
|
6264
6189
|
# The unit of billing period duration.
|
6265
6190
|
#
|
6266
|
-
# @return [Symbol, Orb::
|
6191
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::CumulativeGroupedBulk::InvoicingCycleConfiguration::DurationUnit]
|
6267
6192
|
required :duration_unit,
|
6268
|
-
enum: -> {
|
6193
|
+
enum: -> {
|
6194
|
+
Orb::PlanCreateParams::Price::CumulativeGroupedBulk::InvoicingCycleConfiguration::DurationUnit
|
6195
|
+
}
|
6269
6196
|
|
6270
6197
|
# @!method initialize(duration:, duration_unit:)
|
6271
6198
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
@@ -6273,11 +6200,11 @@ module Orb
|
|
6273
6200
|
#
|
6274
6201
|
# @param duration [Integer] The duration of the billing period.
|
6275
6202
|
#
|
6276
|
-
# @param duration_unit [Symbol, Orb::
|
6203
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::CumulativeGroupedBulk::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
6277
6204
|
|
6278
6205
|
# The unit of billing period duration.
|
6279
6206
|
#
|
6280
|
-
# @see Orb::
|
6207
|
+
# @see Orb::PlanCreateParams::Price::CumulativeGroupedBulk::InvoicingCycleConfiguration#duration_unit
|
6281
6208
|
module DurationUnit
|
6282
6209
|
extend Orb::Internal::Type::Enum
|
6283
6210
|
|
@@ -6291,7 +6218,7 @@ module Orb
|
|
6291
6218
|
end
|
6292
6219
|
|
6293
6220
|
# @!method self.variants
|
6294
|
-
# @return [Array(Orb::
|
6221
|
+
# @return [Array(Orb::PlanCreateParams::Price::Unit, Orb::PlanCreateParams::Price::Package, Orb::PlanCreateParams::Price::Matrix, Orb::PlanCreateParams::Price::Tiered, Orb::PlanCreateParams::Price::TieredBps, Orb::PlanCreateParams::Price::Bps, Orb::PlanCreateParams::Price::BulkBps, Orb::PlanCreateParams::Price::Bulk, Orb::PlanCreateParams::Price::ThresholdTotalAmount, Orb::PlanCreateParams::Price::TieredPackage, Orb::PlanCreateParams::Price::TieredWithMinimum, Orb::PlanCreateParams::Price::UnitWithPercent, Orb::PlanCreateParams::Price::PackageWithAllocation, Orb::PlanCreateParams::Price::TieredWithProration, Orb::PlanCreateParams::Price::UnitWithProration, Orb::PlanCreateParams::Price::GroupedAllocation, Orb::PlanCreateParams::Price::GroupedWithProratedMinimum, Orb::PlanCreateParams::Price::GroupedWithMeteredMinimum, Orb::PlanCreateParams::Price::MatrixWithDisplayName, Orb::PlanCreateParams::Price::BulkWithProration, Orb::PlanCreateParams::Price::GroupedTieredPackage, Orb::PlanCreateParams::Price::MaxGroupTieredPackage, Orb::PlanCreateParams::Price::ScalableMatrixWithUnitPricing, Orb::PlanCreateParams::Price::ScalableMatrixWithTieredPricing, Orb::PlanCreateParams::Price::CumulativeGroupedBulk)]
|
6295
6222
|
end
|
6296
6223
|
|
6297
6224
|
# The status of the plan to create (either active or draft). If not specified,
|