orb-billing 0.1.3 → 0.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.ignore +2 -0
- data/CHANGELOG.md +65 -0
- data/README.md +61 -51
- data/lib/orb/client.rb +7 -6
- data/lib/orb/file_part.rb +55 -0
- data/lib/orb/internal/page.rb +37 -39
- data/lib/orb/internal/transport/base_client.rb +21 -11
- data/lib/orb/internal/transport/pooled_net_requester.rb +3 -3
- data/lib/orb/internal/type/array_of.rb +28 -2
- data/lib/orb/internal/type/base_model.rb +83 -21
- data/lib/orb/internal/type/base_page.rb +10 -1
- data/lib/orb/internal/type/boolean.rb +6 -0
- data/lib/orb/internal/type/converter.rb +28 -1
- data/lib/orb/internal/type/enum.rb +28 -8
- data/lib/orb/internal/type/{io_like.rb → file_input.rb} +35 -15
- data/lib/orb/internal/type/hash_of.rb +28 -2
- data/lib/orb/internal/type/request_parameters.rb +1 -2
- data/lib/orb/internal/type/union.rb +27 -4
- data/lib/orb/internal/type/unknown.rb +6 -0
- data/lib/orb/internal/util.rb +105 -70
- data/lib/orb/internal.rb +5 -2
- data/lib/orb/models/alert.rb +68 -71
- data/lib/orb/models/alert_create_for_customer_params.rb +20 -25
- data/lib/orb/models/alert_create_for_external_customer_params.rb +20 -25
- data/lib/orb/models/alert_create_for_subscription_params.rb +20 -25
- data/lib/orb/models/alert_disable_params.rb +5 -9
- data/lib/orb/models/alert_enable_params.rb +5 -9
- data/lib/orb/models/alert_list_params.rb +26 -36
- data/lib/orb/models/alert_retrieve_params.rb +3 -8
- data/lib/orb/models/alert_update_params.rb +14 -18
- data/lib/orb/models/amount_discount.rb +14 -14
- data/lib/orb/models/billable_metric.rb +23 -20
- data/lib/orb/models/billing_cycle_relative_date.rb +2 -5
- data/lib/orb/models/coupon.rb +28 -21
- data/lib/orb/models/coupon_archive_params.rb +3 -8
- data/lib/orb/models/coupon_create_params.rb +24 -29
- data/lib/orb/models/coupon_fetch_params.rb +3 -8
- data/lib/orb/models/coupon_list_params.rb +17 -17
- data/lib/orb/models/coupons/subscription_list_params.rb +12 -15
- data/lib/orb/models/credit_note.rb +100 -166
- data/lib/orb/models/credit_note_create_params.rb +15 -23
- data/lib/orb/models/credit_note_fetch_params.rb +3 -8
- data/lib/orb/models/credit_note_list_params.rb +20 -30
- data/lib/orb/models/customer.rb +224 -271
- data/lib/orb/models/customer_create_params.rb +211 -252
- data/lib/orb/models/customer_delete_params.rb +3 -8
- data/lib/orb/models/customer_fetch_by_external_id_params.rb +3 -8
- data/lib/orb/models/customer_fetch_params.rb +3 -8
- data/lib/orb/models/customer_list_params.rb +20 -30
- data/lib/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rb +3 -8
- data/lib/orb/models/customer_sync_payment_methods_from_gateway_params.rb +3 -8
- data/lib/orb/models/customer_update_by_external_id_params.rb +207 -250
- data/lib/orb/models/customer_update_params.rb +207 -250
- data/lib/orb/models/customers/balance_transaction_create_params.rb +11 -16
- data/lib/orb/models/customers/balance_transaction_create_response.rb +33 -51
- data/lib/orb/models/customers/balance_transaction_list_params.rb +20 -30
- data/lib/orb/models/customers/balance_transaction_list_response.rb +33 -51
- data/lib/orb/models/customers/cost_list_by_external_id_params.rb +17 -17
- data/lib/orb/models/customers/cost_list_by_external_id_response.rb +22 -26
- data/lib/orb/models/customers/cost_list_params.rb +17 -17
- data/lib/orb/models/customers/cost_list_response.rb +22 -26
- data/lib/orb/models/customers/credit_list_by_external_id_params.rb +18 -22
- data/lib/orb/models/customers/credit_list_by_external_id_response.rb +10 -17
- data/lib/orb/models/customers/credit_list_params.rb +18 -22
- data/lib/orb/models/customers/credit_list_response.rb +10 -17
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +64 -66
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +300 -406
- data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +63 -66
- data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +300 -406
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +33 -48
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +300 -406
- data/lib/orb/models/customers/credits/ledger_list_params.rb +32 -48
- data/lib/orb/models/customers/credits/ledger_list_response.rb +300 -406
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +47 -50
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb +43 -46
- data/lib/orb/models/customers/credits/top_up_create_params.rb +46 -50
- data/lib/orb/models/customers/credits/top_up_create_response.rb +42 -46
- data/lib/orb/models/customers/credits/top_up_delete_by_external_id_params.rb +4 -9
- data/lib/orb/models/customers/credits/top_up_delete_params.rb +4 -9
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rb +12 -15
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb +43 -46
- data/lib/orb/models/customers/credits/top_up_list_params.rb +12 -15
- data/lib/orb/models/customers/credits/top_up_list_response.rb +42 -46
- data/lib/orb/models/dimensional_price_group.rb +21 -15
- data/lib/orb/models/dimensional_price_group_create_params.rb +17 -23
- data/lib/orb/models/dimensional_price_group_list_params.rb +12 -15
- data/lib/orb/models/dimensional_price_group_retrieve_params.rb +3 -8
- data/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rb +3 -8
- data/lib/orb/models/dimensional_price_groups.rb +3 -7
- data/lib/orb/models/discount.rb +2 -3
- data/lib/orb/models/evaluate_price_group.rb +8 -11
- data/lib/orb/models/event_deprecate_params.rb +3 -8
- data/lib/orb/models/event_deprecate_response.rb +2 -6
- data/lib/orb/models/event_ingest_params.rb +33 -27
- data/lib/orb/models/event_ingest_response.rb +23 -24
- data/lib/orb/models/event_search_params.rb +15 -11
- data/lib/orb/models/event_search_response.rb +27 -22
- data/lib/orb/models/event_update_params.rb +19 -13
- data/lib/orb/models/event_update_response.rb +2 -6
- data/lib/orb/models/events/backfill_close_params.rb +3 -8
- data/lib/orb/models/events/backfill_close_response.rb +34 -39
- data/lib/orb/models/events/backfill_create_params.rb +28 -32
- data/lib/orb/models/events/backfill_create_response.rb +34 -39
- data/lib/orb/models/events/backfill_fetch_params.rb +3 -8
- data/lib/orb/models/events/backfill_fetch_response.rb +34 -39
- data/lib/orb/models/events/backfill_list_params.rb +12 -15
- data/lib/orb/models/events/backfill_list_response.rb +34 -39
- data/lib/orb/models/events/backfill_revert_params.rb +3 -8
- data/lib/orb/models/events/backfill_revert_response.rb +34 -39
- data/lib/orb/models/events/event_volumes.rb +11 -17
- data/lib/orb/models/events/volume_list_params.rb +19 -22
- data/lib/orb/models/invoice.rb +589 -637
- data/lib/orb/models/invoice_create_params.rb +52 -61
- data/lib/orb/models/invoice_fetch_params.rb +3 -8
- data/lib/orb/models/invoice_fetch_upcoming_params.rb +4 -9
- data/lib/orb/models/invoice_fetch_upcoming_response.rb +584 -631
- data/lib/orb/models/invoice_issue_params.rb +10 -14
- data/lib/orb/models/invoice_level_discount.rb +2 -3
- data/lib/orb/models/invoice_line_item_create_params.rb +19 -14
- data/lib/orb/models/invoice_line_item_create_response.rb +247 -269
- data/lib/orb/models/invoice_list_params.rb +51 -66
- data/lib/orb/models/invoice_mark_paid_params.rb +9 -11
- data/lib/orb/models/invoice_pay_params.rb +3 -8
- data/lib/orb/models/invoice_update_params.rb +9 -9
- data/lib/orb/models/invoice_void_params.rb +3 -8
- data/lib/orb/models/item.rb +14 -25
- data/lib/orb/models/item_create_params.rb +5 -9
- data/lib/orb/models/item_fetch_params.rb +3 -8
- data/lib/orb/models/item_list_params.rb +12 -15
- data/lib/orb/models/item_update_params.rb +10 -22
- data/lib/orb/models/metric_create_params.rb +17 -13
- data/lib/orb/models/metric_fetch_params.rb +3 -8
- data/lib/orb/models/metric_list_params.rb +20 -30
- data/lib/orb/models/metric_update_params.rb +9 -9
- data/lib/orb/models/pagination_metadata.rb +3 -7
- data/lib/orb/models/percentage_discount.rb +15 -14
- data/lib/orb/models/plan.rb +250 -279
- data/lib/orb/models/plan_create_params.rb +1623 -1984
- data/lib/orb/models/plan_fetch_params.rb +3 -8
- data/lib/orb/models/plan_list_params.rb +25 -42
- data/lib/orb/models/plan_update_params.rb +12 -10
- data/lib/orb/models/plans/external_plan_id_fetch_params.rb +3 -8
- data/lib/orb/models/plans/external_plan_id_update_params.rb +12 -10
- data/lib/orb/models/price.rb +2709 -3820
- data/lib/orb/models/price_create_params.rb +203 -244
- data/lib/orb/models/price_evaluate_params.rb +21 -30
- data/lib/orb/models/price_evaluate_response.rb +2 -6
- data/lib/orb/models/price_fetch_params.rb +3 -8
- data/lib/orb/models/price_list_params.rb +12 -15
- data/lib/orb/models/price_update_params.rb +9 -9
- data/lib/orb/models/prices/external_price_id_fetch_params.rb +3 -8
- data/lib/orb/models/prices/external_price_id_update_params.rb +9 -9
- data/lib/orb/models/subscription.rb +343 -382
- data/lib/orb/models/subscription_cancel_params.rb +16 -16
- data/lib/orb/models/subscription_cancel_response.rb +339 -377
- data/lib/orb/models/subscription_change_apply_params.rb +7 -10
- data/lib/orb/models/subscription_change_apply_response.rb +365 -398
- data/lib/orb/models/subscription_change_cancel_params.rb +3 -8
- data/lib/orb/models/subscription_change_cancel_response.rb +365 -398
- data/lib/orb/models/subscription_change_retrieve_params.rb +3 -8
- data/lib/orb/models/subscription_change_retrieve_response.rb +366 -398
- data/lib/orb/models/subscription_create_params.rb +3771 -4402
- data/lib/orb/models/subscription_create_response.rb +339 -377
- data/lib/orb/models/subscription_fetch_costs_params.rb +17 -17
- data/lib/orb/models/subscription_fetch_costs_response.rb +22 -26
- data/lib/orb/models/subscription_fetch_params.rb +3 -8
- data/lib/orb/models/subscription_fetch_schedule_params.rb +20 -30
- data/lib/orb/models/subscription_fetch_schedule_response.rb +15 -17
- data/lib/orb/models/subscription_fetch_usage_params.rb +32 -43
- data/lib/orb/models/subscription_list_params.rb +28 -41
- data/lib/orb/models/subscription_price_intervals_params.rb +2018 -2472
- data/lib/orb/models/subscription_price_intervals_response.rb +342 -377
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +3764 -4392
- data/lib/orb/models/subscription_schedule_plan_change_response.rb +342 -377
- data/lib/orb/models/subscription_trigger_phase_params.rb +12 -10
- data/lib/orb/models/subscription_trigger_phase_response.rb +341 -377
- data/lib/orb/models/subscription_unschedule_cancellation_params.rb +3 -8
- data/lib/orb/models/subscription_unschedule_cancellation_response.rb +342 -377
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rb +5 -9
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +343 -377
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_params.rb +3 -8
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +343 -377
- data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +22 -33
- data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +342 -377
- data/lib/orb/models/subscription_update_params.rb +21 -23
- data/lib/orb/models/subscription_update_trial_params.rb +15 -18
- data/lib/orb/models/subscription_update_trial_response.rb +341 -377
- data/lib/orb/models/subscription_usage.rb +37 -80
- data/lib/orb/models/subscriptions.rb +3 -7
- data/lib/orb/models/top_level_ping_params.rb +3 -8
- data/lib/orb/models/top_level_ping_response.rb +2 -6
- data/lib/orb/models/trial_discount.rb +16 -24
- data/lib/orb/models/usage_discount.rb +15 -14
- data/lib/orb/request_options.rb +3 -4
- data/lib/orb/resources/alerts.rb +48 -17
- data/lib/orb/resources/coupons/subscriptions.rb +9 -2
- data/lib/orb/resources/coupons.rb +25 -7
- data/lib/orb/resources/credit_notes.rb +17 -4
- data/lib/orb/resources/customers/balance_transactions.rb +18 -3
- data/lib/orb/resources/customers/costs.rb +26 -8
- data/lib/orb/resources/customers/credits/ledger.rb +108 -28
- data/lib/orb/resources/customers/credits/top_ups.rb +67 -20
- data/lib/orb/resources/customers/credits.rb +28 -8
- data/lib/orb/resources/customers.rb +135 -36
- data/lib/orb/resources/dimensional_price_groups.rb +19 -4
- data/lib/orb/resources/events/backfills.rb +32 -9
- data/lib/orb/resources/events/volume.rb +14 -4
- data/lib/orb/resources/events.rb +40 -11
- data/lib/orb/resources/invoice_line_items.rb +16 -6
- data/lib/orb/resources/invoices.rb +77 -17
- data/lib/orb/resources/items.rb +10 -3
- data/lib/orb/resources/metrics.rb +33 -8
- data/lib/orb/resources/plans/external_plan_id.rb +10 -2
- data/lib/orb/resources/plans.rb +47 -11
- data/lib/orb/resources/prices/external_price_id.rb +7 -1
- data/lib/orb/resources/prices.rb +97 -22
- data/lib/orb/resources/subscription_changes.rb +5 -2
- data/lib/orb/resources/subscriptions.rb +292 -78
- data/lib/orb/version.rb +1 -1
- data/lib/orb.rb +2 -10
- data/rbi/lib/orb/client.rbi +7 -6
- data/rbi/lib/orb/file_part.rbi +34 -0
- data/rbi/lib/orb/internal/page.rbi +1 -0
- data/rbi/lib/orb/internal/transport/base_client.rbi +18 -3
- data/rbi/lib/orb/internal/type/array_of.rbi +15 -9
- data/rbi/lib/orb/internal/type/base_model.rbi +22 -0
- data/rbi/lib/orb/internal/type/base_page.rbi +2 -0
- data/rbi/lib/orb/internal/type/boolean.rbi +4 -5
- data/rbi/lib/orb/internal/type/converter.rbi +8 -0
- data/rbi/lib/orb/internal/type/enum.rbi +7 -6
- data/rbi/lib/orb/internal/type/{io_like.rbi → file_input.rbi} +9 -7
- data/rbi/lib/orb/internal/type/hash_of.rbi +15 -9
- data/rbi/lib/orb/internal/type/union.rbi +7 -0
- data/rbi/lib/orb/internal/type/unknown.rbi +4 -5
- data/rbi/lib/orb/internal/util.rbi +39 -19
- data/rbi/lib/orb/internal.rbi +1 -2
- data/rbi/lib/orb/models/alert.rbi +28 -8
- data/rbi/lib/orb/models/alert_create_for_customer_params.rbi +16 -6
- data/rbi/lib/orb/models/alert_create_for_external_customer_params.rbi +16 -6
- data/rbi/lib/orb/models/alert_create_for_subscription_params.rbi +16 -6
- data/rbi/lib/orb/models/alert_disable_params.rbi +5 -2
- data/rbi/lib/orb/models/alert_enable_params.rbi +5 -2
- data/rbi/lib/orb/models/alert_list_params.rbi +6 -0
- data/rbi/lib/orb/models/alert_update_params.rbi +11 -4
- data/rbi/lib/orb/models/amount_discount.rbi +10 -4
- data/rbi/lib/orb/models/billable_metric.rbi +16 -3
- data/rbi/lib/orb/models/billing_cycle_relative_date.rbi +1 -1
- data/rbi/lib/orb/models/coupon.rbi +10 -3
- data/rbi/lib/orb/models/coupon_create_params.rbi +6 -3
- data/rbi/lib/orb/models/coupon_list_params.rbi +13 -3
- data/rbi/lib/orb/models/coupons/subscription_list_params.rbi +8 -2
- data/rbi/lib/orb/models/credit_note.rbi +44 -12
- data/rbi/lib/orb/models/credit_note_create_params.rbi +15 -6
- data/rbi/lib/orb/models/credit_note_list_params.rbi +3 -0
- data/rbi/lib/orb/models/customer.rbi +130 -11
- data/rbi/lib/orb/models/customer_create_params.rbi +142 -8
- data/rbi/lib/orb/models/customer_list_params.rbi +3 -0
- data/rbi/lib/orb/models/customer_update_by_external_id_params.rbi +140 -8
- data/rbi/lib/orb/models/customer_update_params.rbi +140 -8
- data/rbi/lib/orb/models/customers/balance_transaction_create_params.rbi +8 -4
- data/rbi/lib/orb/models/customers/balance_transaction_create_response.rbi +18 -8
- data/rbi/lib/orb/models/customers/balance_transaction_list_params.rbi +3 -0
- data/rbi/lib/orb/models/customers/balance_transaction_list_response.rbi +18 -8
- data/rbi/lib/orb/models/customers/cost_list_by_external_id_params.rbi +9 -5
- data/rbi/lib/orb/models/customers/cost_list_by_external_id_response.rbi +21 -4
- data/rbi/lib/orb/models/customers/cost_list_params.rbi +9 -5
- data/rbi/lib/orb/models/customers/cost_list_response.rbi +21 -4
- data/rbi/lib/orb/models/customers/credit_list_by_external_id_params.rbi +13 -3
- data/rbi/lib/orb/models/customers/credit_list_by_external_id_response.rbi +1 -2
- data/rbi/lib/orb/models/customers/credit_list_params.rbi +13 -3
- data/rbi/lib/orb/models/customers/credit_list_response.rbi +1 -2
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +40 -18
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi +35 -56
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_params.rbi +40 -6
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_response.rbi +35 -56
- data/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rbi +6 -16
- data/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rbi +35 -56
- data/rbi/lib/orb/models/customers/credits/ledger_list_params.rbi +6 -4
- data/rbi/lib/orb/models/customers/credits/ledger_list_response.rbi +35 -56
- data/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rbi +27 -10
- data/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rbi +25 -10
- data/rbi/lib/orb/models/customers/credits/top_up_create_params.rbi +27 -4
- data/rbi/lib/orb/models/customers/credits/top_up_create_response.rbi +25 -10
- data/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rbi +8 -2
- data/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rbi +25 -10
- data/rbi/lib/orb/models/customers/credits/top_up_list_params.rbi +8 -2
- data/rbi/lib/orb/models/customers/credits/top_up_list_response.rbi +25 -4
- data/rbi/lib/orb/models/dimensional_price_group.rbi +11 -3
- data/rbi/lib/orb/models/dimensional_price_group_create_params.rbi +4 -0
- data/rbi/lib/orb/models/dimensional_price_group_list_params.rbi +8 -2
- data/rbi/lib/orb/models/evaluate_price_group.rbi +8 -2
- data/rbi/lib/orb/models/event_deprecate_response.rbi +4 -2
- data/rbi/lib/orb/models/event_ingest_params.rbi +22 -5
- data/rbi/lib/orb/models/event_ingest_response.rbi +15 -4
- data/rbi/lib/orb/models/event_search_params.rbi +14 -2
- data/rbi/lib/orb/models/event_search_response.rbi +14 -3
- data/rbi/lib/orb/models/event_update_params.rbi +10 -3
- data/rbi/lib/orb/models/event_update_response.rbi +4 -2
- data/rbi/lib/orb/models/events/backfill_close_response.rbi +14 -2
- data/rbi/lib/orb/models/events/backfill_create_params.rbi +18 -0
- data/rbi/lib/orb/models/events/backfill_create_response.rbi +14 -2
- data/rbi/lib/orb/models/events/backfill_fetch_response.rbi +14 -2
- data/rbi/lib/orb/models/events/backfill_list_params.rbi +8 -2
- data/rbi/lib/orb/models/events/backfill_list_response.rbi +14 -2
- data/rbi/lib/orb/models/events/backfill_revert_response.rbi +14 -2
- data/rbi/lib/orb/models/events/event_volumes.rbi +6 -2
- data/rbi/lib/orb/models/events/volume_list_params.rbi +18 -2
- data/rbi/lib/orb/models/invoice.rbi +375 -46
- data/rbi/lib/orb/models/invoice_create_params.rbi +38 -6
- data/rbi/lib/orb/models/invoice_fetch_upcoming_response.rbi +375 -66
- data/rbi/lib/orb/models/invoice_issue_params.rbi +9 -2
- data/rbi/lib/orb/models/invoice_line_item_create_params.rbi +16 -2
- data/rbi/lib/orb/models/invoice_line_item_create_response.rbi +141 -20
- data/rbi/lib/orb/models/invoice_list_params.rbi +9 -2
- data/rbi/lib/orb/models/invoice_mark_paid_params.rbi +9 -2
- data/rbi/lib/orb/models/invoice_update_params.rbi +7 -2
- data/rbi/lib/orb/models/item.rbi +1 -2
- data/rbi/lib/orb/models/item_create_params.rbi +5 -2
- data/rbi/lib/orb/models/item_list_params.rbi +8 -2
- data/rbi/lib/orb/models/item_update_params.rbi +1 -8
- data/rbi/lib/orb/models/metric_create_params.rbi +15 -2
- data/rbi/lib/orb/models/metric_list_params.rbi +3 -0
- data/rbi/lib/orb/models/metric_update_params.rbi +7 -2
- data/rbi/lib/orb/models/percentage_discount.rbi +11 -4
- data/rbi/lib/orb/models/plan.rbi +102 -15
- data/rbi/lib/orb/models/plan_create_params.rbi +997 -679
- data/rbi/lib/orb/models/plan_list_params.rbi +5 -1
- data/rbi/lib/orb/models/plan_update_params.rbi +11 -2
- data/rbi/lib/orb/models/plans/external_plan_id_update_params.rbi +11 -2
- data/rbi/lib/orb/models/price.rbi +717 -688
- data/rbi/lib/orb/models/price_create_params.rbi +137 -53
- data/rbi/lib/orb/models/price_evaluate_params.rbi +10 -0
- data/rbi/lib/orb/models/price_list_params.rbi +8 -2
- data/rbi/lib/orb/models/price_update_params.rbi +7 -2
- data/rbi/lib/orb/models/prices/external_price_id_update_params.rbi +7 -2
- data/rbi/lib/orb/models/subscription.rbi +174 -11
- data/rbi/lib/orb/models/subscription_cancel_params.rbi +8 -5
- data/rbi/lib/orb/models/subscription_cancel_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_change_apply_params.rbi +7 -2
- data/rbi/lib/orb/models/subscription_change_apply_response.rbi +199 -18
- data/rbi/lib/orb/models/subscription_change_cancel_response.rbi +199 -18
- data/rbi/lib/orb/models/subscription_change_retrieve_response.rbi +199 -18
- data/rbi/lib/orb/models/subscription_create_params.rbi +2282 -1536
- data/rbi/lib/orb/models/subscription_create_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_fetch_costs_params.rbi +9 -5
- data/rbi/lib/orb/models/subscription_fetch_costs_response.rbi +21 -4
- data/rbi/lib/orb/models/subscription_fetch_schedule_params.rbi +3 -0
- data/rbi/lib/orb/models/subscription_fetch_schedule_response.rbi +8 -2
- data/rbi/lib/orb/models/subscription_fetch_usage_params.rbi +13 -4
- data/rbi/lib/orb/models/subscription_list_params.rbi +4 -2
- data/rbi/lib/orb/models/subscription_price_intervals_params.rbi +1228 -861
- data/rbi/lib/orb/models/subscription_price_intervals_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_schedule_plan_change_params.rbi +2288 -1544
- data/rbi/lib/orb/models/subscription_schedule_plan_change_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_trigger_phase_params.rbi +10 -2
- data/rbi/lib/orb/models/subscription_trigger_phase_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_unschedule_cancellation_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +5 -2
- data/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +187 -20
- data/rbi/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_params.rbi +11 -2
- data/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_update_params.rbi +15 -0
- data/rbi/lib/orb/models/subscription_update_trial_params.rbi +11 -5
- data/rbi/lib/orb/models/subscription_update_trial_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_usage.rbi +2 -16
- data/rbi/lib/orb/models/trial_discount.rbi +5 -1
- data/rbi/lib/orb/models/usage_discount.rbi +11 -3
- data/sig/orb/file_part.rbs +21 -0
- data/sig/orb/internal/transport/base_client.rbs +9 -3
- data/sig/orb/internal/type/array_of.rbs +4 -0
- data/sig/orb/internal/type/base_model.rbs +12 -0
- data/sig/orb/internal/type/converter.rbs +4 -0
- data/sig/orb/internal/type/enum.rbs +4 -2
- data/sig/orb/internal/type/{io_like.rbs → file_input.rbs} +1 -1
- data/sig/orb/internal/type/hash_of.rbs +4 -0
- data/sig/orb/internal/type/union.rbs +4 -0
- data/sig/orb/internal/util.rbs +16 -12
- data/sig/orb/internal.rbs +1 -1
- metadata +9 -5
@@ -4,8 +4,7 @@ module Orb
|
|
4
4
|
module Models
|
5
5
|
# @see Orb::Resources::Plans#create
|
6
6
|
class PlanCreateParams < Orb::Internal::Type::BaseModel
|
7
|
-
|
8
|
-
# extend Orb::Internal::Type::RequestParameters::Converter
|
7
|
+
extend Orb::Internal::Type::RequestParameters::Converter
|
9
8
|
include Orb::Internal::Type::RequestParameters
|
10
9
|
|
11
10
|
# @!attribute currency
|
@@ -54,44 +53,40 @@ module Orb
|
|
54
53
|
# @return [Integer, nil]
|
55
54
|
optional :net_terms, Integer, nil?: true
|
56
55
|
|
57
|
-
# @!attribute
|
56
|
+
# @!attribute status
|
58
57
|
# The status of the plan to create (either active or draft). If not specified,
|
59
58
|
# this defaults to active.
|
60
59
|
#
|
61
60
|
# @return [Symbol, Orb::Models::PlanCreateParams::Status, nil]
|
62
61
|
optional :status, enum: -> { Orb::Models::PlanCreateParams::Status }
|
63
62
|
|
64
|
-
# @!
|
65
|
-
#
|
66
|
-
#
|
67
|
-
|
68
|
-
#
|
69
|
-
#
|
70
|
-
#
|
71
|
-
#
|
72
|
-
#
|
73
|
-
#
|
74
|
-
#
|
75
|
-
#
|
76
|
-
#
|
77
|
-
#
|
78
|
-
#
|
79
|
-
#
|
80
|
-
#
|
81
|
-
#
|
82
|
-
#
|
83
|
-
#
|
84
|
-
#
|
85
|
-
#
|
86
|
-
#
|
87
|
-
#
|
88
|
-
#
|
89
|
-
#
|
90
|
-
#
|
91
|
-
# super
|
92
|
-
# end
|
93
|
-
|
94
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
63
|
+
# @!method initialize(currency:, name:, prices:, default_invoice_memo: nil, external_plan_id: nil, metadata: nil, net_terms: nil, status: nil, request_options: {})
|
64
|
+
# Some parameter documentations has been truncated, see
|
65
|
+
# {Orb::Models::PlanCreateParams} for more details.
|
66
|
+
#
|
67
|
+
# @param currency [String] An ISO 4217 currency string for invoices generated by subscriptions on this plan
|
68
|
+
# ...
|
69
|
+
#
|
70
|
+
# @param name [String]
|
71
|
+
#
|
72
|
+
# @param prices [Array<Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice, Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice, Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice, Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice, Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice, Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice, Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice, Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice, Orb::Models::PlanCreateParams::Price::NewPlanThresholdTotalAmountPrice, Orb::Models::PlanCreateParams::Price::NewPlanTieredPackagePrice, Orb::Models::PlanCreateParams::Price::NewPlanTieredWithMinimumPrice, Orb::Models::PlanCreateParams::Price::NewPlanUnitWithPercentPrice, Orb::Models::PlanCreateParams::Price::NewPlanPackageWithAllocationPrice, Orb::Models::PlanCreateParams::Price::NewPlanTierWithProrationPrice, Orb::Models::PlanCreateParams::Price::NewPlanUnitWithProrationPrice, Orb::Models::PlanCreateParams::Price::NewPlanGroupedAllocationPrice, Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithProratedMinimumPrice, Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithMeteredMinimumPrice, Orb::Models::PlanCreateParams::Price::NewPlanMatrixWithDisplayNamePrice, Orb::Models::PlanCreateParams::Price::NewPlanBulkWithProrationPrice, Orb::Models::PlanCreateParams::Price::NewPlanGroupedTieredPackagePrice, Orb::Models::PlanCreateParams::Price::NewPlanMaxGroupTieredPackagePrice, Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithUnitPricingPrice, Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithTieredPricingPrice, Orb::Models::PlanCreateParams::Price::NewPlanCumulativeGroupedBulkPrice>] Prices for this plan. If the plan has phases, this includes prices across all ph
|
73
|
+
# ...
|
74
|
+
#
|
75
|
+
# @param default_invoice_memo [String, nil] Free-form text which is available on the invoice PDF and the Orb invoice portal.
|
76
|
+
# ...
|
77
|
+
#
|
78
|
+
# @param external_plan_id [String, nil]
|
79
|
+
#
|
80
|
+
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
81
|
+
# ...
|
82
|
+
#
|
83
|
+
# @param net_terms [Integer, nil] The net terms determines the difference between the invoice date and the issue d
|
84
|
+
# ...
|
85
|
+
#
|
86
|
+
# @param status [Symbol, Orb::Models::PlanCreateParams::Status] The status of the plan to create (either active or draft). If not specified, thi
|
87
|
+
# ...
|
88
|
+
#
|
89
|
+
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
95
90
|
|
96
91
|
module Price
|
97
92
|
extend Orb::Internal::Type::Union
|
@@ -259,45 +254,46 @@ module Orb
|
|
259
254
|
# @return [Hash{Symbol=>String, nil}, nil]
|
260
255
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
261
256
|
|
262
|
-
# @!
|
263
|
-
#
|
264
|
-
#
|
265
|
-
#
|
266
|
-
#
|
267
|
-
#
|
268
|
-
#
|
269
|
-
#
|
270
|
-
#
|
271
|
-
#
|
272
|
-
#
|
273
|
-
#
|
274
|
-
#
|
275
|
-
#
|
276
|
-
#
|
277
|
-
#
|
278
|
-
#
|
279
|
-
#
|
280
|
-
#
|
281
|
-
#
|
282
|
-
#
|
283
|
-
#
|
284
|
-
#
|
285
|
-
#
|
286
|
-
#
|
287
|
-
#
|
288
|
-
#
|
289
|
-
#
|
290
|
-
#
|
291
|
-
#
|
292
|
-
#
|
293
|
-
#
|
294
|
-
#
|
295
|
-
#
|
296
|
-
#
|
297
|
-
#
|
298
|
-
#
|
299
|
-
|
300
|
-
#
|
257
|
+
# @!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
|
+
# Some parameter documentations has been truncated, see
|
259
|
+
# {Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice} for more details.
|
260
|
+
#
|
261
|
+
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice::Cadence] The cadence to bill for this price on.
|
262
|
+
#
|
263
|
+
# @param item_id [String] The id of the item the price will be associated with.
|
264
|
+
#
|
265
|
+
# @param name [String] The name of the price.
|
266
|
+
#
|
267
|
+
# @param unit_config [Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice::UnitConfig]
|
268
|
+
#
|
269
|
+
# @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
|
+
#
|
272
|
+
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
273
|
+
# ...
|
274
|
+
#
|
275
|
+
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
276
|
+
# ...
|
277
|
+
#
|
278
|
+
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
279
|
+
#
|
280
|
+
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
281
|
+
# ...
|
282
|
+
#
|
283
|
+
# @param external_price_id [String, nil] An alias for the price.
|
284
|
+
#
|
285
|
+
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
286
|
+
# ...
|
287
|
+
#
|
288
|
+
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
289
|
+
#
|
290
|
+
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
291
|
+
# ...
|
292
|
+
#
|
293
|
+
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
294
|
+
# ...
|
295
|
+
#
|
296
|
+
# @param model_type [Symbol, :unit]
|
301
297
|
|
302
298
|
# The cadence to bill for this price on.
|
303
299
|
#
|
@@ -312,11 +308,8 @@ module Orb
|
|
312
308
|
ONE_TIME = :one_time
|
313
309
|
CUSTOM = :custom
|
314
310
|
|
315
|
-
|
316
|
-
|
317
|
-
# @!parse
|
318
|
-
# # @return [Array<Symbol>]
|
319
|
-
# def self.values; end
|
311
|
+
# @!method self.values
|
312
|
+
# @return [Array<Symbol>]
|
320
313
|
end
|
321
314
|
|
322
315
|
# @see Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice#unit_config
|
@@ -327,12 +320,8 @@ module Orb
|
|
327
320
|
# @return [String]
|
328
321
|
required :unit_amount, String
|
329
322
|
|
330
|
-
# @!
|
331
|
-
#
|
332
|
-
# #
|
333
|
-
# def initialize(unit_amount:, **) = super
|
334
|
-
|
335
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
323
|
+
# @!method initialize(unit_amount:)
|
324
|
+
# @param unit_amount [String] Rate per unit of usage
|
336
325
|
end
|
337
326
|
|
338
327
|
# @see Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice#billing_cycle_configuration
|
@@ -350,16 +339,13 @@ module Orb
|
|
350
339
|
required :duration_unit,
|
351
340
|
enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice::BillingCycleConfiguration::DurationUnit }
|
352
341
|
|
353
|
-
# @!
|
354
|
-
#
|
355
|
-
#
|
356
|
-
#
|
357
|
-
#
|
358
|
-
#
|
359
|
-
#
|
360
|
-
# def initialize(duration:, duration_unit:, **) = super
|
361
|
-
|
362
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
342
|
+
# @!method initialize(duration:, duration_unit:)
|
343
|
+
# For custom cadence: specifies the duration of the billing period in days or
|
344
|
+
# months.
|
345
|
+
#
|
346
|
+
# @param duration [Integer] The duration of the billing period.
|
347
|
+
#
|
348
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
363
349
|
|
364
350
|
# The unit of billing period duration.
|
365
351
|
#
|
@@ -370,11 +356,8 @@ module Orb
|
|
370
356
|
DAY = :day
|
371
357
|
MONTH = :month
|
372
358
|
|
373
|
-
|
374
|
-
|
375
|
-
# @!parse
|
376
|
-
# # @return [Array<Symbol>]
|
377
|
-
# def self.values; end
|
359
|
+
# @!method self.values
|
360
|
+
# @return [Array<Symbol>]
|
378
361
|
end
|
379
362
|
end
|
380
363
|
|
@@ -393,16 +376,13 @@ module Orb
|
|
393
376
|
required :duration_unit,
|
394
377
|
enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice::InvoicingCycleConfiguration::DurationUnit }
|
395
378
|
|
396
|
-
# @!
|
397
|
-
#
|
398
|
-
#
|
399
|
-
#
|
400
|
-
#
|
401
|
-
#
|
402
|
-
#
|
403
|
-
# def initialize(duration:, duration_unit:, **) = super
|
404
|
-
|
405
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
379
|
+
# @!method initialize(duration:, duration_unit:)
|
380
|
+
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
381
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
382
|
+
#
|
383
|
+
# @param duration [Integer] The duration of the billing period.
|
384
|
+
#
|
385
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
406
386
|
|
407
387
|
# The unit of billing period duration.
|
408
388
|
#
|
@@ -413,11 +393,8 @@ module Orb
|
|
413
393
|
DAY = :day
|
414
394
|
MONTH = :month
|
415
395
|
|
416
|
-
|
417
|
-
|
418
|
-
# @!parse
|
419
|
-
# # @return [Array<Symbol>]
|
420
|
-
# def self.values; end
|
396
|
+
# @!method self.values
|
397
|
+
# @return [Array<Symbol>]
|
421
398
|
end
|
422
399
|
end
|
423
400
|
end
|
@@ -523,45 +500,46 @@ module Orb
|
|
523
500
|
# @return [Hash{Symbol=>String, nil}, nil]
|
524
501
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
525
502
|
|
526
|
-
# @!
|
527
|
-
#
|
528
|
-
#
|
529
|
-
#
|
530
|
-
#
|
531
|
-
#
|
532
|
-
#
|
533
|
-
#
|
534
|
-
#
|
535
|
-
#
|
536
|
-
#
|
537
|
-
#
|
538
|
-
#
|
539
|
-
#
|
540
|
-
#
|
541
|
-
#
|
542
|
-
#
|
543
|
-
#
|
544
|
-
#
|
545
|
-
#
|
546
|
-
#
|
547
|
-
#
|
548
|
-
#
|
549
|
-
#
|
550
|
-
#
|
551
|
-
#
|
552
|
-
#
|
553
|
-
#
|
554
|
-
#
|
555
|
-
#
|
556
|
-
#
|
557
|
-
#
|
558
|
-
#
|
559
|
-
#
|
560
|
-
#
|
561
|
-
#
|
562
|
-
#
|
563
|
-
|
564
|
-
#
|
503
|
+
# @!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
|
+
# Some parameter documentations has been truncated, see
|
505
|
+
# {Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice} for more details.
|
506
|
+
#
|
507
|
+
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice::Cadence] The cadence to bill for this price on.
|
508
|
+
#
|
509
|
+
# @param item_id [String] The id of the item the price will be associated with.
|
510
|
+
#
|
511
|
+
# @param name [String] The name of the price.
|
512
|
+
#
|
513
|
+
# @param package_config [Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice::PackageConfig]
|
514
|
+
#
|
515
|
+
# @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
|
+
#
|
518
|
+
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
519
|
+
# ...
|
520
|
+
#
|
521
|
+
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
522
|
+
# ...
|
523
|
+
#
|
524
|
+
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
525
|
+
#
|
526
|
+
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
527
|
+
# ...
|
528
|
+
#
|
529
|
+
# @param external_price_id [String, nil] An alias for the price.
|
530
|
+
#
|
531
|
+
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
532
|
+
# ...
|
533
|
+
#
|
534
|
+
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
535
|
+
#
|
536
|
+
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
537
|
+
# ...
|
538
|
+
#
|
539
|
+
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
540
|
+
# ...
|
541
|
+
#
|
542
|
+
# @param model_type [Symbol, :package]
|
565
543
|
|
566
544
|
# The cadence to bill for this price on.
|
567
545
|
#
|
@@ -576,11 +554,8 @@ module Orb
|
|
576
554
|
ONE_TIME = :one_time
|
577
555
|
CUSTOM = :custom
|
578
556
|
|
579
|
-
|
580
|
-
|
581
|
-
# @!parse
|
582
|
-
# # @return [Array<Symbol>]
|
583
|
-
# def self.values; end
|
557
|
+
# @!method self.values
|
558
|
+
# @return [Array<Symbol>]
|
584
559
|
end
|
585
560
|
|
586
561
|
# @see Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice#package_config
|
@@ -598,13 +573,15 @@ module Orb
|
|
598
573
|
# @return [Integer]
|
599
574
|
required :package_size, Integer
|
600
575
|
|
601
|
-
# @!
|
602
|
-
#
|
603
|
-
#
|
604
|
-
#
|
605
|
-
#
|
606
|
-
|
607
|
-
#
|
576
|
+
# @!method initialize(package_amount:, package_size:)
|
577
|
+
# Some parameter documentations has been truncated, see
|
578
|
+
# {Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice::PackageConfig} for
|
579
|
+
# more details.
|
580
|
+
#
|
581
|
+
# @param package_amount [String] A currency amount to rate usage by
|
582
|
+
#
|
583
|
+
# @param package_size [Integer] An integer amount to represent package size. For example, 1000 here would divide
|
584
|
+
# ...
|
608
585
|
end
|
609
586
|
|
610
587
|
# @see Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice#billing_cycle_configuration
|
@@ -622,16 +599,13 @@ module Orb
|
|
622
599
|
required :duration_unit,
|
623
600
|
enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice::BillingCycleConfiguration::DurationUnit }
|
624
601
|
|
625
|
-
# @!
|
626
|
-
#
|
627
|
-
#
|
628
|
-
#
|
629
|
-
#
|
630
|
-
#
|
631
|
-
#
|
632
|
-
# def initialize(duration:, duration_unit:, **) = super
|
633
|
-
|
634
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
602
|
+
# @!method initialize(duration:, duration_unit:)
|
603
|
+
# For custom cadence: specifies the duration of the billing period in days or
|
604
|
+
# months.
|
605
|
+
#
|
606
|
+
# @param duration [Integer] The duration of the billing period.
|
607
|
+
#
|
608
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
635
609
|
|
636
610
|
# The unit of billing period duration.
|
637
611
|
#
|
@@ -642,11 +616,8 @@ module Orb
|
|
642
616
|
DAY = :day
|
643
617
|
MONTH = :month
|
644
618
|
|
645
|
-
|
646
|
-
|
647
|
-
# @!parse
|
648
|
-
# # @return [Array<Symbol>]
|
649
|
-
# def self.values; end
|
619
|
+
# @!method self.values
|
620
|
+
# @return [Array<Symbol>]
|
650
621
|
end
|
651
622
|
end
|
652
623
|
|
@@ -665,16 +636,13 @@ module Orb
|
|
665
636
|
required :duration_unit,
|
666
637
|
enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice::InvoicingCycleConfiguration::DurationUnit }
|
667
638
|
|
668
|
-
# @!
|
669
|
-
#
|
670
|
-
#
|
671
|
-
#
|
672
|
-
#
|
673
|
-
#
|
674
|
-
#
|
675
|
-
# def initialize(duration:, duration_unit:, **) = super
|
676
|
-
|
677
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
639
|
+
# @!method initialize(duration:, duration_unit:)
|
640
|
+
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
641
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
642
|
+
#
|
643
|
+
# @param duration [Integer] The duration of the billing period.
|
644
|
+
#
|
645
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
678
646
|
|
679
647
|
# The unit of billing period duration.
|
680
648
|
#
|
@@ -685,11 +653,8 @@ module Orb
|
|
685
653
|
DAY = :day
|
686
654
|
MONTH = :month
|
687
655
|
|
688
|
-
|
689
|
-
|
690
|
-
# @!parse
|
691
|
-
# # @return [Array<Symbol>]
|
692
|
-
# def self.values; end
|
656
|
+
# @!method self.values
|
657
|
+
# @return [Array<Symbol>]
|
693
658
|
end
|
694
659
|
end
|
695
660
|
end
|
@@ -795,45 +760,46 @@ module Orb
|
|
795
760
|
# @return [Hash{Symbol=>String, nil}, nil]
|
796
761
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
797
762
|
|
798
|
-
# @!
|
799
|
-
#
|
800
|
-
#
|
801
|
-
#
|
802
|
-
#
|
803
|
-
#
|
804
|
-
#
|
805
|
-
#
|
806
|
-
#
|
807
|
-
#
|
808
|
-
#
|
809
|
-
#
|
810
|
-
#
|
811
|
-
#
|
812
|
-
#
|
813
|
-
#
|
814
|
-
#
|
815
|
-
#
|
816
|
-
#
|
817
|
-
#
|
818
|
-
#
|
819
|
-
#
|
820
|
-
#
|
821
|
-
#
|
822
|
-
#
|
823
|
-
#
|
824
|
-
#
|
825
|
-
#
|
826
|
-
#
|
827
|
-
#
|
828
|
-
#
|
829
|
-
#
|
830
|
-
#
|
831
|
-
#
|
832
|
-
#
|
833
|
-
#
|
834
|
-
#
|
835
|
-
|
836
|
-
#
|
763
|
+
# @!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
|
+
# Some parameter documentations has been truncated, see
|
765
|
+
# {Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice} for more details.
|
766
|
+
#
|
767
|
+
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice::Cadence] The cadence to bill for this price on.
|
768
|
+
#
|
769
|
+
# @param item_id [String] The id of the item the price will be associated with.
|
770
|
+
#
|
771
|
+
# @param matrix_config [Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice::MatrixConfig]
|
772
|
+
#
|
773
|
+
# @param name [String] The name of the price.
|
774
|
+
#
|
775
|
+
# @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
|
+
#
|
778
|
+
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
779
|
+
# ...
|
780
|
+
#
|
781
|
+
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
782
|
+
# ...
|
783
|
+
#
|
784
|
+
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
785
|
+
#
|
786
|
+
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
787
|
+
# ...
|
788
|
+
#
|
789
|
+
# @param external_price_id [String, nil] An alias for the price.
|
790
|
+
#
|
791
|
+
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
792
|
+
# ...
|
793
|
+
#
|
794
|
+
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
795
|
+
#
|
796
|
+
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
797
|
+
# ...
|
798
|
+
#
|
799
|
+
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
800
|
+
# ...
|
801
|
+
#
|
802
|
+
# @param model_type [Symbol, :matrix]
|
837
803
|
|
838
804
|
# The cadence to bill for this price on.
|
839
805
|
#
|
@@ -848,11 +814,8 @@ module Orb
|
|
848
814
|
ONE_TIME = :one_time
|
849
815
|
CUSTOM = :custom
|
850
816
|
|
851
|
-
|
852
|
-
|
853
|
-
# @!parse
|
854
|
-
# # @return [Array<Symbol>]
|
855
|
-
# def self.values; end
|
817
|
+
# @!method self.values
|
818
|
+
# @return [Array<Symbol>]
|
856
819
|
end
|
857
820
|
|
858
821
|
# @see Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice#matrix_config
|
@@ -876,14 +839,12 @@ module Orb
|
|
876
839
|
required :matrix_values,
|
877
840
|
-> { Orb::Internal::Type::ArrayOf[Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice::MatrixConfig::MatrixValue] }
|
878
841
|
|
879
|
-
# @!
|
880
|
-
#
|
881
|
-
#
|
882
|
-
#
|
883
|
-
#
|
884
|
-
#
|
885
|
-
|
886
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
842
|
+
# @!method initialize(default_unit_amount:, dimensions:, matrix_values:)
|
843
|
+
# @param default_unit_amount [String] Default per unit rate for any usage not bucketed into a specified matrix_value
|
844
|
+
#
|
845
|
+
# @param dimensions [Array<String, nil>] One or two event property values to evaluate matrix groups by
|
846
|
+
#
|
847
|
+
# @param matrix_values [Array<Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice::MatrixConfig::MatrixValue>] Matrix values for specified matrix grouping keys
|
887
848
|
|
888
849
|
class MatrixValue < Orb::Internal::Type::BaseModel
|
889
850
|
# @!attribute dimension_values
|
@@ -900,13 +861,15 @@ module Orb
|
|
900
861
|
# @return [String]
|
901
862
|
required :unit_amount, String
|
902
863
|
|
903
|
-
# @!
|
904
|
-
#
|
905
|
-
#
|
906
|
-
#
|
907
|
-
#
|
908
|
-
|
909
|
-
#
|
864
|
+
# @!method initialize(dimension_values:, unit_amount:)
|
865
|
+
# Some parameter documentations has been truncated, see
|
866
|
+
# {Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice::MatrixConfig::MatrixValue}
|
867
|
+
# for more details.
|
868
|
+
#
|
869
|
+
# @param dimension_values [Array<String, nil>] One or two matrix keys to filter usage to this Matrix value by. For example, ["r
|
870
|
+
# ...
|
871
|
+
#
|
872
|
+
# @param unit_amount [String] Unit price for the specified dimension_values
|
910
873
|
end
|
911
874
|
end
|
912
875
|
|
@@ -925,16 +888,13 @@ module Orb
|
|
925
888
|
required :duration_unit,
|
926
889
|
enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice::BillingCycleConfiguration::DurationUnit }
|
927
890
|
|
928
|
-
# @!
|
929
|
-
#
|
930
|
-
#
|
931
|
-
#
|
932
|
-
#
|
933
|
-
#
|
934
|
-
#
|
935
|
-
# def initialize(duration:, duration_unit:, **) = super
|
936
|
-
|
937
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
891
|
+
# @!method initialize(duration:, duration_unit:)
|
892
|
+
# For custom cadence: specifies the duration of the billing period in days or
|
893
|
+
# months.
|
894
|
+
#
|
895
|
+
# @param duration [Integer] The duration of the billing period.
|
896
|
+
#
|
897
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
938
898
|
|
939
899
|
# The unit of billing period duration.
|
940
900
|
#
|
@@ -945,11 +905,8 @@ module Orb
|
|
945
905
|
DAY = :day
|
946
906
|
MONTH = :month
|
947
907
|
|
948
|
-
|
949
|
-
|
950
|
-
# @!parse
|
951
|
-
# # @return [Array<Symbol>]
|
952
|
-
# def self.values; end
|
908
|
+
# @!method self.values
|
909
|
+
# @return [Array<Symbol>]
|
953
910
|
end
|
954
911
|
end
|
955
912
|
|
@@ -968,16 +925,13 @@ module Orb
|
|
968
925
|
required :duration_unit,
|
969
926
|
enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice::InvoicingCycleConfiguration::DurationUnit }
|
970
927
|
|
971
|
-
# @!
|
972
|
-
#
|
973
|
-
#
|
974
|
-
#
|
975
|
-
#
|
976
|
-
#
|
977
|
-
#
|
978
|
-
# def initialize(duration:, duration_unit:, **) = super
|
979
|
-
|
980
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
928
|
+
# @!method initialize(duration:, duration_unit:)
|
929
|
+
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
930
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
931
|
+
#
|
932
|
+
# @param duration [Integer] The duration of the billing period.
|
933
|
+
#
|
934
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
981
935
|
|
982
936
|
# The unit of billing period duration.
|
983
937
|
#
|
@@ -988,11 +942,8 @@ module Orb
|
|
988
942
|
DAY = :day
|
989
943
|
MONTH = :month
|
990
944
|
|
991
|
-
|
992
|
-
|
993
|
-
# @!parse
|
994
|
-
# # @return [Array<Symbol>]
|
995
|
-
# def self.values; end
|
945
|
+
# @!method self.values
|
946
|
+
# @return [Array<Symbol>]
|
996
947
|
end
|
997
948
|
end
|
998
949
|
end
|
@@ -1098,45 +1049,46 @@ module Orb
|
|
1098
1049
|
# @return [Hash{Symbol=>String, nil}, nil]
|
1099
1050
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
1100
1051
|
|
1101
|
-
# @!
|
1102
|
-
#
|
1103
|
-
#
|
1104
|
-
#
|
1105
|
-
#
|
1106
|
-
#
|
1107
|
-
#
|
1108
|
-
#
|
1109
|
-
#
|
1110
|
-
#
|
1111
|
-
#
|
1112
|
-
#
|
1113
|
-
#
|
1114
|
-
#
|
1115
|
-
#
|
1116
|
-
#
|
1117
|
-
#
|
1118
|
-
#
|
1119
|
-
#
|
1120
|
-
#
|
1121
|
-
#
|
1122
|
-
#
|
1123
|
-
#
|
1124
|
-
#
|
1125
|
-
#
|
1126
|
-
#
|
1127
|
-
#
|
1128
|
-
#
|
1129
|
-
#
|
1130
|
-
#
|
1131
|
-
#
|
1132
|
-
#
|
1133
|
-
#
|
1134
|
-
#
|
1135
|
-
#
|
1136
|
-
#
|
1137
|
-
#
|
1138
|
-
|
1139
|
-
#
|
1052
|
+
# @!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
|
+
# Some parameter documentations has been truncated, see
|
1054
|
+
# {Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice} for more details.
|
1055
|
+
#
|
1056
|
+
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice::Cadence] The cadence to bill for this price on.
|
1057
|
+
#
|
1058
|
+
# @param item_id [String] The id of the item the price will be associated with.
|
1059
|
+
#
|
1060
|
+
# @param name [String] The name of the price.
|
1061
|
+
#
|
1062
|
+
# @param tiered_config [Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice::TieredConfig]
|
1063
|
+
#
|
1064
|
+
# @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
|
+
#
|
1067
|
+
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
1068
|
+
# ...
|
1069
|
+
#
|
1070
|
+
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
1071
|
+
# ...
|
1072
|
+
#
|
1073
|
+
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
1074
|
+
#
|
1075
|
+
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
1076
|
+
# ...
|
1077
|
+
#
|
1078
|
+
# @param external_price_id [String, nil] An alias for the price.
|
1079
|
+
#
|
1080
|
+
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
1081
|
+
# ...
|
1082
|
+
#
|
1083
|
+
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
1084
|
+
#
|
1085
|
+
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
1086
|
+
# ...
|
1087
|
+
#
|
1088
|
+
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
1089
|
+
# ...
|
1090
|
+
#
|
1091
|
+
# @param model_type [Symbol, :tiered]
|
1140
1092
|
|
1141
1093
|
# The cadence to bill for this price on.
|
1142
1094
|
#
|
@@ -1151,11 +1103,8 @@ module Orb
|
|
1151
1103
|
ONE_TIME = :one_time
|
1152
1104
|
CUSTOM = :custom
|
1153
1105
|
|
1154
|
-
|
1155
|
-
|
1156
|
-
# @!parse
|
1157
|
-
# # @return [Array<Symbol>]
|
1158
|
-
# def self.values; end
|
1106
|
+
# @!method self.values
|
1107
|
+
# @return [Array<Symbol>]
|
1159
1108
|
end
|
1160
1109
|
|
1161
1110
|
# @see Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice#tiered_config
|
@@ -1167,12 +1116,8 @@ module Orb
|
|
1167
1116
|
required :tiers,
|
1168
1117
|
-> { Orb::Internal::Type::ArrayOf[Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice::TieredConfig::Tier] }
|
1169
1118
|
|
1170
|
-
# @!
|
1171
|
-
#
|
1172
|
-
# #
|
1173
|
-
# def initialize(tiers:, **) = super
|
1174
|
-
|
1175
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
1119
|
+
# @!method initialize(tiers:)
|
1120
|
+
# @param tiers [Array<Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice::TieredConfig::Tier>] Tiers for rating based on total usage quantities into the specified tier
|
1176
1121
|
|
1177
1122
|
class Tier < Orb::Internal::Type::BaseModel
|
1178
1123
|
# @!attribute first_unit
|
@@ -1193,14 +1138,12 @@ module Orb
|
|
1193
1138
|
# @return [Float, nil]
|
1194
1139
|
optional :last_unit, Float, nil?: true
|
1195
1140
|
|
1196
|
-
# @!
|
1197
|
-
#
|
1198
|
-
#
|
1199
|
-
#
|
1200
|
-
#
|
1201
|
-
#
|
1202
|
-
|
1203
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
1141
|
+
# @!method initialize(first_unit:, unit_amount:, last_unit: nil)
|
1142
|
+
# @param first_unit [Float] Exclusive tier starting value
|
1143
|
+
#
|
1144
|
+
# @param unit_amount [String] Amount per unit
|
1145
|
+
#
|
1146
|
+
# @param last_unit [Float, nil] Inclusive tier ending value. If null, this is treated as the last tier
|
1204
1147
|
end
|
1205
1148
|
end
|
1206
1149
|
|
@@ -1219,16 +1162,13 @@ module Orb
|
|
1219
1162
|
required :duration_unit,
|
1220
1163
|
enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice::BillingCycleConfiguration::DurationUnit }
|
1221
1164
|
|
1222
|
-
# @!
|
1223
|
-
#
|
1224
|
-
#
|
1225
|
-
#
|
1226
|
-
#
|
1227
|
-
#
|
1228
|
-
#
|
1229
|
-
# def initialize(duration:, duration_unit:, **) = super
|
1230
|
-
|
1231
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
1165
|
+
# @!method initialize(duration:, duration_unit:)
|
1166
|
+
# For custom cadence: specifies the duration of the billing period in days or
|
1167
|
+
# months.
|
1168
|
+
#
|
1169
|
+
# @param duration [Integer] The duration of the billing period.
|
1170
|
+
#
|
1171
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
1232
1172
|
|
1233
1173
|
# The unit of billing period duration.
|
1234
1174
|
#
|
@@ -1239,11 +1179,8 @@ module Orb
|
|
1239
1179
|
DAY = :day
|
1240
1180
|
MONTH = :month
|
1241
1181
|
|
1242
|
-
|
1243
|
-
|
1244
|
-
# @!parse
|
1245
|
-
# # @return [Array<Symbol>]
|
1246
|
-
# def self.values; end
|
1182
|
+
# @!method self.values
|
1183
|
+
# @return [Array<Symbol>]
|
1247
1184
|
end
|
1248
1185
|
end
|
1249
1186
|
|
@@ -1262,16 +1199,13 @@ module Orb
|
|
1262
1199
|
required :duration_unit,
|
1263
1200
|
enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice::InvoicingCycleConfiguration::DurationUnit }
|
1264
1201
|
|
1265
|
-
# @!
|
1266
|
-
#
|
1267
|
-
#
|
1268
|
-
#
|
1269
|
-
#
|
1270
|
-
#
|
1271
|
-
#
|
1272
|
-
# def initialize(duration:, duration_unit:, **) = super
|
1273
|
-
|
1274
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
1202
|
+
# @!method initialize(duration:, duration_unit:)
|
1203
|
+
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
1204
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
1205
|
+
#
|
1206
|
+
# @param duration [Integer] The duration of the billing period.
|
1207
|
+
#
|
1208
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
1275
1209
|
|
1276
1210
|
# The unit of billing period duration.
|
1277
1211
|
#
|
@@ -1282,11 +1216,8 @@ module Orb
|
|
1282
1216
|
DAY = :day
|
1283
1217
|
MONTH = :month
|
1284
1218
|
|
1285
|
-
|
1286
|
-
|
1287
|
-
# @!parse
|
1288
|
-
# # @return [Array<Symbol>]
|
1289
|
-
# def self.values; end
|
1219
|
+
# @!method self.values
|
1220
|
+
# @return [Array<Symbol>]
|
1290
1221
|
end
|
1291
1222
|
end
|
1292
1223
|
end
|
@@ -1393,45 +1324,46 @@ module Orb
|
|
1393
1324
|
# @return [Hash{Symbol=>String, nil}, nil]
|
1394
1325
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
1395
1326
|
|
1396
|
-
# @!
|
1397
|
-
#
|
1398
|
-
#
|
1399
|
-
#
|
1400
|
-
#
|
1401
|
-
#
|
1402
|
-
#
|
1403
|
-
#
|
1404
|
-
#
|
1405
|
-
#
|
1406
|
-
#
|
1407
|
-
#
|
1408
|
-
#
|
1409
|
-
#
|
1410
|
-
#
|
1411
|
-
#
|
1412
|
-
#
|
1413
|
-
#
|
1414
|
-
#
|
1415
|
-
#
|
1416
|
-
#
|
1417
|
-
#
|
1418
|
-
#
|
1419
|
-
#
|
1420
|
-
#
|
1421
|
-
#
|
1422
|
-
#
|
1423
|
-
#
|
1424
|
-
#
|
1425
|
-
#
|
1426
|
-
#
|
1427
|
-
#
|
1428
|
-
#
|
1429
|
-
#
|
1430
|
-
#
|
1431
|
-
#
|
1432
|
-
#
|
1433
|
-
|
1434
|
-
#
|
1327
|
+
# @!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
|
+
# Some parameter documentations has been truncated, see
|
1329
|
+
# {Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice} for more details.
|
1330
|
+
#
|
1331
|
+
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice::Cadence] The cadence to bill for this price on.
|
1332
|
+
#
|
1333
|
+
# @param item_id [String] The id of the item the price will be associated with.
|
1334
|
+
#
|
1335
|
+
# @param name [String] The name of the price.
|
1336
|
+
#
|
1337
|
+
# @param tiered_bps_config [Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice::TieredBpsConfig]
|
1338
|
+
#
|
1339
|
+
# @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
|
+
#
|
1342
|
+
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
1343
|
+
# ...
|
1344
|
+
#
|
1345
|
+
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
1346
|
+
# ...
|
1347
|
+
#
|
1348
|
+
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
1349
|
+
#
|
1350
|
+
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
1351
|
+
# ...
|
1352
|
+
#
|
1353
|
+
# @param external_price_id [String, nil] An alias for the price.
|
1354
|
+
#
|
1355
|
+
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
1356
|
+
# ...
|
1357
|
+
#
|
1358
|
+
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
1359
|
+
#
|
1360
|
+
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
1361
|
+
# ...
|
1362
|
+
#
|
1363
|
+
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
1364
|
+
# ...
|
1365
|
+
#
|
1366
|
+
# @param model_type [Symbol, :tiered_bps]
|
1435
1367
|
|
1436
1368
|
# The cadence to bill for this price on.
|
1437
1369
|
#
|
@@ -1446,11 +1378,8 @@ module Orb
|
|
1446
1378
|
ONE_TIME = :one_time
|
1447
1379
|
CUSTOM = :custom
|
1448
1380
|
|
1449
|
-
|
1450
|
-
|
1451
|
-
# @!parse
|
1452
|
-
# # @return [Array<Symbol>]
|
1453
|
-
# def self.values; end
|
1381
|
+
# @!method self.values
|
1382
|
+
# @return [Array<Symbol>]
|
1454
1383
|
end
|
1455
1384
|
|
1456
1385
|
# @see Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice#tiered_bps_config
|
@@ -1463,12 +1392,13 @@ module Orb
|
|
1463
1392
|
required :tiers,
|
1464
1393
|
-> { Orb::Internal::Type::ArrayOf[Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice::TieredBpsConfig::Tier] }
|
1465
1394
|
|
1466
|
-
# @!
|
1467
|
-
#
|
1468
|
-
#
|
1469
|
-
#
|
1470
|
-
|
1471
|
-
#
|
1395
|
+
# @!method initialize(tiers:)
|
1396
|
+
# Some parameter documentations has been truncated, see
|
1397
|
+
# {Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice::TieredBpsConfig}
|
1398
|
+
# for more details.
|
1399
|
+
#
|
1400
|
+
# @param tiers [Array<Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice::TieredBpsConfig::Tier>] Tiers for a Graduated BPS pricing model, where usage is bucketed into specified
|
1401
|
+
# ...
|
1472
1402
|
|
1473
1403
|
class Tier < Orb::Internal::Type::BaseModel
|
1474
1404
|
# @!attribute bps
|
@@ -1495,15 +1425,14 @@ module Orb
|
|
1495
1425
|
# @return [String, nil]
|
1496
1426
|
optional :per_unit_maximum, String, nil?: true
|
1497
1427
|
|
1498
|
-
# @!
|
1499
|
-
#
|
1500
|
-
#
|
1501
|
-
#
|
1502
|
-
#
|
1503
|
-
#
|
1504
|
-
#
|
1505
|
-
|
1506
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
1428
|
+
# @!method initialize(bps:, minimum_amount:, maximum_amount: nil, per_unit_maximum: nil)
|
1429
|
+
# @param bps [Float] Per-event basis point rate
|
1430
|
+
#
|
1431
|
+
# @param minimum_amount [String] Exclusive tier starting value
|
1432
|
+
#
|
1433
|
+
# @param maximum_amount [String, nil] Inclusive tier ending value
|
1434
|
+
#
|
1435
|
+
# @param per_unit_maximum [String, nil] Per unit maximum to charge
|
1507
1436
|
end
|
1508
1437
|
end
|
1509
1438
|
|
@@ -1522,16 +1451,13 @@ module Orb
|
|
1522
1451
|
required :duration_unit,
|
1523
1452
|
enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice::BillingCycleConfiguration::DurationUnit }
|
1524
1453
|
|
1525
|
-
# @!
|
1526
|
-
#
|
1527
|
-
#
|
1528
|
-
#
|
1529
|
-
#
|
1530
|
-
#
|
1531
|
-
#
|
1532
|
-
# def initialize(duration:, duration_unit:, **) = super
|
1533
|
-
|
1534
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
1454
|
+
# @!method initialize(duration:, duration_unit:)
|
1455
|
+
# For custom cadence: specifies the duration of the billing period in days or
|
1456
|
+
# months.
|
1457
|
+
#
|
1458
|
+
# @param duration [Integer] The duration of the billing period.
|
1459
|
+
#
|
1460
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
1535
1461
|
|
1536
1462
|
# The unit of billing period duration.
|
1537
1463
|
#
|
@@ -1542,11 +1468,8 @@ module Orb
|
|
1542
1468
|
DAY = :day
|
1543
1469
|
MONTH = :month
|
1544
1470
|
|
1545
|
-
|
1546
|
-
|
1547
|
-
# @!parse
|
1548
|
-
# # @return [Array<Symbol>]
|
1549
|
-
# def self.values; end
|
1471
|
+
# @!method self.values
|
1472
|
+
# @return [Array<Symbol>]
|
1550
1473
|
end
|
1551
1474
|
end
|
1552
1475
|
|
@@ -1565,16 +1488,13 @@ module Orb
|
|
1565
1488
|
required :duration_unit,
|
1566
1489
|
enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice::InvoicingCycleConfiguration::DurationUnit }
|
1567
1490
|
|
1568
|
-
# @!
|
1569
|
-
#
|
1570
|
-
#
|
1571
|
-
#
|
1572
|
-
#
|
1573
|
-
#
|
1574
|
-
#
|
1575
|
-
# def initialize(duration:, duration_unit:, **) = super
|
1576
|
-
|
1577
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
1491
|
+
# @!method initialize(duration:, duration_unit:)
|
1492
|
+
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
1493
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
1494
|
+
#
|
1495
|
+
# @param duration [Integer] The duration of the billing period.
|
1496
|
+
#
|
1497
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
1578
1498
|
|
1579
1499
|
# The unit of billing period duration.
|
1580
1500
|
#
|
@@ -1585,11 +1505,8 @@ module Orb
|
|
1585
1505
|
DAY = :day
|
1586
1506
|
MONTH = :month
|
1587
1507
|
|
1588
|
-
|
1589
|
-
|
1590
|
-
# @!parse
|
1591
|
-
# # @return [Array<Symbol>]
|
1592
|
-
# def self.values; end
|
1508
|
+
# @!method self.values
|
1509
|
+
# @return [Array<Symbol>]
|
1593
1510
|
end
|
1594
1511
|
end
|
1595
1512
|
end
|
@@ -1695,45 +1612,46 @@ module Orb
|
|
1695
1612
|
# @return [Hash{Symbol=>String, nil}, nil]
|
1696
1613
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
1697
1614
|
|
1698
|
-
# @!
|
1699
|
-
#
|
1700
|
-
#
|
1701
|
-
#
|
1702
|
-
#
|
1703
|
-
#
|
1704
|
-
#
|
1705
|
-
#
|
1706
|
-
#
|
1707
|
-
#
|
1708
|
-
#
|
1709
|
-
#
|
1710
|
-
#
|
1711
|
-
#
|
1712
|
-
#
|
1713
|
-
#
|
1714
|
-
#
|
1715
|
-
#
|
1716
|
-
#
|
1717
|
-
#
|
1718
|
-
#
|
1719
|
-
#
|
1720
|
-
#
|
1721
|
-
#
|
1722
|
-
#
|
1723
|
-
#
|
1724
|
-
#
|
1725
|
-
#
|
1726
|
-
#
|
1727
|
-
#
|
1728
|
-
#
|
1729
|
-
#
|
1730
|
-
#
|
1731
|
-
#
|
1732
|
-
#
|
1733
|
-
#
|
1734
|
-
#
|
1735
|
-
|
1736
|
-
#
|
1615
|
+
# @!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
|
+
# Some parameter documentations has been truncated, see
|
1617
|
+
# {Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice} for more details.
|
1618
|
+
#
|
1619
|
+
# @param bps_config [Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice::BpsConfig]
|
1620
|
+
#
|
1621
|
+
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice::Cadence] The cadence to bill for this price on.
|
1622
|
+
#
|
1623
|
+
# @param item_id [String] The id of the item the price will be associated with.
|
1624
|
+
#
|
1625
|
+
# @param name [String] The name of the price.
|
1626
|
+
#
|
1627
|
+
# @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
|
+
#
|
1630
|
+
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
1631
|
+
# ...
|
1632
|
+
#
|
1633
|
+
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
1634
|
+
# ...
|
1635
|
+
#
|
1636
|
+
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
1637
|
+
#
|
1638
|
+
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
1639
|
+
# ...
|
1640
|
+
#
|
1641
|
+
# @param external_price_id [String, nil] An alias for the price.
|
1642
|
+
#
|
1643
|
+
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
1644
|
+
# ...
|
1645
|
+
#
|
1646
|
+
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
1647
|
+
#
|
1648
|
+
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
1649
|
+
# ...
|
1650
|
+
#
|
1651
|
+
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
1652
|
+
# ...
|
1653
|
+
#
|
1654
|
+
# @param model_type [Symbol, :bps]
|
1737
1655
|
|
1738
1656
|
# @see Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice#bps_config
|
1739
1657
|
class BpsConfig < Orb::Internal::Type::BaseModel
|
@@ -1749,13 +1667,10 @@ module Orb
|
|
1749
1667
|
# @return [String, nil]
|
1750
1668
|
optional :per_unit_maximum, String, nil?: true
|
1751
1669
|
|
1752
|
-
# @!
|
1753
|
-
#
|
1754
|
-
#
|
1755
|
-
#
|
1756
|
-
# def initialize(bps:, per_unit_maximum: nil, **) = super
|
1757
|
-
|
1758
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
1670
|
+
# @!method initialize(bps:, per_unit_maximum: nil)
|
1671
|
+
# @param bps [Float] Basis point take rate per event
|
1672
|
+
#
|
1673
|
+
# @param per_unit_maximum [String, nil] Optional currency amount maximum to cap spend per event
|
1759
1674
|
end
|
1760
1675
|
|
1761
1676
|
# The cadence to bill for this price on.
|
@@ -1771,11 +1686,8 @@ module Orb
|
|
1771
1686
|
ONE_TIME = :one_time
|
1772
1687
|
CUSTOM = :custom
|
1773
1688
|
|
1774
|
-
|
1775
|
-
|
1776
|
-
# @!parse
|
1777
|
-
# # @return [Array<Symbol>]
|
1778
|
-
# def self.values; end
|
1689
|
+
# @!method self.values
|
1690
|
+
# @return [Array<Symbol>]
|
1779
1691
|
end
|
1780
1692
|
|
1781
1693
|
# @see Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice#billing_cycle_configuration
|
@@ -1793,16 +1705,13 @@ module Orb
|
|
1793
1705
|
required :duration_unit,
|
1794
1706
|
enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice::BillingCycleConfiguration::DurationUnit }
|
1795
1707
|
|
1796
|
-
# @!
|
1797
|
-
#
|
1798
|
-
#
|
1799
|
-
#
|
1800
|
-
#
|
1801
|
-
#
|
1802
|
-
#
|
1803
|
-
# def initialize(duration:, duration_unit:, **) = super
|
1804
|
-
|
1805
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
1708
|
+
# @!method initialize(duration:, duration_unit:)
|
1709
|
+
# For custom cadence: specifies the duration of the billing period in days or
|
1710
|
+
# months.
|
1711
|
+
#
|
1712
|
+
# @param duration [Integer] The duration of the billing period.
|
1713
|
+
#
|
1714
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
1806
1715
|
|
1807
1716
|
# The unit of billing period duration.
|
1808
1717
|
#
|
@@ -1813,11 +1722,8 @@ module Orb
|
|
1813
1722
|
DAY = :day
|
1814
1723
|
MONTH = :month
|
1815
1724
|
|
1816
|
-
|
1817
|
-
|
1818
|
-
# @!parse
|
1819
|
-
# # @return [Array<Symbol>]
|
1820
|
-
# def self.values; end
|
1725
|
+
# @!method self.values
|
1726
|
+
# @return [Array<Symbol>]
|
1821
1727
|
end
|
1822
1728
|
end
|
1823
1729
|
|
@@ -1836,16 +1742,13 @@ module Orb
|
|
1836
1742
|
required :duration_unit,
|
1837
1743
|
enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice::InvoicingCycleConfiguration::DurationUnit }
|
1838
1744
|
|
1839
|
-
# @!
|
1840
|
-
#
|
1841
|
-
#
|
1842
|
-
#
|
1843
|
-
#
|
1844
|
-
#
|
1845
|
-
#
|
1846
|
-
# def initialize(duration:, duration_unit:, **) = super
|
1847
|
-
|
1848
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
1745
|
+
# @!method initialize(duration:, duration_unit:)
|
1746
|
+
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
1747
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
1748
|
+
#
|
1749
|
+
# @param duration [Integer] The duration of the billing period.
|
1750
|
+
#
|
1751
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
1849
1752
|
|
1850
1753
|
# The unit of billing period duration.
|
1851
1754
|
#
|
@@ -1856,11 +1759,8 @@ module Orb
|
|
1856
1759
|
DAY = :day
|
1857
1760
|
MONTH = :month
|
1858
1761
|
|
1859
|
-
|
1860
|
-
|
1861
|
-
# @!parse
|
1862
|
-
# # @return [Array<Symbol>]
|
1863
|
-
# def self.values; end
|
1762
|
+
# @!method self.values
|
1763
|
+
# @return [Array<Symbol>]
|
1864
1764
|
end
|
1865
1765
|
end
|
1866
1766
|
end
|
@@ -1966,45 +1866,46 @@ module Orb
|
|
1966
1866
|
# @return [Hash{Symbol=>String, nil}, nil]
|
1967
1867
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
1968
1868
|
|
1969
|
-
# @!
|
1970
|
-
#
|
1971
|
-
#
|
1972
|
-
#
|
1973
|
-
#
|
1974
|
-
#
|
1975
|
-
#
|
1976
|
-
#
|
1977
|
-
#
|
1978
|
-
#
|
1979
|
-
#
|
1980
|
-
#
|
1981
|
-
#
|
1982
|
-
#
|
1983
|
-
#
|
1984
|
-
#
|
1985
|
-
#
|
1986
|
-
#
|
1987
|
-
#
|
1988
|
-
#
|
1989
|
-
#
|
1990
|
-
#
|
1991
|
-
#
|
1992
|
-
#
|
1993
|
-
#
|
1994
|
-
#
|
1995
|
-
#
|
1996
|
-
#
|
1997
|
-
#
|
1998
|
-
#
|
1999
|
-
#
|
2000
|
-
#
|
2001
|
-
#
|
2002
|
-
#
|
2003
|
-
#
|
2004
|
-
#
|
2005
|
-
#
|
2006
|
-
|
2007
|
-
#
|
1869
|
+
# @!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
|
+
# Some parameter documentations has been truncated, see
|
1871
|
+
# {Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice} for more details.
|
1872
|
+
#
|
1873
|
+
# @param bulk_bps_config [Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice::BulkBpsConfig]
|
1874
|
+
#
|
1875
|
+
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice::Cadence] The cadence to bill for this price on.
|
1876
|
+
#
|
1877
|
+
# @param item_id [String] The id of the item the price will be associated with.
|
1878
|
+
#
|
1879
|
+
# @param name [String] The name of the price.
|
1880
|
+
#
|
1881
|
+
# @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
|
+
#
|
1884
|
+
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
1885
|
+
# ...
|
1886
|
+
#
|
1887
|
+
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
1888
|
+
# ...
|
1889
|
+
#
|
1890
|
+
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
1891
|
+
#
|
1892
|
+
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
1893
|
+
# ...
|
1894
|
+
#
|
1895
|
+
# @param external_price_id [String, nil] An alias for the price.
|
1896
|
+
#
|
1897
|
+
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
1898
|
+
# ...
|
1899
|
+
#
|
1900
|
+
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
1901
|
+
#
|
1902
|
+
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
1903
|
+
# ...
|
1904
|
+
#
|
1905
|
+
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
1906
|
+
# ...
|
1907
|
+
#
|
1908
|
+
# @param model_type [Symbol, :bulk_bps]
|
2008
1909
|
|
2009
1910
|
# @see Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice#bulk_bps_config
|
2010
1911
|
class BulkBpsConfig < Orb::Internal::Type::BaseModel
|
@@ -2016,12 +1917,13 @@ module Orb
|
|
2016
1917
|
required :tiers,
|
2017
1918
|
-> { Orb::Internal::Type::ArrayOf[Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice::BulkBpsConfig::Tier] }
|
2018
1919
|
|
2019
|
-
# @!
|
2020
|
-
#
|
2021
|
-
#
|
2022
|
-
#
|
2023
|
-
|
2024
|
-
#
|
1920
|
+
# @!method initialize(tiers:)
|
1921
|
+
# Some parameter documentations has been truncated, see
|
1922
|
+
# {Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice::BulkBpsConfig} for
|
1923
|
+
# more details.
|
1924
|
+
#
|
1925
|
+
# @param tiers [Array<Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice::BulkBpsConfig::Tier>] Tiers for a bulk BPS pricing model where all usage is aggregated to a single tie
|
1926
|
+
# ...
|
2025
1927
|
|
2026
1928
|
class Tier < Orb::Internal::Type::BaseModel
|
2027
1929
|
# @!attribute bps
|
@@ -2042,14 +1944,12 @@ module Orb
|
|
2042
1944
|
# @return [String, nil]
|
2043
1945
|
optional :per_unit_maximum, String, nil?: true
|
2044
1946
|
|
2045
|
-
# @!
|
2046
|
-
#
|
2047
|
-
#
|
2048
|
-
#
|
2049
|
-
#
|
2050
|
-
#
|
2051
|
-
|
2052
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
1947
|
+
# @!method initialize(bps:, maximum_amount: nil, per_unit_maximum: nil)
|
1948
|
+
# @param bps [Float] Basis points to rate on
|
1949
|
+
#
|
1950
|
+
# @param maximum_amount [String, nil] Upper bound for tier
|
1951
|
+
#
|
1952
|
+
# @param per_unit_maximum [String, nil] The maximum amount to charge for any one event
|
2053
1953
|
end
|
2054
1954
|
end
|
2055
1955
|
|
@@ -2066,11 +1966,8 @@ module Orb
|
|
2066
1966
|
ONE_TIME = :one_time
|
2067
1967
|
CUSTOM = :custom
|
2068
1968
|
|
2069
|
-
|
2070
|
-
|
2071
|
-
# @!parse
|
2072
|
-
# # @return [Array<Symbol>]
|
2073
|
-
# def self.values; end
|
1969
|
+
# @!method self.values
|
1970
|
+
# @return [Array<Symbol>]
|
2074
1971
|
end
|
2075
1972
|
|
2076
1973
|
# @see Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice#billing_cycle_configuration
|
@@ -2088,16 +1985,13 @@ module Orb
|
|
2088
1985
|
required :duration_unit,
|
2089
1986
|
enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice::BillingCycleConfiguration::DurationUnit }
|
2090
1987
|
|
2091
|
-
# @!
|
2092
|
-
#
|
2093
|
-
#
|
2094
|
-
#
|
2095
|
-
#
|
2096
|
-
#
|
2097
|
-
#
|
2098
|
-
# def initialize(duration:, duration_unit:, **) = super
|
2099
|
-
|
2100
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
1988
|
+
# @!method initialize(duration:, duration_unit:)
|
1989
|
+
# For custom cadence: specifies the duration of the billing period in days or
|
1990
|
+
# months.
|
1991
|
+
#
|
1992
|
+
# @param duration [Integer] The duration of the billing period.
|
1993
|
+
#
|
1994
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
2101
1995
|
|
2102
1996
|
# The unit of billing period duration.
|
2103
1997
|
#
|
@@ -2108,11 +2002,8 @@ module Orb
|
|
2108
2002
|
DAY = :day
|
2109
2003
|
MONTH = :month
|
2110
2004
|
|
2111
|
-
|
2112
|
-
|
2113
|
-
# @!parse
|
2114
|
-
# # @return [Array<Symbol>]
|
2115
|
-
# def self.values; end
|
2005
|
+
# @!method self.values
|
2006
|
+
# @return [Array<Symbol>]
|
2116
2007
|
end
|
2117
2008
|
end
|
2118
2009
|
|
@@ -2131,16 +2022,13 @@ module Orb
|
|
2131
2022
|
required :duration_unit,
|
2132
2023
|
enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice::InvoicingCycleConfiguration::DurationUnit }
|
2133
2024
|
|
2134
|
-
# @!
|
2135
|
-
#
|
2136
|
-
#
|
2137
|
-
#
|
2138
|
-
#
|
2139
|
-
#
|
2140
|
-
#
|
2141
|
-
# def initialize(duration:, duration_unit:, **) = super
|
2142
|
-
|
2143
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
2025
|
+
# @!method initialize(duration:, duration_unit:)
|
2026
|
+
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
2027
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
2028
|
+
#
|
2029
|
+
# @param duration [Integer] The duration of the billing period.
|
2030
|
+
#
|
2031
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
2144
2032
|
|
2145
2033
|
# The unit of billing period duration.
|
2146
2034
|
#
|
@@ -2151,11 +2039,8 @@ module Orb
|
|
2151
2039
|
DAY = :day
|
2152
2040
|
MONTH = :month
|
2153
2041
|
|
2154
|
-
|
2155
|
-
|
2156
|
-
# @!parse
|
2157
|
-
# # @return [Array<Symbol>]
|
2158
|
-
# def self.values; end
|
2042
|
+
# @!method self.values
|
2043
|
+
# @return [Array<Symbol>]
|
2159
2044
|
end
|
2160
2045
|
end
|
2161
2046
|
end
|
@@ -2261,45 +2146,46 @@ module Orb
|
|
2261
2146
|
# @return [Hash{Symbol=>String, nil}, nil]
|
2262
2147
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
2263
2148
|
|
2264
|
-
# @!
|
2265
|
-
#
|
2266
|
-
#
|
2267
|
-
#
|
2268
|
-
#
|
2269
|
-
#
|
2270
|
-
#
|
2271
|
-
#
|
2272
|
-
#
|
2273
|
-
#
|
2274
|
-
#
|
2275
|
-
#
|
2276
|
-
#
|
2277
|
-
#
|
2278
|
-
#
|
2279
|
-
#
|
2280
|
-
#
|
2281
|
-
#
|
2282
|
-
#
|
2283
|
-
#
|
2284
|
-
#
|
2285
|
-
#
|
2286
|
-
#
|
2287
|
-
#
|
2288
|
-
#
|
2289
|
-
#
|
2290
|
-
#
|
2291
|
-
#
|
2292
|
-
#
|
2293
|
-
#
|
2294
|
-
#
|
2295
|
-
#
|
2296
|
-
#
|
2297
|
-
#
|
2298
|
-
#
|
2299
|
-
#
|
2300
|
-
#
|
2301
|
-
|
2302
|
-
#
|
2149
|
+
# @!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
|
+
# Some parameter documentations has been truncated, see
|
2151
|
+
# {Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice} for more details.
|
2152
|
+
#
|
2153
|
+
# @param bulk_config [Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice::BulkConfig]
|
2154
|
+
#
|
2155
|
+
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice::Cadence] The cadence to bill for this price on.
|
2156
|
+
#
|
2157
|
+
# @param item_id [String] The id of the item the price will be associated with.
|
2158
|
+
#
|
2159
|
+
# @param name [String] The name of the price.
|
2160
|
+
#
|
2161
|
+
# @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
|
+
#
|
2164
|
+
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
2165
|
+
# ...
|
2166
|
+
#
|
2167
|
+
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
2168
|
+
# ...
|
2169
|
+
#
|
2170
|
+
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
2171
|
+
#
|
2172
|
+
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
2173
|
+
# ...
|
2174
|
+
#
|
2175
|
+
# @param external_price_id [String, nil] An alias for the price.
|
2176
|
+
#
|
2177
|
+
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
2178
|
+
# ...
|
2179
|
+
#
|
2180
|
+
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
2181
|
+
#
|
2182
|
+
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
2183
|
+
# ...
|
2184
|
+
#
|
2185
|
+
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
2186
|
+
# ...
|
2187
|
+
#
|
2188
|
+
# @param model_type [Symbol, :bulk]
|
2303
2189
|
|
2304
2190
|
# @see Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice#bulk_config
|
2305
2191
|
class BulkConfig < Orb::Internal::Type::BaseModel
|
@@ -2310,12 +2196,8 @@ module Orb
|
|
2310
2196
|
required :tiers,
|
2311
2197
|
-> { Orb::Internal::Type::ArrayOf[Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice::BulkConfig::Tier] }
|
2312
2198
|
|
2313
|
-
# @!
|
2314
|
-
#
|
2315
|
-
# #
|
2316
|
-
# def initialize(tiers:, **) = super
|
2317
|
-
|
2318
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
2199
|
+
# @!method initialize(tiers:)
|
2200
|
+
# @param tiers [Array<Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice::BulkConfig::Tier>] Bulk tiers for rating based on total usage volume
|
2319
2201
|
|
2320
2202
|
class Tier < Orb::Internal::Type::BaseModel
|
2321
2203
|
# @!attribute unit_amount
|
@@ -2330,13 +2212,10 @@ module Orb
|
|
2330
2212
|
# @return [Float, nil]
|
2331
2213
|
optional :maximum_units, Float, nil?: true
|
2332
2214
|
|
2333
|
-
# @!
|
2334
|
-
#
|
2335
|
-
#
|
2336
|
-
#
|
2337
|
-
# def initialize(unit_amount:, maximum_units: nil, **) = super
|
2338
|
-
|
2339
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
2215
|
+
# @!method initialize(unit_amount:, maximum_units: nil)
|
2216
|
+
# @param unit_amount [String] Amount per unit
|
2217
|
+
#
|
2218
|
+
# @param maximum_units [Float, nil] Upper bound for this tier
|
2340
2219
|
end
|
2341
2220
|
end
|
2342
2221
|
|
@@ -2353,11 +2232,8 @@ module Orb
|
|
2353
2232
|
ONE_TIME = :one_time
|
2354
2233
|
CUSTOM = :custom
|
2355
2234
|
|
2356
|
-
|
2357
|
-
|
2358
|
-
# @!parse
|
2359
|
-
# # @return [Array<Symbol>]
|
2360
|
-
# def self.values; end
|
2235
|
+
# @!method self.values
|
2236
|
+
# @return [Array<Symbol>]
|
2361
2237
|
end
|
2362
2238
|
|
2363
2239
|
# @see Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice#billing_cycle_configuration
|
@@ -2375,16 +2251,13 @@ module Orb
|
|
2375
2251
|
required :duration_unit,
|
2376
2252
|
enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice::BillingCycleConfiguration::DurationUnit }
|
2377
2253
|
|
2378
|
-
# @!
|
2379
|
-
#
|
2380
|
-
#
|
2381
|
-
#
|
2382
|
-
#
|
2383
|
-
#
|
2384
|
-
#
|
2385
|
-
# def initialize(duration:, duration_unit:, **) = super
|
2386
|
-
|
2387
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
2254
|
+
# @!method initialize(duration:, duration_unit:)
|
2255
|
+
# For custom cadence: specifies the duration of the billing period in days or
|
2256
|
+
# months.
|
2257
|
+
#
|
2258
|
+
# @param duration [Integer] The duration of the billing period.
|
2259
|
+
#
|
2260
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
2388
2261
|
|
2389
2262
|
# The unit of billing period duration.
|
2390
2263
|
#
|
@@ -2395,11 +2268,8 @@ module Orb
|
|
2395
2268
|
DAY = :day
|
2396
2269
|
MONTH = :month
|
2397
2270
|
|
2398
|
-
|
2399
|
-
|
2400
|
-
# @!parse
|
2401
|
-
# # @return [Array<Symbol>]
|
2402
|
-
# def self.values; end
|
2271
|
+
# @!method self.values
|
2272
|
+
# @return [Array<Symbol>]
|
2403
2273
|
end
|
2404
2274
|
end
|
2405
2275
|
|
@@ -2418,16 +2288,13 @@ module Orb
|
|
2418
2288
|
required :duration_unit,
|
2419
2289
|
enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice::InvoicingCycleConfiguration::DurationUnit }
|
2420
2290
|
|
2421
|
-
# @!
|
2422
|
-
#
|
2423
|
-
#
|
2424
|
-
#
|
2425
|
-
#
|
2426
|
-
#
|
2427
|
-
#
|
2428
|
-
# def initialize(duration:, duration_unit:, **) = super
|
2429
|
-
|
2430
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
2291
|
+
# @!method initialize(duration:, duration_unit:)
|
2292
|
+
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
2293
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
2294
|
+
#
|
2295
|
+
# @param duration [Integer] The duration of the billing period.
|
2296
|
+
#
|
2297
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
2431
2298
|
|
2432
2299
|
# The unit of billing period duration.
|
2433
2300
|
#
|
@@ -2438,11 +2305,8 @@ module Orb
|
|
2438
2305
|
DAY = :day
|
2439
2306
|
MONTH = :month
|
2440
2307
|
|
2441
|
-
|
2442
|
-
|
2443
|
-
# @!parse
|
2444
|
-
# # @return [Array<Symbol>]
|
2445
|
-
# def self.values; end
|
2308
|
+
# @!method self.values
|
2309
|
+
# @return [Array<Symbol>]
|
2446
2310
|
end
|
2447
2311
|
end
|
2448
2312
|
end
|
@@ -2549,45 +2413,47 @@ module Orb
|
|
2549
2413
|
# @return [Hash{Symbol=>String, nil}, nil]
|
2550
2414
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
2551
2415
|
|
2552
|
-
# @!
|
2553
|
-
#
|
2554
|
-
#
|
2555
|
-
#
|
2556
|
-
#
|
2557
|
-
#
|
2558
|
-
#
|
2559
|
-
#
|
2560
|
-
#
|
2561
|
-
#
|
2562
|
-
#
|
2563
|
-
#
|
2564
|
-
#
|
2565
|
-
#
|
2566
|
-
#
|
2567
|
-
#
|
2568
|
-
#
|
2569
|
-
#
|
2570
|
-
#
|
2571
|
-
#
|
2572
|
-
#
|
2573
|
-
#
|
2574
|
-
#
|
2575
|
-
#
|
2576
|
-
#
|
2577
|
-
#
|
2578
|
-
#
|
2579
|
-
#
|
2580
|
-
#
|
2581
|
-
#
|
2582
|
-
#
|
2583
|
-
#
|
2584
|
-
#
|
2585
|
-
#
|
2586
|
-
#
|
2587
|
-
#
|
2588
|
-
#
|
2589
|
-
|
2590
|
-
#
|
2416
|
+
# @!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
|
+
# Some parameter documentations has been truncated, see
|
2418
|
+
# {Orb::Models::PlanCreateParams::Price::NewPlanThresholdTotalAmountPrice} for
|
2419
|
+
# more details.
|
2420
|
+
#
|
2421
|
+
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanThresholdTotalAmountPrice::Cadence] The cadence to bill for this price on.
|
2422
|
+
#
|
2423
|
+
# @param item_id [String] The id of the item the price will be associated with.
|
2424
|
+
#
|
2425
|
+
# @param name [String] The name of the price.
|
2426
|
+
#
|
2427
|
+
# @param threshold_total_amount_config [Hash{Symbol=>Object}]
|
2428
|
+
#
|
2429
|
+
# @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
|
+
#
|
2432
|
+
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
2433
|
+
# ...
|
2434
|
+
#
|
2435
|
+
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanThresholdTotalAmountPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
2436
|
+
# ...
|
2437
|
+
#
|
2438
|
+
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
2439
|
+
#
|
2440
|
+
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
2441
|
+
# ...
|
2442
|
+
#
|
2443
|
+
# @param external_price_id [String, nil] An alias for the price.
|
2444
|
+
#
|
2445
|
+
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
2446
|
+
# ...
|
2447
|
+
#
|
2448
|
+
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
2449
|
+
#
|
2450
|
+
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanThresholdTotalAmountPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
2451
|
+
# ...
|
2452
|
+
#
|
2453
|
+
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
2454
|
+
# ...
|
2455
|
+
#
|
2456
|
+
# @param model_type [Symbol, :threshold_total_amount]
|
2591
2457
|
|
2592
2458
|
# The cadence to bill for this price on.
|
2593
2459
|
#
|
@@ -2602,11 +2468,8 @@ module Orb
|
|
2602
2468
|
ONE_TIME = :one_time
|
2603
2469
|
CUSTOM = :custom
|
2604
2470
|
|
2605
|
-
|
2606
|
-
|
2607
|
-
# @!parse
|
2608
|
-
# # @return [Array<Symbol>]
|
2609
|
-
# def self.values; end
|
2471
|
+
# @!method self.values
|
2472
|
+
# @return [Array<Symbol>]
|
2610
2473
|
end
|
2611
2474
|
|
2612
2475
|
# @see Orb::Models::PlanCreateParams::Price::NewPlanThresholdTotalAmountPrice#billing_cycle_configuration
|
@@ -2624,16 +2487,13 @@ module Orb
|
|
2624
2487
|
required :duration_unit,
|
2625
2488
|
enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanThresholdTotalAmountPrice::BillingCycleConfiguration::DurationUnit }
|
2626
2489
|
|
2627
|
-
# @!
|
2628
|
-
#
|
2629
|
-
#
|
2630
|
-
#
|
2631
|
-
#
|
2632
|
-
#
|
2633
|
-
#
|
2634
|
-
# def initialize(duration:, duration_unit:, **) = super
|
2635
|
-
|
2636
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
2490
|
+
# @!method initialize(duration:, duration_unit:)
|
2491
|
+
# For custom cadence: specifies the duration of the billing period in days or
|
2492
|
+
# months.
|
2493
|
+
#
|
2494
|
+
# @param duration [Integer] The duration of the billing period.
|
2495
|
+
#
|
2496
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanThresholdTotalAmountPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
2637
2497
|
|
2638
2498
|
# The unit of billing period duration.
|
2639
2499
|
#
|
@@ -2644,11 +2504,8 @@ module Orb
|
|
2644
2504
|
DAY = :day
|
2645
2505
|
MONTH = :month
|
2646
2506
|
|
2647
|
-
|
2648
|
-
|
2649
|
-
# @!parse
|
2650
|
-
# # @return [Array<Symbol>]
|
2651
|
-
# def self.values; end
|
2507
|
+
# @!method self.values
|
2508
|
+
# @return [Array<Symbol>]
|
2652
2509
|
end
|
2653
2510
|
end
|
2654
2511
|
|
@@ -2667,16 +2524,13 @@ module Orb
|
|
2667
2524
|
required :duration_unit,
|
2668
2525
|
enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanThresholdTotalAmountPrice::InvoicingCycleConfiguration::DurationUnit }
|
2669
2526
|
|
2670
|
-
# @!
|
2671
|
-
#
|
2672
|
-
#
|
2673
|
-
#
|
2674
|
-
#
|
2675
|
-
#
|
2676
|
-
#
|
2677
|
-
# def initialize(duration:, duration_unit:, **) = super
|
2678
|
-
|
2679
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
2527
|
+
# @!method initialize(duration:, duration_unit:)
|
2528
|
+
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
2529
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
2530
|
+
#
|
2531
|
+
# @param duration [Integer] The duration of the billing period.
|
2532
|
+
#
|
2533
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanThresholdTotalAmountPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
2680
2534
|
|
2681
2535
|
# The unit of billing period duration.
|
2682
2536
|
#
|
@@ -2687,11 +2541,8 @@ module Orb
|
|
2687
2541
|
DAY = :day
|
2688
2542
|
MONTH = :month
|
2689
2543
|
|
2690
|
-
|
2691
|
-
|
2692
|
-
# @!parse
|
2693
|
-
# # @return [Array<Symbol>]
|
2694
|
-
# def self.values; end
|
2544
|
+
# @!method self.values
|
2545
|
+
# @return [Array<Symbol>]
|
2695
2546
|
end
|
2696
2547
|
end
|
2697
2548
|
end
|
@@ -2797,46 +2648,48 @@ module Orb
|
|
2797
2648
|
# @return [Hash{Symbol=>String, nil}, nil]
|
2798
2649
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
2799
2650
|
|
2800
|
-
# @!
|
2801
|
-
#
|
2802
|
-
#
|
2803
|
-
#
|
2804
|
-
#
|
2805
|
-
#
|
2806
|
-
#
|
2807
|
-
#
|
2808
|
-
#
|
2809
|
-
#
|
2810
|
-
#
|
2811
|
-
#
|
2812
|
-
#
|
2813
|
-
#
|
2814
|
-
#
|
2815
|
-
#
|
2816
|
-
#
|
2817
|
-
#
|
2818
|
-
#
|
2819
|
-
#
|
2820
|
-
#
|
2821
|
-
#
|
2822
|
-
#
|
2823
|
-
#
|
2824
|
-
#
|
2825
|
-
#
|
2826
|
-
#
|
2827
|
-
#
|
2828
|
-
#
|
2829
|
-
#
|
2830
|
-
#
|
2831
|
-
#
|
2832
|
-
#
|
2833
|
-
#
|
2834
|
-
#
|
2835
|
-
#
|
2836
|
-
#
|
2837
|
-
|
2838
|
-
#
|
2839
|
-
|
2651
|
+
# @!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
|
+
# Some parameter documentations has been truncated, see
|
2653
|
+
# {Orb::Models::PlanCreateParams::Price::NewPlanTieredPackagePrice} for more
|
2654
|
+
# details.
|
2655
|
+
#
|
2656
|
+
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTieredPackagePrice::Cadence] The cadence to bill for this price on.
|
2657
|
+
#
|
2658
|
+
# @param item_id [String] The id of the item the price will be associated with.
|
2659
|
+
#
|
2660
|
+
# @param name [String] The name of the price.
|
2661
|
+
#
|
2662
|
+
# @param tiered_package_config [Hash{Symbol=>Object}]
|
2663
|
+
#
|
2664
|
+
# @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
|
+
#
|
2667
|
+
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
2668
|
+
# ...
|
2669
|
+
#
|
2670
|
+
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanTieredPackagePrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
2671
|
+
# ...
|
2672
|
+
#
|
2673
|
+
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
2674
|
+
#
|
2675
|
+
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
2676
|
+
# ...
|
2677
|
+
#
|
2678
|
+
# @param external_price_id [String, nil] An alias for the price.
|
2679
|
+
#
|
2680
|
+
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
2681
|
+
# ...
|
2682
|
+
#
|
2683
|
+
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
2684
|
+
#
|
2685
|
+
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanTieredPackagePrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
2686
|
+
# ...
|
2687
|
+
#
|
2688
|
+
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
2689
|
+
# ...
|
2690
|
+
#
|
2691
|
+
# @param model_type [Symbol, :tiered_package]
|
2692
|
+
|
2840
2693
|
# The cadence to bill for this price on.
|
2841
2694
|
#
|
2842
2695
|
# @see Orb::Models::PlanCreateParams::Price::NewPlanTieredPackagePrice#cadence
|
@@ -2850,11 +2703,8 @@ module Orb
|
|
2850
2703
|
ONE_TIME = :one_time
|
2851
2704
|
CUSTOM = :custom
|
2852
2705
|
|
2853
|
-
|
2854
|
-
|
2855
|
-
# @!parse
|
2856
|
-
# # @return [Array<Symbol>]
|
2857
|
-
# def self.values; end
|
2706
|
+
# @!method self.values
|
2707
|
+
# @return [Array<Symbol>]
|
2858
2708
|
end
|
2859
2709
|
|
2860
2710
|
# @see Orb::Models::PlanCreateParams::Price::NewPlanTieredPackagePrice#billing_cycle_configuration
|
@@ -2872,16 +2722,13 @@ module Orb
|
|
2872
2722
|
required :duration_unit,
|
2873
2723
|
enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanTieredPackagePrice::BillingCycleConfiguration::DurationUnit }
|
2874
2724
|
|
2875
|
-
# @!
|
2876
|
-
#
|
2877
|
-
#
|
2878
|
-
#
|
2879
|
-
#
|
2880
|
-
#
|
2881
|
-
#
|
2882
|
-
# def initialize(duration:, duration_unit:, **) = super
|
2883
|
-
|
2884
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
2725
|
+
# @!method initialize(duration:, duration_unit:)
|
2726
|
+
# For custom cadence: specifies the duration of the billing period in days or
|
2727
|
+
# months.
|
2728
|
+
#
|
2729
|
+
# @param duration [Integer] The duration of the billing period.
|
2730
|
+
#
|
2731
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTieredPackagePrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
2885
2732
|
|
2886
2733
|
# The unit of billing period duration.
|
2887
2734
|
#
|
@@ -2892,11 +2739,8 @@ module Orb
|
|
2892
2739
|
DAY = :day
|
2893
2740
|
MONTH = :month
|
2894
2741
|
|
2895
|
-
|
2896
|
-
|
2897
|
-
# @!parse
|
2898
|
-
# # @return [Array<Symbol>]
|
2899
|
-
# def self.values; end
|
2742
|
+
# @!method self.values
|
2743
|
+
# @return [Array<Symbol>]
|
2900
2744
|
end
|
2901
2745
|
end
|
2902
2746
|
|
@@ -2915,16 +2759,13 @@ module Orb
|
|
2915
2759
|
required :duration_unit,
|
2916
2760
|
enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit }
|
2917
2761
|
|
2918
|
-
# @!
|
2919
|
-
#
|
2920
|
-
#
|
2921
|
-
#
|
2922
|
-
#
|
2923
|
-
#
|
2924
|
-
#
|
2925
|
-
# def initialize(duration:, duration_unit:, **) = super
|
2926
|
-
|
2927
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
2762
|
+
# @!method initialize(duration:, duration_unit:)
|
2763
|
+
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
2764
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
2765
|
+
#
|
2766
|
+
# @param duration [Integer] The duration of the billing period.
|
2767
|
+
#
|
2768
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
2928
2769
|
|
2929
2770
|
# The unit of billing period duration.
|
2930
2771
|
#
|
@@ -2935,11 +2776,8 @@ module Orb
|
|
2935
2776
|
DAY = :day
|
2936
2777
|
MONTH = :month
|
2937
2778
|
|
2938
|
-
|
2939
|
-
|
2940
|
-
# @!parse
|
2941
|
-
# # @return [Array<Symbol>]
|
2942
|
-
# def self.values; end
|
2779
|
+
# @!method self.values
|
2780
|
+
# @return [Array<Symbol>]
|
2943
2781
|
end
|
2944
2782
|
end
|
2945
2783
|
end
|
@@ -3046,45 +2884,47 @@ module Orb
|
|
3046
2884
|
# @return [Hash{Symbol=>String, nil}, nil]
|
3047
2885
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
3048
2886
|
|
3049
|
-
# @!
|
3050
|
-
#
|
3051
|
-
#
|
3052
|
-
#
|
3053
|
-
#
|
3054
|
-
#
|
3055
|
-
#
|
3056
|
-
#
|
3057
|
-
#
|
3058
|
-
#
|
3059
|
-
#
|
3060
|
-
#
|
3061
|
-
#
|
3062
|
-
#
|
3063
|
-
#
|
3064
|
-
#
|
3065
|
-
#
|
3066
|
-
#
|
3067
|
-
#
|
3068
|
-
#
|
3069
|
-
#
|
3070
|
-
#
|
3071
|
-
#
|
3072
|
-
#
|
3073
|
-
#
|
3074
|
-
#
|
3075
|
-
#
|
3076
|
-
#
|
3077
|
-
#
|
3078
|
-
#
|
3079
|
-
#
|
3080
|
-
#
|
3081
|
-
#
|
3082
|
-
#
|
3083
|
-
#
|
3084
|
-
#
|
3085
|
-
#
|
3086
|
-
|
3087
|
-
#
|
2887
|
+
# @!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
|
+
# Some parameter documentations has been truncated, see
|
2889
|
+
# {Orb::Models::PlanCreateParams::Price::NewPlanTieredWithMinimumPrice} for more
|
2890
|
+
# details.
|
2891
|
+
#
|
2892
|
+
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTieredWithMinimumPrice::Cadence] The cadence to bill for this price on.
|
2893
|
+
#
|
2894
|
+
# @param item_id [String] The id of the item the price will be associated with.
|
2895
|
+
#
|
2896
|
+
# @param name [String] The name of the price.
|
2897
|
+
#
|
2898
|
+
# @param tiered_with_minimum_config [Hash{Symbol=>Object}]
|
2899
|
+
#
|
2900
|
+
# @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
|
+
#
|
2903
|
+
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
2904
|
+
# ...
|
2905
|
+
#
|
2906
|
+
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanTieredWithMinimumPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
2907
|
+
# ...
|
2908
|
+
#
|
2909
|
+
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
2910
|
+
#
|
2911
|
+
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
2912
|
+
# ...
|
2913
|
+
#
|
2914
|
+
# @param external_price_id [String, nil] An alias for the price.
|
2915
|
+
#
|
2916
|
+
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
2917
|
+
# ...
|
2918
|
+
#
|
2919
|
+
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
2920
|
+
#
|
2921
|
+
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanTieredWithMinimumPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
2922
|
+
# ...
|
2923
|
+
#
|
2924
|
+
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
2925
|
+
# ...
|
2926
|
+
#
|
2927
|
+
# @param model_type [Symbol, :tiered_with_minimum]
|
3088
2928
|
|
3089
2929
|
# The cadence to bill for this price on.
|
3090
2930
|
#
|
@@ -3099,11 +2939,8 @@ module Orb
|
|
3099
2939
|
ONE_TIME = :one_time
|
3100
2940
|
CUSTOM = :custom
|
3101
2941
|
|
3102
|
-
|
3103
|
-
|
3104
|
-
# @!parse
|
3105
|
-
# # @return [Array<Symbol>]
|
3106
|
-
# def self.values; end
|
2942
|
+
# @!method self.values
|
2943
|
+
# @return [Array<Symbol>]
|
3107
2944
|
end
|
3108
2945
|
|
3109
2946
|
# @see Orb::Models::PlanCreateParams::Price::NewPlanTieredWithMinimumPrice#billing_cycle_configuration
|
@@ -3121,16 +2958,13 @@ module Orb
|
|
3121
2958
|
required :duration_unit,
|
3122
2959
|
enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanTieredWithMinimumPrice::BillingCycleConfiguration::DurationUnit }
|
3123
2960
|
|
3124
|
-
# @!
|
3125
|
-
#
|
3126
|
-
#
|
3127
|
-
#
|
3128
|
-
#
|
3129
|
-
#
|
3130
|
-
#
|
3131
|
-
# def initialize(duration:, duration_unit:, **) = super
|
3132
|
-
|
3133
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
2961
|
+
# @!method initialize(duration:, duration_unit:)
|
2962
|
+
# For custom cadence: specifies the duration of the billing period in days or
|
2963
|
+
# months.
|
2964
|
+
#
|
2965
|
+
# @param duration [Integer] The duration of the billing period.
|
2966
|
+
#
|
2967
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTieredWithMinimumPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
3134
2968
|
|
3135
2969
|
# The unit of billing period duration.
|
3136
2970
|
#
|
@@ -3141,11 +2975,8 @@ module Orb
|
|
3141
2975
|
DAY = :day
|
3142
2976
|
MONTH = :month
|
3143
2977
|
|
3144
|
-
|
3145
|
-
|
3146
|
-
# @!parse
|
3147
|
-
# # @return [Array<Symbol>]
|
3148
|
-
# def self.values; end
|
2978
|
+
# @!method self.values
|
2979
|
+
# @return [Array<Symbol>]
|
3149
2980
|
end
|
3150
2981
|
end
|
3151
2982
|
|
@@ -3164,16 +2995,13 @@ module Orb
|
|
3164
2995
|
required :duration_unit,
|
3165
2996
|
enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanTieredWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit }
|
3166
2997
|
|
3167
|
-
# @!
|
3168
|
-
#
|
3169
|
-
#
|
3170
|
-
#
|
3171
|
-
#
|
3172
|
-
#
|
3173
|
-
#
|
3174
|
-
# def initialize(duration:, duration_unit:, **) = super
|
3175
|
-
|
3176
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
2998
|
+
# @!method initialize(duration:, duration_unit:)
|
2999
|
+
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
3000
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
3001
|
+
#
|
3002
|
+
# @param duration [Integer] The duration of the billing period.
|
3003
|
+
#
|
3004
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTieredWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
3177
3005
|
|
3178
3006
|
# The unit of billing period duration.
|
3179
3007
|
#
|
@@ -3184,11 +3012,8 @@ module Orb
|
|
3184
3012
|
DAY = :day
|
3185
3013
|
MONTH = :month
|
3186
3014
|
|
3187
|
-
|
3188
|
-
|
3189
|
-
# @!parse
|
3190
|
-
# # @return [Array<Symbol>]
|
3191
|
-
# def self.values; end
|
3015
|
+
# @!method self.values
|
3016
|
+
# @return [Array<Symbol>]
|
3192
3017
|
end
|
3193
3018
|
end
|
3194
3019
|
end
|
@@ -3294,45 +3119,47 @@ module Orb
|
|
3294
3119
|
# @return [Hash{Symbol=>String, nil}, nil]
|
3295
3120
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
3296
3121
|
|
3297
|
-
# @!
|
3298
|
-
#
|
3299
|
-
#
|
3300
|
-
#
|
3301
|
-
#
|
3302
|
-
#
|
3303
|
-
#
|
3304
|
-
#
|
3305
|
-
#
|
3306
|
-
#
|
3307
|
-
#
|
3308
|
-
#
|
3309
|
-
#
|
3310
|
-
#
|
3311
|
-
#
|
3312
|
-
#
|
3313
|
-
#
|
3314
|
-
#
|
3315
|
-
#
|
3316
|
-
#
|
3317
|
-
#
|
3318
|
-
#
|
3319
|
-
#
|
3320
|
-
#
|
3321
|
-
#
|
3322
|
-
#
|
3323
|
-
#
|
3324
|
-
#
|
3325
|
-
#
|
3326
|
-
#
|
3327
|
-
#
|
3328
|
-
#
|
3329
|
-
#
|
3330
|
-
#
|
3331
|
-
#
|
3332
|
-
#
|
3333
|
-
#
|
3334
|
-
|
3335
|
-
#
|
3122
|
+
# @!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
|
+
# Some parameter documentations has been truncated, see
|
3124
|
+
# {Orb::Models::PlanCreateParams::Price::NewPlanUnitWithPercentPrice} for more
|
3125
|
+
# details.
|
3126
|
+
#
|
3127
|
+
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanUnitWithPercentPrice::Cadence] The cadence to bill for this price on.
|
3128
|
+
#
|
3129
|
+
# @param item_id [String] The id of the item the price will be associated with.
|
3130
|
+
#
|
3131
|
+
# @param name [String] The name of the price.
|
3132
|
+
#
|
3133
|
+
# @param unit_with_percent_config [Hash{Symbol=>Object}]
|
3134
|
+
#
|
3135
|
+
# @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
|
+
#
|
3138
|
+
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
3139
|
+
# ...
|
3140
|
+
#
|
3141
|
+
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanUnitWithPercentPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
3142
|
+
# ...
|
3143
|
+
#
|
3144
|
+
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
3145
|
+
#
|
3146
|
+
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
3147
|
+
# ...
|
3148
|
+
#
|
3149
|
+
# @param external_price_id [String, nil] An alias for the price.
|
3150
|
+
#
|
3151
|
+
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
3152
|
+
# ...
|
3153
|
+
#
|
3154
|
+
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
3155
|
+
#
|
3156
|
+
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanUnitWithPercentPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
3157
|
+
# ...
|
3158
|
+
#
|
3159
|
+
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
3160
|
+
# ...
|
3161
|
+
#
|
3162
|
+
# @param model_type [Symbol, :unit_with_percent]
|
3336
3163
|
|
3337
3164
|
# The cadence to bill for this price on.
|
3338
3165
|
#
|
@@ -3347,11 +3174,8 @@ module Orb
|
|
3347
3174
|
ONE_TIME = :one_time
|
3348
3175
|
CUSTOM = :custom
|
3349
3176
|
|
3350
|
-
|
3351
|
-
|
3352
|
-
# @!parse
|
3353
|
-
# # @return [Array<Symbol>]
|
3354
|
-
# def self.values; end
|
3177
|
+
# @!method self.values
|
3178
|
+
# @return [Array<Symbol>]
|
3355
3179
|
end
|
3356
3180
|
|
3357
3181
|
# @see Orb::Models::PlanCreateParams::Price::NewPlanUnitWithPercentPrice#billing_cycle_configuration
|
@@ -3369,16 +3193,13 @@ module Orb
|
|
3369
3193
|
required :duration_unit,
|
3370
3194
|
enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanUnitWithPercentPrice::BillingCycleConfiguration::DurationUnit }
|
3371
3195
|
|
3372
|
-
# @!
|
3373
|
-
#
|
3374
|
-
#
|
3375
|
-
#
|
3376
|
-
#
|
3377
|
-
#
|
3378
|
-
#
|
3379
|
-
# def initialize(duration:, duration_unit:, **) = super
|
3380
|
-
|
3381
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
3196
|
+
# @!method initialize(duration:, duration_unit:)
|
3197
|
+
# For custom cadence: specifies the duration of the billing period in days or
|
3198
|
+
# months.
|
3199
|
+
#
|
3200
|
+
# @param duration [Integer] The duration of the billing period.
|
3201
|
+
#
|
3202
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanUnitWithPercentPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
3382
3203
|
|
3383
3204
|
# The unit of billing period duration.
|
3384
3205
|
#
|
@@ -3389,11 +3210,8 @@ module Orb
|
|
3389
3210
|
DAY = :day
|
3390
3211
|
MONTH = :month
|
3391
3212
|
|
3392
|
-
|
3393
|
-
|
3394
|
-
# @!parse
|
3395
|
-
# # @return [Array<Symbol>]
|
3396
|
-
# def self.values; end
|
3213
|
+
# @!method self.values
|
3214
|
+
# @return [Array<Symbol>]
|
3397
3215
|
end
|
3398
3216
|
end
|
3399
3217
|
|
@@ -3412,16 +3230,13 @@ module Orb
|
|
3412
3230
|
required :duration_unit,
|
3413
3231
|
enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanUnitWithPercentPrice::InvoicingCycleConfiguration::DurationUnit }
|
3414
3232
|
|
3415
|
-
# @!
|
3416
|
-
#
|
3417
|
-
#
|
3418
|
-
#
|
3419
|
-
#
|
3420
|
-
#
|
3421
|
-
#
|
3422
|
-
# def initialize(duration:, duration_unit:, **) = super
|
3423
|
-
|
3424
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
3233
|
+
# @!method initialize(duration:, duration_unit:)
|
3234
|
+
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
3235
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
3236
|
+
#
|
3237
|
+
# @param duration [Integer] The duration of the billing period.
|
3238
|
+
#
|
3239
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanUnitWithPercentPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
3425
3240
|
|
3426
3241
|
# The unit of billing period duration.
|
3427
3242
|
#
|
@@ -3432,11 +3247,8 @@ module Orb
|
|
3432
3247
|
DAY = :day
|
3433
3248
|
MONTH = :month
|
3434
3249
|
|
3435
|
-
|
3436
|
-
|
3437
|
-
# @!parse
|
3438
|
-
# # @return [Array<Symbol>]
|
3439
|
-
# def self.values; end
|
3250
|
+
# @!method self.values
|
3251
|
+
# @return [Array<Symbol>]
|
3440
3252
|
end
|
3441
3253
|
end
|
3442
3254
|
end
|
@@ -3543,45 +3355,47 @@ module Orb
|
|
3543
3355
|
# @return [Hash{Symbol=>String, nil}, nil]
|
3544
3356
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
3545
3357
|
|
3546
|
-
# @!
|
3547
|
-
#
|
3548
|
-
#
|
3549
|
-
#
|
3550
|
-
#
|
3551
|
-
#
|
3552
|
-
#
|
3553
|
-
#
|
3554
|
-
#
|
3555
|
-
#
|
3556
|
-
#
|
3557
|
-
#
|
3558
|
-
#
|
3559
|
-
#
|
3560
|
-
#
|
3561
|
-
#
|
3562
|
-
#
|
3563
|
-
#
|
3564
|
-
#
|
3565
|
-
#
|
3566
|
-
#
|
3567
|
-
#
|
3568
|
-
#
|
3569
|
-
#
|
3570
|
-
#
|
3571
|
-
#
|
3572
|
-
#
|
3573
|
-
#
|
3574
|
-
#
|
3575
|
-
#
|
3576
|
-
#
|
3577
|
-
#
|
3578
|
-
#
|
3579
|
-
#
|
3580
|
-
#
|
3581
|
-
#
|
3582
|
-
#
|
3583
|
-
|
3584
|
-
#
|
3358
|
+
# @!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
|
+
# Some parameter documentations has been truncated, see
|
3360
|
+
# {Orb::Models::PlanCreateParams::Price::NewPlanPackageWithAllocationPrice} for
|
3361
|
+
# more details.
|
3362
|
+
#
|
3363
|
+
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanPackageWithAllocationPrice::Cadence] The cadence to bill for this price on.
|
3364
|
+
#
|
3365
|
+
# @param item_id [String] The id of the item the price will be associated with.
|
3366
|
+
#
|
3367
|
+
# @param name [String] The name of the price.
|
3368
|
+
#
|
3369
|
+
# @param package_with_allocation_config [Hash{Symbol=>Object}]
|
3370
|
+
#
|
3371
|
+
# @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
|
+
#
|
3374
|
+
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
3375
|
+
# ...
|
3376
|
+
#
|
3377
|
+
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanPackageWithAllocationPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
3378
|
+
# ...
|
3379
|
+
#
|
3380
|
+
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
3381
|
+
#
|
3382
|
+
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
3383
|
+
# ...
|
3384
|
+
#
|
3385
|
+
# @param external_price_id [String, nil] An alias for the price.
|
3386
|
+
#
|
3387
|
+
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
3388
|
+
# ...
|
3389
|
+
#
|
3390
|
+
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
3391
|
+
#
|
3392
|
+
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanPackageWithAllocationPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
3393
|
+
# ...
|
3394
|
+
#
|
3395
|
+
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
3396
|
+
# ...
|
3397
|
+
#
|
3398
|
+
# @param model_type [Symbol, :package_with_allocation]
|
3585
3399
|
|
3586
3400
|
# The cadence to bill for this price on.
|
3587
3401
|
#
|
@@ -3596,11 +3410,8 @@ module Orb
|
|
3596
3410
|
ONE_TIME = :one_time
|
3597
3411
|
CUSTOM = :custom
|
3598
3412
|
|
3599
|
-
|
3600
|
-
|
3601
|
-
# @!parse
|
3602
|
-
# # @return [Array<Symbol>]
|
3603
|
-
# def self.values; end
|
3413
|
+
# @!method self.values
|
3414
|
+
# @return [Array<Symbol>]
|
3604
3415
|
end
|
3605
3416
|
|
3606
3417
|
# @see Orb::Models::PlanCreateParams::Price::NewPlanPackageWithAllocationPrice#billing_cycle_configuration
|
@@ -3618,16 +3429,13 @@ module Orb
|
|
3618
3429
|
required :duration_unit,
|
3619
3430
|
enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanPackageWithAllocationPrice::BillingCycleConfiguration::DurationUnit }
|
3620
3431
|
|
3621
|
-
# @!
|
3622
|
-
#
|
3623
|
-
#
|
3624
|
-
#
|
3625
|
-
#
|
3626
|
-
#
|
3627
|
-
#
|
3628
|
-
# def initialize(duration:, duration_unit:, **) = super
|
3629
|
-
|
3630
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
3432
|
+
# @!method initialize(duration:, duration_unit:)
|
3433
|
+
# For custom cadence: specifies the duration of the billing period in days or
|
3434
|
+
# months.
|
3435
|
+
#
|
3436
|
+
# @param duration [Integer] The duration of the billing period.
|
3437
|
+
#
|
3438
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanPackageWithAllocationPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
3631
3439
|
|
3632
3440
|
# The unit of billing period duration.
|
3633
3441
|
#
|
@@ -3638,11 +3446,8 @@ module Orb
|
|
3638
3446
|
DAY = :day
|
3639
3447
|
MONTH = :month
|
3640
3448
|
|
3641
|
-
|
3642
|
-
|
3643
|
-
# @!parse
|
3644
|
-
# # @return [Array<Symbol>]
|
3645
|
-
# def self.values; end
|
3449
|
+
# @!method self.values
|
3450
|
+
# @return [Array<Symbol>]
|
3646
3451
|
end
|
3647
3452
|
end
|
3648
3453
|
|
@@ -3661,16 +3466,13 @@ module Orb
|
|
3661
3466
|
required :duration_unit,
|
3662
3467
|
enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanPackageWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit }
|
3663
3468
|
|
3664
|
-
# @!
|
3665
|
-
#
|
3666
|
-
#
|
3667
|
-
#
|
3668
|
-
#
|
3669
|
-
#
|
3670
|
-
#
|
3671
|
-
# def initialize(duration:, duration_unit:, **) = super
|
3672
|
-
|
3673
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
3469
|
+
# @!method initialize(duration:, duration_unit:)
|
3470
|
+
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
3471
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
3472
|
+
#
|
3473
|
+
# @param duration [Integer] The duration of the billing period.
|
3474
|
+
#
|
3475
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanPackageWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
3674
3476
|
|
3675
3477
|
# The unit of billing period duration.
|
3676
3478
|
#
|
@@ -3681,11 +3483,8 @@ module Orb
|
|
3681
3483
|
DAY = :day
|
3682
3484
|
MONTH = :month
|
3683
3485
|
|
3684
|
-
|
3685
|
-
|
3686
|
-
# @!parse
|
3687
|
-
# # @return [Array<Symbol>]
|
3688
|
-
# def self.values; end
|
3486
|
+
# @!method self.values
|
3487
|
+
# @return [Array<Symbol>]
|
3689
3488
|
end
|
3690
3489
|
end
|
3691
3490
|
end
|
@@ -3792,45 +3591,47 @@ module Orb
|
|
3792
3591
|
# @return [Hash{Symbol=>String, nil}, nil]
|
3793
3592
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
3794
3593
|
|
3795
|
-
# @!
|
3796
|
-
#
|
3797
|
-
#
|
3798
|
-
#
|
3799
|
-
#
|
3800
|
-
#
|
3801
|
-
#
|
3802
|
-
#
|
3803
|
-
#
|
3804
|
-
#
|
3805
|
-
#
|
3806
|
-
#
|
3807
|
-
#
|
3808
|
-
#
|
3809
|
-
#
|
3810
|
-
#
|
3811
|
-
#
|
3812
|
-
#
|
3813
|
-
#
|
3814
|
-
#
|
3815
|
-
#
|
3816
|
-
#
|
3817
|
-
#
|
3818
|
-
#
|
3819
|
-
#
|
3820
|
-
#
|
3821
|
-
#
|
3822
|
-
#
|
3823
|
-
#
|
3824
|
-
#
|
3825
|
-
#
|
3826
|
-
#
|
3827
|
-
#
|
3828
|
-
#
|
3829
|
-
#
|
3830
|
-
#
|
3831
|
-
#
|
3832
|
-
|
3833
|
-
#
|
3594
|
+
# @!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
|
+
# Some parameter documentations has been truncated, see
|
3596
|
+
# {Orb::Models::PlanCreateParams::Price::NewPlanTierWithProrationPrice} for more
|
3597
|
+
# details.
|
3598
|
+
#
|
3599
|
+
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTierWithProrationPrice::Cadence] The cadence to bill for this price on.
|
3600
|
+
#
|
3601
|
+
# @param item_id [String] The id of the item the price will be associated with.
|
3602
|
+
#
|
3603
|
+
# @param name [String] The name of the price.
|
3604
|
+
#
|
3605
|
+
# @param tiered_with_proration_config [Hash{Symbol=>Object}]
|
3606
|
+
#
|
3607
|
+
# @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
|
+
#
|
3610
|
+
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
3611
|
+
# ...
|
3612
|
+
#
|
3613
|
+
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanTierWithProrationPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
3614
|
+
# ...
|
3615
|
+
#
|
3616
|
+
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
3617
|
+
#
|
3618
|
+
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
3619
|
+
# ...
|
3620
|
+
#
|
3621
|
+
# @param external_price_id [String, nil] An alias for the price.
|
3622
|
+
#
|
3623
|
+
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
3624
|
+
# ...
|
3625
|
+
#
|
3626
|
+
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
3627
|
+
#
|
3628
|
+
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanTierWithProrationPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
3629
|
+
# ...
|
3630
|
+
#
|
3631
|
+
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
3632
|
+
# ...
|
3633
|
+
#
|
3634
|
+
# @param model_type [Symbol, :tiered_with_proration]
|
3834
3635
|
|
3835
3636
|
# The cadence to bill for this price on.
|
3836
3637
|
#
|
@@ -3845,11 +3646,8 @@ module Orb
|
|
3845
3646
|
ONE_TIME = :one_time
|
3846
3647
|
CUSTOM = :custom
|
3847
3648
|
|
3848
|
-
|
3849
|
-
|
3850
|
-
# @!parse
|
3851
|
-
# # @return [Array<Symbol>]
|
3852
|
-
# def self.values; end
|
3649
|
+
# @!method self.values
|
3650
|
+
# @return [Array<Symbol>]
|
3853
3651
|
end
|
3854
3652
|
|
3855
3653
|
# @see Orb::Models::PlanCreateParams::Price::NewPlanTierWithProrationPrice#billing_cycle_configuration
|
@@ -3867,16 +3665,13 @@ module Orb
|
|
3867
3665
|
required :duration_unit,
|
3868
3666
|
enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanTierWithProrationPrice::BillingCycleConfiguration::DurationUnit }
|
3869
3667
|
|
3870
|
-
# @!
|
3871
|
-
#
|
3872
|
-
#
|
3873
|
-
#
|
3874
|
-
#
|
3875
|
-
#
|
3876
|
-
#
|
3877
|
-
# def initialize(duration:, duration_unit:, **) = super
|
3878
|
-
|
3879
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
3668
|
+
# @!method initialize(duration:, duration_unit:)
|
3669
|
+
# For custom cadence: specifies the duration of the billing period in days or
|
3670
|
+
# months.
|
3671
|
+
#
|
3672
|
+
# @param duration [Integer] The duration of the billing period.
|
3673
|
+
#
|
3674
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTierWithProrationPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
3880
3675
|
|
3881
3676
|
# The unit of billing period duration.
|
3882
3677
|
#
|
@@ -3887,11 +3682,8 @@ module Orb
|
|
3887
3682
|
DAY = :day
|
3888
3683
|
MONTH = :month
|
3889
3684
|
|
3890
|
-
|
3891
|
-
|
3892
|
-
# @!parse
|
3893
|
-
# # @return [Array<Symbol>]
|
3894
|
-
# def self.values; end
|
3685
|
+
# @!method self.values
|
3686
|
+
# @return [Array<Symbol>]
|
3895
3687
|
end
|
3896
3688
|
end
|
3897
3689
|
|
@@ -3910,16 +3702,13 @@ module Orb
|
|
3910
3702
|
required :duration_unit,
|
3911
3703
|
enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanTierWithProrationPrice::InvoicingCycleConfiguration::DurationUnit }
|
3912
3704
|
|
3913
|
-
# @!
|
3914
|
-
#
|
3915
|
-
#
|
3916
|
-
#
|
3917
|
-
#
|
3918
|
-
#
|
3919
|
-
#
|
3920
|
-
# def initialize(duration:, duration_unit:, **) = super
|
3921
|
-
|
3922
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
3705
|
+
# @!method initialize(duration:, duration_unit:)
|
3706
|
+
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
3707
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
3708
|
+
#
|
3709
|
+
# @param duration [Integer] The duration of the billing period.
|
3710
|
+
#
|
3711
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTierWithProrationPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
3923
3712
|
|
3924
3713
|
# The unit of billing period duration.
|
3925
3714
|
#
|
@@ -3930,11 +3719,8 @@ module Orb
|
|
3930
3719
|
DAY = :day
|
3931
3720
|
MONTH = :month
|
3932
3721
|
|
3933
|
-
|
3934
|
-
|
3935
|
-
# @!parse
|
3936
|
-
# # @return [Array<Symbol>]
|
3937
|
-
# def self.values; end
|
3722
|
+
# @!method self.values
|
3723
|
+
# @return [Array<Symbol>]
|
3938
3724
|
end
|
3939
3725
|
end
|
3940
3726
|
end
|
@@ -4041,45 +3827,47 @@ module Orb
|
|
4041
3827
|
# @return [Hash{Symbol=>String, nil}, nil]
|
4042
3828
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
4043
3829
|
|
4044
|
-
# @!
|
4045
|
-
#
|
4046
|
-
#
|
4047
|
-
#
|
4048
|
-
#
|
4049
|
-
#
|
4050
|
-
#
|
4051
|
-
#
|
4052
|
-
#
|
4053
|
-
#
|
4054
|
-
#
|
4055
|
-
#
|
4056
|
-
#
|
4057
|
-
#
|
4058
|
-
#
|
4059
|
-
#
|
4060
|
-
#
|
4061
|
-
#
|
4062
|
-
#
|
4063
|
-
#
|
4064
|
-
#
|
4065
|
-
#
|
4066
|
-
#
|
4067
|
-
#
|
4068
|
-
#
|
4069
|
-
#
|
4070
|
-
#
|
4071
|
-
#
|
4072
|
-
#
|
4073
|
-
#
|
4074
|
-
#
|
4075
|
-
#
|
4076
|
-
#
|
4077
|
-
#
|
4078
|
-
#
|
4079
|
-
#
|
4080
|
-
#
|
4081
|
-
|
4082
|
-
#
|
3830
|
+
# @!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
|
+
# Some parameter documentations has been truncated, see
|
3832
|
+
# {Orb::Models::PlanCreateParams::Price::NewPlanUnitWithProrationPrice} for more
|
3833
|
+
# details.
|
3834
|
+
#
|
3835
|
+
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanUnitWithProrationPrice::Cadence] The cadence to bill for this price on.
|
3836
|
+
#
|
3837
|
+
# @param item_id [String] The id of the item the price will be associated with.
|
3838
|
+
#
|
3839
|
+
# @param name [String] The name of the price.
|
3840
|
+
#
|
3841
|
+
# @param unit_with_proration_config [Hash{Symbol=>Object}]
|
3842
|
+
#
|
3843
|
+
# @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
|
+
#
|
3846
|
+
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
3847
|
+
# ...
|
3848
|
+
#
|
3849
|
+
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanUnitWithProrationPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
3850
|
+
# ...
|
3851
|
+
#
|
3852
|
+
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
3853
|
+
#
|
3854
|
+
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
3855
|
+
# ...
|
3856
|
+
#
|
3857
|
+
# @param external_price_id [String, nil] An alias for the price.
|
3858
|
+
#
|
3859
|
+
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
3860
|
+
# ...
|
3861
|
+
#
|
3862
|
+
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
3863
|
+
#
|
3864
|
+
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanUnitWithProrationPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
3865
|
+
# ...
|
3866
|
+
#
|
3867
|
+
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
3868
|
+
# ...
|
3869
|
+
#
|
3870
|
+
# @param model_type [Symbol, :unit_with_proration]
|
4083
3871
|
|
4084
3872
|
# The cadence to bill for this price on.
|
4085
3873
|
#
|
@@ -4094,11 +3882,8 @@ module Orb
|
|
4094
3882
|
ONE_TIME = :one_time
|
4095
3883
|
CUSTOM = :custom
|
4096
3884
|
|
4097
|
-
|
4098
|
-
|
4099
|
-
# @!parse
|
4100
|
-
# # @return [Array<Symbol>]
|
4101
|
-
# def self.values; end
|
3885
|
+
# @!method self.values
|
3886
|
+
# @return [Array<Symbol>]
|
4102
3887
|
end
|
4103
3888
|
|
4104
3889
|
# @see Orb::Models::PlanCreateParams::Price::NewPlanUnitWithProrationPrice#billing_cycle_configuration
|
@@ -4116,16 +3901,13 @@ module Orb
|
|
4116
3901
|
required :duration_unit,
|
4117
3902
|
enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanUnitWithProrationPrice::BillingCycleConfiguration::DurationUnit }
|
4118
3903
|
|
4119
|
-
# @!
|
4120
|
-
#
|
4121
|
-
#
|
4122
|
-
#
|
4123
|
-
#
|
4124
|
-
#
|
4125
|
-
#
|
4126
|
-
# def initialize(duration:, duration_unit:, **) = super
|
4127
|
-
|
4128
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
3904
|
+
# @!method initialize(duration:, duration_unit:)
|
3905
|
+
# For custom cadence: specifies the duration of the billing period in days or
|
3906
|
+
# months.
|
3907
|
+
#
|
3908
|
+
# @param duration [Integer] The duration of the billing period.
|
3909
|
+
#
|
3910
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanUnitWithProrationPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
4129
3911
|
|
4130
3912
|
# The unit of billing period duration.
|
4131
3913
|
#
|
@@ -4136,11 +3918,8 @@ module Orb
|
|
4136
3918
|
DAY = :day
|
4137
3919
|
MONTH = :month
|
4138
3920
|
|
4139
|
-
|
4140
|
-
|
4141
|
-
# @!parse
|
4142
|
-
# # @return [Array<Symbol>]
|
4143
|
-
# def self.values; end
|
3921
|
+
# @!method self.values
|
3922
|
+
# @return [Array<Symbol>]
|
4144
3923
|
end
|
4145
3924
|
end
|
4146
3925
|
|
@@ -4159,16 +3938,13 @@ module Orb
|
|
4159
3938
|
required :duration_unit,
|
4160
3939
|
enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanUnitWithProrationPrice::InvoicingCycleConfiguration::DurationUnit }
|
4161
3940
|
|
4162
|
-
# @!
|
4163
|
-
#
|
4164
|
-
#
|
4165
|
-
#
|
4166
|
-
#
|
4167
|
-
#
|
4168
|
-
#
|
4169
|
-
# def initialize(duration:, duration_unit:, **) = super
|
4170
|
-
|
4171
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
3941
|
+
# @!method initialize(duration:, duration_unit:)
|
3942
|
+
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
3943
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
3944
|
+
#
|
3945
|
+
# @param duration [Integer] The duration of the billing period.
|
3946
|
+
#
|
3947
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanUnitWithProrationPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
4172
3948
|
|
4173
3949
|
# The unit of billing period duration.
|
4174
3950
|
#
|
@@ -4179,11 +3955,8 @@ module Orb
|
|
4179
3955
|
DAY = :day
|
4180
3956
|
MONTH = :month
|
4181
3957
|
|
4182
|
-
|
4183
|
-
|
4184
|
-
# @!parse
|
4185
|
-
# # @return [Array<Symbol>]
|
4186
|
-
# def self.values; end
|
3958
|
+
# @!method self.values
|
3959
|
+
# @return [Array<Symbol>]
|
4187
3960
|
end
|
4188
3961
|
end
|
4189
3962
|
end
|
@@ -4290,45 +4063,47 @@ module Orb
|
|
4290
4063
|
# @return [Hash{Symbol=>String, nil}, nil]
|
4291
4064
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
4292
4065
|
|
4293
|
-
# @!
|
4294
|
-
#
|
4295
|
-
#
|
4296
|
-
#
|
4297
|
-
#
|
4298
|
-
#
|
4299
|
-
#
|
4300
|
-
#
|
4301
|
-
#
|
4302
|
-
#
|
4303
|
-
#
|
4304
|
-
#
|
4305
|
-
#
|
4306
|
-
#
|
4307
|
-
#
|
4308
|
-
#
|
4309
|
-
#
|
4310
|
-
#
|
4311
|
-
#
|
4312
|
-
#
|
4313
|
-
#
|
4314
|
-
#
|
4315
|
-
#
|
4316
|
-
#
|
4317
|
-
#
|
4318
|
-
#
|
4319
|
-
#
|
4320
|
-
#
|
4321
|
-
#
|
4322
|
-
#
|
4323
|
-
#
|
4324
|
-
#
|
4325
|
-
#
|
4326
|
-
#
|
4327
|
-
#
|
4328
|
-
#
|
4329
|
-
#
|
4330
|
-
|
4331
|
-
#
|
4066
|
+
# @!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
|
+
# Some parameter documentations has been truncated, see
|
4068
|
+
# {Orb::Models::PlanCreateParams::Price::NewPlanGroupedAllocationPrice} for more
|
4069
|
+
# details.
|
4070
|
+
#
|
4071
|
+
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanGroupedAllocationPrice::Cadence] The cadence to bill for this price on.
|
4072
|
+
#
|
4073
|
+
# @param grouped_allocation_config [Hash{Symbol=>Object}]
|
4074
|
+
#
|
4075
|
+
# @param item_id [String] The id of the item the price will be associated with.
|
4076
|
+
#
|
4077
|
+
# @param name [String] The name of the price.
|
4078
|
+
#
|
4079
|
+
# @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
|
+
#
|
4082
|
+
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
4083
|
+
# ...
|
4084
|
+
#
|
4085
|
+
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanGroupedAllocationPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
4086
|
+
# ...
|
4087
|
+
#
|
4088
|
+
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
4089
|
+
#
|
4090
|
+
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
4091
|
+
# ...
|
4092
|
+
#
|
4093
|
+
# @param external_price_id [String, nil] An alias for the price.
|
4094
|
+
#
|
4095
|
+
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
4096
|
+
# ...
|
4097
|
+
#
|
4098
|
+
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
4099
|
+
#
|
4100
|
+
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanGroupedAllocationPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
4101
|
+
# ...
|
4102
|
+
#
|
4103
|
+
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
4104
|
+
# ...
|
4105
|
+
#
|
4106
|
+
# @param model_type [Symbol, :grouped_allocation]
|
4332
4107
|
|
4333
4108
|
# The cadence to bill for this price on.
|
4334
4109
|
#
|
@@ -4343,11 +4118,8 @@ module Orb
|
|
4343
4118
|
ONE_TIME = :one_time
|
4344
4119
|
CUSTOM = :custom
|
4345
4120
|
|
4346
|
-
|
4347
|
-
|
4348
|
-
# @!parse
|
4349
|
-
# # @return [Array<Symbol>]
|
4350
|
-
# def self.values; end
|
4121
|
+
# @!method self.values
|
4122
|
+
# @return [Array<Symbol>]
|
4351
4123
|
end
|
4352
4124
|
|
4353
4125
|
# @see Orb::Models::PlanCreateParams::Price::NewPlanGroupedAllocationPrice#billing_cycle_configuration
|
@@ -4365,16 +4137,13 @@ module Orb
|
|
4365
4137
|
required :duration_unit,
|
4366
4138
|
enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanGroupedAllocationPrice::BillingCycleConfiguration::DurationUnit }
|
4367
4139
|
|
4368
|
-
# @!
|
4369
|
-
#
|
4370
|
-
#
|
4371
|
-
#
|
4372
|
-
#
|
4373
|
-
#
|
4374
|
-
#
|
4375
|
-
# def initialize(duration:, duration_unit:, **) = super
|
4376
|
-
|
4377
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
4140
|
+
# @!method initialize(duration:, duration_unit:)
|
4141
|
+
# For custom cadence: specifies the duration of the billing period in days or
|
4142
|
+
# months.
|
4143
|
+
#
|
4144
|
+
# @param duration [Integer] The duration of the billing period.
|
4145
|
+
#
|
4146
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanGroupedAllocationPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
4378
4147
|
|
4379
4148
|
# The unit of billing period duration.
|
4380
4149
|
#
|
@@ -4385,11 +4154,8 @@ module Orb
|
|
4385
4154
|
DAY = :day
|
4386
4155
|
MONTH = :month
|
4387
4156
|
|
4388
|
-
|
4389
|
-
|
4390
|
-
# @!parse
|
4391
|
-
# # @return [Array<Symbol>]
|
4392
|
-
# def self.values; end
|
4157
|
+
# @!method self.values
|
4158
|
+
# @return [Array<Symbol>]
|
4393
4159
|
end
|
4394
4160
|
end
|
4395
4161
|
|
@@ -4408,16 +4174,13 @@ module Orb
|
|
4408
4174
|
required :duration_unit,
|
4409
4175
|
enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanGroupedAllocationPrice::InvoicingCycleConfiguration::DurationUnit }
|
4410
4176
|
|
4411
|
-
# @!
|
4412
|
-
#
|
4413
|
-
#
|
4414
|
-
#
|
4415
|
-
#
|
4416
|
-
#
|
4417
|
-
#
|
4418
|
-
# def initialize(duration:, duration_unit:, **) = super
|
4419
|
-
|
4420
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
4177
|
+
# @!method initialize(duration:, duration_unit:)
|
4178
|
+
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
4179
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
4180
|
+
#
|
4181
|
+
# @param duration [Integer] The duration of the billing period.
|
4182
|
+
#
|
4183
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanGroupedAllocationPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
4421
4184
|
|
4422
4185
|
# The unit of billing period duration.
|
4423
4186
|
#
|
@@ -4428,11 +4191,8 @@ module Orb
|
|
4428
4191
|
DAY = :day
|
4429
4192
|
MONTH = :month
|
4430
4193
|
|
4431
|
-
|
4432
|
-
|
4433
|
-
# @!parse
|
4434
|
-
# # @return [Array<Symbol>]
|
4435
|
-
# def self.values; end
|
4194
|
+
# @!method self.values
|
4195
|
+
# @return [Array<Symbol>]
|
4436
4196
|
end
|
4437
4197
|
end
|
4438
4198
|
end
|
@@ -4540,45 +4300,47 @@ module Orb
|
|
4540
4300
|
# @return [Hash{Symbol=>String, nil}, nil]
|
4541
4301
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
4542
4302
|
|
4543
|
-
# @!
|
4544
|
-
#
|
4545
|
-
#
|
4546
|
-
#
|
4547
|
-
#
|
4548
|
-
#
|
4549
|
-
#
|
4550
|
-
#
|
4551
|
-
#
|
4552
|
-
#
|
4553
|
-
#
|
4554
|
-
#
|
4555
|
-
#
|
4556
|
-
#
|
4557
|
-
#
|
4558
|
-
#
|
4559
|
-
#
|
4560
|
-
#
|
4561
|
-
#
|
4562
|
-
#
|
4563
|
-
#
|
4564
|
-
#
|
4565
|
-
#
|
4566
|
-
#
|
4567
|
-
#
|
4568
|
-
#
|
4569
|
-
#
|
4570
|
-
#
|
4571
|
-
#
|
4572
|
-
#
|
4573
|
-
#
|
4574
|
-
#
|
4575
|
-
#
|
4576
|
-
#
|
4577
|
-
#
|
4578
|
-
#
|
4579
|
-
#
|
4580
|
-
|
4581
|
-
#
|
4303
|
+
# @!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
|
+
# Some parameter documentations has been truncated, see
|
4305
|
+
# {Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithProratedMinimumPrice}
|
4306
|
+
# for more details.
|
4307
|
+
#
|
4308
|
+
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithProratedMinimumPrice::Cadence] The cadence to bill for this price on.
|
4309
|
+
#
|
4310
|
+
# @param grouped_with_prorated_minimum_config [Hash{Symbol=>Object}]
|
4311
|
+
#
|
4312
|
+
# @param item_id [String] The id of the item the price will be associated with.
|
4313
|
+
#
|
4314
|
+
# @param name [String] The name of the price.
|
4315
|
+
#
|
4316
|
+
# @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
|
+
#
|
4319
|
+
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
4320
|
+
# ...
|
4321
|
+
#
|
4322
|
+
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithProratedMinimumPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
4323
|
+
# ...
|
4324
|
+
#
|
4325
|
+
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
4326
|
+
#
|
4327
|
+
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
4328
|
+
# ...
|
4329
|
+
#
|
4330
|
+
# @param external_price_id [String, nil] An alias for the price.
|
4331
|
+
#
|
4332
|
+
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
4333
|
+
# ...
|
4334
|
+
#
|
4335
|
+
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
4336
|
+
#
|
4337
|
+
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
4338
|
+
# ...
|
4339
|
+
#
|
4340
|
+
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
4341
|
+
# ...
|
4342
|
+
#
|
4343
|
+
# @param model_type [Symbol, :grouped_with_prorated_minimum]
|
4582
4344
|
|
4583
4345
|
# The cadence to bill for this price on.
|
4584
4346
|
#
|
@@ -4593,11 +4355,8 @@ module Orb
|
|
4593
4355
|
ONE_TIME = :one_time
|
4594
4356
|
CUSTOM = :custom
|
4595
4357
|
|
4596
|
-
|
4597
|
-
|
4598
|
-
# @!parse
|
4599
|
-
# # @return [Array<Symbol>]
|
4600
|
-
# def self.values; end
|
4358
|
+
# @!method self.values
|
4359
|
+
# @return [Array<Symbol>]
|
4601
4360
|
end
|
4602
4361
|
|
4603
4362
|
# @see Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithProratedMinimumPrice#billing_cycle_configuration
|
@@ -4615,16 +4374,13 @@ module Orb
|
|
4615
4374
|
required :duration_unit,
|
4616
4375
|
enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithProratedMinimumPrice::BillingCycleConfiguration::DurationUnit }
|
4617
4376
|
|
4618
|
-
# @!
|
4619
|
-
#
|
4620
|
-
#
|
4621
|
-
#
|
4622
|
-
#
|
4623
|
-
#
|
4624
|
-
#
|
4625
|
-
# def initialize(duration:, duration_unit:, **) = super
|
4626
|
-
|
4627
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
4377
|
+
# @!method initialize(duration:, duration_unit:)
|
4378
|
+
# For custom cadence: specifies the duration of the billing period in days or
|
4379
|
+
# months.
|
4380
|
+
#
|
4381
|
+
# @param duration [Integer] The duration of the billing period.
|
4382
|
+
#
|
4383
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithProratedMinimumPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
4628
4384
|
|
4629
4385
|
# The unit of billing period duration.
|
4630
4386
|
#
|
@@ -4635,11 +4391,8 @@ module Orb
|
|
4635
4391
|
DAY = :day
|
4636
4392
|
MONTH = :month
|
4637
4393
|
|
4638
|
-
|
4639
|
-
|
4640
|
-
# @!parse
|
4641
|
-
# # @return [Array<Symbol>]
|
4642
|
-
# def self.values; end
|
4394
|
+
# @!method self.values
|
4395
|
+
# @return [Array<Symbol>]
|
4643
4396
|
end
|
4644
4397
|
end
|
4645
4398
|
|
@@ -4658,16 +4411,13 @@ module Orb
|
|
4658
4411
|
required :duration_unit,
|
4659
4412
|
enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration::DurationUnit }
|
4660
4413
|
|
4661
|
-
# @!
|
4662
|
-
#
|
4663
|
-
#
|
4664
|
-
#
|
4665
|
-
#
|
4666
|
-
#
|
4667
|
-
#
|
4668
|
-
# def initialize(duration:, duration_unit:, **) = super
|
4669
|
-
|
4670
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
4414
|
+
# @!method initialize(duration:, duration_unit:)
|
4415
|
+
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
4416
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
4417
|
+
#
|
4418
|
+
# @param duration [Integer] The duration of the billing period.
|
4419
|
+
#
|
4420
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
4671
4421
|
|
4672
4422
|
# The unit of billing period duration.
|
4673
4423
|
#
|
@@ -4678,11 +4428,8 @@ module Orb
|
|
4678
4428
|
DAY = :day
|
4679
4429
|
MONTH = :month
|
4680
4430
|
|
4681
|
-
|
4682
|
-
|
4683
|
-
# @!parse
|
4684
|
-
# # @return [Array<Symbol>]
|
4685
|
-
# def self.values; end
|
4431
|
+
# @!method self.values
|
4432
|
+
# @return [Array<Symbol>]
|
4686
4433
|
end
|
4687
4434
|
end
|
4688
4435
|
end
|
@@ -4790,45 +4537,47 @@ module Orb
|
|
4790
4537
|
# @return [Hash{Symbol=>String, nil}, nil]
|
4791
4538
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
4792
4539
|
|
4793
|
-
# @!
|
4794
|
-
#
|
4795
|
-
#
|
4796
|
-
#
|
4797
|
-
#
|
4798
|
-
#
|
4799
|
-
#
|
4800
|
-
#
|
4801
|
-
#
|
4802
|
-
#
|
4803
|
-
#
|
4804
|
-
#
|
4805
|
-
#
|
4806
|
-
#
|
4807
|
-
#
|
4808
|
-
#
|
4809
|
-
#
|
4810
|
-
#
|
4811
|
-
#
|
4812
|
-
#
|
4813
|
-
#
|
4814
|
-
#
|
4815
|
-
#
|
4816
|
-
#
|
4817
|
-
#
|
4818
|
-
#
|
4819
|
-
#
|
4820
|
-
#
|
4821
|
-
#
|
4822
|
-
#
|
4823
|
-
#
|
4824
|
-
#
|
4825
|
-
#
|
4826
|
-
#
|
4827
|
-
#
|
4828
|
-
#
|
4829
|
-
#
|
4830
|
-
|
4831
|
-
#
|
4540
|
+
# @!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
|
+
# Some parameter documentations has been truncated, see
|
4542
|
+
# {Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithMeteredMinimumPrice}
|
4543
|
+
# for more details.
|
4544
|
+
#
|
4545
|
+
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithMeteredMinimumPrice::Cadence] The cadence to bill for this price on.
|
4546
|
+
#
|
4547
|
+
# @param grouped_with_metered_minimum_config [Hash{Symbol=>Object}]
|
4548
|
+
#
|
4549
|
+
# @param item_id [String] The id of the item the price will be associated with.
|
4550
|
+
#
|
4551
|
+
# @param name [String] The name of the price.
|
4552
|
+
#
|
4553
|
+
# @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
|
+
#
|
4556
|
+
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
4557
|
+
# ...
|
4558
|
+
#
|
4559
|
+
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithMeteredMinimumPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
4560
|
+
# ...
|
4561
|
+
#
|
4562
|
+
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
4563
|
+
#
|
4564
|
+
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
4565
|
+
# ...
|
4566
|
+
#
|
4567
|
+
# @param external_price_id [String, nil] An alias for the price.
|
4568
|
+
#
|
4569
|
+
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
4570
|
+
# ...
|
4571
|
+
#
|
4572
|
+
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
4573
|
+
#
|
4574
|
+
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
4575
|
+
# ...
|
4576
|
+
#
|
4577
|
+
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
4578
|
+
# ...
|
4579
|
+
#
|
4580
|
+
# @param model_type [Symbol, :grouped_with_metered_minimum]
|
4832
4581
|
|
4833
4582
|
# The cadence to bill for this price on.
|
4834
4583
|
#
|
@@ -4843,11 +4592,8 @@ module Orb
|
|
4843
4592
|
ONE_TIME = :one_time
|
4844
4593
|
CUSTOM = :custom
|
4845
4594
|
|
4846
|
-
|
4847
|
-
|
4848
|
-
# @!parse
|
4849
|
-
# # @return [Array<Symbol>]
|
4850
|
-
# def self.values; end
|
4595
|
+
# @!method self.values
|
4596
|
+
# @return [Array<Symbol>]
|
4851
4597
|
end
|
4852
4598
|
|
4853
4599
|
# @see Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithMeteredMinimumPrice#billing_cycle_configuration
|
@@ -4865,16 +4611,13 @@ module Orb
|
|
4865
4611
|
required :duration_unit,
|
4866
4612
|
enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithMeteredMinimumPrice::BillingCycleConfiguration::DurationUnit }
|
4867
4613
|
|
4868
|
-
# @!
|
4869
|
-
#
|
4870
|
-
#
|
4871
|
-
#
|
4872
|
-
#
|
4873
|
-
#
|
4874
|
-
#
|
4875
|
-
# def initialize(duration:, duration_unit:, **) = super
|
4876
|
-
|
4877
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
4614
|
+
# @!method initialize(duration:, duration_unit:)
|
4615
|
+
# For custom cadence: specifies the duration of the billing period in days or
|
4616
|
+
# months.
|
4617
|
+
#
|
4618
|
+
# @param duration [Integer] The duration of the billing period.
|
4619
|
+
#
|
4620
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithMeteredMinimumPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
4878
4621
|
|
4879
4622
|
# The unit of billing period duration.
|
4880
4623
|
#
|
@@ -4885,11 +4628,8 @@ module Orb
|
|
4885
4628
|
DAY = :day
|
4886
4629
|
MONTH = :month
|
4887
4630
|
|
4888
|
-
|
4889
|
-
|
4890
|
-
# @!parse
|
4891
|
-
# # @return [Array<Symbol>]
|
4892
|
-
# def self.values; end
|
4631
|
+
# @!method self.values
|
4632
|
+
# @return [Array<Symbol>]
|
4893
4633
|
end
|
4894
4634
|
end
|
4895
4635
|
|
@@ -4908,16 +4648,13 @@ module Orb
|
|
4908
4648
|
required :duration_unit,
|
4909
4649
|
enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration::DurationUnit }
|
4910
4650
|
|
4911
|
-
# @!
|
4912
|
-
#
|
4913
|
-
#
|
4914
|
-
#
|
4915
|
-
#
|
4916
|
-
#
|
4917
|
-
#
|
4918
|
-
# def initialize(duration:, duration_unit:, **) = super
|
4919
|
-
|
4920
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
4651
|
+
# @!method initialize(duration:, duration_unit:)
|
4652
|
+
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
4653
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
4654
|
+
#
|
4655
|
+
# @param duration [Integer] The duration of the billing period.
|
4656
|
+
#
|
4657
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
4921
4658
|
|
4922
4659
|
# The unit of billing period duration.
|
4923
4660
|
#
|
@@ -4928,11 +4665,8 @@ module Orb
|
|
4928
4665
|
DAY = :day
|
4929
4666
|
MONTH = :month
|
4930
4667
|
|
4931
|
-
|
4932
|
-
|
4933
|
-
# @!parse
|
4934
|
-
# # @return [Array<Symbol>]
|
4935
|
-
# def self.values; end
|
4668
|
+
# @!method self.values
|
4669
|
+
# @return [Array<Symbol>]
|
4936
4670
|
end
|
4937
4671
|
end
|
4938
4672
|
end
|
@@ -5039,45 +4773,47 @@ module Orb
|
|
5039
4773
|
# @return [Hash{Symbol=>String, nil}, nil]
|
5040
4774
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
5041
4775
|
|
5042
|
-
# @!
|
5043
|
-
#
|
5044
|
-
#
|
5045
|
-
#
|
5046
|
-
#
|
5047
|
-
#
|
5048
|
-
#
|
5049
|
-
#
|
5050
|
-
#
|
5051
|
-
#
|
5052
|
-
#
|
5053
|
-
#
|
5054
|
-
#
|
5055
|
-
#
|
5056
|
-
#
|
5057
|
-
#
|
5058
|
-
#
|
5059
|
-
#
|
5060
|
-
#
|
5061
|
-
#
|
5062
|
-
#
|
5063
|
-
#
|
5064
|
-
#
|
5065
|
-
#
|
5066
|
-
#
|
5067
|
-
#
|
5068
|
-
#
|
5069
|
-
#
|
5070
|
-
#
|
5071
|
-
#
|
5072
|
-
#
|
5073
|
-
#
|
5074
|
-
#
|
5075
|
-
#
|
5076
|
-
#
|
5077
|
-
#
|
5078
|
-
#
|
5079
|
-
|
5080
|
-
#
|
4776
|
+
# @!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
|
+
# Some parameter documentations has been truncated, see
|
4778
|
+
# {Orb::Models::PlanCreateParams::Price::NewPlanMatrixWithDisplayNamePrice} for
|
4779
|
+
# more details.
|
4780
|
+
#
|
4781
|
+
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanMatrixWithDisplayNamePrice::Cadence] The cadence to bill for this price on.
|
4782
|
+
#
|
4783
|
+
# @param item_id [String] The id of the item the price will be associated with.
|
4784
|
+
#
|
4785
|
+
# @param matrix_with_display_name_config [Hash{Symbol=>Object}]
|
4786
|
+
#
|
4787
|
+
# @param name [String] The name of the price.
|
4788
|
+
#
|
4789
|
+
# @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
|
+
#
|
4792
|
+
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
4793
|
+
# ...
|
4794
|
+
#
|
4795
|
+
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanMatrixWithDisplayNamePrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
4796
|
+
# ...
|
4797
|
+
#
|
4798
|
+
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
4799
|
+
#
|
4800
|
+
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
4801
|
+
# ...
|
4802
|
+
#
|
4803
|
+
# @param external_price_id [String, nil] An alias for the price.
|
4804
|
+
#
|
4805
|
+
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
4806
|
+
# ...
|
4807
|
+
#
|
4808
|
+
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
4809
|
+
#
|
4810
|
+
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanMatrixWithDisplayNamePrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
4811
|
+
# ...
|
4812
|
+
#
|
4813
|
+
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
4814
|
+
# ...
|
4815
|
+
#
|
4816
|
+
# @param model_type [Symbol, :matrix_with_display_name]
|
5081
4817
|
|
5082
4818
|
# The cadence to bill for this price on.
|
5083
4819
|
#
|
@@ -5092,11 +4828,8 @@ module Orb
|
|
5092
4828
|
ONE_TIME = :one_time
|
5093
4829
|
CUSTOM = :custom
|
5094
4830
|
|
5095
|
-
|
5096
|
-
|
5097
|
-
# @!parse
|
5098
|
-
# # @return [Array<Symbol>]
|
5099
|
-
# def self.values; end
|
4831
|
+
# @!method self.values
|
4832
|
+
# @return [Array<Symbol>]
|
5100
4833
|
end
|
5101
4834
|
|
5102
4835
|
# @see Orb::Models::PlanCreateParams::Price::NewPlanMatrixWithDisplayNamePrice#billing_cycle_configuration
|
@@ -5114,16 +4847,13 @@ module Orb
|
|
5114
4847
|
required :duration_unit,
|
5115
4848
|
enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanMatrixWithDisplayNamePrice::BillingCycleConfiguration::DurationUnit }
|
5116
4849
|
|
5117
|
-
# @!
|
5118
|
-
#
|
5119
|
-
#
|
5120
|
-
#
|
5121
|
-
#
|
5122
|
-
#
|
5123
|
-
#
|
5124
|
-
# def initialize(duration:, duration_unit:, **) = super
|
5125
|
-
|
5126
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
4850
|
+
# @!method initialize(duration:, duration_unit:)
|
4851
|
+
# For custom cadence: specifies the duration of the billing period in days or
|
4852
|
+
# months.
|
4853
|
+
#
|
4854
|
+
# @param duration [Integer] The duration of the billing period.
|
4855
|
+
#
|
4856
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanMatrixWithDisplayNamePrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
5127
4857
|
|
5128
4858
|
# The unit of billing period duration.
|
5129
4859
|
#
|
@@ -5134,11 +4864,8 @@ module Orb
|
|
5134
4864
|
DAY = :day
|
5135
4865
|
MONTH = :month
|
5136
4866
|
|
5137
|
-
|
5138
|
-
|
5139
|
-
# @!parse
|
5140
|
-
# # @return [Array<Symbol>]
|
5141
|
-
# def self.values; end
|
4867
|
+
# @!method self.values
|
4868
|
+
# @return [Array<Symbol>]
|
5142
4869
|
end
|
5143
4870
|
end
|
5144
4871
|
|
@@ -5157,16 +4884,13 @@ module Orb
|
|
5157
4884
|
required :duration_unit,
|
5158
4885
|
enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanMatrixWithDisplayNamePrice::InvoicingCycleConfiguration::DurationUnit }
|
5159
4886
|
|
5160
|
-
# @!
|
5161
|
-
#
|
5162
|
-
#
|
5163
|
-
#
|
5164
|
-
#
|
5165
|
-
#
|
5166
|
-
#
|
5167
|
-
# def initialize(duration:, duration_unit:, **) = super
|
5168
|
-
|
5169
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
4887
|
+
# @!method initialize(duration:, duration_unit:)
|
4888
|
+
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
4889
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
4890
|
+
#
|
4891
|
+
# @param duration [Integer] The duration of the billing period.
|
4892
|
+
#
|
4893
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanMatrixWithDisplayNamePrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
5170
4894
|
|
5171
4895
|
# The unit of billing period duration.
|
5172
4896
|
#
|
@@ -5177,11 +4901,8 @@ module Orb
|
|
5177
4901
|
DAY = :day
|
5178
4902
|
MONTH = :month
|
5179
4903
|
|
5180
|
-
|
5181
|
-
|
5182
|
-
# @!parse
|
5183
|
-
# # @return [Array<Symbol>]
|
5184
|
-
# def self.values; end
|
4904
|
+
# @!method self.values
|
4905
|
+
# @return [Array<Symbol>]
|
5185
4906
|
end
|
5186
4907
|
end
|
5187
4908
|
end
|
@@ -5288,45 +5009,47 @@ module Orb
|
|
5288
5009
|
# @return [Hash{Symbol=>String, nil}, nil]
|
5289
5010
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
5290
5011
|
|
5291
|
-
# @!
|
5292
|
-
#
|
5293
|
-
#
|
5294
|
-
#
|
5295
|
-
#
|
5296
|
-
#
|
5297
|
-
#
|
5298
|
-
#
|
5299
|
-
#
|
5300
|
-
#
|
5301
|
-
#
|
5302
|
-
#
|
5303
|
-
#
|
5304
|
-
#
|
5305
|
-
#
|
5306
|
-
#
|
5307
|
-
#
|
5308
|
-
#
|
5309
|
-
#
|
5310
|
-
#
|
5311
|
-
#
|
5312
|
-
#
|
5313
|
-
#
|
5314
|
-
#
|
5315
|
-
#
|
5316
|
-
#
|
5317
|
-
#
|
5318
|
-
#
|
5319
|
-
#
|
5320
|
-
#
|
5321
|
-
#
|
5322
|
-
#
|
5323
|
-
#
|
5324
|
-
#
|
5325
|
-
#
|
5326
|
-
#
|
5327
|
-
#
|
5328
|
-
|
5329
|
-
#
|
5012
|
+
# @!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
|
+
# Some parameter documentations has been truncated, see
|
5014
|
+
# {Orb::Models::PlanCreateParams::Price::NewPlanBulkWithProrationPrice} for more
|
5015
|
+
# details.
|
5016
|
+
#
|
5017
|
+
# @param bulk_with_proration_config [Hash{Symbol=>Object}]
|
5018
|
+
#
|
5019
|
+
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanBulkWithProrationPrice::Cadence] The cadence to bill for this price on.
|
5020
|
+
#
|
5021
|
+
# @param item_id [String] The id of the item the price will be associated with.
|
5022
|
+
#
|
5023
|
+
# @param name [String] The name of the price.
|
5024
|
+
#
|
5025
|
+
# @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
|
+
#
|
5028
|
+
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
5029
|
+
# ...
|
5030
|
+
#
|
5031
|
+
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanBulkWithProrationPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
5032
|
+
# ...
|
5033
|
+
#
|
5034
|
+
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
5035
|
+
#
|
5036
|
+
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
5037
|
+
# ...
|
5038
|
+
#
|
5039
|
+
# @param external_price_id [String, nil] An alias for the price.
|
5040
|
+
#
|
5041
|
+
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
5042
|
+
# ...
|
5043
|
+
#
|
5044
|
+
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
5045
|
+
#
|
5046
|
+
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanBulkWithProrationPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
5047
|
+
# ...
|
5048
|
+
#
|
5049
|
+
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
5050
|
+
# ...
|
5051
|
+
#
|
5052
|
+
# @param model_type [Symbol, :bulk_with_proration]
|
5330
5053
|
|
5331
5054
|
# The cadence to bill for this price on.
|
5332
5055
|
#
|
@@ -5341,11 +5064,8 @@ module Orb
|
|
5341
5064
|
ONE_TIME = :one_time
|
5342
5065
|
CUSTOM = :custom
|
5343
5066
|
|
5344
|
-
|
5345
|
-
|
5346
|
-
# @!parse
|
5347
|
-
# # @return [Array<Symbol>]
|
5348
|
-
# def self.values; end
|
5067
|
+
# @!method self.values
|
5068
|
+
# @return [Array<Symbol>]
|
5349
5069
|
end
|
5350
5070
|
|
5351
5071
|
# @see Orb::Models::PlanCreateParams::Price::NewPlanBulkWithProrationPrice#billing_cycle_configuration
|
@@ -5363,16 +5083,13 @@ module Orb
|
|
5363
5083
|
required :duration_unit,
|
5364
5084
|
enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanBulkWithProrationPrice::BillingCycleConfiguration::DurationUnit }
|
5365
5085
|
|
5366
|
-
# @!
|
5367
|
-
#
|
5368
|
-
#
|
5369
|
-
#
|
5370
|
-
#
|
5371
|
-
#
|
5372
|
-
#
|
5373
|
-
# def initialize(duration:, duration_unit:, **) = super
|
5374
|
-
|
5375
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
5086
|
+
# @!method initialize(duration:, duration_unit:)
|
5087
|
+
# For custom cadence: specifies the duration of the billing period in days or
|
5088
|
+
# months.
|
5089
|
+
#
|
5090
|
+
# @param duration [Integer] The duration of the billing period.
|
5091
|
+
#
|
5092
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanBulkWithProrationPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
5376
5093
|
|
5377
5094
|
# The unit of billing period duration.
|
5378
5095
|
#
|
@@ -5383,11 +5100,8 @@ module Orb
|
|
5383
5100
|
DAY = :day
|
5384
5101
|
MONTH = :month
|
5385
5102
|
|
5386
|
-
|
5387
|
-
|
5388
|
-
# @!parse
|
5389
|
-
# # @return [Array<Symbol>]
|
5390
|
-
# def self.values; end
|
5103
|
+
# @!method self.values
|
5104
|
+
# @return [Array<Symbol>]
|
5391
5105
|
end
|
5392
5106
|
end
|
5393
5107
|
|
@@ -5406,16 +5120,13 @@ module Orb
|
|
5406
5120
|
required :duration_unit,
|
5407
5121
|
enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanBulkWithProrationPrice::InvoicingCycleConfiguration::DurationUnit }
|
5408
5122
|
|
5409
|
-
# @!
|
5410
|
-
#
|
5411
|
-
#
|
5412
|
-
#
|
5413
|
-
#
|
5414
|
-
#
|
5415
|
-
#
|
5416
|
-
# def initialize(duration:, duration_unit:, **) = super
|
5417
|
-
|
5418
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
5123
|
+
# @!method initialize(duration:, duration_unit:)
|
5124
|
+
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
5125
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
5126
|
+
#
|
5127
|
+
# @param duration [Integer] The duration of the billing period.
|
5128
|
+
#
|
5129
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanBulkWithProrationPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
5419
5130
|
|
5420
5131
|
# The unit of billing period duration.
|
5421
5132
|
#
|
@@ -5426,11 +5137,8 @@ module Orb
|
|
5426
5137
|
DAY = :day
|
5427
5138
|
MONTH = :month
|
5428
5139
|
|
5429
|
-
|
5430
|
-
|
5431
|
-
# @!parse
|
5432
|
-
# # @return [Array<Symbol>]
|
5433
|
-
# def self.values; end
|
5140
|
+
# @!method self.values
|
5141
|
+
# @return [Array<Symbol>]
|
5434
5142
|
end
|
5435
5143
|
end
|
5436
5144
|
end
|
@@ -5537,45 +5245,47 @@ module Orb
|
|
5537
5245
|
# @return [Hash{Symbol=>String, nil}, nil]
|
5538
5246
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
5539
5247
|
|
5540
|
-
# @!
|
5541
|
-
#
|
5542
|
-
#
|
5543
|
-
#
|
5544
|
-
#
|
5545
|
-
#
|
5546
|
-
#
|
5547
|
-
#
|
5548
|
-
#
|
5549
|
-
#
|
5550
|
-
#
|
5551
|
-
#
|
5552
|
-
#
|
5553
|
-
#
|
5554
|
-
#
|
5555
|
-
#
|
5556
|
-
#
|
5557
|
-
#
|
5558
|
-
#
|
5559
|
-
#
|
5560
|
-
#
|
5561
|
-
#
|
5562
|
-
#
|
5563
|
-
#
|
5564
|
-
#
|
5565
|
-
#
|
5566
|
-
#
|
5567
|
-
#
|
5568
|
-
#
|
5569
|
-
#
|
5570
|
-
#
|
5571
|
-
#
|
5572
|
-
#
|
5573
|
-
#
|
5574
|
-
#
|
5575
|
-
#
|
5576
|
-
#
|
5577
|
-
|
5578
|
-
#
|
5248
|
+
# @!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
|
+
# Some parameter documentations has been truncated, see
|
5250
|
+
# {Orb::Models::PlanCreateParams::Price::NewPlanGroupedTieredPackagePrice} for
|
5251
|
+
# more details.
|
5252
|
+
#
|
5253
|
+
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanGroupedTieredPackagePrice::Cadence] The cadence to bill for this price on.
|
5254
|
+
#
|
5255
|
+
# @param grouped_tiered_package_config [Hash{Symbol=>Object}]
|
5256
|
+
#
|
5257
|
+
# @param item_id [String] The id of the item the price will be associated with.
|
5258
|
+
#
|
5259
|
+
# @param name [String] The name of the price.
|
5260
|
+
#
|
5261
|
+
# @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
|
+
#
|
5264
|
+
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
5265
|
+
# ...
|
5266
|
+
#
|
5267
|
+
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanGroupedTieredPackagePrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
5268
|
+
# ...
|
5269
|
+
#
|
5270
|
+
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
5271
|
+
#
|
5272
|
+
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
5273
|
+
# ...
|
5274
|
+
#
|
5275
|
+
# @param external_price_id [String, nil] An alias for the price.
|
5276
|
+
#
|
5277
|
+
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
5278
|
+
# ...
|
5279
|
+
#
|
5280
|
+
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
5281
|
+
#
|
5282
|
+
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanGroupedTieredPackagePrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
5283
|
+
# ...
|
5284
|
+
#
|
5285
|
+
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
5286
|
+
# ...
|
5287
|
+
#
|
5288
|
+
# @param model_type [Symbol, :grouped_tiered_package]
|
5579
5289
|
|
5580
5290
|
# The cadence to bill for this price on.
|
5581
5291
|
#
|
@@ -5590,11 +5300,8 @@ module Orb
|
|
5590
5300
|
ONE_TIME = :one_time
|
5591
5301
|
CUSTOM = :custom
|
5592
5302
|
|
5593
|
-
|
5594
|
-
|
5595
|
-
# @!parse
|
5596
|
-
# # @return [Array<Symbol>]
|
5597
|
-
# def self.values; end
|
5303
|
+
# @!method self.values
|
5304
|
+
# @return [Array<Symbol>]
|
5598
5305
|
end
|
5599
5306
|
|
5600
5307
|
# @see Orb::Models::PlanCreateParams::Price::NewPlanGroupedTieredPackagePrice#billing_cycle_configuration
|
@@ -5612,16 +5319,13 @@ module Orb
|
|
5612
5319
|
required :duration_unit,
|
5613
5320
|
enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanGroupedTieredPackagePrice::BillingCycleConfiguration::DurationUnit }
|
5614
5321
|
|
5615
|
-
# @!
|
5616
|
-
#
|
5617
|
-
#
|
5618
|
-
#
|
5619
|
-
#
|
5620
|
-
#
|
5621
|
-
#
|
5622
|
-
# def initialize(duration:, duration_unit:, **) = super
|
5623
|
-
|
5624
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
5322
|
+
# @!method initialize(duration:, duration_unit:)
|
5323
|
+
# For custom cadence: specifies the duration of the billing period in days or
|
5324
|
+
# months.
|
5325
|
+
#
|
5326
|
+
# @param duration [Integer] The duration of the billing period.
|
5327
|
+
#
|
5328
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanGroupedTieredPackagePrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
5625
5329
|
|
5626
5330
|
# The unit of billing period duration.
|
5627
5331
|
#
|
@@ -5632,11 +5336,8 @@ module Orb
|
|
5632
5336
|
DAY = :day
|
5633
5337
|
MONTH = :month
|
5634
5338
|
|
5635
|
-
|
5636
|
-
|
5637
|
-
# @!parse
|
5638
|
-
# # @return [Array<Symbol>]
|
5639
|
-
# def self.values; end
|
5339
|
+
# @!method self.values
|
5340
|
+
# @return [Array<Symbol>]
|
5640
5341
|
end
|
5641
5342
|
end
|
5642
5343
|
|
@@ -5655,16 +5356,13 @@ module Orb
|
|
5655
5356
|
required :duration_unit,
|
5656
5357
|
enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanGroupedTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit }
|
5657
5358
|
|
5658
|
-
# @!
|
5659
|
-
#
|
5660
|
-
#
|
5661
|
-
#
|
5662
|
-
#
|
5663
|
-
#
|
5664
|
-
#
|
5665
|
-
# def initialize(duration:, duration_unit:, **) = super
|
5666
|
-
|
5667
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
5359
|
+
# @!method initialize(duration:, duration_unit:)
|
5360
|
+
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
5361
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
5362
|
+
#
|
5363
|
+
# @param duration [Integer] The duration of the billing period.
|
5364
|
+
#
|
5365
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanGroupedTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
5668
5366
|
|
5669
5367
|
# The unit of billing period duration.
|
5670
5368
|
#
|
@@ -5675,11 +5373,8 @@ module Orb
|
|
5675
5373
|
DAY = :day
|
5676
5374
|
MONTH = :month
|
5677
5375
|
|
5678
|
-
|
5679
|
-
|
5680
|
-
# @!parse
|
5681
|
-
# # @return [Array<Symbol>]
|
5682
|
-
# def self.values; end
|
5376
|
+
# @!method self.values
|
5377
|
+
# @return [Array<Symbol>]
|
5683
5378
|
end
|
5684
5379
|
end
|
5685
5380
|
end
|
@@ -5786,45 +5481,47 @@ module Orb
|
|
5786
5481
|
# @return [Hash{Symbol=>String, nil}, nil]
|
5787
5482
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
5788
5483
|
|
5789
|
-
# @!
|
5790
|
-
#
|
5791
|
-
#
|
5792
|
-
#
|
5793
|
-
#
|
5794
|
-
#
|
5795
|
-
#
|
5796
|
-
#
|
5797
|
-
#
|
5798
|
-
#
|
5799
|
-
#
|
5800
|
-
#
|
5801
|
-
#
|
5802
|
-
#
|
5803
|
-
#
|
5804
|
-
#
|
5805
|
-
#
|
5806
|
-
#
|
5807
|
-
#
|
5808
|
-
#
|
5809
|
-
#
|
5810
|
-
#
|
5811
|
-
#
|
5812
|
-
#
|
5813
|
-
#
|
5814
|
-
#
|
5815
|
-
#
|
5816
|
-
#
|
5817
|
-
#
|
5818
|
-
#
|
5819
|
-
#
|
5820
|
-
#
|
5821
|
-
#
|
5822
|
-
#
|
5823
|
-
#
|
5824
|
-
#
|
5825
|
-
#
|
5826
|
-
|
5827
|
-
#
|
5484
|
+
# @!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
|
+
# Some parameter documentations has been truncated, see
|
5486
|
+
# {Orb::Models::PlanCreateParams::Price::NewPlanMaxGroupTieredPackagePrice} for
|
5487
|
+
# more details.
|
5488
|
+
#
|
5489
|
+
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanMaxGroupTieredPackagePrice::Cadence] The cadence to bill for this price on.
|
5490
|
+
#
|
5491
|
+
# @param item_id [String] The id of the item the price will be associated with.
|
5492
|
+
#
|
5493
|
+
# @param max_group_tiered_package_config [Hash{Symbol=>Object}]
|
5494
|
+
#
|
5495
|
+
# @param name [String] The name of the price.
|
5496
|
+
#
|
5497
|
+
# @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
|
+
#
|
5500
|
+
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
5501
|
+
# ...
|
5502
|
+
#
|
5503
|
+
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanMaxGroupTieredPackagePrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
5504
|
+
# ...
|
5505
|
+
#
|
5506
|
+
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
5507
|
+
#
|
5508
|
+
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
5509
|
+
# ...
|
5510
|
+
#
|
5511
|
+
# @param external_price_id [String, nil] An alias for the price.
|
5512
|
+
#
|
5513
|
+
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
5514
|
+
# ...
|
5515
|
+
#
|
5516
|
+
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
5517
|
+
#
|
5518
|
+
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanMaxGroupTieredPackagePrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
5519
|
+
# ...
|
5520
|
+
#
|
5521
|
+
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
5522
|
+
# ...
|
5523
|
+
#
|
5524
|
+
# @param model_type [Symbol, :max_group_tiered_package]
|
5828
5525
|
|
5829
5526
|
# The cadence to bill for this price on.
|
5830
5527
|
#
|
@@ -5839,11 +5536,8 @@ module Orb
|
|
5839
5536
|
ONE_TIME = :one_time
|
5840
5537
|
CUSTOM = :custom
|
5841
5538
|
|
5842
|
-
|
5843
|
-
|
5844
|
-
# @!parse
|
5845
|
-
# # @return [Array<Symbol>]
|
5846
|
-
# def self.values; end
|
5539
|
+
# @!method self.values
|
5540
|
+
# @return [Array<Symbol>]
|
5847
5541
|
end
|
5848
5542
|
|
5849
5543
|
# @see Orb::Models::PlanCreateParams::Price::NewPlanMaxGroupTieredPackagePrice#billing_cycle_configuration
|
@@ -5861,16 +5555,13 @@ module Orb
|
|
5861
5555
|
required :duration_unit,
|
5862
5556
|
enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanMaxGroupTieredPackagePrice::BillingCycleConfiguration::DurationUnit }
|
5863
5557
|
|
5864
|
-
# @!
|
5865
|
-
#
|
5866
|
-
#
|
5867
|
-
#
|
5868
|
-
#
|
5869
|
-
#
|
5870
|
-
#
|
5871
|
-
# def initialize(duration:, duration_unit:, **) = super
|
5872
|
-
|
5873
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
5558
|
+
# @!method initialize(duration:, duration_unit:)
|
5559
|
+
# For custom cadence: specifies the duration of the billing period in days or
|
5560
|
+
# months.
|
5561
|
+
#
|
5562
|
+
# @param duration [Integer] The duration of the billing period.
|
5563
|
+
#
|
5564
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanMaxGroupTieredPackagePrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
5874
5565
|
|
5875
5566
|
# The unit of billing period duration.
|
5876
5567
|
#
|
@@ -5881,11 +5572,8 @@ module Orb
|
|
5881
5572
|
DAY = :day
|
5882
5573
|
MONTH = :month
|
5883
5574
|
|
5884
|
-
|
5885
|
-
|
5886
|
-
# @!parse
|
5887
|
-
# # @return [Array<Symbol>]
|
5888
|
-
# def self.values; end
|
5575
|
+
# @!method self.values
|
5576
|
+
# @return [Array<Symbol>]
|
5889
5577
|
end
|
5890
5578
|
end
|
5891
5579
|
|
@@ -5904,16 +5592,13 @@ module Orb
|
|
5904
5592
|
required :duration_unit,
|
5905
5593
|
enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanMaxGroupTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit }
|
5906
5594
|
|
5907
|
-
# @!
|
5908
|
-
#
|
5909
|
-
#
|
5910
|
-
#
|
5911
|
-
#
|
5912
|
-
#
|
5913
|
-
#
|
5914
|
-
# def initialize(duration:, duration_unit:, **) = super
|
5915
|
-
|
5916
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
5595
|
+
# @!method initialize(duration:, duration_unit:)
|
5596
|
+
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
5597
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
5598
|
+
#
|
5599
|
+
# @param duration [Integer] The duration of the billing period.
|
5600
|
+
#
|
5601
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanMaxGroupTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
5917
5602
|
|
5918
5603
|
# The unit of billing period duration.
|
5919
5604
|
#
|
@@ -5924,11 +5609,8 @@ module Orb
|
|
5924
5609
|
DAY = :day
|
5925
5610
|
MONTH = :month
|
5926
5611
|
|
5927
|
-
|
5928
|
-
|
5929
|
-
# @!parse
|
5930
|
-
# # @return [Array<Symbol>]
|
5931
|
-
# def self.values; end
|
5612
|
+
# @!method self.values
|
5613
|
+
# @return [Array<Symbol>]
|
5932
5614
|
end
|
5933
5615
|
end
|
5934
5616
|
end
|
@@ -6036,45 +5718,47 @@ module Orb
|
|
6036
5718
|
# @return [Hash{Symbol=>String, nil}, nil]
|
6037
5719
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
6038
5720
|
|
6039
|
-
# @!
|
6040
|
-
#
|
6041
|
-
#
|
6042
|
-
#
|
6043
|
-
#
|
6044
|
-
#
|
6045
|
-
#
|
6046
|
-
#
|
6047
|
-
#
|
6048
|
-
#
|
6049
|
-
#
|
6050
|
-
#
|
6051
|
-
#
|
6052
|
-
#
|
6053
|
-
#
|
6054
|
-
#
|
6055
|
-
#
|
6056
|
-
#
|
6057
|
-
#
|
6058
|
-
#
|
6059
|
-
#
|
6060
|
-
#
|
6061
|
-
#
|
6062
|
-
#
|
6063
|
-
#
|
6064
|
-
#
|
6065
|
-
#
|
6066
|
-
#
|
6067
|
-
#
|
6068
|
-
#
|
6069
|
-
#
|
6070
|
-
#
|
6071
|
-
#
|
6072
|
-
#
|
6073
|
-
#
|
6074
|
-
#
|
6075
|
-
#
|
6076
|
-
|
6077
|
-
#
|
5721
|
+
# @!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
|
+
# Some parameter documentations has been truncated, see
|
5723
|
+
# {Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithUnitPricingPrice}
|
5724
|
+
# for more details.
|
5725
|
+
#
|
5726
|
+
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithUnitPricingPrice::Cadence] The cadence to bill for this price on.
|
5727
|
+
#
|
5728
|
+
# @param item_id [String] The id of the item the price will be associated with.
|
5729
|
+
#
|
5730
|
+
# @param name [String] The name of the price.
|
5731
|
+
#
|
5732
|
+
# @param scalable_matrix_with_unit_pricing_config [Hash{Symbol=>Object}]
|
5733
|
+
#
|
5734
|
+
# @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
|
+
#
|
5737
|
+
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
5738
|
+
# ...
|
5739
|
+
#
|
5740
|
+
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
5741
|
+
# ...
|
5742
|
+
#
|
5743
|
+
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
5744
|
+
#
|
5745
|
+
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
5746
|
+
# ...
|
5747
|
+
#
|
5748
|
+
# @param external_price_id [String, nil] An alias for the price.
|
5749
|
+
#
|
5750
|
+
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
5751
|
+
# ...
|
5752
|
+
#
|
5753
|
+
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
5754
|
+
#
|
5755
|
+
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
5756
|
+
# ...
|
5757
|
+
#
|
5758
|
+
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
5759
|
+
# ...
|
5760
|
+
#
|
5761
|
+
# @param model_type [Symbol, :scalable_matrix_with_unit_pricing]
|
6078
5762
|
|
6079
5763
|
# The cadence to bill for this price on.
|
6080
5764
|
#
|
@@ -6089,11 +5773,8 @@ module Orb
|
|
6089
5773
|
ONE_TIME = :one_time
|
6090
5774
|
CUSTOM = :custom
|
6091
5775
|
|
6092
|
-
|
6093
|
-
|
6094
|
-
# @!parse
|
6095
|
-
# # @return [Array<Symbol>]
|
6096
|
-
# def self.values; end
|
5776
|
+
# @!method self.values
|
5777
|
+
# @return [Array<Symbol>]
|
6097
5778
|
end
|
6098
5779
|
|
6099
5780
|
# @see Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithUnitPricingPrice#billing_cycle_configuration
|
@@ -6111,16 +5792,13 @@ module Orb
|
|
6111
5792
|
required :duration_unit,
|
6112
5793
|
enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration::DurationUnit }
|
6113
5794
|
|
6114
|
-
# @!
|
6115
|
-
#
|
6116
|
-
#
|
6117
|
-
#
|
6118
|
-
#
|
6119
|
-
#
|
6120
|
-
#
|
6121
|
-
# def initialize(duration:, duration_unit:, **) = super
|
6122
|
-
|
6123
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
5795
|
+
# @!method initialize(duration:, duration_unit:)
|
5796
|
+
# For custom cadence: specifies the duration of the billing period in days or
|
5797
|
+
# months.
|
5798
|
+
#
|
5799
|
+
# @param duration [Integer] The duration of the billing period.
|
5800
|
+
#
|
5801
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
6124
5802
|
|
6125
5803
|
# The unit of billing period duration.
|
6126
5804
|
#
|
@@ -6131,11 +5809,8 @@ module Orb
|
|
6131
5809
|
DAY = :day
|
6132
5810
|
MONTH = :month
|
6133
5811
|
|
6134
|
-
|
6135
|
-
|
6136
|
-
# @!parse
|
6137
|
-
# # @return [Array<Symbol>]
|
6138
|
-
# def self.values; end
|
5812
|
+
# @!method self.values
|
5813
|
+
# @return [Array<Symbol>]
|
6139
5814
|
end
|
6140
5815
|
end
|
6141
5816
|
|
@@ -6154,16 +5829,13 @@ module Orb
|
|
6154
5829
|
required :duration_unit,
|
6155
5830
|
enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration::DurationUnit }
|
6156
5831
|
|
6157
|
-
# @!
|
6158
|
-
#
|
6159
|
-
#
|
6160
|
-
#
|
6161
|
-
#
|
6162
|
-
#
|
6163
|
-
#
|
6164
|
-
# def initialize(duration:, duration_unit:, **) = super
|
6165
|
-
|
6166
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
5832
|
+
# @!method initialize(duration:, duration_unit:)
|
5833
|
+
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
5834
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
5835
|
+
#
|
5836
|
+
# @param duration [Integer] The duration of the billing period.
|
5837
|
+
#
|
5838
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
6167
5839
|
|
6168
5840
|
# The unit of billing period duration.
|
6169
5841
|
#
|
@@ -6174,11 +5846,8 @@ module Orb
|
|
6174
5846
|
DAY = :day
|
6175
5847
|
MONTH = :month
|
6176
5848
|
|
6177
|
-
|
6178
|
-
|
6179
|
-
# @!parse
|
6180
|
-
# # @return [Array<Symbol>]
|
6181
|
-
# def self.values; end
|
5849
|
+
# @!method self.values
|
5850
|
+
# @return [Array<Symbol>]
|
6182
5851
|
end
|
6183
5852
|
end
|
6184
5853
|
end
|
@@ -6286,45 +5955,47 @@ module Orb
|
|
6286
5955
|
# @return [Hash{Symbol=>String, nil}, nil]
|
6287
5956
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
6288
5957
|
|
6289
|
-
# @!
|
6290
|
-
#
|
6291
|
-
#
|
6292
|
-
#
|
6293
|
-
#
|
6294
|
-
#
|
6295
|
-
#
|
6296
|
-
#
|
6297
|
-
#
|
6298
|
-
#
|
6299
|
-
#
|
6300
|
-
#
|
6301
|
-
#
|
6302
|
-
#
|
6303
|
-
#
|
6304
|
-
#
|
6305
|
-
#
|
6306
|
-
#
|
6307
|
-
#
|
6308
|
-
#
|
6309
|
-
#
|
6310
|
-
#
|
6311
|
-
#
|
6312
|
-
#
|
6313
|
-
#
|
6314
|
-
#
|
6315
|
-
#
|
6316
|
-
#
|
6317
|
-
#
|
6318
|
-
#
|
6319
|
-
#
|
6320
|
-
#
|
6321
|
-
#
|
6322
|
-
#
|
6323
|
-
#
|
6324
|
-
#
|
6325
|
-
#
|
6326
|
-
|
6327
|
-
#
|
5958
|
+
# @!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
|
+
# Some parameter documentations has been truncated, see
|
5960
|
+
# {Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithTieredPricingPrice}
|
5961
|
+
# for more details.
|
5962
|
+
#
|
5963
|
+
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithTieredPricingPrice::Cadence] The cadence to bill for this price on.
|
5964
|
+
#
|
5965
|
+
# @param item_id [String] The id of the item the price will be associated with.
|
5966
|
+
#
|
5967
|
+
# @param name [String] The name of the price.
|
5968
|
+
#
|
5969
|
+
# @param scalable_matrix_with_tiered_pricing_config [Hash{Symbol=>Object}]
|
5970
|
+
#
|
5971
|
+
# @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
|
+
#
|
5974
|
+
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
5975
|
+
# ...
|
5976
|
+
#
|
5977
|
+
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
5978
|
+
# ...
|
5979
|
+
#
|
5980
|
+
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
5981
|
+
#
|
5982
|
+
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
5983
|
+
# ...
|
5984
|
+
#
|
5985
|
+
# @param external_price_id [String, nil] An alias for the price.
|
5986
|
+
#
|
5987
|
+
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
5988
|
+
# ...
|
5989
|
+
#
|
5990
|
+
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
5991
|
+
#
|
5992
|
+
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
5993
|
+
# ...
|
5994
|
+
#
|
5995
|
+
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
5996
|
+
# ...
|
5997
|
+
#
|
5998
|
+
# @param model_type [Symbol, :scalable_matrix_with_tiered_pricing]
|
6328
5999
|
|
6329
6000
|
# The cadence to bill for this price on.
|
6330
6001
|
#
|
@@ -6339,11 +6010,8 @@ module Orb
|
|
6339
6010
|
ONE_TIME = :one_time
|
6340
6011
|
CUSTOM = :custom
|
6341
6012
|
|
6342
|
-
|
6343
|
-
|
6344
|
-
# @!parse
|
6345
|
-
# # @return [Array<Symbol>]
|
6346
|
-
# def self.values; end
|
6013
|
+
# @!method self.values
|
6014
|
+
# @return [Array<Symbol>]
|
6347
6015
|
end
|
6348
6016
|
|
6349
6017
|
# @see Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithTieredPricingPrice#billing_cycle_configuration
|
@@ -6361,16 +6029,13 @@ module Orb
|
|
6361
6029
|
required :duration_unit,
|
6362
6030
|
enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration::DurationUnit }
|
6363
6031
|
|
6364
|
-
# @!
|
6365
|
-
#
|
6366
|
-
#
|
6367
|
-
#
|
6368
|
-
#
|
6369
|
-
#
|
6370
|
-
#
|
6371
|
-
# def initialize(duration:, duration_unit:, **) = super
|
6372
|
-
|
6373
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
6032
|
+
# @!method initialize(duration:, duration_unit:)
|
6033
|
+
# For custom cadence: specifies the duration of the billing period in days or
|
6034
|
+
# months.
|
6035
|
+
#
|
6036
|
+
# @param duration [Integer] The duration of the billing period.
|
6037
|
+
#
|
6038
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
6374
6039
|
|
6375
6040
|
# The unit of billing period duration.
|
6376
6041
|
#
|
@@ -6381,11 +6046,8 @@ module Orb
|
|
6381
6046
|
DAY = :day
|
6382
6047
|
MONTH = :month
|
6383
6048
|
|
6384
|
-
|
6385
|
-
|
6386
|
-
# @!parse
|
6387
|
-
# # @return [Array<Symbol>]
|
6388
|
-
# def self.values; end
|
6049
|
+
# @!method self.values
|
6050
|
+
# @return [Array<Symbol>]
|
6389
6051
|
end
|
6390
6052
|
end
|
6391
6053
|
|
@@ -6404,16 +6066,13 @@ module Orb
|
|
6404
6066
|
required :duration_unit,
|
6405
6067
|
enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration::DurationUnit }
|
6406
6068
|
|
6407
|
-
# @!
|
6408
|
-
#
|
6409
|
-
#
|
6410
|
-
#
|
6411
|
-
#
|
6412
|
-
#
|
6413
|
-
#
|
6414
|
-
# def initialize(duration:, duration_unit:, **) = super
|
6415
|
-
|
6416
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
6069
|
+
# @!method initialize(duration:, duration_unit:)
|
6070
|
+
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
6071
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
6072
|
+
#
|
6073
|
+
# @param duration [Integer] The duration of the billing period.
|
6074
|
+
#
|
6075
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
6417
6076
|
|
6418
6077
|
# The unit of billing period duration.
|
6419
6078
|
#
|
@@ -6424,11 +6083,8 @@ module Orb
|
|
6424
6083
|
DAY = :day
|
6425
6084
|
MONTH = :month
|
6426
6085
|
|
6427
|
-
|
6428
|
-
|
6429
|
-
# @!parse
|
6430
|
-
# # @return [Array<Symbol>]
|
6431
|
-
# def self.values; end
|
6086
|
+
# @!method self.values
|
6087
|
+
# @return [Array<Symbol>]
|
6432
6088
|
end
|
6433
6089
|
end
|
6434
6090
|
end
|
@@ -6535,45 +6191,47 @@ module Orb
|
|
6535
6191
|
# @return [Hash{Symbol=>String, nil}, nil]
|
6536
6192
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
6537
6193
|
|
6538
|
-
# @!
|
6539
|
-
#
|
6540
|
-
#
|
6541
|
-
#
|
6542
|
-
#
|
6543
|
-
#
|
6544
|
-
#
|
6545
|
-
#
|
6546
|
-
#
|
6547
|
-
#
|
6548
|
-
#
|
6549
|
-
#
|
6550
|
-
#
|
6551
|
-
#
|
6552
|
-
#
|
6553
|
-
#
|
6554
|
-
#
|
6555
|
-
#
|
6556
|
-
#
|
6557
|
-
#
|
6558
|
-
#
|
6559
|
-
#
|
6560
|
-
#
|
6561
|
-
#
|
6562
|
-
#
|
6563
|
-
#
|
6564
|
-
#
|
6565
|
-
#
|
6566
|
-
#
|
6567
|
-
#
|
6568
|
-
#
|
6569
|
-
#
|
6570
|
-
#
|
6571
|
-
#
|
6572
|
-
#
|
6573
|
-
#
|
6574
|
-
#
|
6575
|
-
|
6576
|
-
#
|
6194
|
+
# @!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
|
+
# Some parameter documentations has been truncated, see
|
6196
|
+
# {Orb::Models::PlanCreateParams::Price::NewPlanCumulativeGroupedBulkPrice} for
|
6197
|
+
# more details.
|
6198
|
+
#
|
6199
|
+
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanCumulativeGroupedBulkPrice::Cadence] The cadence to bill for this price on.
|
6200
|
+
#
|
6201
|
+
# @param cumulative_grouped_bulk_config [Hash{Symbol=>Object}]
|
6202
|
+
#
|
6203
|
+
# @param item_id [String] The id of the item the price will be associated with.
|
6204
|
+
#
|
6205
|
+
# @param name [String] The name of the price.
|
6206
|
+
#
|
6207
|
+
# @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
|
+
#
|
6210
|
+
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
6211
|
+
# ...
|
6212
|
+
#
|
6213
|
+
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanCumulativeGroupedBulkPrice::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
6214
|
+
# ...
|
6215
|
+
#
|
6216
|
+
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
6217
|
+
#
|
6218
|
+
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
6219
|
+
# ...
|
6220
|
+
#
|
6221
|
+
# @param external_price_id [String, nil] An alias for the price.
|
6222
|
+
#
|
6223
|
+
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
6224
|
+
# ...
|
6225
|
+
#
|
6226
|
+
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
6227
|
+
#
|
6228
|
+
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::NewPlanCumulativeGroupedBulkPrice::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
6229
|
+
# ...
|
6230
|
+
#
|
6231
|
+
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
6232
|
+
# ...
|
6233
|
+
#
|
6234
|
+
# @param model_type [Symbol, :cumulative_grouped_bulk]
|
6577
6235
|
|
6578
6236
|
# The cadence to bill for this price on.
|
6579
6237
|
#
|
@@ -6588,11 +6246,8 @@ module Orb
|
|
6588
6246
|
ONE_TIME = :one_time
|
6589
6247
|
CUSTOM = :custom
|
6590
6248
|
|
6591
|
-
|
6592
|
-
|
6593
|
-
# @!parse
|
6594
|
-
# # @return [Array<Symbol>]
|
6595
|
-
# def self.values; end
|
6249
|
+
# @!method self.values
|
6250
|
+
# @return [Array<Symbol>]
|
6596
6251
|
end
|
6597
6252
|
|
6598
6253
|
# @see Orb::Models::PlanCreateParams::Price::NewPlanCumulativeGroupedBulkPrice#billing_cycle_configuration
|
@@ -6610,16 +6265,13 @@ module Orb
|
|
6610
6265
|
required :duration_unit,
|
6611
6266
|
enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanCumulativeGroupedBulkPrice::BillingCycleConfiguration::DurationUnit }
|
6612
6267
|
|
6613
|
-
# @!
|
6614
|
-
#
|
6615
|
-
#
|
6616
|
-
#
|
6617
|
-
#
|
6618
|
-
#
|
6619
|
-
#
|
6620
|
-
# def initialize(duration:, duration_unit:, **) = super
|
6621
|
-
|
6622
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
6268
|
+
# @!method initialize(duration:, duration_unit:)
|
6269
|
+
# For custom cadence: specifies the duration of the billing period in days or
|
6270
|
+
# months.
|
6271
|
+
#
|
6272
|
+
# @param duration [Integer] The duration of the billing period.
|
6273
|
+
#
|
6274
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanCumulativeGroupedBulkPrice::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
6623
6275
|
|
6624
6276
|
# The unit of billing period duration.
|
6625
6277
|
#
|
@@ -6630,11 +6282,8 @@ module Orb
|
|
6630
6282
|
DAY = :day
|
6631
6283
|
MONTH = :month
|
6632
6284
|
|
6633
|
-
|
6634
|
-
|
6635
|
-
# @!parse
|
6636
|
-
# # @return [Array<Symbol>]
|
6637
|
-
# def self.values; end
|
6285
|
+
# @!method self.values
|
6286
|
+
# @return [Array<Symbol>]
|
6638
6287
|
end
|
6639
6288
|
end
|
6640
6289
|
|
@@ -6653,16 +6302,13 @@ module Orb
|
|
6653
6302
|
required :duration_unit,
|
6654
6303
|
enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanCumulativeGroupedBulkPrice::InvoicingCycleConfiguration::DurationUnit }
|
6655
6304
|
|
6656
|
-
# @!
|
6657
|
-
#
|
6658
|
-
#
|
6659
|
-
#
|
6660
|
-
#
|
6661
|
-
#
|
6662
|
-
#
|
6663
|
-
# def initialize(duration:, duration_unit:, **) = super
|
6664
|
-
|
6665
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
6305
|
+
# @!method initialize(duration:, duration_unit:)
|
6306
|
+
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
6307
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
6308
|
+
#
|
6309
|
+
# @param duration [Integer] The duration of the billing period.
|
6310
|
+
#
|
6311
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanCumulativeGroupedBulkPrice::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
6666
6312
|
|
6667
6313
|
# The unit of billing period duration.
|
6668
6314
|
#
|
@@ -6673,18 +6319,14 @@ module Orb
|
|
6673
6319
|
DAY = :day
|
6674
6320
|
MONTH = :month
|
6675
6321
|
|
6676
|
-
|
6677
|
-
|
6678
|
-
# @!parse
|
6679
|
-
# # @return [Array<Symbol>]
|
6680
|
-
# def self.values; end
|
6322
|
+
# @!method self.values
|
6323
|
+
# @return [Array<Symbol>]
|
6681
6324
|
end
|
6682
6325
|
end
|
6683
6326
|
end
|
6684
6327
|
|
6685
|
-
# @!
|
6686
|
-
#
|
6687
|
-
# def self.variants; end
|
6328
|
+
# @!method self.variants
|
6329
|
+
# @return [Array(Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice, Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice, Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice, Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice, Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice, Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice, Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice, Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice, Orb::Models::PlanCreateParams::Price::NewPlanThresholdTotalAmountPrice, Orb::Models::PlanCreateParams::Price::NewPlanTieredPackagePrice, Orb::Models::PlanCreateParams::Price::NewPlanTieredWithMinimumPrice, Orb::Models::PlanCreateParams::Price::NewPlanUnitWithPercentPrice, Orb::Models::PlanCreateParams::Price::NewPlanPackageWithAllocationPrice, Orb::Models::PlanCreateParams::Price::NewPlanTierWithProrationPrice, Orb::Models::PlanCreateParams::Price::NewPlanUnitWithProrationPrice, Orb::Models::PlanCreateParams::Price::NewPlanGroupedAllocationPrice, Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithProratedMinimumPrice, Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithMeteredMinimumPrice, Orb::Models::PlanCreateParams::Price::NewPlanMatrixWithDisplayNamePrice, Orb::Models::PlanCreateParams::Price::NewPlanBulkWithProrationPrice, Orb::Models::PlanCreateParams::Price::NewPlanGroupedTieredPackagePrice, Orb::Models::PlanCreateParams::Price::NewPlanMaxGroupTieredPackagePrice, Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithUnitPricingPrice, Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithTieredPricingPrice, Orb::Models::PlanCreateParams::Price::NewPlanCumulativeGroupedBulkPrice)]
|
6688
6330
|
end
|
6689
6331
|
|
6690
6332
|
# The status of the plan to create (either active or draft). If not specified,
|
@@ -6695,11 +6337,8 @@ module Orb
|
|
6695
6337
|
ACTIVE = :active
|
6696
6338
|
DRAFT = :draft
|
6697
6339
|
|
6698
|
-
|
6699
|
-
|
6700
|
-
# @!parse
|
6701
|
-
# # @return [Array<Symbol>]
|
6702
|
-
# def self.values; end
|
6340
|
+
# @!method self.values
|
6341
|
+
# @return [Array<Symbol>]
|
6703
6342
|
end
|
6704
6343
|
end
|
6705
6344
|
end
|