orb-billing 0.3.0 → 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 +47 -0
- data/README.md +7 -7
- data/lib/orb/errors.rb +9 -9
- data/lib/orb/file_part.rb +2 -2
- data/lib/orb/internal/page.rb +3 -3
- data/lib/orb/internal/transport/base_client.rb +3 -3
- data/lib/orb/internal/type/base_model.rb +1 -9
- data/lib/orb/internal/type/boolean.rb +10 -11
- data/lib/orb/internal/type/enum.rb +13 -14
- data/lib/orb/internal/type/request_parameters.rb +6 -12
- data/lib/orb/internal/type/union.rb +4 -4
- data/lib/orb/internal/type/unknown.rb +10 -11
- data/lib/orb/internal/util.rb +21 -5
- 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 +8 -10
- 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 +43 -55
- data/lib/orb/models/customer_list_params.rb +0 -1
- data/lib/orb/models/customer_update_by_external_id_params.rb +43 -57
- data/lib/orb/models/customer_update_params.rb +43 -53
- 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 +106 -114
- data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +11 -22
- data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +111 -126
- 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 +110 -121
- data/lib/orb/models/customers/credits/ledger_list_params.rb +8 -9
- data/lib/orb/models/customers/credits/ledger_list_response.rb +112 -131
- 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 +165 -224
- data/lib/orb/models/invoice_create_params.rb +14 -21
- data/lib/orb/models/invoice_fetch_upcoming_response.rb +58 -107
- 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 +58 -81
- 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 +83 -111
- data/lib/orb/models/plan_create_params.rb +753 -861
- 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 +1699 -1804
- 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 +94 -136
- data/lib/orb/models/subscription_cancel_params.rb +3 -5
- data/lib/orb/models/subscription_cancel_response.rb +52 -91
- data/lib/orb/models/subscription_change_apply_response.rb +50 -88
- data/lib/orb/models/subscription_change_cancel_response.rb +50 -87
- data/lib/orb/models/subscription_change_retrieve_response.rb +50 -87
- data/lib/orb/models/subscription_create_params.rb +1927 -1928
- data/lib/orb/models/subscription_create_response.rb +52 -91
- 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 +1141 -1079
- data/lib/orb/models/subscription_price_intervals_response.rb +51 -90
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +1966 -1906
- data/lib/orb/models/subscription_schedule_plan_change_response.rb +50 -88
- data/lib/orb/models/subscription_trigger_phase_params.rb +0 -2
- data/lib/orb/models/subscription_trigger_phase_response.rb +51 -90
- data/lib/orb/models/subscription_unschedule_cancellation_response.rb +50 -88
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +50 -86
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +50 -86
- data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +3 -6
- data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +50 -88
- 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 +52 -91
- 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/models.rb +220 -0
- data/lib/orb/request_options.rb +4 -5
- 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 +18 -37
- 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/{lib/orb → orb}/client.rbi +5 -4
- data/rbi/{lib/orb → orb}/errors.rbi +58 -27
- data/rbi/{lib/orb → orb}/file_part.rbi +9 -6
- data/rbi/{lib/orb → orb}/internal/page.rbi +19 -6
- data/rbi/{lib/orb → orb}/internal/transport/base_client.rbi +131 -73
- data/rbi/{lib/orb → orb}/internal/transport/pooled_net_requester.rbi +25 -12
- data/rbi/orb/internal/type/array_of.rbi +98 -0
- data/rbi/{lib/orb → orb}/internal/type/base_model.rbi +124 -65
- data/rbi/{lib/orb → orb}/internal/type/base_page.rbi +11 -7
- data/rbi/{lib/orb → orb}/internal/type/boolean.rbi +16 -10
- data/rbi/{lib/orb → orb}/internal/type/converter.rbi +66 -31
- data/rbi/{lib/orb → orb}/internal/type/enum.rbi +27 -15
- data/rbi/{lib/orb → orb}/internal/type/file_input.rbi +12 -10
- data/rbi/{lib/orb → orb}/internal/type/hash_of.rbi +34 -24
- data/rbi/orb/internal/type/request_parameters.rbi +29 -0
- data/rbi/orb/internal/type/union.rbi +110 -0
- data/rbi/orb/internal/type/unknown.rbi +50 -0
- data/rbi/orb/internal/util.rbi +424 -0
- data/rbi/{lib/orb → orb}/models/alert.rbi +107 -70
- data/rbi/{lib/orb → orb}/models/alert_create_for_customer_params.rbi +60 -27
- data/rbi/{lib/orb → orb}/models/alert_create_for_external_customer_params.rbi +68 -29
- data/rbi/{lib/orb → orb}/models/alert_create_for_subscription_params.rbi +53 -26
- data/rbi/{lib/orb → orb}/models/alert_disable_params.rbi +17 -6
- data/rbi/{lib/orb → orb}/models/alert_enable_params.rbi +17 -6
- data/rbi/{lib/orb → orb}/models/alert_list_params.rbi +23 -20
- data/rbi/orb/models/alert_retrieve_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/alert_update_params.rbi +25 -14
- data/rbi/{lib/orb → orb}/models/amount_discount.rbi +28 -19
- data/rbi/{lib/orb → orb}/models/billable_metric.rbi +33 -26
- data/rbi/orb/models/billing_cycle_relative_date.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/coupon.rbi +28 -20
- data/rbi/orb/models/coupon_archive_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/coupon_create_params.rbi +74 -40
- data/rbi/orb/models/coupon_fetch_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/coupon_list_params.rbi +18 -15
- data/rbi/{lib/orb → orb}/models/coupons/subscription_list_params.rbi +16 -6
- data/rbi/{lib/orb → orb}/models/credit_note.rbi +293 -158
- data/rbi/orb/models/credit_note_create_params.rbi +117 -0
- data/rbi/orb/models/credit_note_fetch_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/credit_note_list_params.rbi +20 -17
- data/rbi/{lib/orb → orb}/models/customer.rbi +430 -329
- data/rbi/{lib/orb → orb}/models/customer_create_params.rbi +664 -327
- data/rbi/orb/models/customer_delete_params.rbi +24 -0
- data/rbi/orb/models/customer_fetch_by_external_id_params.rbi +24 -0
- data/rbi/orb/models/customer_fetch_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/customer_list_params.rbi +20 -17
- data/rbi/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi +24 -0
- data/rbi/orb/models/customer_sync_payment_methods_from_gateway_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/customer_update_by_external_id_params.rbi +1138 -338
- data/rbi/{lib/orb → orb}/models/customer_update_params.rbi +663 -326
- data/rbi/orb/models/customers/balance_transaction_create_params.rbi +94 -0
- data/rbi/orb/models/customers/balance_transaction_create_response.rbi +301 -0
- data/rbi/{lib/orb → orb}/models/customers/balance_transaction_list_params.rbi +20 -17
- data/rbi/orb/models/customers/balance_transaction_list_response.rbi +301 -0
- data/rbi/{lib/orb → orb}/models/customers/cost_list_by_external_id_params.rbi +56 -22
- data/rbi/orb/models/customers/cost_list_by_external_id_response.rbi +263 -0
- data/rbi/{lib/orb → orb}/models/customers/cost_list_params.rbi +45 -22
- data/rbi/orb/models/customers/cost_list_response.rbi +254 -0
- data/rbi/{lib/orb → orb}/models/customers/credit_list_by_external_id_params.rbi +18 -15
- data/rbi/orb/models/customers/credit_list_by_external_id_response.rbi +110 -0
- data/rbi/{lib/orb → orb}/models/customers/credit_list_params.rbi +18 -15
- data/rbi/{lib/orb → orb}/models/customers/credit_list_response.rbi +44 -21
- data/rbi/{lib/orb/models/customers/credits/ledger_create_entry_params.rbi → orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi} +118 -60
- data/rbi/{lib/orb/models/customers/credits/ledger_create_entry_response.rbi → orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi} +685 -468
- data/rbi/{lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi → orb/models/customers/credits/ledger_create_entry_params.rbi} +107 -69
- data/rbi/{lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi → orb/models/customers/credits/ledger_create_entry_response.rbi} +643 -470
- data/rbi/orb/models/customers/credits/ledger_list_by_external_id_params.rbi +224 -0
- data/rbi/{lib/orb → orb}/models/customers/credits/ledger_list_by_external_id_response.rbi +658 -469
- data/rbi/orb/models/customers/credits/ledger_list_params.rbi +224 -0
- data/rbi/{lib/orb → orb}/models/customers/credits/ledger_list_response.rbi +708 -459
- data/rbi/{lib/orb/models/customers/credits/top_up_create_params.rbi → orb/models/customers/credits/top_up_create_by_external_id_params.rbi} +87 -46
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_by_external_id_response.rbi +65 -48
- data/rbi/{lib/orb/models/customers/credits/top_up_create_by_external_id_params.rbi → orb/models/customers/credits/top_up_create_params.rbi} +73 -54
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_response.rbi +83 -43
- data/rbi/{lib/orb → 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 +36 -0
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_by_external_id_params.rbi +9 -5
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_by_external_id_response.rbi +70 -49
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_params.rbi +9 -5
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_response.rbi +84 -43
- data/rbi/{lib/orb → orb}/models/dimensional_price_group.rbi +18 -15
- data/rbi/{lib/orb → orb}/models/dimensional_price_group_create_params.rbi +19 -16
- data/rbi/{lib/orb → orb}/models/dimensional_price_group_list_params.rbi +16 -6
- data/rbi/orb/models/dimensional_price_group_retrieve_params.rbi +24 -0
- data/rbi/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi +26 -0
- data/rbi/orb/models/dimensional_price_groups.rbi +38 -0
- data/rbi/orb/models/discount.rbi +23 -0
- data/rbi/{lib/orb → orb}/models/evaluate_price_group.rbi +28 -12
- data/rbi/orb/models/event_deprecate_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/event_deprecate_response.rbi +8 -3
- data/rbi/{lib/orb → orb}/models/event_ingest_params.rbi +37 -31
- data/rbi/{lib/orb → orb}/models/event_ingest_response.rbi +63 -23
- data/rbi/{lib/orb → orb}/models/event_search_params.rbi +17 -14
- data/rbi/{lib/orb → orb}/models/event_search_response.rbi +33 -21
- data/rbi/{lib/orb → orb}/models/event_update_params.rbi +19 -16
- data/rbi/{lib/orb → orb}/models/event_update_response.rbi +8 -3
- data/rbi/orb/models/events/backfill_close_params.rbi +26 -0
- data/rbi/{lib/orb → orb}/models/events/backfill_close_response.rbi +64 -29
- data/rbi/{lib/orb → orb}/models/events/backfill_create_params.rbi +21 -18
- data/rbi/{lib/orb → orb}/models/events/backfill_create_response.rbi +63 -29
- data/rbi/orb/models/events/backfill_fetch_params.rbi +26 -0
- data/rbi/{lib/orb → orb}/models/events/backfill_fetch_response.rbi +64 -29
- data/rbi/{lib/orb → orb}/models/events/backfill_list_params.rbi +16 -6
- data/rbi/{lib/orb → orb}/models/events/backfill_list_response.rbi +62 -28
- data/rbi/orb/models/events/backfill_revert_params.rbi +26 -0
- data/rbi/{lib/orb → orb}/models/events/backfill_revert_response.rbi +63 -29
- data/rbi/{lib/orb → orb}/models/events/event_volumes.rbi +34 -12
- data/rbi/{lib/orb → orb}/models/events/volume_list_params.rbi +18 -15
- data/rbi/{lib/orb → orb}/models/invoice.rbi +1294 -831
- data/rbi/{lib/orb → orb}/models/invoice_create_params.rbi +97 -69
- data/rbi/orb/models/invoice_fetch_params.rbi +24 -0
- data/rbi/orb/models/invoice_fetch_upcoming_params.rbi +32 -0
- data/rbi/{lib/orb → orb}/models/invoice_fetch_upcoming_response.rbi +2003 -885
- data/rbi/{lib/orb → orb}/models/invoice_issue_params.rbi +16 -5
- data/rbi/orb/models/invoice_level_discount.rbi +22 -0
- data/rbi/{lib/orb → orb}/models/invoice_line_item_create_params.rbi +20 -17
- data/rbi/{lib/orb → orb}/models/invoice_line_item_create_response.rbi +594 -421
- data/rbi/{lib/orb → orb}/models/invoice_list_params.rbi +67 -47
- data/rbi/{lib/orb → orb}/models/invoice_mark_paid_params.rbi +17 -14
- data/rbi/orb/models/invoice_pay_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/invoice_update_params.rbi +15 -10
- data/rbi/orb/models/invoice_void_params.rbi +24 -0
- data/rbi/orb/models/item.rbi +143 -0
- data/rbi/{lib/orb → orb}/models/item_create_params.rbi +14 -5
- data/rbi/orb/models/item_fetch_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/item_list_params.rbi +16 -6
- data/rbi/orb/models/item_update_params.rbi +141 -0
- data/rbi/{lib/orb → orb}/models/metric_create_params.rbi +19 -16
- data/rbi/orb/models/metric_fetch_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/metric_list_params.rbi +20 -17
- data/rbi/{lib/orb → orb}/models/metric_update_params.rbi +15 -10
- data/rbi/orb/models/pagination_metadata.rbi +31 -0
- data/rbi/{lib/orb → orb}/models/percentage_discount.rbi +32 -19
- data/rbi/{lib/orb → orb}/models/plan.rbi +501 -370
- data/rbi/{lib/orb → orb}/models/plan_create_params.rbi +4243 -3094
- data/rbi/orb/models/plan_fetch_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/plan_list_params.rbi +34 -27
- data/rbi/{lib/orb → orb}/models/plan_update_params.rbi +16 -13
- data/rbi/orb/models/plans/external_plan_id_fetch_params.rbi +26 -0
- data/rbi/{lib/orb → orb}/models/plans/external_plan_id_update_params.rbi +16 -13
- data/rbi/orb/models/price.rbi +19414 -0
- data/rbi/{lib/orb → orb}/models/price_create_params.rbi +501 -245
- data/rbi/{lib/orb → orb}/models/price_evaluate_params.rbi +20 -17
- data/rbi/orb/models/price_evaluate_response.rbi +24 -0
- data/rbi/orb/models/price_fetch_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/price_list_params.rbi +16 -6
- data/rbi/{lib/orb → orb}/models/price_update_params.rbi +15 -10
- data/rbi/orb/models/prices/external_price_id_fetch_params.rbi +26 -0
- data/rbi/{lib/orb → orb}/models/prices/external_price_id_update_params.rbi +15 -10
- data/rbi/{lib/orb → orb}/models/subscription.rbi +586 -428
- data/rbi/{lib/orb → orb}/models/subscription_cancel_params.rbi +44 -22
- data/rbi/{lib/orb → orb}/models/subscription_cancel_response.rbi +724 -462
- data/rbi/{lib/orb → orb}/models/subscription_change_apply_params.rbi +16 -13
- data/rbi/{lib/orb → orb}/models/subscription_change_apply_response.rbi +808 -528
- data/rbi/orb/models/subscription_change_cancel_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/subscription_change_cancel_response.rbi +807 -538
- data/rbi/orb/models/subscription_change_retrieve_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/subscription_change_retrieve_response.rbi +806 -548
- data/rbi/{lib/orb/models/subscription_schedule_plan_change_params.rbi → orb/models/subscription_create_params.rbi} +8466 -7080
- data/rbi/{lib/orb → orb}/models/subscription_create_response.rbi +724 -462
- data/rbi/{lib/orb → orb}/models/subscription_fetch_costs_params.rbi +47 -22
- data/rbi/orb/models/subscription_fetch_costs_response.rbi +252 -0
- data/rbi/orb/models/subscription_fetch_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/subscription_fetch_schedule_params.rbi +20 -17
- data/rbi/{lib/orb → orb}/models/subscription_fetch_schedule_response.rbi +33 -19
- data/rbi/{lib/orb → orb}/models/subscription_fetch_usage_params.rbi +81 -34
- data/rbi/{lib/orb → orb}/models/subscription_list_params.rbi +39 -28
- data/rbi/{lib/orb → orb}/models/subscription_price_intervals_params.rbi +4973 -3944
- data/rbi/{lib/orb → orb}/models/subscription_price_intervals_response.rbi +744 -477
- data/rbi/{lib/orb/models/subscription_create_params.rbi → orb/models/subscription_schedule_plan_change_params.rbi} +8649 -7019
- data/rbi/{lib/orb → orb}/models/subscription_schedule_plan_change_response.rbi +742 -491
- data/rbi/{lib/orb → orb}/models/subscription_trigger_phase_params.rbi +16 -13
- data/rbi/{lib/orb → orb}/models/subscription_trigger_phase_response.rbi +736 -472
- data/rbi/orb/models/subscription_unschedule_cancellation_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/subscription_unschedule_cancellation_response.rbi +743 -491
- data/rbi/{lib/orb → orb}/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +16 -5
- data/rbi/{lib/orb → orb}/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +717 -526
- data/rbi/orb/models/subscription_unschedule_pending_plan_changes_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/subscription_unschedule_pending_plan_changes_response.rbi +732 -521
- data/rbi/{lib/orb → orb}/models/subscription_update_fixed_fee_quantity_params.rbi +57 -26
- data/rbi/{lib/orb → orb}/models/subscription_update_fixed_fee_quantity_response.rbi +743 -491
- data/rbi/{lib/orb → orb}/models/subscription_update_params.rbi +19 -16
- data/rbi/orb/models/subscription_update_trial_params.rbi +104 -0
- data/rbi/{lib/orb → orb}/models/subscription_update_trial_response.rbi +736 -471
- data/rbi/orb/models/subscription_usage.rbi +446 -0
- data/rbi/orb/models/subscriptions.rbi +38 -0
- data/rbi/orb/models/top_level_ping_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/top_level_ping_response.rbi +7 -3
- data/rbi/{lib/orb → orb}/models/trial_discount.rbi +29 -20
- data/rbi/{lib/orb → orb}/models/usage_discount.rbi +28 -19
- data/rbi/orb/models.rbi +231 -0
- data/rbi/{lib/orb → orb}/request_options.rbi +12 -4
- data/rbi/{lib/orb → orb}/resources/alerts.rbi +57 -42
- data/rbi/{lib/orb → orb}/resources/coupons/subscriptions.rbi +7 -5
- data/rbi/{lib/orb → orb}/resources/coupons.rbi +25 -22
- data/rbi/{lib/orb → orb}/resources/credit_notes.rbi +18 -15
- data/rbi/{lib/orb → orb}/resources/customers/balance_transactions.rbi +17 -9
- data/rbi/{lib/orb → orb}/resources/customers/costs.rbi +18 -11
- data/rbi/{lib/orb → orb}/resources/customers/credits/ledger.rbi +98 -74
- data/rbi/{lib/orb → orb}/resources/customers/credits/top_ups.rbi +53 -29
- data/rbi/{lib/orb → orb}/resources/customers/credits.rbi +16 -7
- data/rbi/{lib/orb → orb}/resources/customers.rbi +117 -82
- data/rbi/{lib/orb → orb}/resources/dimensional_price_groups/external_dimensional_price_group_id.rbi +6 -5
- data/rbi/{lib/orb → orb}/resources/dimensional_price_groups.rbi +21 -14
- data/rbi/{lib/orb → orb}/resources/events/backfills.rbi +25 -20
- data/rbi/{lib/orb → orb}/resources/events/volume.rbi +7 -5
- data/rbi/{lib/orb → orb}/resources/events.rbi +22 -18
- data/rbi/{lib/orb → orb}/resources/invoice_line_items.rbi +7 -5
- data/rbi/{lib/orb → orb}/resources/invoices.rbi +55 -49
- data/rbi/{lib/orb → orb}/resources/items.rbi +31 -17
- data/rbi/{lib/orb → orb}/resources/metrics.rbi +21 -17
- data/rbi/{lib/orb → orb}/resources/plans/external_plan_id.rbi +11 -9
- data/rbi/{lib/orb → orb}/resources/plans.rbi +53 -49
- data/rbi/orb/resources/prices/external_price_id.rbi +108 -0
- data/rbi/{lib/orb → orb}/resources/prices.rbi +170 -157
- data/rbi/{lib/orb → orb}/resources/subscription_changes.rbi +15 -13
- data/rbi/{lib/orb → orb}/resources/subscriptions.rbi +188 -118
- data/rbi/{lib/orb → orb}/resources/top_level.rbi +7 -4
- data/sig/orb/internal/page.rbs +0 -2
- data/sig/orb/internal/type/request_parameters.rbs +3 -1
- data/sig/orb/internal/util.rbs +2 -0
- 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 +7 -14
- 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 +36 -57
- 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 +36 -57
- data/sig/orb/models/customer_update_params.rbs +36 -57
- 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 +92 -134
- data/sig/orb/models/customers/credits/ledger_create_entry_params.rbs +3 -7
- data/sig/orb/models/customers/credits/ledger_create_entry_response.rbs +92 -134
- 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 +92 -134
- data/sig/orb/models/customers/credits/ledger_list_params.rbs +0 -2
- data/sig/orb/models/customers/credits/ledger_list_response.rbs +92 -134
- 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 +126 -188
- 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 +41 -103
- 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 +41 -75
- 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 +55 -83
- data/sig/orb/models/plan_create_params.rbs +568 -746
- 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 +1250 -1790
- 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 +72 -110
- data/sig/orb/models/subscription_cancel_params.rbs +0 -2
- data/sig/orb/models/subscription_cancel_response.rbs +44 -84
- data/sig/orb/models/subscription_change_apply_params.rbs +0 -2
- data/sig/orb/models/subscription_change_apply_response.rbs +44 -86
- data/sig/orb/models/subscription_change_cancel_params.rbs +0 -2
- data/sig/orb/models/subscription_change_cancel_response.rbs +44 -86
- data/sig/orb/models/subscription_change_retrieve_params.rbs +0 -2
- data/sig/orb/models/subscription_change_retrieve_response.rbs +44 -86
- data/sig/orb/models/subscription_create_params.rbs +1223 -1619
- data/sig/orb/models/subscription_create_response.rbs +44 -84
- 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 +738 -970
- data/sig/orb/models/subscription_price_intervals_response.rbs +44 -84
- data/sig/orb/models/subscription_schedule_plan_change_params.rbs +1223 -1619
- data/sig/orb/models/subscription_schedule_plan_change_response.rbs +44 -84
- data/sig/orb/models/subscription_trigger_phase_params.rbs +0 -2
- data/sig/orb/models/subscription_trigger_phase_response.rbs +44 -84
- data/sig/orb/models/subscription_unschedule_cancellation_params.rbs +0 -2
- data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +44 -84
- 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 +44 -84
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_params.rbs +0 -2
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +44 -84
- data/sig/orb/models/subscription_update_fixed_fee_quantity_params.rbs +0 -2
- data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +44 -84
- 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 +44 -84
- 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/models.rbs +215 -0
- 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 +226 -223
- data/rbi/lib/orb/internal/type/array_of.rbi +0 -90
- data/rbi/lib/orb/internal/type/request_parameters.rbi +0 -21
- data/rbi/lib/orb/internal/type/union.rbi +0 -75
- data/rbi/lib/orb/internal/type/unknown.rbi +0 -42
- data/rbi/lib/orb/internal/util.rbi +0 -299
- data/rbi/lib/orb/models/alert_retrieve_params.rbi +0 -18
- data/rbi/lib/orb/models/billing_cycle_relative_date.rbi +0 -18
- data/rbi/lib/orb/models/coupon_archive_params.rbi +0 -18
- data/rbi/lib/orb/models/coupon_fetch_params.rbi +0 -18
- data/rbi/lib/orb/models/credit_note_create_params.rbi +0 -88
- data/rbi/lib/orb/models/credit_note_fetch_params.rbi +0 -18
- data/rbi/lib/orb/models/customer_delete_params.rbi +0 -18
- data/rbi/lib/orb/models/customer_fetch_by_external_id_params.rbi +0 -18
- data/rbi/lib/orb/models/customer_fetch_params.rbi +0 -18
- data/rbi/lib/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi +0 -18
- data/rbi/lib/orb/models/customer_sync_payment_methods_from_gateway_params.rbi +0 -18
- data/rbi/lib/orb/models/customers/balance_transaction_create_params.rbi +0 -65
- data/rbi/lib/orb/models/customers/balance_transaction_create_response.rbi +0 -208
- data/rbi/lib/orb/models/customers/balance_transaction_list_response.rbi +0 -196
- data/rbi/lib/orb/models/customers/cost_list_by_external_id_response.rbi +0 -225
- data/rbi/lib/orb/models/customers/cost_list_response.rbi +0 -223
- data/rbi/lib/orb/models/customers/credit_list_by_external_id_response.rbi +0 -84
- data/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rbi +0 -166
- data/rbi/lib/orb/models/customers/credits/ledger_list_params.rbi +0 -141
- data/rbi/lib/orb/models/customers/credits/top_up_delete_params.rbi +0 -26
- data/rbi/lib/orb/models/dimensional_price_group_retrieve_params.rbi +0 -18
- data/rbi/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi +0 -25
- data/rbi/lib/orb/models/dimensional_price_groups.rbi +0 -33
- data/rbi/lib/orb/models/discount.rbi +0 -17
- data/rbi/lib/orb/models/event_deprecate_params.rbi +0 -18
- data/rbi/lib/orb/models/events/backfill_close_params.rbi +0 -25
- data/rbi/lib/orb/models/events/backfill_fetch_params.rbi +0 -25
- data/rbi/lib/orb/models/events/backfill_revert_params.rbi +0 -25
- data/rbi/lib/orb/models/invoice_fetch_params.rbi +0 -18
- data/rbi/lib/orb/models/invoice_fetch_upcoming_params.rbi +0 -22
- data/rbi/lib/orb/models/invoice_level_discount.rbi +0 -15
- data/rbi/lib/orb/models/invoice_pay_params.rbi +0 -18
- data/rbi/lib/orb/models/invoice_void_params.rbi +0 -18
- data/rbi/lib/orb/models/item.rbi +0 -95
- data/rbi/lib/orb/models/item_fetch_params.rbi +0 -18
- data/rbi/lib/orb/models/item_update_params.rbi +0 -101
- data/rbi/lib/orb/models/metric_fetch_params.rbi +0 -18
- data/rbi/lib/orb/models/pagination_metadata.rbi +0 -19
- data/rbi/lib/orb/models/plan_fetch_params.rbi +0 -18
- data/rbi/lib/orb/models/plans/external_plan_id_fetch_params.rbi +0 -25
- data/rbi/lib/orb/models/price.rbi +0 -14861
- data/rbi/lib/orb/models/price_evaluate_response.rbi +0 -19
- data/rbi/lib/orb/models/price_fetch_params.rbi +0 -18
- data/rbi/lib/orb/models/prices/external_price_id_fetch_params.rbi +0 -25
- data/rbi/lib/orb/models/subscription_change_cancel_params.rbi +0 -18
- data/rbi/lib/orb/models/subscription_change_retrieve_params.rbi +0 -18
- data/rbi/lib/orb/models/subscription_fetch_costs_response.rbi +0 -221
- data/rbi/lib/orb/models/subscription_fetch_params.rbi +0 -18
- data/rbi/lib/orb/models/subscription_unschedule_cancellation_params.rbi +0 -18
- data/rbi/lib/orb/models/subscription_unschedule_pending_plan_changes_params.rbi +0 -18
- data/rbi/lib/orb/models/subscription_update_trial_params.rbi +0 -66
- data/rbi/lib/orb/models/subscription_usage.rbi +0 -296
- data/rbi/lib/orb/models/subscriptions.rbi +0 -31
- data/rbi/lib/orb/models/top_level_ping_params.rbi +0 -18
- data/rbi/lib/orb/resources/prices/external_price_id.rbi +0 -106
- /data/rbi/{lib/orb → orb}/internal.rbi +0 -0
- /data/rbi/{lib/orb → orb}/version.rbi +0 -0
@@ -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,72 +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,
|
113
|
-
-> { Orb::Models::PlanCreateParams::Price::NewPlanThresholdTotalAmountPrice }
|
106
|
+
variant :threshold_total_amount, -> { Orb::PlanCreateParams::Price::ThresholdTotalAmount }
|
114
107
|
|
115
|
-
variant :tiered_package, -> { Orb::
|
108
|
+
variant :tiered_package, -> { Orb::PlanCreateParams::Price::TieredPackage }
|
116
109
|
|
117
|
-
variant :tiered_with_minimum, -> { Orb::
|
110
|
+
variant :tiered_with_minimum, -> { Orb::PlanCreateParams::Price::TieredWithMinimum }
|
118
111
|
|
119
|
-
variant :unit_with_percent, -> { Orb::
|
112
|
+
variant :unit_with_percent, -> { Orb::PlanCreateParams::Price::UnitWithPercent }
|
120
113
|
|
121
|
-
variant :package_with_allocation,
|
122
|
-
-> { Orb::Models::PlanCreateParams::Price::NewPlanPackageWithAllocationPrice }
|
114
|
+
variant :package_with_allocation, -> { Orb::PlanCreateParams::Price::PackageWithAllocation }
|
123
115
|
|
124
|
-
variant :tiered_with_proration, -> { Orb::
|
116
|
+
variant :tiered_with_proration, -> { Orb::PlanCreateParams::Price::TieredWithProration }
|
125
117
|
|
126
|
-
variant :unit_with_proration, -> { Orb::
|
118
|
+
variant :unit_with_proration, -> { Orb::PlanCreateParams::Price::UnitWithProration }
|
127
119
|
|
128
|
-
variant :grouped_allocation, -> { Orb::
|
120
|
+
variant :grouped_allocation, -> { Orb::PlanCreateParams::Price::GroupedAllocation }
|
129
121
|
|
130
122
|
variant :grouped_with_prorated_minimum,
|
131
|
-
-> {
|
123
|
+
-> {
|
124
|
+
Orb::PlanCreateParams::Price::GroupedWithProratedMinimum
|
125
|
+
}
|
132
126
|
|
133
|
-
variant :grouped_with_metered_minimum,
|
134
|
-
-> { Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithMeteredMinimumPrice }
|
127
|
+
variant :grouped_with_metered_minimum, -> { Orb::PlanCreateParams::Price::GroupedWithMeteredMinimum }
|
135
128
|
|
136
|
-
variant :matrix_with_display_name,
|
137
|
-
-> { Orb::Models::PlanCreateParams::Price::NewPlanMatrixWithDisplayNamePrice }
|
129
|
+
variant :matrix_with_display_name, -> { Orb::PlanCreateParams::Price::MatrixWithDisplayName }
|
138
130
|
|
139
|
-
variant :bulk_with_proration, -> { Orb::
|
131
|
+
variant :bulk_with_proration, -> { Orb::PlanCreateParams::Price::BulkWithProration }
|
140
132
|
|
141
|
-
variant :grouped_tiered_package,
|
142
|
-
-> { Orb::Models::PlanCreateParams::Price::NewPlanGroupedTieredPackagePrice }
|
133
|
+
variant :grouped_tiered_package, -> { Orb::PlanCreateParams::Price::GroupedTieredPackage }
|
143
134
|
|
144
|
-
variant :max_group_tiered_package,
|
145
|
-
-> { Orb::Models::PlanCreateParams::Price::NewPlanMaxGroupTieredPackagePrice }
|
135
|
+
variant :max_group_tiered_package, -> { Orb::PlanCreateParams::Price::MaxGroupTieredPackage }
|
146
136
|
|
147
137
|
variant :scalable_matrix_with_unit_pricing,
|
148
|
-
-> { Orb::
|
138
|
+
-> { Orb::PlanCreateParams::Price::ScalableMatrixWithUnitPricing }
|
149
139
|
|
150
140
|
variant :scalable_matrix_with_tiered_pricing,
|
151
|
-
-> { Orb::
|
141
|
+
-> { Orb::PlanCreateParams::Price::ScalableMatrixWithTieredPricing }
|
152
142
|
|
153
|
-
variant :cumulative_grouped_bulk,
|
154
|
-
-> { Orb::Models::PlanCreateParams::Price::NewPlanCumulativeGroupedBulkPrice }
|
143
|
+
variant :cumulative_grouped_bulk, -> { Orb::PlanCreateParams::Price::CumulativeGroupedBulk }
|
155
144
|
|
156
|
-
class
|
145
|
+
class Unit < Orb::Internal::Type::BaseModel
|
157
146
|
# @!attribute cadence
|
158
147
|
# The cadence to bill for this price on.
|
159
148
|
#
|
160
|
-
# @return [Symbol, Orb::
|
161
|
-
required :cadence, enum: -> { Orb::
|
149
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::Unit::Cadence]
|
150
|
+
required :cadence, enum: -> { Orb::PlanCreateParams::Price::Unit::Cadence }
|
162
151
|
|
163
152
|
# @!attribute item_id
|
164
153
|
# The id of the item the price will be associated with.
|
@@ -179,8 +168,8 @@ module Orb
|
|
179
168
|
|
180
169
|
# @!attribute unit_config
|
181
170
|
#
|
182
|
-
# @return [Orb::
|
183
|
-
required :unit_config, -> { Orb::
|
171
|
+
# @return [Orb::PlanCreateParams::Price::Unit::UnitConfig]
|
172
|
+
required :unit_config, -> { Orb::PlanCreateParams::Price::Unit::UnitConfig }
|
184
173
|
|
185
174
|
# @!attribute billable_metric_id
|
186
175
|
# The id of the billable metric for the price. Only needed if the price is
|
@@ -200,9 +189,9 @@ module Orb
|
|
200
189
|
# For custom cadence: specifies the duration of the billing period in days or
|
201
190
|
# months.
|
202
191
|
#
|
203
|
-
# @return [Orb::
|
192
|
+
# @return [Orb::PlanCreateParams::Price::Unit::BillingCycleConfiguration, nil]
|
204
193
|
optional :billing_cycle_configuration,
|
205
|
-
-> { Orb::
|
194
|
+
-> { Orb::PlanCreateParams::Price::Unit::BillingCycleConfiguration },
|
206
195
|
nil?: true
|
207
196
|
|
208
197
|
# @!attribute conversion_rate
|
@@ -241,9 +230,9 @@ module Orb
|
|
241
230
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
242
231
|
# If unspecified, a single invoice is produced per billing cycle.
|
243
232
|
#
|
244
|
-
# @return [Orb::
|
233
|
+
# @return [Orb::PlanCreateParams::Price::Unit::InvoicingCycleConfiguration, nil]
|
245
234
|
optional :invoicing_cycle_configuration,
|
246
|
-
-> { Orb::
|
235
|
+
-> { Orb::PlanCreateParams::Price::Unit::InvoicingCycleConfiguration },
|
247
236
|
nil?: true
|
248
237
|
|
249
238
|
# @!attribute metadata
|
@@ -256,48 +245,41 @@ module Orb
|
|
256
245
|
|
257
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)
|
258
247
|
# Some parameter documentations has been truncated, see
|
259
|
-
# {Orb::
|
248
|
+
# {Orb::PlanCreateParams::Price::Unit} for more details.
|
260
249
|
#
|
261
|
-
# @param cadence [Symbol, Orb::
|
250
|
+
# @param cadence [Symbol, Orb::PlanCreateParams::Price::Unit::Cadence] The cadence to bill for this price on.
|
262
251
|
#
|
263
252
|
# @param item_id [String] The id of the item the price will be associated with.
|
264
253
|
#
|
265
254
|
# @param name [String] The name of the price.
|
266
255
|
#
|
267
|
-
# @param unit_config [Orb::
|
256
|
+
# @param unit_config [Orb::PlanCreateParams::Price::Unit::UnitConfig]
|
268
257
|
#
|
269
258
|
# @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b
|
270
|
-
# ...
|
271
259
|
#
|
272
260
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
273
|
-
# ...
|
274
261
|
#
|
275
|
-
# @param billing_cycle_configuration [Orb::
|
276
|
-
# ...
|
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
|
277
263
|
#
|
278
264
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
279
265
|
#
|
280
266
|
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
281
|
-
# ...
|
282
267
|
#
|
283
268
|
# @param external_price_id [String, nil] An alias for the price.
|
284
269
|
#
|
285
270
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
286
|
-
# ...
|
287
271
|
#
|
288
272
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
289
273
|
#
|
290
|
-
# @param invoicing_cycle_configuration [Orb::
|
291
|
-
# ...
|
274
|
+
# @param invoicing_cycle_configuration [Orb::PlanCreateParams::Price::Unit::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
292
275
|
#
|
293
276
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
294
|
-
# ...
|
295
277
|
#
|
296
278
|
# @param model_type [Symbol, :unit]
|
297
279
|
|
298
280
|
# The cadence to bill for this price on.
|
299
281
|
#
|
300
|
-
# @see Orb::
|
282
|
+
# @see Orb::PlanCreateParams::Price::Unit#cadence
|
301
283
|
module Cadence
|
302
284
|
extend Orb::Internal::Type::Enum
|
303
285
|
|
@@ -312,7 +294,7 @@ module Orb
|
|
312
294
|
# @return [Array<Symbol>]
|
313
295
|
end
|
314
296
|
|
315
|
-
# @see Orb::
|
297
|
+
# @see Orb::PlanCreateParams::Price::Unit#unit_config
|
316
298
|
class UnitConfig < Orb::Internal::Type::BaseModel
|
317
299
|
# @!attribute unit_amount
|
318
300
|
# Rate per unit of usage
|
@@ -324,7 +306,7 @@ module Orb
|
|
324
306
|
# @param unit_amount [String] Rate per unit of usage
|
325
307
|
end
|
326
308
|
|
327
|
-
# @see Orb::
|
309
|
+
# @see Orb::PlanCreateParams::Price::Unit#billing_cycle_configuration
|
328
310
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
329
311
|
# @!attribute duration
|
330
312
|
# The duration of the billing period.
|
@@ -335,9 +317,9 @@ module Orb
|
|
335
317
|
# @!attribute duration_unit
|
336
318
|
# The unit of billing period duration.
|
337
319
|
#
|
338
|
-
# @return [Symbol, Orb::
|
320
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::Unit::BillingCycleConfiguration::DurationUnit]
|
339
321
|
required :duration_unit,
|
340
|
-
enum: -> { Orb::
|
322
|
+
enum: -> { Orb::PlanCreateParams::Price::Unit::BillingCycleConfiguration::DurationUnit }
|
341
323
|
|
342
324
|
# @!method initialize(duration:, duration_unit:)
|
343
325
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -345,11 +327,11 @@ module Orb
|
|
345
327
|
#
|
346
328
|
# @param duration [Integer] The duration of the billing period.
|
347
329
|
#
|
348
|
-
# @param duration_unit [Symbol, Orb::
|
330
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::Unit::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
349
331
|
|
350
332
|
# The unit of billing period duration.
|
351
333
|
#
|
352
|
-
# @see Orb::
|
334
|
+
# @see Orb::PlanCreateParams::Price::Unit::BillingCycleConfiguration#duration_unit
|
353
335
|
module DurationUnit
|
354
336
|
extend Orb::Internal::Type::Enum
|
355
337
|
|
@@ -361,7 +343,7 @@ module Orb
|
|
361
343
|
end
|
362
344
|
end
|
363
345
|
|
364
|
-
# @see Orb::
|
346
|
+
# @see Orb::PlanCreateParams::Price::Unit#invoicing_cycle_configuration
|
365
347
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
366
348
|
# @!attribute duration
|
367
349
|
# The duration of the billing period.
|
@@ -372,9 +354,11 @@ module Orb
|
|
372
354
|
# @!attribute duration_unit
|
373
355
|
# The unit of billing period duration.
|
374
356
|
#
|
375
|
-
# @return [Symbol, Orb::
|
357
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::Unit::InvoicingCycleConfiguration::DurationUnit]
|
376
358
|
required :duration_unit,
|
377
|
-
enum: -> {
|
359
|
+
enum: -> {
|
360
|
+
Orb::PlanCreateParams::Price::Unit::InvoicingCycleConfiguration::DurationUnit
|
361
|
+
}
|
378
362
|
|
379
363
|
# @!method initialize(duration:, duration_unit:)
|
380
364
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
@@ -382,11 +366,11 @@ module Orb
|
|
382
366
|
#
|
383
367
|
# @param duration [Integer] The duration of the billing period.
|
384
368
|
#
|
385
|
-
# @param duration_unit [Symbol, Orb::
|
369
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::Unit::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
386
370
|
|
387
371
|
# The unit of billing period duration.
|
388
372
|
#
|
389
|
-
# @see Orb::
|
373
|
+
# @see Orb::PlanCreateParams::Price::Unit::InvoicingCycleConfiguration#duration_unit
|
390
374
|
module DurationUnit
|
391
375
|
extend Orb::Internal::Type::Enum
|
392
376
|
|
@@ -399,12 +383,12 @@ module Orb
|
|
399
383
|
end
|
400
384
|
end
|
401
385
|
|
402
|
-
class
|
386
|
+
class Package < Orb::Internal::Type::BaseModel
|
403
387
|
# @!attribute cadence
|
404
388
|
# The cadence to bill for this price on.
|
405
389
|
#
|
406
|
-
# @return [Symbol, Orb::
|
407
|
-
required :cadence, enum: -> { Orb::
|
390
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::Package::Cadence]
|
391
|
+
required :cadence, enum: -> { Orb::PlanCreateParams::Price::Package::Cadence }
|
408
392
|
|
409
393
|
# @!attribute item_id
|
410
394
|
# The id of the item the price will be associated with.
|
@@ -425,8 +409,8 @@ module Orb
|
|
425
409
|
|
426
410
|
# @!attribute package_config
|
427
411
|
#
|
428
|
-
# @return [Orb::
|
429
|
-
required :package_config, -> { Orb::
|
412
|
+
# @return [Orb::PlanCreateParams::Price::Package::PackageConfig]
|
413
|
+
required :package_config, -> { Orb::PlanCreateParams::Price::Package::PackageConfig }
|
430
414
|
|
431
415
|
# @!attribute billable_metric_id
|
432
416
|
# The id of the billable metric for the price. Only needed if the price is
|
@@ -446,9 +430,9 @@ module Orb
|
|
446
430
|
# For custom cadence: specifies the duration of the billing period in days or
|
447
431
|
# months.
|
448
432
|
#
|
449
|
-
# @return [Orb::
|
433
|
+
# @return [Orb::PlanCreateParams::Price::Package::BillingCycleConfiguration, nil]
|
450
434
|
optional :billing_cycle_configuration,
|
451
|
-
-> { Orb::
|
435
|
+
-> { Orb::PlanCreateParams::Price::Package::BillingCycleConfiguration },
|
452
436
|
nil?: true
|
453
437
|
|
454
438
|
# @!attribute conversion_rate
|
@@ -487,9 +471,9 @@ module Orb
|
|
487
471
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
488
472
|
# If unspecified, a single invoice is produced per billing cycle.
|
489
473
|
#
|
490
|
-
# @return [Orb::
|
474
|
+
# @return [Orb::PlanCreateParams::Price::Package::InvoicingCycleConfiguration, nil]
|
491
475
|
optional :invoicing_cycle_configuration,
|
492
|
-
-> { Orb::
|
476
|
+
-> { Orb::PlanCreateParams::Price::Package::InvoicingCycleConfiguration },
|
493
477
|
nil?: true
|
494
478
|
|
495
479
|
# @!attribute metadata
|
@@ -502,48 +486,41 @@ module Orb
|
|
502
486
|
|
503
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)
|
504
488
|
# Some parameter documentations has been truncated, see
|
505
|
-
# {Orb::
|
489
|
+
# {Orb::PlanCreateParams::Price::Package} for more details.
|
506
490
|
#
|
507
|
-
# @param cadence [Symbol, Orb::
|
491
|
+
# @param cadence [Symbol, Orb::PlanCreateParams::Price::Package::Cadence] The cadence to bill for this price on.
|
508
492
|
#
|
509
493
|
# @param item_id [String] The id of the item the price will be associated with.
|
510
494
|
#
|
511
495
|
# @param name [String] The name of the price.
|
512
496
|
#
|
513
|
-
# @param package_config [Orb::
|
497
|
+
# @param package_config [Orb::PlanCreateParams::Price::Package::PackageConfig]
|
514
498
|
#
|
515
499
|
# @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b
|
516
|
-
# ...
|
517
500
|
#
|
518
501
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
519
|
-
# ...
|
520
502
|
#
|
521
|
-
# @param billing_cycle_configuration [Orb::
|
522
|
-
# ...
|
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
|
523
504
|
#
|
524
505
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
525
506
|
#
|
526
507
|
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
527
|
-
# ...
|
528
508
|
#
|
529
509
|
# @param external_price_id [String, nil] An alias for the price.
|
530
510
|
#
|
531
511
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
532
|
-
# ...
|
533
512
|
#
|
534
513
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
535
514
|
#
|
536
|
-
# @param invoicing_cycle_configuration [Orb::
|
537
|
-
# ...
|
515
|
+
# @param invoicing_cycle_configuration [Orb::PlanCreateParams::Price::Package::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
538
516
|
#
|
539
517
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
540
|
-
# ...
|
541
518
|
#
|
542
519
|
# @param model_type [Symbol, :package]
|
543
520
|
|
544
521
|
# The cadence to bill for this price on.
|
545
522
|
#
|
546
|
-
# @see Orb::
|
523
|
+
# @see Orb::PlanCreateParams::Price::Package#cadence
|
547
524
|
module Cadence
|
548
525
|
extend Orb::Internal::Type::Enum
|
549
526
|
|
@@ -558,7 +535,7 @@ module Orb
|
|
558
535
|
# @return [Array<Symbol>]
|
559
536
|
end
|
560
537
|
|
561
|
-
# @see Orb::
|
538
|
+
# @see Orb::PlanCreateParams::Price::Package#package_config
|
562
539
|
class PackageConfig < Orb::Internal::Type::BaseModel
|
563
540
|
# @!attribute package_amount
|
564
541
|
# A currency amount to rate usage by
|
@@ -575,16 +552,14 @@ module Orb
|
|
575
552
|
|
576
553
|
# @!method initialize(package_amount:, package_size:)
|
577
554
|
# Some parameter documentations has been truncated, see
|
578
|
-
# {Orb::
|
579
|
-
# more details.
|
555
|
+
# {Orb::PlanCreateParams::Price::Package::PackageConfig} for more details.
|
580
556
|
#
|
581
557
|
# @param package_amount [String] A currency amount to rate usage by
|
582
558
|
#
|
583
559
|
# @param package_size [Integer] An integer amount to represent package size. For example, 1000 here would divide
|
584
|
-
# ...
|
585
560
|
end
|
586
561
|
|
587
|
-
# @see Orb::
|
562
|
+
# @see Orb::PlanCreateParams::Price::Package#billing_cycle_configuration
|
588
563
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
589
564
|
# @!attribute duration
|
590
565
|
# The duration of the billing period.
|
@@ -595,9 +570,11 @@ module Orb
|
|
595
570
|
# @!attribute duration_unit
|
596
571
|
# The unit of billing period duration.
|
597
572
|
#
|
598
|
-
# @return [Symbol, Orb::
|
573
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::Package::BillingCycleConfiguration::DurationUnit]
|
599
574
|
required :duration_unit,
|
600
|
-
enum: -> {
|
575
|
+
enum: -> {
|
576
|
+
Orb::PlanCreateParams::Price::Package::BillingCycleConfiguration::DurationUnit
|
577
|
+
}
|
601
578
|
|
602
579
|
# @!method initialize(duration:, duration_unit:)
|
603
580
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -605,11 +582,11 @@ module Orb
|
|
605
582
|
#
|
606
583
|
# @param duration [Integer] The duration of the billing period.
|
607
584
|
#
|
608
|
-
# @param duration_unit [Symbol, Orb::
|
585
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::Package::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
609
586
|
|
610
587
|
# The unit of billing period duration.
|
611
588
|
#
|
612
|
-
# @see Orb::
|
589
|
+
# @see Orb::PlanCreateParams::Price::Package::BillingCycleConfiguration#duration_unit
|
613
590
|
module DurationUnit
|
614
591
|
extend Orb::Internal::Type::Enum
|
615
592
|
|
@@ -621,7 +598,7 @@ module Orb
|
|
621
598
|
end
|
622
599
|
end
|
623
600
|
|
624
|
-
# @see Orb::
|
601
|
+
# @see Orb::PlanCreateParams::Price::Package#invoicing_cycle_configuration
|
625
602
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
626
603
|
# @!attribute duration
|
627
604
|
# The duration of the billing period.
|
@@ -632,9 +609,11 @@ module Orb
|
|
632
609
|
# @!attribute duration_unit
|
633
610
|
# The unit of billing period duration.
|
634
611
|
#
|
635
|
-
# @return [Symbol, Orb::
|
612
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::Package::InvoicingCycleConfiguration::DurationUnit]
|
636
613
|
required :duration_unit,
|
637
|
-
enum: -> {
|
614
|
+
enum: -> {
|
615
|
+
Orb::PlanCreateParams::Price::Package::InvoicingCycleConfiguration::DurationUnit
|
616
|
+
}
|
638
617
|
|
639
618
|
# @!method initialize(duration:, duration_unit:)
|
640
619
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
@@ -642,11 +621,11 @@ module Orb
|
|
642
621
|
#
|
643
622
|
# @param duration [Integer] The duration of the billing period.
|
644
623
|
#
|
645
|
-
# @param duration_unit [Symbol, Orb::
|
624
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::Package::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
646
625
|
|
647
626
|
# The unit of billing period duration.
|
648
627
|
#
|
649
|
-
# @see Orb::
|
628
|
+
# @see Orb::PlanCreateParams::Price::Package::InvoicingCycleConfiguration#duration_unit
|
650
629
|
module DurationUnit
|
651
630
|
extend Orb::Internal::Type::Enum
|
652
631
|
|
@@ -659,12 +638,12 @@ module Orb
|
|
659
638
|
end
|
660
639
|
end
|
661
640
|
|
662
|
-
class
|
641
|
+
class Matrix < Orb::Internal::Type::BaseModel
|
663
642
|
# @!attribute cadence
|
664
643
|
# The cadence to bill for this price on.
|
665
644
|
#
|
666
|
-
# @return [Symbol, Orb::
|
667
|
-
required :cadence, enum: -> { Orb::
|
645
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::Matrix::Cadence]
|
646
|
+
required :cadence, enum: -> { Orb::PlanCreateParams::Price::Matrix::Cadence }
|
668
647
|
|
669
648
|
# @!attribute item_id
|
670
649
|
# The id of the item the price will be associated with.
|
@@ -674,8 +653,8 @@ module Orb
|
|
674
653
|
|
675
654
|
# @!attribute matrix_config
|
676
655
|
#
|
677
|
-
# @return [Orb::
|
678
|
-
required :matrix_config, -> { Orb::
|
656
|
+
# @return [Orb::PlanCreateParams::Price::Matrix::MatrixConfig]
|
657
|
+
required :matrix_config, -> { Orb::PlanCreateParams::Price::Matrix::MatrixConfig }
|
679
658
|
|
680
659
|
# @!attribute model_type
|
681
660
|
#
|
@@ -706,9 +685,9 @@ module Orb
|
|
706
685
|
# For custom cadence: specifies the duration of the billing period in days or
|
707
686
|
# months.
|
708
687
|
#
|
709
|
-
# @return [Orb::
|
688
|
+
# @return [Orb::PlanCreateParams::Price::Matrix::BillingCycleConfiguration, nil]
|
710
689
|
optional :billing_cycle_configuration,
|
711
|
-
-> { Orb::
|
690
|
+
-> { Orb::PlanCreateParams::Price::Matrix::BillingCycleConfiguration },
|
712
691
|
nil?: true
|
713
692
|
|
714
693
|
# @!attribute conversion_rate
|
@@ -747,9 +726,9 @@ module Orb
|
|
747
726
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
748
727
|
# If unspecified, a single invoice is produced per billing cycle.
|
749
728
|
#
|
750
|
-
# @return [Orb::
|
729
|
+
# @return [Orb::PlanCreateParams::Price::Matrix::InvoicingCycleConfiguration, nil]
|
751
730
|
optional :invoicing_cycle_configuration,
|
752
|
-
-> { Orb::
|
731
|
+
-> { Orb::PlanCreateParams::Price::Matrix::InvoicingCycleConfiguration },
|
753
732
|
nil?: true
|
754
733
|
|
755
734
|
# @!attribute metadata
|
@@ -762,48 +741,41 @@ module Orb
|
|
762
741
|
|
763
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)
|
764
743
|
# Some parameter documentations has been truncated, see
|
765
|
-
# {Orb::
|
744
|
+
# {Orb::PlanCreateParams::Price::Matrix} for more details.
|
766
745
|
#
|
767
|
-
# @param cadence [Symbol, Orb::
|
746
|
+
# @param cadence [Symbol, Orb::PlanCreateParams::Price::Matrix::Cadence] The cadence to bill for this price on.
|
768
747
|
#
|
769
748
|
# @param item_id [String] The id of the item the price will be associated with.
|
770
749
|
#
|
771
|
-
# @param matrix_config [Orb::
|
750
|
+
# @param matrix_config [Orb::PlanCreateParams::Price::Matrix::MatrixConfig]
|
772
751
|
#
|
773
752
|
# @param name [String] The name of the price.
|
774
753
|
#
|
775
754
|
# @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b
|
776
|
-
# ...
|
777
755
|
#
|
778
756
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
779
|
-
# ...
|
780
757
|
#
|
781
|
-
# @param billing_cycle_configuration [Orb::
|
782
|
-
# ...
|
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
|
783
759
|
#
|
784
760
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
785
761
|
#
|
786
762
|
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
787
|
-
# ...
|
788
763
|
#
|
789
764
|
# @param external_price_id [String, nil] An alias for the price.
|
790
765
|
#
|
791
766
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
792
|
-
# ...
|
793
767
|
#
|
794
768
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
795
769
|
#
|
796
|
-
# @param invoicing_cycle_configuration [Orb::
|
797
|
-
# ...
|
770
|
+
# @param invoicing_cycle_configuration [Orb::PlanCreateParams::Price::Matrix::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
798
771
|
#
|
799
772
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
800
|
-
# ...
|
801
773
|
#
|
802
774
|
# @param model_type [Symbol, :matrix]
|
803
775
|
|
804
776
|
# The cadence to bill for this price on.
|
805
777
|
#
|
806
|
-
# @see Orb::
|
778
|
+
# @see Orb::PlanCreateParams::Price::Matrix#cadence
|
807
779
|
module Cadence
|
808
780
|
extend Orb::Internal::Type::Enum
|
809
781
|
|
@@ -818,7 +790,7 @@ module Orb
|
|
818
790
|
# @return [Array<Symbol>]
|
819
791
|
end
|
820
792
|
|
821
|
-
# @see Orb::
|
793
|
+
# @see Orb::PlanCreateParams::Price::Matrix#matrix_config
|
822
794
|
class MatrixConfig < Orb::Internal::Type::BaseModel
|
823
795
|
# @!attribute default_unit_amount
|
824
796
|
# Default per unit rate for any usage not bucketed into a specified matrix_value
|
@@ -835,16 +807,18 @@ module Orb
|
|
835
807
|
# @!attribute matrix_values
|
836
808
|
# Matrix values for specified matrix grouping keys
|
837
809
|
#
|
838
|
-
# @return [Array<Orb::
|
810
|
+
# @return [Array<Orb::PlanCreateParams::Price::Matrix::MatrixConfig::MatrixValue>]
|
839
811
|
required :matrix_values,
|
840
|
-
-> {
|
812
|
+
-> {
|
813
|
+
Orb::Internal::Type::ArrayOf[Orb::PlanCreateParams::Price::Matrix::MatrixConfig::MatrixValue]
|
814
|
+
}
|
841
815
|
|
842
816
|
# @!method initialize(default_unit_amount:, dimensions:, matrix_values:)
|
843
817
|
# @param default_unit_amount [String] Default per unit rate for any usage not bucketed into a specified matrix_value
|
844
818
|
#
|
845
819
|
# @param dimensions [Array<String, nil>] One or two event property values to evaluate matrix groups by
|
846
820
|
#
|
847
|
-
# @param matrix_values [Array<Orb::
|
821
|
+
# @param matrix_values [Array<Orb::PlanCreateParams::Price::Matrix::MatrixConfig::MatrixValue>] Matrix values for specified matrix grouping keys
|
848
822
|
|
849
823
|
class MatrixValue < Orb::Internal::Type::BaseModel
|
850
824
|
# @!attribute dimension_values
|
@@ -863,17 +837,16 @@ module Orb
|
|
863
837
|
|
864
838
|
# @!method initialize(dimension_values:, unit_amount:)
|
865
839
|
# Some parameter documentations has been truncated, see
|
866
|
-
# {Orb::
|
867
|
-
#
|
840
|
+
# {Orb::PlanCreateParams::Price::Matrix::MatrixConfig::MatrixValue} for more
|
841
|
+
# details.
|
868
842
|
#
|
869
843
|
# @param dimension_values [Array<String, nil>] One or two matrix keys to filter usage to this Matrix value by. For example, ["r
|
870
|
-
# ...
|
871
844
|
#
|
872
845
|
# @param unit_amount [String] Unit price for the specified dimension_values
|
873
846
|
end
|
874
847
|
end
|
875
848
|
|
876
|
-
# @see Orb::
|
849
|
+
# @see Orb::PlanCreateParams::Price::Matrix#billing_cycle_configuration
|
877
850
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
878
851
|
# @!attribute duration
|
879
852
|
# The duration of the billing period.
|
@@ -884,9 +857,11 @@ module Orb
|
|
884
857
|
# @!attribute duration_unit
|
885
858
|
# The unit of billing period duration.
|
886
859
|
#
|
887
|
-
# @return [Symbol, Orb::
|
860
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::Matrix::BillingCycleConfiguration::DurationUnit]
|
888
861
|
required :duration_unit,
|
889
|
-
enum: -> {
|
862
|
+
enum: -> {
|
863
|
+
Orb::PlanCreateParams::Price::Matrix::BillingCycleConfiguration::DurationUnit
|
864
|
+
}
|
890
865
|
|
891
866
|
# @!method initialize(duration:, duration_unit:)
|
892
867
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -894,11 +869,11 @@ module Orb
|
|
894
869
|
#
|
895
870
|
# @param duration [Integer] The duration of the billing period.
|
896
871
|
#
|
897
|
-
# @param duration_unit [Symbol, Orb::
|
872
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::Matrix::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
898
873
|
|
899
874
|
# The unit of billing period duration.
|
900
875
|
#
|
901
|
-
# @see Orb::
|
876
|
+
# @see Orb::PlanCreateParams::Price::Matrix::BillingCycleConfiguration#duration_unit
|
902
877
|
module DurationUnit
|
903
878
|
extend Orb::Internal::Type::Enum
|
904
879
|
|
@@ -910,7 +885,7 @@ module Orb
|
|
910
885
|
end
|
911
886
|
end
|
912
887
|
|
913
|
-
# @see Orb::
|
888
|
+
# @see Orb::PlanCreateParams::Price::Matrix#invoicing_cycle_configuration
|
914
889
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
915
890
|
# @!attribute duration
|
916
891
|
# The duration of the billing period.
|
@@ -921,9 +896,11 @@ module Orb
|
|
921
896
|
# @!attribute duration_unit
|
922
897
|
# The unit of billing period duration.
|
923
898
|
#
|
924
|
-
# @return [Symbol, Orb::
|
899
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::Matrix::InvoicingCycleConfiguration::DurationUnit]
|
925
900
|
required :duration_unit,
|
926
|
-
enum: -> {
|
901
|
+
enum: -> {
|
902
|
+
Orb::PlanCreateParams::Price::Matrix::InvoicingCycleConfiguration::DurationUnit
|
903
|
+
}
|
927
904
|
|
928
905
|
# @!method initialize(duration:, duration_unit:)
|
929
906
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
@@ -931,11 +908,11 @@ module Orb
|
|
931
908
|
#
|
932
909
|
# @param duration [Integer] The duration of the billing period.
|
933
910
|
#
|
934
|
-
# @param duration_unit [Symbol, Orb::
|
911
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::Matrix::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
935
912
|
|
936
913
|
# The unit of billing period duration.
|
937
914
|
#
|
938
|
-
# @see Orb::
|
915
|
+
# @see Orb::PlanCreateParams::Price::Matrix::InvoicingCycleConfiguration#duration_unit
|
939
916
|
module DurationUnit
|
940
917
|
extend Orb::Internal::Type::Enum
|
941
918
|
|
@@ -948,12 +925,12 @@ module Orb
|
|
948
925
|
end
|
949
926
|
end
|
950
927
|
|
951
|
-
class
|
928
|
+
class Tiered < Orb::Internal::Type::BaseModel
|
952
929
|
# @!attribute cadence
|
953
930
|
# The cadence to bill for this price on.
|
954
931
|
#
|
955
|
-
# @return [Symbol, Orb::
|
956
|
-
required :cadence, enum: -> { Orb::
|
932
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::Tiered::Cadence]
|
933
|
+
required :cadence, enum: -> { Orb::PlanCreateParams::Price::Tiered::Cadence }
|
957
934
|
|
958
935
|
# @!attribute item_id
|
959
936
|
# The id of the item the price will be associated with.
|
@@ -974,8 +951,8 @@ module Orb
|
|
974
951
|
|
975
952
|
# @!attribute tiered_config
|
976
953
|
#
|
977
|
-
# @return [Orb::
|
978
|
-
required :tiered_config, -> { Orb::
|
954
|
+
# @return [Orb::PlanCreateParams::Price::Tiered::TieredConfig]
|
955
|
+
required :tiered_config, -> { Orb::PlanCreateParams::Price::Tiered::TieredConfig }
|
979
956
|
|
980
957
|
# @!attribute billable_metric_id
|
981
958
|
# The id of the billable metric for the price. Only needed if the price is
|
@@ -995,9 +972,9 @@ module Orb
|
|
995
972
|
# For custom cadence: specifies the duration of the billing period in days or
|
996
973
|
# months.
|
997
974
|
#
|
998
|
-
# @return [Orb::
|
975
|
+
# @return [Orb::PlanCreateParams::Price::Tiered::BillingCycleConfiguration, nil]
|
999
976
|
optional :billing_cycle_configuration,
|
1000
|
-
-> { Orb::
|
977
|
+
-> { Orb::PlanCreateParams::Price::Tiered::BillingCycleConfiguration },
|
1001
978
|
nil?: true
|
1002
979
|
|
1003
980
|
# @!attribute conversion_rate
|
@@ -1036,9 +1013,9 @@ module Orb
|
|
1036
1013
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
1037
1014
|
# If unspecified, a single invoice is produced per billing cycle.
|
1038
1015
|
#
|
1039
|
-
# @return [Orb::
|
1016
|
+
# @return [Orb::PlanCreateParams::Price::Tiered::InvoicingCycleConfiguration, nil]
|
1040
1017
|
optional :invoicing_cycle_configuration,
|
1041
|
-
-> { Orb::
|
1018
|
+
-> { Orb::PlanCreateParams::Price::Tiered::InvoicingCycleConfiguration },
|
1042
1019
|
nil?: true
|
1043
1020
|
|
1044
1021
|
# @!attribute metadata
|
@@ -1051,48 +1028,41 @@ module Orb
|
|
1051
1028
|
|
1052
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)
|
1053
1030
|
# Some parameter documentations has been truncated, see
|
1054
|
-
# {Orb::
|
1031
|
+
# {Orb::PlanCreateParams::Price::Tiered} for more details.
|
1055
1032
|
#
|
1056
|
-
# @param cadence [Symbol, Orb::
|
1033
|
+
# @param cadence [Symbol, Orb::PlanCreateParams::Price::Tiered::Cadence] The cadence to bill for this price on.
|
1057
1034
|
#
|
1058
1035
|
# @param item_id [String] The id of the item the price will be associated with.
|
1059
1036
|
#
|
1060
1037
|
# @param name [String] The name of the price.
|
1061
1038
|
#
|
1062
|
-
# @param tiered_config [Orb::
|
1039
|
+
# @param tiered_config [Orb::PlanCreateParams::Price::Tiered::TieredConfig]
|
1063
1040
|
#
|
1064
1041
|
# @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b
|
1065
|
-
# ...
|
1066
1042
|
#
|
1067
1043
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
1068
|
-
# ...
|
1069
1044
|
#
|
1070
|
-
# @param billing_cycle_configuration [Orb::
|
1071
|
-
# ...
|
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
|
1072
1046
|
#
|
1073
1047
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
1074
1048
|
#
|
1075
1049
|
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
1076
|
-
# ...
|
1077
1050
|
#
|
1078
1051
|
# @param external_price_id [String, nil] An alias for the price.
|
1079
1052
|
#
|
1080
1053
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
1081
|
-
# ...
|
1082
1054
|
#
|
1083
1055
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
1084
1056
|
#
|
1085
|
-
# @param invoicing_cycle_configuration [Orb::
|
1086
|
-
# ...
|
1057
|
+
# @param invoicing_cycle_configuration [Orb::PlanCreateParams::Price::Tiered::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
1087
1058
|
#
|
1088
1059
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
1089
|
-
# ...
|
1090
1060
|
#
|
1091
1061
|
# @param model_type [Symbol, :tiered]
|
1092
1062
|
|
1093
1063
|
# The cadence to bill for this price on.
|
1094
1064
|
#
|
1095
|
-
# @see Orb::
|
1065
|
+
# @see Orb::PlanCreateParams::Price::Tiered#cadence
|
1096
1066
|
module Cadence
|
1097
1067
|
extend Orb::Internal::Type::Enum
|
1098
1068
|
|
@@ -1107,17 +1077,19 @@ module Orb
|
|
1107
1077
|
# @return [Array<Symbol>]
|
1108
1078
|
end
|
1109
1079
|
|
1110
|
-
# @see Orb::
|
1080
|
+
# @see Orb::PlanCreateParams::Price::Tiered#tiered_config
|
1111
1081
|
class TieredConfig < Orb::Internal::Type::BaseModel
|
1112
1082
|
# @!attribute tiers
|
1113
1083
|
# Tiers for rating based on total usage quantities into the specified tier
|
1114
1084
|
#
|
1115
|
-
# @return [Array<Orb::
|
1085
|
+
# @return [Array<Orb::PlanCreateParams::Price::Tiered::TieredConfig::Tier>]
|
1116
1086
|
required :tiers,
|
1117
|
-
-> {
|
1087
|
+
-> {
|
1088
|
+
Orb::Internal::Type::ArrayOf[Orb::PlanCreateParams::Price::Tiered::TieredConfig::Tier]
|
1089
|
+
}
|
1118
1090
|
|
1119
1091
|
# @!method initialize(tiers:)
|
1120
|
-
# @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
|
1121
1093
|
|
1122
1094
|
class Tier < Orb::Internal::Type::BaseModel
|
1123
1095
|
# @!attribute first_unit
|
@@ -1147,7 +1119,7 @@ module Orb
|
|
1147
1119
|
end
|
1148
1120
|
end
|
1149
1121
|
|
1150
|
-
# @see Orb::
|
1122
|
+
# @see Orb::PlanCreateParams::Price::Tiered#billing_cycle_configuration
|
1151
1123
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
1152
1124
|
# @!attribute duration
|
1153
1125
|
# The duration of the billing period.
|
@@ -1158,9 +1130,11 @@ module Orb
|
|
1158
1130
|
# @!attribute duration_unit
|
1159
1131
|
# The unit of billing period duration.
|
1160
1132
|
#
|
1161
|
-
# @return [Symbol, Orb::
|
1133
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::Tiered::BillingCycleConfiguration::DurationUnit]
|
1162
1134
|
required :duration_unit,
|
1163
|
-
enum: -> {
|
1135
|
+
enum: -> {
|
1136
|
+
Orb::PlanCreateParams::Price::Tiered::BillingCycleConfiguration::DurationUnit
|
1137
|
+
}
|
1164
1138
|
|
1165
1139
|
# @!method initialize(duration:, duration_unit:)
|
1166
1140
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -1168,11 +1142,11 @@ module Orb
|
|
1168
1142
|
#
|
1169
1143
|
# @param duration [Integer] The duration of the billing period.
|
1170
1144
|
#
|
1171
|
-
# @param duration_unit [Symbol, Orb::
|
1145
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::Tiered::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
1172
1146
|
|
1173
1147
|
# The unit of billing period duration.
|
1174
1148
|
#
|
1175
|
-
# @see Orb::
|
1149
|
+
# @see Orb::PlanCreateParams::Price::Tiered::BillingCycleConfiguration#duration_unit
|
1176
1150
|
module DurationUnit
|
1177
1151
|
extend Orb::Internal::Type::Enum
|
1178
1152
|
|
@@ -1184,7 +1158,7 @@ module Orb
|
|
1184
1158
|
end
|
1185
1159
|
end
|
1186
1160
|
|
1187
|
-
# @see Orb::
|
1161
|
+
# @see Orb::PlanCreateParams::Price::Tiered#invoicing_cycle_configuration
|
1188
1162
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
1189
1163
|
# @!attribute duration
|
1190
1164
|
# The duration of the billing period.
|
@@ -1195,9 +1169,11 @@ module Orb
|
|
1195
1169
|
# @!attribute duration_unit
|
1196
1170
|
# The unit of billing period duration.
|
1197
1171
|
#
|
1198
|
-
# @return [Symbol, Orb::
|
1172
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::Tiered::InvoicingCycleConfiguration::DurationUnit]
|
1199
1173
|
required :duration_unit,
|
1200
|
-
enum: -> {
|
1174
|
+
enum: -> {
|
1175
|
+
Orb::PlanCreateParams::Price::Tiered::InvoicingCycleConfiguration::DurationUnit
|
1176
|
+
}
|
1201
1177
|
|
1202
1178
|
# @!method initialize(duration:, duration_unit:)
|
1203
1179
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
@@ -1205,11 +1181,11 @@ module Orb
|
|
1205
1181
|
#
|
1206
1182
|
# @param duration [Integer] The duration of the billing period.
|
1207
1183
|
#
|
1208
|
-
# @param duration_unit [Symbol, Orb::
|
1184
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::Tiered::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
1209
1185
|
|
1210
1186
|
# The unit of billing period duration.
|
1211
1187
|
#
|
1212
|
-
# @see Orb::
|
1188
|
+
# @see Orb::PlanCreateParams::Price::Tiered::InvoicingCycleConfiguration#duration_unit
|
1213
1189
|
module DurationUnit
|
1214
1190
|
extend Orb::Internal::Type::Enum
|
1215
1191
|
|
@@ -1222,12 +1198,12 @@ module Orb
|
|
1222
1198
|
end
|
1223
1199
|
end
|
1224
1200
|
|
1225
|
-
class
|
1201
|
+
class TieredBps < Orb::Internal::Type::BaseModel
|
1226
1202
|
# @!attribute cadence
|
1227
1203
|
# The cadence to bill for this price on.
|
1228
1204
|
#
|
1229
|
-
# @return [Symbol, Orb::
|
1230
|
-
required :cadence, enum: -> { Orb::
|
1205
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::TieredBps::Cadence]
|
1206
|
+
required :cadence, enum: -> { Orb::PlanCreateParams::Price::TieredBps::Cadence }
|
1231
1207
|
|
1232
1208
|
# @!attribute item_id
|
1233
1209
|
# The id of the item the price will be associated with.
|
@@ -1248,9 +1224,8 @@ module Orb
|
|
1248
1224
|
|
1249
1225
|
# @!attribute tiered_bps_config
|
1250
1226
|
#
|
1251
|
-
# @return [Orb::
|
1252
|
-
required :tiered_bps_config,
|
1253
|
-
-> { Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice::TieredBpsConfig }
|
1227
|
+
# @return [Orb::PlanCreateParams::Price::TieredBps::TieredBpsConfig]
|
1228
|
+
required :tiered_bps_config, -> { Orb::PlanCreateParams::Price::TieredBps::TieredBpsConfig }
|
1254
1229
|
|
1255
1230
|
# @!attribute billable_metric_id
|
1256
1231
|
# The id of the billable metric for the price. Only needed if the price is
|
@@ -1270,9 +1245,9 @@ module Orb
|
|
1270
1245
|
# For custom cadence: specifies the duration of the billing period in days or
|
1271
1246
|
# months.
|
1272
1247
|
#
|
1273
|
-
# @return [Orb::
|
1248
|
+
# @return [Orb::PlanCreateParams::Price::TieredBps::BillingCycleConfiguration, nil]
|
1274
1249
|
optional :billing_cycle_configuration,
|
1275
|
-
-> { Orb::
|
1250
|
+
-> { Orb::PlanCreateParams::Price::TieredBps::BillingCycleConfiguration },
|
1276
1251
|
nil?: true
|
1277
1252
|
|
1278
1253
|
# @!attribute conversion_rate
|
@@ -1311,9 +1286,9 @@ module Orb
|
|
1311
1286
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
1312
1287
|
# If unspecified, a single invoice is produced per billing cycle.
|
1313
1288
|
#
|
1314
|
-
# @return [Orb::
|
1289
|
+
# @return [Orb::PlanCreateParams::Price::TieredBps::InvoicingCycleConfiguration, nil]
|
1315
1290
|
optional :invoicing_cycle_configuration,
|
1316
|
-
-> { Orb::
|
1291
|
+
-> { Orb::PlanCreateParams::Price::TieredBps::InvoicingCycleConfiguration },
|
1317
1292
|
nil?: true
|
1318
1293
|
|
1319
1294
|
# @!attribute metadata
|
@@ -1326,48 +1301,41 @@ module Orb
|
|
1326
1301
|
|
1327
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)
|
1328
1303
|
# Some parameter documentations has been truncated, see
|
1329
|
-
# {Orb::
|
1304
|
+
# {Orb::PlanCreateParams::Price::TieredBps} for more details.
|
1330
1305
|
#
|
1331
|
-
# @param cadence [Symbol, Orb::
|
1306
|
+
# @param cadence [Symbol, Orb::PlanCreateParams::Price::TieredBps::Cadence] The cadence to bill for this price on.
|
1332
1307
|
#
|
1333
1308
|
# @param item_id [String] The id of the item the price will be associated with.
|
1334
1309
|
#
|
1335
1310
|
# @param name [String] The name of the price.
|
1336
1311
|
#
|
1337
|
-
# @param tiered_bps_config [Orb::
|
1312
|
+
# @param tiered_bps_config [Orb::PlanCreateParams::Price::TieredBps::TieredBpsConfig]
|
1338
1313
|
#
|
1339
1314
|
# @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b
|
1340
|
-
# ...
|
1341
1315
|
#
|
1342
1316
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
1343
|
-
# ...
|
1344
1317
|
#
|
1345
|
-
# @param billing_cycle_configuration [Orb::
|
1346
|
-
# ...
|
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
|
1347
1319
|
#
|
1348
1320
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
1349
1321
|
#
|
1350
1322
|
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
1351
|
-
# ...
|
1352
1323
|
#
|
1353
1324
|
# @param external_price_id [String, nil] An alias for the price.
|
1354
1325
|
#
|
1355
1326
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
1356
|
-
# ...
|
1357
1327
|
#
|
1358
1328
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
1359
1329
|
#
|
1360
|
-
# @param invoicing_cycle_configuration [Orb::
|
1361
|
-
# ...
|
1330
|
+
# @param invoicing_cycle_configuration [Orb::PlanCreateParams::Price::TieredBps::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
1362
1331
|
#
|
1363
1332
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
1364
|
-
# ...
|
1365
1333
|
#
|
1366
1334
|
# @param model_type [Symbol, :tiered_bps]
|
1367
1335
|
|
1368
1336
|
# The cadence to bill for this price on.
|
1369
1337
|
#
|
1370
|
-
# @see Orb::
|
1338
|
+
# @see Orb::PlanCreateParams::Price::TieredBps#cadence
|
1371
1339
|
module Cadence
|
1372
1340
|
extend Orb::Internal::Type::Enum
|
1373
1341
|
|
@@ -1382,23 +1350,23 @@ module Orb
|
|
1382
1350
|
# @return [Array<Symbol>]
|
1383
1351
|
end
|
1384
1352
|
|
1385
|
-
# @see Orb::
|
1353
|
+
# @see Orb::PlanCreateParams::Price::TieredBps#tiered_bps_config
|
1386
1354
|
class TieredBpsConfig < Orb::Internal::Type::BaseModel
|
1387
1355
|
# @!attribute tiers
|
1388
1356
|
# Tiers for a Graduated BPS pricing model, where usage is bucketed into specified
|
1389
1357
|
# tiers
|
1390
1358
|
#
|
1391
|
-
# @return [Array<Orb::
|
1359
|
+
# @return [Array<Orb::PlanCreateParams::Price::TieredBps::TieredBpsConfig::Tier>]
|
1392
1360
|
required :tiers,
|
1393
|
-
-> {
|
1361
|
+
-> {
|
1362
|
+
Orb::Internal::Type::ArrayOf[Orb::PlanCreateParams::Price::TieredBps::TieredBpsConfig::Tier]
|
1363
|
+
}
|
1394
1364
|
|
1395
1365
|
# @!method initialize(tiers:)
|
1396
1366
|
# Some parameter documentations has been truncated, see
|
1397
|
-
# {Orb::
|
1398
|
-
# for more details.
|
1367
|
+
# {Orb::PlanCreateParams::Price::TieredBps::TieredBpsConfig} for more details.
|
1399
1368
|
#
|
1400
|
-
# @param tiers [Array<Orb::
|
1401
|
-
# ...
|
1369
|
+
# @param tiers [Array<Orb::PlanCreateParams::Price::TieredBps::TieredBpsConfig::Tier>] Tiers for a Graduated BPS pricing model, where usage is bucketed into specified
|
1402
1370
|
|
1403
1371
|
class Tier < Orb::Internal::Type::BaseModel
|
1404
1372
|
# @!attribute bps
|
@@ -1436,7 +1404,7 @@ module Orb
|
|
1436
1404
|
end
|
1437
1405
|
end
|
1438
1406
|
|
1439
|
-
# @see Orb::
|
1407
|
+
# @see Orb::PlanCreateParams::Price::TieredBps#billing_cycle_configuration
|
1440
1408
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
1441
1409
|
# @!attribute duration
|
1442
1410
|
# The duration of the billing period.
|
@@ -1447,9 +1415,11 @@ module Orb
|
|
1447
1415
|
# @!attribute duration_unit
|
1448
1416
|
# The unit of billing period duration.
|
1449
1417
|
#
|
1450
|
-
# @return [Symbol, Orb::
|
1418
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::TieredBps::BillingCycleConfiguration::DurationUnit]
|
1451
1419
|
required :duration_unit,
|
1452
|
-
enum: -> {
|
1420
|
+
enum: -> {
|
1421
|
+
Orb::PlanCreateParams::Price::TieredBps::BillingCycleConfiguration::DurationUnit
|
1422
|
+
}
|
1453
1423
|
|
1454
1424
|
# @!method initialize(duration:, duration_unit:)
|
1455
1425
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -1457,11 +1427,11 @@ module Orb
|
|
1457
1427
|
#
|
1458
1428
|
# @param duration [Integer] The duration of the billing period.
|
1459
1429
|
#
|
1460
|
-
# @param duration_unit [Symbol, Orb::
|
1430
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::TieredBps::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
1461
1431
|
|
1462
1432
|
# The unit of billing period duration.
|
1463
1433
|
#
|
1464
|
-
# @see Orb::
|
1434
|
+
# @see Orb::PlanCreateParams::Price::TieredBps::BillingCycleConfiguration#duration_unit
|
1465
1435
|
module DurationUnit
|
1466
1436
|
extend Orb::Internal::Type::Enum
|
1467
1437
|
|
@@ -1473,7 +1443,7 @@ module Orb
|
|
1473
1443
|
end
|
1474
1444
|
end
|
1475
1445
|
|
1476
|
-
# @see Orb::
|
1446
|
+
# @see Orb::PlanCreateParams::Price::TieredBps#invoicing_cycle_configuration
|
1477
1447
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
1478
1448
|
# @!attribute duration
|
1479
1449
|
# The duration of the billing period.
|
@@ -1484,9 +1454,11 @@ module Orb
|
|
1484
1454
|
# @!attribute duration_unit
|
1485
1455
|
# The unit of billing period duration.
|
1486
1456
|
#
|
1487
|
-
# @return [Symbol, Orb::
|
1457
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::TieredBps::InvoicingCycleConfiguration::DurationUnit]
|
1488
1458
|
required :duration_unit,
|
1489
|
-
enum: -> {
|
1459
|
+
enum: -> {
|
1460
|
+
Orb::PlanCreateParams::Price::TieredBps::InvoicingCycleConfiguration::DurationUnit
|
1461
|
+
}
|
1490
1462
|
|
1491
1463
|
# @!method initialize(duration:, duration_unit:)
|
1492
1464
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
@@ -1494,11 +1466,11 @@ module Orb
|
|
1494
1466
|
#
|
1495
1467
|
# @param duration [Integer] The duration of the billing period.
|
1496
1468
|
#
|
1497
|
-
# @param duration_unit [Symbol, Orb::
|
1469
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::TieredBps::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
1498
1470
|
|
1499
1471
|
# The unit of billing period duration.
|
1500
1472
|
#
|
1501
|
-
# @see Orb::
|
1473
|
+
# @see Orb::PlanCreateParams::Price::TieredBps::InvoicingCycleConfiguration#duration_unit
|
1502
1474
|
module DurationUnit
|
1503
1475
|
extend Orb::Internal::Type::Enum
|
1504
1476
|
|
@@ -1511,17 +1483,17 @@ module Orb
|
|
1511
1483
|
end
|
1512
1484
|
end
|
1513
1485
|
|
1514
|
-
class
|
1486
|
+
class Bps < Orb::Internal::Type::BaseModel
|
1515
1487
|
# @!attribute bps_config
|
1516
1488
|
#
|
1517
|
-
# @return [Orb::
|
1518
|
-
required :bps_config, -> { Orb::
|
1489
|
+
# @return [Orb::PlanCreateParams::Price::Bps::BpsConfig]
|
1490
|
+
required :bps_config, -> { Orb::PlanCreateParams::Price::Bps::BpsConfig }
|
1519
1491
|
|
1520
1492
|
# @!attribute cadence
|
1521
1493
|
# The cadence to bill for this price on.
|
1522
1494
|
#
|
1523
|
-
# @return [Symbol, Orb::
|
1524
|
-
required :cadence, enum: -> { Orb::
|
1495
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::Bps::Cadence]
|
1496
|
+
required :cadence, enum: -> { Orb::PlanCreateParams::Price::Bps::Cadence }
|
1525
1497
|
|
1526
1498
|
# @!attribute item_id
|
1527
1499
|
# The id of the item the price will be associated with.
|
@@ -1558,9 +1530,9 @@ module Orb
|
|
1558
1530
|
# For custom cadence: specifies the duration of the billing period in days or
|
1559
1531
|
# months.
|
1560
1532
|
#
|
1561
|
-
# @return [Orb::
|
1533
|
+
# @return [Orb::PlanCreateParams::Price::Bps::BillingCycleConfiguration, nil]
|
1562
1534
|
optional :billing_cycle_configuration,
|
1563
|
-
-> { Orb::
|
1535
|
+
-> { Orb::PlanCreateParams::Price::Bps::BillingCycleConfiguration },
|
1564
1536
|
nil?: true
|
1565
1537
|
|
1566
1538
|
# @!attribute conversion_rate
|
@@ -1599,9 +1571,9 @@ module Orb
|
|
1599
1571
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
1600
1572
|
# If unspecified, a single invoice is produced per billing cycle.
|
1601
1573
|
#
|
1602
|
-
# @return [Orb::
|
1574
|
+
# @return [Orb::PlanCreateParams::Price::Bps::InvoicingCycleConfiguration, nil]
|
1603
1575
|
optional :invoicing_cycle_configuration,
|
1604
|
-
-> { Orb::
|
1576
|
+
-> { Orb::PlanCreateParams::Price::Bps::InvoicingCycleConfiguration },
|
1605
1577
|
nil?: true
|
1606
1578
|
|
1607
1579
|
# @!attribute metadata
|
@@ -1614,46 +1586,39 @@ module Orb
|
|
1614
1586
|
|
1615
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)
|
1616
1588
|
# Some parameter documentations has been truncated, see
|
1617
|
-
# {Orb::
|
1589
|
+
# {Orb::PlanCreateParams::Price::Bps} for more details.
|
1618
1590
|
#
|
1619
|
-
# @param bps_config [Orb::
|
1591
|
+
# @param bps_config [Orb::PlanCreateParams::Price::Bps::BpsConfig]
|
1620
1592
|
#
|
1621
|
-
# @param cadence [Symbol, Orb::
|
1593
|
+
# @param cadence [Symbol, Orb::PlanCreateParams::Price::Bps::Cadence] The cadence to bill for this price on.
|
1622
1594
|
#
|
1623
1595
|
# @param item_id [String] The id of the item the price will be associated with.
|
1624
1596
|
#
|
1625
1597
|
# @param name [String] The name of the price.
|
1626
1598
|
#
|
1627
1599
|
# @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b
|
1628
|
-
# ...
|
1629
1600
|
#
|
1630
1601
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
1631
|
-
# ...
|
1632
1602
|
#
|
1633
|
-
# @param billing_cycle_configuration [Orb::
|
1634
|
-
# ...
|
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
|
1635
1604
|
#
|
1636
1605
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
1637
1606
|
#
|
1638
1607
|
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
1639
|
-
# ...
|
1640
1608
|
#
|
1641
1609
|
# @param external_price_id [String, nil] An alias for the price.
|
1642
1610
|
#
|
1643
1611
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
1644
|
-
# ...
|
1645
1612
|
#
|
1646
1613
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
1647
1614
|
#
|
1648
|
-
# @param invoicing_cycle_configuration [Orb::
|
1649
|
-
# ...
|
1615
|
+
# @param invoicing_cycle_configuration [Orb::PlanCreateParams::Price::Bps::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
1650
1616
|
#
|
1651
1617
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
1652
|
-
# ...
|
1653
1618
|
#
|
1654
1619
|
# @param model_type [Symbol, :bps]
|
1655
1620
|
|
1656
|
-
# @see Orb::
|
1621
|
+
# @see Orb::PlanCreateParams::Price::Bps#bps_config
|
1657
1622
|
class BpsConfig < Orb::Internal::Type::BaseModel
|
1658
1623
|
# @!attribute bps
|
1659
1624
|
# Basis point take rate per event
|
@@ -1675,7 +1640,7 @@ module Orb
|
|
1675
1640
|
|
1676
1641
|
# The cadence to bill for this price on.
|
1677
1642
|
#
|
1678
|
-
# @see Orb::
|
1643
|
+
# @see Orb::PlanCreateParams::Price::Bps#cadence
|
1679
1644
|
module Cadence
|
1680
1645
|
extend Orb::Internal::Type::Enum
|
1681
1646
|
|
@@ -1690,7 +1655,7 @@ module Orb
|
|
1690
1655
|
# @return [Array<Symbol>]
|
1691
1656
|
end
|
1692
1657
|
|
1693
|
-
# @see Orb::
|
1658
|
+
# @see Orb::PlanCreateParams::Price::Bps#billing_cycle_configuration
|
1694
1659
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
1695
1660
|
# @!attribute duration
|
1696
1661
|
# The duration of the billing period.
|
@@ -1701,9 +1666,9 @@ module Orb
|
|
1701
1666
|
# @!attribute duration_unit
|
1702
1667
|
# The unit of billing period duration.
|
1703
1668
|
#
|
1704
|
-
# @return [Symbol, Orb::
|
1669
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::Bps::BillingCycleConfiguration::DurationUnit]
|
1705
1670
|
required :duration_unit,
|
1706
|
-
enum: -> { Orb::
|
1671
|
+
enum: -> { Orb::PlanCreateParams::Price::Bps::BillingCycleConfiguration::DurationUnit }
|
1707
1672
|
|
1708
1673
|
# @!method initialize(duration:, duration_unit:)
|
1709
1674
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -1711,11 +1676,11 @@ module Orb
|
|
1711
1676
|
#
|
1712
1677
|
# @param duration [Integer] The duration of the billing period.
|
1713
1678
|
#
|
1714
|
-
# @param duration_unit [Symbol, Orb::
|
1679
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::Bps::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
1715
1680
|
|
1716
1681
|
# The unit of billing period duration.
|
1717
1682
|
#
|
1718
|
-
# @see Orb::
|
1683
|
+
# @see Orb::PlanCreateParams::Price::Bps::BillingCycleConfiguration#duration_unit
|
1719
1684
|
module DurationUnit
|
1720
1685
|
extend Orb::Internal::Type::Enum
|
1721
1686
|
|
@@ -1727,7 +1692,7 @@ module Orb
|
|
1727
1692
|
end
|
1728
1693
|
end
|
1729
1694
|
|
1730
|
-
# @see Orb::
|
1695
|
+
# @see Orb::PlanCreateParams::Price::Bps#invoicing_cycle_configuration
|
1731
1696
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
1732
1697
|
# @!attribute duration
|
1733
1698
|
# The duration of the billing period.
|
@@ -1738,9 +1703,9 @@ module Orb
|
|
1738
1703
|
# @!attribute duration_unit
|
1739
1704
|
# The unit of billing period duration.
|
1740
1705
|
#
|
1741
|
-
# @return [Symbol, Orb::
|
1706
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::Bps::InvoicingCycleConfiguration::DurationUnit]
|
1742
1707
|
required :duration_unit,
|
1743
|
-
enum: -> { Orb::
|
1708
|
+
enum: -> { Orb::PlanCreateParams::Price::Bps::InvoicingCycleConfiguration::DurationUnit }
|
1744
1709
|
|
1745
1710
|
# @!method initialize(duration:, duration_unit:)
|
1746
1711
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
@@ -1748,11 +1713,11 @@ module Orb
|
|
1748
1713
|
#
|
1749
1714
|
# @param duration [Integer] The duration of the billing period.
|
1750
1715
|
#
|
1751
|
-
# @param duration_unit [Symbol, Orb::
|
1716
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::Bps::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
1752
1717
|
|
1753
1718
|
# The unit of billing period duration.
|
1754
1719
|
#
|
1755
|
-
# @see Orb::
|
1720
|
+
# @see Orb::PlanCreateParams::Price::Bps::InvoicingCycleConfiguration#duration_unit
|
1756
1721
|
module DurationUnit
|
1757
1722
|
extend Orb::Internal::Type::Enum
|
1758
1723
|
|
@@ -1765,17 +1730,17 @@ module Orb
|
|
1765
1730
|
end
|
1766
1731
|
end
|
1767
1732
|
|
1768
|
-
class
|
1733
|
+
class BulkBps < Orb::Internal::Type::BaseModel
|
1769
1734
|
# @!attribute bulk_bps_config
|
1770
1735
|
#
|
1771
|
-
# @return [Orb::
|
1772
|
-
required :bulk_bps_config, -> { Orb::
|
1736
|
+
# @return [Orb::PlanCreateParams::Price::BulkBps::BulkBpsConfig]
|
1737
|
+
required :bulk_bps_config, -> { Orb::PlanCreateParams::Price::BulkBps::BulkBpsConfig }
|
1773
1738
|
|
1774
1739
|
# @!attribute cadence
|
1775
1740
|
# The cadence to bill for this price on.
|
1776
1741
|
#
|
1777
|
-
# @return [Symbol, Orb::
|
1778
|
-
required :cadence, enum: -> { Orb::
|
1742
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::BulkBps::Cadence]
|
1743
|
+
required :cadence, enum: -> { Orb::PlanCreateParams::Price::BulkBps::Cadence }
|
1779
1744
|
|
1780
1745
|
# @!attribute item_id
|
1781
1746
|
# The id of the item the price will be associated with.
|
@@ -1812,9 +1777,9 @@ module Orb
|
|
1812
1777
|
# For custom cadence: specifies the duration of the billing period in days or
|
1813
1778
|
# months.
|
1814
1779
|
#
|
1815
|
-
# @return [Orb::
|
1780
|
+
# @return [Orb::PlanCreateParams::Price::BulkBps::BillingCycleConfiguration, nil]
|
1816
1781
|
optional :billing_cycle_configuration,
|
1817
|
-
-> { Orb::
|
1782
|
+
-> { Orb::PlanCreateParams::Price::BulkBps::BillingCycleConfiguration },
|
1818
1783
|
nil?: true
|
1819
1784
|
|
1820
1785
|
# @!attribute conversion_rate
|
@@ -1853,9 +1818,9 @@ module Orb
|
|
1853
1818
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
1854
1819
|
# If unspecified, a single invoice is produced per billing cycle.
|
1855
1820
|
#
|
1856
|
-
# @return [Orb::
|
1821
|
+
# @return [Orb::PlanCreateParams::Price::BulkBps::InvoicingCycleConfiguration, nil]
|
1857
1822
|
optional :invoicing_cycle_configuration,
|
1858
|
-
-> { Orb::
|
1823
|
+
-> { Orb::PlanCreateParams::Price::BulkBps::InvoicingCycleConfiguration },
|
1859
1824
|
nil?: true
|
1860
1825
|
|
1861
1826
|
# @!attribute metadata
|
@@ -1868,62 +1833,55 @@ module Orb
|
|
1868
1833
|
|
1869
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)
|
1870
1835
|
# Some parameter documentations has been truncated, see
|
1871
|
-
# {Orb::
|
1836
|
+
# {Orb::PlanCreateParams::Price::BulkBps} for more details.
|
1872
1837
|
#
|
1873
|
-
# @param bulk_bps_config [Orb::
|
1838
|
+
# @param bulk_bps_config [Orb::PlanCreateParams::Price::BulkBps::BulkBpsConfig]
|
1874
1839
|
#
|
1875
|
-
# @param cadence [Symbol, Orb::
|
1840
|
+
# @param cadence [Symbol, Orb::PlanCreateParams::Price::BulkBps::Cadence] The cadence to bill for this price on.
|
1876
1841
|
#
|
1877
1842
|
# @param item_id [String] The id of the item the price will be associated with.
|
1878
1843
|
#
|
1879
1844
|
# @param name [String] The name of the price.
|
1880
1845
|
#
|
1881
1846
|
# @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b
|
1882
|
-
# ...
|
1883
1847
|
#
|
1884
1848
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
1885
|
-
# ...
|
1886
1849
|
#
|
1887
|
-
# @param billing_cycle_configuration [Orb::
|
1888
|
-
# ...
|
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
|
1889
1851
|
#
|
1890
1852
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
1891
1853
|
#
|
1892
1854
|
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
1893
|
-
# ...
|
1894
1855
|
#
|
1895
1856
|
# @param external_price_id [String, nil] An alias for the price.
|
1896
1857
|
#
|
1897
1858
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
1898
|
-
# ...
|
1899
1859
|
#
|
1900
1860
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
1901
1861
|
#
|
1902
|
-
# @param invoicing_cycle_configuration [Orb::
|
1903
|
-
# ...
|
1862
|
+
# @param invoicing_cycle_configuration [Orb::PlanCreateParams::Price::BulkBps::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
1904
1863
|
#
|
1905
1864
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
1906
|
-
# ...
|
1907
1865
|
#
|
1908
1866
|
# @param model_type [Symbol, :bulk_bps]
|
1909
1867
|
|
1910
|
-
# @see Orb::
|
1868
|
+
# @see Orb::PlanCreateParams::Price::BulkBps#bulk_bps_config
|
1911
1869
|
class BulkBpsConfig < Orb::Internal::Type::BaseModel
|
1912
1870
|
# @!attribute tiers
|
1913
1871
|
# Tiers for a bulk BPS pricing model where all usage is aggregated to a single
|
1914
1872
|
# tier based on total volume
|
1915
1873
|
#
|
1916
|
-
# @return [Array<Orb::
|
1874
|
+
# @return [Array<Orb::PlanCreateParams::Price::BulkBps::BulkBpsConfig::Tier>]
|
1917
1875
|
required :tiers,
|
1918
|
-
-> {
|
1876
|
+
-> {
|
1877
|
+
Orb::Internal::Type::ArrayOf[Orb::PlanCreateParams::Price::BulkBps::BulkBpsConfig::Tier]
|
1878
|
+
}
|
1919
1879
|
|
1920
1880
|
# @!method initialize(tiers:)
|
1921
1881
|
# Some parameter documentations has been truncated, see
|
1922
|
-
# {Orb::
|
1923
|
-
# more details.
|
1882
|
+
# {Orb::PlanCreateParams::Price::BulkBps::BulkBpsConfig} for more details.
|
1924
1883
|
#
|
1925
|
-
# @param tiers [Array<Orb::
|
1926
|
-
# ...
|
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
|
1927
1885
|
|
1928
1886
|
class Tier < Orb::Internal::Type::BaseModel
|
1929
1887
|
# @!attribute bps
|
@@ -1955,7 +1913,7 @@ module Orb
|
|
1955
1913
|
|
1956
1914
|
# The cadence to bill for this price on.
|
1957
1915
|
#
|
1958
|
-
# @see Orb::
|
1916
|
+
# @see Orb::PlanCreateParams::Price::BulkBps#cadence
|
1959
1917
|
module Cadence
|
1960
1918
|
extend Orb::Internal::Type::Enum
|
1961
1919
|
|
@@ -1970,7 +1928,7 @@ module Orb
|
|
1970
1928
|
# @return [Array<Symbol>]
|
1971
1929
|
end
|
1972
1930
|
|
1973
|
-
# @see Orb::
|
1931
|
+
# @see Orb::PlanCreateParams::Price::BulkBps#billing_cycle_configuration
|
1974
1932
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
1975
1933
|
# @!attribute duration
|
1976
1934
|
# The duration of the billing period.
|
@@ -1981,9 +1939,11 @@ module Orb
|
|
1981
1939
|
# @!attribute duration_unit
|
1982
1940
|
# The unit of billing period duration.
|
1983
1941
|
#
|
1984
|
-
# @return [Symbol, Orb::
|
1942
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::BulkBps::BillingCycleConfiguration::DurationUnit]
|
1985
1943
|
required :duration_unit,
|
1986
|
-
enum: -> {
|
1944
|
+
enum: -> {
|
1945
|
+
Orb::PlanCreateParams::Price::BulkBps::BillingCycleConfiguration::DurationUnit
|
1946
|
+
}
|
1987
1947
|
|
1988
1948
|
# @!method initialize(duration:, duration_unit:)
|
1989
1949
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -1991,11 +1951,11 @@ module Orb
|
|
1991
1951
|
#
|
1992
1952
|
# @param duration [Integer] The duration of the billing period.
|
1993
1953
|
#
|
1994
|
-
# @param duration_unit [Symbol, Orb::
|
1954
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::BulkBps::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
1995
1955
|
|
1996
1956
|
# The unit of billing period duration.
|
1997
1957
|
#
|
1998
|
-
# @see Orb::
|
1958
|
+
# @see Orb::PlanCreateParams::Price::BulkBps::BillingCycleConfiguration#duration_unit
|
1999
1959
|
module DurationUnit
|
2000
1960
|
extend Orb::Internal::Type::Enum
|
2001
1961
|
|
@@ -2007,7 +1967,7 @@ module Orb
|
|
2007
1967
|
end
|
2008
1968
|
end
|
2009
1969
|
|
2010
|
-
# @see Orb::
|
1970
|
+
# @see Orb::PlanCreateParams::Price::BulkBps#invoicing_cycle_configuration
|
2011
1971
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
2012
1972
|
# @!attribute duration
|
2013
1973
|
# The duration of the billing period.
|
@@ -2018,9 +1978,11 @@ module Orb
|
|
2018
1978
|
# @!attribute duration_unit
|
2019
1979
|
# The unit of billing period duration.
|
2020
1980
|
#
|
2021
|
-
# @return [Symbol, Orb::
|
1981
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::BulkBps::InvoicingCycleConfiguration::DurationUnit]
|
2022
1982
|
required :duration_unit,
|
2023
|
-
enum: -> {
|
1983
|
+
enum: -> {
|
1984
|
+
Orb::PlanCreateParams::Price::BulkBps::InvoicingCycleConfiguration::DurationUnit
|
1985
|
+
}
|
2024
1986
|
|
2025
1987
|
# @!method initialize(duration:, duration_unit:)
|
2026
1988
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
@@ -2028,11 +1990,11 @@ module Orb
|
|
2028
1990
|
#
|
2029
1991
|
# @param duration [Integer] The duration of the billing period.
|
2030
1992
|
#
|
2031
|
-
# @param duration_unit [Symbol, Orb::
|
1993
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::BulkBps::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
2032
1994
|
|
2033
1995
|
# The unit of billing period duration.
|
2034
1996
|
#
|
2035
|
-
# @see Orb::
|
1997
|
+
# @see Orb::PlanCreateParams::Price::BulkBps::InvoicingCycleConfiguration#duration_unit
|
2036
1998
|
module DurationUnit
|
2037
1999
|
extend Orb::Internal::Type::Enum
|
2038
2000
|
|
@@ -2045,17 +2007,17 @@ module Orb
|
|
2045
2007
|
end
|
2046
2008
|
end
|
2047
2009
|
|
2048
|
-
class
|
2010
|
+
class Bulk < Orb::Internal::Type::BaseModel
|
2049
2011
|
# @!attribute bulk_config
|
2050
2012
|
#
|
2051
|
-
# @return [Orb::
|
2052
|
-
required :bulk_config, -> { Orb::
|
2013
|
+
# @return [Orb::PlanCreateParams::Price::Bulk::BulkConfig]
|
2014
|
+
required :bulk_config, -> { Orb::PlanCreateParams::Price::Bulk::BulkConfig }
|
2053
2015
|
|
2054
2016
|
# @!attribute cadence
|
2055
2017
|
# The cadence to bill for this price on.
|
2056
2018
|
#
|
2057
|
-
# @return [Symbol, Orb::
|
2058
|
-
required :cadence, enum: -> { Orb::
|
2019
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::Bulk::Cadence]
|
2020
|
+
required :cadence, enum: -> { Orb::PlanCreateParams::Price::Bulk::Cadence }
|
2059
2021
|
|
2060
2022
|
# @!attribute item_id
|
2061
2023
|
# The id of the item the price will be associated with.
|
@@ -2092,9 +2054,9 @@ module Orb
|
|
2092
2054
|
# For custom cadence: specifies the duration of the billing period in days or
|
2093
2055
|
# months.
|
2094
2056
|
#
|
2095
|
-
# @return [Orb::
|
2057
|
+
# @return [Orb::PlanCreateParams::Price::Bulk::BillingCycleConfiguration, nil]
|
2096
2058
|
optional :billing_cycle_configuration,
|
2097
|
-
-> { Orb::
|
2059
|
+
-> { Orb::PlanCreateParams::Price::Bulk::BillingCycleConfiguration },
|
2098
2060
|
nil?: true
|
2099
2061
|
|
2100
2062
|
# @!attribute conversion_rate
|
@@ -2133,9 +2095,9 @@ module Orb
|
|
2133
2095
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
2134
2096
|
# If unspecified, a single invoice is produced per billing cycle.
|
2135
2097
|
#
|
2136
|
-
# @return [Orb::
|
2098
|
+
# @return [Orb::PlanCreateParams::Price::Bulk::InvoicingCycleConfiguration, nil]
|
2137
2099
|
optional :invoicing_cycle_configuration,
|
2138
|
-
-> { Orb::
|
2100
|
+
-> { Orb::PlanCreateParams::Price::Bulk::InvoicingCycleConfiguration },
|
2139
2101
|
nil?: true
|
2140
2102
|
|
2141
2103
|
# @!attribute metadata
|
@@ -2148,56 +2110,51 @@ module Orb
|
|
2148
2110
|
|
2149
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)
|
2150
2112
|
# Some parameter documentations has been truncated, see
|
2151
|
-
# {Orb::
|
2113
|
+
# {Orb::PlanCreateParams::Price::Bulk} for more details.
|
2152
2114
|
#
|
2153
|
-
# @param bulk_config [Orb::
|
2115
|
+
# @param bulk_config [Orb::PlanCreateParams::Price::Bulk::BulkConfig]
|
2154
2116
|
#
|
2155
|
-
# @param cadence [Symbol, Orb::
|
2117
|
+
# @param cadence [Symbol, Orb::PlanCreateParams::Price::Bulk::Cadence] The cadence to bill for this price on.
|
2156
2118
|
#
|
2157
2119
|
# @param item_id [String] The id of the item the price will be associated with.
|
2158
2120
|
#
|
2159
2121
|
# @param name [String] The name of the price.
|
2160
2122
|
#
|
2161
2123
|
# @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b
|
2162
|
-
# ...
|
2163
2124
|
#
|
2164
2125
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
2165
|
-
# ...
|
2166
2126
|
#
|
2167
|
-
# @param billing_cycle_configuration [Orb::
|
2168
|
-
# ...
|
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
|
2169
2128
|
#
|
2170
2129
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
2171
2130
|
#
|
2172
2131
|
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
2173
|
-
# ...
|
2174
2132
|
#
|
2175
2133
|
# @param external_price_id [String, nil] An alias for the price.
|
2176
2134
|
#
|
2177
2135
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
2178
|
-
# ...
|
2179
2136
|
#
|
2180
2137
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
2181
2138
|
#
|
2182
|
-
# @param invoicing_cycle_configuration [Orb::
|
2183
|
-
# ...
|
2139
|
+
# @param invoicing_cycle_configuration [Orb::PlanCreateParams::Price::Bulk::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
2184
2140
|
#
|
2185
2141
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
2186
|
-
# ...
|
2187
2142
|
#
|
2188
2143
|
# @param model_type [Symbol, :bulk]
|
2189
2144
|
|
2190
|
-
# @see Orb::
|
2145
|
+
# @see Orb::PlanCreateParams::Price::Bulk#bulk_config
|
2191
2146
|
class BulkConfig < Orb::Internal::Type::BaseModel
|
2192
2147
|
# @!attribute tiers
|
2193
2148
|
# Bulk tiers for rating based on total usage volume
|
2194
2149
|
#
|
2195
|
-
# @return [Array<Orb::
|
2150
|
+
# @return [Array<Orb::PlanCreateParams::Price::Bulk::BulkConfig::Tier>]
|
2196
2151
|
required :tiers,
|
2197
|
-
-> {
|
2152
|
+
-> {
|
2153
|
+
Orb::Internal::Type::ArrayOf[Orb::PlanCreateParams::Price::Bulk::BulkConfig::Tier]
|
2154
|
+
}
|
2198
2155
|
|
2199
2156
|
# @!method initialize(tiers:)
|
2200
|
-
# @param tiers [Array<Orb::
|
2157
|
+
# @param tiers [Array<Orb::PlanCreateParams::Price::Bulk::BulkConfig::Tier>] Bulk tiers for rating based on total usage volume
|
2201
2158
|
|
2202
2159
|
class Tier < Orb::Internal::Type::BaseModel
|
2203
2160
|
# @!attribute unit_amount
|
@@ -2221,7 +2178,7 @@ module Orb
|
|
2221
2178
|
|
2222
2179
|
# The cadence to bill for this price on.
|
2223
2180
|
#
|
2224
|
-
# @see Orb::
|
2181
|
+
# @see Orb::PlanCreateParams::Price::Bulk#cadence
|
2225
2182
|
module Cadence
|
2226
2183
|
extend Orb::Internal::Type::Enum
|
2227
2184
|
|
@@ -2236,7 +2193,7 @@ module Orb
|
|
2236
2193
|
# @return [Array<Symbol>]
|
2237
2194
|
end
|
2238
2195
|
|
2239
|
-
# @see Orb::
|
2196
|
+
# @see Orb::PlanCreateParams::Price::Bulk#billing_cycle_configuration
|
2240
2197
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
2241
2198
|
# @!attribute duration
|
2242
2199
|
# The duration of the billing period.
|
@@ -2247,9 +2204,9 @@ module Orb
|
|
2247
2204
|
# @!attribute duration_unit
|
2248
2205
|
# The unit of billing period duration.
|
2249
2206
|
#
|
2250
|
-
# @return [Symbol, Orb::
|
2207
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::Bulk::BillingCycleConfiguration::DurationUnit]
|
2251
2208
|
required :duration_unit,
|
2252
|
-
enum: -> { Orb::
|
2209
|
+
enum: -> { Orb::PlanCreateParams::Price::Bulk::BillingCycleConfiguration::DurationUnit }
|
2253
2210
|
|
2254
2211
|
# @!method initialize(duration:, duration_unit:)
|
2255
2212
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -2257,11 +2214,11 @@ module Orb
|
|
2257
2214
|
#
|
2258
2215
|
# @param duration [Integer] The duration of the billing period.
|
2259
2216
|
#
|
2260
|
-
# @param duration_unit [Symbol, Orb::
|
2217
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::Bulk::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
2261
2218
|
|
2262
2219
|
# The unit of billing period duration.
|
2263
2220
|
#
|
2264
|
-
# @see Orb::
|
2221
|
+
# @see Orb::PlanCreateParams::Price::Bulk::BillingCycleConfiguration#duration_unit
|
2265
2222
|
module DurationUnit
|
2266
2223
|
extend Orb::Internal::Type::Enum
|
2267
2224
|
|
@@ -2273,7 +2230,7 @@ module Orb
|
|
2273
2230
|
end
|
2274
2231
|
end
|
2275
2232
|
|
2276
|
-
# @see Orb::
|
2233
|
+
# @see Orb::PlanCreateParams::Price::Bulk#invoicing_cycle_configuration
|
2277
2234
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
2278
2235
|
# @!attribute duration
|
2279
2236
|
# The duration of the billing period.
|
@@ -2284,9 +2241,11 @@ module Orb
|
|
2284
2241
|
# @!attribute duration_unit
|
2285
2242
|
# The unit of billing period duration.
|
2286
2243
|
#
|
2287
|
-
# @return [Symbol, Orb::
|
2244
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::Bulk::InvoicingCycleConfiguration::DurationUnit]
|
2288
2245
|
required :duration_unit,
|
2289
|
-
enum: -> {
|
2246
|
+
enum: -> {
|
2247
|
+
Orb::PlanCreateParams::Price::Bulk::InvoicingCycleConfiguration::DurationUnit
|
2248
|
+
}
|
2290
2249
|
|
2291
2250
|
# @!method initialize(duration:, duration_unit:)
|
2292
2251
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
@@ -2294,11 +2253,11 @@ module Orb
|
|
2294
2253
|
#
|
2295
2254
|
# @param duration [Integer] The duration of the billing period.
|
2296
2255
|
#
|
2297
|
-
# @param duration_unit [Symbol, Orb::
|
2256
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::Bulk::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
2298
2257
|
|
2299
2258
|
# The unit of billing period duration.
|
2300
2259
|
#
|
2301
|
-
# @see Orb::
|
2260
|
+
# @see Orb::PlanCreateParams::Price::Bulk::InvoicingCycleConfiguration#duration_unit
|
2302
2261
|
module DurationUnit
|
2303
2262
|
extend Orb::Internal::Type::Enum
|
2304
2263
|
|
@@ -2311,13 +2270,12 @@ module Orb
|
|
2311
2270
|
end
|
2312
2271
|
end
|
2313
2272
|
|
2314
|
-
class
|
2273
|
+
class ThresholdTotalAmount < Orb::Internal::Type::BaseModel
|
2315
2274
|
# @!attribute cadence
|
2316
2275
|
# The cadence to bill for this price on.
|
2317
2276
|
#
|
2318
|
-
# @return [Symbol, Orb::
|
2319
|
-
required :cadence,
|
2320
|
-
enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanThresholdTotalAmountPrice::Cadence }
|
2277
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::ThresholdTotalAmount::Cadence]
|
2278
|
+
required :cadence, enum: -> { Orb::PlanCreateParams::Price::ThresholdTotalAmount::Cadence }
|
2321
2279
|
|
2322
2280
|
# @!attribute item_id
|
2323
2281
|
# The id of the item the price will be associated with.
|
@@ -2359,9 +2317,9 @@ module Orb
|
|
2359
2317
|
# For custom cadence: specifies the duration of the billing period in days or
|
2360
2318
|
# months.
|
2361
2319
|
#
|
2362
|
-
# @return [Orb::
|
2320
|
+
# @return [Orb::PlanCreateParams::Price::ThresholdTotalAmount::BillingCycleConfiguration, nil]
|
2363
2321
|
optional :billing_cycle_configuration,
|
2364
|
-
-> { Orb::
|
2322
|
+
-> { Orb::PlanCreateParams::Price::ThresholdTotalAmount::BillingCycleConfiguration },
|
2365
2323
|
nil?: true
|
2366
2324
|
|
2367
2325
|
# @!attribute conversion_rate
|
@@ -2400,9 +2358,9 @@ module Orb
|
|
2400
2358
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
2401
2359
|
# If unspecified, a single invoice is produced per billing cycle.
|
2402
2360
|
#
|
2403
|
-
# @return [Orb::
|
2361
|
+
# @return [Orb::PlanCreateParams::Price::ThresholdTotalAmount::InvoicingCycleConfiguration, nil]
|
2404
2362
|
optional :invoicing_cycle_configuration,
|
2405
|
-
-> { Orb::
|
2363
|
+
-> { Orb::PlanCreateParams::Price::ThresholdTotalAmount::InvoicingCycleConfiguration },
|
2406
2364
|
nil?: true
|
2407
2365
|
|
2408
2366
|
# @!attribute metadata
|
@@ -2415,10 +2373,9 @@ module Orb
|
|
2415
2373
|
|
2416
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)
|
2417
2375
|
# Some parameter documentations has been truncated, see
|
2418
|
-
# {Orb::
|
2419
|
-
# more details.
|
2376
|
+
# {Orb::PlanCreateParams::Price::ThresholdTotalAmount} for more details.
|
2420
2377
|
#
|
2421
|
-
# @param cadence [Symbol, Orb::
|
2378
|
+
# @param cadence [Symbol, Orb::PlanCreateParams::Price::ThresholdTotalAmount::Cadence] The cadence to bill for this price on.
|
2422
2379
|
#
|
2423
2380
|
# @param item_id [String] The id of the item the price will be associated with.
|
2424
2381
|
#
|
@@ -2427,37 +2384,30 @@ module Orb
|
|
2427
2384
|
# @param threshold_total_amount_config [Hash{Symbol=>Object}]
|
2428
2385
|
#
|
2429
2386
|
# @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b
|
2430
|
-
# ...
|
2431
2387
|
#
|
2432
2388
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
2433
|
-
# ...
|
2434
2389
|
#
|
2435
|
-
# @param billing_cycle_configuration [Orb::
|
2436
|
-
# ...
|
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
|
2437
2391
|
#
|
2438
2392
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
2439
2393
|
#
|
2440
2394
|
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
2441
|
-
# ...
|
2442
2395
|
#
|
2443
2396
|
# @param external_price_id [String, nil] An alias for the price.
|
2444
2397
|
#
|
2445
2398
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
2446
|
-
# ...
|
2447
2399
|
#
|
2448
2400
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
2449
2401
|
#
|
2450
|
-
# @param invoicing_cycle_configuration [Orb::
|
2451
|
-
# ...
|
2402
|
+
# @param invoicing_cycle_configuration [Orb::PlanCreateParams::Price::ThresholdTotalAmount::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
2452
2403
|
#
|
2453
2404
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
2454
|
-
# ...
|
2455
2405
|
#
|
2456
2406
|
# @param model_type [Symbol, :threshold_total_amount]
|
2457
2407
|
|
2458
2408
|
# The cadence to bill for this price on.
|
2459
2409
|
#
|
2460
|
-
# @see Orb::
|
2410
|
+
# @see Orb::PlanCreateParams::Price::ThresholdTotalAmount#cadence
|
2461
2411
|
module Cadence
|
2462
2412
|
extend Orb::Internal::Type::Enum
|
2463
2413
|
|
@@ -2472,7 +2422,7 @@ module Orb
|
|
2472
2422
|
# @return [Array<Symbol>]
|
2473
2423
|
end
|
2474
2424
|
|
2475
|
-
# @see Orb::
|
2425
|
+
# @see Orb::PlanCreateParams::Price::ThresholdTotalAmount#billing_cycle_configuration
|
2476
2426
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
2477
2427
|
# @!attribute duration
|
2478
2428
|
# The duration of the billing period.
|
@@ -2483,9 +2433,11 @@ module Orb
|
|
2483
2433
|
# @!attribute duration_unit
|
2484
2434
|
# The unit of billing period duration.
|
2485
2435
|
#
|
2486
|
-
# @return [Symbol, Orb::
|
2436
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::ThresholdTotalAmount::BillingCycleConfiguration::DurationUnit]
|
2487
2437
|
required :duration_unit,
|
2488
|
-
enum: -> {
|
2438
|
+
enum: -> {
|
2439
|
+
Orb::PlanCreateParams::Price::ThresholdTotalAmount::BillingCycleConfiguration::DurationUnit
|
2440
|
+
}
|
2489
2441
|
|
2490
2442
|
# @!method initialize(duration:, duration_unit:)
|
2491
2443
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -2493,11 +2445,11 @@ module Orb
|
|
2493
2445
|
#
|
2494
2446
|
# @param duration [Integer] The duration of the billing period.
|
2495
2447
|
#
|
2496
|
-
# @param duration_unit [Symbol, Orb::
|
2448
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::ThresholdTotalAmount::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
2497
2449
|
|
2498
2450
|
# The unit of billing period duration.
|
2499
2451
|
#
|
2500
|
-
# @see Orb::
|
2452
|
+
# @see Orb::PlanCreateParams::Price::ThresholdTotalAmount::BillingCycleConfiguration#duration_unit
|
2501
2453
|
module DurationUnit
|
2502
2454
|
extend Orb::Internal::Type::Enum
|
2503
2455
|
|
@@ -2509,7 +2461,7 @@ module Orb
|
|
2509
2461
|
end
|
2510
2462
|
end
|
2511
2463
|
|
2512
|
-
# @see Orb::
|
2464
|
+
# @see Orb::PlanCreateParams::Price::ThresholdTotalAmount#invoicing_cycle_configuration
|
2513
2465
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
2514
2466
|
# @!attribute duration
|
2515
2467
|
# The duration of the billing period.
|
@@ -2520,9 +2472,11 @@ module Orb
|
|
2520
2472
|
# @!attribute duration_unit
|
2521
2473
|
# The unit of billing period duration.
|
2522
2474
|
#
|
2523
|
-
# @return [Symbol, Orb::
|
2475
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::ThresholdTotalAmount::InvoicingCycleConfiguration::DurationUnit]
|
2524
2476
|
required :duration_unit,
|
2525
|
-
enum: -> {
|
2477
|
+
enum: -> {
|
2478
|
+
Orb::PlanCreateParams::Price::ThresholdTotalAmount::InvoicingCycleConfiguration::DurationUnit
|
2479
|
+
}
|
2526
2480
|
|
2527
2481
|
# @!method initialize(duration:, duration_unit:)
|
2528
2482
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
@@ -2530,11 +2484,11 @@ module Orb
|
|
2530
2484
|
#
|
2531
2485
|
# @param duration [Integer] The duration of the billing period.
|
2532
2486
|
#
|
2533
|
-
# @param duration_unit [Symbol, Orb::
|
2487
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::ThresholdTotalAmount::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
2534
2488
|
|
2535
2489
|
# The unit of billing period duration.
|
2536
2490
|
#
|
2537
|
-
# @see Orb::
|
2491
|
+
# @see Orb::PlanCreateParams::Price::ThresholdTotalAmount::InvoicingCycleConfiguration#duration_unit
|
2538
2492
|
module DurationUnit
|
2539
2493
|
extend Orb::Internal::Type::Enum
|
2540
2494
|
|
@@ -2547,12 +2501,12 @@ module Orb
|
|
2547
2501
|
end
|
2548
2502
|
end
|
2549
2503
|
|
2550
|
-
class
|
2504
|
+
class TieredPackage < Orb::Internal::Type::BaseModel
|
2551
2505
|
# @!attribute cadence
|
2552
2506
|
# The cadence to bill for this price on.
|
2553
2507
|
#
|
2554
|
-
# @return [Symbol, Orb::
|
2555
|
-
required :cadence, enum: -> { Orb::
|
2508
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::TieredPackage::Cadence]
|
2509
|
+
required :cadence, enum: -> { Orb::PlanCreateParams::Price::TieredPackage::Cadence }
|
2556
2510
|
|
2557
2511
|
# @!attribute item_id
|
2558
2512
|
# The id of the item the price will be associated with.
|
@@ -2594,9 +2548,9 @@ module Orb
|
|
2594
2548
|
# For custom cadence: specifies the duration of the billing period in days or
|
2595
2549
|
# months.
|
2596
2550
|
#
|
2597
|
-
# @return [Orb::
|
2551
|
+
# @return [Orb::PlanCreateParams::Price::TieredPackage::BillingCycleConfiguration, nil]
|
2598
2552
|
optional :billing_cycle_configuration,
|
2599
|
-
-> { Orb::
|
2553
|
+
-> { Orb::PlanCreateParams::Price::TieredPackage::BillingCycleConfiguration },
|
2600
2554
|
nil?: true
|
2601
2555
|
|
2602
2556
|
# @!attribute conversion_rate
|
@@ -2635,9 +2589,9 @@ module Orb
|
|
2635
2589
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
2636
2590
|
# If unspecified, a single invoice is produced per billing cycle.
|
2637
2591
|
#
|
2638
|
-
# @return [Orb::
|
2592
|
+
# @return [Orb::PlanCreateParams::Price::TieredPackage::InvoicingCycleConfiguration, nil]
|
2639
2593
|
optional :invoicing_cycle_configuration,
|
2640
|
-
-> { Orb::
|
2594
|
+
-> { Orb::PlanCreateParams::Price::TieredPackage::InvoicingCycleConfiguration },
|
2641
2595
|
nil?: true
|
2642
2596
|
|
2643
2597
|
# @!attribute metadata
|
@@ -2650,10 +2604,9 @@ module Orb
|
|
2650
2604
|
|
2651
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)
|
2652
2606
|
# Some parameter documentations has been truncated, see
|
2653
|
-
# {Orb::
|
2654
|
-
# details.
|
2607
|
+
# {Orb::PlanCreateParams::Price::TieredPackage} for more details.
|
2655
2608
|
#
|
2656
|
-
# @param cadence [Symbol, Orb::
|
2609
|
+
# @param cadence [Symbol, Orb::PlanCreateParams::Price::TieredPackage::Cadence] The cadence to bill for this price on.
|
2657
2610
|
#
|
2658
2611
|
# @param item_id [String] The id of the item the price will be associated with.
|
2659
2612
|
#
|
@@ -2662,37 +2615,30 @@ module Orb
|
|
2662
2615
|
# @param tiered_package_config [Hash{Symbol=>Object}]
|
2663
2616
|
#
|
2664
2617
|
# @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b
|
2665
|
-
# ...
|
2666
2618
|
#
|
2667
2619
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
2668
|
-
# ...
|
2669
2620
|
#
|
2670
|
-
# @param billing_cycle_configuration [Orb::
|
2671
|
-
# ...
|
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
|
2672
2622
|
#
|
2673
2623
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
2674
2624
|
#
|
2675
2625
|
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
2676
|
-
# ...
|
2677
2626
|
#
|
2678
2627
|
# @param external_price_id [String, nil] An alias for the price.
|
2679
2628
|
#
|
2680
2629
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
2681
|
-
# ...
|
2682
2630
|
#
|
2683
2631
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
2684
2632
|
#
|
2685
|
-
# @param invoicing_cycle_configuration [Orb::
|
2686
|
-
# ...
|
2633
|
+
# @param invoicing_cycle_configuration [Orb::PlanCreateParams::Price::TieredPackage::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
2687
2634
|
#
|
2688
2635
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
2689
|
-
# ...
|
2690
2636
|
#
|
2691
2637
|
# @param model_type [Symbol, :tiered_package]
|
2692
2638
|
|
2693
2639
|
# The cadence to bill for this price on.
|
2694
2640
|
#
|
2695
|
-
# @see Orb::
|
2641
|
+
# @see Orb::PlanCreateParams::Price::TieredPackage#cadence
|
2696
2642
|
module Cadence
|
2697
2643
|
extend Orb::Internal::Type::Enum
|
2698
2644
|
|
@@ -2707,7 +2653,7 @@ module Orb
|
|
2707
2653
|
# @return [Array<Symbol>]
|
2708
2654
|
end
|
2709
2655
|
|
2710
|
-
# @see Orb::
|
2656
|
+
# @see Orb::PlanCreateParams::Price::TieredPackage#billing_cycle_configuration
|
2711
2657
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
2712
2658
|
# @!attribute duration
|
2713
2659
|
# The duration of the billing period.
|
@@ -2718,9 +2664,11 @@ module Orb
|
|
2718
2664
|
# @!attribute duration_unit
|
2719
2665
|
# The unit of billing period duration.
|
2720
2666
|
#
|
2721
|
-
# @return [Symbol, Orb::
|
2667
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::TieredPackage::BillingCycleConfiguration::DurationUnit]
|
2722
2668
|
required :duration_unit,
|
2723
|
-
enum: -> {
|
2669
|
+
enum: -> {
|
2670
|
+
Orb::PlanCreateParams::Price::TieredPackage::BillingCycleConfiguration::DurationUnit
|
2671
|
+
}
|
2724
2672
|
|
2725
2673
|
# @!method initialize(duration:, duration_unit:)
|
2726
2674
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -2728,11 +2676,11 @@ module Orb
|
|
2728
2676
|
#
|
2729
2677
|
# @param duration [Integer] The duration of the billing period.
|
2730
2678
|
#
|
2731
|
-
# @param duration_unit [Symbol, Orb::
|
2679
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::TieredPackage::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
2732
2680
|
|
2733
2681
|
# The unit of billing period duration.
|
2734
2682
|
#
|
2735
|
-
# @see Orb::
|
2683
|
+
# @see Orb::PlanCreateParams::Price::TieredPackage::BillingCycleConfiguration#duration_unit
|
2736
2684
|
module DurationUnit
|
2737
2685
|
extend Orb::Internal::Type::Enum
|
2738
2686
|
|
@@ -2744,7 +2692,7 @@ module Orb
|
|
2744
2692
|
end
|
2745
2693
|
end
|
2746
2694
|
|
2747
|
-
# @see Orb::
|
2695
|
+
# @see Orb::PlanCreateParams::Price::TieredPackage#invoicing_cycle_configuration
|
2748
2696
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
2749
2697
|
# @!attribute duration
|
2750
2698
|
# The duration of the billing period.
|
@@ -2755,9 +2703,11 @@ module Orb
|
|
2755
2703
|
# @!attribute duration_unit
|
2756
2704
|
# The unit of billing period duration.
|
2757
2705
|
#
|
2758
|
-
# @return [Symbol, Orb::
|
2706
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::TieredPackage::InvoicingCycleConfiguration::DurationUnit]
|
2759
2707
|
required :duration_unit,
|
2760
|
-
enum: -> {
|
2708
|
+
enum: -> {
|
2709
|
+
Orb::PlanCreateParams::Price::TieredPackage::InvoicingCycleConfiguration::DurationUnit
|
2710
|
+
}
|
2761
2711
|
|
2762
2712
|
# @!method initialize(duration:, duration_unit:)
|
2763
2713
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
@@ -2765,11 +2715,11 @@ module Orb
|
|
2765
2715
|
#
|
2766
2716
|
# @param duration [Integer] The duration of the billing period.
|
2767
2717
|
#
|
2768
|
-
# @param duration_unit [Symbol, Orb::
|
2718
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::TieredPackage::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
2769
2719
|
|
2770
2720
|
# The unit of billing period duration.
|
2771
2721
|
#
|
2772
|
-
# @see Orb::
|
2722
|
+
# @see Orb::PlanCreateParams::Price::TieredPackage::InvoicingCycleConfiguration#duration_unit
|
2773
2723
|
module DurationUnit
|
2774
2724
|
extend Orb::Internal::Type::Enum
|
2775
2725
|
|
@@ -2782,13 +2732,12 @@ module Orb
|
|
2782
2732
|
end
|
2783
2733
|
end
|
2784
2734
|
|
2785
|
-
class
|
2735
|
+
class TieredWithMinimum < Orb::Internal::Type::BaseModel
|
2786
2736
|
# @!attribute cadence
|
2787
2737
|
# The cadence to bill for this price on.
|
2788
2738
|
#
|
2789
|
-
# @return [Symbol, Orb::
|
2790
|
-
required :cadence,
|
2791
|
-
enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanTieredWithMinimumPrice::Cadence }
|
2739
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::TieredWithMinimum::Cadence]
|
2740
|
+
required :cadence, enum: -> { Orb::PlanCreateParams::Price::TieredWithMinimum::Cadence }
|
2792
2741
|
|
2793
2742
|
# @!attribute item_id
|
2794
2743
|
# The id of the item the price will be associated with.
|
@@ -2830,9 +2779,9 @@ module Orb
|
|
2830
2779
|
# For custom cadence: specifies the duration of the billing period in days or
|
2831
2780
|
# months.
|
2832
2781
|
#
|
2833
|
-
# @return [Orb::
|
2782
|
+
# @return [Orb::PlanCreateParams::Price::TieredWithMinimum::BillingCycleConfiguration, nil]
|
2834
2783
|
optional :billing_cycle_configuration,
|
2835
|
-
-> { Orb::
|
2784
|
+
-> { Orb::PlanCreateParams::Price::TieredWithMinimum::BillingCycleConfiguration },
|
2836
2785
|
nil?: true
|
2837
2786
|
|
2838
2787
|
# @!attribute conversion_rate
|
@@ -2871,9 +2820,9 @@ module Orb
|
|
2871
2820
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
2872
2821
|
# If unspecified, a single invoice is produced per billing cycle.
|
2873
2822
|
#
|
2874
|
-
# @return [Orb::
|
2823
|
+
# @return [Orb::PlanCreateParams::Price::TieredWithMinimum::InvoicingCycleConfiguration, nil]
|
2875
2824
|
optional :invoicing_cycle_configuration,
|
2876
|
-
-> { Orb::
|
2825
|
+
-> { Orb::PlanCreateParams::Price::TieredWithMinimum::InvoicingCycleConfiguration },
|
2877
2826
|
nil?: true
|
2878
2827
|
|
2879
2828
|
# @!attribute metadata
|
@@ -2886,10 +2835,9 @@ module Orb
|
|
2886
2835
|
|
2887
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)
|
2888
2837
|
# Some parameter documentations has been truncated, see
|
2889
|
-
# {Orb::
|
2890
|
-
# details.
|
2838
|
+
# {Orb::PlanCreateParams::Price::TieredWithMinimum} for more details.
|
2891
2839
|
#
|
2892
|
-
# @param cadence [Symbol, Orb::
|
2840
|
+
# @param cadence [Symbol, Orb::PlanCreateParams::Price::TieredWithMinimum::Cadence] The cadence to bill for this price on.
|
2893
2841
|
#
|
2894
2842
|
# @param item_id [String] The id of the item the price will be associated with.
|
2895
2843
|
#
|
@@ -2898,37 +2846,30 @@ module Orb
|
|
2898
2846
|
# @param tiered_with_minimum_config [Hash{Symbol=>Object}]
|
2899
2847
|
#
|
2900
2848
|
# @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b
|
2901
|
-
# ...
|
2902
2849
|
#
|
2903
2850
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
2904
|
-
# ...
|
2905
2851
|
#
|
2906
|
-
# @param billing_cycle_configuration [Orb::
|
2907
|
-
# ...
|
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
|
2908
2853
|
#
|
2909
2854
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
2910
2855
|
#
|
2911
2856
|
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
2912
|
-
# ...
|
2913
2857
|
#
|
2914
2858
|
# @param external_price_id [String, nil] An alias for the price.
|
2915
2859
|
#
|
2916
2860
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
2917
|
-
# ...
|
2918
2861
|
#
|
2919
2862
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
2920
2863
|
#
|
2921
|
-
# @param invoicing_cycle_configuration [Orb::
|
2922
|
-
# ...
|
2864
|
+
# @param invoicing_cycle_configuration [Orb::PlanCreateParams::Price::TieredWithMinimum::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
2923
2865
|
#
|
2924
2866
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
2925
|
-
# ...
|
2926
2867
|
#
|
2927
2868
|
# @param model_type [Symbol, :tiered_with_minimum]
|
2928
2869
|
|
2929
2870
|
# The cadence to bill for this price on.
|
2930
2871
|
#
|
2931
|
-
# @see Orb::
|
2872
|
+
# @see Orb::PlanCreateParams::Price::TieredWithMinimum#cadence
|
2932
2873
|
module Cadence
|
2933
2874
|
extend Orb::Internal::Type::Enum
|
2934
2875
|
|
@@ -2943,7 +2884,7 @@ module Orb
|
|
2943
2884
|
# @return [Array<Symbol>]
|
2944
2885
|
end
|
2945
2886
|
|
2946
|
-
# @see Orb::
|
2887
|
+
# @see Orb::PlanCreateParams::Price::TieredWithMinimum#billing_cycle_configuration
|
2947
2888
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
2948
2889
|
# @!attribute duration
|
2949
2890
|
# The duration of the billing period.
|
@@ -2954,9 +2895,11 @@ module Orb
|
|
2954
2895
|
# @!attribute duration_unit
|
2955
2896
|
# The unit of billing period duration.
|
2956
2897
|
#
|
2957
|
-
# @return [Symbol, Orb::
|
2898
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::TieredWithMinimum::BillingCycleConfiguration::DurationUnit]
|
2958
2899
|
required :duration_unit,
|
2959
|
-
enum: -> {
|
2900
|
+
enum: -> {
|
2901
|
+
Orb::PlanCreateParams::Price::TieredWithMinimum::BillingCycleConfiguration::DurationUnit
|
2902
|
+
}
|
2960
2903
|
|
2961
2904
|
# @!method initialize(duration:, duration_unit:)
|
2962
2905
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -2964,11 +2907,11 @@ module Orb
|
|
2964
2907
|
#
|
2965
2908
|
# @param duration [Integer] The duration of the billing period.
|
2966
2909
|
#
|
2967
|
-
# @param duration_unit [Symbol, Orb::
|
2910
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::TieredWithMinimum::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
2968
2911
|
|
2969
2912
|
# The unit of billing period duration.
|
2970
2913
|
#
|
2971
|
-
# @see Orb::
|
2914
|
+
# @see Orb::PlanCreateParams::Price::TieredWithMinimum::BillingCycleConfiguration#duration_unit
|
2972
2915
|
module DurationUnit
|
2973
2916
|
extend Orb::Internal::Type::Enum
|
2974
2917
|
|
@@ -2980,7 +2923,7 @@ module Orb
|
|
2980
2923
|
end
|
2981
2924
|
end
|
2982
2925
|
|
2983
|
-
# @see Orb::
|
2926
|
+
# @see Orb::PlanCreateParams::Price::TieredWithMinimum#invoicing_cycle_configuration
|
2984
2927
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
2985
2928
|
# @!attribute duration
|
2986
2929
|
# The duration of the billing period.
|
@@ -2991,9 +2934,11 @@ module Orb
|
|
2991
2934
|
# @!attribute duration_unit
|
2992
2935
|
# The unit of billing period duration.
|
2993
2936
|
#
|
2994
|
-
# @return [Symbol, Orb::
|
2937
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::TieredWithMinimum::InvoicingCycleConfiguration::DurationUnit]
|
2995
2938
|
required :duration_unit,
|
2996
|
-
enum: -> {
|
2939
|
+
enum: -> {
|
2940
|
+
Orb::PlanCreateParams::Price::TieredWithMinimum::InvoicingCycleConfiguration::DurationUnit
|
2941
|
+
}
|
2997
2942
|
|
2998
2943
|
# @!method initialize(duration:, duration_unit:)
|
2999
2944
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
@@ -3001,11 +2946,11 @@ module Orb
|
|
3001
2946
|
#
|
3002
2947
|
# @param duration [Integer] The duration of the billing period.
|
3003
2948
|
#
|
3004
|
-
# @param duration_unit [Symbol, Orb::
|
2949
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::TieredWithMinimum::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
3005
2950
|
|
3006
2951
|
# The unit of billing period duration.
|
3007
2952
|
#
|
3008
|
-
# @see Orb::
|
2953
|
+
# @see Orb::PlanCreateParams::Price::TieredWithMinimum::InvoicingCycleConfiguration#duration_unit
|
3009
2954
|
module DurationUnit
|
3010
2955
|
extend Orb::Internal::Type::Enum
|
3011
2956
|
|
@@ -3018,12 +2963,12 @@ module Orb
|
|
3018
2963
|
end
|
3019
2964
|
end
|
3020
2965
|
|
3021
|
-
class
|
2966
|
+
class UnitWithPercent < Orb::Internal::Type::BaseModel
|
3022
2967
|
# @!attribute cadence
|
3023
2968
|
# The cadence to bill for this price on.
|
3024
2969
|
#
|
3025
|
-
# @return [Symbol, Orb::
|
3026
|
-
required :cadence, enum: -> { Orb::
|
2970
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::UnitWithPercent::Cadence]
|
2971
|
+
required :cadence, enum: -> { Orb::PlanCreateParams::Price::UnitWithPercent::Cadence }
|
3027
2972
|
|
3028
2973
|
# @!attribute item_id
|
3029
2974
|
# The id of the item the price will be associated with.
|
@@ -3065,9 +3010,9 @@ module Orb
|
|
3065
3010
|
# For custom cadence: specifies the duration of the billing period in days or
|
3066
3011
|
# months.
|
3067
3012
|
#
|
3068
|
-
# @return [Orb::
|
3013
|
+
# @return [Orb::PlanCreateParams::Price::UnitWithPercent::BillingCycleConfiguration, nil]
|
3069
3014
|
optional :billing_cycle_configuration,
|
3070
|
-
-> { Orb::
|
3015
|
+
-> { Orb::PlanCreateParams::Price::UnitWithPercent::BillingCycleConfiguration },
|
3071
3016
|
nil?: true
|
3072
3017
|
|
3073
3018
|
# @!attribute conversion_rate
|
@@ -3106,9 +3051,9 @@ module Orb
|
|
3106
3051
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
3107
3052
|
# If unspecified, a single invoice is produced per billing cycle.
|
3108
3053
|
#
|
3109
|
-
# @return [Orb::
|
3054
|
+
# @return [Orb::PlanCreateParams::Price::UnitWithPercent::InvoicingCycleConfiguration, nil]
|
3110
3055
|
optional :invoicing_cycle_configuration,
|
3111
|
-
-> { Orb::
|
3056
|
+
-> { Orb::PlanCreateParams::Price::UnitWithPercent::InvoicingCycleConfiguration },
|
3112
3057
|
nil?: true
|
3113
3058
|
|
3114
3059
|
# @!attribute metadata
|
@@ -3121,10 +3066,9 @@ module Orb
|
|
3121
3066
|
|
3122
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)
|
3123
3068
|
# Some parameter documentations has been truncated, see
|
3124
|
-
# {Orb::
|
3125
|
-
# details.
|
3069
|
+
# {Orb::PlanCreateParams::Price::UnitWithPercent} for more details.
|
3126
3070
|
#
|
3127
|
-
# @param cadence [Symbol, Orb::
|
3071
|
+
# @param cadence [Symbol, Orb::PlanCreateParams::Price::UnitWithPercent::Cadence] The cadence to bill for this price on.
|
3128
3072
|
#
|
3129
3073
|
# @param item_id [String] The id of the item the price will be associated with.
|
3130
3074
|
#
|
@@ -3133,37 +3077,30 @@ module Orb
|
|
3133
3077
|
# @param unit_with_percent_config [Hash{Symbol=>Object}]
|
3134
3078
|
#
|
3135
3079
|
# @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b
|
3136
|
-
# ...
|
3137
3080
|
#
|
3138
3081
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
3139
|
-
# ...
|
3140
3082
|
#
|
3141
|
-
# @param billing_cycle_configuration [Orb::
|
3142
|
-
# ...
|
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
|
3143
3084
|
#
|
3144
3085
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
3145
3086
|
#
|
3146
3087
|
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
3147
|
-
# ...
|
3148
3088
|
#
|
3149
3089
|
# @param external_price_id [String, nil] An alias for the price.
|
3150
3090
|
#
|
3151
3091
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
3152
|
-
# ...
|
3153
3092
|
#
|
3154
3093
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
3155
3094
|
#
|
3156
|
-
# @param invoicing_cycle_configuration [Orb::
|
3157
|
-
# ...
|
3095
|
+
# @param invoicing_cycle_configuration [Orb::PlanCreateParams::Price::UnitWithPercent::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
3158
3096
|
#
|
3159
3097
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
3160
|
-
# ...
|
3161
3098
|
#
|
3162
3099
|
# @param model_type [Symbol, :unit_with_percent]
|
3163
3100
|
|
3164
3101
|
# The cadence to bill for this price on.
|
3165
3102
|
#
|
3166
|
-
# @see Orb::
|
3103
|
+
# @see Orb::PlanCreateParams::Price::UnitWithPercent#cadence
|
3167
3104
|
module Cadence
|
3168
3105
|
extend Orb::Internal::Type::Enum
|
3169
3106
|
|
@@ -3178,7 +3115,7 @@ module Orb
|
|
3178
3115
|
# @return [Array<Symbol>]
|
3179
3116
|
end
|
3180
3117
|
|
3181
|
-
# @see Orb::
|
3118
|
+
# @see Orb::PlanCreateParams::Price::UnitWithPercent#billing_cycle_configuration
|
3182
3119
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
3183
3120
|
# @!attribute duration
|
3184
3121
|
# The duration of the billing period.
|
@@ -3189,9 +3126,11 @@ module Orb
|
|
3189
3126
|
# @!attribute duration_unit
|
3190
3127
|
# The unit of billing period duration.
|
3191
3128
|
#
|
3192
|
-
# @return [Symbol, Orb::
|
3129
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::UnitWithPercent::BillingCycleConfiguration::DurationUnit]
|
3193
3130
|
required :duration_unit,
|
3194
|
-
enum: -> {
|
3131
|
+
enum: -> {
|
3132
|
+
Orb::PlanCreateParams::Price::UnitWithPercent::BillingCycleConfiguration::DurationUnit
|
3133
|
+
}
|
3195
3134
|
|
3196
3135
|
# @!method initialize(duration:, duration_unit:)
|
3197
3136
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -3199,11 +3138,11 @@ module Orb
|
|
3199
3138
|
#
|
3200
3139
|
# @param duration [Integer] The duration of the billing period.
|
3201
3140
|
#
|
3202
|
-
# @param duration_unit [Symbol, Orb::
|
3141
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::UnitWithPercent::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
3203
3142
|
|
3204
3143
|
# The unit of billing period duration.
|
3205
3144
|
#
|
3206
|
-
# @see Orb::
|
3145
|
+
# @see Orb::PlanCreateParams::Price::UnitWithPercent::BillingCycleConfiguration#duration_unit
|
3207
3146
|
module DurationUnit
|
3208
3147
|
extend Orb::Internal::Type::Enum
|
3209
3148
|
|
@@ -3215,7 +3154,7 @@ module Orb
|
|
3215
3154
|
end
|
3216
3155
|
end
|
3217
3156
|
|
3218
|
-
# @see Orb::
|
3157
|
+
# @see Orb::PlanCreateParams::Price::UnitWithPercent#invoicing_cycle_configuration
|
3219
3158
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
3220
3159
|
# @!attribute duration
|
3221
3160
|
# The duration of the billing period.
|
@@ -3226,9 +3165,11 @@ module Orb
|
|
3226
3165
|
# @!attribute duration_unit
|
3227
3166
|
# The unit of billing period duration.
|
3228
3167
|
#
|
3229
|
-
# @return [Symbol, Orb::
|
3168
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::UnitWithPercent::InvoicingCycleConfiguration::DurationUnit]
|
3230
3169
|
required :duration_unit,
|
3231
|
-
enum: -> {
|
3170
|
+
enum: -> {
|
3171
|
+
Orb::PlanCreateParams::Price::UnitWithPercent::InvoicingCycleConfiguration::DurationUnit
|
3172
|
+
}
|
3232
3173
|
|
3233
3174
|
# @!method initialize(duration:, duration_unit:)
|
3234
3175
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
@@ -3236,11 +3177,11 @@ module Orb
|
|
3236
3177
|
#
|
3237
3178
|
# @param duration [Integer] The duration of the billing period.
|
3238
3179
|
#
|
3239
|
-
# @param duration_unit [Symbol, Orb::
|
3180
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::UnitWithPercent::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
3240
3181
|
|
3241
3182
|
# The unit of billing period duration.
|
3242
3183
|
#
|
3243
|
-
# @see Orb::
|
3184
|
+
# @see Orb::PlanCreateParams::Price::UnitWithPercent::InvoicingCycleConfiguration#duration_unit
|
3244
3185
|
module DurationUnit
|
3245
3186
|
extend Orb::Internal::Type::Enum
|
3246
3187
|
|
@@ -3253,13 +3194,12 @@ module Orb
|
|
3253
3194
|
end
|
3254
3195
|
end
|
3255
3196
|
|
3256
|
-
class
|
3197
|
+
class PackageWithAllocation < Orb::Internal::Type::BaseModel
|
3257
3198
|
# @!attribute cadence
|
3258
3199
|
# The cadence to bill for this price on.
|
3259
3200
|
#
|
3260
|
-
# @return [Symbol, Orb::
|
3261
|
-
required :cadence,
|
3262
|
-
enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanPackageWithAllocationPrice::Cadence }
|
3201
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::PackageWithAllocation::Cadence]
|
3202
|
+
required :cadence, enum: -> { Orb::PlanCreateParams::Price::PackageWithAllocation::Cadence }
|
3263
3203
|
|
3264
3204
|
# @!attribute item_id
|
3265
3205
|
# The id of the item the price will be associated with.
|
@@ -3301,9 +3241,9 @@ module Orb
|
|
3301
3241
|
# For custom cadence: specifies the duration of the billing period in days or
|
3302
3242
|
# months.
|
3303
3243
|
#
|
3304
|
-
# @return [Orb::
|
3244
|
+
# @return [Orb::PlanCreateParams::Price::PackageWithAllocation::BillingCycleConfiguration, nil]
|
3305
3245
|
optional :billing_cycle_configuration,
|
3306
|
-
-> { Orb::
|
3246
|
+
-> { Orb::PlanCreateParams::Price::PackageWithAllocation::BillingCycleConfiguration },
|
3307
3247
|
nil?: true
|
3308
3248
|
|
3309
3249
|
# @!attribute conversion_rate
|
@@ -3342,9 +3282,9 @@ module Orb
|
|
3342
3282
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
3343
3283
|
# If unspecified, a single invoice is produced per billing cycle.
|
3344
3284
|
#
|
3345
|
-
# @return [Orb::
|
3285
|
+
# @return [Orb::PlanCreateParams::Price::PackageWithAllocation::InvoicingCycleConfiguration, nil]
|
3346
3286
|
optional :invoicing_cycle_configuration,
|
3347
|
-
-> { Orb::
|
3287
|
+
-> { Orb::PlanCreateParams::Price::PackageWithAllocation::InvoicingCycleConfiguration },
|
3348
3288
|
nil?: true
|
3349
3289
|
|
3350
3290
|
# @!attribute metadata
|
@@ -3357,10 +3297,9 @@ module Orb
|
|
3357
3297
|
|
3358
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)
|
3359
3299
|
# Some parameter documentations has been truncated, see
|
3360
|
-
# {Orb::
|
3361
|
-
# more details.
|
3300
|
+
# {Orb::PlanCreateParams::Price::PackageWithAllocation} for more details.
|
3362
3301
|
#
|
3363
|
-
# @param cadence [Symbol, Orb::
|
3302
|
+
# @param cadence [Symbol, Orb::PlanCreateParams::Price::PackageWithAllocation::Cadence] The cadence to bill for this price on.
|
3364
3303
|
#
|
3365
3304
|
# @param item_id [String] The id of the item the price will be associated with.
|
3366
3305
|
#
|
@@ -3369,37 +3308,30 @@ module Orb
|
|
3369
3308
|
# @param package_with_allocation_config [Hash{Symbol=>Object}]
|
3370
3309
|
#
|
3371
3310
|
# @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b
|
3372
|
-
# ...
|
3373
3311
|
#
|
3374
3312
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
3375
|
-
# ...
|
3376
3313
|
#
|
3377
|
-
# @param billing_cycle_configuration [Orb::
|
3378
|
-
# ...
|
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
|
3379
3315
|
#
|
3380
3316
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
3381
3317
|
#
|
3382
3318
|
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
3383
|
-
# ...
|
3384
3319
|
#
|
3385
3320
|
# @param external_price_id [String, nil] An alias for the price.
|
3386
3321
|
#
|
3387
3322
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
3388
|
-
# ...
|
3389
3323
|
#
|
3390
3324
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
3391
3325
|
#
|
3392
|
-
# @param invoicing_cycle_configuration [Orb::
|
3393
|
-
# ...
|
3326
|
+
# @param invoicing_cycle_configuration [Orb::PlanCreateParams::Price::PackageWithAllocation::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
3394
3327
|
#
|
3395
3328
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
3396
|
-
# ...
|
3397
3329
|
#
|
3398
3330
|
# @param model_type [Symbol, :package_with_allocation]
|
3399
3331
|
|
3400
3332
|
# The cadence to bill for this price on.
|
3401
3333
|
#
|
3402
|
-
# @see Orb::
|
3334
|
+
# @see Orb::PlanCreateParams::Price::PackageWithAllocation#cadence
|
3403
3335
|
module Cadence
|
3404
3336
|
extend Orb::Internal::Type::Enum
|
3405
3337
|
|
@@ -3414,7 +3346,7 @@ module Orb
|
|
3414
3346
|
# @return [Array<Symbol>]
|
3415
3347
|
end
|
3416
3348
|
|
3417
|
-
# @see Orb::
|
3349
|
+
# @see Orb::PlanCreateParams::Price::PackageWithAllocation#billing_cycle_configuration
|
3418
3350
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
3419
3351
|
# @!attribute duration
|
3420
3352
|
# The duration of the billing period.
|
@@ -3425,9 +3357,11 @@ module Orb
|
|
3425
3357
|
# @!attribute duration_unit
|
3426
3358
|
# The unit of billing period duration.
|
3427
3359
|
#
|
3428
|
-
# @return [Symbol, Orb::
|
3360
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::PackageWithAllocation::BillingCycleConfiguration::DurationUnit]
|
3429
3361
|
required :duration_unit,
|
3430
|
-
enum: -> {
|
3362
|
+
enum: -> {
|
3363
|
+
Orb::PlanCreateParams::Price::PackageWithAllocation::BillingCycleConfiguration::DurationUnit
|
3364
|
+
}
|
3431
3365
|
|
3432
3366
|
# @!method initialize(duration:, duration_unit:)
|
3433
3367
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -3435,11 +3369,11 @@ module Orb
|
|
3435
3369
|
#
|
3436
3370
|
# @param duration [Integer] The duration of the billing period.
|
3437
3371
|
#
|
3438
|
-
# @param duration_unit [Symbol, Orb::
|
3372
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::PackageWithAllocation::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
3439
3373
|
|
3440
3374
|
# The unit of billing period duration.
|
3441
3375
|
#
|
3442
|
-
# @see Orb::
|
3376
|
+
# @see Orb::PlanCreateParams::Price::PackageWithAllocation::BillingCycleConfiguration#duration_unit
|
3443
3377
|
module DurationUnit
|
3444
3378
|
extend Orb::Internal::Type::Enum
|
3445
3379
|
|
@@ -3451,7 +3385,7 @@ module Orb
|
|
3451
3385
|
end
|
3452
3386
|
end
|
3453
3387
|
|
3454
|
-
# @see Orb::
|
3388
|
+
# @see Orb::PlanCreateParams::Price::PackageWithAllocation#invoicing_cycle_configuration
|
3455
3389
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
3456
3390
|
# @!attribute duration
|
3457
3391
|
# The duration of the billing period.
|
@@ -3462,9 +3396,11 @@ module Orb
|
|
3462
3396
|
# @!attribute duration_unit
|
3463
3397
|
# The unit of billing period duration.
|
3464
3398
|
#
|
3465
|
-
# @return [Symbol, Orb::
|
3399
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::PackageWithAllocation::InvoicingCycleConfiguration::DurationUnit]
|
3466
3400
|
required :duration_unit,
|
3467
|
-
enum: -> {
|
3401
|
+
enum: -> {
|
3402
|
+
Orb::PlanCreateParams::Price::PackageWithAllocation::InvoicingCycleConfiguration::DurationUnit
|
3403
|
+
}
|
3468
3404
|
|
3469
3405
|
# @!method initialize(duration:, duration_unit:)
|
3470
3406
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
@@ -3472,11 +3408,11 @@ module Orb
|
|
3472
3408
|
#
|
3473
3409
|
# @param duration [Integer] The duration of the billing period.
|
3474
3410
|
#
|
3475
|
-
# @param duration_unit [Symbol, Orb::
|
3411
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::PackageWithAllocation::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
3476
3412
|
|
3477
3413
|
# The unit of billing period duration.
|
3478
3414
|
#
|
3479
|
-
# @see Orb::
|
3415
|
+
# @see Orb::PlanCreateParams::Price::PackageWithAllocation::InvoicingCycleConfiguration#duration_unit
|
3480
3416
|
module DurationUnit
|
3481
3417
|
extend Orb::Internal::Type::Enum
|
3482
3418
|
|
@@ -3489,13 +3425,12 @@ module Orb
|
|
3489
3425
|
end
|
3490
3426
|
end
|
3491
3427
|
|
3492
|
-
class
|
3428
|
+
class TieredWithProration < Orb::Internal::Type::BaseModel
|
3493
3429
|
# @!attribute cadence
|
3494
3430
|
# The cadence to bill for this price on.
|
3495
3431
|
#
|
3496
|
-
# @return [Symbol, Orb::
|
3497
|
-
required :cadence,
|
3498
|
-
enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanTierWithProrationPrice::Cadence }
|
3432
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::TieredWithProration::Cadence]
|
3433
|
+
required :cadence, enum: -> { Orb::PlanCreateParams::Price::TieredWithProration::Cadence }
|
3499
3434
|
|
3500
3435
|
# @!attribute item_id
|
3501
3436
|
# The id of the item the price will be associated with.
|
@@ -3537,9 +3472,9 @@ module Orb
|
|
3537
3472
|
# For custom cadence: specifies the duration of the billing period in days or
|
3538
3473
|
# months.
|
3539
3474
|
#
|
3540
|
-
# @return [Orb::
|
3475
|
+
# @return [Orb::PlanCreateParams::Price::TieredWithProration::BillingCycleConfiguration, nil]
|
3541
3476
|
optional :billing_cycle_configuration,
|
3542
|
-
-> { Orb::
|
3477
|
+
-> { Orb::PlanCreateParams::Price::TieredWithProration::BillingCycleConfiguration },
|
3543
3478
|
nil?: true
|
3544
3479
|
|
3545
3480
|
# @!attribute conversion_rate
|
@@ -3578,9 +3513,9 @@ module Orb
|
|
3578
3513
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
3579
3514
|
# If unspecified, a single invoice is produced per billing cycle.
|
3580
3515
|
#
|
3581
|
-
# @return [Orb::
|
3516
|
+
# @return [Orb::PlanCreateParams::Price::TieredWithProration::InvoicingCycleConfiguration, nil]
|
3582
3517
|
optional :invoicing_cycle_configuration,
|
3583
|
-
-> { Orb::
|
3518
|
+
-> { Orb::PlanCreateParams::Price::TieredWithProration::InvoicingCycleConfiguration },
|
3584
3519
|
nil?: true
|
3585
3520
|
|
3586
3521
|
# @!attribute metadata
|
@@ -3593,10 +3528,9 @@ module Orb
|
|
3593
3528
|
|
3594
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)
|
3595
3530
|
# Some parameter documentations has been truncated, see
|
3596
|
-
# {Orb::
|
3597
|
-
# details.
|
3531
|
+
# {Orb::PlanCreateParams::Price::TieredWithProration} for more details.
|
3598
3532
|
#
|
3599
|
-
# @param cadence [Symbol, Orb::
|
3533
|
+
# @param cadence [Symbol, Orb::PlanCreateParams::Price::TieredWithProration::Cadence] The cadence to bill for this price on.
|
3600
3534
|
#
|
3601
3535
|
# @param item_id [String] The id of the item the price will be associated with.
|
3602
3536
|
#
|
@@ -3605,37 +3539,30 @@ module Orb
|
|
3605
3539
|
# @param tiered_with_proration_config [Hash{Symbol=>Object}]
|
3606
3540
|
#
|
3607
3541
|
# @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b
|
3608
|
-
# ...
|
3609
3542
|
#
|
3610
3543
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
3611
|
-
# ...
|
3612
3544
|
#
|
3613
|
-
# @param billing_cycle_configuration [Orb::
|
3614
|
-
# ...
|
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
|
3615
3546
|
#
|
3616
3547
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
3617
3548
|
#
|
3618
3549
|
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
3619
|
-
# ...
|
3620
3550
|
#
|
3621
3551
|
# @param external_price_id [String, nil] An alias for the price.
|
3622
3552
|
#
|
3623
3553
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
3624
|
-
# ...
|
3625
3554
|
#
|
3626
3555
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
3627
3556
|
#
|
3628
|
-
# @param invoicing_cycle_configuration [Orb::
|
3629
|
-
# ...
|
3557
|
+
# @param invoicing_cycle_configuration [Orb::PlanCreateParams::Price::TieredWithProration::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
3630
3558
|
#
|
3631
3559
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
3632
|
-
# ...
|
3633
3560
|
#
|
3634
3561
|
# @param model_type [Symbol, :tiered_with_proration]
|
3635
3562
|
|
3636
3563
|
# The cadence to bill for this price on.
|
3637
3564
|
#
|
3638
|
-
# @see Orb::
|
3565
|
+
# @see Orb::PlanCreateParams::Price::TieredWithProration#cadence
|
3639
3566
|
module Cadence
|
3640
3567
|
extend Orb::Internal::Type::Enum
|
3641
3568
|
|
@@ -3650,7 +3577,7 @@ module Orb
|
|
3650
3577
|
# @return [Array<Symbol>]
|
3651
3578
|
end
|
3652
3579
|
|
3653
|
-
# @see Orb::
|
3580
|
+
# @see Orb::PlanCreateParams::Price::TieredWithProration#billing_cycle_configuration
|
3654
3581
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
3655
3582
|
# @!attribute duration
|
3656
3583
|
# The duration of the billing period.
|
@@ -3661,9 +3588,11 @@ module Orb
|
|
3661
3588
|
# @!attribute duration_unit
|
3662
3589
|
# The unit of billing period duration.
|
3663
3590
|
#
|
3664
|
-
# @return [Symbol, Orb::
|
3591
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::TieredWithProration::BillingCycleConfiguration::DurationUnit]
|
3665
3592
|
required :duration_unit,
|
3666
|
-
enum: -> {
|
3593
|
+
enum: -> {
|
3594
|
+
Orb::PlanCreateParams::Price::TieredWithProration::BillingCycleConfiguration::DurationUnit
|
3595
|
+
}
|
3667
3596
|
|
3668
3597
|
# @!method initialize(duration:, duration_unit:)
|
3669
3598
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -3671,11 +3600,11 @@ module Orb
|
|
3671
3600
|
#
|
3672
3601
|
# @param duration [Integer] The duration of the billing period.
|
3673
3602
|
#
|
3674
|
-
# @param duration_unit [Symbol, Orb::
|
3603
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::TieredWithProration::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
3675
3604
|
|
3676
3605
|
# The unit of billing period duration.
|
3677
3606
|
#
|
3678
|
-
# @see Orb::
|
3607
|
+
# @see Orb::PlanCreateParams::Price::TieredWithProration::BillingCycleConfiguration#duration_unit
|
3679
3608
|
module DurationUnit
|
3680
3609
|
extend Orb::Internal::Type::Enum
|
3681
3610
|
|
@@ -3687,7 +3616,7 @@ module Orb
|
|
3687
3616
|
end
|
3688
3617
|
end
|
3689
3618
|
|
3690
|
-
# @see Orb::
|
3619
|
+
# @see Orb::PlanCreateParams::Price::TieredWithProration#invoicing_cycle_configuration
|
3691
3620
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
3692
3621
|
# @!attribute duration
|
3693
3622
|
# The duration of the billing period.
|
@@ -3698,9 +3627,11 @@ module Orb
|
|
3698
3627
|
# @!attribute duration_unit
|
3699
3628
|
# The unit of billing period duration.
|
3700
3629
|
#
|
3701
|
-
# @return [Symbol, Orb::
|
3630
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::TieredWithProration::InvoicingCycleConfiguration::DurationUnit]
|
3702
3631
|
required :duration_unit,
|
3703
|
-
enum: -> {
|
3632
|
+
enum: -> {
|
3633
|
+
Orb::PlanCreateParams::Price::TieredWithProration::InvoicingCycleConfiguration::DurationUnit
|
3634
|
+
}
|
3704
3635
|
|
3705
3636
|
# @!method initialize(duration:, duration_unit:)
|
3706
3637
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
@@ -3708,11 +3639,11 @@ module Orb
|
|
3708
3639
|
#
|
3709
3640
|
# @param duration [Integer] The duration of the billing period.
|
3710
3641
|
#
|
3711
|
-
# @param duration_unit [Symbol, Orb::
|
3642
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::TieredWithProration::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
3712
3643
|
|
3713
3644
|
# The unit of billing period duration.
|
3714
3645
|
#
|
3715
|
-
# @see Orb::
|
3646
|
+
# @see Orb::PlanCreateParams::Price::TieredWithProration::InvoicingCycleConfiguration#duration_unit
|
3716
3647
|
module DurationUnit
|
3717
3648
|
extend Orb::Internal::Type::Enum
|
3718
3649
|
|
@@ -3725,13 +3656,12 @@ module Orb
|
|
3725
3656
|
end
|
3726
3657
|
end
|
3727
3658
|
|
3728
|
-
class
|
3659
|
+
class UnitWithProration < Orb::Internal::Type::BaseModel
|
3729
3660
|
# @!attribute cadence
|
3730
3661
|
# The cadence to bill for this price on.
|
3731
3662
|
#
|
3732
|
-
# @return [Symbol, Orb::
|
3733
|
-
required :cadence,
|
3734
|
-
enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanUnitWithProrationPrice::Cadence }
|
3663
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::UnitWithProration::Cadence]
|
3664
|
+
required :cadence, enum: -> { Orb::PlanCreateParams::Price::UnitWithProration::Cadence }
|
3735
3665
|
|
3736
3666
|
# @!attribute item_id
|
3737
3667
|
# The id of the item the price will be associated with.
|
@@ -3773,9 +3703,9 @@ module Orb
|
|
3773
3703
|
# For custom cadence: specifies the duration of the billing period in days or
|
3774
3704
|
# months.
|
3775
3705
|
#
|
3776
|
-
# @return [Orb::
|
3706
|
+
# @return [Orb::PlanCreateParams::Price::UnitWithProration::BillingCycleConfiguration, nil]
|
3777
3707
|
optional :billing_cycle_configuration,
|
3778
|
-
-> { Orb::
|
3708
|
+
-> { Orb::PlanCreateParams::Price::UnitWithProration::BillingCycleConfiguration },
|
3779
3709
|
nil?: true
|
3780
3710
|
|
3781
3711
|
# @!attribute conversion_rate
|
@@ -3814,9 +3744,9 @@ module Orb
|
|
3814
3744
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
3815
3745
|
# If unspecified, a single invoice is produced per billing cycle.
|
3816
3746
|
#
|
3817
|
-
# @return [Orb::
|
3747
|
+
# @return [Orb::PlanCreateParams::Price::UnitWithProration::InvoicingCycleConfiguration, nil]
|
3818
3748
|
optional :invoicing_cycle_configuration,
|
3819
|
-
-> { Orb::
|
3749
|
+
-> { Orb::PlanCreateParams::Price::UnitWithProration::InvoicingCycleConfiguration },
|
3820
3750
|
nil?: true
|
3821
3751
|
|
3822
3752
|
# @!attribute metadata
|
@@ -3829,10 +3759,9 @@ module Orb
|
|
3829
3759
|
|
3830
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)
|
3831
3761
|
# Some parameter documentations has been truncated, see
|
3832
|
-
# {Orb::
|
3833
|
-
# details.
|
3762
|
+
# {Orb::PlanCreateParams::Price::UnitWithProration} for more details.
|
3834
3763
|
#
|
3835
|
-
# @param cadence [Symbol, Orb::
|
3764
|
+
# @param cadence [Symbol, Orb::PlanCreateParams::Price::UnitWithProration::Cadence] The cadence to bill for this price on.
|
3836
3765
|
#
|
3837
3766
|
# @param item_id [String] The id of the item the price will be associated with.
|
3838
3767
|
#
|
@@ -3841,37 +3770,30 @@ module Orb
|
|
3841
3770
|
# @param unit_with_proration_config [Hash{Symbol=>Object}]
|
3842
3771
|
#
|
3843
3772
|
# @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b
|
3844
|
-
# ...
|
3845
3773
|
#
|
3846
3774
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
3847
|
-
# ...
|
3848
3775
|
#
|
3849
|
-
# @param billing_cycle_configuration [Orb::
|
3850
|
-
# ...
|
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
|
3851
3777
|
#
|
3852
3778
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
3853
3779
|
#
|
3854
3780
|
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
3855
|
-
# ...
|
3856
3781
|
#
|
3857
3782
|
# @param external_price_id [String, nil] An alias for the price.
|
3858
3783
|
#
|
3859
3784
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
3860
|
-
# ...
|
3861
3785
|
#
|
3862
3786
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
3863
3787
|
#
|
3864
|
-
# @param invoicing_cycle_configuration [Orb::
|
3865
|
-
# ...
|
3788
|
+
# @param invoicing_cycle_configuration [Orb::PlanCreateParams::Price::UnitWithProration::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
3866
3789
|
#
|
3867
3790
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
3868
|
-
# ...
|
3869
3791
|
#
|
3870
3792
|
# @param model_type [Symbol, :unit_with_proration]
|
3871
3793
|
|
3872
3794
|
# The cadence to bill for this price on.
|
3873
3795
|
#
|
3874
|
-
# @see Orb::
|
3796
|
+
# @see Orb::PlanCreateParams::Price::UnitWithProration#cadence
|
3875
3797
|
module Cadence
|
3876
3798
|
extend Orb::Internal::Type::Enum
|
3877
3799
|
|
@@ -3886,7 +3808,7 @@ module Orb
|
|
3886
3808
|
# @return [Array<Symbol>]
|
3887
3809
|
end
|
3888
3810
|
|
3889
|
-
# @see Orb::
|
3811
|
+
# @see Orb::PlanCreateParams::Price::UnitWithProration#billing_cycle_configuration
|
3890
3812
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
3891
3813
|
# @!attribute duration
|
3892
3814
|
# The duration of the billing period.
|
@@ -3897,9 +3819,11 @@ module Orb
|
|
3897
3819
|
# @!attribute duration_unit
|
3898
3820
|
# The unit of billing period duration.
|
3899
3821
|
#
|
3900
|
-
# @return [Symbol, Orb::
|
3822
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::UnitWithProration::BillingCycleConfiguration::DurationUnit]
|
3901
3823
|
required :duration_unit,
|
3902
|
-
enum: -> {
|
3824
|
+
enum: -> {
|
3825
|
+
Orb::PlanCreateParams::Price::UnitWithProration::BillingCycleConfiguration::DurationUnit
|
3826
|
+
}
|
3903
3827
|
|
3904
3828
|
# @!method initialize(duration:, duration_unit:)
|
3905
3829
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -3907,11 +3831,11 @@ module Orb
|
|
3907
3831
|
#
|
3908
3832
|
# @param duration [Integer] The duration of the billing period.
|
3909
3833
|
#
|
3910
|
-
# @param duration_unit [Symbol, Orb::
|
3834
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::UnitWithProration::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
3911
3835
|
|
3912
3836
|
# The unit of billing period duration.
|
3913
3837
|
#
|
3914
|
-
# @see Orb::
|
3838
|
+
# @see Orb::PlanCreateParams::Price::UnitWithProration::BillingCycleConfiguration#duration_unit
|
3915
3839
|
module DurationUnit
|
3916
3840
|
extend Orb::Internal::Type::Enum
|
3917
3841
|
|
@@ -3923,7 +3847,7 @@ module Orb
|
|
3923
3847
|
end
|
3924
3848
|
end
|
3925
3849
|
|
3926
|
-
# @see Orb::
|
3850
|
+
# @see Orb::PlanCreateParams::Price::UnitWithProration#invoicing_cycle_configuration
|
3927
3851
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
3928
3852
|
# @!attribute duration
|
3929
3853
|
# The duration of the billing period.
|
@@ -3934,9 +3858,11 @@ module Orb
|
|
3934
3858
|
# @!attribute duration_unit
|
3935
3859
|
# The unit of billing period duration.
|
3936
3860
|
#
|
3937
|
-
# @return [Symbol, Orb::
|
3861
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::UnitWithProration::InvoicingCycleConfiguration::DurationUnit]
|
3938
3862
|
required :duration_unit,
|
3939
|
-
enum: -> {
|
3863
|
+
enum: -> {
|
3864
|
+
Orb::PlanCreateParams::Price::UnitWithProration::InvoicingCycleConfiguration::DurationUnit
|
3865
|
+
}
|
3940
3866
|
|
3941
3867
|
# @!method initialize(duration:, duration_unit:)
|
3942
3868
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
@@ -3944,11 +3870,11 @@ module Orb
|
|
3944
3870
|
#
|
3945
3871
|
# @param duration [Integer] The duration of the billing period.
|
3946
3872
|
#
|
3947
|
-
# @param duration_unit [Symbol, Orb::
|
3873
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::UnitWithProration::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
3948
3874
|
|
3949
3875
|
# The unit of billing period duration.
|
3950
3876
|
#
|
3951
|
-
# @see Orb::
|
3877
|
+
# @see Orb::PlanCreateParams::Price::UnitWithProration::InvoicingCycleConfiguration#duration_unit
|
3952
3878
|
module DurationUnit
|
3953
3879
|
extend Orb::Internal::Type::Enum
|
3954
3880
|
|
@@ -3961,13 +3887,12 @@ module Orb
|
|
3961
3887
|
end
|
3962
3888
|
end
|
3963
3889
|
|
3964
|
-
class
|
3890
|
+
class GroupedAllocation < Orb::Internal::Type::BaseModel
|
3965
3891
|
# @!attribute cadence
|
3966
3892
|
# The cadence to bill for this price on.
|
3967
3893
|
#
|
3968
|
-
# @return [Symbol, Orb::
|
3969
|
-
required :cadence,
|
3970
|
-
enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanGroupedAllocationPrice::Cadence }
|
3894
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::GroupedAllocation::Cadence]
|
3895
|
+
required :cadence, enum: -> { Orb::PlanCreateParams::Price::GroupedAllocation::Cadence }
|
3971
3896
|
|
3972
3897
|
# @!attribute grouped_allocation_config
|
3973
3898
|
#
|
@@ -4009,9 +3934,9 @@ module Orb
|
|
4009
3934
|
# For custom cadence: specifies the duration of the billing period in days or
|
4010
3935
|
# months.
|
4011
3936
|
#
|
4012
|
-
# @return [Orb::
|
3937
|
+
# @return [Orb::PlanCreateParams::Price::GroupedAllocation::BillingCycleConfiguration, nil]
|
4013
3938
|
optional :billing_cycle_configuration,
|
4014
|
-
-> { Orb::
|
3939
|
+
-> { Orb::PlanCreateParams::Price::GroupedAllocation::BillingCycleConfiguration },
|
4015
3940
|
nil?: true
|
4016
3941
|
|
4017
3942
|
# @!attribute conversion_rate
|
@@ -4050,9 +3975,9 @@ module Orb
|
|
4050
3975
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
4051
3976
|
# If unspecified, a single invoice is produced per billing cycle.
|
4052
3977
|
#
|
4053
|
-
# @return [Orb::
|
3978
|
+
# @return [Orb::PlanCreateParams::Price::GroupedAllocation::InvoicingCycleConfiguration, nil]
|
4054
3979
|
optional :invoicing_cycle_configuration,
|
4055
|
-
-> { Orb::
|
3980
|
+
-> { Orb::PlanCreateParams::Price::GroupedAllocation::InvoicingCycleConfiguration },
|
4056
3981
|
nil?: true
|
4057
3982
|
|
4058
3983
|
# @!attribute metadata
|
@@ -4065,10 +3990,9 @@ module Orb
|
|
4065
3990
|
|
4066
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)
|
4067
3992
|
# Some parameter documentations has been truncated, see
|
4068
|
-
# {Orb::
|
4069
|
-
# details.
|
3993
|
+
# {Orb::PlanCreateParams::Price::GroupedAllocation} for more details.
|
4070
3994
|
#
|
4071
|
-
# @param cadence [Symbol, Orb::
|
3995
|
+
# @param cadence [Symbol, Orb::PlanCreateParams::Price::GroupedAllocation::Cadence] The cadence to bill for this price on.
|
4072
3996
|
#
|
4073
3997
|
# @param grouped_allocation_config [Hash{Symbol=>Object}]
|
4074
3998
|
#
|
@@ -4077,37 +4001,30 @@ module Orb
|
|
4077
4001
|
# @param name [String] The name of the price.
|
4078
4002
|
#
|
4079
4003
|
# @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b
|
4080
|
-
# ...
|
4081
4004
|
#
|
4082
4005
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
4083
|
-
# ...
|
4084
4006
|
#
|
4085
|
-
# @param billing_cycle_configuration [Orb::
|
4086
|
-
# ...
|
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
|
4087
4008
|
#
|
4088
4009
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
4089
4010
|
#
|
4090
4011
|
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
4091
|
-
# ...
|
4092
4012
|
#
|
4093
4013
|
# @param external_price_id [String, nil] An alias for the price.
|
4094
4014
|
#
|
4095
4015
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
4096
|
-
# ...
|
4097
4016
|
#
|
4098
4017
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
4099
4018
|
#
|
4100
|
-
# @param invoicing_cycle_configuration [Orb::
|
4101
|
-
# ...
|
4019
|
+
# @param invoicing_cycle_configuration [Orb::PlanCreateParams::Price::GroupedAllocation::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
4102
4020
|
#
|
4103
4021
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
4104
|
-
# ...
|
4105
4022
|
#
|
4106
4023
|
# @param model_type [Symbol, :grouped_allocation]
|
4107
4024
|
|
4108
4025
|
# The cadence to bill for this price on.
|
4109
4026
|
#
|
4110
|
-
# @see Orb::
|
4027
|
+
# @see Orb::PlanCreateParams::Price::GroupedAllocation#cadence
|
4111
4028
|
module Cadence
|
4112
4029
|
extend Orb::Internal::Type::Enum
|
4113
4030
|
|
@@ -4122,7 +4039,7 @@ module Orb
|
|
4122
4039
|
# @return [Array<Symbol>]
|
4123
4040
|
end
|
4124
4041
|
|
4125
|
-
# @see Orb::
|
4042
|
+
# @see Orb::PlanCreateParams::Price::GroupedAllocation#billing_cycle_configuration
|
4126
4043
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
4127
4044
|
# @!attribute duration
|
4128
4045
|
# The duration of the billing period.
|
@@ -4133,9 +4050,11 @@ module Orb
|
|
4133
4050
|
# @!attribute duration_unit
|
4134
4051
|
# The unit of billing period duration.
|
4135
4052
|
#
|
4136
|
-
# @return [Symbol, Orb::
|
4053
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::GroupedAllocation::BillingCycleConfiguration::DurationUnit]
|
4137
4054
|
required :duration_unit,
|
4138
|
-
enum: -> {
|
4055
|
+
enum: -> {
|
4056
|
+
Orb::PlanCreateParams::Price::GroupedAllocation::BillingCycleConfiguration::DurationUnit
|
4057
|
+
}
|
4139
4058
|
|
4140
4059
|
# @!method initialize(duration:, duration_unit:)
|
4141
4060
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -4143,11 +4062,11 @@ module Orb
|
|
4143
4062
|
#
|
4144
4063
|
# @param duration [Integer] The duration of the billing period.
|
4145
4064
|
#
|
4146
|
-
# @param duration_unit [Symbol, Orb::
|
4065
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::GroupedAllocation::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
4147
4066
|
|
4148
4067
|
# The unit of billing period duration.
|
4149
4068
|
#
|
4150
|
-
# @see Orb::
|
4069
|
+
# @see Orb::PlanCreateParams::Price::GroupedAllocation::BillingCycleConfiguration#duration_unit
|
4151
4070
|
module DurationUnit
|
4152
4071
|
extend Orb::Internal::Type::Enum
|
4153
4072
|
|
@@ -4159,7 +4078,7 @@ module Orb
|
|
4159
4078
|
end
|
4160
4079
|
end
|
4161
4080
|
|
4162
|
-
# @see Orb::
|
4081
|
+
# @see Orb::PlanCreateParams::Price::GroupedAllocation#invoicing_cycle_configuration
|
4163
4082
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
4164
4083
|
# @!attribute duration
|
4165
4084
|
# The duration of the billing period.
|
@@ -4170,9 +4089,11 @@ module Orb
|
|
4170
4089
|
# @!attribute duration_unit
|
4171
4090
|
# The unit of billing period duration.
|
4172
4091
|
#
|
4173
|
-
# @return [Symbol, Orb::
|
4092
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::GroupedAllocation::InvoicingCycleConfiguration::DurationUnit]
|
4174
4093
|
required :duration_unit,
|
4175
|
-
enum: -> {
|
4094
|
+
enum: -> {
|
4095
|
+
Orb::PlanCreateParams::Price::GroupedAllocation::InvoicingCycleConfiguration::DurationUnit
|
4096
|
+
}
|
4176
4097
|
|
4177
4098
|
# @!method initialize(duration:, duration_unit:)
|
4178
4099
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
@@ -4180,11 +4101,11 @@ module Orb
|
|
4180
4101
|
#
|
4181
4102
|
# @param duration [Integer] The duration of the billing period.
|
4182
4103
|
#
|
4183
|
-
# @param duration_unit [Symbol, Orb::
|
4104
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::GroupedAllocation::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
4184
4105
|
|
4185
4106
|
# The unit of billing period duration.
|
4186
4107
|
#
|
4187
|
-
# @see Orb::
|
4108
|
+
# @see Orb::PlanCreateParams::Price::GroupedAllocation::InvoicingCycleConfiguration#duration_unit
|
4188
4109
|
module DurationUnit
|
4189
4110
|
extend Orb::Internal::Type::Enum
|
4190
4111
|
|
@@ -4197,13 +4118,12 @@ module Orb
|
|
4197
4118
|
end
|
4198
4119
|
end
|
4199
4120
|
|
4200
|
-
class
|
4121
|
+
class GroupedWithProratedMinimum < Orb::Internal::Type::BaseModel
|
4201
4122
|
# @!attribute cadence
|
4202
4123
|
# The cadence to bill for this price on.
|
4203
4124
|
#
|
4204
|
-
# @return [Symbol, Orb::
|
4205
|
-
required :cadence,
|
4206
|
-
enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithProratedMinimumPrice::Cadence }
|
4125
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::GroupedWithProratedMinimum::Cadence]
|
4126
|
+
required :cadence, enum: -> { Orb::PlanCreateParams::Price::GroupedWithProratedMinimum::Cadence }
|
4207
4127
|
|
4208
4128
|
# @!attribute grouped_with_prorated_minimum_config
|
4209
4129
|
#
|
@@ -4246,9 +4166,9 @@ module Orb
|
|
4246
4166
|
# For custom cadence: specifies the duration of the billing period in days or
|
4247
4167
|
# months.
|
4248
4168
|
#
|
4249
|
-
# @return [Orb::
|
4169
|
+
# @return [Orb::PlanCreateParams::Price::GroupedWithProratedMinimum::BillingCycleConfiguration, nil]
|
4250
4170
|
optional :billing_cycle_configuration,
|
4251
|
-
-> { Orb::
|
4171
|
+
-> { Orb::PlanCreateParams::Price::GroupedWithProratedMinimum::BillingCycleConfiguration },
|
4252
4172
|
nil?: true
|
4253
4173
|
|
4254
4174
|
# @!attribute conversion_rate
|
@@ -4287,9 +4207,11 @@ module Orb
|
|
4287
4207
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
4288
4208
|
# If unspecified, a single invoice is produced per billing cycle.
|
4289
4209
|
#
|
4290
|
-
# @return [Orb::
|
4210
|
+
# @return [Orb::PlanCreateParams::Price::GroupedWithProratedMinimum::InvoicingCycleConfiguration, nil]
|
4291
4211
|
optional :invoicing_cycle_configuration,
|
4292
|
-
-> {
|
4212
|
+
-> {
|
4213
|
+
Orb::PlanCreateParams::Price::GroupedWithProratedMinimum::InvoicingCycleConfiguration
|
4214
|
+
},
|
4293
4215
|
nil?: true
|
4294
4216
|
|
4295
4217
|
# @!attribute metadata
|
@@ -4302,10 +4224,9 @@ module Orb
|
|
4302
4224
|
|
4303
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)
|
4304
4226
|
# Some parameter documentations has been truncated, see
|
4305
|
-
# {Orb::
|
4306
|
-
# for more details.
|
4227
|
+
# {Orb::PlanCreateParams::Price::GroupedWithProratedMinimum} for more details.
|
4307
4228
|
#
|
4308
|
-
# @param cadence [Symbol, Orb::
|
4229
|
+
# @param cadence [Symbol, Orb::PlanCreateParams::Price::GroupedWithProratedMinimum::Cadence] The cadence to bill for this price on.
|
4309
4230
|
#
|
4310
4231
|
# @param grouped_with_prorated_minimum_config [Hash{Symbol=>Object}]
|
4311
4232
|
#
|
@@ -4314,37 +4235,30 @@ module Orb
|
|
4314
4235
|
# @param name [String] The name of the price.
|
4315
4236
|
#
|
4316
4237
|
# @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b
|
4317
|
-
# ...
|
4318
4238
|
#
|
4319
4239
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
4320
|
-
# ...
|
4321
4240
|
#
|
4322
|
-
# @param billing_cycle_configuration [Orb::
|
4323
|
-
# ...
|
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
|
4324
4242
|
#
|
4325
4243
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
4326
4244
|
#
|
4327
4245
|
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
4328
|
-
# ...
|
4329
4246
|
#
|
4330
4247
|
# @param external_price_id [String, nil] An alias for the price.
|
4331
4248
|
#
|
4332
4249
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
4333
|
-
# ...
|
4334
4250
|
#
|
4335
4251
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
4336
4252
|
#
|
4337
|
-
# @param invoicing_cycle_configuration [Orb::
|
4338
|
-
# ...
|
4253
|
+
# @param invoicing_cycle_configuration [Orb::PlanCreateParams::Price::GroupedWithProratedMinimum::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
4339
4254
|
#
|
4340
4255
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
4341
|
-
# ...
|
4342
4256
|
#
|
4343
4257
|
# @param model_type [Symbol, :grouped_with_prorated_minimum]
|
4344
4258
|
|
4345
4259
|
# The cadence to bill for this price on.
|
4346
4260
|
#
|
4347
|
-
# @see Orb::
|
4261
|
+
# @see Orb::PlanCreateParams::Price::GroupedWithProratedMinimum#cadence
|
4348
4262
|
module Cadence
|
4349
4263
|
extend Orb::Internal::Type::Enum
|
4350
4264
|
|
@@ -4359,7 +4273,7 @@ module Orb
|
|
4359
4273
|
# @return [Array<Symbol>]
|
4360
4274
|
end
|
4361
4275
|
|
4362
|
-
# @see Orb::
|
4276
|
+
# @see Orb::PlanCreateParams::Price::GroupedWithProratedMinimum#billing_cycle_configuration
|
4363
4277
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
4364
4278
|
# @!attribute duration
|
4365
4279
|
# The duration of the billing period.
|
@@ -4370,9 +4284,11 @@ module Orb
|
|
4370
4284
|
# @!attribute duration_unit
|
4371
4285
|
# The unit of billing period duration.
|
4372
4286
|
#
|
4373
|
-
# @return [Symbol, Orb::
|
4287
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::GroupedWithProratedMinimum::BillingCycleConfiguration::DurationUnit]
|
4374
4288
|
required :duration_unit,
|
4375
|
-
enum: -> {
|
4289
|
+
enum: -> {
|
4290
|
+
Orb::PlanCreateParams::Price::GroupedWithProratedMinimum::BillingCycleConfiguration::DurationUnit
|
4291
|
+
}
|
4376
4292
|
|
4377
4293
|
# @!method initialize(duration:, duration_unit:)
|
4378
4294
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -4380,11 +4296,11 @@ module Orb
|
|
4380
4296
|
#
|
4381
4297
|
# @param duration [Integer] The duration of the billing period.
|
4382
4298
|
#
|
4383
|
-
# @param duration_unit [Symbol, Orb::
|
4299
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::GroupedWithProratedMinimum::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
4384
4300
|
|
4385
4301
|
# The unit of billing period duration.
|
4386
4302
|
#
|
4387
|
-
# @see Orb::
|
4303
|
+
# @see Orb::PlanCreateParams::Price::GroupedWithProratedMinimum::BillingCycleConfiguration#duration_unit
|
4388
4304
|
module DurationUnit
|
4389
4305
|
extend Orb::Internal::Type::Enum
|
4390
4306
|
|
@@ -4396,7 +4312,7 @@ module Orb
|
|
4396
4312
|
end
|
4397
4313
|
end
|
4398
4314
|
|
4399
|
-
# @see Orb::
|
4315
|
+
# @see Orb::PlanCreateParams::Price::GroupedWithProratedMinimum#invoicing_cycle_configuration
|
4400
4316
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
4401
4317
|
# @!attribute duration
|
4402
4318
|
# The duration of the billing period.
|
@@ -4407,9 +4323,11 @@ module Orb
|
|
4407
4323
|
# @!attribute duration_unit
|
4408
4324
|
# The unit of billing period duration.
|
4409
4325
|
#
|
4410
|
-
# @return [Symbol, Orb::
|
4326
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::GroupedWithProratedMinimum::InvoicingCycleConfiguration::DurationUnit]
|
4411
4327
|
required :duration_unit,
|
4412
|
-
enum: -> {
|
4328
|
+
enum: -> {
|
4329
|
+
Orb::PlanCreateParams::Price::GroupedWithProratedMinimum::InvoicingCycleConfiguration::DurationUnit
|
4330
|
+
}
|
4413
4331
|
|
4414
4332
|
# @!method initialize(duration:, duration_unit:)
|
4415
4333
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
@@ -4417,11 +4335,11 @@ module Orb
|
|
4417
4335
|
#
|
4418
4336
|
# @param duration [Integer] The duration of the billing period.
|
4419
4337
|
#
|
4420
|
-
# @param duration_unit [Symbol, Orb::
|
4338
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::GroupedWithProratedMinimum::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
4421
4339
|
|
4422
4340
|
# The unit of billing period duration.
|
4423
4341
|
#
|
4424
|
-
# @see Orb::
|
4342
|
+
# @see Orb::PlanCreateParams::Price::GroupedWithProratedMinimum::InvoicingCycleConfiguration#duration_unit
|
4425
4343
|
module DurationUnit
|
4426
4344
|
extend Orb::Internal::Type::Enum
|
4427
4345
|
|
@@ -4434,13 +4352,12 @@ module Orb
|
|
4434
4352
|
end
|
4435
4353
|
end
|
4436
4354
|
|
4437
|
-
class
|
4355
|
+
class GroupedWithMeteredMinimum < Orb::Internal::Type::BaseModel
|
4438
4356
|
# @!attribute cadence
|
4439
4357
|
# The cadence to bill for this price on.
|
4440
4358
|
#
|
4441
|
-
# @return [Symbol, Orb::
|
4442
|
-
required :cadence,
|
4443
|
-
enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithMeteredMinimumPrice::Cadence }
|
4359
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::GroupedWithMeteredMinimum::Cadence]
|
4360
|
+
required :cadence, enum: -> { Orb::PlanCreateParams::Price::GroupedWithMeteredMinimum::Cadence }
|
4444
4361
|
|
4445
4362
|
# @!attribute grouped_with_metered_minimum_config
|
4446
4363
|
#
|
@@ -4483,9 +4400,9 @@ module Orb
|
|
4483
4400
|
# For custom cadence: specifies the duration of the billing period in days or
|
4484
4401
|
# months.
|
4485
4402
|
#
|
4486
|
-
# @return [Orb::
|
4403
|
+
# @return [Orb::PlanCreateParams::Price::GroupedWithMeteredMinimum::BillingCycleConfiguration, nil]
|
4487
4404
|
optional :billing_cycle_configuration,
|
4488
|
-
-> { Orb::
|
4405
|
+
-> { Orb::PlanCreateParams::Price::GroupedWithMeteredMinimum::BillingCycleConfiguration },
|
4489
4406
|
nil?: true
|
4490
4407
|
|
4491
4408
|
# @!attribute conversion_rate
|
@@ -4524,9 +4441,11 @@ module Orb
|
|
4524
4441
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
4525
4442
|
# If unspecified, a single invoice is produced per billing cycle.
|
4526
4443
|
#
|
4527
|
-
# @return [Orb::
|
4444
|
+
# @return [Orb::PlanCreateParams::Price::GroupedWithMeteredMinimum::InvoicingCycleConfiguration, nil]
|
4528
4445
|
optional :invoicing_cycle_configuration,
|
4529
|
-
-> {
|
4446
|
+
-> {
|
4447
|
+
Orb::PlanCreateParams::Price::GroupedWithMeteredMinimum::InvoicingCycleConfiguration
|
4448
|
+
},
|
4530
4449
|
nil?: true
|
4531
4450
|
|
4532
4451
|
# @!attribute metadata
|
@@ -4539,10 +4458,9 @@ module Orb
|
|
4539
4458
|
|
4540
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)
|
4541
4460
|
# Some parameter documentations has been truncated, see
|
4542
|
-
# {Orb::
|
4543
|
-
# for more details.
|
4461
|
+
# {Orb::PlanCreateParams::Price::GroupedWithMeteredMinimum} for more details.
|
4544
4462
|
#
|
4545
|
-
# @param cadence [Symbol, Orb::
|
4463
|
+
# @param cadence [Symbol, Orb::PlanCreateParams::Price::GroupedWithMeteredMinimum::Cadence] The cadence to bill for this price on.
|
4546
4464
|
#
|
4547
4465
|
# @param grouped_with_metered_minimum_config [Hash{Symbol=>Object}]
|
4548
4466
|
#
|
@@ -4551,37 +4469,30 @@ module Orb
|
|
4551
4469
|
# @param name [String] The name of the price.
|
4552
4470
|
#
|
4553
4471
|
# @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b
|
4554
|
-
# ...
|
4555
4472
|
#
|
4556
4473
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
4557
|
-
# ...
|
4558
4474
|
#
|
4559
|
-
# @param billing_cycle_configuration [Orb::
|
4560
|
-
# ...
|
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
|
4561
4476
|
#
|
4562
4477
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
4563
4478
|
#
|
4564
4479
|
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
4565
|
-
# ...
|
4566
4480
|
#
|
4567
4481
|
# @param external_price_id [String, nil] An alias for the price.
|
4568
4482
|
#
|
4569
4483
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
4570
|
-
# ...
|
4571
4484
|
#
|
4572
4485
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
4573
4486
|
#
|
4574
|
-
# @param invoicing_cycle_configuration [Orb::
|
4575
|
-
# ...
|
4487
|
+
# @param invoicing_cycle_configuration [Orb::PlanCreateParams::Price::GroupedWithMeteredMinimum::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
4576
4488
|
#
|
4577
4489
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
4578
|
-
# ...
|
4579
4490
|
#
|
4580
4491
|
# @param model_type [Symbol, :grouped_with_metered_minimum]
|
4581
4492
|
|
4582
4493
|
# The cadence to bill for this price on.
|
4583
4494
|
#
|
4584
|
-
# @see Orb::
|
4495
|
+
# @see Orb::PlanCreateParams::Price::GroupedWithMeteredMinimum#cadence
|
4585
4496
|
module Cadence
|
4586
4497
|
extend Orb::Internal::Type::Enum
|
4587
4498
|
|
@@ -4596,7 +4507,7 @@ module Orb
|
|
4596
4507
|
# @return [Array<Symbol>]
|
4597
4508
|
end
|
4598
4509
|
|
4599
|
-
# @see Orb::
|
4510
|
+
# @see Orb::PlanCreateParams::Price::GroupedWithMeteredMinimum#billing_cycle_configuration
|
4600
4511
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
4601
4512
|
# @!attribute duration
|
4602
4513
|
# The duration of the billing period.
|
@@ -4607,9 +4518,11 @@ module Orb
|
|
4607
4518
|
# @!attribute duration_unit
|
4608
4519
|
# The unit of billing period duration.
|
4609
4520
|
#
|
4610
|
-
# @return [Symbol, Orb::
|
4521
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::GroupedWithMeteredMinimum::BillingCycleConfiguration::DurationUnit]
|
4611
4522
|
required :duration_unit,
|
4612
|
-
enum: -> {
|
4523
|
+
enum: -> {
|
4524
|
+
Orb::PlanCreateParams::Price::GroupedWithMeteredMinimum::BillingCycleConfiguration::DurationUnit
|
4525
|
+
}
|
4613
4526
|
|
4614
4527
|
# @!method initialize(duration:, duration_unit:)
|
4615
4528
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -4617,11 +4530,11 @@ module Orb
|
|
4617
4530
|
#
|
4618
4531
|
# @param duration [Integer] The duration of the billing period.
|
4619
4532
|
#
|
4620
|
-
# @param duration_unit [Symbol, Orb::
|
4533
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::GroupedWithMeteredMinimum::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
4621
4534
|
|
4622
4535
|
# The unit of billing period duration.
|
4623
4536
|
#
|
4624
|
-
# @see Orb::
|
4537
|
+
# @see Orb::PlanCreateParams::Price::GroupedWithMeteredMinimum::BillingCycleConfiguration#duration_unit
|
4625
4538
|
module DurationUnit
|
4626
4539
|
extend Orb::Internal::Type::Enum
|
4627
4540
|
|
@@ -4633,7 +4546,7 @@ module Orb
|
|
4633
4546
|
end
|
4634
4547
|
end
|
4635
4548
|
|
4636
|
-
# @see Orb::
|
4549
|
+
# @see Orb::PlanCreateParams::Price::GroupedWithMeteredMinimum#invoicing_cycle_configuration
|
4637
4550
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
4638
4551
|
# @!attribute duration
|
4639
4552
|
# The duration of the billing period.
|
@@ -4644,9 +4557,11 @@ module Orb
|
|
4644
4557
|
# @!attribute duration_unit
|
4645
4558
|
# The unit of billing period duration.
|
4646
4559
|
#
|
4647
|
-
# @return [Symbol, Orb::
|
4560
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::GroupedWithMeteredMinimum::InvoicingCycleConfiguration::DurationUnit]
|
4648
4561
|
required :duration_unit,
|
4649
|
-
enum: -> {
|
4562
|
+
enum: -> {
|
4563
|
+
Orb::PlanCreateParams::Price::GroupedWithMeteredMinimum::InvoicingCycleConfiguration::DurationUnit
|
4564
|
+
}
|
4650
4565
|
|
4651
4566
|
# @!method initialize(duration:, duration_unit:)
|
4652
4567
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
@@ -4654,11 +4569,11 @@ module Orb
|
|
4654
4569
|
#
|
4655
4570
|
# @param duration [Integer] The duration of the billing period.
|
4656
4571
|
#
|
4657
|
-
# @param duration_unit [Symbol, Orb::
|
4572
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::GroupedWithMeteredMinimum::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
4658
4573
|
|
4659
4574
|
# The unit of billing period duration.
|
4660
4575
|
#
|
4661
|
-
# @see Orb::
|
4576
|
+
# @see Orb::PlanCreateParams::Price::GroupedWithMeteredMinimum::InvoicingCycleConfiguration#duration_unit
|
4662
4577
|
module DurationUnit
|
4663
4578
|
extend Orb::Internal::Type::Enum
|
4664
4579
|
|
@@ -4671,13 +4586,12 @@ module Orb
|
|
4671
4586
|
end
|
4672
4587
|
end
|
4673
4588
|
|
4674
|
-
class
|
4589
|
+
class MatrixWithDisplayName < Orb::Internal::Type::BaseModel
|
4675
4590
|
# @!attribute cadence
|
4676
4591
|
# The cadence to bill for this price on.
|
4677
4592
|
#
|
4678
|
-
# @return [Symbol, Orb::
|
4679
|
-
required :cadence,
|
4680
|
-
enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanMatrixWithDisplayNamePrice::Cadence }
|
4593
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::MatrixWithDisplayName::Cadence]
|
4594
|
+
required :cadence, enum: -> { Orb::PlanCreateParams::Price::MatrixWithDisplayName::Cadence }
|
4681
4595
|
|
4682
4596
|
# @!attribute item_id
|
4683
4597
|
# The id of the item the price will be associated with.
|
@@ -4719,9 +4633,9 @@ module Orb
|
|
4719
4633
|
# For custom cadence: specifies the duration of the billing period in days or
|
4720
4634
|
# months.
|
4721
4635
|
#
|
4722
|
-
# @return [Orb::
|
4636
|
+
# @return [Orb::PlanCreateParams::Price::MatrixWithDisplayName::BillingCycleConfiguration, nil]
|
4723
4637
|
optional :billing_cycle_configuration,
|
4724
|
-
-> { Orb::
|
4638
|
+
-> { Orb::PlanCreateParams::Price::MatrixWithDisplayName::BillingCycleConfiguration },
|
4725
4639
|
nil?: true
|
4726
4640
|
|
4727
4641
|
# @!attribute conversion_rate
|
@@ -4760,9 +4674,9 @@ module Orb
|
|
4760
4674
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
4761
4675
|
# If unspecified, a single invoice is produced per billing cycle.
|
4762
4676
|
#
|
4763
|
-
# @return [Orb::
|
4677
|
+
# @return [Orb::PlanCreateParams::Price::MatrixWithDisplayName::InvoicingCycleConfiguration, nil]
|
4764
4678
|
optional :invoicing_cycle_configuration,
|
4765
|
-
-> { Orb::
|
4679
|
+
-> { Orb::PlanCreateParams::Price::MatrixWithDisplayName::InvoicingCycleConfiguration },
|
4766
4680
|
nil?: true
|
4767
4681
|
|
4768
4682
|
# @!attribute metadata
|
@@ -4775,10 +4689,9 @@ module Orb
|
|
4775
4689
|
|
4776
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)
|
4777
4691
|
# Some parameter documentations has been truncated, see
|
4778
|
-
# {Orb::
|
4779
|
-
# more details.
|
4692
|
+
# {Orb::PlanCreateParams::Price::MatrixWithDisplayName} for more details.
|
4780
4693
|
#
|
4781
|
-
# @param cadence [Symbol, Orb::
|
4694
|
+
# @param cadence [Symbol, Orb::PlanCreateParams::Price::MatrixWithDisplayName::Cadence] The cadence to bill for this price on.
|
4782
4695
|
#
|
4783
4696
|
# @param item_id [String] The id of the item the price will be associated with.
|
4784
4697
|
#
|
@@ -4787,37 +4700,30 @@ module Orb
|
|
4787
4700
|
# @param name [String] The name of the price.
|
4788
4701
|
#
|
4789
4702
|
# @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b
|
4790
|
-
# ...
|
4791
4703
|
#
|
4792
4704
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
4793
|
-
# ...
|
4794
4705
|
#
|
4795
|
-
# @param billing_cycle_configuration [Orb::
|
4796
|
-
# ...
|
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
|
4797
4707
|
#
|
4798
4708
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
4799
4709
|
#
|
4800
4710
|
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
4801
|
-
# ...
|
4802
4711
|
#
|
4803
4712
|
# @param external_price_id [String, nil] An alias for the price.
|
4804
4713
|
#
|
4805
4714
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
4806
|
-
# ...
|
4807
4715
|
#
|
4808
4716
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
4809
4717
|
#
|
4810
|
-
# @param invoicing_cycle_configuration [Orb::
|
4811
|
-
# ...
|
4718
|
+
# @param invoicing_cycle_configuration [Orb::PlanCreateParams::Price::MatrixWithDisplayName::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
4812
4719
|
#
|
4813
4720
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
4814
|
-
# ...
|
4815
4721
|
#
|
4816
4722
|
# @param model_type [Symbol, :matrix_with_display_name]
|
4817
4723
|
|
4818
4724
|
# The cadence to bill for this price on.
|
4819
4725
|
#
|
4820
|
-
# @see Orb::
|
4726
|
+
# @see Orb::PlanCreateParams::Price::MatrixWithDisplayName#cadence
|
4821
4727
|
module Cadence
|
4822
4728
|
extend Orb::Internal::Type::Enum
|
4823
4729
|
|
@@ -4832,7 +4738,7 @@ module Orb
|
|
4832
4738
|
# @return [Array<Symbol>]
|
4833
4739
|
end
|
4834
4740
|
|
4835
|
-
# @see Orb::
|
4741
|
+
# @see Orb::PlanCreateParams::Price::MatrixWithDisplayName#billing_cycle_configuration
|
4836
4742
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
4837
4743
|
# @!attribute duration
|
4838
4744
|
# The duration of the billing period.
|
@@ -4843,9 +4749,11 @@ module Orb
|
|
4843
4749
|
# @!attribute duration_unit
|
4844
4750
|
# The unit of billing period duration.
|
4845
4751
|
#
|
4846
|
-
# @return [Symbol, Orb::
|
4752
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::MatrixWithDisplayName::BillingCycleConfiguration::DurationUnit]
|
4847
4753
|
required :duration_unit,
|
4848
|
-
enum: -> {
|
4754
|
+
enum: -> {
|
4755
|
+
Orb::PlanCreateParams::Price::MatrixWithDisplayName::BillingCycleConfiguration::DurationUnit
|
4756
|
+
}
|
4849
4757
|
|
4850
4758
|
# @!method initialize(duration:, duration_unit:)
|
4851
4759
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -4853,11 +4761,11 @@ module Orb
|
|
4853
4761
|
#
|
4854
4762
|
# @param duration [Integer] The duration of the billing period.
|
4855
4763
|
#
|
4856
|
-
# @param duration_unit [Symbol, Orb::
|
4764
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::MatrixWithDisplayName::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
4857
4765
|
|
4858
4766
|
# The unit of billing period duration.
|
4859
4767
|
#
|
4860
|
-
# @see Orb::
|
4768
|
+
# @see Orb::PlanCreateParams::Price::MatrixWithDisplayName::BillingCycleConfiguration#duration_unit
|
4861
4769
|
module DurationUnit
|
4862
4770
|
extend Orb::Internal::Type::Enum
|
4863
4771
|
|
@@ -4869,7 +4777,7 @@ module Orb
|
|
4869
4777
|
end
|
4870
4778
|
end
|
4871
4779
|
|
4872
|
-
# @see Orb::
|
4780
|
+
# @see Orb::PlanCreateParams::Price::MatrixWithDisplayName#invoicing_cycle_configuration
|
4873
4781
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
4874
4782
|
# @!attribute duration
|
4875
4783
|
# The duration of the billing period.
|
@@ -4880,9 +4788,11 @@ module Orb
|
|
4880
4788
|
# @!attribute duration_unit
|
4881
4789
|
# The unit of billing period duration.
|
4882
4790
|
#
|
4883
|
-
# @return [Symbol, Orb::
|
4791
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::MatrixWithDisplayName::InvoicingCycleConfiguration::DurationUnit]
|
4884
4792
|
required :duration_unit,
|
4885
|
-
enum: -> {
|
4793
|
+
enum: -> {
|
4794
|
+
Orb::PlanCreateParams::Price::MatrixWithDisplayName::InvoicingCycleConfiguration::DurationUnit
|
4795
|
+
}
|
4886
4796
|
|
4887
4797
|
# @!method initialize(duration:, duration_unit:)
|
4888
4798
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
@@ -4890,11 +4800,11 @@ module Orb
|
|
4890
4800
|
#
|
4891
4801
|
# @param duration [Integer] The duration of the billing period.
|
4892
4802
|
#
|
4893
|
-
# @param duration_unit [Symbol, Orb::
|
4803
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::MatrixWithDisplayName::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
4894
4804
|
|
4895
4805
|
# The unit of billing period duration.
|
4896
4806
|
#
|
4897
|
-
# @see Orb::
|
4807
|
+
# @see Orb::PlanCreateParams::Price::MatrixWithDisplayName::InvoicingCycleConfiguration#duration_unit
|
4898
4808
|
module DurationUnit
|
4899
4809
|
extend Orb::Internal::Type::Enum
|
4900
4810
|
|
@@ -4907,7 +4817,7 @@ module Orb
|
|
4907
4817
|
end
|
4908
4818
|
end
|
4909
4819
|
|
4910
|
-
class
|
4820
|
+
class BulkWithProration < Orb::Internal::Type::BaseModel
|
4911
4821
|
# @!attribute bulk_with_proration_config
|
4912
4822
|
#
|
4913
4823
|
# @return [Hash{Symbol=>Object}]
|
@@ -4916,9 +4826,8 @@ module Orb
|
|
4916
4826
|
# @!attribute cadence
|
4917
4827
|
# The cadence to bill for this price on.
|
4918
4828
|
#
|
4919
|
-
# @return [Symbol, Orb::
|
4920
|
-
required :cadence,
|
4921
|
-
enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanBulkWithProrationPrice::Cadence }
|
4829
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::BulkWithProration::Cadence]
|
4830
|
+
required :cadence, enum: -> { Orb::PlanCreateParams::Price::BulkWithProration::Cadence }
|
4922
4831
|
|
4923
4832
|
# @!attribute item_id
|
4924
4833
|
# The id of the item the price will be associated with.
|
@@ -4955,9 +4864,9 @@ module Orb
|
|
4955
4864
|
# For custom cadence: specifies the duration of the billing period in days or
|
4956
4865
|
# months.
|
4957
4866
|
#
|
4958
|
-
# @return [Orb::
|
4867
|
+
# @return [Orb::PlanCreateParams::Price::BulkWithProration::BillingCycleConfiguration, nil]
|
4959
4868
|
optional :billing_cycle_configuration,
|
4960
|
-
-> { Orb::
|
4869
|
+
-> { Orb::PlanCreateParams::Price::BulkWithProration::BillingCycleConfiguration },
|
4961
4870
|
nil?: true
|
4962
4871
|
|
4963
4872
|
# @!attribute conversion_rate
|
@@ -4996,9 +4905,9 @@ module Orb
|
|
4996
4905
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
4997
4906
|
# If unspecified, a single invoice is produced per billing cycle.
|
4998
4907
|
#
|
4999
|
-
# @return [Orb::
|
4908
|
+
# @return [Orb::PlanCreateParams::Price::BulkWithProration::InvoicingCycleConfiguration, nil]
|
5000
4909
|
optional :invoicing_cycle_configuration,
|
5001
|
-
-> { Orb::
|
4910
|
+
-> { Orb::PlanCreateParams::Price::BulkWithProration::InvoicingCycleConfiguration },
|
5002
4911
|
nil?: true
|
5003
4912
|
|
5004
4913
|
# @!attribute metadata
|
@@ -5011,49 +4920,41 @@ module Orb
|
|
5011
4920
|
|
5012
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)
|
5013
4922
|
# Some parameter documentations has been truncated, see
|
5014
|
-
# {Orb::
|
5015
|
-
# details.
|
4923
|
+
# {Orb::PlanCreateParams::Price::BulkWithProration} for more details.
|
5016
4924
|
#
|
5017
4925
|
# @param bulk_with_proration_config [Hash{Symbol=>Object}]
|
5018
4926
|
#
|
5019
|
-
# @param cadence [Symbol, Orb::
|
4927
|
+
# @param cadence [Symbol, Orb::PlanCreateParams::Price::BulkWithProration::Cadence] The cadence to bill for this price on.
|
5020
4928
|
#
|
5021
4929
|
# @param item_id [String] The id of the item the price will be associated with.
|
5022
4930
|
#
|
5023
4931
|
# @param name [String] The name of the price.
|
5024
4932
|
#
|
5025
4933
|
# @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b
|
5026
|
-
# ...
|
5027
4934
|
#
|
5028
4935
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
5029
|
-
# ...
|
5030
4936
|
#
|
5031
|
-
# @param billing_cycle_configuration [Orb::
|
5032
|
-
# ...
|
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
|
5033
4938
|
#
|
5034
4939
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
5035
4940
|
#
|
5036
4941
|
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
5037
|
-
# ...
|
5038
4942
|
#
|
5039
4943
|
# @param external_price_id [String, nil] An alias for the price.
|
5040
4944
|
#
|
5041
4945
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
5042
|
-
# ...
|
5043
4946
|
#
|
5044
4947
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
5045
4948
|
#
|
5046
|
-
# @param invoicing_cycle_configuration [Orb::
|
5047
|
-
# ...
|
4949
|
+
# @param invoicing_cycle_configuration [Orb::PlanCreateParams::Price::BulkWithProration::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
5048
4950
|
#
|
5049
4951
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
5050
|
-
# ...
|
5051
4952
|
#
|
5052
4953
|
# @param model_type [Symbol, :bulk_with_proration]
|
5053
4954
|
|
5054
4955
|
# The cadence to bill for this price on.
|
5055
4956
|
#
|
5056
|
-
# @see Orb::
|
4957
|
+
# @see Orb::PlanCreateParams::Price::BulkWithProration#cadence
|
5057
4958
|
module Cadence
|
5058
4959
|
extend Orb::Internal::Type::Enum
|
5059
4960
|
|
@@ -5068,7 +4969,7 @@ module Orb
|
|
5068
4969
|
# @return [Array<Symbol>]
|
5069
4970
|
end
|
5070
4971
|
|
5071
|
-
# @see Orb::
|
4972
|
+
# @see Orb::PlanCreateParams::Price::BulkWithProration#billing_cycle_configuration
|
5072
4973
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
5073
4974
|
# @!attribute duration
|
5074
4975
|
# The duration of the billing period.
|
@@ -5079,9 +4980,11 @@ module Orb
|
|
5079
4980
|
# @!attribute duration_unit
|
5080
4981
|
# The unit of billing period duration.
|
5081
4982
|
#
|
5082
|
-
# @return [Symbol, Orb::
|
4983
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::BulkWithProration::BillingCycleConfiguration::DurationUnit]
|
5083
4984
|
required :duration_unit,
|
5084
|
-
enum: -> {
|
4985
|
+
enum: -> {
|
4986
|
+
Orb::PlanCreateParams::Price::BulkWithProration::BillingCycleConfiguration::DurationUnit
|
4987
|
+
}
|
5085
4988
|
|
5086
4989
|
# @!method initialize(duration:, duration_unit:)
|
5087
4990
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -5089,11 +4992,11 @@ module Orb
|
|
5089
4992
|
#
|
5090
4993
|
# @param duration [Integer] The duration of the billing period.
|
5091
4994
|
#
|
5092
|
-
# @param duration_unit [Symbol, Orb::
|
4995
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::BulkWithProration::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
5093
4996
|
|
5094
4997
|
# The unit of billing period duration.
|
5095
4998
|
#
|
5096
|
-
# @see Orb::
|
4999
|
+
# @see Orb::PlanCreateParams::Price::BulkWithProration::BillingCycleConfiguration#duration_unit
|
5097
5000
|
module DurationUnit
|
5098
5001
|
extend Orb::Internal::Type::Enum
|
5099
5002
|
|
@@ -5105,7 +5008,7 @@ module Orb
|
|
5105
5008
|
end
|
5106
5009
|
end
|
5107
5010
|
|
5108
|
-
# @see Orb::
|
5011
|
+
# @see Orb::PlanCreateParams::Price::BulkWithProration#invoicing_cycle_configuration
|
5109
5012
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
5110
5013
|
# @!attribute duration
|
5111
5014
|
# The duration of the billing period.
|
@@ -5116,9 +5019,11 @@ module Orb
|
|
5116
5019
|
# @!attribute duration_unit
|
5117
5020
|
# The unit of billing period duration.
|
5118
5021
|
#
|
5119
|
-
# @return [Symbol, Orb::
|
5022
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::BulkWithProration::InvoicingCycleConfiguration::DurationUnit]
|
5120
5023
|
required :duration_unit,
|
5121
|
-
enum: -> {
|
5024
|
+
enum: -> {
|
5025
|
+
Orb::PlanCreateParams::Price::BulkWithProration::InvoicingCycleConfiguration::DurationUnit
|
5026
|
+
}
|
5122
5027
|
|
5123
5028
|
# @!method initialize(duration:, duration_unit:)
|
5124
5029
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
@@ -5126,11 +5031,11 @@ module Orb
|
|
5126
5031
|
#
|
5127
5032
|
# @param duration [Integer] The duration of the billing period.
|
5128
5033
|
#
|
5129
|
-
# @param duration_unit [Symbol, Orb::
|
5034
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::BulkWithProration::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
5130
5035
|
|
5131
5036
|
# The unit of billing period duration.
|
5132
5037
|
#
|
5133
|
-
# @see Orb::
|
5038
|
+
# @see Orb::PlanCreateParams::Price::BulkWithProration::InvoicingCycleConfiguration#duration_unit
|
5134
5039
|
module DurationUnit
|
5135
5040
|
extend Orb::Internal::Type::Enum
|
5136
5041
|
|
@@ -5143,13 +5048,12 @@ module Orb
|
|
5143
5048
|
end
|
5144
5049
|
end
|
5145
5050
|
|
5146
|
-
class
|
5051
|
+
class GroupedTieredPackage < Orb::Internal::Type::BaseModel
|
5147
5052
|
# @!attribute cadence
|
5148
5053
|
# The cadence to bill for this price on.
|
5149
5054
|
#
|
5150
|
-
# @return [Symbol, Orb::
|
5151
|
-
required :cadence,
|
5152
|
-
enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanGroupedTieredPackagePrice::Cadence }
|
5055
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::GroupedTieredPackage::Cadence]
|
5056
|
+
required :cadence, enum: -> { Orb::PlanCreateParams::Price::GroupedTieredPackage::Cadence }
|
5153
5057
|
|
5154
5058
|
# @!attribute grouped_tiered_package_config
|
5155
5059
|
#
|
@@ -5191,9 +5095,9 @@ module Orb
|
|
5191
5095
|
# For custom cadence: specifies the duration of the billing period in days or
|
5192
5096
|
# months.
|
5193
5097
|
#
|
5194
|
-
# @return [Orb::
|
5098
|
+
# @return [Orb::PlanCreateParams::Price::GroupedTieredPackage::BillingCycleConfiguration, nil]
|
5195
5099
|
optional :billing_cycle_configuration,
|
5196
|
-
-> { Orb::
|
5100
|
+
-> { Orb::PlanCreateParams::Price::GroupedTieredPackage::BillingCycleConfiguration },
|
5197
5101
|
nil?: true
|
5198
5102
|
|
5199
5103
|
# @!attribute conversion_rate
|
@@ -5232,9 +5136,9 @@ module Orb
|
|
5232
5136
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
5233
5137
|
# If unspecified, a single invoice is produced per billing cycle.
|
5234
5138
|
#
|
5235
|
-
# @return [Orb::
|
5139
|
+
# @return [Orb::PlanCreateParams::Price::GroupedTieredPackage::InvoicingCycleConfiguration, nil]
|
5236
5140
|
optional :invoicing_cycle_configuration,
|
5237
|
-
-> { Orb::
|
5141
|
+
-> { Orb::PlanCreateParams::Price::GroupedTieredPackage::InvoicingCycleConfiguration },
|
5238
5142
|
nil?: true
|
5239
5143
|
|
5240
5144
|
# @!attribute metadata
|
@@ -5247,10 +5151,9 @@ module Orb
|
|
5247
5151
|
|
5248
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)
|
5249
5153
|
# Some parameter documentations has been truncated, see
|
5250
|
-
# {Orb::
|
5251
|
-
# more details.
|
5154
|
+
# {Orb::PlanCreateParams::Price::GroupedTieredPackage} for more details.
|
5252
5155
|
#
|
5253
|
-
# @param cadence [Symbol, Orb::
|
5156
|
+
# @param cadence [Symbol, Orb::PlanCreateParams::Price::GroupedTieredPackage::Cadence] The cadence to bill for this price on.
|
5254
5157
|
#
|
5255
5158
|
# @param grouped_tiered_package_config [Hash{Symbol=>Object}]
|
5256
5159
|
#
|
@@ -5259,37 +5162,30 @@ module Orb
|
|
5259
5162
|
# @param name [String] The name of the price.
|
5260
5163
|
#
|
5261
5164
|
# @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b
|
5262
|
-
# ...
|
5263
5165
|
#
|
5264
5166
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
5265
|
-
# ...
|
5266
5167
|
#
|
5267
|
-
# @param billing_cycle_configuration [Orb::
|
5268
|
-
# ...
|
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
|
5269
5169
|
#
|
5270
5170
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
5271
5171
|
#
|
5272
5172
|
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
5273
|
-
# ...
|
5274
5173
|
#
|
5275
5174
|
# @param external_price_id [String, nil] An alias for the price.
|
5276
5175
|
#
|
5277
5176
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
5278
|
-
# ...
|
5279
5177
|
#
|
5280
5178
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
5281
5179
|
#
|
5282
|
-
# @param invoicing_cycle_configuration [Orb::
|
5283
|
-
# ...
|
5180
|
+
# @param invoicing_cycle_configuration [Orb::PlanCreateParams::Price::GroupedTieredPackage::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
5284
5181
|
#
|
5285
5182
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
5286
|
-
# ...
|
5287
5183
|
#
|
5288
5184
|
# @param model_type [Symbol, :grouped_tiered_package]
|
5289
5185
|
|
5290
5186
|
# The cadence to bill for this price on.
|
5291
5187
|
#
|
5292
|
-
# @see Orb::
|
5188
|
+
# @see Orb::PlanCreateParams::Price::GroupedTieredPackage#cadence
|
5293
5189
|
module Cadence
|
5294
5190
|
extend Orb::Internal::Type::Enum
|
5295
5191
|
|
@@ -5304,7 +5200,7 @@ module Orb
|
|
5304
5200
|
# @return [Array<Symbol>]
|
5305
5201
|
end
|
5306
5202
|
|
5307
|
-
# @see Orb::
|
5203
|
+
# @see Orb::PlanCreateParams::Price::GroupedTieredPackage#billing_cycle_configuration
|
5308
5204
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
5309
5205
|
# @!attribute duration
|
5310
5206
|
# The duration of the billing period.
|
@@ -5315,9 +5211,11 @@ module Orb
|
|
5315
5211
|
# @!attribute duration_unit
|
5316
5212
|
# The unit of billing period duration.
|
5317
5213
|
#
|
5318
|
-
# @return [Symbol, Orb::
|
5214
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::GroupedTieredPackage::BillingCycleConfiguration::DurationUnit]
|
5319
5215
|
required :duration_unit,
|
5320
|
-
enum: -> {
|
5216
|
+
enum: -> {
|
5217
|
+
Orb::PlanCreateParams::Price::GroupedTieredPackage::BillingCycleConfiguration::DurationUnit
|
5218
|
+
}
|
5321
5219
|
|
5322
5220
|
# @!method initialize(duration:, duration_unit:)
|
5323
5221
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -5325,11 +5223,11 @@ module Orb
|
|
5325
5223
|
#
|
5326
5224
|
# @param duration [Integer] The duration of the billing period.
|
5327
5225
|
#
|
5328
|
-
# @param duration_unit [Symbol, Orb::
|
5226
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::GroupedTieredPackage::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
5329
5227
|
|
5330
5228
|
# The unit of billing period duration.
|
5331
5229
|
#
|
5332
|
-
# @see Orb::
|
5230
|
+
# @see Orb::PlanCreateParams::Price::GroupedTieredPackage::BillingCycleConfiguration#duration_unit
|
5333
5231
|
module DurationUnit
|
5334
5232
|
extend Orb::Internal::Type::Enum
|
5335
5233
|
|
@@ -5341,7 +5239,7 @@ module Orb
|
|
5341
5239
|
end
|
5342
5240
|
end
|
5343
5241
|
|
5344
|
-
# @see Orb::
|
5242
|
+
# @see Orb::PlanCreateParams::Price::GroupedTieredPackage#invoicing_cycle_configuration
|
5345
5243
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
5346
5244
|
# @!attribute duration
|
5347
5245
|
# The duration of the billing period.
|
@@ -5352,9 +5250,11 @@ module Orb
|
|
5352
5250
|
# @!attribute duration_unit
|
5353
5251
|
# The unit of billing period duration.
|
5354
5252
|
#
|
5355
|
-
# @return [Symbol, Orb::
|
5253
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::GroupedTieredPackage::InvoicingCycleConfiguration::DurationUnit]
|
5356
5254
|
required :duration_unit,
|
5357
|
-
enum: -> {
|
5255
|
+
enum: -> {
|
5256
|
+
Orb::PlanCreateParams::Price::GroupedTieredPackage::InvoicingCycleConfiguration::DurationUnit
|
5257
|
+
}
|
5358
5258
|
|
5359
5259
|
# @!method initialize(duration:, duration_unit:)
|
5360
5260
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
@@ -5362,11 +5262,11 @@ module Orb
|
|
5362
5262
|
#
|
5363
5263
|
# @param duration [Integer] The duration of the billing period.
|
5364
5264
|
#
|
5365
|
-
# @param duration_unit [Symbol, Orb::
|
5265
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::GroupedTieredPackage::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
5366
5266
|
|
5367
5267
|
# The unit of billing period duration.
|
5368
5268
|
#
|
5369
|
-
# @see Orb::
|
5269
|
+
# @see Orb::PlanCreateParams::Price::GroupedTieredPackage::InvoicingCycleConfiguration#duration_unit
|
5370
5270
|
module DurationUnit
|
5371
5271
|
extend Orb::Internal::Type::Enum
|
5372
5272
|
|
@@ -5379,13 +5279,12 @@ module Orb
|
|
5379
5279
|
end
|
5380
5280
|
end
|
5381
5281
|
|
5382
|
-
class
|
5282
|
+
class MaxGroupTieredPackage < Orb::Internal::Type::BaseModel
|
5383
5283
|
# @!attribute cadence
|
5384
5284
|
# The cadence to bill for this price on.
|
5385
5285
|
#
|
5386
|
-
# @return [Symbol, Orb::
|
5387
|
-
required :cadence,
|
5388
|
-
enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanMaxGroupTieredPackagePrice::Cadence }
|
5286
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::MaxGroupTieredPackage::Cadence]
|
5287
|
+
required :cadence, enum: -> { Orb::PlanCreateParams::Price::MaxGroupTieredPackage::Cadence }
|
5389
5288
|
|
5390
5289
|
# @!attribute item_id
|
5391
5290
|
# The id of the item the price will be associated with.
|
@@ -5427,9 +5326,9 @@ module Orb
|
|
5427
5326
|
# For custom cadence: specifies the duration of the billing period in days or
|
5428
5327
|
# months.
|
5429
5328
|
#
|
5430
|
-
# @return [Orb::
|
5329
|
+
# @return [Orb::PlanCreateParams::Price::MaxGroupTieredPackage::BillingCycleConfiguration, nil]
|
5431
5330
|
optional :billing_cycle_configuration,
|
5432
|
-
-> { Orb::
|
5331
|
+
-> { Orb::PlanCreateParams::Price::MaxGroupTieredPackage::BillingCycleConfiguration },
|
5433
5332
|
nil?: true
|
5434
5333
|
|
5435
5334
|
# @!attribute conversion_rate
|
@@ -5468,9 +5367,9 @@ module Orb
|
|
5468
5367
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
5469
5368
|
# If unspecified, a single invoice is produced per billing cycle.
|
5470
5369
|
#
|
5471
|
-
# @return [Orb::
|
5370
|
+
# @return [Orb::PlanCreateParams::Price::MaxGroupTieredPackage::InvoicingCycleConfiguration, nil]
|
5472
5371
|
optional :invoicing_cycle_configuration,
|
5473
|
-
-> { Orb::
|
5372
|
+
-> { Orb::PlanCreateParams::Price::MaxGroupTieredPackage::InvoicingCycleConfiguration },
|
5474
5373
|
nil?: true
|
5475
5374
|
|
5476
5375
|
# @!attribute metadata
|
@@ -5483,10 +5382,9 @@ module Orb
|
|
5483
5382
|
|
5484
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)
|
5485
5384
|
# Some parameter documentations has been truncated, see
|
5486
|
-
# {Orb::
|
5487
|
-
# more details.
|
5385
|
+
# {Orb::PlanCreateParams::Price::MaxGroupTieredPackage} for more details.
|
5488
5386
|
#
|
5489
|
-
# @param cadence [Symbol, Orb::
|
5387
|
+
# @param cadence [Symbol, Orb::PlanCreateParams::Price::MaxGroupTieredPackage::Cadence] The cadence to bill for this price on.
|
5490
5388
|
#
|
5491
5389
|
# @param item_id [String] The id of the item the price will be associated with.
|
5492
5390
|
#
|
@@ -5495,37 +5393,30 @@ module Orb
|
|
5495
5393
|
# @param name [String] The name of the price.
|
5496
5394
|
#
|
5497
5395
|
# @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b
|
5498
|
-
# ...
|
5499
5396
|
#
|
5500
5397
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
5501
|
-
# ...
|
5502
5398
|
#
|
5503
|
-
# @param billing_cycle_configuration [Orb::
|
5504
|
-
# ...
|
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
|
5505
5400
|
#
|
5506
5401
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
5507
5402
|
#
|
5508
5403
|
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
5509
|
-
# ...
|
5510
5404
|
#
|
5511
5405
|
# @param external_price_id [String, nil] An alias for the price.
|
5512
5406
|
#
|
5513
5407
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
5514
|
-
# ...
|
5515
5408
|
#
|
5516
5409
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
5517
5410
|
#
|
5518
|
-
# @param invoicing_cycle_configuration [Orb::
|
5519
|
-
# ...
|
5411
|
+
# @param invoicing_cycle_configuration [Orb::PlanCreateParams::Price::MaxGroupTieredPackage::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
5520
5412
|
#
|
5521
5413
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
5522
|
-
# ...
|
5523
5414
|
#
|
5524
5415
|
# @param model_type [Symbol, :max_group_tiered_package]
|
5525
5416
|
|
5526
5417
|
# The cadence to bill for this price on.
|
5527
5418
|
#
|
5528
|
-
# @see Orb::
|
5419
|
+
# @see Orb::PlanCreateParams::Price::MaxGroupTieredPackage#cadence
|
5529
5420
|
module Cadence
|
5530
5421
|
extend Orb::Internal::Type::Enum
|
5531
5422
|
|
@@ -5540,7 +5431,7 @@ module Orb
|
|
5540
5431
|
# @return [Array<Symbol>]
|
5541
5432
|
end
|
5542
5433
|
|
5543
|
-
# @see Orb::
|
5434
|
+
# @see Orb::PlanCreateParams::Price::MaxGroupTieredPackage#billing_cycle_configuration
|
5544
5435
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
5545
5436
|
# @!attribute duration
|
5546
5437
|
# The duration of the billing period.
|
@@ -5551,9 +5442,11 @@ module Orb
|
|
5551
5442
|
# @!attribute duration_unit
|
5552
5443
|
# The unit of billing period duration.
|
5553
5444
|
#
|
5554
|
-
# @return [Symbol, Orb::
|
5445
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::MaxGroupTieredPackage::BillingCycleConfiguration::DurationUnit]
|
5555
5446
|
required :duration_unit,
|
5556
|
-
enum: -> {
|
5447
|
+
enum: -> {
|
5448
|
+
Orb::PlanCreateParams::Price::MaxGroupTieredPackage::BillingCycleConfiguration::DurationUnit
|
5449
|
+
}
|
5557
5450
|
|
5558
5451
|
# @!method initialize(duration:, duration_unit:)
|
5559
5452
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -5561,11 +5454,11 @@ module Orb
|
|
5561
5454
|
#
|
5562
5455
|
# @param duration [Integer] The duration of the billing period.
|
5563
5456
|
#
|
5564
|
-
# @param duration_unit [Symbol, Orb::
|
5457
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::MaxGroupTieredPackage::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
5565
5458
|
|
5566
5459
|
# The unit of billing period duration.
|
5567
5460
|
#
|
5568
|
-
# @see Orb::
|
5461
|
+
# @see Orb::PlanCreateParams::Price::MaxGroupTieredPackage::BillingCycleConfiguration#duration_unit
|
5569
5462
|
module DurationUnit
|
5570
5463
|
extend Orb::Internal::Type::Enum
|
5571
5464
|
|
@@ -5577,7 +5470,7 @@ module Orb
|
|
5577
5470
|
end
|
5578
5471
|
end
|
5579
5472
|
|
5580
|
-
# @see Orb::
|
5473
|
+
# @see Orb::PlanCreateParams::Price::MaxGroupTieredPackage#invoicing_cycle_configuration
|
5581
5474
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
5582
5475
|
# @!attribute duration
|
5583
5476
|
# The duration of the billing period.
|
@@ -5588,9 +5481,11 @@ module Orb
|
|
5588
5481
|
# @!attribute duration_unit
|
5589
5482
|
# The unit of billing period duration.
|
5590
5483
|
#
|
5591
|
-
# @return [Symbol, Orb::
|
5484
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::MaxGroupTieredPackage::InvoicingCycleConfiguration::DurationUnit]
|
5592
5485
|
required :duration_unit,
|
5593
|
-
enum: -> {
|
5486
|
+
enum: -> {
|
5487
|
+
Orb::PlanCreateParams::Price::MaxGroupTieredPackage::InvoicingCycleConfiguration::DurationUnit
|
5488
|
+
}
|
5594
5489
|
|
5595
5490
|
# @!method initialize(duration:, duration_unit:)
|
5596
5491
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
@@ -5598,11 +5493,11 @@ module Orb
|
|
5598
5493
|
#
|
5599
5494
|
# @param duration [Integer] The duration of the billing period.
|
5600
5495
|
#
|
5601
|
-
# @param duration_unit [Symbol, Orb::
|
5496
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::MaxGroupTieredPackage::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
5602
5497
|
|
5603
5498
|
# The unit of billing period duration.
|
5604
5499
|
#
|
5605
|
-
# @see Orb::
|
5500
|
+
# @see Orb::PlanCreateParams::Price::MaxGroupTieredPackage::InvoicingCycleConfiguration#duration_unit
|
5606
5501
|
module DurationUnit
|
5607
5502
|
extend Orb::Internal::Type::Enum
|
5608
5503
|
|
@@ -5615,13 +5510,12 @@ module Orb
|
|
5615
5510
|
end
|
5616
5511
|
end
|
5617
5512
|
|
5618
|
-
class
|
5513
|
+
class ScalableMatrixWithUnitPricing < Orb::Internal::Type::BaseModel
|
5619
5514
|
# @!attribute cadence
|
5620
5515
|
# The cadence to bill for this price on.
|
5621
5516
|
#
|
5622
|
-
# @return [Symbol, Orb::
|
5623
|
-
required :cadence,
|
5624
|
-
enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithUnitPricingPrice::Cadence }
|
5517
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::ScalableMatrixWithUnitPricing::Cadence]
|
5518
|
+
required :cadence, enum: -> { Orb::PlanCreateParams::Price::ScalableMatrixWithUnitPricing::Cadence }
|
5625
5519
|
|
5626
5520
|
# @!attribute item_id
|
5627
5521
|
# The id of the item the price will be associated with.
|
@@ -5664,9 +5558,11 @@ module Orb
|
|
5664
5558
|
# For custom cadence: specifies the duration of the billing period in days or
|
5665
5559
|
# months.
|
5666
5560
|
#
|
5667
|
-
# @return [Orb::
|
5561
|
+
# @return [Orb::PlanCreateParams::Price::ScalableMatrixWithUnitPricing::BillingCycleConfiguration, nil]
|
5668
5562
|
optional :billing_cycle_configuration,
|
5669
|
-
-> {
|
5563
|
+
-> {
|
5564
|
+
Orb::PlanCreateParams::Price::ScalableMatrixWithUnitPricing::BillingCycleConfiguration
|
5565
|
+
},
|
5670
5566
|
nil?: true
|
5671
5567
|
|
5672
5568
|
# @!attribute conversion_rate
|
@@ -5705,9 +5601,11 @@ module Orb
|
|
5705
5601
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
5706
5602
|
# If unspecified, a single invoice is produced per billing cycle.
|
5707
5603
|
#
|
5708
|
-
# @return [Orb::
|
5604
|
+
# @return [Orb::PlanCreateParams::Price::ScalableMatrixWithUnitPricing::InvoicingCycleConfiguration, nil]
|
5709
5605
|
optional :invoicing_cycle_configuration,
|
5710
|
-
-> {
|
5606
|
+
-> {
|
5607
|
+
Orb::PlanCreateParams::Price::ScalableMatrixWithUnitPricing::InvoicingCycleConfiguration
|
5608
|
+
},
|
5711
5609
|
nil?: true
|
5712
5610
|
|
5713
5611
|
# @!attribute metadata
|
@@ -5720,10 +5618,9 @@ module Orb
|
|
5720
5618
|
|
5721
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)
|
5722
5620
|
# Some parameter documentations has been truncated, see
|
5723
|
-
# {Orb::
|
5724
|
-
# for more details.
|
5621
|
+
# {Orb::PlanCreateParams::Price::ScalableMatrixWithUnitPricing} for more details.
|
5725
5622
|
#
|
5726
|
-
# @param cadence [Symbol, Orb::
|
5623
|
+
# @param cadence [Symbol, Orb::PlanCreateParams::Price::ScalableMatrixWithUnitPricing::Cadence] The cadence to bill for this price on.
|
5727
5624
|
#
|
5728
5625
|
# @param item_id [String] The id of the item the price will be associated with.
|
5729
5626
|
#
|
@@ -5732,37 +5629,30 @@ module Orb
|
|
5732
5629
|
# @param scalable_matrix_with_unit_pricing_config [Hash{Symbol=>Object}]
|
5733
5630
|
#
|
5734
5631
|
# @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b
|
5735
|
-
# ...
|
5736
5632
|
#
|
5737
5633
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
5738
|
-
# ...
|
5739
5634
|
#
|
5740
|
-
# @param billing_cycle_configuration [Orb::
|
5741
|
-
# ...
|
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
|
5742
5636
|
#
|
5743
5637
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
5744
5638
|
#
|
5745
5639
|
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
5746
|
-
# ...
|
5747
5640
|
#
|
5748
5641
|
# @param external_price_id [String, nil] An alias for the price.
|
5749
5642
|
#
|
5750
5643
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
5751
|
-
# ...
|
5752
5644
|
#
|
5753
5645
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
5754
5646
|
#
|
5755
|
-
# @param invoicing_cycle_configuration [Orb::
|
5756
|
-
# ...
|
5647
|
+
# @param invoicing_cycle_configuration [Orb::PlanCreateParams::Price::ScalableMatrixWithUnitPricing::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
5757
5648
|
#
|
5758
5649
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
5759
|
-
# ...
|
5760
5650
|
#
|
5761
5651
|
# @param model_type [Symbol, :scalable_matrix_with_unit_pricing]
|
5762
5652
|
|
5763
5653
|
# The cadence to bill for this price on.
|
5764
5654
|
#
|
5765
|
-
# @see Orb::
|
5655
|
+
# @see Orb::PlanCreateParams::Price::ScalableMatrixWithUnitPricing#cadence
|
5766
5656
|
module Cadence
|
5767
5657
|
extend Orb::Internal::Type::Enum
|
5768
5658
|
|
@@ -5777,7 +5667,7 @@ module Orb
|
|
5777
5667
|
# @return [Array<Symbol>]
|
5778
5668
|
end
|
5779
5669
|
|
5780
|
-
# @see Orb::
|
5670
|
+
# @see Orb::PlanCreateParams::Price::ScalableMatrixWithUnitPricing#billing_cycle_configuration
|
5781
5671
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
5782
5672
|
# @!attribute duration
|
5783
5673
|
# The duration of the billing period.
|
@@ -5788,9 +5678,11 @@ module Orb
|
|
5788
5678
|
# @!attribute duration_unit
|
5789
5679
|
# The unit of billing period duration.
|
5790
5680
|
#
|
5791
|
-
# @return [Symbol, Orb::
|
5681
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::ScalableMatrixWithUnitPricing::BillingCycleConfiguration::DurationUnit]
|
5792
5682
|
required :duration_unit,
|
5793
|
-
enum: -> {
|
5683
|
+
enum: -> {
|
5684
|
+
Orb::PlanCreateParams::Price::ScalableMatrixWithUnitPricing::BillingCycleConfiguration::DurationUnit
|
5685
|
+
}
|
5794
5686
|
|
5795
5687
|
# @!method initialize(duration:, duration_unit:)
|
5796
5688
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -5798,11 +5690,11 @@ module Orb
|
|
5798
5690
|
#
|
5799
5691
|
# @param duration [Integer] The duration of the billing period.
|
5800
5692
|
#
|
5801
|
-
# @param duration_unit [Symbol, Orb::
|
5693
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::ScalableMatrixWithUnitPricing::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
5802
5694
|
|
5803
5695
|
# The unit of billing period duration.
|
5804
5696
|
#
|
5805
|
-
# @see Orb::
|
5697
|
+
# @see Orb::PlanCreateParams::Price::ScalableMatrixWithUnitPricing::BillingCycleConfiguration#duration_unit
|
5806
5698
|
module DurationUnit
|
5807
5699
|
extend Orb::Internal::Type::Enum
|
5808
5700
|
|
@@ -5814,7 +5706,7 @@ module Orb
|
|
5814
5706
|
end
|
5815
5707
|
end
|
5816
5708
|
|
5817
|
-
# @see Orb::
|
5709
|
+
# @see Orb::PlanCreateParams::Price::ScalableMatrixWithUnitPricing#invoicing_cycle_configuration
|
5818
5710
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
5819
5711
|
# @!attribute duration
|
5820
5712
|
# The duration of the billing period.
|
@@ -5825,9 +5717,11 @@ module Orb
|
|
5825
5717
|
# @!attribute duration_unit
|
5826
5718
|
# The unit of billing period duration.
|
5827
5719
|
#
|
5828
|
-
# @return [Symbol, Orb::
|
5720
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::ScalableMatrixWithUnitPricing::InvoicingCycleConfiguration::DurationUnit]
|
5829
5721
|
required :duration_unit,
|
5830
|
-
enum: -> {
|
5722
|
+
enum: -> {
|
5723
|
+
Orb::PlanCreateParams::Price::ScalableMatrixWithUnitPricing::InvoicingCycleConfiguration::DurationUnit
|
5724
|
+
}
|
5831
5725
|
|
5832
5726
|
# @!method initialize(duration:, duration_unit:)
|
5833
5727
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
@@ -5835,11 +5729,11 @@ module Orb
|
|
5835
5729
|
#
|
5836
5730
|
# @param duration [Integer] The duration of the billing period.
|
5837
5731
|
#
|
5838
|
-
# @param duration_unit [Symbol, Orb::
|
5732
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::ScalableMatrixWithUnitPricing::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
5839
5733
|
|
5840
5734
|
# The unit of billing period duration.
|
5841
5735
|
#
|
5842
|
-
# @see Orb::
|
5736
|
+
# @see Orb::PlanCreateParams::Price::ScalableMatrixWithUnitPricing::InvoicingCycleConfiguration#duration_unit
|
5843
5737
|
module DurationUnit
|
5844
5738
|
extend Orb::Internal::Type::Enum
|
5845
5739
|
|
@@ -5852,13 +5746,15 @@ module Orb
|
|
5852
5746
|
end
|
5853
5747
|
end
|
5854
5748
|
|
5855
|
-
class
|
5749
|
+
class ScalableMatrixWithTieredPricing < Orb::Internal::Type::BaseModel
|
5856
5750
|
# @!attribute cadence
|
5857
5751
|
# The cadence to bill for this price on.
|
5858
5752
|
#
|
5859
|
-
# @return [Symbol, Orb::
|
5753
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::ScalableMatrixWithTieredPricing::Cadence]
|
5860
5754
|
required :cadence,
|
5861
|
-
enum: -> {
|
5755
|
+
enum: -> {
|
5756
|
+
Orb::PlanCreateParams::Price::ScalableMatrixWithTieredPricing::Cadence
|
5757
|
+
}
|
5862
5758
|
|
5863
5759
|
# @!attribute item_id
|
5864
5760
|
# The id of the item the price will be associated with.
|
@@ -5901,9 +5797,11 @@ module Orb
|
|
5901
5797
|
# For custom cadence: specifies the duration of the billing period in days or
|
5902
5798
|
# months.
|
5903
5799
|
#
|
5904
|
-
# @return [Orb::
|
5800
|
+
# @return [Orb::PlanCreateParams::Price::ScalableMatrixWithTieredPricing::BillingCycleConfiguration, nil]
|
5905
5801
|
optional :billing_cycle_configuration,
|
5906
|
-
-> {
|
5802
|
+
-> {
|
5803
|
+
Orb::PlanCreateParams::Price::ScalableMatrixWithTieredPricing::BillingCycleConfiguration
|
5804
|
+
},
|
5907
5805
|
nil?: true
|
5908
5806
|
|
5909
5807
|
# @!attribute conversion_rate
|
@@ -5942,9 +5840,11 @@ module Orb
|
|
5942
5840
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
5943
5841
|
# If unspecified, a single invoice is produced per billing cycle.
|
5944
5842
|
#
|
5945
|
-
# @return [Orb::
|
5843
|
+
# @return [Orb::PlanCreateParams::Price::ScalableMatrixWithTieredPricing::InvoicingCycleConfiguration, nil]
|
5946
5844
|
optional :invoicing_cycle_configuration,
|
5947
|
-
-> {
|
5845
|
+
-> {
|
5846
|
+
Orb::PlanCreateParams::Price::ScalableMatrixWithTieredPricing::InvoicingCycleConfiguration
|
5847
|
+
},
|
5948
5848
|
nil?: true
|
5949
5849
|
|
5950
5850
|
# @!attribute metadata
|
@@ -5957,10 +5857,10 @@ module Orb
|
|
5957
5857
|
|
5958
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)
|
5959
5859
|
# Some parameter documentations has been truncated, see
|
5960
|
-
# {Orb::
|
5961
|
-
#
|
5860
|
+
# {Orb::PlanCreateParams::Price::ScalableMatrixWithTieredPricing} for more
|
5861
|
+
# details.
|
5962
5862
|
#
|
5963
|
-
# @param cadence [Symbol, Orb::
|
5863
|
+
# @param cadence [Symbol, Orb::PlanCreateParams::Price::ScalableMatrixWithTieredPricing::Cadence] The cadence to bill for this price on.
|
5964
5864
|
#
|
5965
5865
|
# @param item_id [String] The id of the item the price will be associated with.
|
5966
5866
|
#
|
@@ -5969,37 +5869,30 @@ module Orb
|
|
5969
5869
|
# @param scalable_matrix_with_tiered_pricing_config [Hash{Symbol=>Object}]
|
5970
5870
|
#
|
5971
5871
|
# @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b
|
5972
|
-
# ...
|
5973
5872
|
#
|
5974
5873
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
5975
|
-
# ...
|
5976
5874
|
#
|
5977
|
-
# @param billing_cycle_configuration [Orb::
|
5978
|
-
# ...
|
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
|
5979
5876
|
#
|
5980
5877
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
5981
5878
|
#
|
5982
5879
|
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
5983
|
-
# ...
|
5984
5880
|
#
|
5985
5881
|
# @param external_price_id [String, nil] An alias for the price.
|
5986
5882
|
#
|
5987
5883
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
5988
|
-
# ...
|
5989
5884
|
#
|
5990
5885
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
5991
5886
|
#
|
5992
|
-
# @param invoicing_cycle_configuration [Orb::
|
5993
|
-
# ...
|
5887
|
+
# @param invoicing_cycle_configuration [Orb::PlanCreateParams::Price::ScalableMatrixWithTieredPricing::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
5994
5888
|
#
|
5995
5889
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
5996
|
-
# ...
|
5997
5890
|
#
|
5998
5891
|
# @param model_type [Symbol, :scalable_matrix_with_tiered_pricing]
|
5999
5892
|
|
6000
5893
|
# The cadence to bill for this price on.
|
6001
5894
|
#
|
6002
|
-
# @see Orb::
|
5895
|
+
# @see Orb::PlanCreateParams::Price::ScalableMatrixWithTieredPricing#cadence
|
6003
5896
|
module Cadence
|
6004
5897
|
extend Orb::Internal::Type::Enum
|
6005
5898
|
|
@@ -6014,7 +5907,7 @@ module Orb
|
|
6014
5907
|
# @return [Array<Symbol>]
|
6015
5908
|
end
|
6016
5909
|
|
6017
|
-
# @see Orb::
|
5910
|
+
# @see Orb::PlanCreateParams::Price::ScalableMatrixWithTieredPricing#billing_cycle_configuration
|
6018
5911
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
6019
5912
|
# @!attribute duration
|
6020
5913
|
# The duration of the billing period.
|
@@ -6025,9 +5918,11 @@ module Orb
|
|
6025
5918
|
# @!attribute duration_unit
|
6026
5919
|
# The unit of billing period duration.
|
6027
5920
|
#
|
6028
|
-
# @return [Symbol, Orb::
|
5921
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::ScalableMatrixWithTieredPricing::BillingCycleConfiguration::DurationUnit]
|
6029
5922
|
required :duration_unit,
|
6030
|
-
enum: -> {
|
5923
|
+
enum: -> {
|
5924
|
+
Orb::PlanCreateParams::Price::ScalableMatrixWithTieredPricing::BillingCycleConfiguration::DurationUnit
|
5925
|
+
}
|
6031
5926
|
|
6032
5927
|
# @!method initialize(duration:, duration_unit:)
|
6033
5928
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -6035,11 +5930,11 @@ module Orb
|
|
6035
5930
|
#
|
6036
5931
|
# @param duration [Integer] The duration of the billing period.
|
6037
5932
|
#
|
6038
|
-
# @param duration_unit [Symbol, Orb::
|
5933
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::ScalableMatrixWithTieredPricing::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
6039
5934
|
|
6040
5935
|
# The unit of billing period duration.
|
6041
5936
|
#
|
6042
|
-
# @see Orb::
|
5937
|
+
# @see Orb::PlanCreateParams::Price::ScalableMatrixWithTieredPricing::BillingCycleConfiguration#duration_unit
|
6043
5938
|
module DurationUnit
|
6044
5939
|
extend Orb::Internal::Type::Enum
|
6045
5940
|
|
@@ -6051,7 +5946,7 @@ module Orb
|
|
6051
5946
|
end
|
6052
5947
|
end
|
6053
5948
|
|
6054
|
-
# @see Orb::
|
5949
|
+
# @see Orb::PlanCreateParams::Price::ScalableMatrixWithTieredPricing#invoicing_cycle_configuration
|
6055
5950
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
6056
5951
|
# @!attribute duration
|
6057
5952
|
# The duration of the billing period.
|
@@ -6062,9 +5957,11 @@ module Orb
|
|
6062
5957
|
# @!attribute duration_unit
|
6063
5958
|
# The unit of billing period duration.
|
6064
5959
|
#
|
6065
|
-
# @return [Symbol, Orb::
|
5960
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::ScalableMatrixWithTieredPricing::InvoicingCycleConfiguration::DurationUnit]
|
6066
5961
|
required :duration_unit,
|
6067
|
-
enum: -> {
|
5962
|
+
enum: -> {
|
5963
|
+
Orb::PlanCreateParams::Price::ScalableMatrixWithTieredPricing::InvoicingCycleConfiguration::DurationUnit
|
5964
|
+
}
|
6068
5965
|
|
6069
5966
|
# @!method initialize(duration:, duration_unit:)
|
6070
5967
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
@@ -6072,11 +5969,11 @@ module Orb
|
|
6072
5969
|
#
|
6073
5970
|
# @param duration [Integer] The duration of the billing period.
|
6074
5971
|
#
|
6075
|
-
# @param duration_unit [Symbol, Orb::
|
5972
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::ScalableMatrixWithTieredPricing::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
6076
5973
|
|
6077
5974
|
# The unit of billing period duration.
|
6078
5975
|
#
|
6079
|
-
# @see Orb::
|
5976
|
+
# @see Orb::PlanCreateParams::Price::ScalableMatrixWithTieredPricing::InvoicingCycleConfiguration#duration_unit
|
6080
5977
|
module DurationUnit
|
6081
5978
|
extend Orb::Internal::Type::Enum
|
6082
5979
|
|
@@ -6089,13 +5986,12 @@ module Orb
|
|
6089
5986
|
end
|
6090
5987
|
end
|
6091
5988
|
|
6092
|
-
class
|
5989
|
+
class CumulativeGroupedBulk < Orb::Internal::Type::BaseModel
|
6093
5990
|
# @!attribute cadence
|
6094
5991
|
# The cadence to bill for this price on.
|
6095
5992
|
#
|
6096
|
-
# @return [Symbol, Orb::
|
6097
|
-
required :cadence,
|
6098
|
-
enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanCumulativeGroupedBulkPrice::Cadence }
|
5993
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::CumulativeGroupedBulk::Cadence]
|
5994
|
+
required :cadence, enum: -> { Orb::PlanCreateParams::Price::CumulativeGroupedBulk::Cadence }
|
6099
5995
|
|
6100
5996
|
# @!attribute cumulative_grouped_bulk_config
|
6101
5997
|
#
|
@@ -6137,9 +6033,9 @@ module Orb
|
|
6137
6033
|
# For custom cadence: specifies the duration of the billing period in days or
|
6138
6034
|
# months.
|
6139
6035
|
#
|
6140
|
-
# @return [Orb::
|
6036
|
+
# @return [Orb::PlanCreateParams::Price::CumulativeGroupedBulk::BillingCycleConfiguration, nil]
|
6141
6037
|
optional :billing_cycle_configuration,
|
6142
|
-
-> { Orb::
|
6038
|
+
-> { Orb::PlanCreateParams::Price::CumulativeGroupedBulk::BillingCycleConfiguration },
|
6143
6039
|
nil?: true
|
6144
6040
|
|
6145
6041
|
# @!attribute conversion_rate
|
@@ -6178,9 +6074,9 @@ module Orb
|
|
6178
6074
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
6179
6075
|
# If unspecified, a single invoice is produced per billing cycle.
|
6180
6076
|
#
|
6181
|
-
# @return [Orb::
|
6077
|
+
# @return [Orb::PlanCreateParams::Price::CumulativeGroupedBulk::InvoicingCycleConfiguration, nil]
|
6182
6078
|
optional :invoicing_cycle_configuration,
|
6183
|
-
-> { Orb::
|
6079
|
+
-> { Orb::PlanCreateParams::Price::CumulativeGroupedBulk::InvoicingCycleConfiguration },
|
6184
6080
|
nil?: true
|
6185
6081
|
|
6186
6082
|
# @!attribute metadata
|
@@ -6193,10 +6089,9 @@ module Orb
|
|
6193
6089
|
|
6194
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)
|
6195
6091
|
# Some parameter documentations has been truncated, see
|
6196
|
-
# {Orb::
|
6197
|
-
# more details.
|
6092
|
+
# {Orb::PlanCreateParams::Price::CumulativeGroupedBulk} for more details.
|
6198
6093
|
#
|
6199
|
-
# @param cadence [Symbol, Orb::
|
6094
|
+
# @param cadence [Symbol, Orb::PlanCreateParams::Price::CumulativeGroupedBulk::Cadence] The cadence to bill for this price on.
|
6200
6095
|
#
|
6201
6096
|
# @param cumulative_grouped_bulk_config [Hash{Symbol=>Object}]
|
6202
6097
|
#
|
@@ -6205,37 +6100,30 @@ module Orb
|
|
6205
6100
|
# @param name [String] The name of the price.
|
6206
6101
|
#
|
6207
6102
|
# @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b
|
6208
|
-
# ...
|
6209
6103
|
#
|
6210
6104
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
6211
|
-
# ...
|
6212
6105
|
#
|
6213
|
-
# @param billing_cycle_configuration [Orb::
|
6214
|
-
# ...
|
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
|
6215
6107
|
#
|
6216
6108
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
6217
6109
|
#
|
6218
6110
|
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
6219
|
-
# ...
|
6220
6111
|
#
|
6221
6112
|
# @param external_price_id [String, nil] An alias for the price.
|
6222
6113
|
#
|
6223
6114
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
6224
|
-
# ...
|
6225
6115
|
#
|
6226
6116
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
6227
6117
|
#
|
6228
|
-
# @param invoicing_cycle_configuration [Orb::
|
6229
|
-
# ...
|
6118
|
+
# @param invoicing_cycle_configuration [Orb::PlanCreateParams::Price::CumulativeGroupedBulk::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
6230
6119
|
#
|
6231
6120
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
6232
|
-
# ...
|
6233
6121
|
#
|
6234
6122
|
# @param model_type [Symbol, :cumulative_grouped_bulk]
|
6235
6123
|
|
6236
6124
|
# The cadence to bill for this price on.
|
6237
6125
|
#
|
6238
|
-
# @see Orb::
|
6126
|
+
# @see Orb::PlanCreateParams::Price::CumulativeGroupedBulk#cadence
|
6239
6127
|
module Cadence
|
6240
6128
|
extend Orb::Internal::Type::Enum
|
6241
6129
|
|
@@ -6250,7 +6138,7 @@ module Orb
|
|
6250
6138
|
# @return [Array<Symbol>]
|
6251
6139
|
end
|
6252
6140
|
|
6253
|
-
# @see Orb::
|
6141
|
+
# @see Orb::PlanCreateParams::Price::CumulativeGroupedBulk#billing_cycle_configuration
|
6254
6142
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
6255
6143
|
# @!attribute duration
|
6256
6144
|
# The duration of the billing period.
|
@@ -6261,9 +6149,11 @@ module Orb
|
|
6261
6149
|
# @!attribute duration_unit
|
6262
6150
|
# The unit of billing period duration.
|
6263
6151
|
#
|
6264
|
-
# @return [Symbol, Orb::
|
6152
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::CumulativeGroupedBulk::BillingCycleConfiguration::DurationUnit]
|
6265
6153
|
required :duration_unit,
|
6266
|
-
enum: -> {
|
6154
|
+
enum: -> {
|
6155
|
+
Orb::PlanCreateParams::Price::CumulativeGroupedBulk::BillingCycleConfiguration::DurationUnit
|
6156
|
+
}
|
6267
6157
|
|
6268
6158
|
# @!method initialize(duration:, duration_unit:)
|
6269
6159
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -6271,11 +6161,11 @@ module Orb
|
|
6271
6161
|
#
|
6272
6162
|
# @param duration [Integer] The duration of the billing period.
|
6273
6163
|
#
|
6274
|
-
# @param duration_unit [Symbol, Orb::
|
6164
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::CumulativeGroupedBulk::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
6275
6165
|
|
6276
6166
|
# The unit of billing period duration.
|
6277
6167
|
#
|
6278
|
-
# @see Orb::
|
6168
|
+
# @see Orb::PlanCreateParams::Price::CumulativeGroupedBulk::BillingCycleConfiguration#duration_unit
|
6279
6169
|
module DurationUnit
|
6280
6170
|
extend Orb::Internal::Type::Enum
|
6281
6171
|
|
@@ -6287,7 +6177,7 @@ module Orb
|
|
6287
6177
|
end
|
6288
6178
|
end
|
6289
6179
|
|
6290
|
-
# @see Orb::
|
6180
|
+
# @see Orb::PlanCreateParams::Price::CumulativeGroupedBulk#invoicing_cycle_configuration
|
6291
6181
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
6292
6182
|
# @!attribute duration
|
6293
6183
|
# The duration of the billing period.
|
@@ -6298,9 +6188,11 @@ module Orb
|
|
6298
6188
|
# @!attribute duration_unit
|
6299
6189
|
# The unit of billing period duration.
|
6300
6190
|
#
|
6301
|
-
# @return [Symbol, Orb::
|
6191
|
+
# @return [Symbol, Orb::PlanCreateParams::Price::CumulativeGroupedBulk::InvoicingCycleConfiguration::DurationUnit]
|
6302
6192
|
required :duration_unit,
|
6303
|
-
enum: -> {
|
6193
|
+
enum: -> {
|
6194
|
+
Orb::PlanCreateParams::Price::CumulativeGroupedBulk::InvoicingCycleConfiguration::DurationUnit
|
6195
|
+
}
|
6304
6196
|
|
6305
6197
|
# @!method initialize(duration:, duration_unit:)
|
6306
6198
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
@@ -6308,11 +6200,11 @@ module Orb
|
|
6308
6200
|
#
|
6309
6201
|
# @param duration [Integer] The duration of the billing period.
|
6310
6202
|
#
|
6311
|
-
# @param duration_unit [Symbol, Orb::
|
6203
|
+
# @param duration_unit [Symbol, Orb::PlanCreateParams::Price::CumulativeGroupedBulk::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
6312
6204
|
|
6313
6205
|
# The unit of billing period duration.
|
6314
6206
|
#
|
6315
|
-
# @see Orb::
|
6207
|
+
# @see Orb::PlanCreateParams::Price::CumulativeGroupedBulk::InvoicingCycleConfiguration#duration_unit
|
6316
6208
|
module DurationUnit
|
6317
6209
|
extend Orb::Internal::Type::Enum
|
6318
6210
|
|
@@ -6326,7 +6218,7 @@ module Orb
|
|
6326
6218
|
end
|
6327
6219
|
|
6328
6220
|
# @!method self.variants
|
6329
|
-
# @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)]
|
6330
6222
|
end
|
6331
6223
|
|
6332
6224
|
# The status of the plan to create (either active or draft). If not specified,
|