orb-billing 0.3.0 → 0.3.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +33 -0
- data/README.md +5 -5
- data/lib/orb/errors.rb +9 -9
- data/lib/orb/internal/page.rb +3 -3
- data/lib/orb/internal/transport/base_client.rb +3 -3
- data/lib/orb/internal/type/base_model.rb +1 -9
- data/lib/orb/internal/type/boolean.rb +10 -11
- data/lib/orb/internal/type/enum.rb +10 -11
- data/lib/orb/internal/type/request_parameters.rb +2 -8
- data/lib/orb/internal/type/unknown.rb +10 -11
- data/lib/orb/internal/util.rb +20 -4
- data/lib/orb/models/coupon_create_params.rb +7 -7
- data/lib/orb/models/customer_create_params.rb +7 -7
- data/lib/orb/models/customer_update_by_external_id_params.rb +7 -9
- data/lib/orb/models/customer_update_params.rb +7 -7
- data/lib/orb/models/customers/cost_list_by_external_id_response.rb +2 -2
- data/lib/orb/models/customers/cost_list_response.rb +2 -2
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +106 -107
- data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +111 -119
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +110 -114
- data/lib/orb/models/customers/credits/ledger_list_response.rb +112 -124
- data/lib/orb/models/invoice.rb +50 -64
- data/lib/orb/models/invoice_fetch_upcoming_response.rb +51 -55
- data/lib/orb/models/invoice_line_item_create_response.rb +54 -57
- data/lib/orb/models/plan.rb +20 -23
- data/lib/orb/models/plan_create_params.rb +635 -670
- data/lib/orb/models/price.rb +1547 -1599
- data/lib/orb/models/subscription.rb +35 -41
- data/lib/orb/models/subscription_cancel_response.rb +33 -36
- data/lib/orb/models/subscription_change_apply_response.rb +31 -32
- data/lib/orb/models/subscription_change_cancel_response.rb +31 -31
- data/lib/orb/models/subscription_change_retrieve_response.rb +31 -31
- data/lib/orb/models/subscription_create_params.rb +1316 -1367
- data/lib/orb/models/subscription_create_response.rb +33 -36
- data/lib/orb/models/subscription_fetch_costs_response.rb +2 -2
- data/lib/orb/models/subscription_price_intervals_params.rb +748 -774
- data/lib/orb/models/subscription_price_intervals_response.rb +32 -35
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +1299 -1354
- data/lib/orb/models/subscription_schedule_plan_change_response.rb +31 -33
- data/lib/orb/models/subscription_trigger_phase_response.rb +32 -35
- data/lib/orb/models/subscription_unschedule_cancellation_response.rb +31 -33
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +31 -31
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +31 -31
- data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +31 -33
- data/lib/orb/models/subscription_update_trial_response.rb +33 -36
- data/lib/orb/models.rb +220 -0
- data/lib/orb/request_options.rb +4 -5
- data/lib/orb/resources/coupons.rb +1 -1
- data/lib/orb/resources/customers/credits/ledger.rb +4 -4
- data/lib/orb/resources/customers.rb +3 -3
- data/lib/orb/resources/plans.rb +1 -1
- data/lib/orb/resources/prices/external_price_id.rb +2 -2
- data/lib/orb/resources/prices.rb +4 -4
- data/lib/orb/version.rb +1 -1
- data/rbi/{lib/orb → orb}/errors.rbi +1 -1
- data/rbi/{lib/orb → orb}/internal/transport/base_client.rbi +2 -2
- data/rbi/{lib/orb → orb}/internal/type/request_parameters.rbi +1 -1
- data/rbi/{lib/orb → orb}/internal/util.rbi +5 -1
- data/rbi/{lib/orb → orb}/models/coupon_create_params.rbi +9 -9
- data/rbi/{lib/orb → orb}/models/customer_create_params.rbi +9 -9
- data/rbi/{lib/orb → orb}/models/customer_update_by_external_id_params.rbi +9 -9
- data/rbi/{lib/orb → orb}/models/customer_update_params.rbi +9 -9
- data/rbi/{lib/orb → orb}/models/customers/cost_list_by_external_id_response.rbi +84 -84
- data/rbi/{lib/orb → orb}/models/customers/cost_list_response.rbi +84 -84
- data/rbi/{lib/orb/models/customers/credits/ledger_create_entry_response.rbi → orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi} +122 -114
- data/rbi/{lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi → orb/models/customers/credits/ledger_create_entry_response.rbi} +114 -216
- data/rbi/{lib/orb/models/customers/credits/ledger_list_response.rbi → orb/models/customers/credits/ledger_list_by_external_id_response.rbi} +114 -114
- data/rbi/{lib/orb/models/customers/credits/ledger_list_by_external_id_response.rbi → orb/models/customers/credits/ledger_list_response.rbi} +114 -271
- data/rbi/{lib/orb → orb}/models/invoice.rbi +138 -156
- data/rbi/{lib/orb → orb}/models/invoice_fetch_upcoming_response.rbi +138 -150
- data/rbi/{lib/orb → orb}/models/invoice_line_item_create_response.rbi +138 -162
- data/rbi/{lib/orb → orb}/models/plan.rbi +105 -105
- data/rbi/{lib/orb → orb}/models/plan_create_params.rbi +973 -1734
- data/rbi/{lib/orb → orb}/models/price.rbi +1875 -2267
- data/rbi/{lib/orb → orb}/models/subscription.rbi +118 -118
- data/rbi/{lib/orb → orb}/models/subscription_cancel_response.rbi +118 -118
- data/rbi/{lib/orb → orb}/models/subscription_change_apply_response.rbi +118 -118
- data/rbi/{lib/orb → orb}/models/subscription_change_cancel_response.rbi +118 -118
- data/rbi/{lib/orb → orb}/models/subscription_change_retrieve_response.rbi +118 -118
- data/rbi/{lib/orb → orb}/models/subscription_create_params.rbi +1988 -2733
- data/rbi/{lib/orb → orb}/models/subscription_create_response.rbi +118 -118
- data/rbi/{lib/orb → orb}/models/subscription_fetch_costs_response.rbi +84 -84
- data/rbi/{lib/orb → orb}/models/subscription_price_intervals_params.rbi +1125 -1455
- data/rbi/{lib/orb → orb}/models/subscription_price_intervals_response.rbi +118 -118
- data/rbi/{lib/orb → orb}/models/subscription_schedule_plan_change_params.rbi +1988 -2210
- data/rbi/{lib/orb → orb}/models/subscription_schedule_plan_change_response.rbi +118 -118
- data/rbi/{lib/orb → orb}/models/subscription_trigger_phase_response.rbi +118 -118
- data/rbi/{lib/orb → orb}/models/subscription_unschedule_cancellation_response.rbi +118 -118
- data/rbi/{lib/orb → orb}/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +118 -118
- data/rbi/{lib/orb → orb}/models/subscription_unschedule_pending_plan_changes_response.rbi +118 -118
- data/rbi/{lib/orb → orb}/models/subscription_update_fixed_fee_quantity_response.rbi +118 -118
- data/rbi/{lib/orb → orb}/models/subscription_update_trial_response.rbi +118 -118
- data/rbi/orb/models.rbi +220 -0
- data/rbi/{lib/orb → orb}/request_options.rbi +2 -0
- data/rbi/{lib/orb → orb}/resources/alerts.rbi +8 -14
- data/rbi/{lib/orb → orb}/resources/coupons/subscriptions.rbi +1 -1
- data/rbi/{lib/orb → orb}/resources/coupons.rbi +6 -18
- data/rbi/{lib/orb → orb}/resources/credit_notes.rbi +3 -9
- data/rbi/{lib/orb → orb}/resources/customers/balance_transactions.rbi +2 -2
- data/rbi/{lib/orb → orb}/resources/customers/costs.rbi +2 -2
- data/rbi/{lib/orb → orb}/resources/customers/credits/ledger.rbi +32 -32
- data/rbi/{lib/orb → orb}/resources/customers/credits/top_ups.rbi +6 -18
- data/rbi/{lib/orb → orb}/resources/customers/credits.rbi +2 -2
- data/rbi/{lib/orb → orb}/resources/customers.rbi +15 -45
- data/rbi/{lib/orb → orb}/resources/dimensional_price_groups/external_dimensional_price_group_id.rbi +1 -4
- data/rbi/{lib/orb → orb}/resources/dimensional_price_groups.rbi +3 -10
- data/rbi/{lib/orb → orb}/resources/events/backfills.rbi +5 -18
- data/rbi/{lib/orb → orb}/resources/events/volume.rbi +1 -1
- data/rbi/{lib/orb → orb}/resources/events.rbi +4 -10
- data/rbi/{lib/orb → orb}/resources/invoice_line_items.rbi +1 -1
- data/rbi/{lib/orb → orb}/resources/invoices.rbi +9 -34
- data/rbi/{lib/orb → orb}/resources/items.rbi +4 -17
- data/rbi/{lib/orb → orb}/resources/metrics.rbi +4 -10
- data/rbi/{lib/orb → orb}/resources/plans/external_plan_id.rbi +2 -8
- data/rbi/{lib/orb → orb}/resources/plans.rbi +29 -35
- data/rbi/orb/resources/prices/external_price_id.rbi +103 -0
- data/rbi/{lib/orb → orb}/resources/prices.rbi +117 -124
- data/rbi/{lib/orb → orb}/resources/subscription_changes.rbi +3 -9
- data/rbi/{lib/orb → orb}/resources/subscriptions.rbi +16 -32
- data/rbi/{lib/orb → orb}/resources/top_level.rbi +1 -4
- data/sig/orb/internal/util.rbs +2 -0
- data/sig/orb/models/coupon_create_params.rbs +9 -10
- data/sig/orb/models/customer_create_params.rbs +9 -10
- data/sig/orb/models/customer_update_by_external_id_params.rbs +9 -10
- data/sig/orb/models/customer_update_params.rbs +9 -10
- data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbs +113 -113
- data/sig/orb/models/customers/credits/ledger_create_entry_response.rbs +113 -113
- data/sig/orb/models/customers/credits/ledger_list_by_external_id_response.rbs +113 -113
- data/sig/orb/models/customers/credits/ledger_list_response.rbs +113 -113
- data/sig/orb/models/invoice.rbs +54 -54
- data/sig/orb/models/invoice_fetch_upcoming_response.rbs +54 -54
- data/sig/orb/models/invoice_line_item_create_response.rbs +54 -54
- data/sig/orb/models/plan.rbs +21 -21
- data/sig/orb/models/plan_create_params.rbs +653 -653
- data/sig/orb/models/price.rbs +1517 -1521
- data/sig/orb/models/subscription.rbs +34 -34
- data/sig/orb/models/subscription_cancel_response.rbs +34 -34
- data/sig/orb/models/subscription_change_apply_response.rbs +34 -34
- data/sig/orb/models/subscription_change_cancel_response.rbs +34 -34
- data/sig/orb/models/subscription_change_retrieve_response.rbs +34 -34
- data/sig/orb/models/subscription_create_params.rbs +1348 -1348
- data/sig/orb/models/subscription_create_response.rbs +34 -34
- data/sig/orb/models/subscription_price_intervals_params.rbs +767 -769
- data/sig/orb/models/subscription_price_intervals_response.rbs +34 -34
- data/sig/orb/models/subscription_schedule_plan_change_params.rbs +1348 -1348
- data/sig/orb/models/subscription_schedule_plan_change_response.rbs +34 -34
- data/sig/orb/models/subscription_trigger_phase_response.rbs +34 -34
- data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +34 -34
- data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +34 -34
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +34 -34
- data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +34 -34
- data/sig/orb/models/subscription_update_trial_response.rbs +34 -34
- data/sig/orb/models.rbs +215 -0
- metadata +226 -223
- data/rbi/lib/orb/resources/prices/external_price_id.rbi +0 -106
- data/rbi/{lib/orb → orb}/client.rbi +0 -0
- data/rbi/{lib/orb → orb}/file_part.rbi +0 -0
- data/rbi/{lib/orb → orb}/internal/page.rbi +0 -0
- data/rbi/{lib/orb → orb}/internal/transport/pooled_net_requester.rbi +0 -0
- data/rbi/{lib/orb → orb}/internal/type/array_of.rbi +0 -0
- data/rbi/{lib/orb → orb}/internal/type/base_model.rbi +0 -0
- data/rbi/{lib/orb → orb}/internal/type/base_page.rbi +0 -0
- data/rbi/{lib/orb → orb}/internal/type/boolean.rbi +0 -0
- data/rbi/{lib/orb → orb}/internal/type/converter.rbi +0 -0
- data/rbi/{lib/orb → orb}/internal/type/enum.rbi +0 -0
- data/rbi/{lib/orb → orb}/internal/type/file_input.rbi +0 -0
- data/rbi/{lib/orb → orb}/internal/type/hash_of.rbi +0 -0
- data/rbi/{lib/orb → orb}/internal/type/union.rbi +0 -0
- data/rbi/{lib/orb → orb}/internal/type/unknown.rbi +0 -0
- data/rbi/{lib/orb → orb}/internal.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/alert.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/alert_create_for_customer_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/alert_create_for_external_customer_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/alert_create_for_subscription_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/alert_disable_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/alert_enable_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/alert_list_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/alert_retrieve_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/alert_update_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/amount_discount.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/billable_metric.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/billing_cycle_relative_date.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/coupon.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/coupon_archive_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/coupon_fetch_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/coupon_list_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/coupons/subscription_list_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/credit_note.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/credit_note_create_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/credit_note_fetch_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/credit_note_list_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customer.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customer_delete_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customer_fetch_by_external_id_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customer_fetch_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customer_list_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customer_sync_payment_methods_from_gateway_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/balance_transaction_create_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/balance_transaction_create_response.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/balance_transaction_list_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/balance_transaction_list_response.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/cost_list_by_external_id_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/cost_list_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/credit_list_by_external_id_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/credit_list_by_external_id_response.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/credit_list_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/credit_list_response.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/credits/ledger_create_entry_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/credits/ledger_list_by_external_id_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/credits/ledger_list_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_by_external_id_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_by_external_id_response.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_response.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_delete_by_external_id_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_delete_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_by_external_id_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_by_external_id_response.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_response.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/dimensional_price_group.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/dimensional_price_group_create_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/dimensional_price_group_list_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/dimensional_price_group_retrieve_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/dimensional_price_groups.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/discount.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/evaluate_price_group.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/event_deprecate_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/event_deprecate_response.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/event_ingest_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/event_ingest_response.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/event_search_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/event_search_response.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/event_update_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/event_update_response.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/events/backfill_close_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/events/backfill_close_response.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/events/backfill_create_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/events/backfill_create_response.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/events/backfill_fetch_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/events/backfill_fetch_response.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/events/backfill_list_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/events/backfill_list_response.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/events/backfill_revert_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/events/backfill_revert_response.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/events/event_volumes.rbi +2 -2
- /data/rbi/{lib/orb → orb}/models/events/volume_list_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_create_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_fetch_upcoming_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_issue_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_level_discount.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_line_item_create_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_list_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_mark_paid_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_pay_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_update_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_void_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/item.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/item_create_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/item_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/item_list_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/item_update_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/metric_create_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/metric_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/metric_list_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/metric_update_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/pagination_metadata.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/percentage_discount.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/plan_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/plan_list_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/plan_update_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/plans/external_plan_id_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/plans/external_plan_id_update_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/price_create_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/price_evaluate_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/price_evaluate_response.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/price_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/price_list_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/price_update_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/prices/external_price_id_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/prices/external_price_id_update_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_cancel_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_change_apply_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_change_cancel_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_change_retrieve_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_fetch_costs_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_fetch_schedule_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_fetch_schedule_response.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_fetch_usage_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_list_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_trigger_phase_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_unschedule_cancellation_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_unschedule_pending_plan_changes_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_update_fixed_fee_quantity_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_update_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_update_trial_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_usage.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscriptions.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/top_level_ping_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/top_level_ping_response.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/trial_discount.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/usage_discount.rbi +0 -0
- /data/rbi/{lib/orb → orb}/version.rbi +0 -0
@@ -23,7 +23,7 @@ module Orb
|
|
23
23
|
# Prices for this plan. If the plan has phases, this includes prices across all
|
24
24
|
# phases of the plan.
|
25
25
|
#
|
26
|
-
# @return [Array<Orb::Models::PlanCreateParams::Price::
|
26
|
+
# @return [Array<Orb::Models::PlanCreateParams::Price::Unit, Orb::Models::PlanCreateParams::Price::Package, Orb::Models::PlanCreateParams::Price::Matrix, Orb::Models::PlanCreateParams::Price::Tiered, Orb::Models::PlanCreateParams::Price::TieredBps, Orb::Models::PlanCreateParams::Price::Bps, Orb::Models::PlanCreateParams::Price::BulkBps, Orb::Models::PlanCreateParams::Price::Bulk, Orb::Models::PlanCreateParams::Price::ThresholdTotalAmount, Orb::Models::PlanCreateParams::Price::TieredPackage, Orb::Models::PlanCreateParams::Price::TieredWithMinimum, Orb::Models::PlanCreateParams::Price::UnitWithPercent, Orb::Models::PlanCreateParams::Price::PackageWithAllocation, Orb::Models::PlanCreateParams::Price::TieredWithProration, Orb::Models::PlanCreateParams::Price::UnitWithProration, Orb::Models::PlanCreateParams::Price::GroupedAllocation, Orb::Models::PlanCreateParams::Price::GroupedWithProratedMinimum, Orb::Models::PlanCreateParams::Price::GroupedWithMeteredMinimum, Orb::Models::PlanCreateParams::Price::MatrixWithDisplayName, Orb::Models::PlanCreateParams::Price::BulkWithProration, Orb::Models::PlanCreateParams::Price::GroupedTieredPackage, Orb::Models::PlanCreateParams::Price::MaxGroupTieredPackage, Orb::Models::PlanCreateParams::Price::ScalableMatrixWithUnitPricing, Orb::Models::PlanCreateParams::Price::ScalableMatrixWithTieredPricing, Orb::Models::PlanCreateParams::Price::CumulativeGroupedBulk>]
|
27
27
|
required :prices, -> { Orb::Internal::Type::ArrayOf[union: Orb::Models::PlanCreateParams::Price] }
|
28
28
|
|
29
29
|
# @!attribute default_invoice_memo
|
@@ -69,7 +69,7 @@ module Orb
|
|
69
69
|
#
|
70
70
|
# @param name [String]
|
71
71
|
#
|
72
|
-
# @param prices [Array<Orb::Models::PlanCreateParams::Price::
|
72
|
+
# @param prices [Array<Orb::Models::PlanCreateParams::Price::Unit, Orb::Models::PlanCreateParams::Price::Package, Orb::Models::PlanCreateParams::Price::Matrix, Orb::Models::PlanCreateParams::Price::Tiered, Orb::Models::PlanCreateParams::Price::TieredBps, Orb::Models::PlanCreateParams::Price::Bps, Orb::Models::PlanCreateParams::Price::BulkBps, Orb::Models::PlanCreateParams::Price::Bulk, Orb::Models::PlanCreateParams::Price::ThresholdTotalAmount, Orb::Models::PlanCreateParams::Price::TieredPackage, Orb::Models::PlanCreateParams::Price::TieredWithMinimum, Orb::Models::PlanCreateParams::Price::UnitWithPercent, Orb::Models::PlanCreateParams::Price::PackageWithAllocation, Orb::Models::PlanCreateParams::Price::TieredWithProration, Orb::Models::PlanCreateParams::Price::UnitWithProration, Orb::Models::PlanCreateParams::Price::GroupedAllocation, Orb::Models::PlanCreateParams::Price::GroupedWithProratedMinimum, Orb::Models::PlanCreateParams::Price::GroupedWithMeteredMinimum, Orb::Models::PlanCreateParams::Price::MatrixWithDisplayName, Orb::Models::PlanCreateParams::Price::BulkWithProration, Orb::Models::PlanCreateParams::Price::GroupedTieredPackage, Orb::Models::PlanCreateParams::Price::MaxGroupTieredPackage, Orb::Models::PlanCreateParams::Price::ScalableMatrixWithUnitPricing, Orb::Models::PlanCreateParams::Price::ScalableMatrixWithTieredPricing, Orb::Models::PlanCreateParams::Price::CumulativeGroupedBulk>] Prices for this plan. If the plan has phases, this includes prices across all ph
|
73
73
|
# ...
|
74
74
|
#
|
75
75
|
# @param default_invoice_memo [String, nil] Free-form text which is available on the invoice PDF and the Orb invoice portal.
|
@@ -93,72 +93,66 @@ module Orb
|
|
93
93
|
|
94
94
|
discriminator :model_type
|
95
95
|
|
96
|
-
variant :unit, -> { Orb::Models::PlanCreateParams::Price::
|
96
|
+
variant :unit, -> { Orb::Models::PlanCreateParams::Price::Unit }
|
97
97
|
|
98
|
-
variant :package, -> { Orb::Models::PlanCreateParams::Price::
|
98
|
+
variant :package, -> { Orb::Models::PlanCreateParams::Price::Package }
|
99
99
|
|
100
|
-
variant :matrix, -> { Orb::Models::PlanCreateParams::Price::
|
100
|
+
variant :matrix, -> { Orb::Models::PlanCreateParams::Price::Matrix }
|
101
101
|
|
102
|
-
variant :tiered, -> { Orb::Models::PlanCreateParams::Price::
|
102
|
+
variant :tiered, -> { Orb::Models::PlanCreateParams::Price::Tiered }
|
103
103
|
|
104
|
-
variant :tiered_bps, -> { Orb::Models::PlanCreateParams::Price::
|
104
|
+
variant :tiered_bps, -> { Orb::Models::PlanCreateParams::Price::TieredBps }
|
105
105
|
|
106
|
-
variant :bps, -> { Orb::Models::PlanCreateParams::Price::
|
106
|
+
variant :bps, -> { Orb::Models::PlanCreateParams::Price::Bps }
|
107
107
|
|
108
|
-
variant :bulk_bps, -> { Orb::Models::PlanCreateParams::Price::
|
108
|
+
variant :bulk_bps, -> { Orb::Models::PlanCreateParams::Price::BulkBps }
|
109
109
|
|
110
|
-
variant :bulk, -> { Orb::Models::PlanCreateParams::Price::
|
110
|
+
variant :bulk, -> { Orb::Models::PlanCreateParams::Price::Bulk }
|
111
111
|
|
112
|
-
variant :threshold_total_amount,
|
113
|
-
-> { Orb::Models::PlanCreateParams::Price::NewPlanThresholdTotalAmountPrice }
|
112
|
+
variant :threshold_total_amount, -> { Orb::Models::PlanCreateParams::Price::ThresholdTotalAmount }
|
114
113
|
|
115
|
-
variant :tiered_package, -> { Orb::Models::PlanCreateParams::Price::
|
114
|
+
variant :tiered_package, -> { Orb::Models::PlanCreateParams::Price::TieredPackage }
|
116
115
|
|
117
|
-
variant :tiered_with_minimum, -> { Orb::Models::PlanCreateParams::Price::
|
116
|
+
variant :tiered_with_minimum, -> { Orb::Models::PlanCreateParams::Price::TieredWithMinimum }
|
118
117
|
|
119
|
-
variant :unit_with_percent, -> { Orb::Models::PlanCreateParams::Price::
|
118
|
+
variant :unit_with_percent, -> { Orb::Models::PlanCreateParams::Price::UnitWithPercent }
|
120
119
|
|
121
|
-
variant :package_with_allocation,
|
122
|
-
-> { Orb::Models::PlanCreateParams::Price::NewPlanPackageWithAllocationPrice }
|
120
|
+
variant :package_with_allocation, -> { Orb::Models::PlanCreateParams::Price::PackageWithAllocation }
|
123
121
|
|
124
|
-
variant :tiered_with_proration, -> { Orb::Models::PlanCreateParams::Price::
|
122
|
+
variant :tiered_with_proration, -> { Orb::Models::PlanCreateParams::Price::TieredWithProration }
|
125
123
|
|
126
|
-
variant :unit_with_proration, -> { Orb::Models::PlanCreateParams::Price::
|
124
|
+
variant :unit_with_proration, -> { Orb::Models::PlanCreateParams::Price::UnitWithProration }
|
127
125
|
|
128
|
-
variant :grouped_allocation, -> { Orb::Models::PlanCreateParams::Price::
|
126
|
+
variant :grouped_allocation, -> { Orb::Models::PlanCreateParams::Price::GroupedAllocation }
|
129
127
|
|
130
128
|
variant :grouped_with_prorated_minimum,
|
131
|
-
-> { Orb::Models::PlanCreateParams::Price::
|
129
|
+
-> { Orb::Models::PlanCreateParams::Price::GroupedWithProratedMinimum }
|
132
130
|
|
133
131
|
variant :grouped_with_metered_minimum,
|
134
|
-
-> { Orb::Models::PlanCreateParams::Price::
|
132
|
+
-> { Orb::Models::PlanCreateParams::Price::GroupedWithMeteredMinimum }
|
135
133
|
|
136
|
-
variant :matrix_with_display_name,
|
137
|
-
-> { Orb::Models::PlanCreateParams::Price::NewPlanMatrixWithDisplayNamePrice }
|
134
|
+
variant :matrix_with_display_name, -> { Orb::Models::PlanCreateParams::Price::MatrixWithDisplayName }
|
138
135
|
|
139
|
-
variant :bulk_with_proration, -> { Orb::Models::PlanCreateParams::Price::
|
136
|
+
variant :bulk_with_proration, -> { Orb::Models::PlanCreateParams::Price::BulkWithProration }
|
140
137
|
|
141
|
-
variant :grouped_tiered_package,
|
142
|
-
-> { Orb::Models::PlanCreateParams::Price::NewPlanGroupedTieredPackagePrice }
|
138
|
+
variant :grouped_tiered_package, -> { Orb::Models::PlanCreateParams::Price::GroupedTieredPackage }
|
143
139
|
|
144
|
-
variant :max_group_tiered_package,
|
145
|
-
-> { Orb::Models::PlanCreateParams::Price::NewPlanMaxGroupTieredPackagePrice }
|
140
|
+
variant :max_group_tiered_package, -> { Orb::Models::PlanCreateParams::Price::MaxGroupTieredPackage }
|
146
141
|
|
147
142
|
variant :scalable_matrix_with_unit_pricing,
|
148
|
-
-> { Orb::Models::PlanCreateParams::Price::
|
143
|
+
-> { Orb::Models::PlanCreateParams::Price::ScalableMatrixWithUnitPricing }
|
149
144
|
|
150
145
|
variant :scalable_matrix_with_tiered_pricing,
|
151
|
-
-> { Orb::Models::PlanCreateParams::Price::
|
146
|
+
-> { Orb::Models::PlanCreateParams::Price::ScalableMatrixWithTieredPricing }
|
152
147
|
|
153
|
-
variant :cumulative_grouped_bulk,
|
154
|
-
-> { Orb::Models::PlanCreateParams::Price::NewPlanCumulativeGroupedBulkPrice }
|
148
|
+
variant :cumulative_grouped_bulk, -> { Orb::Models::PlanCreateParams::Price::CumulativeGroupedBulk }
|
155
149
|
|
156
|
-
class
|
150
|
+
class Unit < Orb::Internal::Type::BaseModel
|
157
151
|
# @!attribute cadence
|
158
152
|
# The cadence to bill for this price on.
|
159
153
|
#
|
160
|
-
# @return [Symbol, Orb::Models::PlanCreateParams::Price::
|
161
|
-
required :cadence, enum: -> { Orb::Models::PlanCreateParams::Price::
|
154
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::Unit::Cadence]
|
155
|
+
required :cadence, enum: -> { Orb::Models::PlanCreateParams::Price::Unit::Cadence }
|
162
156
|
|
163
157
|
# @!attribute item_id
|
164
158
|
# The id of the item the price will be associated with.
|
@@ -179,8 +173,8 @@ module Orb
|
|
179
173
|
|
180
174
|
# @!attribute unit_config
|
181
175
|
#
|
182
|
-
# @return [Orb::Models::PlanCreateParams::Price::
|
183
|
-
required :unit_config, -> { Orb::Models::PlanCreateParams::Price::
|
176
|
+
# @return [Orb::Models::PlanCreateParams::Price::Unit::UnitConfig]
|
177
|
+
required :unit_config, -> { Orb::Models::PlanCreateParams::Price::Unit::UnitConfig }
|
184
178
|
|
185
179
|
# @!attribute billable_metric_id
|
186
180
|
# The id of the billable metric for the price. Only needed if the price is
|
@@ -200,9 +194,9 @@ module Orb
|
|
200
194
|
# For custom cadence: specifies the duration of the billing period in days or
|
201
195
|
# months.
|
202
196
|
#
|
203
|
-
# @return [Orb::Models::PlanCreateParams::Price::
|
197
|
+
# @return [Orb::Models::PlanCreateParams::Price::Unit::BillingCycleConfiguration, nil]
|
204
198
|
optional :billing_cycle_configuration,
|
205
|
-
-> { Orb::Models::PlanCreateParams::Price::
|
199
|
+
-> { Orb::Models::PlanCreateParams::Price::Unit::BillingCycleConfiguration },
|
206
200
|
nil?: true
|
207
201
|
|
208
202
|
# @!attribute conversion_rate
|
@@ -241,9 +235,9 @@ module Orb
|
|
241
235
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
242
236
|
# If unspecified, a single invoice is produced per billing cycle.
|
243
237
|
#
|
244
|
-
# @return [Orb::Models::PlanCreateParams::Price::
|
238
|
+
# @return [Orb::Models::PlanCreateParams::Price::Unit::InvoicingCycleConfiguration, nil]
|
245
239
|
optional :invoicing_cycle_configuration,
|
246
|
-
-> { Orb::Models::PlanCreateParams::Price::
|
240
|
+
-> { Orb::Models::PlanCreateParams::Price::Unit::InvoicingCycleConfiguration },
|
247
241
|
nil?: true
|
248
242
|
|
249
243
|
# @!attribute metadata
|
@@ -256,15 +250,15 @@ module Orb
|
|
256
250
|
|
257
251
|
# @!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
252
|
# Some parameter documentations has been truncated, see
|
259
|
-
# {Orb::Models::PlanCreateParams::Price::
|
253
|
+
# {Orb::Models::PlanCreateParams::Price::Unit} for more details.
|
260
254
|
#
|
261
|
-
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::
|
255
|
+
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::Unit::Cadence] The cadence to bill for this price on.
|
262
256
|
#
|
263
257
|
# @param item_id [String] The id of the item the price will be associated with.
|
264
258
|
#
|
265
259
|
# @param name [String] The name of the price.
|
266
260
|
#
|
267
|
-
# @param unit_config [Orb::Models::PlanCreateParams::Price::
|
261
|
+
# @param unit_config [Orb::Models::PlanCreateParams::Price::Unit::UnitConfig]
|
268
262
|
#
|
269
263
|
# @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b
|
270
264
|
# ...
|
@@ -272,7 +266,7 @@ module Orb
|
|
272
266
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
273
267
|
# ...
|
274
268
|
#
|
275
|
-
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::
|
269
|
+
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::Unit::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
276
270
|
# ...
|
277
271
|
#
|
278
272
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
@@ -287,7 +281,7 @@ module Orb
|
|
287
281
|
#
|
288
282
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
289
283
|
#
|
290
|
-
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::
|
284
|
+
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::Unit::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
291
285
|
# ...
|
292
286
|
#
|
293
287
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
@@ -297,7 +291,7 @@ module Orb
|
|
297
291
|
|
298
292
|
# The cadence to bill for this price on.
|
299
293
|
#
|
300
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
294
|
+
# @see Orb::Models::PlanCreateParams::Price::Unit#cadence
|
301
295
|
module Cadence
|
302
296
|
extend Orb::Internal::Type::Enum
|
303
297
|
|
@@ -312,7 +306,7 @@ module Orb
|
|
312
306
|
# @return [Array<Symbol>]
|
313
307
|
end
|
314
308
|
|
315
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
309
|
+
# @see Orb::Models::PlanCreateParams::Price::Unit#unit_config
|
316
310
|
class UnitConfig < Orb::Internal::Type::BaseModel
|
317
311
|
# @!attribute unit_amount
|
318
312
|
# Rate per unit of usage
|
@@ -324,7 +318,7 @@ module Orb
|
|
324
318
|
# @param unit_amount [String] Rate per unit of usage
|
325
319
|
end
|
326
320
|
|
327
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
321
|
+
# @see Orb::Models::PlanCreateParams::Price::Unit#billing_cycle_configuration
|
328
322
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
329
323
|
# @!attribute duration
|
330
324
|
# The duration of the billing period.
|
@@ -335,9 +329,9 @@ module Orb
|
|
335
329
|
# @!attribute duration_unit
|
336
330
|
# The unit of billing period duration.
|
337
331
|
#
|
338
|
-
# @return [Symbol, Orb::Models::PlanCreateParams::Price::
|
332
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::Unit::BillingCycleConfiguration::DurationUnit]
|
339
333
|
required :duration_unit,
|
340
|
-
enum: -> { Orb::Models::PlanCreateParams::Price::
|
334
|
+
enum: -> { Orb::Models::PlanCreateParams::Price::Unit::BillingCycleConfiguration::DurationUnit }
|
341
335
|
|
342
336
|
# @!method initialize(duration:, duration_unit:)
|
343
337
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -345,11 +339,11 @@ module Orb
|
|
345
339
|
#
|
346
340
|
# @param duration [Integer] The duration of the billing period.
|
347
341
|
#
|
348
|
-
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::
|
342
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::Unit::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
349
343
|
|
350
344
|
# The unit of billing period duration.
|
351
345
|
#
|
352
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
346
|
+
# @see Orb::Models::PlanCreateParams::Price::Unit::BillingCycleConfiguration#duration_unit
|
353
347
|
module DurationUnit
|
354
348
|
extend Orb::Internal::Type::Enum
|
355
349
|
|
@@ -361,7 +355,7 @@ module Orb
|
|
361
355
|
end
|
362
356
|
end
|
363
357
|
|
364
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
358
|
+
# @see Orb::Models::PlanCreateParams::Price::Unit#invoicing_cycle_configuration
|
365
359
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
366
360
|
# @!attribute duration
|
367
361
|
# The duration of the billing period.
|
@@ -372,9 +366,9 @@ module Orb
|
|
372
366
|
# @!attribute duration_unit
|
373
367
|
# The unit of billing period duration.
|
374
368
|
#
|
375
|
-
# @return [Symbol, Orb::Models::PlanCreateParams::Price::
|
369
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::Unit::InvoicingCycleConfiguration::DurationUnit]
|
376
370
|
required :duration_unit,
|
377
|
-
enum: -> { Orb::Models::PlanCreateParams::Price::
|
371
|
+
enum: -> { Orb::Models::PlanCreateParams::Price::Unit::InvoicingCycleConfiguration::DurationUnit }
|
378
372
|
|
379
373
|
# @!method initialize(duration:, duration_unit:)
|
380
374
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
@@ -382,11 +376,11 @@ module Orb
|
|
382
376
|
#
|
383
377
|
# @param duration [Integer] The duration of the billing period.
|
384
378
|
#
|
385
|
-
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::
|
379
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::Unit::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
386
380
|
|
387
381
|
# The unit of billing period duration.
|
388
382
|
#
|
389
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
383
|
+
# @see Orb::Models::PlanCreateParams::Price::Unit::InvoicingCycleConfiguration#duration_unit
|
390
384
|
module DurationUnit
|
391
385
|
extend Orb::Internal::Type::Enum
|
392
386
|
|
@@ -399,12 +393,12 @@ module Orb
|
|
399
393
|
end
|
400
394
|
end
|
401
395
|
|
402
|
-
class
|
396
|
+
class Package < Orb::Internal::Type::BaseModel
|
403
397
|
# @!attribute cadence
|
404
398
|
# The cadence to bill for this price on.
|
405
399
|
#
|
406
|
-
# @return [Symbol, Orb::Models::PlanCreateParams::Price::
|
407
|
-
required :cadence, enum: -> { Orb::Models::PlanCreateParams::Price::
|
400
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::Package::Cadence]
|
401
|
+
required :cadence, enum: -> { Orb::Models::PlanCreateParams::Price::Package::Cadence }
|
408
402
|
|
409
403
|
# @!attribute item_id
|
410
404
|
# The id of the item the price will be associated with.
|
@@ -425,8 +419,8 @@ module Orb
|
|
425
419
|
|
426
420
|
# @!attribute package_config
|
427
421
|
#
|
428
|
-
# @return [Orb::Models::PlanCreateParams::Price::
|
429
|
-
required :package_config, -> { Orb::Models::PlanCreateParams::Price::
|
422
|
+
# @return [Orb::Models::PlanCreateParams::Price::Package::PackageConfig]
|
423
|
+
required :package_config, -> { Orb::Models::PlanCreateParams::Price::Package::PackageConfig }
|
430
424
|
|
431
425
|
# @!attribute billable_metric_id
|
432
426
|
# The id of the billable metric for the price. Only needed if the price is
|
@@ -446,9 +440,9 @@ module Orb
|
|
446
440
|
# For custom cadence: specifies the duration of the billing period in days or
|
447
441
|
# months.
|
448
442
|
#
|
449
|
-
# @return [Orb::Models::PlanCreateParams::Price::
|
443
|
+
# @return [Orb::Models::PlanCreateParams::Price::Package::BillingCycleConfiguration, nil]
|
450
444
|
optional :billing_cycle_configuration,
|
451
|
-
-> { Orb::Models::PlanCreateParams::Price::
|
445
|
+
-> { Orb::Models::PlanCreateParams::Price::Package::BillingCycleConfiguration },
|
452
446
|
nil?: true
|
453
447
|
|
454
448
|
# @!attribute conversion_rate
|
@@ -487,9 +481,9 @@ module Orb
|
|
487
481
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
488
482
|
# If unspecified, a single invoice is produced per billing cycle.
|
489
483
|
#
|
490
|
-
# @return [Orb::Models::PlanCreateParams::Price::
|
484
|
+
# @return [Orb::Models::PlanCreateParams::Price::Package::InvoicingCycleConfiguration, nil]
|
491
485
|
optional :invoicing_cycle_configuration,
|
492
|
-
-> { Orb::Models::PlanCreateParams::Price::
|
486
|
+
-> { Orb::Models::PlanCreateParams::Price::Package::InvoicingCycleConfiguration },
|
493
487
|
nil?: true
|
494
488
|
|
495
489
|
# @!attribute metadata
|
@@ -502,15 +496,15 @@ module Orb
|
|
502
496
|
|
503
497
|
# @!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
498
|
# Some parameter documentations has been truncated, see
|
505
|
-
# {Orb::Models::PlanCreateParams::Price::
|
499
|
+
# {Orb::Models::PlanCreateParams::Price::Package} for more details.
|
506
500
|
#
|
507
|
-
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::
|
501
|
+
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::Package::Cadence] The cadence to bill for this price on.
|
508
502
|
#
|
509
503
|
# @param item_id [String] The id of the item the price will be associated with.
|
510
504
|
#
|
511
505
|
# @param name [String] The name of the price.
|
512
506
|
#
|
513
|
-
# @param package_config [Orb::Models::PlanCreateParams::Price::
|
507
|
+
# @param package_config [Orb::Models::PlanCreateParams::Price::Package::PackageConfig]
|
514
508
|
#
|
515
509
|
# @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b
|
516
510
|
# ...
|
@@ -518,7 +512,7 @@ module Orb
|
|
518
512
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
519
513
|
# ...
|
520
514
|
#
|
521
|
-
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::
|
515
|
+
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::Package::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
522
516
|
# ...
|
523
517
|
#
|
524
518
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
@@ -533,7 +527,7 @@ module Orb
|
|
533
527
|
#
|
534
528
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
535
529
|
#
|
536
|
-
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::
|
530
|
+
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::Package::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
537
531
|
# ...
|
538
532
|
#
|
539
533
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
@@ -543,7 +537,7 @@ module Orb
|
|
543
537
|
|
544
538
|
# The cadence to bill for this price on.
|
545
539
|
#
|
546
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
540
|
+
# @see Orb::Models::PlanCreateParams::Price::Package#cadence
|
547
541
|
module Cadence
|
548
542
|
extend Orb::Internal::Type::Enum
|
549
543
|
|
@@ -558,7 +552,7 @@ module Orb
|
|
558
552
|
# @return [Array<Symbol>]
|
559
553
|
end
|
560
554
|
|
561
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
555
|
+
# @see Orb::Models::PlanCreateParams::Price::Package#package_config
|
562
556
|
class PackageConfig < Orb::Internal::Type::BaseModel
|
563
557
|
# @!attribute package_amount
|
564
558
|
# A currency amount to rate usage by
|
@@ -575,8 +569,7 @@ module Orb
|
|
575
569
|
|
576
570
|
# @!method initialize(package_amount:, package_size:)
|
577
571
|
# Some parameter documentations has been truncated, see
|
578
|
-
# {Orb::Models::PlanCreateParams::Price::
|
579
|
-
# more details.
|
572
|
+
# {Orb::Models::PlanCreateParams::Price::Package::PackageConfig} for more details.
|
580
573
|
#
|
581
574
|
# @param package_amount [String] A currency amount to rate usage by
|
582
575
|
#
|
@@ -584,7 +577,7 @@ module Orb
|
|
584
577
|
# ...
|
585
578
|
end
|
586
579
|
|
587
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
580
|
+
# @see Orb::Models::PlanCreateParams::Price::Package#billing_cycle_configuration
|
588
581
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
589
582
|
# @!attribute duration
|
590
583
|
# The duration of the billing period.
|
@@ -595,9 +588,9 @@ module Orb
|
|
595
588
|
# @!attribute duration_unit
|
596
589
|
# The unit of billing period duration.
|
597
590
|
#
|
598
|
-
# @return [Symbol, Orb::Models::PlanCreateParams::Price::
|
591
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::Package::BillingCycleConfiguration::DurationUnit]
|
599
592
|
required :duration_unit,
|
600
|
-
enum: -> { Orb::Models::PlanCreateParams::Price::
|
593
|
+
enum: -> { Orb::Models::PlanCreateParams::Price::Package::BillingCycleConfiguration::DurationUnit }
|
601
594
|
|
602
595
|
# @!method initialize(duration:, duration_unit:)
|
603
596
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -605,11 +598,11 @@ module Orb
|
|
605
598
|
#
|
606
599
|
# @param duration [Integer] The duration of the billing period.
|
607
600
|
#
|
608
|
-
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::
|
601
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::Package::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
609
602
|
|
610
603
|
# The unit of billing period duration.
|
611
604
|
#
|
612
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
605
|
+
# @see Orb::Models::PlanCreateParams::Price::Package::BillingCycleConfiguration#duration_unit
|
613
606
|
module DurationUnit
|
614
607
|
extend Orb::Internal::Type::Enum
|
615
608
|
|
@@ -621,7 +614,7 @@ module Orb
|
|
621
614
|
end
|
622
615
|
end
|
623
616
|
|
624
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
617
|
+
# @see Orb::Models::PlanCreateParams::Price::Package#invoicing_cycle_configuration
|
625
618
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
626
619
|
# @!attribute duration
|
627
620
|
# The duration of the billing period.
|
@@ -632,9 +625,9 @@ module Orb
|
|
632
625
|
# @!attribute duration_unit
|
633
626
|
# The unit of billing period duration.
|
634
627
|
#
|
635
|
-
# @return [Symbol, Orb::Models::PlanCreateParams::Price::
|
628
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::Package::InvoicingCycleConfiguration::DurationUnit]
|
636
629
|
required :duration_unit,
|
637
|
-
enum: -> { Orb::Models::PlanCreateParams::Price::
|
630
|
+
enum: -> { Orb::Models::PlanCreateParams::Price::Package::InvoicingCycleConfiguration::DurationUnit }
|
638
631
|
|
639
632
|
# @!method initialize(duration:, duration_unit:)
|
640
633
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
@@ -642,11 +635,11 @@ module Orb
|
|
642
635
|
#
|
643
636
|
# @param duration [Integer] The duration of the billing period.
|
644
637
|
#
|
645
|
-
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::
|
638
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::Package::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
646
639
|
|
647
640
|
# The unit of billing period duration.
|
648
641
|
#
|
649
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
642
|
+
# @see Orb::Models::PlanCreateParams::Price::Package::InvoicingCycleConfiguration#duration_unit
|
650
643
|
module DurationUnit
|
651
644
|
extend Orb::Internal::Type::Enum
|
652
645
|
|
@@ -659,12 +652,12 @@ module Orb
|
|
659
652
|
end
|
660
653
|
end
|
661
654
|
|
662
|
-
class
|
655
|
+
class Matrix < Orb::Internal::Type::BaseModel
|
663
656
|
# @!attribute cadence
|
664
657
|
# The cadence to bill for this price on.
|
665
658
|
#
|
666
|
-
# @return [Symbol, Orb::Models::PlanCreateParams::Price::
|
667
|
-
required :cadence, enum: -> { Orb::Models::PlanCreateParams::Price::
|
659
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::Matrix::Cadence]
|
660
|
+
required :cadence, enum: -> { Orb::Models::PlanCreateParams::Price::Matrix::Cadence }
|
668
661
|
|
669
662
|
# @!attribute item_id
|
670
663
|
# The id of the item the price will be associated with.
|
@@ -674,8 +667,8 @@ module Orb
|
|
674
667
|
|
675
668
|
# @!attribute matrix_config
|
676
669
|
#
|
677
|
-
# @return [Orb::Models::PlanCreateParams::Price::
|
678
|
-
required :matrix_config, -> { Orb::Models::PlanCreateParams::Price::
|
670
|
+
# @return [Orb::Models::PlanCreateParams::Price::Matrix::MatrixConfig]
|
671
|
+
required :matrix_config, -> { Orb::Models::PlanCreateParams::Price::Matrix::MatrixConfig }
|
679
672
|
|
680
673
|
# @!attribute model_type
|
681
674
|
#
|
@@ -706,9 +699,9 @@ module Orb
|
|
706
699
|
# For custom cadence: specifies the duration of the billing period in days or
|
707
700
|
# months.
|
708
701
|
#
|
709
|
-
# @return [Orb::Models::PlanCreateParams::Price::
|
702
|
+
# @return [Orb::Models::PlanCreateParams::Price::Matrix::BillingCycleConfiguration, nil]
|
710
703
|
optional :billing_cycle_configuration,
|
711
|
-
-> { Orb::Models::PlanCreateParams::Price::
|
704
|
+
-> { Orb::Models::PlanCreateParams::Price::Matrix::BillingCycleConfiguration },
|
712
705
|
nil?: true
|
713
706
|
|
714
707
|
# @!attribute conversion_rate
|
@@ -747,9 +740,9 @@ module Orb
|
|
747
740
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
748
741
|
# If unspecified, a single invoice is produced per billing cycle.
|
749
742
|
#
|
750
|
-
# @return [Orb::Models::PlanCreateParams::Price::
|
743
|
+
# @return [Orb::Models::PlanCreateParams::Price::Matrix::InvoicingCycleConfiguration, nil]
|
751
744
|
optional :invoicing_cycle_configuration,
|
752
|
-
-> { Orb::Models::PlanCreateParams::Price::
|
745
|
+
-> { Orb::Models::PlanCreateParams::Price::Matrix::InvoicingCycleConfiguration },
|
753
746
|
nil?: true
|
754
747
|
|
755
748
|
# @!attribute metadata
|
@@ -762,13 +755,13 @@ module Orb
|
|
762
755
|
|
763
756
|
# @!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
757
|
# Some parameter documentations has been truncated, see
|
765
|
-
# {Orb::Models::PlanCreateParams::Price::
|
758
|
+
# {Orb::Models::PlanCreateParams::Price::Matrix} for more details.
|
766
759
|
#
|
767
|
-
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::
|
760
|
+
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::Matrix::Cadence] The cadence to bill for this price on.
|
768
761
|
#
|
769
762
|
# @param item_id [String] The id of the item the price will be associated with.
|
770
763
|
#
|
771
|
-
# @param matrix_config [Orb::Models::PlanCreateParams::Price::
|
764
|
+
# @param matrix_config [Orb::Models::PlanCreateParams::Price::Matrix::MatrixConfig]
|
772
765
|
#
|
773
766
|
# @param name [String] The name of the price.
|
774
767
|
#
|
@@ -778,7 +771,7 @@ module Orb
|
|
778
771
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
779
772
|
# ...
|
780
773
|
#
|
781
|
-
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::
|
774
|
+
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::Matrix::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
782
775
|
# ...
|
783
776
|
#
|
784
777
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
@@ -793,7 +786,7 @@ module Orb
|
|
793
786
|
#
|
794
787
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
795
788
|
#
|
796
|
-
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::
|
789
|
+
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::Matrix::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
797
790
|
# ...
|
798
791
|
#
|
799
792
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
@@ -803,7 +796,7 @@ module Orb
|
|
803
796
|
|
804
797
|
# The cadence to bill for this price on.
|
805
798
|
#
|
806
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
799
|
+
# @see Orb::Models::PlanCreateParams::Price::Matrix#cadence
|
807
800
|
module Cadence
|
808
801
|
extend Orb::Internal::Type::Enum
|
809
802
|
|
@@ -818,7 +811,7 @@ module Orb
|
|
818
811
|
# @return [Array<Symbol>]
|
819
812
|
end
|
820
813
|
|
821
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
814
|
+
# @see Orb::Models::PlanCreateParams::Price::Matrix#matrix_config
|
822
815
|
class MatrixConfig < Orb::Internal::Type::BaseModel
|
823
816
|
# @!attribute default_unit_amount
|
824
817
|
# Default per unit rate for any usage not bucketed into a specified matrix_value
|
@@ -835,16 +828,16 @@ module Orb
|
|
835
828
|
# @!attribute matrix_values
|
836
829
|
# Matrix values for specified matrix grouping keys
|
837
830
|
#
|
838
|
-
# @return [Array<Orb::Models::PlanCreateParams::Price::
|
831
|
+
# @return [Array<Orb::Models::PlanCreateParams::Price::Matrix::MatrixConfig::MatrixValue>]
|
839
832
|
required :matrix_values,
|
840
|
-
-> { Orb::Internal::Type::ArrayOf[Orb::Models::PlanCreateParams::Price::
|
833
|
+
-> { Orb::Internal::Type::ArrayOf[Orb::Models::PlanCreateParams::Price::Matrix::MatrixConfig::MatrixValue] }
|
841
834
|
|
842
835
|
# @!method initialize(default_unit_amount:, dimensions:, matrix_values:)
|
843
836
|
# @param default_unit_amount [String] Default per unit rate for any usage not bucketed into a specified matrix_value
|
844
837
|
#
|
845
838
|
# @param dimensions [Array<String, nil>] One or two event property values to evaluate matrix groups by
|
846
839
|
#
|
847
|
-
# @param matrix_values [Array<Orb::Models::PlanCreateParams::Price::
|
840
|
+
# @param matrix_values [Array<Orb::Models::PlanCreateParams::Price::Matrix::MatrixConfig::MatrixValue>] Matrix values for specified matrix grouping keys
|
848
841
|
|
849
842
|
class MatrixValue < Orb::Internal::Type::BaseModel
|
850
843
|
# @!attribute dimension_values
|
@@ -863,8 +856,8 @@ module Orb
|
|
863
856
|
|
864
857
|
# @!method initialize(dimension_values:, unit_amount:)
|
865
858
|
# Some parameter documentations has been truncated, see
|
866
|
-
# {Orb::Models::PlanCreateParams::Price::
|
867
|
-
#
|
859
|
+
# {Orb::Models::PlanCreateParams::Price::Matrix::MatrixConfig::MatrixValue} for
|
860
|
+
# more details.
|
868
861
|
#
|
869
862
|
# @param dimension_values [Array<String, nil>] One or two matrix keys to filter usage to this Matrix value by. For example, ["r
|
870
863
|
# ...
|
@@ -873,7 +866,7 @@ module Orb
|
|
873
866
|
end
|
874
867
|
end
|
875
868
|
|
876
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
869
|
+
# @see Orb::Models::PlanCreateParams::Price::Matrix#billing_cycle_configuration
|
877
870
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
878
871
|
# @!attribute duration
|
879
872
|
# The duration of the billing period.
|
@@ -884,9 +877,9 @@ module Orb
|
|
884
877
|
# @!attribute duration_unit
|
885
878
|
# The unit of billing period duration.
|
886
879
|
#
|
887
|
-
# @return [Symbol, Orb::Models::PlanCreateParams::Price::
|
880
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::Matrix::BillingCycleConfiguration::DurationUnit]
|
888
881
|
required :duration_unit,
|
889
|
-
enum: -> { Orb::Models::PlanCreateParams::Price::
|
882
|
+
enum: -> { Orb::Models::PlanCreateParams::Price::Matrix::BillingCycleConfiguration::DurationUnit }
|
890
883
|
|
891
884
|
# @!method initialize(duration:, duration_unit:)
|
892
885
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -894,11 +887,11 @@ module Orb
|
|
894
887
|
#
|
895
888
|
# @param duration [Integer] The duration of the billing period.
|
896
889
|
#
|
897
|
-
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::
|
890
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::Matrix::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
898
891
|
|
899
892
|
# The unit of billing period duration.
|
900
893
|
#
|
901
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
894
|
+
# @see Orb::Models::PlanCreateParams::Price::Matrix::BillingCycleConfiguration#duration_unit
|
902
895
|
module DurationUnit
|
903
896
|
extend Orb::Internal::Type::Enum
|
904
897
|
|
@@ -910,7 +903,7 @@ module Orb
|
|
910
903
|
end
|
911
904
|
end
|
912
905
|
|
913
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
906
|
+
# @see Orb::Models::PlanCreateParams::Price::Matrix#invoicing_cycle_configuration
|
914
907
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
915
908
|
# @!attribute duration
|
916
909
|
# The duration of the billing period.
|
@@ -921,9 +914,9 @@ module Orb
|
|
921
914
|
# @!attribute duration_unit
|
922
915
|
# The unit of billing period duration.
|
923
916
|
#
|
924
|
-
# @return [Symbol, Orb::Models::PlanCreateParams::Price::
|
917
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::Matrix::InvoicingCycleConfiguration::DurationUnit]
|
925
918
|
required :duration_unit,
|
926
|
-
enum: -> { Orb::Models::PlanCreateParams::Price::
|
919
|
+
enum: -> { Orb::Models::PlanCreateParams::Price::Matrix::InvoicingCycleConfiguration::DurationUnit }
|
927
920
|
|
928
921
|
# @!method initialize(duration:, duration_unit:)
|
929
922
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
@@ -931,11 +924,11 @@ module Orb
|
|
931
924
|
#
|
932
925
|
# @param duration [Integer] The duration of the billing period.
|
933
926
|
#
|
934
|
-
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::
|
927
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::Matrix::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
935
928
|
|
936
929
|
# The unit of billing period duration.
|
937
930
|
#
|
938
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
931
|
+
# @see Orb::Models::PlanCreateParams::Price::Matrix::InvoicingCycleConfiguration#duration_unit
|
939
932
|
module DurationUnit
|
940
933
|
extend Orb::Internal::Type::Enum
|
941
934
|
|
@@ -948,12 +941,12 @@ module Orb
|
|
948
941
|
end
|
949
942
|
end
|
950
943
|
|
951
|
-
class
|
944
|
+
class Tiered < Orb::Internal::Type::BaseModel
|
952
945
|
# @!attribute cadence
|
953
946
|
# The cadence to bill for this price on.
|
954
947
|
#
|
955
|
-
# @return [Symbol, Orb::Models::PlanCreateParams::Price::
|
956
|
-
required :cadence, enum: -> { Orb::Models::PlanCreateParams::Price::
|
948
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::Tiered::Cadence]
|
949
|
+
required :cadence, enum: -> { Orb::Models::PlanCreateParams::Price::Tiered::Cadence }
|
957
950
|
|
958
951
|
# @!attribute item_id
|
959
952
|
# The id of the item the price will be associated with.
|
@@ -974,8 +967,8 @@ module Orb
|
|
974
967
|
|
975
968
|
# @!attribute tiered_config
|
976
969
|
#
|
977
|
-
# @return [Orb::Models::PlanCreateParams::Price::
|
978
|
-
required :tiered_config, -> { Orb::Models::PlanCreateParams::Price::
|
970
|
+
# @return [Orb::Models::PlanCreateParams::Price::Tiered::TieredConfig]
|
971
|
+
required :tiered_config, -> { Orb::Models::PlanCreateParams::Price::Tiered::TieredConfig }
|
979
972
|
|
980
973
|
# @!attribute billable_metric_id
|
981
974
|
# The id of the billable metric for the price. Only needed if the price is
|
@@ -995,9 +988,9 @@ module Orb
|
|
995
988
|
# For custom cadence: specifies the duration of the billing period in days or
|
996
989
|
# months.
|
997
990
|
#
|
998
|
-
# @return [Orb::Models::PlanCreateParams::Price::
|
991
|
+
# @return [Orb::Models::PlanCreateParams::Price::Tiered::BillingCycleConfiguration, nil]
|
999
992
|
optional :billing_cycle_configuration,
|
1000
|
-
-> { Orb::Models::PlanCreateParams::Price::
|
993
|
+
-> { Orb::Models::PlanCreateParams::Price::Tiered::BillingCycleConfiguration },
|
1001
994
|
nil?: true
|
1002
995
|
|
1003
996
|
# @!attribute conversion_rate
|
@@ -1036,9 +1029,9 @@ module Orb
|
|
1036
1029
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
1037
1030
|
# If unspecified, a single invoice is produced per billing cycle.
|
1038
1031
|
#
|
1039
|
-
# @return [Orb::Models::PlanCreateParams::Price::
|
1032
|
+
# @return [Orb::Models::PlanCreateParams::Price::Tiered::InvoicingCycleConfiguration, nil]
|
1040
1033
|
optional :invoicing_cycle_configuration,
|
1041
|
-
-> { Orb::Models::PlanCreateParams::Price::
|
1034
|
+
-> { Orb::Models::PlanCreateParams::Price::Tiered::InvoicingCycleConfiguration },
|
1042
1035
|
nil?: true
|
1043
1036
|
|
1044
1037
|
# @!attribute metadata
|
@@ -1051,15 +1044,15 @@ module Orb
|
|
1051
1044
|
|
1052
1045
|
# @!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
1046
|
# Some parameter documentations has been truncated, see
|
1054
|
-
# {Orb::Models::PlanCreateParams::Price::
|
1047
|
+
# {Orb::Models::PlanCreateParams::Price::Tiered} for more details.
|
1055
1048
|
#
|
1056
|
-
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::
|
1049
|
+
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::Tiered::Cadence] The cadence to bill for this price on.
|
1057
1050
|
#
|
1058
1051
|
# @param item_id [String] The id of the item the price will be associated with.
|
1059
1052
|
#
|
1060
1053
|
# @param name [String] The name of the price.
|
1061
1054
|
#
|
1062
|
-
# @param tiered_config [Orb::Models::PlanCreateParams::Price::
|
1055
|
+
# @param tiered_config [Orb::Models::PlanCreateParams::Price::Tiered::TieredConfig]
|
1063
1056
|
#
|
1064
1057
|
# @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b
|
1065
1058
|
# ...
|
@@ -1067,7 +1060,7 @@ module Orb
|
|
1067
1060
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
1068
1061
|
# ...
|
1069
1062
|
#
|
1070
|
-
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::
|
1063
|
+
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::Tiered::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
1071
1064
|
# ...
|
1072
1065
|
#
|
1073
1066
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
@@ -1082,7 +1075,7 @@ module Orb
|
|
1082
1075
|
#
|
1083
1076
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
1084
1077
|
#
|
1085
|
-
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::
|
1078
|
+
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::Tiered::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
1086
1079
|
# ...
|
1087
1080
|
#
|
1088
1081
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
@@ -1092,7 +1085,7 @@ module Orb
|
|
1092
1085
|
|
1093
1086
|
# The cadence to bill for this price on.
|
1094
1087
|
#
|
1095
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
1088
|
+
# @see Orb::Models::PlanCreateParams::Price::Tiered#cadence
|
1096
1089
|
module Cadence
|
1097
1090
|
extend Orb::Internal::Type::Enum
|
1098
1091
|
|
@@ -1107,17 +1100,17 @@ module Orb
|
|
1107
1100
|
# @return [Array<Symbol>]
|
1108
1101
|
end
|
1109
1102
|
|
1110
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
1103
|
+
# @see Orb::Models::PlanCreateParams::Price::Tiered#tiered_config
|
1111
1104
|
class TieredConfig < Orb::Internal::Type::BaseModel
|
1112
1105
|
# @!attribute tiers
|
1113
1106
|
# Tiers for rating based on total usage quantities into the specified tier
|
1114
1107
|
#
|
1115
|
-
# @return [Array<Orb::Models::PlanCreateParams::Price::
|
1108
|
+
# @return [Array<Orb::Models::PlanCreateParams::Price::Tiered::TieredConfig::Tier>]
|
1116
1109
|
required :tiers,
|
1117
|
-
-> { Orb::Internal::Type::ArrayOf[Orb::Models::PlanCreateParams::Price::
|
1110
|
+
-> { Orb::Internal::Type::ArrayOf[Orb::Models::PlanCreateParams::Price::Tiered::TieredConfig::Tier] }
|
1118
1111
|
|
1119
1112
|
# @!method initialize(tiers:)
|
1120
|
-
# @param tiers [Array<Orb::Models::PlanCreateParams::Price::
|
1113
|
+
# @param tiers [Array<Orb::Models::PlanCreateParams::Price::Tiered::TieredConfig::Tier>] Tiers for rating based on total usage quantities into the specified tier
|
1121
1114
|
|
1122
1115
|
class Tier < Orb::Internal::Type::BaseModel
|
1123
1116
|
# @!attribute first_unit
|
@@ -1147,7 +1140,7 @@ module Orb
|
|
1147
1140
|
end
|
1148
1141
|
end
|
1149
1142
|
|
1150
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
1143
|
+
# @see Orb::Models::PlanCreateParams::Price::Tiered#billing_cycle_configuration
|
1151
1144
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
1152
1145
|
# @!attribute duration
|
1153
1146
|
# The duration of the billing period.
|
@@ -1158,9 +1151,9 @@ module Orb
|
|
1158
1151
|
# @!attribute duration_unit
|
1159
1152
|
# The unit of billing period duration.
|
1160
1153
|
#
|
1161
|
-
# @return [Symbol, Orb::Models::PlanCreateParams::Price::
|
1154
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::Tiered::BillingCycleConfiguration::DurationUnit]
|
1162
1155
|
required :duration_unit,
|
1163
|
-
enum: -> { Orb::Models::PlanCreateParams::Price::
|
1156
|
+
enum: -> { Orb::Models::PlanCreateParams::Price::Tiered::BillingCycleConfiguration::DurationUnit }
|
1164
1157
|
|
1165
1158
|
# @!method initialize(duration:, duration_unit:)
|
1166
1159
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -1168,11 +1161,11 @@ module Orb
|
|
1168
1161
|
#
|
1169
1162
|
# @param duration [Integer] The duration of the billing period.
|
1170
1163
|
#
|
1171
|
-
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::
|
1164
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::Tiered::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
1172
1165
|
|
1173
1166
|
# The unit of billing period duration.
|
1174
1167
|
#
|
1175
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
1168
|
+
# @see Orb::Models::PlanCreateParams::Price::Tiered::BillingCycleConfiguration#duration_unit
|
1176
1169
|
module DurationUnit
|
1177
1170
|
extend Orb::Internal::Type::Enum
|
1178
1171
|
|
@@ -1184,7 +1177,7 @@ module Orb
|
|
1184
1177
|
end
|
1185
1178
|
end
|
1186
1179
|
|
1187
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
1180
|
+
# @see Orb::Models::PlanCreateParams::Price::Tiered#invoicing_cycle_configuration
|
1188
1181
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
1189
1182
|
# @!attribute duration
|
1190
1183
|
# The duration of the billing period.
|
@@ -1195,9 +1188,9 @@ module Orb
|
|
1195
1188
|
# @!attribute duration_unit
|
1196
1189
|
# The unit of billing period duration.
|
1197
1190
|
#
|
1198
|
-
# @return [Symbol, Orb::Models::PlanCreateParams::Price::
|
1191
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::Tiered::InvoicingCycleConfiguration::DurationUnit]
|
1199
1192
|
required :duration_unit,
|
1200
|
-
enum: -> { Orb::Models::PlanCreateParams::Price::
|
1193
|
+
enum: -> { Orb::Models::PlanCreateParams::Price::Tiered::InvoicingCycleConfiguration::DurationUnit }
|
1201
1194
|
|
1202
1195
|
# @!method initialize(duration:, duration_unit:)
|
1203
1196
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
@@ -1205,11 +1198,11 @@ module Orb
|
|
1205
1198
|
#
|
1206
1199
|
# @param duration [Integer] The duration of the billing period.
|
1207
1200
|
#
|
1208
|
-
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::
|
1201
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::Tiered::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
1209
1202
|
|
1210
1203
|
# The unit of billing period duration.
|
1211
1204
|
#
|
1212
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
1205
|
+
# @see Orb::Models::PlanCreateParams::Price::Tiered::InvoicingCycleConfiguration#duration_unit
|
1213
1206
|
module DurationUnit
|
1214
1207
|
extend Orb::Internal::Type::Enum
|
1215
1208
|
|
@@ -1222,12 +1215,12 @@ module Orb
|
|
1222
1215
|
end
|
1223
1216
|
end
|
1224
1217
|
|
1225
|
-
class
|
1218
|
+
class TieredBps < Orb::Internal::Type::BaseModel
|
1226
1219
|
# @!attribute cadence
|
1227
1220
|
# The cadence to bill for this price on.
|
1228
1221
|
#
|
1229
|
-
# @return [Symbol, Orb::Models::PlanCreateParams::Price::
|
1230
|
-
required :cadence, enum: -> { Orb::Models::PlanCreateParams::Price::
|
1222
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::TieredBps::Cadence]
|
1223
|
+
required :cadence, enum: -> { Orb::Models::PlanCreateParams::Price::TieredBps::Cadence }
|
1231
1224
|
|
1232
1225
|
# @!attribute item_id
|
1233
1226
|
# The id of the item the price will be associated with.
|
@@ -1248,9 +1241,8 @@ module Orb
|
|
1248
1241
|
|
1249
1242
|
# @!attribute tiered_bps_config
|
1250
1243
|
#
|
1251
|
-
# @return [Orb::Models::PlanCreateParams::Price::
|
1252
|
-
required :tiered_bps_config,
|
1253
|
-
-> { Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice::TieredBpsConfig }
|
1244
|
+
# @return [Orb::Models::PlanCreateParams::Price::TieredBps::TieredBpsConfig]
|
1245
|
+
required :tiered_bps_config, -> { Orb::Models::PlanCreateParams::Price::TieredBps::TieredBpsConfig }
|
1254
1246
|
|
1255
1247
|
# @!attribute billable_metric_id
|
1256
1248
|
# The id of the billable metric for the price. Only needed if the price is
|
@@ -1270,9 +1262,9 @@ module Orb
|
|
1270
1262
|
# For custom cadence: specifies the duration of the billing period in days or
|
1271
1263
|
# months.
|
1272
1264
|
#
|
1273
|
-
# @return [Orb::Models::PlanCreateParams::Price::
|
1265
|
+
# @return [Orb::Models::PlanCreateParams::Price::TieredBps::BillingCycleConfiguration, nil]
|
1274
1266
|
optional :billing_cycle_configuration,
|
1275
|
-
-> { Orb::Models::PlanCreateParams::Price::
|
1267
|
+
-> { Orb::Models::PlanCreateParams::Price::TieredBps::BillingCycleConfiguration },
|
1276
1268
|
nil?: true
|
1277
1269
|
|
1278
1270
|
# @!attribute conversion_rate
|
@@ -1311,9 +1303,9 @@ module Orb
|
|
1311
1303
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
1312
1304
|
# If unspecified, a single invoice is produced per billing cycle.
|
1313
1305
|
#
|
1314
|
-
# @return [Orb::Models::PlanCreateParams::Price::
|
1306
|
+
# @return [Orb::Models::PlanCreateParams::Price::TieredBps::InvoicingCycleConfiguration, nil]
|
1315
1307
|
optional :invoicing_cycle_configuration,
|
1316
|
-
-> { Orb::Models::PlanCreateParams::Price::
|
1308
|
+
-> { Orb::Models::PlanCreateParams::Price::TieredBps::InvoicingCycleConfiguration },
|
1317
1309
|
nil?: true
|
1318
1310
|
|
1319
1311
|
# @!attribute metadata
|
@@ -1326,15 +1318,15 @@ module Orb
|
|
1326
1318
|
|
1327
1319
|
# @!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
1320
|
# Some parameter documentations has been truncated, see
|
1329
|
-
# {Orb::Models::PlanCreateParams::Price::
|
1321
|
+
# {Orb::Models::PlanCreateParams::Price::TieredBps} for more details.
|
1330
1322
|
#
|
1331
|
-
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::
|
1323
|
+
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::TieredBps::Cadence] The cadence to bill for this price on.
|
1332
1324
|
#
|
1333
1325
|
# @param item_id [String] The id of the item the price will be associated with.
|
1334
1326
|
#
|
1335
1327
|
# @param name [String] The name of the price.
|
1336
1328
|
#
|
1337
|
-
# @param tiered_bps_config [Orb::Models::PlanCreateParams::Price::
|
1329
|
+
# @param tiered_bps_config [Orb::Models::PlanCreateParams::Price::TieredBps::TieredBpsConfig]
|
1338
1330
|
#
|
1339
1331
|
# @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b
|
1340
1332
|
# ...
|
@@ -1342,7 +1334,7 @@ module Orb
|
|
1342
1334
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
1343
1335
|
# ...
|
1344
1336
|
#
|
1345
|
-
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::
|
1337
|
+
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::TieredBps::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
1346
1338
|
# ...
|
1347
1339
|
#
|
1348
1340
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
@@ -1357,7 +1349,7 @@ module Orb
|
|
1357
1349
|
#
|
1358
1350
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
1359
1351
|
#
|
1360
|
-
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::
|
1352
|
+
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::TieredBps::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
1361
1353
|
# ...
|
1362
1354
|
#
|
1363
1355
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
@@ -1367,7 +1359,7 @@ module Orb
|
|
1367
1359
|
|
1368
1360
|
# The cadence to bill for this price on.
|
1369
1361
|
#
|
1370
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
1362
|
+
# @see Orb::Models::PlanCreateParams::Price::TieredBps#cadence
|
1371
1363
|
module Cadence
|
1372
1364
|
extend Orb::Internal::Type::Enum
|
1373
1365
|
|
@@ -1382,22 +1374,22 @@ module Orb
|
|
1382
1374
|
# @return [Array<Symbol>]
|
1383
1375
|
end
|
1384
1376
|
|
1385
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
1377
|
+
# @see Orb::Models::PlanCreateParams::Price::TieredBps#tiered_bps_config
|
1386
1378
|
class TieredBpsConfig < Orb::Internal::Type::BaseModel
|
1387
1379
|
# @!attribute tiers
|
1388
1380
|
# Tiers for a Graduated BPS pricing model, where usage is bucketed into specified
|
1389
1381
|
# tiers
|
1390
1382
|
#
|
1391
|
-
# @return [Array<Orb::Models::PlanCreateParams::Price::
|
1383
|
+
# @return [Array<Orb::Models::PlanCreateParams::Price::TieredBps::TieredBpsConfig::Tier>]
|
1392
1384
|
required :tiers,
|
1393
|
-
-> { Orb::Internal::Type::ArrayOf[Orb::Models::PlanCreateParams::Price::
|
1385
|
+
-> { Orb::Internal::Type::ArrayOf[Orb::Models::PlanCreateParams::Price::TieredBps::TieredBpsConfig::Tier] }
|
1394
1386
|
|
1395
1387
|
# @!method initialize(tiers:)
|
1396
1388
|
# Some parameter documentations has been truncated, see
|
1397
|
-
# {Orb::Models::PlanCreateParams::Price::
|
1398
|
-
#
|
1389
|
+
# {Orb::Models::PlanCreateParams::Price::TieredBps::TieredBpsConfig} for more
|
1390
|
+
# details.
|
1399
1391
|
#
|
1400
|
-
# @param tiers [Array<Orb::Models::PlanCreateParams::Price::
|
1392
|
+
# @param tiers [Array<Orb::Models::PlanCreateParams::Price::TieredBps::TieredBpsConfig::Tier>] Tiers for a Graduated BPS pricing model, where usage is bucketed into specified
|
1401
1393
|
# ...
|
1402
1394
|
|
1403
1395
|
class Tier < Orb::Internal::Type::BaseModel
|
@@ -1436,7 +1428,7 @@ module Orb
|
|
1436
1428
|
end
|
1437
1429
|
end
|
1438
1430
|
|
1439
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
1431
|
+
# @see Orb::Models::PlanCreateParams::Price::TieredBps#billing_cycle_configuration
|
1440
1432
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
1441
1433
|
# @!attribute duration
|
1442
1434
|
# The duration of the billing period.
|
@@ -1447,9 +1439,9 @@ module Orb
|
|
1447
1439
|
# @!attribute duration_unit
|
1448
1440
|
# The unit of billing period duration.
|
1449
1441
|
#
|
1450
|
-
# @return [Symbol, Orb::Models::PlanCreateParams::Price::
|
1442
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::TieredBps::BillingCycleConfiguration::DurationUnit]
|
1451
1443
|
required :duration_unit,
|
1452
|
-
enum: -> { Orb::Models::PlanCreateParams::Price::
|
1444
|
+
enum: -> { Orb::Models::PlanCreateParams::Price::TieredBps::BillingCycleConfiguration::DurationUnit }
|
1453
1445
|
|
1454
1446
|
# @!method initialize(duration:, duration_unit:)
|
1455
1447
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -1457,11 +1449,11 @@ module Orb
|
|
1457
1449
|
#
|
1458
1450
|
# @param duration [Integer] The duration of the billing period.
|
1459
1451
|
#
|
1460
|
-
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::
|
1452
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::TieredBps::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
1461
1453
|
|
1462
1454
|
# The unit of billing period duration.
|
1463
1455
|
#
|
1464
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
1456
|
+
# @see Orb::Models::PlanCreateParams::Price::TieredBps::BillingCycleConfiguration#duration_unit
|
1465
1457
|
module DurationUnit
|
1466
1458
|
extend Orb::Internal::Type::Enum
|
1467
1459
|
|
@@ -1473,7 +1465,7 @@ module Orb
|
|
1473
1465
|
end
|
1474
1466
|
end
|
1475
1467
|
|
1476
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
1468
|
+
# @see Orb::Models::PlanCreateParams::Price::TieredBps#invoicing_cycle_configuration
|
1477
1469
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
1478
1470
|
# @!attribute duration
|
1479
1471
|
# The duration of the billing period.
|
@@ -1484,9 +1476,9 @@ module Orb
|
|
1484
1476
|
# @!attribute duration_unit
|
1485
1477
|
# The unit of billing period duration.
|
1486
1478
|
#
|
1487
|
-
# @return [Symbol, Orb::Models::PlanCreateParams::Price::
|
1479
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::TieredBps::InvoicingCycleConfiguration::DurationUnit]
|
1488
1480
|
required :duration_unit,
|
1489
|
-
enum: -> { Orb::Models::PlanCreateParams::Price::
|
1481
|
+
enum: -> { Orb::Models::PlanCreateParams::Price::TieredBps::InvoicingCycleConfiguration::DurationUnit }
|
1490
1482
|
|
1491
1483
|
# @!method initialize(duration:, duration_unit:)
|
1492
1484
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
@@ -1494,11 +1486,11 @@ module Orb
|
|
1494
1486
|
#
|
1495
1487
|
# @param duration [Integer] The duration of the billing period.
|
1496
1488
|
#
|
1497
|
-
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::
|
1489
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::TieredBps::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
1498
1490
|
|
1499
1491
|
# The unit of billing period duration.
|
1500
1492
|
#
|
1501
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
1493
|
+
# @see Orb::Models::PlanCreateParams::Price::TieredBps::InvoicingCycleConfiguration#duration_unit
|
1502
1494
|
module DurationUnit
|
1503
1495
|
extend Orb::Internal::Type::Enum
|
1504
1496
|
|
@@ -1511,17 +1503,17 @@ module Orb
|
|
1511
1503
|
end
|
1512
1504
|
end
|
1513
1505
|
|
1514
|
-
class
|
1506
|
+
class Bps < Orb::Internal::Type::BaseModel
|
1515
1507
|
# @!attribute bps_config
|
1516
1508
|
#
|
1517
|
-
# @return [Orb::Models::PlanCreateParams::Price::
|
1518
|
-
required :bps_config, -> { Orb::Models::PlanCreateParams::Price::
|
1509
|
+
# @return [Orb::Models::PlanCreateParams::Price::Bps::BpsConfig]
|
1510
|
+
required :bps_config, -> { Orb::Models::PlanCreateParams::Price::Bps::BpsConfig }
|
1519
1511
|
|
1520
1512
|
# @!attribute cadence
|
1521
1513
|
# The cadence to bill for this price on.
|
1522
1514
|
#
|
1523
|
-
# @return [Symbol, Orb::Models::PlanCreateParams::Price::
|
1524
|
-
required :cadence, enum: -> { Orb::Models::PlanCreateParams::Price::
|
1515
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::Bps::Cadence]
|
1516
|
+
required :cadence, enum: -> { Orb::Models::PlanCreateParams::Price::Bps::Cadence }
|
1525
1517
|
|
1526
1518
|
# @!attribute item_id
|
1527
1519
|
# The id of the item the price will be associated with.
|
@@ -1558,9 +1550,9 @@ module Orb
|
|
1558
1550
|
# For custom cadence: specifies the duration of the billing period in days or
|
1559
1551
|
# months.
|
1560
1552
|
#
|
1561
|
-
# @return [Orb::Models::PlanCreateParams::Price::
|
1553
|
+
# @return [Orb::Models::PlanCreateParams::Price::Bps::BillingCycleConfiguration, nil]
|
1562
1554
|
optional :billing_cycle_configuration,
|
1563
|
-
-> { Orb::Models::PlanCreateParams::Price::
|
1555
|
+
-> { Orb::Models::PlanCreateParams::Price::Bps::BillingCycleConfiguration },
|
1564
1556
|
nil?: true
|
1565
1557
|
|
1566
1558
|
# @!attribute conversion_rate
|
@@ -1599,9 +1591,9 @@ module Orb
|
|
1599
1591
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
1600
1592
|
# If unspecified, a single invoice is produced per billing cycle.
|
1601
1593
|
#
|
1602
|
-
# @return [Orb::Models::PlanCreateParams::Price::
|
1594
|
+
# @return [Orb::Models::PlanCreateParams::Price::Bps::InvoicingCycleConfiguration, nil]
|
1603
1595
|
optional :invoicing_cycle_configuration,
|
1604
|
-
-> { Orb::Models::PlanCreateParams::Price::
|
1596
|
+
-> { Orb::Models::PlanCreateParams::Price::Bps::InvoicingCycleConfiguration },
|
1605
1597
|
nil?: true
|
1606
1598
|
|
1607
1599
|
# @!attribute metadata
|
@@ -1614,11 +1606,11 @@ module Orb
|
|
1614
1606
|
|
1615
1607
|
# @!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
1608
|
# Some parameter documentations has been truncated, see
|
1617
|
-
# {Orb::Models::PlanCreateParams::Price::
|
1609
|
+
# {Orb::Models::PlanCreateParams::Price::Bps} for more details.
|
1618
1610
|
#
|
1619
|
-
# @param bps_config [Orb::Models::PlanCreateParams::Price::
|
1611
|
+
# @param bps_config [Orb::Models::PlanCreateParams::Price::Bps::BpsConfig]
|
1620
1612
|
#
|
1621
|
-
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::
|
1613
|
+
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::Bps::Cadence] The cadence to bill for this price on.
|
1622
1614
|
#
|
1623
1615
|
# @param item_id [String] The id of the item the price will be associated with.
|
1624
1616
|
#
|
@@ -1630,7 +1622,7 @@ module Orb
|
|
1630
1622
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
1631
1623
|
# ...
|
1632
1624
|
#
|
1633
|
-
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::
|
1625
|
+
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::Bps::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
1634
1626
|
# ...
|
1635
1627
|
#
|
1636
1628
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
@@ -1645,7 +1637,7 @@ module Orb
|
|
1645
1637
|
#
|
1646
1638
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
1647
1639
|
#
|
1648
|
-
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::
|
1640
|
+
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::Bps::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
1649
1641
|
# ...
|
1650
1642
|
#
|
1651
1643
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
@@ -1653,7 +1645,7 @@ module Orb
|
|
1653
1645
|
#
|
1654
1646
|
# @param model_type [Symbol, :bps]
|
1655
1647
|
|
1656
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
1648
|
+
# @see Orb::Models::PlanCreateParams::Price::Bps#bps_config
|
1657
1649
|
class BpsConfig < Orb::Internal::Type::BaseModel
|
1658
1650
|
# @!attribute bps
|
1659
1651
|
# Basis point take rate per event
|
@@ -1675,7 +1667,7 @@ module Orb
|
|
1675
1667
|
|
1676
1668
|
# The cadence to bill for this price on.
|
1677
1669
|
#
|
1678
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
1670
|
+
# @see Orb::Models::PlanCreateParams::Price::Bps#cadence
|
1679
1671
|
module Cadence
|
1680
1672
|
extend Orb::Internal::Type::Enum
|
1681
1673
|
|
@@ -1690,7 +1682,7 @@ module Orb
|
|
1690
1682
|
# @return [Array<Symbol>]
|
1691
1683
|
end
|
1692
1684
|
|
1693
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
1685
|
+
# @see Orb::Models::PlanCreateParams::Price::Bps#billing_cycle_configuration
|
1694
1686
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
1695
1687
|
# @!attribute duration
|
1696
1688
|
# The duration of the billing period.
|
@@ -1701,9 +1693,9 @@ module Orb
|
|
1701
1693
|
# @!attribute duration_unit
|
1702
1694
|
# The unit of billing period duration.
|
1703
1695
|
#
|
1704
|
-
# @return [Symbol, Orb::Models::PlanCreateParams::Price::
|
1696
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::Bps::BillingCycleConfiguration::DurationUnit]
|
1705
1697
|
required :duration_unit,
|
1706
|
-
enum: -> { Orb::Models::PlanCreateParams::Price::
|
1698
|
+
enum: -> { Orb::Models::PlanCreateParams::Price::Bps::BillingCycleConfiguration::DurationUnit }
|
1707
1699
|
|
1708
1700
|
# @!method initialize(duration:, duration_unit:)
|
1709
1701
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -1711,11 +1703,11 @@ module Orb
|
|
1711
1703
|
#
|
1712
1704
|
# @param duration [Integer] The duration of the billing period.
|
1713
1705
|
#
|
1714
|
-
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::
|
1706
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::Bps::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
1715
1707
|
|
1716
1708
|
# The unit of billing period duration.
|
1717
1709
|
#
|
1718
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
1710
|
+
# @see Orb::Models::PlanCreateParams::Price::Bps::BillingCycleConfiguration#duration_unit
|
1719
1711
|
module DurationUnit
|
1720
1712
|
extend Orb::Internal::Type::Enum
|
1721
1713
|
|
@@ -1727,7 +1719,7 @@ module Orb
|
|
1727
1719
|
end
|
1728
1720
|
end
|
1729
1721
|
|
1730
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
1722
|
+
# @see Orb::Models::PlanCreateParams::Price::Bps#invoicing_cycle_configuration
|
1731
1723
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
1732
1724
|
# @!attribute duration
|
1733
1725
|
# The duration of the billing period.
|
@@ -1738,9 +1730,9 @@ module Orb
|
|
1738
1730
|
# @!attribute duration_unit
|
1739
1731
|
# The unit of billing period duration.
|
1740
1732
|
#
|
1741
|
-
# @return [Symbol, Orb::Models::PlanCreateParams::Price::
|
1733
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::Bps::InvoicingCycleConfiguration::DurationUnit]
|
1742
1734
|
required :duration_unit,
|
1743
|
-
enum: -> { Orb::Models::PlanCreateParams::Price::
|
1735
|
+
enum: -> { Orb::Models::PlanCreateParams::Price::Bps::InvoicingCycleConfiguration::DurationUnit }
|
1744
1736
|
|
1745
1737
|
# @!method initialize(duration:, duration_unit:)
|
1746
1738
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
@@ -1748,11 +1740,11 @@ module Orb
|
|
1748
1740
|
#
|
1749
1741
|
# @param duration [Integer] The duration of the billing period.
|
1750
1742
|
#
|
1751
|
-
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::
|
1743
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::Bps::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
1752
1744
|
|
1753
1745
|
# The unit of billing period duration.
|
1754
1746
|
#
|
1755
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
1747
|
+
# @see Orb::Models::PlanCreateParams::Price::Bps::InvoicingCycleConfiguration#duration_unit
|
1756
1748
|
module DurationUnit
|
1757
1749
|
extend Orb::Internal::Type::Enum
|
1758
1750
|
|
@@ -1765,17 +1757,17 @@ module Orb
|
|
1765
1757
|
end
|
1766
1758
|
end
|
1767
1759
|
|
1768
|
-
class
|
1760
|
+
class BulkBps < Orb::Internal::Type::BaseModel
|
1769
1761
|
# @!attribute bulk_bps_config
|
1770
1762
|
#
|
1771
|
-
# @return [Orb::Models::PlanCreateParams::Price::
|
1772
|
-
required :bulk_bps_config, -> { Orb::Models::PlanCreateParams::Price::
|
1763
|
+
# @return [Orb::Models::PlanCreateParams::Price::BulkBps::BulkBpsConfig]
|
1764
|
+
required :bulk_bps_config, -> { Orb::Models::PlanCreateParams::Price::BulkBps::BulkBpsConfig }
|
1773
1765
|
|
1774
1766
|
# @!attribute cadence
|
1775
1767
|
# The cadence to bill for this price on.
|
1776
1768
|
#
|
1777
|
-
# @return [Symbol, Orb::Models::PlanCreateParams::Price::
|
1778
|
-
required :cadence, enum: -> { Orb::Models::PlanCreateParams::Price::
|
1769
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::BulkBps::Cadence]
|
1770
|
+
required :cadence, enum: -> { Orb::Models::PlanCreateParams::Price::BulkBps::Cadence }
|
1779
1771
|
|
1780
1772
|
# @!attribute item_id
|
1781
1773
|
# The id of the item the price will be associated with.
|
@@ -1812,9 +1804,9 @@ module Orb
|
|
1812
1804
|
# For custom cadence: specifies the duration of the billing period in days or
|
1813
1805
|
# months.
|
1814
1806
|
#
|
1815
|
-
# @return [Orb::Models::PlanCreateParams::Price::
|
1807
|
+
# @return [Orb::Models::PlanCreateParams::Price::BulkBps::BillingCycleConfiguration, nil]
|
1816
1808
|
optional :billing_cycle_configuration,
|
1817
|
-
-> { Orb::Models::PlanCreateParams::Price::
|
1809
|
+
-> { Orb::Models::PlanCreateParams::Price::BulkBps::BillingCycleConfiguration },
|
1818
1810
|
nil?: true
|
1819
1811
|
|
1820
1812
|
# @!attribute conversion_rate
|
@@ -1853,9 +1845,9 @@ module Orb
|
|
1853
1845
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
1854
1846
|
# If unspecified, a single invoice is produced per billing cycle.
|
1855
1847
|
#
|
1856
|
-
# @return [Orb::Models::PlanCreateParams::Price::
|
1848
|
+
# @return [Orb::Models::PlanCreateParams::Price::BulkBps::InvoicingCycleConfiguration, nil]
|
1857
1849
|
optional :invoicing_cycle_configuration,
|
1858
|
-
-> { Orb::Models::PlanCreateParams::Price::
|
1850
|
+
-> { Orb::Models::PlanCreateParams::Price::BulkBps::InvoicingCycleConfiguration },
|
1859
1851
|
nil?: true
|
1860
1852
|
|
1861
1853
|
# @!attribute metadata
|
@@ -1868,11 +1860,11 @@ module Orb
|
|
1868
1860
|
|
1869
1861
|
# @!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
1862
|
# Some parameter documentations has been truncated, see
|
1871
|
-
# {Orb::Models::PlanCreateParams::Price::
|
1863
|
+
# {Orb::Models::PlanCreateParams::Price::BulkBps} for more details.
|
1872
1864
|
#
|
1873
|
-
# @param bulk_bps_config [Orb::Models::PlanCreateParams::Price::
|
1865
|
+
# @param bulk_bps_config [Orb::Models::PlanCreateParams::Price::BulkBps::BulkBpsConfig]
|
1874
1866
|
#
|
1875
|
-
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::
|
1867
|
+
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::BulkBps::Cadence] The cadence to bill for this price on.
|
1876
1868
|
#
|
1877
1869
|
# @param item_id [String] The id of the item the price will be associated with.
|
1878
1870
|
#
|
@@ -1884,7 +1876,7 @@ module Orb
|
|
1884
1876
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
1885
1877
|
# ...
|
1886
1878
|
#
|
1887
|
-
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::
|
1879
|
+
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::BulkBps::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
1888
1880
|
# ...
|
1889
1881
|
#
|
1890
1882
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
@@ -1899,7 +1891,7 @@ module Orb
|
|
1899
1891
|
#
|
1900
1892
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
1901
1893
|
#
|
1902
|
-
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::
|
1894
|
+
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::BulkBps::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
1903
1895
|
# ...
|
1904
1896
|
#
|
1905
1897
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
@@ -1907,22 +1899,21 @@ module Orb
|
|
1907
1899
|
#
|
1908
1900
|
# @param model_type [Symbol, :bulk_bps]
|
1909
1901
|
|
1910
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
1902
|
+
# @see Orb::Models::PlanCreateParams::Price::BulkBps#bulk_bps_config
|
1911
1903
|
class BulkBpsConfig < Orb::Internal::Type::BaseModel
|
1912
1904
|
# @!attribute tiers
|
1913
1905
|
# Tiers for a bulk BPS pricing model where all usage is aggregated to a single
|
1914
1906
|
# tier based on total volume
|
1915
1907
|
#
|
1916
|
-
# @return [Array<Orb::Models::PlanCreateParams::Price::
|
1908
|
+
# @return [Array<Orb::Models::PlanCreateParams::Price::BulkBps::BulkBpsConfig::Tier>]
|
1917
1909
|
required :tiers,
|
1918
|
-
-> { Orb::Internal::Type::ArrayOf[Orb::Models::PlanCreateParams::Price::
|
1910
|
+
-> { Orb::Internal::Type::ArrayOf[Orb::Models::PlanCreateParams::Price::BulkBps::BulkBpsConfig::Tier] }
|
1919
1911
|
|
1920
1912
|
# @!method initialize(tiers:)
|
1921
1913
|
# Some parameter documentations has been truncated, see
|
1922
|
-
# {Orb::Models::PlanCreateParams::Price::
|
1923
|
-
# more details.
|
1914
|
+
# {Orb::Models::PlanCreateParams::Price::BulkBps::BulkBpsConfig} for more details.
|
1924
1915
|
#
|
1925
|
-
# @param tiers [Array<Orb::Models::PlanCreateParams::Price::
|
1916
|
+
# @param tiers [Array<Orb::Models::PlanCreateParams::Price::BulkBps::BulkBpsConfig::Tier>] Tiers for a bulk BPS pricing model where all usage is aggregated to a single tie
|
1926
1917
|
# ...
|
1927
1918
|
|
1928
1919
|
class Tier < Orb::Internal::Type::BaseModel
|
@@ -1955,7 +1946,7 @@ module Orb
|
|
1955
1946
|
|
1956
1947
|
# The cadence to bill for this price on.
|
1957
1948
|
#
|
1958
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
1949
|
+
# @see Orb::Models::PlanCreateParams::Price::BulkBps#cadence
|
1959
1950
|
module Cadence
|
1960
1951
|
extend Orb::Internal::Type::Enum
|
1961
1952
|
|
@@ -1970,7 +1961,7 @@ module Orb
|
|
1970
1961
|
# @return [Array<Symbol>]
|
1971
1962
|
end
|
1972
1963
|
|
1973
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
1964
|
+
# @see Orb::Models::PlanCreateParams::Price::BulkBps#billing_cycle_configuration
|
1974
1965
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
1975
1966
|
# @!attribute duration
|
1976
1967
|
# The duration of the billing period.
|
@@ -1981,9 +1972,9 @@ module Orb
|
|
1981
1972
|
# @!attribute duration_unit
|
1982
1973
|
# The unit of billing period duration.
|
1983
1974
|
#
|
1984
|
-
# @return [Symbol, Orb::Models::PlanCreateParams::Price::
|
1975
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::BulkBps::BillingCycleConfiguration::DurationUnit]
|
1985
1976
|
required :duration_unit,
|
1986
|
-
enum: -> { Orb::Models::PlanCreateParams::Price::
|
1977
|
+
enum: -> { Orb::Models::PlanCreateParams::Price::BulkBps::BillingCycleConfiguration::DurationUnit }
|
1987
1978
|
|
1988
1979
|
# @!method initialize(duration:, duration_unit:)
|
1989
1980
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -1991,11 +1982,11 @@ module Orb
|
|
1991
1982
|
#
|
1992
1983
|
# @param duration [Integer] The duration of the billing period.
|
1993
1984
|
#
|
1994
|
-
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::
|
1985
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::BulkBps::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
1995
1986
|
|
1996
1987
|
# The unit of billing period duration.
|
1997
1988
|
#
|
1998
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
1989
|
+
# @see Orb::Models::PlanCreateParams::Price::BulkBps::BillingCycleConfiguration#duration_unit
|
1999
1990
|
module DurationUnit
|
2000
1991
|
extend Orb::Internal::Type::Enum
|
2001
1992
|
|
@@ -2007,7 +1998,7 @@ module Orb
|
|
2007
1998
|
end
|
2008
1999
|
end
|
2009
2000
|
|
2010
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
2001
|
+
# @see Orb::Models::PlanCreateParams::Price::BulkBps#invoicing_cycle_configuration
|
2011
2002
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
2012
2003
|
# @!attribute duration
|
2013
2004
|
# The duration of the billing period.
|
@@ -2018,9 +2009,9 @@ module Orb
|
|
2018
2009
|
# @!attribute duration_unit
|
2019
2010
|
# The unit of billing period duration.
|
2020
2011
|
#
|
2021
|
-
# @return [Symbol, Orb::Models::PlanCreateParams::Price::
|
2012
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::BulkBps::InvoicingCycleConfiguration::DurationUnit]
|
2022
2013
|
required :duration_unit,
|
2023
|
-
enum: -> { Orb::Models::PlanCreateParams::Price::
|
2014
|
+
enum: -> { Orb::Models::PlanCreateParams::Price::BulkBps::InvoicingCycleConfiguration::DurationUnit }
|
2024
2015
|
|
2025
2016
|
# @!method initialize(duration:, duration_unit:)
|
2026
2017
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
@@ -2028,11 +2019,11 @@ module Orb
|
|
2028
2019
|
#
|
2029
2020
|
# @param duration [Integer] The duration of the billing period.
|
2030
2021
|
#
|
2031
|
-
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::
|
2022
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::BulkBps::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
2032
2023
|
|
2033
2024
|
# The unit of billing period duration.
|
2034
2025
|
#
|
2035
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
2026
|
+
# @see Orb::Models::PlanCreateParams::Price::BulkBps::InvoicingCycleConfiguration#duration_unit
|
2036
2027
|
module DurationUnit
|
2037
2028
|
extend Orb::Internal::Type::Enum
|
2038
2029
|
|
@@ -2045,17 +2036,17 @@ module Orb
|
|
2045
2036
|
end
|
2046
2037
|
end
|
2047
2038
|
|
2048
|
-
class
|
2039
|
+
class Bulk < Orb::Internal::Type::BaseModel
|
2049
2040
|
# @!attribute bulk_config
|
2050
2041
|
#
|
2051
|
-
# @return [Orb::Models::PlanCreateParams::Price::
|
2052
|
-
required :bulk_config, -> { Orb::Models::PlanCreateParams::Price::
|
2042
|
+
# @return [Orb::Models::PlanCreateParams::Price::Bulk::BulkConfig]
|
2043
|
+
required :bulk_config, -> { Orb::Models::PlanCreateParams::Price::Bulk::BulkConfig }
|
2053
2044
|
|
2054
2045
|
# @!attribute cadence
|
2055
2046
|
# The cadence to bill for this price on.
|
2056
2047
|
#
|
2057
|
-
# @return [Symbol, Orb::Models::PlanCreateParams::Price::
|
2058
|
-
required :cadence, enum: -> { Orb::Models::PlanCreateParams::Price::
|
2048
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::Bulk::Cadence]
|
2049
|
+
required :cadence, enum: -> { Orb::Models::PlanCreateParams::Price::Bulk::Cadence }
|
2059
2050
|
|
2060
2051
|
# @!attribute item_id
|
2061
2052
|
# The id of the item the price will be associated with.
|
@@ -2092,9 +2083,9 @@ module Orb
|
|
2092
2083
|
# For custom cadence: specifies the duration of the billing period in days or
|
2093
2084
|
# months.
|
2094
2085
|
#
|
2095
|
-
# @return [Orb::Models::PlanCreateParams::Price::
|
2086
|
+
# @return [Orb::Models::PlanCreateParams::Price::Bulk::BillingCycleConfiguration, nil]
|
2096
2087
|
optional :billing_cycle_configuration,
|
2097
|
-
-> { Orb::Models::PlanCreateParams::Price::
|
2088
|
+
-> { Orb::Models::PlanCreateParams::Price::Bulk::BillingCycleConfiguration },
|
2098
2089
|
nil?: true
|
2099
2090
|
|
2100
2091
|
# @!attribute conversion_rate
|
@@ -2133,9 +2124,9 @@ module Orb
|
|
2133
2124
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
2134
2125
|
# If unspecified, a single invoice is produced per billing cycle.
|
2135
2126
|
#
|
2136
|
-
# @return [Orb::Models::PlanCreateParams::Price::
|
2127
|
+
# @return [Orb::Models::PlanCreateParams::Price::Bulk::InvoicingCycleConfiguration, nil]
|
2137
2128
|
optional :invoicing_cycle_configuration,
|
2138
|
-
-> { Orb::Models::PlanCreateParams::Price::
|
2129
|
+
-> { Orb::Models::PlanCreateParams::Price::Bulk::InvoicingCycleConfiguration },
|
2139
2130
|
nil?: true
|
2140
2131
|
|
2141
2132
|
# @!attribute metadata
|
@@ -2148,11 +2139,11 @@ module Orb
|
|
2148
2139
|
|
2149
2140
|
# @!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
2141
|
# Some parameter documentations has been truncated, see
|
2151
|
-
# {Orb::Models::PlanCreateParams::Price::
|
2142
|
+
# {Orb::Models::PlanCreateParams::Price::Bulk} for more details.
|
2152
2143
|
#
|
2153
|
-
# @param bulk_config [Orb::Models::PlanCreateParams::Price::
|
2144
|
+
# @param bulk_config [Orb::Models::PlanCreateParams::Price::Bulk::BulkConfig]
|
2154
2145
|
#
|
2155
|
-
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::
|
2146
|
+
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::Bulk::Cadence] The cadence to bill for this price on.
|
2156
2147
|
#
|
2157
2148
|
# @param item_id [String] The id of the item the price will be associated with.
|
2158
2149
|
#
|
@@ -2164,7 +2155,7 @@ module Orb
|
|
2164
2155
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
2165
2156
|
# ...
|
2166
2157
|
#
|
2167
|
-
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::
|
2158
|
+
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::Bulk::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
2168
2159
|
# ...
|
2169
2160
|
#
|
2170
2161
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
@@ -2179,7 +2170,7 @@ module Orb
|
|
2179
2170
|
#
|
2180
2171
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
2181
2172
|
#
|
2182
|
-
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::
|
2173
|
+
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::Bulk::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
2183
2174
|
# ...
|
2184
2175
|
#
|
2185
2176
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
@@ -2187,17 +2178,17 @@ module Orb
|
|
2187
2178
|
#
|
2188
2179
|
# @param model_type [Symbol, :bulk]
|
2189
2180
|
|
2190
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
2181
|
+
# @see Orb::Models::PlanCreateParams::Price::Bulk#bulk_config
|
2191
2182
|
class BulkConfig < Orb::Internal::Type::BaseModel
|
2192
2183
|
# @!attribute tiers
|
2193
2184
|
# Bulk tiers for rating based on total usage volume
|
2194
2185
|
#
|
2195
|
-
# @return [Array<Orb::Models::PlanCreateParams::Price::
|
2186
|
+
# @return [Array<Orb::Models::PlanCreateParams::Price::Bulk::BulkConfig::Tier>]
|
2196
2187
|
required :tiers,
|
2197
|
-
-> { Orb::Internal::Type::ArrayOf[Orb::Models::PlanCreateParams::Price::
|
2188
|
+
-> { Orb::Internal::Type::ArrayOf[Orb::Models::PlanCreateParams::Price::Bulk::BulkConfig::Tier] }
|
2198
2189
|
|
2199
2190
|
# @!method initialize(tiers:)
|
2200
|
-
# @param tiers [Array<Orb::Models::PlanCreateParams::Price::
|
2191
|
+
# @param tiers [Array<Orb::Models::PlanCreateParams::Price::Bulk::BulkConfig::Tier>] Bulk tiers for rating based on total usage volume
|
2201
2192
|
|
2202
2193
|
class Tier < Orb::Internal::Type::BaseModel
|
2203
2194
|
# @!attribute unit_amount
|
@@ -2221,7 +2212,7 @@ module Orb
|
|
2221
2212
|
|
2222
2213
|
# The cadence to bill for this price on.
|
2223
2214
|
#
|
2224
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
2215
|
+
# @see Orb::Models::PlanCreateParams::Price::Bulk#cadence
|
2225
2216
|
module Cadence
|
2226
2217
|
extend Orb::Internal::Type::Enum
|
2227
2218
|
|
@@ -2236,7 +2227,7 @@ module Orb
|
|
2236
2227
|
# @return [Array<Symbol>]
|
2237
2228
|
end
|
2238
2229
|
|
2239
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
2230
|
+
# @see Orb::Models::PlanCreateParams::Price::Bulk#billing_cycle_configuration
|
2240
2231
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
2241
2232
|
# @!attribute duration
|
2242
2233
|
# The duration of the billing period.
|
@@ -2247,9 +2238,9 @@ module Orb
|
|
2247
2238
|
# @!attribute duration_unit
|
2248
2239
|
# The unit of billing period duration.
|
2249
2240
|
#
|
2250
|
-
# @return [Symbol, Orb::Models::PlanCreateParams::Price::
|
2241
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::Bulk::BillingCycleConfiguration::DurationUnit]
|
2251
2242
|
required :duration_unit,
|
2252
|
-
enum: -> { Orb::Models::PlanCreateParams::Price::
|
2243
|
+
enum: -> { Orb::Models::PlanCreateParams::Price::Bulk::BillingCycleConfiguration::DurationUnit }
|
2253
2244
|
|
2254
2245
|
# @!method initialize(duration:, duration_unit:)
|
2255
2246
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -2257,11 +2248,11 @@ module Orb
|
|
2257
2248
|
#
|
2258
2249
|
# @param duration [Integer] The duration of the billing period.
|
2259
2250
|
#
|
2260
|
-
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::
|
2251
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::Bulk::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
2261
2252
|
|
2262
2253
|
# The unit of billing period duration.
|
2263
2254
|
#
|
2264
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
2255
|
+
# @see Orb::Models::PlanCreateParams::Price::Bulk::BillingCycleConfiguration#duration_unit
|
2265
2256
|
module DurationUnit
|
2266
2257
|
extend Orb::Internal::Type::Enum
|
2267
2258
|
|
@@ -2273,7 +2264,7 @@ module Orb
|
|
2273
2264
|
end
|
2274
2265
|
end
|
2275
2266
|
|
2276
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
2267
|
+
# @see Orb::Models::PlanCreateParams::Price::Bulk#invoicing_cycle_configuration
|
2277
2268
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
2278
2269
|
# @!attribute duration
|
2279
2270
|
# The duration of the billing period.
|
@@ -2284,9 +2275,9 @@ module Orb
|
|
2284
2275
|
# @!attribute duration_unit
|
2285
2276
|
# The unit of billing period duration.
|
2286
2277
|
#
|
2287
|
-
# @return [Symbol, Orb::Models::PlanCreateParams::Price::
|
2278
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::Bulk::InvoicingCycleConfiguration::DurationUnit]
|
2288
2279
|
required :duration_unit,
|
2289
|
-
enum: -> { Orb::Models::PlanCreateParams::Price::
|
2280
|
+
enum: -> { Orb::Models::PlanCreateParams::Price::Bulk::InvoicingCycleConfiguration::DurationUnit }
|
2290
2281
|
|
2291
2282
|
# @!method initialize(duration:, duration_unit:)
|
2292
2283
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
@@ -2294,11 +2285,11 @@ module Orb
|
|
2294
2285
|
#
|
2295
2286
|
# @param duration [Integer] The duration of the billing period.
|
2296
2287
|
#
|
2297
|
-
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::
|
2288
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::Bulk::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
2298
2289
|
|
2299
2290
|
# The unit of billing period duration.
|
2300
2291
|
#
|
2301
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
2292
|
+
# @see Orb::Models::PlanCreateParams::Price::Bulk::InvoicingCycleConfiguration#duration_unit
|
2302
2293
|
module DurationUnit
|
2303
2294
|
extend Orb::Internal::Type::Enum
|
2304
2295
|
|
@@ -2311,13 +2302,12 @@ module Orb
|
|
2311
2302
|
end
|
2312
2303
|
end
|
2313
2304
|
|
2314
|
-
class
|
2305
|
+
class ThresholdTotalAmount < Orb::Internal::Type::BaseModel
|
2315
2306
|
# @!attribute cadence
|
2316
2307
|
# The cadence to bill for this price on.
|
2317
2308
|
#
|
2318
|
-
# @return [Symbol, Orb::Models::PlanCreateParams::Price::
|
2319
|
-
required :cadence,
|
2320
|
-
enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanThresholdTotalAmountPrice::Cadence }
|
2309
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::ThresholdTotalAmount::Cadence]
|
2310
|
+
required :cadence, enum: -> { Orb::Models::PlanCreateParams::Price::ThresholdTotalAmount::Cadence }
|
2321
2311
|
|
2322
2312
|
# @!attribute item_id
|
2323
2313
|
# The id of the item the price will be associated with.
|
@@ -2359,9 +2349,9 @@ module Orb
|
|
2359
2349
|
# For custom cadence: specifies the duration of the billing period in days or
|
2360
2350
|
# months.
|
2361
2351
|
#
|
2362
|
-
# @return [Orb::Models::PlanCreateParams::Price::
|
2352
|
+
# @return [Orb::Models::PlanCreateParams::Price::ThresholdTotalAmount::BillingCycleConfiguration, nil]
|
2363
2353
|
optional :billing_cycle_configuration,
|
2364
|
-
-> { Orb::Models::PlanCreateParams::Price::
|
2354
|
+
-> { Orb::Models::PlanCreateParams::Price::ThresholdTotalAmount::BillingCycleConfiguration },
|
2365
2355
|
nil?: true
|
2366
2356
|
|
2367
2357
|
# @!attribute conversion_rate
|
@@ -2400,9 +2390,9 @@ module Orb
|
|
2400
2390
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
2401
2391
|
# If unspecified, a single invoice is produced per billing cycle.
|
2402
2392
|
#
|
2403
|
-
# @return [Orb::Models::PlanCreateParams::Price::
|
2393
|
+
# @return [Orb::Models::PlanCreateParams::Price::ThresholdTotalAmount::InvoicingCycleConfiguration, nil]
|
2404
2394
|
optional :invoicing_cycle_configuration,
|
2405
|
-
-> { Orb::Models::PlanCreateParams::Price::
|
2395
|
+
-> { Orb::Models::PlanCreateParams::Price::ThresholdTotalAmount::InvoicingCycleConfiguration },
|
2406
2396
|
nil?: true
|
2407
2397
|
|
2408
2398
|
# @!attribute metadata
|
@@ -2415,10 +2405,9 @@ module Orb
|
|
2415
2405
|
|
2416
2406
|
# @!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
2407
|
# Some parameter documentations has been truncated, see
|
2418
|
-
# {Orb::Models::PlanCreateParams::Price::
|
2419
|
-
# more details.
|
2408
|
+
# {Orb::Models::PlanCreateParams::Price::ThresholdTotalAmount} for more details.
|
2420
2409
|
#
|
2421
|
-
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::
|
2410
|
+
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::ThresholdTotalAmount::Cadence] The cadence to bill for this price on.
|
2422
2411
|
#
|
2423
2412
|
# @param item_id [String] The id of the item the price will be associated with.
|
2424
2413
|
#
|
@@ -2432,7 +2421,7 @@ module Orb
|
|
2432
2421
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
2433
2422
|
# ...
|
2434
2423
|
#
|
2435
|
-
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::
|
2424
|
+
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::ThresholdTotalAmount::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
2436
2425
|
# ...
|
2437
2426
|
#
|
2438
2427
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
@@ -2447,7 +2436,7 @@ module Orb
|
|
2447
2436
|
#
|
2448
2437
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
2449
2438
|
#
|
2450
|
-
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::
|
2439
|
+
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::ThresholdTotalAmount::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
2451
2440
|
# ...
|
2452
2441
|
#
|
2453
2442
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
@@ -2457,7 +2446,7 @@ module Orb
|
|
2457
2446
|
|
2458
2447
|
# The cadence to bill for this price on.
|
2459
2448
|
#
|
2460
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
2449
|
+
# @see Orb::Models::PlanCreateParams::Price::ThresholdTotalAmount#cadence
|
2461
2450
|
module Cadence
|
2462
2451
|
extend Orb::Internal::Type::Enum
|
2463
2452
|
|
@@ -2472,7 +2461,7 @@ module Orb
|
|
2472
2461
|
# @return [Array<Symbol>]
|
2473
2462
|
end
|
2474
2463
|
|
2475
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
2464
|
+
# @see Orb::Models::PlanCreateParams::Price::ThresholdTotalAmount#billing_cycle_configuration
|
2476
2465
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
2477
2466
|
# @!attribute duration
|
2478
2467
|
# The duration of the billing period.
|
@@ -2483,9 +2472,9 @@ module Orb
|
|
2483
2472
|
# @!attribute duration_unit
|
2484
2473
|
# The unit of billing period duration.
|
2485
2474
|
#
|
2486
|
-
# @return [Symbol, Orb::Models::PlanCreateParams::Price::
|
2475
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::ThresholdTotalAmount::BillingCycleConfiguration::DurationUnit]
|
2487
2476
|
required :duration_unit,
|
2488
|
-
enum: -> { Orb::Models::PlanCreateParams::Price::
|
2477
|
+
enum: -> { Orb::Models::PlanCreateParams::Price::ThresholdTotalAmount::BillingCycleConfiguration::DurationUnit }
|
2489
2478
|
|
2490
2479
|
# @!method initialize(duration:, duration_unit:)
|
2491
2480
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -2493,11 +2482,11 @@ module Orb
|
|
2493
2482
|
#
|
2494
2483
|
# @param duration [Integer] The duration of the billing period.
|
2495
2484
|
#
|
2496
|
-
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::
|
2485
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::ThresholdTotalAmount::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
2497
2486
|
|
2498
2487
|
# The unit of billing period duration.
|
2499
2488
|
#
|
2500
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
2489
|
+
# @see Orb::Models::PlanCreateParams::Price::ThresholdTotalAmount::BillingCycleConfiguration#duration_unit
|
2501
2490
|
module DurationUnit
|
2502
2491
|
extend Orb::Internal::Type::Enum
|
2503
2492
|
|
@@ -2509,7 +2498,7 @@ module Orb
|
|
2509
2498
|
end
|
2510
2499
|
end
|
2511
2500
|
|
2512
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
2501
|
+
# @see Orb::Models::PlanCreateParams::Price::ThresholdTotalAmount#invoicing_cycle_configuration
|
2513
2502
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
2514
2503
|
# @!attribute duration
|
2515
2504
|
# The duration of the billing period.
|
@@ -2520,9 +2509,9 @@ module Orb
|
|
2520
2509
|
# @!attribute duration_unit
|
2521
2510
|
# The unit of billing period duration.
|
2522
2511
|
#
|
2523
|
-
# @return [Symbol, Orb::Models::PlanCreateParams::Price::
|
2512
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::ThresholdTotalAmount::InvoicingCycleConfiguration::DurationUnit]
|
2524
2513
|
required :duration_unit,
|
2525
|
-
enum: -> { Orb::Models::PlanCreateParams::Price::
|
2514
|
+
enum: -> { Orb::Models::PlanCreateParams::Price::ThresholdTotalAmount::InvoicingCycleConfiguration::DurationUnit }
|
2526
2515
|
|
2527
2516
|
# @!method initialize(duration:, duration_unit:)
|
2528
2517
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
@@ -2530,11 +2519,11 @@ module Orb
|
|
2530
2519
|
#
|
2531
2520
|
# @param duration [Integer] The duration of the billing period.
|
2532
2521
|
#
|
2533
|
-
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::
|
2522
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::ThresholdTotalAmount::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
2534
2523
|
|
2535
2524
|
# The unit of billing period duration.
|
2536
2525
|
#
|
2537
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
2526
|
+
# @see Orb::Models::PlanCreateParams::Price::ThresholdTotalAmount::InvoicingCycleConfiguration#duration_unit
|
2538
2527
|
module DurationUnit
|
2539
2528
|
extend Orb::Internal::Type::Enum
|
2540
2529
|
|
@@ -2547,12 +2536,12 @@ module Orb
|
|
2547
2536
|
end
|
2548
2537
|
end
|
2549
2538
|
|
2550
|
-
class
|
2539
|
+
class TieredPackage < Orb::Internal::Type::BaseModel
|
2551
2540
|
# @!attribute cadence
|
2552
2541
|
# The cadence to bill for this price on.
|
2553
2542
|
#
|
2554
|
-
# @return [Symbol, Orb::Models::PlanCreateParams::Price::
|
2555
|
-
required :cadence, enum: -> { Orb::Models::PlanCreateParams::Price::
|
2543
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::TieredPackage::Cadence]
|
2544
|
+
required :cadence, enum: -> { Orb::Models::PlanCreateParams::Price::TieredPackage::Cadence }
|
2556
2545
|
|
2557
2546
|
# @!attribute item_id
|
2558
2547
|
# The id of the item the price will be associated with.
|
@@ -2594,9 +2583,9 @@ module Orb
|
|
2594
2583
|
# For custom cadence: specifies the duration of the billing period in days or
|
2595
2584
|
# months.
|
2596
2585
|
#
|
2597
|
-
# @return [Orb::Models::PlanCreateParams::Price::
|
2586
|
+
# @return [Orb::Models::PlanCreateParams::Price::TieredPackage::BillingCycleConfiguration, nil]
|
2598
2587
|
optional :billing_cycle_configuration,
|
2599
|
-
-> { Orb::Models::PlanCreateParams::Price::
|
2588
|
+
-> { Orb::Models::PlanCreateParams::Price::TieredPackage::BillingCycleConfiguration },
|
2600
2589
|
nil?: true
|
2601
2590
|
|
2602
2591
|
# @!attribute conversion_rate
|
@@ -2635,9 +2624,9 @@ module Orb
|
|
2635
2624
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
2636
2625
|
# If unspecified, a single invoice is produced per billing cycle.
|
2637
2626
|
#
|
2638
|
-
# @return [Orb::Models::PlanCreateParams::Price::
|
2627
|
+
# @return [Orb::Models::PlanCreateParams::Price::TieredPackage::InvoicingCycleConfiguration, nil]
|
2639
2628
|
optional :invoicing_cycle_configuration,
|
2640
|
-
-> { Orb::Models::PlanCreateParams::Price::
|
2629
|
+
-> { Orb::Models::PlanCreateParams::Price::TieredPackage::InvoicingCycleConfiguration },
|
2641
2630
|
nil?: true
|
2642
2631
|
|
2643
2632
|
# @!attribute metadata
|
@@ -2650,10 +2639,9 @@ module Orb
|
|
2650
2639
|
|
2651
2640
|
# @!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
2641
|
# Some parameter documentations has been truncated, see
|
2653
|
-
# {Orb::Models::PlanCreateParams::Price::
|
2654
|
-
# details.
|
2642
|
+
# {Orb::Models::PlanCreateParams::Price::TieredPackage} for more details.
|
2655
2643
|
#
|
2656
|
-
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::
|
2644
|
+
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::TieredPackage::Cadence] The cadence to bill for this price on.
|
2657
2645
|
#
|
2658
2646
|
# @param item_id [String] The id of the item the price will be associated with.
|
2659
2647
|
#
|
@@ -2667,7 +2655,7 @@ module Orb
|
|
2667
2655
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
2668
2656
|
# ...
|
2669
2657
|
#
|
2670
|
-
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::
|
2658
|
+
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::TieredPackage::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
2671
2659
|
# ...
|
2672
2660
|
#
|
2673
2661
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
@@ -2682,7 +2670,7 @@ module Orb
|
|
2682
2670
|
#
|
2683
2671
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
2684
2672
|
#
|
2685
|
-
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::
|
2673
|
+
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::TieredPackage::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
2686
2674
|
# ...
|
2687
2675
|
#
|
2688
2676
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
@@ -2692,7 +2680,7 @@ module Orb
|
|
2692
2680
|
|
2693
2681
|
# The cadence to bill for this price on.
|
2694
2682
|
#
|
2695
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
2683
|
+
# @see Orb::Models::PlanCreateParams::Price::TieredPackage#cadence
|
2696
2684
|
module Cadence
|
2697
2685
|
extend Orb::Internal::Type::Enum
|
2698
2686
|
|
@@ -2707,7 +2695,7 @@ module Orb
|
|
2707
2695
|
# @return [Array<Symbol>]
|
2708
2696
|
end
|
2709
2697
|
|
2710
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
2698
|
+
# @see Orb::Models::PlanCreateParams::Price::TieredPackage#billing_cycle_configuration
|
2711
2699
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
2712
2700
|
# @!attribute duration
|
2713
2701
|
# The duration of the billing period.
|
@@ -2718,9 +2706,9 @@ module Orb
|
|
2718
2706
|
# @!attribute duration_unit
|
2719
2707
|
# The unit of billing period duration.
|
2720
2708
|
#
|
2721
|
-
# @return [Symbol, Orb::Models::PlanCreateParams::Price::
|
2709
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::TieredPackage::BillingCycleConfiguration::DurationUnit]
|
2722
2710
|
required :duration_unit,
|
2723
|
-
enum: -> { Orb::Models::PlanCreateParams::Price::
|
2711
|
+
enum: -> { Orb::Models::PlanCreateParams::Price::TieredPackage::BillingCycleConfiguration::DurationUnit }
|
2724
2712
|
|
2725
2713
|
# @!method initialize(duration:, duration_unit:)
|
2726
2714
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -2728,11 +2716,11 @@ module Orb
|
|
2728
2716
|
#
|
2729
2717
|
# @param duration [Integer] The duration of the billing period.
|
2730
2718
|
#
|
2731
|
-
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::
|
2719
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::TieredPackage::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
2732
2720
|
|
2733
2721
|
# The unit of billing period duration.
|
2734
2722
|
#
|
2735
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
2723
|
+
# @see Orb::Models::PlanCreateParams::Price::TieredPackage::BillingCycleConfiguration#duration_unit
|
2736
2724
|
module DurationUnit
|
2737
2725
|
extend Orb::Internal::Type::Enum
|
2738
2726
|
|
@@ -2744,7 +2732,7 @@ module Orb
|
|
2744
2732
|
end
|
2745
2733
|
end
|
2746
2734
|
|
2747
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
2735
|
+
# @see Orb::Models::PlanCreateParams::Price::TieredPackage#invoicing_cycle_configuration
|
2748
2736
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
2749
2737
|
# @!attribute duration
|
2750
2738
|
# The duration of the billing period.
|
@@ -2755,9 +2743,9 @@ module Orb
|
|
2755
2743
|
# @!attribute duration_unit
|
2756
2744
|
# The unit of billing period duration.
|
2757
2745
|
#
|
2758
|
-
# @return [Symbol, Orb::Models::PlanCreateParams::Price::
|
2746
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::TieredPackage::InvoicingCycleConfiguration::DurationUnit]
|
2759
2747
|
required :duration_unit,
|
2760
|
-
enum: -> { Orb::Models::PlanCreateParams::Price::
|
2748
|
+
enum: -> { Orb::Models::PlanCreateParams::Price::TieredPackage::InvoicingCycleConfiguration::DurationUnit }
|
2761
2749
|
|
2762
2750
|
# @!method initialize(duration:, duration_unit:)
|
2763
2751
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
@@ -2765,11 +2753,11 @@ module Orb
|
|
2765
2753
|
#
|
2766
2754
|
# @param duration [Integer] The duration of the billing period.
|
2767
2755
|
#
|
2768
|
-
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::
|
2756
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::TieredPackage::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
2769
2757
|
|
2770
2758
|
# The unit of billing period duration.
|
2771
2759
|
#
|
2772
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
2760
|
+
# @see Orb::Models::PlanCreateParams::Price::TieredPackage::InvoicingCycleConfiguration#duration_unit
|
2773
2761
|
module DurationUnit
|
2774
2762
|
extend Orb::Internal::Type::Enum
|
2775
2763
|
|
@@ -2782,13 +2770,12 @@ module Orb
|
|
2782
2770
|
end
|
2783
2771
|
end
|
2784
2772
|
|
2785
|
-
class
|
2773
|
+
class TieredWithMinimum < Orb::Internal::Type::BaseModel
|
2786
2774
|
# @!attribute cadence
|
2787
2775
|
# The cadence to bill for this price on.
|
2788
2776
|
#
|
2789
|
-
# @return [Symbol, Orb::Models::PlanCreateParams::Price::
|
2790
|
-
required :cadence,
|
2791
|
-
enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanTieredWithMinimumPrice::Cadence }
|
2777
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::TieredWithMinimum::Cadence]
|
2778
|
+
required :cadence, enum: -> { Orb::Models::PlanCreateParams::Price::TieredWithMinimum::Cadence }
|
2792
2779
|
|
2793
2780
|
# @!attribute item_id
|
2794
2781
|
# The id of the item the price will be associated with.
|
@@ -2830,9 +2817,9 @@ module Orb
|
|
2830
2817
|
# For custom cadence: specifies the duration of the billing period in days or
|
2831
2818
|
# months.
|
2832
2819
|
#
|
2833
|
-
# @return [Orb::Models::PlanCreateParams::Price::
|
2820
|
+
# @return [Orb::Models::PlanCreateParams::Price::TieredWithMinimum::BillingCycleConfiguration, nil]
|
2834
2821
|
optional :billing_cycle_configuration,
|
2835
|
-
-> { Orb::Models::PlanCreateParams::Price::
|
2822
|
+
-> { Orb::Models::PlanCreateParams::Price::TieredWithMinimum::BillingCycleConfiguration },
|
2836
2823
|
nil?: true
|
2837
2824
|
|
2838
2825
|
# @!attribute conversion_rate
|
@@ -2871,9 +2858,9 @@ module Orb
|
|
2871
2858
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
2872
2859
|
# If unspecified, a single invoice is produced per billing cycle.
|
2873
2860
|
#
|
2874
|
-
# @return [Orb::Models::PlanCreateParams::Price::
|
2861
|
+
# @return [Orb::Models::PlanCreateParams::Price::TieredWithMinimum::InvoicingCycleConfiguration, nil]
|
2875
2862
|
optional :invoicing_cycle_configuration,
|
2876
|
-
-> { Orb::Models::PlanCreateParams::Price::
|
2863
|
+
-> { Orb::Models::PlanCreateParams::Price::TieredWithMinimum::InvoicingCycleConfiguration },
|
2877
2864
|
nil?: true
|
2878
2865
|
|
2879
2866
|
# @!attribute metadata
|
@@ -2886,10 +2873,9 @@ module Orb
|
|
2886
2873
|
|
2887
2874
|
# @!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
2875
|
# Some parameter documentations has been truncated, see
|
2889
|
-
# {Orb::Models::PlanCreateParams::Price::
|
2890
|
-
# details.
|
2876
|
+
# {Orb::Models::PlanCreateParams::Price::TieredWithMinimum} for more details.
|
2891
2877
|
#
|
2892
|
-
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::
|
2878
|
+
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::TieredWithMinimum::Cadence] The cadence to bill for this price on.
|
2893
2879
|
#
|
2894
2880
|
# @param item_id [String] The id of the item the price will be associated with.
|
2895
2881
|
#
|
@@ -2903,7 +2889,7 @@ module Orb
|
|
2903
2889
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
2904
2890
|
# ...
|
2905
2891
|
#
|
2906
|
-
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::
|
2892
|
+
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::TieredWithMinimum::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
2907
2893
|
# ...
|
2908
2894
|
#
|
2909
2895
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
@@ -2918,7 +2904,7 @@ module Orb
|
|
2918
2904
|
#
|
2919
2905
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
2920
2906
|
#
|
2921
|
-
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::
|
2907
|
+
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::TieredWithMinimum::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
2922
2908
|
# ...
|
2923
2909
|
#
|
2924
2910
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
@@ -2928,7 +2914,7 @@ module Orb
|
|
2928
2914
|
|
2929
2915
|
# The cadence to bill for this price on.
|
2930
2916
|
#
|
2931
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
2917
|
+
# @see Orb::Models::PlanCreateParams::Price::TieredWithMinimum#cadence
|
2932
2918
|
module Cadence
|
2933
2919
|
extend Orb::Internal::Type::Enum
|
2934
2920
|
|
@@ -2943,7 +2929,7 @@ module Orb
|
|
2943
2929
|
# @return [Array<Symbol>]
|
2944
2930
|
end
|
2945
2931
|
|
2946
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
2932
|
+
# @see Orb::Models::PlanCreateParams::Price::TieredWithMinimum#billing_cycle_configuration
|
2947
2933
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
2948
2934
|
# @!attribute duration
|
2949
2935
|
# The duration of the billing period.
|
@@ -2954,9 +2940,9 @@ module Orb
|
|
2954
2940
|
# @!attribute duration_unit
|
2955
2941
|
# The unit of billing period duration.
|
2956
2942
|
#
|
2957
|
-
# @return [Symbol, Orb::Models::PlanCreateParams::Price::
|
2943
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::TieredWithMinimum::BillingCycleConfiguration::DurationUnit]
|
2958
2944
|
required :duration_unit,
|
2959
|
-
enum: -> { Orb::Models::PlanCreateParams::Price::
|
2945
|
+
enum: -> { Orb::Models::PlanCreateParams::Price::TieredWithMinimum::BillingCycleConfiguration::DurationUnit }
|
2960
2946
|
|
2961
2947
|
# @!method initialize(duration:, duration_unit:)
|
2962
2948
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -2964,11 +2950,11 @@ module Orb
|
|
2964
2950
|
#
|
2965
2951
|
# @param duration [Integer] The duration of the billing period.
|
2966
2952
|
#
|
2967
|
-
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::
|
2953
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::TieredWithMinimum::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
2968
2954
|
|
2969
2955
|
# The unit of billing period duration.
|
2970
2956
|
#
|
2971
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
2957
|
+
# @see Orb::Models::PlanCreateParams::Price::TieredWithMinimum::BillingCycleConfiguration#duration_unit
|
2972
2958
|
module DurationUnit
|
2973
2959
|
extend Orb::Internal::Type::Enum
|
2974
2960
|
|
@@ -2980,7 +2966,7 @@ module Orb
|
|
2980
2966
|
end
|
2981
2967
|
end
|
2982
2968
|
|
2983
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
2969
|
+
# @see Orb::Models::PlanCreateParams::Price::TieredWithMinimum#invoicing_cycle_configuration
|
2984
2970
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
2985
2971
|
# @!attribute duration
|
2986
2972
|
# The duration of the billing period.
|
@@ -2991,9 +2977,9 @@ module Orb
|
|
2991
2977
|
# @!attribute duration_unit
|
2992
2978
|
# The unit of billing period duration.
|
2993
2979
|
#
|
2994
|
-
# @return [Symbol, Orb::Models::PlanCreateParams::Price::
|
2980
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::TieredWithMinimum::InvoicingCycleConfiguration::DurationUnit]
|
2995
2981
|
required :duration_unit,
|
2996
|
-
enum: -> { Orb::Models::PlanCreateParams::Price::
|
2982
|
+
enum: -> { Orb::Models::PlanCreateParams::Price::TieredWithMinimum::InvoicingCycleConfiguration::DurationUnit }
|
2997
2983
|
|
2998
2984
|
# @!method initialize(duration:, duration_unit:)
|
2999
2985
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
@@ -3001,11 +2987,11 @@ module Orb
|
|
3001
2987
|
#
|
3002
2988
|
# @param duration [Integer] The duration of the billing period.
|
3003
2989
|
#
|
3004
|
-
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::
|
2990
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::TieredWithMinimum::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
3005
2991
|
|
3006
2992
|
# The unit of billing period duration.
|
3007
2993
|
#
|
3008
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
2994
|
+
# @see Orb::Models::PlanCreateParams::Price::TieredWithMinimum::InvoicingCycleConfiguration#duration_unit
|
3009
2995
|
module DurationUnit
|
3010
2996
|
extend Orb::Internal::Type::Enum
|
3011
2997
|
|
@@ -3018,12 +3004,12 @@ module Orb
|
|
3018
3004
|
end
|
3019
3005
|
end
|
3020
3006
|
|
3021
|
-
class
|
3007
|
+
class UnitWithPercent < Orb::Internal::Type::BaseModel
|
3022
3008
|
# @!attribute cadence
|
3023
3009
|
# The cadence to bill for this price on.
|
3024
3010
|
#
|
3025
|
-
# @return [Symbol, Orb::Models::PlanCreateParams::Price::
|
3026
|
-
required :cadence, enum: -> { Orb::Models::PlanCreateParams::Price::
|
3011
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::UnitWithPercent::Cadence]
|
3012
|
+
required :cadence, enum: -> { Orb::Models::PlanCreateParams::Price::UnitWithPercent::Cadence }
|
3027
3013
|
|
3028
3014
|
# @!attribute item_id
|
3029
3015
|
# The id of the item the price will be associated with.
|
@@ -3065,9 +3051,9 @@ module Orb
|
|
3065
3051
|
# For custom cadence: specifies the duration of the billing period in days or
|
3066
3052
|
# months.
|
3067
3053
|
#
|
3068
|
-
# @return [Orb::Models::PlanCreateParams::Price::
|
3054
|
+
# @return [Orb::Models::PlanCreateParams::Price::UnitWithPercent::BillingCycleConfiguration, nil]
|
3069
3055
|
optional :billing_cycle_configuration,
|
3070
|
-
-> { Orb::Models::PlanCreateParams::Price::
|
3056
|
+
-> { Orb::Models::PlanCreateParams::Price::UnitWithPercent::BillingCycleConfiguration },
|
3071
3057
|
nil?: true
|
3072
3058
|
|
3073
3059
|
# @!attribute conversion_rate
|
@@ -3106,9 +3092,9 @@ module Orb
|
|
3106
3092
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
3107
3093
|
# If unspecified, a single invoice is produced per billing cycle.
|
3108
3094
|
#
|
3109
|
-
# @return [Orb::Models::PlanCreateParams::Price::
|
3095
|
+
# @return [Orb::Models::PlanCreateParams::Price::UnitWithPercent::InvoicingCycleConfiguration, nil]
|
3110
3096
|
optional :invoicing_cycle_configuration,
|
3111
|
-
-> { Orb::Models::PlanCreateParams::Price::
|
3097
|
+
-> { Orb::Models::PlanCreateParams::Price::UnitWithPercent::InvoicingCycleConfiguration },
|
3112
3098
|
nil?: true
|
3113
3099
|
|
3114
3100
|
# @!attribute metadata
|
@@ -3121,10 +3107,9 @@ module Orb
|
|
3121
3107
|
|
3122
3108
|
# @!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
3109
|
# Some parameter documentations has been truncated, see
|
3124
|
-
# {Orb::Models::PlanCreateParams::Price::
|
3125
|
-
# details.
|
3110
|
+
# {Orb::Models::PlanCreateParams::Price::UnitWithPercent} for more details.
|
3126
3111
|
#
|
3127
|
-
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::
|
3112
|
+
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::UnitWithPercent::Cadence] The cadence to bill for this price on.
|
3128
3113
|
#
|
3129
3114
|
# @param item_id [String] The id of the item the price will be associated with.
|
3130
3115
|
#
|
@@ -3138,7 +3123,7 @@ module Orb
|
|
3138
3123
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
3139
3124
|
# ...
|
3140
3125
|
#
|
3141
|
-
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::
|
3126
|
+
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::UnitWithPercent::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
3142
3127
|
# ...
|
3143
3128
|
#
|
3144
3129
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
@@ -3153,7 +3138,7 @@ module Orb
|
|
3153
3138
|
#
|
3154
3139
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
3155
3140
|
#
|
3156
|
-
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::
|
3141
|
+
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::UnitWithPercent::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
3157
3142
|
# ...
|
3158
3143
|
#
|
3159
3144
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
@@ -3163,7 +3148,7 @@ module Orb
|
|
3163
3148
|
|
3164
3149
|
# The cadence to bill for this price on.
|
3165
3150
|
#
|
3166
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
3151
|
+
# @see Orb::Models::PlanCreateParams::Price::UnitWithPercent#cadence
|
3167
3152
|
module Cadence
|
3168
3153
|
extend Orb::Internal::Type::Enum
|
3169
3154
|
|
@@ -3178,7 +3163,7 @@ module Orb
|
|
3178
3163
|
# @return [Array<Symbol>]
|
3179
3164
|
end
|
3180
3165
|
|
3181
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
3166
|
+
# @see Orb::Models::PlanCreateParams::Price::UnitWithPercent#billing_cycle_configuration
|
3182
3167
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
3183
3168
|
# @!attribute duration
|
3184
3169
|
# The duration of the billing period.
|
@@ -3189,9 +3174,9 @@ module Orb
|
|
3189
3174
|
# @!attribute duration_unit
|
3190
3175
|
# The unit of billing period duration.
|
3191
3176
|
#
|
3192
|
-
# @return [Symbol, Orb::Models::PlanCreateParams::Price::
|
3177
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::UnitWithPercent::BillingCycleConfiguration::DurationUnit]
|
3193
3178
|
required :duration_unit,
|
3194
|
-
enum: -> { Orb::Models::PlanCreateParams::Price::
|
3179
|
+
enum: -> { Orb::Models::PlanCreateParams::Price::UnitWithPercent::BillingCycleConfiguration::DurationUnit }
|
3195
3180
|
|
3196
3181
|
# @!method initialize(duration:, duration_unit:)
|
3197
3182
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -3199,11 +3184,11 @@ module Orb
|
|
3199
3184
|
#
|
3200
3185
|
# @param duration [Integer] The duration of the billing period.
|
3201
3186
|
#
|
3202
|
-
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::
|
3187
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::UnitWithPercent::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
3203
3188
|
|
3204
3189
|
# The unit of billing period duration.
|
3205
3190
|
#
|
3206
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
3191
|
+
# @see Orb::Models::PlanCreateParams::Price::UnitWithPercent::BillingCycleConfiguration#duration_unit
|
3207
3192
|
module DurationUnit
|
3208
3193
|
extend Orb::Internal::Type::Enum
|
3209
3194
|
|
@@ -3215,7 +3200,7 @@ module Orb
|
|
3215
3200
|
end
|
3216
3201
|
end
|
3217
3202
|
|
3218
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
3203
|
+
# @see Orb::Models::PlanCreateParams::Price::UnitWithPercent#invoicing_cycle_configuration
|
3219
3204
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
3220
3205
|
# @!attribute duration
|
3221
3206
|
# The duration of the billing period.
|
@@ -3226,9 +3211,9 @@ module Orb
|
|
3226
3211
|
# @!attribute duration_unit
|
3227
3212
|
# The unit of billing period duration.
|
3228
3213
|
#
|
3229
|
-
# @return [Symbol, Orb::Models::PlanCreateParams::Price::
|
3214
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::UnitWithPercent::InvoicingCycleConfiguration::DurationUnit]
|
3230
3215
|
required :duration_unit,
|
3231
|
-
enum: -> { Orb::Models::PlanCreateParams::Price::
|
3216
|
+
enum: -> { Orb::Models::PlanCreateParams::Price::UnitWithPercent::InvoicingCycleConfiguration::DurationUnit }
|
3232
3217
|
|
3233
3218
|
# @!method initialize(duration:, duration_unit:)
|
3234
3219
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
@@ -3236,11 +3221,11 @@ module Orb
|
|
3236
3221
|
#
|
3237
3222
|
# @param duration [Integer] The duration of the billing period.
|
3238
3223
|
#
|
3239
|
-
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::
|
3224
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::UnitWithPercent::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
3240
3225
|
|
3241
3226
|
# The unit of billing period duration.
|
3242
3227
|
#
|
3243
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
3228
|
+
# @see Orb::Models::PlanCreateParams::Price::UnitWithPercent::InvoicingCycleConfiguration#duration_unit
|
3244
3229
|
module DurationUnit
|
3245
3230
|
extend Orb::Internal::Type::Enum
|
3246
3231
|
|
@@ -3253,13 +3238,12 @@ module Orb
|
|
3253
3238
|
end
|
3254
3239
|
end
|
3255
3240
|
|
3256
|
-
class
|
3241
|
+
class PackageWithAllocation < Orb::Internal::Type::BaseModel
|
3257
3242
|
# @!attribute cadence
|
3258
3243
|
# The cadence to bill for this price on.
|
3259
3244
|
#
|
3260
|
-
# @return [Symbol, Orb::Models::PlanCreateParams::Price::
|
3261
|
-
required :cadence,
|
3262
|
-
enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanPackageWithAllocationPrice::Cadence }
|
3245
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::PackageWithAllocation::Cadence]
|
3246
|
+
required :cadence, enum: -> { Orb::Models::PlanCreateParams::Price::PackageWithAllocation::Cadence }
|
3263
3247
|
|
3264
3248
|
# @!attribute item_id
|
3265
3249
|
# The id of the item the price will be associated with.
|
@@ -3301,9 +3285,9 @@ module Orb
|
|
3301
3285
|
# For custom cadence: specifies the duration of the billing period in days or
|
3302
3286
|
# months.
|
3303
3287
|
#
|
3304
|
-
# @return [Orb::Models::PlanCreateParams::Price::
|
3288
|
+
# @return [Orb::Models::PlanCreateParams::Price::PackageWithAllocation::BillingCycleConfiguration, nil]
|
3305
3289
|
optional :billing_cycle_configuration,
|
3306
|
-
-> { Orb::Models::PlanCreateParams::Price::
|
3290
|
+
-> { Orb::Models::PlanCreateParams::Price::PackageWithAllocation::BillingCycleConfiguration },
|
3307
3291
|
nil?: true
|
3308
3292
|
|
3309
3293
|
# @!attribute conversion_rate
|
@@ -3342,9 +3326,9 @@ module Orb
|
|
3342
3326
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
3343
3327
|
# If unspecified, a single invoice is produced per billing cycle.
|
3344
3328
|
#
|
3345
|
-
# @return [Orb::Models::PlanCreateParams::Price::
|
3329
|
+
# @return [Orb::Models::PlanCreateParams::Price::PackageWithAllocation::InvoicingCycleConfiguration, nil]
|
3346
3330
|
optional :invoicing_cycle_configuration,
|
3347
|
-
-> { Orb::Models::PlanCreateParams::Price::
|
3331
|
+
-> { Orb::Models::PlanCreateParams::Price::PackageWithAllocation::InvoicingCycleConfiguration },
|
3348
3332
|
nil?: true
|
3349
3333
|
|
3350
3334
|
# @!attribute metadata
|
@@ -3357,10 +3341,9 @@ module Orb
|
|
3357
3341
|
|
3358
3342
|
# @!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
3343
|
# Some parameter documentations has been truncated, see
|
3360
|
-
# {Orb::Models::PlanCreateParams::Price::
|
3361
|
-
# more details.
|
3344
|
+
# {Orb::Models::PlanCreateParams::Price::PackageWithAllocation} for more details.
|
3362
3345
|
#
|
3363
|
-
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::
|
3346
|
+
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::PackageWithAllocation::Cadence] The cadence to bill for this price on.
|
3364
3347
|
#
|
3365
3348
|
# @param item_id [String] The id of the item the price will be associated with.
|
3366
3349
|
#
|
@@ -3374,7 +3357,7 @@ module Orb
|
|
3374
3357
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
3375
3358
|
# ...
|
3376
3359
|
#
|
3377
|
-
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::
|
3360
|
+
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::PackageWithAllocation::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
3378
3361
|
# ...
|
3379
3362
|
#
|
3380
3363
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
@@ -3389,7 +3372,7 @@ module Orb
|
|
3389
3372
|
#
|
3390
3373
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
3391
3374
|
#
|
3392
|
-
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::
|
3375
|
+
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::PackageWithAllocation::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
3393
3376
|
# ...
|
3394
3377
|
#
|
3395
3378
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
@@ -3399,7 +3382,7 @@ module Orb
|
|
3399
3382
|
|
3400
3383
|
# The cadence to bill for this price on.
|
3401
3384
|
#
|
3402
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
3385
|
+
# @see Orb::Models::PlanCreateParams::Price::PackageWithAllocation#cadence
|
3403
3386
|
module Cadence
|
3404
3387
|
extend Orb::Internal::Type::Enum
|
3405
3388
|
|
@@ -3414,7 +3397,7 @@ module Orb
|
|
3414
3397
|
# @return [Array<Symbol>]
|
3415
3398
|
end
|
3416
3399
|
|
3417
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
3400
|
+
# @see Orb::Models::PlanCreateParams::Price::PackageWithAllocation#billing_cycle_configuration
|
3418
3401
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
3419
3402
|
# @!attribute duration
|
3420
3403
|
# The duration of the billing period.
|
@@ -3425,9 +3408,9 @@ module Orb
|
|
3425
3408
|
# @!attribute duration_unit
|
3426
3409
|
# The unit of billing period duration.
|
3427
3410
|
#
|
3428
|
-
# @return [Symbol, Orb::Models::PlanCreateParams::Price::
|
3411
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::PackageWithAllocation::BillingCycleConfiguration::DurationUnit]
|
3429
3412
|
required :duration_unit,
|
3430
|
-
enum: -> { Orb::Models::PlanCreateParams::Price::
|
3413
|
+
enum: -> { Orb::Models::PlanCreateParams::Price::PackageWithAllocation::BillingCycleConfiguration::DurationUnit }
|
3431
3414
|
|
3432
3415
|
# @!method initialize(duration:, duration_unit:)
|
3433
3416
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -3435,11 +3418,11 @@ module Orb
|
|
3435
3418
|
#
|
3436
3419
|
# @param duration [Integer] The duration of the billing period.
|
3437
3420
|
#
|
3438
|
-
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::
|
3421
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::PackageWithAllocation::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
3439
3422
|
|
3440
3423
|
# The unit of billing period duration.
|
3441
3424
|
#
|
3442
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
3425
|
+
# @see Orb::Models::PlanCreateParams::Price::PackageWithAllocation::BillingCycleConfiguration#duration_unit
|
3443
3426
|
module DurationUnit
|
3444
3427
|
extend Orb::Internal::Type::Enum
|
3445
3428
|
|
@@ -3451,7 +3434,7 @@ module Orb
|
|
3451
3434
|
end
|
3452
3435
|
end
|
3453
3436
|
|
3454
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
3437
|
+
# @see Orb::Models::PlanCreateParams::Price::PackageWithAllocation#invoicing_cycle_configuration
|
3455
3438
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
3456
3439
|
# @!attribute duration
|
3457
3440
|
# The duration of the billing period.
|
@@ -3462,9 +3445,9 @@ module Orb
|
|
3462
3445
|
# @!attribute duration_unit
|
3463
3446
|
# The unit of billing period duration.
|
3464
3447
|
#
|
3465
|
-
# @return [Symbol, Orb::Models::PlanCreateParams::Price::
|
3448
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::PackageWithAllocation::InvoicingCycleConfiguration::DurationUnit]
|
3466
3449
|
required :duration_unit,
|
3467
|
-
enum: -> { Orb::Models::PlanCreateParams::Price::
|
3450
|
+
enum: -> { Orb::Models::PlanCreateParams::Price::PackageWithAllocation::InvoicingCycleConfiguration::DurationUnit }
|
3468
3451
|
|
3469
3452
|
# @!method initialize(duration:, duration_unit:)
|
3470
3453
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
@@ -3472,11 +3455,11 @@ module Orb
|
|
3472
3455
|
#
|
3473
3456
|
# @param duration [Integer] The duration of the billing period.
|
3474
3457
|
#
|
3475
|
-
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::
|
3458
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::PackageWithAllocation::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
3476
3459
|
|
3477
3460
|
# The unit of billing period duration.
|
3478
3461
|
#
|
3479
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
3462
|
+
# @see Orb::Models::PlanCreateParams::Price::PackageWithAllocation::InvoicingCycleConfiguration#duration_unit
|
3480
3463
|
module DurationUnit
|
3481
3464
|
extend Orb::Internal::Type::Enum
|
3482
3465
|
|
@@ -3489,13 +3472,12 @@ module Orb
|
|
3489
3472
|
end
|
3490
3473
|
end
|
3491
3474
|
|
3492
|
-
class
|
3475
|
+
class TieredWithProration < Orb::Internal::Type::BaseModel
|
3493
3476
|
# @!attribute cadence
|
3494
3477
|
# The cadence to bill for this price on.
|
3495
3478
|
#
|
3496
|
-
# @return [Symbol, Orb::Models::PlanCreateParams::Price::
|
3497
|
-
required :cadence,
|
3498
|
-
enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanTierWithProrationPrice::Cadence }
|
3479
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::TieredWithProration::Cadence]
|
3480
|
+
required :cadence, enum: -> { Orb::Models::PlanCreateParams::Price::TieredWithProration::Cadence }
|
3499
3481
|
|
3500
3482
|
# @!attribute item_id
|
3501
3483
|
# The id of the item the price will be associated with.
|
@@ -3537,9 +3519,9 @@ module Orb
|
|
3537
3519
|
# For custom cadence: specifies the duration of the billing period in days or
|
3538
3520
|
# months.
|
3539
3521
|
#
|
3540
|
-
# @return [Orb::Models::PlanCreateParams::Price::
|
3522
|
+
# @return [Orb::Models::PlanCreateParams::Price::TieredWithProration::BillingCycleConfiguration, nil]
|
3541
3523
|
optional :billing_cycle_configuration,
|
3542
|
-
-> { Orb::Models::PlanCreateParams::Price::
|
3524
|
+
-> { Orb::Models::PlanCreateParams::Price::TieredWithProration::BillingCycleConfiguration },
|
3543
3525
|
nil?: true
|
3544
3526
|
|
3545
3527
|
# @!attribute conversion_rate
|
@@ -3578,9 +3560,9 @@ module Orb
|
|
3578
3560
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
3579
3561
|
# If unspecified, a single invoice is produced per billing cycle.
|
3580
3562
|
#
|
3581
|
-
# @return [Orb::Models::PlanCreateParams::Price::
|
3563
|
+
# @return [Orb::Models::PlanCreateParams::Price::TieredWithProration::InvoicingCycleConfiguration, nil]
|
3582
3564
|
optional :invoicing_cycle_configuration,
|
3583
|
-
-> { Orb::Models::PlanCreateParams::Price::
|
3565
|
+
-> { Orb::Models::PlanCreateParams::Price::TieredWithProration::InvoicingCycleConfiguration },
|
3584
3566
|
nil?: true
|
3585
3567
|
|
3586
3568
|
# @!attribute metadata
|
@@ -3593,10 +3575,9 @@ module Orb
|
|
3593
3575
|
|
3594
3576
|
# @!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
3577
|
# Some parameter documentations has been truncated, see
|
3596
|
-
# {Orb::Models::PlanCreateParams::Price::
|
3597
|
-
# details.
|
3578
|
+
# {Orb::Models::PlanCreateParams::Price::TieredWithProration} for more details.
|
3598
3579
|
#
|
3599
|
-
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::
|
3580
|
+
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::TieredWithProration::Cadence] The cadence to bill for this price on.
|
3600
3581
|
#
|
3601
3582
|
# @param item_id [String] The id of the item the price will be associated with.
|
3602
3583
|
#
|
@@ -3610,7 +3591,7 @@ module Orb
|
|
3610
3591
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
3611
3592
|
# ...
|
3612
3593
|
#
|
3613
|
-
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::
|
3594
|
+
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::TieredWithProration::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
3614
3595
|
# ...
|
3615
3596
|
#
|
3616
3597
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
@@ -3625,7 +3606,7 @@ module Orb
|
|
3625
3606
|
#
|
3626
3607
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
3627
3608
|
#
|
3628
|
-
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::
|
3609
|
+
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::TieredWithProration::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
3629
3610
|
# ...
|
3630
3611
|
#
|
3631
3612
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
@@ -3635,7 +3616,7 @@ module Orb
|
|
3635
3616
|
|
3636
3617
|
# The cadence to bill for this price on.
|
3637
3618
|
#
|
3638
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
3619
|
+
# @see Orb::Models::PlanCreateParams::Price::TieredWithProration#cadence
|
3639
3620
|
module Cadence
|
3640
3621
|
extend Orb::Internal::Type::Enum
|
3641
3622
|
|
@@ -3650,7 +3631,7 @@ module Orb
|
|
3650
3631
|
# @return [Array<Symbol>]
|
3651
3632
|
end
|
3652
3633
|
|
3653
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
3634
|
+
# @see Orb::Models::PlanCreateParams::Price::TieredWithProration#billing_cycle_configuration
|
3654
3635
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
3655
3636
|
# @!attribute duration
|
3656
3637
|
# The duration of the billing period.
|
@@ -3661,9 +3642,9 @@ module Orb
|
|
3661
3642
|
# @!attribute duration_unit
|
3662
3643
|
# The unit of billing period duration.
|
3663
3644
|
#
|
3664
|
-
# @return [Symbol, Orb::Models::PlanCreateParams::Price::
|
3645
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::TieredWithProration::BillingCycleConfiguration::DurationUnit]
|
3665
3646
|
required :duration_unit,
|
3666
|
-
enum: -> { Orb::Models::PlanCreateParams::Price::
|
3647
|
+
enum: -> { Orb::Models::PlanCreateParams::Price::TieredWithProration::BillingCycleConfiguration::DurationUnit }
|
3667
3648
|
|
3668
3649
|
# @!method initialize(duration:, duration_unit:)
|
3669
3650
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -3671,11 +3652,11 @@ module Orb
|
|
3671
3652
|
#
|
3672
3653
|
# @param duration [Integer] The duration of the billing period.
|
3673
3654
|
#
|
3674
|
-
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::
|
3655
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::TieredWithProration::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
3675
3656
|
|
3676
3657
|
# The unit of billing period duration.
|
3677
3658
|
#
|
3678
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
3659
|
+
# @see Orb::Models::PlanCreateParams::Price::TieredWithProration::BillingCycleConfiguration#duration_unit
|
3679
3660
|
module DurationUnit
|
3680
3661
|
extend Orb::Internal::Type::Enum
|
3681
3662
|
|
@@ -3687,7 +3668,7 @@ module Orb
|
|
3687
3668
|
end
|
3688
3669
|
end
|
3689
3670
|
|
3690
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
3671
|
+
# @see Orb::Models::PlanCreateParams::Price::TieredWithProration#invoicing_cycle_configuration
|
3691
3672
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
3692
3673
|
# @!attribute duration
|
3693
3674
|
# The duration of the billing period.
|
@@ -3698,9 +3679,9 @@ module Orb
|
|
3698
3679
|
# @!attribute duration_unit
|
3699
3680
|
# The unit of billing period duration.
|
3700
3681
|
#
|
3701
|
-
# @return [Symbol, Orb::Models::PlanCreateParams::Price::
|
3682
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::TieredWithProration::InvoicingCycleConfiguration::DurationUnit]
|
3702
3683
|
required :duration_unit,
|
3703
|
-
enum: -> { Orb::Models::PlanCreateParams::Price::
|
3684
|
+
enum: -> { Orb::Models::PlanCreateParams::Price::TieredWithProration::InvoicingCycleConfiguration::DurationUnit }
|
3704
3685
|
|
3705
3686
|
# @!method initialize(duration:, duration_unit:)
|
3706
3687
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
@@ -3708,11 +3689,11 @@ module Orb
|
|
3708
3689
|
#
|
3709
3690
|
# @param duration [Integer] The duration of the billing period.
|
3710
3691
|
#
|
3711
|
-
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::
|
3692
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::TieredWithProration::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
3712
3693
|
|
3713
3694
|
# The unit of billing period duration.
|
3714
3695
|
#
|
3715
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
3696
|
+
# @see Orb::Models::PlanCreateParams::Price::TieredWithProration::InvoicingCycleConfiguration#duration_unit
|
3716
3697
|
module DurationUnit
|
3717
3698
|
extend Orb::Internal::Type::Enum
|
3718
3699
|
|
@@ -3725,13 +3706,12 @@ module Orb
|
|
3725
3706
|
end
|
3726
3707
|
end
|
3727
3708
|
|
3728
|
-
class
|
3709
|
+
class UnitWithProration < Orb::Internal::Type::BaseModel
|
3729
3710
|
# @!attribute cadence
|
3730
3711
|
# The cadence to bill for this price on.
|
3731
3712
|
#
|
3732
|
-
# @return [Symbol, Orb::Models::PlanCreateParams::Price::
|
3733
|
-
required :cadence,
|
3734
|
-
enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanUnitWithProrationPrice::Cadence }
|
3713
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::UnitWithProration::Cadence]
|
3714
|
+
required :cadence, enum: -> { Orb::Models::PlanCreateParams::Price::UnitWithProration::Cadence }
|
3735
3715
|
|
3736
3716
|
# @!attribute item_id
|
3737
3717
|
# The id of the item the price will be associated with.
|
@@ -3773,9 +3753,9 @@ module Orb
|
|
3773
3753
|
# For custom cadence: specifies the duration of the billing period in days or
|
3774
3754
|
# months.
|
3775
3755
|
#
|
3776
|
-
# @return [Orb::Models::PlanCreateParams::Price::
|
3756
|
+
# @return [Orb::Models::PlanCreateParams::Price::UnitWithProration::BillingCycleConfiguration, nil]
|
3777
3757
|
optional :billing_cycle_configuration,
|
3778
|
-
-> { Orb::Models::PlanCreateParams::Price::
|
3758
|
+
-> { Orb::Models::PlanCreateParams::Price::UnitWithProration::BillingCycleConfiguration },
|
3779
3759
|
nil?: true
|
3780
3760
|
|
3781
3761
|
# @!attribute conversion_rate
|
@@ -3814,9 +3794,9 @@ module Orb
|
|
3814
3794
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
3815
3795
|
# If unspecified, a single invoice is produced per billing cycle.
|
3816
3796
|
#
|
3817
|
-
# @return [Orb::Models::PlanCreateParams::Price::
|
3797
|
+
# @return [Orb::Models::PlanCreateParams::Price::UnitWithProration::InvoicingCycleConfiguration, nil]
|
3818
3798
|
optional :invoicing_cycle_configuration,
|
3819
|
-
-> { Orb::Models::PlanCreateParams::Price::
|
3799
|
+
-> { Orb::Models::PlanCreateParams::Price::UnitWithProration::InvoicingCycleConfiguration },
|
3820
3800
|
nil?: true
|
3821
3801
|
|
3822
3802
|
# @!attribute metadata
|
@@ -3829,10 +3809,9 @@ module Orb
|
|
3829
3809
|
|
3830
3810
|
# @!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
3811
|
# Some parameter documentations has been truncated, see
|
3832
|
-
# {Orb::Models::PlanCreateParams::Price::
|
3833
|
-
# details.
|
3812
|
+
# {Orb::Models::PlanCreateParams::Price::UnitWithProration} for more details.
|
3834
3813
|
#
|
3835
|
-
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::
|
3814
|
+
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::UnitWithProration::Cadence] The cadence to bill for this price on.
|
3836
3815
|
#
|
3837
3816
|
# @param item_id [String] The id of the item the price will be associated with.
|
3838
3817
|
#
|
@@ -3846,7 +3825,7 @@ module Orb
|
|
3846
3825
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
3847
3826
|
# ...
|
3848
3827
|
#
|
3849
|
-
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::
|
3828
|
+
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::UnitWithProration::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
3850
3829
|
# ...
|
3851
3830
|
#
|
3852
3831
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
@@ -3861,7 +3840,7 @@ module Orb
|
|
3861
3840
|
#
|
3862
3841
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
3863
3842
|
#
|
3864
|
-
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::
|
3843
|
+
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::UnitWithProration::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
3865
3844
|
# ...
|
3866
3845
|
#
|
3867
3846
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
@@ -3871,7 +3850,7 @@ module Orb
|
|
3871
3850
|
|
3872
3851
|
# The cadence to bill for this price on.
|
3873
3852
|
#
|
3874
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
3853
|
+
# @see Orb::Models::PlanCreateParams::Price::UnitWithProration#cadence
|
3875
3854
|
module Cadence
|
3876
3855
|
extend Orb::Internal::Type::Enum
|
3877
3856
|
|
@@ -3886,7 +3865,7 @@ module Orb
|
|
3886
3865
|
# @return [Array<Symbol>]
|
3887
3866
|
end
|
3888
3867
|
|
3889
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
3868
|
+
# @see Orb::Models::PlanCreateParams::Price::UnitWithProration#billing_cycle_configuration
|
3890
3869
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
3891
3870
|
# @!attribute duration
|
3892
3871
|
# The duration of the billing period.
|
@@ -3897,9 +3876,9 @@ module Orb
|
|
3897
3876
|
# @!attribute duration_unit
|
3898
3877
|
# The unit of billing period duration.
|
3899
3878
|
#
|
3900
|
-
# @return [Symbol, Orb::Models::PlanCreateParams::Price::
|
3879
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::UnitWithProration::BillingCycleConfiguration::DurationUnit]
|
3901
3880
|
required :duration_unit,
|
3902
|
-
enum: -> { Orb::Models::PlanCreateParams::Price::
|
3881
|
+
enum: -> { Orb::Models::PlanCreateParams::Price::UnitWithProration::BillingCycleConfiguration::DurationUnit }
|
3903
3882
|
|
3904
3883
|
# @!method initialize(duration:, duration_unit:)
|
3905
3884
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -3907,11 +3886,11 @@ module Orb
|
|
3907
3886
|
#
|
3908
3887
|
# @param duration [Integer] The duration of the billing period.
|
3909
3888
|
#
|
3910
|
-
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::
|
3889
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::UnitWithProration::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
3911
3890
|
|
3912
3891
|
# The unit of billing period duration.
|
3913
3892
|
#
|
3914
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
3893
|
+
# @see Orb::Models::PlanCreateParams::Price::UnitWithProration::BillingCycleConfiguration#duration_unit
|
3915
3894
|
module DurationUnit
|
3916
3895
|
extend Orb::Internal::Type::Enum
|
3917
3896
|
|
@@ -3923,7 +3902,7 @@ module Orb
|
|
3923
3902
|
end
|
3924
3903
|
end
|
3925
3904
|
|
3926
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
3905
|
+
# @see Orb::Models::PlanCreateParams::Price::UnitWithProration#invoicing_cycle_configuration
|
3927
3906
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
3928
3907
|
# @!attribute duration
|
3929
3908
|
# The duration of the billing period.
|
@@ -3934,9 +3913,9 @@ module Orb
|
|
3934
3913
|
# @!attribute duration_unit
|
3935
3914
|
# The unit of billing period duration.
|
3936
3915
|
#
|
3937
|
-
# @return [Symbol, Orb::Models::PlanCreateParams::Price::
|
3916
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::UnitWithProration::InvoicingCycleConfiguration::DurationUnit]
|
3938
3917
|
required :duration_unit,
|
3939
|
-
enum: -> { Orb::Models::PlanCreateParams::Price::
|
3918
|
+
enum: -> { Orb::Models::PlanCreateParams::Price::UnitWithProration::InvoicingCycleConfiguration::DurationUnit }
|
3940
3919
|
|
3941
3920
|
# @!method initialize(duration:, duration_unit:)
|
3942
3921
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
@@ -3944,11 +3923,11 @@ module Orb
|
|
3944
3923
|
#
|
3945
3924
|
# @param duration [Integer] The duration of the billing period.
|
3946
3925
|
#
|
3947
|
-
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::
|
3926
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::UnitWithProration::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
3948
3927
|
|
3949
3928
|
# The unit of billing period duration.
|
3950
3929
|
#
|
3951
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
3930
|
+
# @see Orb::Models::PlanCreateParams::Price::UnitWithProration::InvoicingCycleConfiguration#duration_unit
|
3952
3931
|
module DurationUnit
|
3953
3932
|
extend Orb::Internal::Type::Enum
|
3954
3933
|
|
@@ -3961,13 +3940,12 @@ module Orb
|
|
3961
3940
|
end
|
3962
3941
|
end
|
3963
3942
|
|
3964
|
-
class
|
3943
|
+
class GroupedAllocation < Orb::Internal::Type::BaseModel
|
3965
3944
|
# @!attribute cadence
|
3966
3945
|
# The cadence to bill for this price on.
|
3967
3946
|
#
|
3968
|
-
# @return [Symbol, Orb::Models::PlanCreateParams::Price::
|
3969
|
-
required :cadence,
|
3970
|
-
enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanGroupedAllocationPrice::Cadence }
|
3947
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::GroupedAllocation::Cadence]
|
3948
|
+
required :cadence, enum: -> { Orb::Models::PlanCreateParams::Price::GroupedAllocation::Cadence }
|
3971
3949
|
|
3972
3950
|
# @!attribute grouped_allocation_config
|
3973
3951
|
#
|
@@ -4009,9 +3987,9 @@ module Orb
|
|
4009
3987
|
# For custom cadence: specifies the duration of the billing period in days or
|
4010
3988
|
# months.
|
4011
3989
|
#
|
4012
|
-
# @return [Orb::Models::PlanCreateParams::Price::
|
3990
|
+
# @return [Orb::Models::PlanCreateParams::Price::GroupedAllocation::BillingCycleConfiguration, nil]
|
4013
3991
|
optional :billing_cycle_configuration,
|
4014
|
-
-> { Orb::Models::PlanCreateParams::Price::
|
3992
|
+
-> { Orb::Models::PlanCreateParams::Price::GroupedAllocation::BillingCycleConfiguration },
|
4015
3993
|
nil?: true
|
4016
3994
|
|
4017
3995
|
# @!attribute conversion_rate
|
@@ -4050,9 +4028,9 @@ module Orb
|
|
4050
4028
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
4051
4029
|
# If unspecified, a single invoice is produced per billing cycle.
|
4052
4030
|
#
|
4053
|
-
# @return [Orb::Models::PlanCreateParams::Price::
|
4031
|
+
# @return [Orb::Models::PlanCreateParams::Price::GroupedAllocation::InvoicingCycleConfiguration, nil]
|
4054
4032
|
optional :invoicing_cycle_configuration,
|
4055
|
-
-> { Orb::Models::PlanCreateParams::Price::
|
4033
|
+
-> { Orb::Models::PlanCreateParams::Price::GroupedAllocation::InvoicingCycleConfiguration },
|
4056
4034
|
nil?: true
|
4057
4035
|
|
4058
4036
|
# @!attribute metadata
|
@@ -4065,10 +4043,9 @@ module Orb
|
|
4065
4043
|
|
4066
4044
|
# @!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
4045
|
# Some parameter documentations has been truncated, see
|
4068
|
-
# {Orb::Models::PlanCreateParams::Price::
|
4069
|
-
# details.
|
4046
|
+
# {Orb::Models::PlanCreateParams::Price::GroupedAllocation} for more details.
|
4070
4047
|
#
|
4071
|
-
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::
|
4048
|
+
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::GroupedAllocation::Cadence] The cadence to bill for this price on.
|
4072
4049
|
#
|
4073
4050
|
# @param grouped_allocation_config [Hash{Symbol=>Object}]
|
4074
4051
|
#
|
@@ -4082,7 +4059,7 @@ module Orb
|
|
4082
4059
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
4083
4060
|
# ...
|
4084
4061
|
#
|
4085
|
-
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::
|
4062
|
+
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::GroupedAllocation::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
4086
4063
|
# ...
|
4087
4064
|
#
|
4088
4065
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
@@ -4097,7 +4074,7 @@ module Orb
|
|
4097
4074
|
#
|
4098
4075
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
4099
4076
|
#
|
4100
|
-
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::
|
4077
|
+
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::GroupedAllocation::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
4101
4078
|
# ...
|
4102
4079
|
#
|
4103
4080
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
@@ -4107,7 +4084,7 @@ module Orb
|
|
4107
4084
|
|
4108
4085
|
# The cadence to bill for this price on.
|
4109
4086
|
#
|
4110
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
4087
|
+
# @see Orb::Models::PlanCreateParams::Price::GroupedAllocation#cadence
|
4111
4088
|
module Cadence
|
4112
4089
|
extend Orb::Internal::Type::Enum
|
4113
4090
|
|
@@ -4122,7 +4099,7 @@ module Orb
|
|
4122
4099
|
# @return [Array<Symbol>]
|
4123
4100
|
end
|
4124
4101
|
|
4125
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
4102
|
+
# @see Orb::Models::PlanCreateParams::Price::GroupedAllocation#billing_cycle_configuration
|
4126
4103
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
4127
4104
|
# @!attribute duration
|
4128
4105
|
# The duration of the billing period.
|
@@ -4133,9 +4110,9 @@ module Orb
|
|
4133
4110
|
# @!attribute duration_unit
|
4134
4111
|
# The unit of billing period duration.
|
4135
4112
|
#
|
4136
|
-
# @return [Symbol, Orb::Models::PlanCreateParams::Price::
|
4113
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::GroupedAllocation::BillingCycleConfiguration::DurationUnit]
|
4137
4114
|
required :duration_unit,
|
4138
|
-
enum: -> { Orb::Models::PlanCreateParams::Price::
|
4115
|
+
enum: -> { Orb::Models::PlanCreateParams::Price::GroupedAllocation::BillingCycleConfiguration::DurationUnit }
|
4139
4116
|
|
4140
4117
|
# @!method initialize(duration:, duration_unit:)
|
4141
4118
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -4143,11 +4120,11 @@ module Orb
|
|
4143
4120
|
#
|
4144
4121
|
# @param duration [Integer] The duration of the billing period.
|
4145
4122
|
#
|
4146
|
-
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::
|
4123
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::GroupedAllocation::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
4147
4124
|
|
4148
4125
|
# The unit of billing period duration.
|
4149
4126
|
#
|
4150
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
4127
|
+
# @see Orb::Models::PlanCreateParams::Price::GroupedAllocation::BillingCycleConfiguration#duration_unit
|
4151
4128
|
module DurationUnit
|
4152
4129
|
extend Orb::Internal::Type::Enum
|
4153
4130
|
|
@@ -4159,7 +4136,7 @@ module Orb
|
|
4159
4136
|
end
|
4160
4137
|
end
|
4161
4138
|
|
4162
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
4139
|
+
# @see Orb::Models::PlanCreateParams::Price::GroupedAllocation#invoicing_cycle_configuration
|
4163
4140
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
4164
4141
|
# @!attribute duration
|
4165
4142
|
# The duration of the billing period.
|
@@ -4170,9 +4147,9 @@ module Orb
|
|
4170
4147
|
# @!attribute duration_unit
|
4171
4148
|
# The unit of billing period duration.
|
4172
4149
|
#
|
4173
|
-
# @return [Symbol, Orb::Models::PlanCreateParams::Price::
|
4150
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::GroupedAllocation::InvoicingCycleConfiguration::DurationUnit]
|
4174
4151
|
required :duration_unit,
|
4175
|
-
enum: -> { Orb::Models::PlanCreateParams::Price::
|
4152
|
+
enum: -> { Orb::Models::PlanCreateParams::Price::GroupedAllocation::InvoicingCycleConfiguration::DurationUnit }
|
4176
4153
|
|
4177
4154
|
# @!method initialize(duration:, duration_unit:)
|
4178
4155
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
@@ -4180,11 +4157,11 @@ module Orb
|
|
4180
4157
|
#
|
4181
4158
|
# @param duration [Integer] The duration of the billing period.
|
4182
4159
|
#
|
4183
|
-
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::
|
4160
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::GroupedAllocation::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
4184
4161
|
|
4185
4162
|
# The unit of billing period duration.
|
4186
4163
|
#
|
4187
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
4164
|
+
# @see Orb::Models::PlanCreateParams::Price::GroupedAllocation::InvoicingCycleConfiguration#duration_unit
|
4188
4165
|
module DurationUnit
|
4189
4166
|
extend Orb::Internal::Type::Enum
|
4190
4167
|
|
@@ -4197,13 +4174,12 @@ module Orb
|
|
4197
4174
|
end
|
4198
4175
|
end
|
4199
4176
|
|
4200
|
-
class
|
4177
|
+
class GroupedWithProratedMinimum < Orb::Internal::Type::BaseModel
|
4201
4178
|
# @!attribute cadence
|
4202
4179
|
# The cadence to bill for this price on.
|
4203
4180
|
#
|
4204
|
-
# @return [Symbol, Orb::Models::PlanCreateParams::Price::
|
4205
|
-
required :cadence,
|
4206
|
-
enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithProratedMinimumPrice::Cadence }
|
4181
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::GroupedWithProratedMinimum::Cadence]
|
4182
|
+
required :cadence, enum: -> { Orb::Models::PlanCreateParams::Price::GroupedWithProratedMinimum::Cadence }
|
4207
4183
|
|
4208
4184
|
# @!attribute grouped_with_prorated_minimum_config
|
4209
4185
|
#
|
@@ -4246,9 +4222,9 @@ module Orb
|
|
4246
4222
|
# For custom cadence: specifies the duration of the billing period in days or
|
4247
4223
|
# months.
|
4248
4224
|
#
|
4249
|
-
# @return [Orb::Models::PlanCreateParams::Price::
|
4225
|
+
# @return [Orb::Models::PlanCreateParams::Price::GroupedWithProratedMinimum::BillingCycleConfiguration, nil]
|
4250
4226
|
optional :billing_cycle_configuration,
|
4251
|
-
-> { Orb::Models::PlanCreateParams::Price::
|
4227
|
+
-> { Orb::Models::PlanCreateParams::Price::GroupedWithProratedMinimum::BillingCycleConfiguration },
|
4252
4228
|
nil?: true
|
4253
4229
|
|
4254
4230
|
# @!attribute conversion_rate
|
@@ -4287,9 +4263,9 @@ module Orb
|
|
4287
4263
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
4288
4264
|
# If unspecified, a single invoice is produced per billing cycle.
|
4289
4265
|
#
|
4290
|
-
# @return [Orb::Models::PlanCreateParams::Price::
|
4266
|
+
# @return [Orb::Models::PlanCreateParams::Price::GroupedWithProratedMinimum::InvoicingCycleConfiguration, nil]
|
4291
4267
|
optional :invoicing_cycle_configuration,
|
4292
|
-
-> { Orb::Models::PlanCreateParams::Price::
|
4268
|
+
-> { Orb::Models::PlanCreateParams::Price::GroupedWithProratedMinimum::InvoicingCycleConfiguration },
|
4293
4269
|
nil?: true
|
4294
4270
|
|
4295
4271
|
# @!attribute metadata
|
@@ -4302,10 +4278,10 @@ module Orb
|
|
4302
4278
|
|
4303
4279
|
# @!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
4280
|
# Some parameter documentations has been truncated, see
|
4305
|
-
# {Orb::Models::PlanCreateParams::Price::
|
4306
|
-
#
|
4281
|
+
# {Orb::Models::PlanCreateParams::Price::GroupedWithProratedMinimum} for more
|
4282
|
+
# details.
|
4307
4283
|
#
|
4308
|
-
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::
|
4284
|
+
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::GroupedWithProratedMinimum::Cadence] The cadence to bill for this price on.
|
4309
4285
|
#
|
4310
4286
|
# @param grouped_with_prorated_minimum_config [Hash{Symbol=>Object}]
|
4311
4287
|
#
|
@@ -4319,7 +4295,7 @@ module Orb
|
|
4319
4295
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
4320
4296
|
# ...
|
4321
4297
|
#
|
4322
|
-
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::
|
4298
|
+
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::GroupedWithProratedMinimum::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
4323
4299
|
# ...
|
4324
4300
|
#
|
4325
4301
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
@@ -4334,7 +4310,7 @@ module Orb
|
|
4334
4310
|
#
|
4335
4311
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
4336
4312
|
#
|
4337
|
-
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::
|
4313
|
+
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::GroupedWithProratedMinimum::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
4338
4314
|
# ...
|
4339
4315
|
#
|
4340
4316
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
@@ -4344,7 +4320,7 @@ module Orb
|
|
4344
4320
|
|
4345
4321
|
# The cadence to bill for this price on.
|
4346
4322
|
#
|
4347
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
4323
|
+
# @see Orb::Models::PlanCreateParams::Price::GroupedWithProratedMinimum#cadence
|
4348
4324
|
module Cadence
|
4349
4325
|
extend Orb::Internal::Type::Enum
|
4350
4326
|
|
@@ -4359,7 +4335,7 @@ module Orb
|
|
4359
4335
|
# @return [Array<Symbol>]
|
4360
4336
|
end
|
4361
4337
|
|
4362
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
4338
|
+
# @see Orb::Models::PlanCreateParams::Price::GroupedWithProratedMinimum#billing_cycle_configuration
|
4363
4339
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
4364
4340
|
# @!attribute duration
|
4365
4341
|
# The duration of the billing period.
|
@@ -4370,9 +4346,9 @@ module Orb
|
|
4370
4346
|
# @!attribute duration_unit
|
4371
4347
|
# The unit of billing period duration.
|
4372
4348
|
#
|
4373
|
-
# @return [Symbol, Orb::Models::PlanCreateParams::Price::
|
4349
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::GroupedWithProratedMinimum::BillingCycleConfiguration::DurationUnit]
|
4374
4350
|
required :duration_unit,
|
4375
|
-
enum: -> { Orb::Models::PlanCreateParams::Price::
|
4351
|
+
enum: -> { Orb::Models::PlanCreateParams::Price::GroupedWithProratedMinimum::BillingCycleConfiguration::DurationUnit }
|
4376
4352
|
|
4377
4353
|
# @!method initialize(duration:, duration_unit:)
|
4378
4354
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -4380,11 +4356,11 @@ module Orb
|
|
4380
4356
|
#
|
4381
4357
|
# @param duration [Integer] The duration of the billing period.
|
4382
4358
|
#
|
4383
|
-
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::
|
4359
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::GroupedWithProratedMinimum::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
4384
4360
|
|
4385
4361
|
# The unit of billing period duration.
|
4386
4362
|
#
|
4387
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
4363
|
+
# @see Orb::Models::PlanCreateParams::Price::GroupedWithProratedMinimum::BillingCycleConfiguration#duration_unit
|
4388
4364
|
module DurationUnit
|
4389
4365
|
extend Orb::Internal::Type::Enum
|
4390
4366
|
|
@@ -4396,7 +4372,7 @@ module Orb
|
|
4396
4372
|
end
|
4397
4373
|
end
|
4398
4374
|
|
4399
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
4375
|
+
# @see Orb::Models::PlanCreateParams::Price::GroupedWithProratedMinimum#invoicing_cycle_configuration
|
4400
4376
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
4401
4377
|
# @!attribute duration
|
4402
4378
|
# The duration of the billing period.
|
@@ -4407,9 +4383,9 @@ module Orb
|
|
4407
4383
|
# @!attribute duration_unit
|
4408
4384
|
# The unit of billing period duration.
|
4409
4385
|
#
|
4410
|
-
# @return [Symbol, Orb::Models::PlanCreateParams::Price::
|
4386
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::GroupedWithProratedMinimum::InvoicingCycleConfiguration::DurationUnit]
|
4411
4387
|
required :duration_unit,
|
4412
|
-
enum: -> { Orb::Models::PlanCreateParams::Price::
|
4388
|
+
enum: -> { Orb::Models::PlanCreateParams::Price::GroupedWithProratedMinimum::InvoicingCycleConfiguration::DurationUnit }
|
4413
4389
|
|
4414
4390
|
# @!method initialize(duration:, duration_unit:)
|
4415
4391
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
@@ -4417,11 +4393,11 @@ module Orb
|
|
4417
4393
|
#
|
4418
4394
|
# @param duration [Integer] The duration of the billing period.
|
4419
4395
|
#
|
4420
|
-
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::
|
4396
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::GroupedWithProratedMinimum::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
4421
4397
|
|
4422
4398
|
# The unit of billing period duration.
|
4423
4399
|
#
|
4424
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
4400
|
+
# @see Orb::Models::PlanCreateParams::Price::GroupedWithProratedMinimum::InvoicingCycleConfiguration#duration_unit
|
4425
4401
|
module DurationUnit
|
4426
4402
|
extend Orb::Internal::Type::Enum
|
4427
4403
|
|
@@ -4434,13 +4410,12 @@ module Orb
|
|
4434
4410
|
end
|
4435
4411
|
end
|
4436
4412
|
|
4437
|
-
class
|
4413
|
+
class GroupedWithMeteredMinimum < Orb::Internal::Type::BaseModel
|
4438
4414
|
# @!attribute cadence
|
4439
4415
|
# The cadence to bill for this price on.
|
4440
4416
|
#
|
4441
|
-
# @return [Symbol, Orb::Models::PlanCreateParams::Price::
|
4442
|
-
required :cadence,
|
4443
|
-
enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithMeteredMinimumPrice::Cadence }
|
4417
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::GroupedWithMeteredMinimum::Cadence]
|
4418
|
+
required :cadence, enum: -> { Orb::Models::PlanCreateParams::Price::GroupedWithMeteredMinimum::Cadence }
|
4444
4419
|
|
4445
4420
|
# @!attribute grouped_with_metered_minimum_config
|
4446
4421
|
#
|
@@ -4483,9 +4458,9 @@ module Orb
|
|
4483
4458
|
# For custom cadence: specifies the duration of the billing period in days or
|
4484
4459
|
# months.
|
4485
4460
|
#
|
4486
|
-
# @return [Orb::Models::PlanCreateParams::Price::
|
4461
|
+
# @return [Orb::Models::PlanCreateParams::Price::GroupedWithMeteredMinimum::BillingCycleConfiguration, nil]
|
4487
4462
|
optional :billing_cycle_configuration,
|
4488
|
-
-> { Orb::Models::PlanCreateParams::Price::
|
4463
|
+
-> { Orb::Models::PlanCreateParams::Price::GroupedWithMeteredMinimum::BillingCycleConfiguration },
|
4489
4464
|
nil?: true
|
4490
4465
|
|
4491
4466
|
# @!attribute conversion_rate
|
@@ -4524,9 +4499,9 @@ module Orb
|
|
4524
4499
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
4525
4500
|
# If unspecified, a single invoice is produced per billing cycle.
|
4526
4501
|
#
|
4527
|
-
# @return [Orb::Models::PlanCreateParams::Price::
|
4502
|
+
# @return [Orb::Models::PlanCreateParams::Price::GroupedWithMeteredMinimum::InvoicingCycleConfiguration, nil]
|
4528
4503
|
optional :invoicing_cycle_configuration,
|
4529
|
-
-> { Orb::Models::PlanCreateParams::Price::
|
4504
|
+
-> { Orb::Models::PlanCreateParams::Price::GroupedWithMeteredMinimum::InvoicingCycleConfiguration },
|
4530
4505
|
nil?: true
|
4531
4506
|
|
4532
4507
|
# @!attribute metadata
|
@@ -4539,10 +4514,10 @@ module Orb
|
|
4539
4514
|
|
4540
4515
|
# @!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
4516
|
# Some parameter documentations has been truncated, see
|
4542
|
-
# {Orb::Models::PlanCreateParams::Price::
|
4543
|
-
#
|
4517
|
+
# {Orb::Models::PlanCreateParams::Price::GroupedWithMeteredMinimum} for more
|
4518
|
+
# details.
|
4544
4519
|
#
|
4545
|
-
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::
|
4520
|
+
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::GroupedWithMeteredMinimum::Cadence] The cadence to bill for this price on.
|
4546
4521
|
#
|
4547
4522
|
# @param grouped_with_metered_minimum_config [Hash{Symbol=>Object}]
|
4548
4523
|
#
|
@@ -4556,7 +4531,7 @@ module Orb
|
|
4556
4531
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
4557
4532
|
# ...
|
4558
4533
|
#
|
4559
|
-
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::
|
4534
|
+
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::GroupedWithMeteredMinimum::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
4560
4535
|
# ...
|
4561
4536
|
#
|
4562
4537
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
@@ -4571,7 +4546,7 @@ module Orb
|
|
4571
4546
|
#
|
4572
4547
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
4573
4548
|
#
|
4574
|
-
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::
|
4549
|
+
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::GroupedWithMeteredMinimum::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
4575
4550
|
# ...
|
4576
4551
|
#
|
4577
4552
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
@@ -4581,7 +4556,7 @@ module Orb
|
|
4581
4556
|
|
4582
4557
|
# The cadence to bill for this price on.
|
4583
4558
|
#
|
4584
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
4559
|
+
# @see Orb::Models::PlanCreateParams::Price::GroupedWithMeteredMinimum#cadence
|
4585
4560
|
module Cadence
|
4586
4561
|
extend Orb::Internal::Type::Enum
|
4587
4562
|
|
@@ -4596,7 +4571,7 @@ module Orb
|
|
4596
4571
|
# @return [Array<Symbol>]
|
4597
4572
|
end
|
4598
4573
|
|
4599
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
4574
|
+
# @see Orb::Models::PlanCreateParams::Price::GroupedWithMeteredMinimum#billing_cycle_configuration
|
4600
4575
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
4601
4576
|
# @!attribute duration
|
4602
4577
|
# The duration of the billing period.
|
@@ -4607,9 +4582,9 @@ module Orb
|
|
4607
4582
|
# @!attribute duration_unit
|
4608
4583
|
# The unit of billing period duration.
|
4609
4584
|
#
|
4610
|
-
# @return [Symbol, Orb::Models::PlanCreateParams::Price::
|
4585
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::GroupedWithMeteredMinimum::BillingCycleConfiguration::DurationUnit]
|
4611
4586
|
required :duration_unit,
|
4612
|
-
enum: -> { Orb::Models::PlanCreateParams::Price::
|
4587
|
+
enum: -> { Orb::Models::PlanCreateParams::Price::GroupedWithMeteredMinimum::BillingCycleConfiguration::DurationUnit }
|
4613
4588
|
|
4614
4589
|
# @!method initialize(duration:, duration_unit:)
|
4615
4590
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -4617,11 +4592,11 @@ module Orb
|
|
4617
4592
|
#
|
4618
4593
|
# @param duration [Integer] The duration of the billing period.
|
4619
4594
|
#
|
4620
|
-
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::
|
4595
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::GroupedWithMeteredMinimum::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
4621
4596
|
|
4622
4597
|
# The unit of billing period duration.
|
4623
4598
|
#
|
4624
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
4599
|
+
# @see Orb::Models::PlanCreateParams::Price::GroupedWithMeteredMinimum::BillingCycleConfiguration#duration_unit
|
4625
4600
|
module DurationUnit
|
4626
4601
|
extend Orb::Internal::Type::Enum
|
4627
4602
|
|
@@ -4633,7 +4608,7 @@ module Orb
|
|
4633
4608
|
end
|
4634
4609
|
end
|
4635
4610
|
|
4636
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
4611
|
+
# @see Orb::Models::PlanCreateParams::Price::GroupedWithMeteredMinimum#invoicing_cycle_configuration
|
4637
4612
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
4638
4613
|
# @!attribute duration
|
4639
4614
|
# The duration of the billing period.
|
@@ -4644,9 +4619,9 @@ module Orb
|
|
4644
4619
|
# @!attribute duration_unit
|
4645
4620
|
# The unit of billing period duration.
|
4646
4621
|
#
|
4647
|
-
# @return [Symbol, Orb::Models::PlanCreateParams::Price::
|
4622
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::GroupedWithMeteredMinimum::InvoicingCycleConfiguration::DurationUnit]
|
4648
4623
|
required :duration_unit,
|
4649
|
-
enum: -> { Orb::Models::PlanCreateParams::Price::
|
4624
|
+
enum: -> { Orb::Models::PlanCreateParams::Price::GroupedWithMeteredMinimum::InvoicingCycleConfiguration::DurationUnit }
|
4650
4625
|
|
4651
4626
|
# @!method initialize(duration:, duration_unit:)
|
4652
4627
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
@@ -4654,11 +4629,11 @@ module Orb
|
|
4654
4629
|
#
|
4655
4630
|
# @param duration [Integer] The duration of the billing period.
|
4656
4631
|
#
|
4657
|
-
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::
|
4632
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::GroupedWithMeteredMinimum::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
4658
4633
|
|
4659
4634
|
# The unit of billing period duration.
|
4660
4635
|
#
|
4661
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
4636
|
+
# @see Orb::Models::PlanCreateParams::Price::GroupedWithMeteredMinimum::InvoicingCycleConfiguration#duration_unit
|
4662
4637
|
module DurationUnit
|
4663
4638
|
extend Orb::Internal::Type::Enum
|
4664
4639
|
|
@@ -4671,13 +4646,12 @@ module Orb
|
|
4671
4646
|
end
|
4672
4647
|
end
|
4673
4648
|
|
4674
|
-
class
|
4649
|
+
class MatrixWithDisplayName < Orb::Internal::Type::BaseModel
|
4675
4650
|
# @!attribute cadence
|
4676
4651
|
# The cadence to bill for this price on.
|
4677
4652
|
#
|
4678
|
-
# @return [Symbol, Orb::Models::PlanCreateParams::Price::
|
4679
|
-
required :cadence,
|
4680
|
-
enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanMatrixWithDisplayNamePrice::Cadence }
|
4653
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::MatrixWithDisplayName::Cadence]
|
4654
|
+
required :cadence, enum: -> { Orb::Models::PlanCreateParams::Price::MatrixWithDisplayName::Cadence }
|
4681
4655
|
|
4682
4656
|
# @!attribute item_id
|
4683
4657
|
# The id of the item the price will be associated with.
|
@@ -4719,9 +4693,9 @@ module Orb
|
|
4719
4693
|
# For custom cadence: specifies the duration of the billing period in days or
|
4720
4694
|
# months.
|
4721
4695
|
#
|
4722
|
-
# @return [Orb::Models::PlanCreateParams::Price::
|
4696
|
+
# @return [Orb::Models::PlanCreateParams::Price::MatrixWithDisplayName::BillingCycleConfiguration, nil]
|
4723
4697
|
optional :billing_cycle_configuration,
|
4724
|
-
-> { Orb::Models::PlanCreateParams::Price::
|
4698
|
+
-> { Orb::Models::PlanCreateParams::Price::MatrixWithDisplayName::BillingCycleConfiguration },
|
4725
4699
|
nil?: true
|
4726
4700
|
|
4727
4701
|
# @!attribute conversion_rate
|
@@ -4760,9 +4734,9 @@ module Orb
|
|
4760
4734
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
4761
4735
|
# If unspecified, a single invoice is produced per billing cycle.
|
4762
4736
|
#
|
4763
|
-
# @return [Orb::Models::PlanCreateParams::Price::
|
4737
|
+
# @return [Orb::Models::PlanCreateParams::Price::MatrixWithDisplayName::InvoicingCycleConfiguration, nil]
|
4764
4738
|
optional :invoicing_cycle_configuration,
|
4765
|
-
-> { Orb::Models::PlanCreateParams::Price::
|
4739
|
+
-> { Orb::Models::PlanCreateParams::Price::MatrixWithDisplayName::InvoicingCycleConfiguration },
|
4766
4740
|
nil?: true
|
4767
4741
|
|
4768
4742
|
# @!attribute metadata
|
@@ -4775,10 +4749,9 @@ module Orb
|
|
4775
4749
|
|
4776
4750
|
# @!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
4751
|
# Some parameter documentations has been truncated, see
|
4778
|
-
# {Orb::Models::PlanCreateParams::Price::
|
4779
|
-
# more details.
|
4752
|
+
# {Orb::Models::PlanCreateParams::Price::MatrixWithDisplayName} for more details.
|
4780
4753
|
#
|
4781
|
-
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::
|
4754
|
+
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::MatrixWithDisplayName::Cadence] The cadence to bill for this price on.
|
4782
4755
|
#
|
4783
4756
|
# @param item_id [String] The id of the item the price will be associated with.
|
4784
4757
|
#
|
@@ -4792,7 +4765,7 @@ module Orb
|
|
4792
4765
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
4793
4766
|
# ...
|
4794
4767
|
#
|
4795
|
-
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::
|
4768
|
+
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::MatrixWithDisplayName::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
4796
4769
|
# ...
|
4797
4770
|
#
|
4798
4771
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
@@ -4807,7 +4780,7 @@ module Orb
|
|
4807
4780
|
#
|
4808
4781
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
4809
4782
|
#
|
4810
|
-
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::
|
4783
|
+
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::MatrixWithDisplayName::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
4811
4784
|
# ...
|
4812
4785
|
#
|
4813
4786
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
@@ -4817,7 +4790,7 @@ module Orb
|
|
4817
4790
|
|
4818
4791
|
# The cadence to bill for this price on.
|
4819
4792
|
#
|
4820
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
4793
|
+
# @see Orb::Models::PlanCreateParams::Price::MatrixWithDisplayName#cadence
|
4821
4794
|
module Cadence
|
4822
4795
|
extend Orb::Internal::Type::Enum
|
4823
4796
|
|
@@ -4832,7 +4805,7 @@ module Orb
|
|
4832
4805
|
# @return [Array<Symbol>]
|
4833
4806
|
end
|
4834
4807
|
|
4835
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
4808
|
+
# @see Orb::Models::PlanCreateParams::Price::MatrixWithDisplayName#billing_cycle_configuration
|
4836
4809
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
4837
4810
|
# @!attribute duration
|
4838
4811
|
# The duration of the billing period.
|
@@ -4843,9 +4816,9 @@ module Orb
|
|
4843
4816
|
# @!attribute duration_unit
|
4844
4817
|
# The unit of billing period duration.
|
4845
4818
|
#
|
4846
|
-
# @return [Symbol, Orb::Models::PlanCreateParams::Price::
|
4819
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::MatrixWithDisplayName::BillingCycleConfiguration::DurationUnit]
|
4847
4820
|
required :duration_unit,
|
4848
|
-
enum: -> { Orb::Models::PlanCreateParams::Price::
|
4821
|
+
enum: -> { Orb::Models::PlanCreateParams::Price::MatrixWithDisplayName::BillingCycleConfiguration::DurationUnit }
|
4849
4822
|
|
4850
4823
|
# @!method initialize(duration:, duration_unit:)
|
4851
4824
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -4853,11 +4826,11 @@ module Orb
|
|
4853
4826
|
#
|
4854
4827
|
# @param duration [Integer] The duration of the billing period.
|
4855
4828
|
#
|
4856
|
-
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::
|
4829
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::MatrixWithDisplayName::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
4857
4830
|
|
4858
4831
|
# The unit of billing period duration.
|
4859
4832
|
#
|
4860
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
4833
|
+
# @see Orb::Models::PlanCreateParams::Price::MatrixWithDisplayName::BillingCycleConfiguration#duration_unit
|
4861
4834
|
module DurationUnit
|
4862
4835
|
extend Orb::Internal::Type::Enum
|
4863
4836
|
|
@@ -4869,7 +4842,7 @@ module Orb
|
|
4869
4842
|
end
|
4870
4843
|
end
|
4871
4844
|
|
4872
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
4845
|
+
# @see Orb::Models::PlanCreateParams::Price::MatrixWithDisplayName#invoicing_cycle_configuration
|
4873
4846
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
4874
4847
|
# @!attribute duration
|
4875
4848
|
# The duration of the billing period.
|
@@ -4880,9 +4853,9 @@ module Orb
|
|
4880
4853
|
# @!attribute duration_unit
|
4881
4854
|
# The unit of billing period duration.
|
4882
4855
|
#
|
4883
|
-
# @return [Symbol, Orb::Models::PlanCreateParams::Price::
|
4856
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::MatrixWithDisplayName::InvoicingCycleConfiguration::DurationUnit]
|
4884
4857
|
required :duration_unit,
|
4885
|
-
enum: -> { Orb::Models::PlanCreateParams::Price::
|
4858
|
+
enum: -> { Orb::Models::PlanCreateParams::Price::MatrixWithDisplayName::InvoicingCycleConfiguration::DurationUnit }
|
4886
4859
|
|
4887
4860
|
# @!method initialize(duration:, duration_unit:)
|
4888
4861
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
@@ -4890,11 +4863,11 @@ module Orb
|
|
4890
4863
|
#
|
4891
4864
|
# @param duration [Integer] The duration of the billing period.
|
4892
4865
|
#
|
4893
|
-
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::
|
4866
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::MatrixWithDisplayName::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
4894
4867
|
|
4895
4868
|
# The unit of billing period duration.
|
4896
4869
|
#
|
4897
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
4870
|
+
# @see Orb::Models::PlanCreateParams::Price::MatrixWithDisplayName::InvoicingCycleConfiguration#duration_unit
|
4898
4871
|
module DurationUnit
|
4899
4872
|
extend Orb::Internal::Type::Enum
|
4900
4873
|
|
@@ -4907,7 +4880,7 @@ module Orb
|
|
4907
4880
|
end
|
4908
4881
|
end
|
4909
4882
|
|
4910
|
-
class
|
4883
|
+
class BulkWithProration < Orb::Internal::Type::BaseModel
|
4911
4884
|
# @!attribute bulk_with_proration_config
|
4912
4885
|
#
|
4913
4886
|
# @return [Hash{Symbol=>Object}]
|
@@ -4916,9 +4889,8 @@ module Orb
|
|
4916
4889
|
# @!attribute cadence
|
4917
4890
|
# The cadence to bill for this price on.
|
4918
4891
|
#
|
4919
|
-
# @return [Symbol, Orb::Models::PlanCreateParams::Price::
|
4920
|
-
required :cadence,
|
4921
|
-
enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanBulkWithProrationPrice::Cadence }
|
4892
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::BulkWithProration::Cadence]
|
4893
|
+
required :cadence, enum: -> { Orb::Models::PlanCreateParams::Price::BulkWithProration::Cadence }
|
4922
4894
|
|
4923
4895
|
# @!attribute item_id
|
4924
4896
|
# The id of the item the price will be associated with.
|
@@ -4955,9 +4927,9 @@ module Orb
|
|
4955
4927
|
# For custom cadence: specifies the duration of the billing period in days or
|
4956
4928
|
# months.
|
4957
4929
|
#
|
4958
|
-
# @return [Orb::Models::PlanCreateParams::Price::
|
4930
|
+
# @return [Orb::Models::PlanCreateParams::Price::BulkWithProration::BillingCycleConfiguration, nil]
|
4959
4931
|
optional :billing_cycle_configuration,
|
4960
|
-
-> { Orb::Models::PlanCreateParams::Price::
|
4932
|
+
-> { Orb::Models::PlanCreateParams::Price::BulkWithProration::BillingCycleConfiguration },
|
4961
4933
|
nil?: true
|
4962
4934
|
|
4963
4935
|
# @!attribute conversion_rate
|
@@ -4996,9 +4968,9 @@ module Orb
|
|
4996
4968
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
4997
4969
|
# If unspecified, a single invoice is produced per billing cycle.
|
4998
4970
|
#
|
4999
|
-
# @return [Orb::Models::PlanCreateParams::Price::
|
4971
|
+
# @return [Orb::Models::PlanCreateParams::Price::BulkWithProration::InvoicingCycleConfiguration, nil]
|
5000
4972
|
optional :invoicing_cycle_configuration,
|
5001
|
-
-> { Orb::Models::PlanCreateParams::Price::
|
4973
|
+
-> { Orb::Models::PlanCreateParams::Price::BulkWithProration::InvoicingCycleConfiguration },
|
5002
4974
|
nil?: true
|
5003
4975
|
|
5004
4976
|
# @!attribute metadata
|
@@ -5011,12 +4983,11 @@ module Orb
|
|
5011
4983
|
|
5012
4984
|
# @!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
4985
|
# Some parameter documentations has been truncated, see
|
5014
|
-
# {Orb::Models::PlanCreateParams::Price::
|
5015
|
-
# details.
|
4986
|
+
# {Orb::Models::PlanCreateParams::Price::BulkWithProration} for more details.
|
5016
4987
|
#
|
5017
4988
|
# @param bulk_with_proration_config [Hash{Symbol=>Object}]
|
5018
4989
|
#
|
5019
|
-
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::
|
4990
|
+
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::BulkWithProration::Cadence] The cadence to bill for this price on.
|
5020
4991
|
#
|
5021
4992
|
# @param item_id [String] The id of the item the price will be associated with.
|
5022
4993
|
#
|
@@ -5028,7 +4999,7 @@ module Orb
|
|
5028
4999
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
5029
5000
|
# ...
|
5030
5001
|
#
|
5031
|
-
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::
|
5002
|
+
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::BulkWithProration::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
5032
5003
|
# ...
|
5033
5004
|
#
|
5034
5005
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
@@ -5043,7 +5014,7 @@ module Orb
|
|
5043
5014
|
#
|
5044
5015
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
5045
5016
|
#
|
5046
|
-
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::
|
5017
|
+
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::BulkWithProration::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
5047
5018
|
# ...
|
5048
5019
|
#
|
5049
5020
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
@@ -5053,7 +5024,7 @@ module Orb
|
|
5053
5024
|
|
5054
5025
|
# The cadence to bill for this price on.
|
5055
5026
|
#
|
5056
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
5027
|
+
# @see Orb::Models::PlanCreateParams::Price::BulkWithProration#cadence
|
5057
5028
|
module Cadence
|
5058
5029
|
extend Orb::Internal::Type::Enum
|
5059
5030
|
|
@@ -5068,7 +5039,7 @@ module Orb
|
|
5068
5039
|
# @return [Array<Symbol>]
|
5069
5040
|
end
|
5070
5041
|
|
5071
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
5042
|
+
# @see Orb::Models::PlanCreateParams::Price::BulkWithProration#billing_cycle_configuration
|
5072
5043
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
5073
5044
|
# @!attribute duration
|
5074
5045
|
# The duration of the billing period.
|
@@ -5079,9 +5050,9 @@ module Orb
|
|
5079
5050
|
# @!attribute duration_unit
|
5080
5051
|
# The unit of billing period duration.
|
5081
5052
|
#
|
5082
|
-
# @return [Symbol, Orb::Models::PlanCreateParams::Price::
|
5053
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::BulkWithProration::BillingCycleConfiguration::DurationUnit]
|
5083
5054
|
required :duration_unit,
|
5084
|
-
enum: -> { Orb::Models::PlanCreateParams::Price::
|
5055
|
+
enum: -> { Orb::Models::PlanCreateParams::Price::BulkWithProration::BillingCycleConfiguration::DurationUnit }
|
5085
5056
|
|
5086
5057
|
# @!method initialize(duration:, duration_unit:)
|
5087
5058
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -5089,11 +5060,11 @@ module Orb
|
|
5089
5060
|
#
|
5090
5061
|
# @param duration [Integer] The duration of the billing period.
|
5091
5062
|
#
|
5092
|
-
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::
|
5063
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::BulkWithProration::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
5093
5064
|
|
5094
5065
|
# The unit of billing period duration.
|
5095
5066
|
#
|
5096
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
5067
|
+
# @see Orb::Models::PlanCreateParams::Price::BulkWithProration::BillingCycleConfiguration#duration_unit
|
5097
5068
|
module DurationUnit
|
5098
5069
|
extend Orb::Internal::Type::Enum
|
5099
5070
|
|
@@ -5105,7 +5076,7 @@ module Orb
|
|
5105
5076
|
end
|
5106
5077
|
end
|
5107
5078
|
|
5108
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
5079
|
+
# @see Orb::Models::PlanCreateParams::Price::BulkWithProration#invoicing_cycle_configuration
|
5109
5080
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
5110
5081
|
# @!attribute duration
|
5111
5082
|
# The duration of the billing period.
|
@@ -5116,9 +5087,9 @@ module Orb
|
|
5116
5087
|
# @!attribute duration_unit
|
5117
5088
|
# The unit of billing period duration.
|
5118
5089
|
#
|
5119
|
-
# @return [Symbol, Orb::Models::PlanCreateParams::Price::
|
5090
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::BulkWithProration::InvoicingCycleConfiguration::DurationUnit]
|
5120
5091
|
required :duration_unit,
|
5121
|
-
enum: -> { Orb::Models::PlanCreateParams::Price::
|
5092
|
+
enum: -> { Orb::Models::PlanCreateParams::Price::BulkWithProration::InvoicingCycleConfiguration::DurationUnit }
|
5122
5093
|
|
5123
5094
|
# @!method initialize(duration:, duration_unit:)
|
5124
5095
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
@@ -5126,11 +5097,11 @@ module Orb
|
|
5126
5097
|
#
|
5127
5098
|
# @param duration [Integer] The duration of the billing period.
|
5128
5099
|
#
|
5129
|
-
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::
|
5100
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::BulkWithProration::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
5130
5101
|
|
5131
5102
|
# The unit of billing period duration.
|
5132
5103
|
#
|
5133
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
5104
|
+
# @see Orb::Models::PlanCreateParams::Price::BulkWithProration::InvoicingCycleConfiguration#duration_unit
|
5134
5105
|
module DurationUnit
|
5135
5106
|
extend Orb::Internal::Type::Enum
|
5136
5107
|
|
@@ -5143,13 +5114,12 @@ module Orb
|
|
5143
5114
|
end
|
5144
5115
|
end
|
5145
5116
|
|
5146
|
-
class
|
5117
|
+
class GroupedTieredPackage < Orb::Internal::Type::BaseModel
|
5147
5118
|
# @!attribute cadence
|
5148
5119
|
# The cadence to bill for this price on.
|
5149
5120
|
#
|
5150
|
-
# @return [Symbol, Orb::Models::PlanCreateParams::Price::
|
5151
|
-
required :cadence,
|
5152
|
-
enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanGroupedTieredPackagePrice::Cadence }
|
5121
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::GroupedTieredPackage::Cadence]
|
5122
|
+
required :cadence, enum: -> { Orb::Models::PlanCreateParams::Price::GroupedTieredPackage::Cadence }
|
5153
5123
|
|
5154
5124
|
# @!attribute grouped_tiered_package_config
|
5155
5125
|
#
|
@@ -5191,9 +5161,9 @@ module Orb
|
|
5191
5161
|
# For custom cadence: specifies the duration of the billing period in days or
|
5192
5162
|
# months.
|
5193
5163
|
#
|
5194
|
-
# @return [Orb::Models::PlanCreateParams::Price::
|
5164
|
+
# @return [Orb::Models::PlanCreateParams::Price::GroupedTieredPackage::BillingCycleConfiguration, nil]
|
5195
5165
|
optional :billing_cycle_configuration,
|
5196
|
-
-> { Orb::Models::PlanCreateParams::Price::
|
5166
|
+
-> { Orb::Models::PlanCreateParams::Price::GroupedTieredPackage::BillingCycleConfiguration },
|
5197
5167
|
nil?: true
|
5198
5168
|
|
5199
5169
|
# @!attribute conversion_rate
|
@@ -5232,9 +5202,9 @@ module Orb
|
|
5232
5202
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
5233
5203
|
# If unspecified, a single invoice is produced per billing cycle.
|
5234
5204
|
#
|
5235
|
-
# @return [Orb::Models::PlanCreateParams::Price::
|
5205
|
+
# @return [Orb::Models::PlanCreateParams::Price::GroupedTieredPackage::InvoicingCycleConfiguration, nil]
|
5236
5206
|
optional :invoicing_cycle_configuration,
|
5237
|
-
-> { Orb::Models::PlanCreateParams::Price::
|
5207
|
+
-> { Orb::Models::PlanCreateParams::Price::GroupedTieredPackage::InvoicingCycleConfiguration },
|
5238
5208
|
nil?: true
|
5239
5209
|
|
5240
5210
|
# @!attribute metadata
|
@@ -5247,10 +5217,9 @@ module Orb
|
|
5247
5217
|
|
5248
5218
|
# @!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
5219
|
# Some parameter documentations has been truncated, see
|
5250
|
-
# {Orb::Models::PlanCreateParams::Price::
|
5251
|
-
# more details.
|
5220
|
+
# {Orb::Models::PlanCreateParams::Price::GroupedTieredPackage} for more details.
|
5252
5221
|
#
|
5253
|
-
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::
|
5222
|
+
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::GroupedTieredPackage::Cadence] The cadence to bill for this price on.
|
5254
5223
|
#
|
5255
5224
|
# @param grouped_tiered_package_config [Hash{Symbol=>Object}]
|
5256
5225
|
#
|
@@ -5264,7 +5233,7 @@ module Orb
|
|
5264
5233
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
5265
5234
|
# ...
|
5266
5235
|
#
|
5267
|
-
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::
|
5236
|
+
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::GroupedTieredPackage::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
5268
5237
|
# ...
|
5269
5238
|
#
|
5270
5239
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
@@ -5279,7 +5248,7 @@ module Orb
|
|
5279
5248
|
#
|
5280
5249
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
5281
5250
|
#
|
5282
|
-
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::
|
5251
|
+
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::GroupedTieredPackage::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
5283
5252
|
# ...
|
5284
5253
|
#
|
5285
5254
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
@@ -5289,7 +5258,7 @@ module Orb
|
|
5289
5258
|
|
5290
5259
|
# The cadence to bill for this price on.
|
5291
5260
|
#
|
5292
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
5261
|
+
# @see Orb::Models::PlanCreateParams::Price::GroupedTieredPackage#cadence
|
5293
5262
|
module Cadence
|
5294
5263
|
extend Orb::Internal::Type::Enum
|
5295
5264
|
|
@@ -5304,7 +5273,7 @@ module Orb
|
|
5304
5273
|
# @return [Array<Symbol>]
|
5305
5274
|
end
|
5306
5275
|
|
5307
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
5276
|
+
# @see Orb::Models::PlanCreateParams::Price::GroupedTieredPackage#billing_cycle_configuration
|
5308
5277
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
5309
5278
|
# @!attribute duration
|
5310
5279
|
# The duration of the billing period.
|
@@ -5315,9 +5284,9 @@ module Orb
|
|
5315
5284
|
# @!attribute duration_unit
|
5316
5285
|
# The unit of billing period duration.
|
5317
5286
|
#
|
5318
|
-
# @return [Symbol, Orb::Models::PlanCreateParams::Price::
|
5287
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::GroupedTieredPackage::BillingCycleConfiguration::DurationUnit]
|
5319
5288
|
required :duration_unit,
|
5320
|
-
enum: -> { Orb::Models::PlanCreateParams::Price::
|
5289
|
+
enum: -> { Orb::Models::PlanCreateParams::Price::GroupedTieredPackage::BillingCycleConfiguration::DurationUnit }
|
5321
5290
|
|
5322
5291
|
# @!method initialize(duration:, duration_unit:)
|
5323
5292
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -5325,11 +5294,11 @@ module Orb
|
|
5325
5294
|
#
|
5326
5295
|
# @param duration [Integer] The duration of the billing period.
|
5327
5296
|
#
|
5328
|
-
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::
|
5297
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::GroupedTieredPackage::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
5329
5298
|
|
5330
5299
|
# The unit of billing period duration.
|
5331
5300
|
#
|
5332
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
5301
|
+
# @see Orb::Models::PlanCreateParams::Price::GroupedTieredPackage::BillingCycleConfiguration#duration_unit
|
5333
5302
|
module DurationUnit
|
5334
5303
|
extend Orb::Internal::Type::Enum
|
5335
5304
|
|
@@ -5341,7 +5310,7 @@ module Orb
|
|
5341
5310
|
end
|
5342
5311
|
end
|
5343
5312
|
|
5344
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
5313
|
+
# @see Orb::Models::PlanCreateParams::Price::GroupedTieredPackage#invoicing_cycle_configuration
|
5345
5314
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
5346
5315
|
# @!attribute duration
|
5347
5316
|
# The duration of the billing period.
|
@@ -5352,9 +5321,9 @@ module Orb
|
|
5352
5321
|
# @!attribute duration_unit
|
5353
5322
|
# The unit of billing period duration.
|
5354
5323
|
#
|
5355
|
-
# @return [Symbol, Orb::Models::PlanCreateParams::Price::
|
5324
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::GroupedTieredPackage::InvoicingCycleConfiguration::DurationUnit]
|
5356
5325
|
required :duration_unit,
|
5357
|
-
enum: -> { Orb::Models::PlanCreateParams::Price::
|
5326
|
+
enum: -> { Orb::Models::PlanCreateParams::Price::GroupedTieredPackage::InvoicingCycleConfiguration::DurationUnit }
|
5358
5327
|
|
5359
5328
|
# @!method initialize(duration:, duration_unit:)
|
5360
5329
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
@@ -5362,11 +5331,11 @@ module Orb
|
|
5362
5331
|
#
|
5363
5332
|
# @param duration [Integer] The duration of the billing period.
|
5364
5333
|
#
|
5365
|
-
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::
|
5334
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::GroupedTieredPackage::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
5366
5335
|
|
5367
5336
|
# The unit of billing period duration.
|
5368
5337
|
#
|
5369
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
5338
|
+
# @see Orb::Models::PlanCreateParams::Price::GroupedTieredPackage::InvoicingCycleConfiguration#duration_unit
|
5370
5339
|
module DurationUnit
|
5371
5340
|
extend Orb::Internal::Type::Enum
|
5372
5341
|
|
@@ -5379,13 +5348,12 @@ module Orb
|
|
5379
5348
|
end
|
5380
5349
|
end
|
5381
5350
|
|
5382
|
-
class
|
5351
|
+
class MaxGroupTieredPackage < Orb::Internal::Type::BaseModel
|
5383
5352
|
# @!attribute cadence
|
5384
5353
|
# The cadence to bill for this price on.
|
5385
5354
|
#
|
5386
|
-
# @return [Symbol, Orb::Models::PlanCreateParams::Price::
|
5387
|
-
required :cadence,
|
5388
|
-
enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanMaxGroupTieredPackagePrice::Cadence }
|
5355
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::MaxGroupTieredPackage::Cadence]
|
5356
|
+
required :cadence, enum: -> { Orb::Models::PlanCreateParams::Price::MaxGroupTieredPackage::Cadence }
|
5389
5357
|
|
5390
5358
|
# @!attribute item_id
|
5391
5359
|
# The id of the item the price will be associated with.
|
@@ -5427,9 +5395,9 @@ module Orb
|
|
5427
5395
|
# For custom cadence: specifies the duration of the billing period in days or
|
5428
5396
|
# months.
|
5429
5397
|
#
|
5430
|
-
# @return [Orb::Models::PlanCreateParams::Price::
|
5398
|
+
# @return [Orb::Models::PlanCreateParams::Price::MaxGroupTieredPackage::BillingCycleConfiguration, nil]
|
5431
5399
|
optional :billing_cycle_configuration,
|
5432
|
-
-> { Orb::Models::PlanCreateParams::Price::
|
5400
|
+
-> { Orb::Models::PlanCreateParams::Price::MaxGroupTieredPackage::BillingCycleConfiguration },
|
5433
5401
|
nil?: true
|
5434
5402
|
|
5435
5403
|
# @!attribute conversion_rate
|
@@ -5468,9 +5436,9 @@ module Orb
|
|
5468
5436
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
5469
5437
|
# If unspecified, a single invoice is produced per billing cycle.
|
5470
5438
|
#
|
5471
|
-
# @return [Orb::Models::PlanCreateParams::Price::
|
5439
|
+
# @return [Orb::Models::PlanCreateParams::Price::MaxGroupTieredPackage::InvoicingCycleConfiguration, nil]
|
5472
5440
|
optional :invoicing_cycle_configuration,
|
5473
|
-
-> { Orb::Models::PlanCreateParams::Price::
|
5441
|
+
-> { Orb::Models::PlanCreateParams::Price::MaxGroupTieredPackage::InvoicingCycleConfiguration },
|
5474
5442
|
nil?: true
|
5475
5443
|
|
5476
5444
|
# @!attribute metadata
|
@@ -5483,10 +5451,9 @@ module Orb
|
|
5483
5451
|
|
5484
5452
|
# @!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
5453
|
# Some parameter documentations has been truncated, see
|
5486
|
-
# {Orb::Models::PlanCreateParams::Price::
|
5487
|
-
# more details.
|
5454
|
+
# {Orb::Models::PlanCreateParams::Price::MaxGroupTieredPackage} for more details.
|
5488
5455
|
#
|
5489
|
-
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::
|
5456
|
+
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::MaxGroupTieredPackage::Cadence] The cadence to bill for this price on.
|
5490
5457
|
#
|
5491
5458
|
# @param item_id [String] The id of the item the price will be associated with.
|
5492
5459
|
#
|
@@ -5500,7 +5467,7 @@ module Orb
|
|
5500
5467
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
5501
5468
|
# ...
|
5502
5469
|
#
|
5503
|
-
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::
|
5470
|
+
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::MaxGroupTieredPackage::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
5504
5471
|
# ...
|
5505
5472
|
#
|
5506
5473
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
@@ -5515,7 +5482,7 @@ module Orb
|
|
5515
5482
|
#
|
5516
5483
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
5517
5484
|
#
|
5518
|
-
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::
|
5485
|
+
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::MaxGroupTieredPackage::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
5519
5486
|
# ...
|
5520
5487
|
#
|
5521
5488
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
@@ -5525,7 +5492,7 @@ module Orb
|
|
5525
5492
|
|
5526
5493
|
# The cadence to bill for this price on.
|
5527
5494
|
#
|
5528
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
5495
|
+
# @see Orb::Models::PlanCreateParams::Price::MaxGroupTieredPackage#cadence
|
5529
5496
|
module Cadence
|
5530
5497
|
extend Orb::Internal::Type::Enum
|
5531
5498
|
|
@@ -5540,7 +5507,7 @@ module Orb
|
|
5540
5507
|
# @return [Array<Symbol>]
|
5541
5508
|
end
|
5542
5509
|
|
5543
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
5510
|
+
# @see Orb::Models::PlanCreateParams::Price::MaxGroupTieredPackage#billing_cycle_configuration
|
5544
5511
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
5545
5512
|
# @!attribute duration
|
5546
5513
|
# The duration of the billing period.
|
@@ -5551,9 +5518,9 @@ module Orb
|
|
5551
5518
|
# @!attribute duration_unit
|
5552
5519
|
# The unit of billing period duration.
|
5553
5520
|
#
|
5554
|
-
# @return [Symbol, Orb::Models::PlanCreateParams::Price::
|
5521
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::MaxGroupTieredPackage::BillingCycleConfiguration::DurationUnit]
|
5555
5522
|
required :duration_unit,
|
5556
|
-
enum: -> { Orb::Models::PlanCreateParams::Price::
|
5523
|
+
enum: -> { Orb::Models::PlanCreateParams::Price::MaxGroupTieredPackage::BillingCycleConfiguration::DurationUnit }
|
5557
5524
|
|
5558
5525
|
# @!method initialize(duration:, duration_unit:)
|
5559
5526
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -5561,11 +5528,11 @@ module Orb
|
|
5561
5528
|
#
|
5562
5529
|
# @param duration [Integer] The duration of the billing period.
|
5563
5530
|
#
|
5564
|
-
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::
|
5531
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::MaxGroupTieredPackage::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
5565
5532
|
|
5566
5533
|
# The unit of billing period duration.
|
5567
5534
|
#
|
5568
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
5535
|
+
# @see Orb::Models::PlanCreateParams::Price::MaxGroupTieredPackage::BillingCycleConfiguration#duration_unit
|
5569
5536
|
module DurationUnit
|
5570
5537
|
extend Orb::Internal::Type::Enum
|
5571
5538
|
|
@@ -5577,7 +5544,7 @@ module Orb
|
|
5577
5544
|
end
|
5578
5545
|
end
|
5579
5546
|
|
5580
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
5547
|
+
# @see Orb::Models::PlanCreateParams::Price::MaxGroupTieredPackage#invoicing_cycle_configuration
|
5581
5548
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
5582
5549
|
# @!attribute duration
|
5583
5550
|
# The duration of the billing period.
|
@@ -5588,9 +5555,9 @@ module Orb
|
|
5588
5555
|
# @!attribute duration_unit
|
5589
5556
|
# The unit of billing period duration.
|
5590
5557
|
#
|
5591
|
-
# @return [Symbol, Orb::Models::PlanCreateParams::Price::
|
5558
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::MaxGroupTieredPackage::InvoicingCycleConfiguration::DurationUnit]
|
5592
5559
|
required :duration_unit,
|
5593
|
-
enum: -> { Orb::Models::PlanCreateParams::Price::
|
5560
|
+
enum: -> { Orb::Models::PlanCreateParams::Price::MaxGroupTieredPackage::InvoicingCycleConfiguration::DurationUnit }
|
5594
5561
|
|
5595
5562
|
# @!method initialize(duration:, duration_unit:)
|
5596
5563
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
@@ -5598,11 +5565,11 @@ module Orb
|
|
5598
5565
|
#
|
5599
5566
|
# @param duration [Integer] The duration of the billing period.
|
5600
5567
|
#
|
5601
|
-
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::
|
5568
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::MaxGroupTieredPackage::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
5602
5569
|
|
5603
5570
|
# The unit of billing period duration.
|
5604
5571
|
#
|
5605
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
5572
|
+
# @see Orb::Models::PlanCreateParams::Price::MaxGroupTieredPackage::InvoicingCycleConfiguration#duration_unit
|
5606
5573
|
module DurationUnit
|
5607
5574
|
extend Orb::Internal::Type::Enum
|
5608
5575
|
|
@@ -5615,13 +5582,13 @@ module Orb
|
|
5615
5582
|
end
|
5616
5583
|
end
|
5617
5584
|
|
5618
|
-
class
|
5585
|
+
class ScalableMatrixWithUnitPricing < Orb::Internal::Type::BaseModel
|
5619
5586
|
# @!attribute cadence
|
5620
5587
|
# The cadence to bill for this price on.
|
5621
5588
|
#
|
5622
|
-
# @return [Symbol, Orb::Models::PlanCreateParams::Price::
|
5589
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::ScalableMatrixWithUnitPricing::Cadence]
|
5623
5590
|
required :cadence,
|
5624
|
-
enum: -> { Orb::Models::PlanCreateParams::Price::
|
5591
|
+
enum: -> { Orb::Models::PlanCreateParams::Price::ScalableMatrixWithUnitPricing::Cadence }
|
5625
5592
|
|
5626
5593
|
# @!attribute item_id
|
5627
5594
|
# The id of the item the price will be associated with.
|
@@ -5664,9 +5631,9 @@ module Orb
|
|
5664
5631
|
# For custom cadence: specifies the duration of the billing period in days or
|
5665
5632
|
# months.
|
5666
5633
|
#
|
5667
|
-
# @return [Orb::Models::PlanCreateParams::Price::
|
5634
|
+
# @return [Orb::Models::PlanCreateParams::Price::ScalableMatrixWithUnitPricing::BillingCycleConfiguration, nil]
|
5668
5635
|
optional :billing_cycle_configuration,
|
5669
|
-
-> { Orb::Models::PlanCreateParams::Price::
|
5636
|
+
-> { Orb::Models::PlanCreateParams::Price::ScalableMatrixWithUnitPricing::BillingCycleConfiguration },
|
5670
5637
|
nil?: true
|
5671
5638
|
|
5672
5639
|
# @!attribute conversion_rate
|
@@ -5705,9 +5672,9 @@ module Orb
|
|
5705
5672
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
5706
5673
|
# If unspecified, a single invoice is produced per billing cycle.
|
5707
5674
|
#
|
5708
|
-
# @return [Orb::Models::PlanCreateParams::Price::
|
5675
|
+
# @return [Orb::Models::PlanCreateParams::Price::ScalableMatrixWithUnitPricing::InvoicingCycleConfiguration, nil]
|
5709
5676
|
optional :invoicing_cycle_configuration,
|
5710
|
-
-> { Orb::Models::PlanCreateParams::Price::
|
5677
|
+
-> { Orb::Models::PlanCreateParams::Price::ScalableMatrixWithUnitPricing::InvoicingCycleConfiguration },
|
5711
5678
|
nil?: true
|
5712
5679
|
|
5713
5680
|
# @!attribute metadata
|
@@ -5720,10 +5687,10 @@ module Orb
|
|
5720
5687
|
|
5721
5688
|
# @!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
5689
|
# Some parameter documentations has been truncated, see
|
5723
|
-
# {Orb::Models::PlanCreateParams::Price::
|
5724
|
-
#
|
5690
|
+
# {Orb::Models::PlanCreateParams::Price::ScalableMatrixWithUnitPricing} for more
|
5691
|
+
# details.
|
5725
5692
|
#
|
5726
|
-
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::
|
5693
|
+
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::ScalableMatrixWithUnitPricing::Cadence] The cadence to bill for this price on.
|
5727
5694
|
#
|
5728
5695
|
# @param item_id [String] The id of the item the price will be associated with.
|
5729
5696
|
#
|
@@ -5737,7 +5704,7 @@ module Orb
|
|
5737
5704
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
5738
5705
|
# ...
|
5739
5706
|
#
|
5740
|
-
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::
|
5707
|
+
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::ScalableMatrixWithUnitPricing::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
5741
5708
|
# ...
|
5742
5709
|
#
|
5743
5710
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
@@ -5752,7 +5719,7 @@ module Orb
|
|
5752
5719
|
#
|
5753
5720
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
5754
5721
|
#
|
5755
|
-
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::
|
5722
|
+
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::ScalableMatrixWithUnitPricing::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
5756
5723
|
# ...
|
5757
5724
|
#
|
5758
5725
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
@@ -5762,7 +5729,7 @@ module Orb
|
|
5762
5729
|
|
5763
5730
|
# The cadence to bill for this price on.
|
5764
5731
|
#
|
5765
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
5732
|
+
# @see Orb::Models::PlanCreateParams::Price::ScalableMatrixWithUnitPricing#cadence
|
5766
5733
|
module Cadence
|
5767
5734
|
extend Orb::Internal::Type::Enum
|
5768
5735
|
|
@@ -5777,7 +5744,7 @@ module Orb
|
|
5777
5744
|
# @return [Array<Symbol>]
|
5778
5745
|
end
|
5779
5746
|
|
5780
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
5747
|
+
# @see Orb::Models::PlanCreateParams::Price::ScalableMatrixWithUnitPricing#billing_cycle_configuration
|
5781
5748
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
5782
5749
|
# @!attribute duration
|
5783
5750
|
# The duration of the billing period.
|
@@ -5788,9 +5755,9 @@ module Orb
|
|
5788
5755
|
# @!attribute duration_unit
|
5789
5756
|
# The unit of billing period duration.
|
5790
5757
|
#
|
5791
|
-
# @return [Symbol, Orb::Models::PlanCreateParams::Price::
|
5758
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::ScalableMatrixWithUnitPricing::BillingCycleConfiguration::DurationUnit]
|
5792
5759
|
required :duration_unit,
|
5793
|
-
enum: -> { Orb::Models::PlanCreateParams::Price::
|
5760
|
+
enum: -> { Orb::Models::PlanCreateParams::Price::ScalableMatrixWithUnitPricing::BillingCycleConfiguration::DurationUnit }
|
5794
5761
|
|
5795
5762
|
# @!method initialize(duration:, duration_unit:)
|
5796
5763
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -5798,11 +5765,11 @@ module Orb
|
|
5798
5765
|
#
|
5799
5766
|
# @param duration [Integer] The duration of the billing period.
|
5800
5767
|
#
|
5801
|
-
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::
|
5768
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::ScalableMatrixWithUnitPricing::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
5802
5769
|
|
5803
5770
|
# The unit of billing period duration.
|
5804
5771
|
#
|
5805
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
5772
|
+
# @see Orb::Models::PlanCreateParams::Price::ScalableMatrixWithUnitPricing::BillingCycleConfiguration#duration_unit
|
5806
5773
|
module DurationUnit
|
5807
5774
|
extend Orb::Internal::Type::Enum
|
5808
5775
|
|
@@ -5814,7 +5781,7 @@ module Orb
|
|
5814
5781
|
end
|
5815
5782
|
end
|
5816
5783
|
|
5817
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
5784
|
+
# @see Orb::Models::PlanCreateParams::Price::ScalableMatrixWithUnitPricing#invoicing_cycle_configuration
|
5818
5785
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
5819
5786
|
# @!attribute duration
|
5820
5787
|
# The duration of the billing period.
|
@@ -5825,9 +5792,9 @@ module Orb
|
|
5825
5792
|
# @!attribute duration_unit
|
5826
5793
|
# The unit of billing period duration.
|
5827
5794
|
#
|
5828
|
-
# @return [Symbol, Orb::Models::PlanCreateParams::Price::
|
5795
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::ScalableMatrixWithUnitPricing::InvoicingCycleConfiguration::DurationUnit]
|
5829
5796
|
required :duration_unit,
|
5830
|
-
enum: -> { Orb::Models::PlanCreateParams::Price::
|
5797
|
+
enum: -> { Orb::Models::PlanCreateParams::Price::ScalableMatrixWithUnitPricing::InvoicingCycleConfiguration::DurationUnit }
|
5831
5798
|
|
5832
5799
|
# @!method initialize(duration:, duration_unit:)
|
5833
5800
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
@@ -5835,11 +5802,11 @@ module Orb
|
|
5835
5802
|
#
|
5836
5803
|
# @param duration [Integer] The duration of the billing period.
|
5837
5804
|
#
|
5838
|
-
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::
|
5805
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::ScalableMatrixWithUnitPricing::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
5839
5806
|
|
5840
5807
|
# The unit of billing period duration.
|
5841
5808
|
#
|
5842
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
5809
|
+
# @see Orb::Models::PlanCreateParams::Price::ScalableMatrixWithUnitPricing::InvoicingCycleConfiguration#duration_unit
|
5843
5810
|
module DurationUnit
|
5844
5811
|
extend Orb::Internal::Type::Enum
|
5845
5812
|
|
@@ -5852,13 +5819,13 @@ module Orb
|
|
5852
5819
|
end
|
5853
5820
|
end
|
5854
5821
|
|
5855
|
-
class
|
5822
|
+
class ScalableMatrixWithTieredPricing < Orb::Internal::Type::BaseModel
|
5856
5823
|
# @!attribute cadence
|
5857
5824
|
# The cadence to bill for this price on.
|
5858
5825
|
#
|
5859
|
-
# @return [Symbol, Orb::Models::PlanCreateParams::Price::
|
5826
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::ScalableMatrixWithTieredPricing::Cadence]
|
5860
5827
|
required :cadence,
|
5861
|
-
enum: -> { Orb::Models::PlanCreateParams::Price::
|
5828
|
+
enum: -> { Orb::Models::PlanCreateParams::Price::ScalableMatrixWithTieredPricing::Cadence }
|
5862
5829
|
|
5863
5830
|
# @!attribute item_id
|
5864
5831
|
# The id of the item the price will be associated with.
|
@@ -5901,9 +5868,9 @@ module Orb
|
|
5901
5868
|
# For custom cadence: specifies the duration of the billing period in days or
|
5902
5869
|
# months.
|
5903
5870
|
#
|
5904
|
-
# @return [Orb::Models::PlanCreateParams::Price::
|
5871
|
+
# @return [Orb::Models::PlanCreateParams::Price::ScalableMatrixWithTieredPricing::BillingCycleConfiguration, nil]
|
5905
5872
|
optional :billing_cycle_configuration,
|
5906
|
-
-> { Orb::Models::PlanCreateParams::Price::
|
5873
|
+
-> { Orb::Models::PlanCreateParams::Price::ScalableMatrixWithTieredPricing::BillingCycleConfiguration },
|
5907
5874
|
nil?: true
|
5908
5875
|
|
5909
5876
|
# @!attribute conversion_rate
|
@@ -5942,9 +5909,9 @@ module Orb
|
|
5942
5909
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
5943
5910
|
# If unspecified, a single invoice is produced per billing cycle.
|
5944
5911
|
#
|
5945
|
-
# @return [Orb::Models::PlanCreateParams::Price::
|
5912
|
+
# @return [Orb::Models::PlanCreateParams::Price::ScalableMatrixWithTieredPricing::InvoicingCycleConfiguration, nil]
|
5946
5913
|
optional :invoicing_cycle_configuration,
|
5947
|
-
-> { Orb::Models::PlanCreateParams::Price::
|
5914
|
+
-> { Orb::Models::PlanCreateParams::Price::ScalableMatrixWithTieredPricing::InvoicingCycleConfiguration },
|
5948
5915
|
nil?: true
|
5949
5916
|
|
5950
5917
|
# @!attribute metadata
|
@@ -5957,10 +5924,10 @@ module Orb
|
|
5957
5924
|
|
5958
5925
|
# @!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
5926
|
# Some parameter documentations has been truncated, see
|
5960
|
-
# {Orb::Models::PlanCreateParams::Price::
|
5961
|
-
#
|
5927
|
+
# {Orb::Models::PlanCreateParams::Price::ScalableMatrixWithTieredPricing} for more
|
5928
|
+
# details.
|
5962
5929
|
#
|
5963
|
-
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::
|
5930
|
+
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::ScalableMatrixWithTieredPricing::Cadence] The cadence to bill for this price on.
|
5964
5931
|
#
|
5965
5932
|
# @param item_id [String] The id of the item the price will be associated with.
|
5966
5933
|
#
|
@@ -5974,7 +5941,7 @@ module Orb
|
|
5974
5941
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
5975
5942
|
# ...
|
5976
5943
|
#
|
5977
|
-
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::
|
5944
|
+
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::ScalableMatrixWithTieredPricing::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
5978
5945
|
# ...
|
5979
5946
|
#
|
5980
5947
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
@@ -5989,7 +5956,7 @@ module Orb
|
|
5989
5956
|
#
|
5990
5957
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
5991
5958
|
#
|
5992
|
-
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::
|
5959
|
+
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::ScalableMatrixWithTieredPricing::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
5993
5960
|
# ...
|
5994
5961
|
#
|
5995
5962
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
@@ -5999,7 +5966,7 @@ module Orb
|
|
5999
5966
|
|
6000
5967
|
# The cadence to bill for this price on.
|
6001
5968
|
#
|
6002
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
5969
|
+
# @see Orb::Models::PlanCreateParams::Price::ScalableMatrixWithTieredPricing#cadence
|
6003
5970
|
module Cadence
|
6004
5971
|
extend Orb::Internal::Type::Enum
|
6005
5972
|
|
@@ -6014,7 +5981,7 @@ module Orb
|
|
6014
5981
|
# @return [Array<Symbol>]
|
6015
5982
|
end
|
6016
5983
|
|
6017
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
5984
|
+
# @see Orb::Models::PlanCreateParams::Price::ScalableMatrixWithTieredPricing#billing_cycle_configuration
|
6018
5985
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
6019
5986
|
# @!attribute duration
|
6020
5987
|
# The duration of the billing period.
|
@@ -6025,9 +5992,9 @@ module Orb
|
|
6025
5992
|
# @!attribute duration_unit
|
6026
5993
|
# The unit of billing period duration.
|
6027
5994
|
#
|
6028
|
-
# @return [Symbol, Orb::Models::PlanCreateParams::Price::
|
5995
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::ScalableMatrixWithTieredPricing::BillingCycleConfiguration::DurationUnit]
|
6029
5996
|
required :duration_unit,
|
6030
|
-
enum: -> { Orb::Models::PlanCreateParams::Price::
|
5997
|
+
enum: -> { Orb::Models::PlanCreateParams::Price::ScalableMatrixWithTieredPricing::BillingCycleConfiguration::DurationUnit }
|
6031
5998
|
|
6032
5999
|
# @!method initialize(duration:, duration_unit:)
|
6033
6000
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -6035,11 +6002,11 @@ module Orb
|
|
6035
6002
|
#
|
6036
6003
|
# @param duration [Integer] The duration of the billing period.
|
6037
6004
|
#
|
6038
|
-
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::
|
6005
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::ScalableMatrixWithTieredPricing::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
6039
6006
|
|
6040
6007
|
# The unit of billing period duration.
|
6041
6008
|
#
|
6042
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
6009
|
+
# @see Orb::Models::PlanCreateParams::Price::ScalableMatrixWithTieredPricing::BillingCycleConfiguration#duration_unit
|
6043
6010
|
module DurationUnit
|
6044
6011
|
extend Orb::Internal::Type::Enum
|
6045
6012
|
|
@@ -6051,7 +6018,7 @@ module Orb
|
|
6051
6018
|
end
|
6052
6019
|
end
|
6053
6020
|
|
6054
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
6021
|
+
# @see Orb::Models::PlanCreateParams::Price::ScalableMatrixWithTieredPricing#invoicing_cycle_configuration
|
6055
6022
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
6056
6023
|
# @!attribute duration
|
6057
6024
|
# The duration of the billing period.
|
@@ -6062,9 +6029,9 @@ module Orb
|
|
6062
6029
|
# @!attribute duration_unit
|
6063
6030
|
# The unit of billing period duration.
|
6064
6031
|
#
|
6065
|
-
# @return [Symbol, Orb::Models::PlanCreateParams::Price::
|
6032
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::ScalableMatrixWithTieredPricing::InvoicingCycleConfiguration::DurationUnit]
|
6066
6033
|
required :duration_unit,
|
6067
|
-
enum: -> { Orb::Models::PlanCreateParams::Price::
|
6034
|
+
enum: -> { Orb::Models::PlanCreateParams::Price::ScalableMatrixWithTieredPricing::InvoicingCycleConfiguration::DurationUnit }
|
6068
6035
|
|
6069
6036
|
# @!method initialize(duration:, duration_unit:)
|
6070
6037
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
@@ -6072,11 +6039,11 @@ module Orb
|
|
6072
6039
|
#
|
6073
6040
|
# @param duration [Integer] The duration of the billing period.
|
6074
6041
|
#
|
6075
|
-
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::
|
6042
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::ScalableMatrixWithTieredPricing::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
6076
6043
|
|
6077
6044
|
# The unit of billing period duration.
|
6078
6045
|
#
|
6079
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
6046
|
+
# @see Orb::Models::PlanCreateParams::Price::ScalableMatrixWithTieredPricing::InvoicingCycleConfiguration#duration_unit
|
6080
6047
|
module DurationUnit
|
6081
6048
|
extend Orb::Internal::Type::Enum
|
6082
6049
|
|
@@ -6089,13 +6056,12 @@ module Orb
|
|
6089
6056
|
end
|
6090
6057
|
end
|
6091
6058
|
|
6092
|
-
class
|
6059
|
+
class CumulativeGroupedBulk < Orb::Internal::Type::BaseModel
|
6093
6060
|
# @!attribute cadence
|
6094
6061
|
# The cadence to bill for this price on.
|
6095
6062
|
#
|
6096
|
-
# @return [Symbol, Orb::Models::PlanCreateParams::Price::
|
6097
|
-
required :cadence,
|
6098
|
-
enum: -> { Orb::Models::PlanCreateParams::Price::NewPlanCumulativeGroupedBulkPrice::Cadence }
|
6063
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::CumulativeGroupedBulk::Cadence]
|
6064
|
+
required :cadence, enum: -> { Orb::Models::PlanCreateParams::Price::CumulativeGroupedBulk::Cadence }
|
6099
6065
|
|
6100
6066
|
# @!attribute cumulative_grouped_bulk_config
|
6101
6067
|
#
|
@@ -6137,9 +6103,9 @@ module Orb
|
|
6137
6103
|
# For custom cadence: specifies the duration of the billing period in days or
|
6138
6104
|
# months.
|
6139
6105
|
#
|
6140
|
-
# @return [Orb::Models::PlanCreateParams::Price::
|
6106
|
+
# @return [Orb::Models::PlanCreateParams::Price::CumulativeGroupedBulk::BillingCycleConfiguration, nil]
|
6141
6107
|
optional :billing_cycle_configuration,
|
6142
|
-
-> { Orb::Models::PlanCreateParams::Price::
|
6108
|
+
-> { Orb::Models::PlanCreateParams::Price::CumulativeGroupedBulk::BillingCycleConfiguration },
|
6143
6109
|
nil?: true
|
6144
6110
|
|
6145
6111
|
# @!attribute conversion_rate
|
@@ -6178,9 +6144,9 @@ module Orb
|
|
6178
6144
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
6179
6145
|
# If unspecified, a single invoice is produced per billing cycle.
|
6180
6146
|
#
|
6181
|
-
# @return [Orb::Models::PlanCreateParams::Price::
|
6147
|
+
# @return [Orb::Models::PlanCreateParams::Price::CumulativeGroupedBulk::InvoicingCycleConfiguration, nil]
|
6182
6148
|
optional :invoicing_cycle_configuration,
|
6183
|
-
-> { Orb::Models::PlanCreateParams::Price::
|
6149
|
+
-> { Orb::Models::PlanCreateParams::Price::CumulativeGroupedBulk::InvoicingCycleConfiguration },
|
6184
6150
|
nil?: true
|
6185
6151
|
|
6186
6152
|
# @!attribute metadata
|
@@ -6193,10 +6159,9 @@ module Orb
|
|
6193
6159
|
|
6194
6160
|
# @!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
6161
|
# Some parameter documentations has been truncated, see
|
6196
|
-
# {Orb::Models::PlanCreateParams::Price::
|
6197
|
-
# more details.
|
6162
|
+
# {Orb::Models::PlanCreateParams::Price::CumulativeGroupedBulk} for more details.
|
6198
6163
|
#
|
6199
|
-
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::
|
6164
|
+
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::CumulativeGroupedBulk::Cadence] The cadence to bill for this price on.
|
6200
6165
|
#
|
6201
6166
|
# @param cumulative_grouped_bulk_config [Hash{Symbol=>Object}]
|
6202
6167
|
#
|
@@ -6210,7 +6175,7 @@ module Orb
|
|
6210
6175
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
6211
6176
|
# ...
|
6212
6177
|
#
|
6213
|
-
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::
|
6178
|
+
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::CumulativeGroupedBulk::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
6214
6179
|
# ...
|
6215
6180
|
#
|
6216
6181
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
@@ -6225,7 +6190,7 @@ module Orb
|
|
6225
6190
|
#
|
6226
6191
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
6227
6192
|
#
|
6228
|
-
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::
|
6193
|
+
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::CumulativeGroupedBulk::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
6229
6194
|
# ...
|
6230
6195
|
#
|
6231
6196
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
@@ -6235,7 +6200,7 @@ module Orb
|
|
6235
6200
|
|
6236
6201
|
# The cadence to bill for this price on.
|
6237
6202
|
#
|
6238
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
6203
|
+
# @see Orb::Models::PlanCreateParams::Price::CumulativeGroupedBulk#cadence
|
6239
6204
|
module Cadence
|
6240
6205
|
extend Orb::Internal::Type::Enum
|
6241
6206
|
|
@@ -6250,7 +6215,7 @@ module Orb
|
|
6250
6215
|
# @return [Array<Symbol>]
|
6251
6216
|
end
|
6252
6217
|
|
6253
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
6218
|
+
# @see Orb::Models::PlanCreateParams::Price::CumulativeGroupedBulk#billing_cycle_configuration
|
6254
6219
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
6255
6220
|
# @!attribute duration
|
6256
6221
|
# The duration of the billing period.
|
@@ -6261,9 +6226,9 @@ module Orb
|
|
6261
6226
|
# @!attribute duration_unit
|
6262
6227
|
# The unit of billing period duration.
|
6263
6228
|
#
|
6264
|
-
# @return [Symbol, Orb::Models::PlanCreateParams::Price::
|
6229
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::CumulativeGroupedBulk::BillingCycleConfiguration::DurationUnit]
|
6265
6230
|
required :duration_unit,
|
6266
|
-
enum: -> { Orb::Models::PlanCreateParams::Price::
|
6231
|
+
enum: -> { Orb::Models::PlanCreateParams::Price::CumulativeGroupedBulk::BillingCycleConfiguration::DurationUnit }
|
6267
6232
|
|
6268
6233
|
# @!method initialize(duration:, duration_unit:)
|
6269
6234
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -6271,11 +6236,11 @@ module Orb
|
|
6271
6236
|
#
|
6272
6237
|
# @param duration [Integer] The duration of the billing period.
|
6273
6238
|
#
|
6274
|
-
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::
|
6239
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::CumulativeGroupedBulk::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
6275
6240
|
|
6276
6241
|
# The unit of billing period duration.
|
6277
6242
|
#
|
6278
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
6243
|
+
# @see Orb::Models::PlanCreateParams::Price::CumulativeGroupedBulk::BillingCycleConfiguration#duration_unit
|
6279
6244
|
module DurationUnit
|
6280
6245
|
extend Orb::Internal::Type::Enum
|
6281
6246
|
|
@@ -6287,7 +6252,7 @@ module Orb
|
|
6287
6252
|
end
|
6288
6253
|
end
|
6289
6254
|
|
6290
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
6255
|
+
# @see Orb::Models::PlanCreateParams::Price::CumulativeGroupedBulk#invoicing_cycle_configuration
|
6291
6256
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
6292
6257
|
# @!attribute duration
|
6293
6258
|
# The duration of the billing period.
|
@@ -6298,9 +6263,9 @@ module Orb
|
|
6298
6263
|
# @!attribute duration_unit
|
6299
6264
|
# The unit of billing period duration.
|
6300
6265
|
#
|
6301
|
-
# @return [Symbol, Orb::Models::PlanCreateParams::Price::
|
6266
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::CumulativeGroupedBulk::InvoicingCycleConfiguration::DurationUnit]
|
6302
6267
|
required :duration_unit,
|
6303
|
-
enum: -> { Orb::Models::PlanCreateParams::Price::
|
6268
|
+
enum: -> { Orb::Models::PlanCreateParams::Price::CumulativeGroupedBulk::InvoicingCycleConfiguration::DurationUnit }
|
6304
6269
|
|
6305
6270
|
# @!method initialize(duration:, duration_unit:)
|
6306
6271
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
@@ -6308,11 +6273,11 @@ module Orb
|
|
6308
6273
|
#
|
6309
6274
|
# @param duration [Integer] The duration of the billing period.
|
6310
6275
|
#
|
6311
|
-
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::
|
6276
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::CumulativeGroupedBulk::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
6312
6277
|
|
6313
6278
|
# The unit of billing period duration.
|
6314
6279
|
#
|
6315
|
-
# @see Orb::Models::PlanCreateParams::Price::
|
6280
|
+
# @see Orb::Models::PlanCreateParams::Price::CumulativeGroupedBulk::InvoicingCycleConfiguration#duration_unit
|
6316
6281
|
module DurationUnit
|
6317
6282
|
extend Orb::Internal::Type::Enum
|
6318
6283
|
|
@@ -6326,7 +6291,7 @@ module Orb
|
|
6326
6291
|
end
|
6327
6292
|
|
6328
6293
|
# @!method self.variants
|
6329
|
-
# @return [Array(Orb::Models::PlanCreateParams::Price::
|
6294
|
+
# @return [Array(Orb::Models::PlanCreateParams::Price::Unit, Orb::Models::PlanCreateParams::Price::Package, Orb::Models::PlanCreateParams::Price::Matrix, Orb::Models::PlanCreateParams::Price::Tiered, Orb::Models::PlanCreateParams::Price::TieredBps, Orb::Models::PlanCreateParams::Price::Bps, Orb::Models::PlanCreateParams::Price::BulkBps, Orb::Models::PlanCreateParams::Price::Bulk, Orb::Models::PlanCreateParams::Price::ThresholdTotalAmount, Orb::Models::PlanCreateParams::Price::TieredPackage, Orb::Models::PlanCreateParams::Price::TieredWithMinimum, Orb::Models::PlanCreateParams::Price::UnitWithPercent, Orb::Models::PlanCreateParams::Price::PackageWithAllocation, Orb::Models::PlanCreateParams::Price::TieredWithProration, Orb::Models::PlanCreateParams::Price::UnitWithProration, Orb::Models::PlanCreateParams::Price::GroupedAllocation, Orb::Models::PlanCreateParams::Price::GroupedWithProratedMinimum, Orb::Models::PlanCreateParams::Price::GroupedWithMeteredMinimum, Orb::Models::PlanCreateParams::Price::MatrixWithDisplayName, Orb::Models::PlanCreateParams::Price::BulkWithProration, Orb::Models::PlanCreateParams::Price::GroupedTieredPackage, Orb::Models::PlanCreateParams::Price::MaxGroupTieredPackage, Orb::Models::PlanCreateParams::Price::ScalableMatrixWithUnitPricing, Orb::Models::PlanCreateParams::Price::ScalableMatrixWithTieredPricing, Orb::Models::PlanCreateParams::Price::CumulativeGroupedBulk)]
|
6330
6295
|
end
|
6331
6296
|
|
6332
6297
|
# The status of the plan to create (either active or draft). If not specified,
|