orb-billing 0.1.0.pre.alpha.38 → 0.1.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/README.md +10 -2
- data/lib/orb/client.rb +4 -0
- data/lib/orb/internal/transport/base_client.rb +2 -2
- data/lib/orb/internal/transport/pooled_net_requester.rb +15 -6
- data/lib/orb/internal/type/array_of.rb +12 -2
- data/lib/orb/internal/type/base_model.rb +23 -22
- data/lib/orb/internal/type/boolean.rb +5 -1
- data/lib/orb/internal/type/converter.rb +62 -39
- data/lib/orb/internal/type/enum.rb +13 -9
- data/lib/orb/internal/type/hash_of.rb +6 -2
- data/lib/orb/internal/type/io_like.rb +75 -0
- data/lib/orb/internal/type/request_parameters.rb +11 -2
- data/lib/orb/internal/type/union.rb +7 -3
- data/lib/orb/internal/type/unknown.rb +5 -1
- data/lib/orb/internal/util.rb +81 -26
- data/lib/orb/models/alert.rb +9 -9
- data/lib/orb/models/alert_create_for_customer_params.rb +3 -3
- data/lib/orb/models/alert_create_for_external_customer_params.rb +3 -3
- data/lib/orb/models/alert_create_for_subscription_params.rb +3 -3
- data/lib/orb/models/alert_list_params.rb +5 -5
- data/lib/orb/models/alert_update_params.rb +3 -3
- data/lib/orb/models/amount_discount.rb +1 -1
- data/lib/orb/models/billable_metric.rb +7 -7
- data/lib/orb/models/coupon.rb +7 -7
- data/lib/orb/models/coupon_create_params.rb +2 -2
- data/lib/orb/models/coupon_list_params.rb +2 -2
- data/lib/orb/models/coupons/subscription_list_params.rb +1 -1
- data/lib/orb/models/credit_note.rb +1 -1
- data/lib/orb/models/credit_note_list_params.rb +5 -5
- data/lib/orb/models/customer.rb +232 -232
- data/lib/orb/models/customer_create_params.rb +223 -223
- data/lib/orb/models/customer_list_params.rb +5 -5
- data/lib/orb/models/customer_update_by_external_id_params.rb +224 -224
- data/lib/orb/models/customer_update_params.rb +224 -224
- data/lib/orb/models/customers/balance_transaction_create_response.rb +2 -2
- data/lib/orb/models/customers/balance_transaction_list_params.rb +5 -5
- data/lib/orb/models/customers/balance_transaction_list_response.rb +2 -2
- data/lib/orb/models/customers/cost_list_by_external_id_params.rb +6 -6
- data/lib/orb/models/customers/cost_list_params.rb +6 -6
- data/lib/orb/models/customers/credit_list_by_external_id_params.rb +2 -2
- data/lib/orb/models/customers/credit_list_params.rb +2 -2
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +20 -20
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +22 -22
- data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +20 -20
- data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +22 -22
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +5 -5
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +22 -22
- data/lib/orb/models/customers/credits/ledger_list_params.rb +5 -5
- data/lib/orb/models/customers/credits/ledger_list_response.rb +22 -22
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +8 -8
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb +7 -7
- data/lib/orb/models/customers/credits/top_up_create_params.rb +8 -8
- data/lib/orb/models/customers/credits/top_up_create_response.rb +7 -7
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rb +1 -1
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb +7 -7
- data/lib/orb/models/customers/credits/top_up_list_params.rb +1 -1
- data/lib/orb/models/customers/credits/top_up_list_response.rb +7 -7
- data/lib/orb/models/dimensional_price_group.rb +7 -7
- data/lib/orb/models/dimensional_price_group_create_params.rb +2 -2
- data/lib/orb/models/dimensional_price_group_list_params.rb +1 -1
- data/lib/orb/models/event_ingest_params.rb +7 -7
- data/lib/orb/models/event_ingest_response.rb +4 -4
- data/lib/orb/models/event_search_params.rb +5 -5
- data/lib/orb/models/event_search_response.rb +8 -8
- data/lib/orb/models/event_update_params.rb +4 -4
- data/lib/orb/models/events/backfill_close_response.rb +7 -7
- data/lib/orb/models/events/backfill_create_params.rb +11 -11
- data/lib/orb/models/events/backfill_create_response.rb +7 -7
- data/lib/orb/models/events/backfill_fetch_response.rb +7 -7
- data/lib/orb/models/events/backfill_list_params.rb +1 -1
- data/lib/orb/models/events/backfill_list_response.rb +7 -7
- data/lib/orb/models/events/backfill_revert_response.rb +7 -7
- data/lib/orb/models/events/event_volumes.rb +1 -1
- data/lib/orb/models/events/volume_list_params.rb +7 -7
- data/lib/orb/models/invoice.rb +270 -270
- data/lib/orb/models/invoice_create_params.rb +12 -11
- data/lib/orb/models/invoice_fetch_upcoming_response.rb +266 -266
- data/lib/orb/models/invoice_issue_params.rb +4 -4
- data/lib/orb/models/invoice_line_item_create_params.rb +1 -1
- data/lib/orb/models/invoice_line_item_create_response.rb +27 -27
- data/lib/orb/models/invoice_list_params.rb +12 -12
- data/lib/orb/models/invoice_update_params.rb +2 -2
- data/lib/orb/models/item.rb +2 -2
- data/lib/orb/models/item_list_params.rb +1 -1
- data/lib/orb/models/metric_create_params.rb +2 -2
- data/lib/orb/models/metric_list_params.rb +5 -5
- data/lib/orb/models/metric_update_params.rb +2 -2
- data/lib/orb/models/percentage_discount.rb +2 -2
- data/lib/orb/models/plan.rb +35 -35
- data/lib/orb/models/plan_create_params.rb +267 -267
- data/lib/orb/models/plan_list_params.rb +5 -5
- data/lib/orb/models/plan_update_params.rb +4 -4
- data/lib/orb/models/plans/external_plan_id_update_params.rb +4 -4
- data/lib/orb/models/price.rb +158 -158
- data/lib/orb/models/price_create_params.rb +20 -20
- data/lib/orb/models/price_evaluate_params.rb +4 -4
- data/lib/orb/models/price_list_params.rb +1 -1
- data/lib/orb/models/price_update_params.rb +2 -2
- data/lib/orb/models/prices/external_price_id_update_params.rb +2 -2
- data/lib/orb/models/subscription.rb +114 -87
- data/lib/orb/models/subscription_cancel_params.rb +3 -3
- data/lib/orb/models/subscription_cancel_response.rb +150 -72
- data/lib/orb/models/subscription_change_apply_params.rb +33 -0
- data/lib/orb/models/subscription_change_apply_response.rb +1372 -0
- data/lib/orb/models/subscription_change_cancel_params.rb +19 -0
- data/lib/orb/models/subscription_change_cancel_response.rb +1372 -0
- data/lib/orb/models/subscription_change_retrieve_params.rb +19 -0
- data/lib/orb/models/subscription_change_retrieve_response.rb +1372 -0
- data/lib/orb/models/subscription_create_params.rb +641 -641
- data/lib/orb/models/subscription_create_response.rb +150 -72
- data/lib/orb/models/subscription_fetch_costs_params.rb +6 -6
- data/lib/orb/models/subscription_fetch_schedule_params.rb +5 -5
- data/lib/orb/models/subscription_fetch_schedule_response.rb +2 -2
- data/lib/orb/models/subscription_fetch_usage_params.rb +8 -8
- data/lib/orb/models/subscription_list_params.rb +5 -5
- data/lib/orb/models/subscription_price_intervals_params.rb +323 -323
- data/lib/orb/models/subscription_price_intervals_response.rb +152 -72
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +651 -651
- data/lib/orb/models/subscription_schedule_plan_change_response.rb +152 -72
- data/lib/orb/models/subscription_trigger_phase_params.rb +3 -3
- data/lib/orb/models/subscription_trigger_phase_response.rb +152 -72
- data/lib/orb/models/subscription_unschedule_cancellation_response.rb +152 -72
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +153 -73
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +152 -72
- data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +8 -8
- data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +152 -72
- data/lib/orb/models/subscription_update_params.rb +10 -10
- data/lib/orb/models/subscription_update_trial_params.rb +3 -3
- data/lib/orb/models/subscription_update_trial_response.rb +152 -72
- data/lib/orb/models/trial_discount.rb +1 -1
- data/lib/orb/models/usage_discount.rb +2 -2
- data/lib/orb/request_options.rb +7 -7
- data/lib/orb/resources/alerts.rb +38 -38
- data/lib/orb/resources/coupons/subscriptions.rb +3 -3
- data/lib/orb/resources/coupons.rb +9 -9
- data/lib/orb/resources/credit_notes.rb +8 -8
- data/lib/orb/resources/customers/balance_transactions.rb +26 -26
- data/lib/orb/resources/customers/costs.rb +232 -232
- data/lib/orb/resources/customers/credits/ledger.rb +344 -344
- data/lib/orb/resources/customers/credits/top_ups.rb +12 -12
- data/lib/orb/resources/customers/credits.rb +8 -8
- data/lib/orb/resources/customers.rb +59 -59
- data/lib/orb/resources/dimensional_price_groups.rb +6 -6
- data/lib/orb/resources/events/backfills.rb +49 -49
- data/lib/orb/resources/events/volume.rb +10 -10
- data/lib/orb/resources/events.rb +295 -295
- data/lib/orb/resources/invoice_line_items.rb +1 -1
- data/lib/orb/resources/invoices.rb +38 -38
- data/lib/orb/resources/items.rb +1 -1
- data/lib/orb/resources/metrics.rb +11 -11
- data/lib/orb/resources/plans/external_plan_id.rb +14 -14
- data/lib/orb/resources/plans.rb +22 -22
- data/lib/orb/resources/prices/external_price_id.rb +4 -4
- data/lib/orb/resources/prices.rb +30 -30
- data/lib/orb/resources/subscription_changes.rb +87 -0
- data/lib/orb/resources/subscriptions.rb +813 -813
- data/lib/orb/resources/top_level.rb +4 -4
- data/lib/orb/version.rb +1 -1
- data/lib/orb.rb +8 -0
- data/rbi/lib/orb/client.rbi +5 -4
- data/rbi/lib/orb/errors.rbi +3 -6
- data/rbi/lib/orb/internal/page.rbi +3 -6
- data/rbi/lib/orb/internal/transport/base_client.rbi +13 -27
- data/rbi/lib/orb/internal/transport/pooled_net_requester.rbi +8 -14
- data/rbi/lib/orb/internal/type/array_of.rbi +14 -18
- data/rbi/lib/orb/internal/type/base_model.rbi +51 -66
- data/rbi/lib/orb/internal/type/base_page.rbi +5 -10
- data/rbi/lib/orb/internal/type/boolean.rbi +12 -10
- data/rbi/lib/orb/internal/type/converter.rbi +44 -37
- data/rbi/lib/orb/internal/type/enum.rbi +24 -21
- data/rbi/lib/orb/internal/type/hash_of.rbi +13 -18
- data/rbi/lib/orb/internal/type/io_like.rbi +49 -0
- data/rbi/lib/orb/internal/type/request_parameters.rbi +1 -2
- data/rbi/lib/orb/internal/type/union.rbi +19 -21
- data/rbi/lib/orb/internal/type/unknown.rbi +10 -9
- data/rbi/lib/orb/internal/util.rbi +67 -70
- data/rbi/lib/orb/internal.rbi +1 -1
- data/rbi/lib/orb/models/alert.rbi +21 -33
- data/rbi/lib/orb/models/alert_create_for_customer_params.rbi +8 -13
- data/rbi/lib/orb/models/alert_create_for_external_customer_params.rbi +8 -13
- data/rbi/lib/orb/models/alert_create_for_subscription_params.rbi +8 -13
- data/rbi/lib/orb/models/alert_disable_params.rbi +2 -4
- data/rbi/lib/orb/models/alert_enable_params.rbi +2 -4
- data/rbi/lib/orb/models/alert_list_params.rbi +3 -6
- data/rbi/lib/orb/models/alert_retrieve_params.rbi +2 -4
- data/rbi/lib/orb/models/alert_update_params.rbi +7 -11
- data/rbi/lib/orb/models/amount_discount.rbi +4 -7
- data/rbi/lib/orb/models/billable_metric.rbi +10 -13
- data/rbi/lib/orb/models/billing_cycle_relative_date.rbi +1 -2
- data/rbi/lib/orb/models/coupon.rbi +9 -11
- data/rbi/lib/orb/models/coupon_archive_params.rbi +2 -4
- data/rbi/lib/orb/models/coupon_create_params.rbi +8 -14
- data/rbi/lib/orb/models/coupon_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/coupon_list_params.rbi +3 -4
- data/rbi/lib/orb/models/coupons/subscription_list_params.rbi +3 -5
- data/rbi/lib/orb/models/credit_note.rbi +22 -45
- data/rbi/lib/orb/models/credit_note_create_params.rbi +5 -10
- data/rbi/lib/orb/models/credit_note_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/credit_note_list_params.rbi +3 -6
- data/rbi/lib/orb/models/customer.rbi +256 -281
- data/rbi/lib/orb/models/customer_create_params.rbi +251 -276
- data/rbi/lib/orb/models/customer_delete_params.rbi +2 -4
- data/rbi/lib/orb/models/customer_fetch_by_external_id_params.rbi +2 -4
- data/rbi/lib/orb/models/customer_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/customer_list_params.rbi +3 -6
- data/rbi/lib/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi +2 -4
- data/rbi/lib/orb/models/customer_sync_payment_methods_from_gateway_params.rbi +2 -4
- data/rbi/lib/orb/models/customer_update_by_external_id_params.rbi +252 -277
- data/rbi/lib/orb/models/customer_update_params.rbi +252 -277
- data/rbi/lib/orb/models/customers/balance_transaction_create_params.rbi +3 -6
- data/rbi/lib/orb/models/customers/balance_transaction_create_response.rbi +10 -19
- data/rbi/lib/orb/models/customers/balance_transaction_list_params.rbi +3 -6
- data/rbi/lib/orb/models/customers/balance_transaction_list_response.rbi +10 -19
- data/rbi/lib/orb/models/customers/cost_list_by_external_id_params.rbi +8 -10
- data/rbi/lib/orb/models/customers/cost_list_by_external_id_response.rbi +6 -12
- data/rbi/lib/orb/models/customers/cost_list_params.rbi +8 -10
- data/rbi/lib/orb/models/customers/cost_list_response.rbi +6 -12
- data/rbi/lib/orb/models/customers/credit_list_by_external_id_params.rbi +3 -4
- data/rbi/lib/orb/models/customers/credit_list_by_external_id_response.rbi +2 -4
- data/rbi/lib/orb/models/customers/credit_list_params.rbi +3 -4
- data/rbi/lib/orb/models/customers/credit_list_response.rbi +2 -4
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +26 -33
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi +79 -136
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_params.rbi +26 -33
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_response.rbi +78 -135
- data/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rbi +5 -10
- data/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rbi +79 -136
- data/rbi/lib/orb/models/customers/credits/ledger_list_params.rbi +5 -10
- data/rbi/lib/orb/models/customers/credits/ledger_list_response.rbi +74 -131
- data/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rbi +13 -19
- data/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rbi +12 -18
- data/rbi/lib/orb/models/customers/credits/top_up_create_params.rbi +13 -19
- data/rbi/lib/orb/models/customers/credits/top_up_create_response.rbi +12 -18
- data/rbi/lib/orb/models/customers/credits/top_up_delete_by_external_id_params.rbi +2 -4
- data/rbi/lib/orb/models/customers/credits/top_up_delete_params.rbi +2 -4
- data/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rbi +3 -5
- data/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rbi +12 -18
- data/rbi/lib/orb/models/customers/credits/top_up_list_params.rbi +3 -5
- data/rbi/lib/orb/models/customers/credits/top_up_list_response.rbi +12 -18
- data/rbi/lib/orb/models/dimensional_price_group.rbi +8 -9
- data/rbi/lib/orb/models/dimensional_price_group_create_params.rbi +4 -7
- data/rbi/lib/orb/models/dimensional_price_group_list_params.rbi +3 -5
- data/rbi/lib/orb/models/dimensional_price_group_retrieve_params.rbi +2 -4
- data/rbi/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi +2 -4
- data/rbi/lib/orb/models/dimensional_price_groups.rbi +2 -4
- data/rbi/lib/orb/models/discount.rbi +1 -2
- data/rbi/lib/orb/models/evaluate_price_group.rbi +3 -6
- data/rbi/lib/orb/models/event_deprecate_params.rbi +2 -4
- data/rbi/lib/orb/models/event_deprecate_response.rbi +2 -4
- data/rbi/lib/orb/models/event_ingest_params.rbi +10 -13
- data/rbi/lib/orb/models/event_ingest_response.rbi +10 -16
- data/rbi/lib/orb/models/event_search_params.rbi +7 -9
- data/rbi/lib/orb/models/event_search_response.rbi +11 -14
- data/rbi/lib/orb/models/event_update_params.rbi +5 -6
- data/rbi/lib/orb/models/event_update_response.rbi +2 -4
- data/rbi/lib/orb/models/events/backfill_close_params.rbi +2 -4
- data/rbi/lib/orb/models/events/backfill_close_response.rbi +10 -14
- data/rbi/lib/orb/models/events/backfill_create_params.rbi +13 -16
- data/rbi/lib/orb/models/events/backfill_create_response.rbi +10 -14
- data/rbi/lib/orb/models/events/backfill_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/events/backfill_fetch_response.rbi +10 -14
- data/rbi/lib/orb/models/events/backfill_list_params.rbi +3 -5
- data/rbi/lib/orb/models/events/backfill_list_response.rbi +10 -14
- data/rbi/lib/orb/models/events/backfill_revert_params.rbi +2 -4
- data/rbi/lib/orb/models/events/backfill_revert_response.rbi +10 -14
- data/rbi/lib/orb/models/events/event_volumes.rbi +5 -9
- data/rbi/lib/orb/models/events/volume_list_params.rbi +9 -11
- data/rbi/lib/orb/models/invoice.rbi +388 -465
- data/rbi/lib/orb/models/invoice_create_params.rbi +19 -26
- data/rbi/lib/orb/models/invoice_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/invoice_fetch_upcoming_params.rbi +2 -4
- data/rbi/lib/orb/models/invoice_fetch_upcoming_response.rbi +381 -460
- data/rbi/lib/orb/models/invoice_issue_params.rbi +6 -8
- data/rbi/lib/orb/models/invoice_level_discount.rbi +1 -2
- data/rbi/lib/orb/models/invoice_line_item_create_params.rbi +3 -5
- data/rbi/lib/orb/models/invoice_line_item_create_response.rbi +101 -143
- data/rbi/lib/orb/models/invoice_list_params.rbi +8 -13
- data/rbi/lib/orb/models/invoice_mark_paid_params.rbi +2 -4
- data/rbi/lib/orb/models/invoice_pay_params.rbi +2 -4
- data/rbi/lib/orb/models/invoice_update_params.rbi +4 -6
- data/rbi/lib/orb/models/invoice_void_params.rbi +2 -4
- data/rbi/lib/orb/models/item.rbi +7 -12
- data/rbi/lib/orb/models/item_create_params.rbi +2 -4
- data/rbi/lib/orb/models/item_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/item_list_params.rbi +3 -5
- data/rbi/lib/orb/models/item_update_params.rbi +5 -10
- data/rbi/lib/orb/models/metric_create_params.rbi +4 -6
- data/rbi/lib/orb/models/metric_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/metric_list_params.rbi +3 -6
- data/rbi/lib/orb/models/metric_update_params.rbi +4 -6
- data/rbi/lib/orb/models/pagination_metadata.rbi +2 -4
- data/rbi/lib/orb/models/percentage_discount.rbi +5 -8
- data/rbi/lib/orb/models/plan.rbi +180 -219
- data/rbi/lib/orb/models/plan_create_params.rbi +670 -951
- data/rbi/lib/orb/models/plan_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/plan_list_params.rbi +4 -8
- data/rbi/lib/orb/models/plan_update_params.rbi +6 -8
- data/rbi/lib/orb/models/plans/external_plan_id_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/plans/external_plan_id_update_params.rbi +6 -8
- data/rbi/lib/orb/models/price.rbi +827 -1494
- data/rbi/lib/orb/models/price_create_params.rbi +60 -101
- data/rbi/lib/orb/models/price_evaluate_params.rbi +6 -9
- data/rbi/lib/orb/models/price_evaluate_response.rbi +2 -4
- data/rbi/lib/orb/models/price_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/price_list_params.rbi +3 -5
- data/rbi/lib/orb/models/price_update_params.rbi +4 -6
- data/rbi/lib/orb/models/prices/external_price_id_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/prices/external_price_id_update_params.rbi +4 -6
- data/rbi/lib/orb/models/subscription.rbi +167 -187
- data/rbi/lib/orb/models/subscription_cancel_params.rbi +5 -7
- data/rbi/lib/orb/models/subscription_cancel_response.rbi +224 -178
- data/rbi/lib/orb/models/subscription_change_apply_params.rbi +40 -0
- data/rbi/lib/orb/models/subscription_change_apply_response.rbi +1554 -0
- data/rbi/lib/orb/models/subscription_change_cancel_params.rbi +18 -0
- data/rbi/lib/orb/models/subscription_change_cancel_response.rbi +1565 -0
- data/rbi/lib/orb/models/subscription_change_retrieve_params.rbi +18 -0
- data/rbi/lib/orb/models/subscription_change_retrieve_response.rbi +1581 -0
- data/rbi/lib/orb/models/subscription_create_params.rbi +1372 -1968
- data/rbi/lib/orb/models/subscription_create_response.rbi +224 -178
- data/rbi/lib/orb/models/subscription_fetch_costs_params.rbi +8 -10
- data/rbi/lib/orb/models/subscription_fetch_costs_response.rbi +6 -12
- data/rbi/lib/orb/models/subscription_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/subscription_fetch_schedule_params.rbi +3 -6
- data/rbi/lib/orb/models/subscription_fetch_schedule_response.rbi +6 -10
- data/rbi/lib/orb/models/subscription_fetch_usage_params.rbi +12 -17
- data/rbi/lib/orb/models/subscription_list_params.rbi +4 -8
- data/rbi/lib/orb/models/subscription_price_intervals_params.rbi +772 -1124
- data/rbi/lib/orb/models/subscription_price_intervals_response.rbi +228 -178
- data/rbi/lib/orb/models/subscription_schedule_plan_change_params.rbi +1396 -1993
- data/rbi/lib/orb/models/subscription_schedule_plan_change_response.rbi +238 -182
- data/rbi/lib/orb/models/subscription_trigger_phase_params.rbi +5 -7
- data/rbi/lib/orb/models/subscription_trigger_phase_response.rbi +224 -178
- data/rbi/lib/orb/models/subscription_unschedule_cancellation_params.rbi +2 -4
- data/rbi/lib/orb/models/subscription_unschedule_cancellation_response.rbi +238 -182
- data/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +2 -4
- data/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +265 -199
- data/rbi/lib/orb/models/subscription_unschedule_pending_plan_changes_params.rbi +2 -4
- data/rbi/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rbi +264 -198
- data/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_params.rbi +11 -15
- data/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_response.rbi +238 -182
- data/rbi/lib/orb/models/subscription_update_params.rbi +12 -15
- data/rbi/lib/orb/models/subscription_update_trial_params.rbi +6 -9
- data/rbi/lib/orb/models/subscription_update_trial_response.rbi +224 -178
- data/rbi/lib/orb/models/subscription_usage.rbi +24 -43
- data/rbi/lib/orb/models/subscriptions.rbi +2 -4
- data/rbi/lib/orb/models/top_level_ping_params.rbi +2 -4
- data/rbi/lib/orb/models/top_level_ping_response.rbi +2 -4
- data/rbi/lib/orb/models/trial_discount.rbi +4 -8
- data/rbi/lib/orb/models/usage_discount.rbi +5 -8
- data/rbi/lib/orb/request_options.rbi +9 -11
- data/rbi/lib/orb/resources/alerts.rbi +44 -60
- data/rbi/lib/orb/resources/coupons/subscriptions.rbi +6 -9
- data/rbi/lib/orb/resources/coupons.rbi +18 -25
- data/rbi/lib/orb/resources/credit_notes.rbi +9 -15
- data/rbi/lib/orb/resources/customers/balance_transactions.rbi +26 -31
- data/rbi/lib/orb/resources/customers/costs.rbi +241 -246
- data/rbi/lib/orb/resources/customers/credits/ledger.rbi +387 -396
- data/rbi/lib/orb/resources/customers/credits/top_ups.rbi +29 -40
- data/rbi/lib/orb/resources/customers/credits.rbi +15 -20
- data/rbi/lib/orb/resources/customers.rbi +407 -417
- data/rbi/lib/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rbi +2 -4
- data/rbi/lib/orb/resources/dimensional_price_groups.rbi +13 -19
- data/rbi/lib/orb/resources/events/backfills.rbi +61 -69
- data/rbi/lib/orb/resources/events/volume.rbi +19 -22
- data/rbi/lib/orb/resources/events.rbi +311 -319
- data/rbi/lib/orb/resources/invoice_line_items.rbi +4 -7
- data/rbi/lib/orb/resources/invoices.rbi +62 -76
- data/rbi/lib/orb/resources/items.rbi +7 -14
- data/rbi/lib/orb/resources/metrics.rbi +17 -25
- data/rbi/lib/orb/resources/plans/external_plan_id.rbi +21 -25
- data/rbi/lib/orb/resources/plans.rbi +63 -71
- data/rbi/lib/orb/resources/prices/external_price_id.rbi +9 -13
- data/rbi/lib/orb/resources/prices.rbi +77 -87
- data/rbi/lib/orb/resources/subscription_changes.rbi +61 -0
- data/rbi/lib/orb/resources/subscriptions.rbi +933 -963
- data/rbi/lib/orb/resources/top_level.rbi +6 -8
- data/sig/orb/client.rbs +2 -0
- data/sig/orb/internal/transport/pooled_net_requester.rbs +1 -1
- data/sig/orb/internal/type/array_of.rbs +5 -2
- data/sig/orb/internal/type/base_model.rbs +5 -2
- data/sig/orb/internal/type/boolean.rbs +5 -2
- data/sig/orb/internal/type/converter.rbs +11 -5
- data/sig/orb/internal/type/enum.rbs +5 -2
- data/sig/orb/internal/type/hash_of.rbs +5 -2
- data/sig/orb/internal/type/io_like.rbs +23 -0
- data/sig/orb/internal/type/union.rbs +5 -2
- data/sig/orb/internal/type/unknown.rbs +5 -2
- data/sig/orb/internal/util.rbs +17 -2
- data/sig/orb/models/subscription.rbs +14 -0
- data/sig/orb/models/subscription_cancel_response.rbs +47 -2
- data/sig/orb/models/subscription_change_apply_params.rbs +24 -0
- data/sig/orb/models/subscription_change_apply_response.rbs +784 -0
- data/sig/orb/models/subscription_change_cancel_params.rbs +15 -0
- data/sig/orb/models/subscription_change_cancel_response.rbs +784 -0
- data/sig/orb/models/subscription_change_retrieve_params.rbs +15 -0
- data/sig/orb/models/subscription_change_retrieve_response.rbs +784 -0
- data/sig/orb/models/subscription_create_response.rbs +47 -2
- data/sig/orb/models/subscription_price_intervals_response.rbs +47 -2
- data/sig/orb/models/subscription_schedule_plan_change_response.rbs +47 -2
- data/sig/orb/models/subscription_trigger_phase_response.rbs +47 -2
- data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +47 -2
- data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +47 -2
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +47 -2
- data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +47 -2
- data/sig/orb/models/subscription_update_trial_response.rbs +47 -2
- data/sig/orb/resources/customers.rbs +2 -2
- data/sig/orb/resources/subscription_changes.rbs +24 -0
- metadata +28 -4
@@ -31,8 +31,8 @@ module Orb
|
|
31
31
|
|
32
32
|
# @!attribute allow_invoice_credit_or_void
|
33
33
|
# If false, this request will fail if it would void an issued invoice or create a
|
34
|
-
#
|
35
|
-
#
|
34
|
+
# credit note. Consider using this as a safety mechanism if you do not expect
|
35
|
+
# existing invoices to be changed.
|
36
36
|
#
|
37
37
|
# @return [Boolean, nil]
|
38
38
|
optional :allow_invoice_credit_or_void, Orb::Internal::Type::Boolean, nil?: true
|
@@ -83,7 +83,7 @@ module Orb
|
|
83
83
|
class Add < Orb::Internal::Type::BaseModel
|
84
84
|
# @!attribute start_date
|
85
85
|
# The start date of the price interval. This is the date that the price will start
|
86
|
-
#
|
86
|
+
# billing on the subscription.
|
87
87
|
#
|
88
88
|
# @return [Time, Symbol, Orb::Models::BillingCycleRelativeDate]
|
89
89
|
required :start_date, union: -> { Orb::Models::SubscriptionPriceIntervalsParams::Add::StartDate }
|
@@ -106,7 +106,7 @@ module Orb
|
|
106
106
|
|
107
107
|
# @!attribute end_date
|
108
108
|
# The end date of the price interval. This is the date that the price will stop
|
109
|
-
#
|
109
|
+
# billing on the subscription.
|
110
110
|
#
|
111
111
|
# @return [Time, Symbol, Orb::Models::BillingCycleRelativeDate, nil]
|
112
112
|
optional :end_date, union: -> { Orb::Models::SubscriptionPriceIntervalsParams::Add::EndDate }, nil?: true
|
@@ -119,9 +119,9 @@ module Orb
|
|
119
119
|
|
120
120
|
# @!attribute filter
|
121
121
|
# An additional filter to apply to usage queries. This filter must be expressed as
|
122
|
-
#
|
123
|
-
#
|
124
|
-
#
|
122
|
+
# a boolean
|
123
|
+
# [computed property](/extensibility/advanced-metrics#computed-properties). If
|
124
|
+
# null, usage queries will not include any additional filter.
|
125
125
|
#
|
126
126
|
# @return [String, nil]
|
127
127
|
optional :filter, String, nil?: true
|
@@ -136,14 +136,14 @@ module Orb
|
|
136
136
|
|
137
137
|
# @!attribute maximum_amount
|
138
138
|
# The maximum amount that will be billed for this price interval for a given
|
139
|
-
#
|
139
|
+
# billing period.
|
140
140
|
#
|
141
141
|
# @return [Float, nil]
|
142
142
|
optional :maximum_amount, Float, nil?: true
|
143
143
|
|
144
144
|
# @!attribute minimum_amount
|
145
145
|
# The minimum amount that will be billed for this price interval for a given
|
146
|
-
#
|
146
|
+
# billing period.
|
147
147
|
#
|
148
148
|
# @return [Float, nil]
|
149
149
|
optional :minimum_amount, Float, nil?: true
|
@@ -162,11 +162,11 @@ module Orb
|
|
162
162
|
|
163
163
|
# @!attribute usage_customer_ids
|
164
164
|
# A list of customer IDs whose usage events will be aggregated and billed under
|
165
|
-
#
|
166
|
-
#
|
167
|
-
#
|
168
|
-
#
|
169
|
-
#
|
165
|
+
# this subscription. By default, a subscription only considers usage events
|
166
|
+
# associated with its attached customer's customer_id. When usage_customer_ids is
|
167
|
+
# provided, the subscription includes usage events from the specified customers
|
168
|
+
# only. Provided usage_customer_ids must be either the customer for this
|
169
|
+
# subscription itself, or any of that customer's children.
|
170
170
|
#
|
171
171
|
# @return [Array<String>, nil]
|
172
172
|
optional :usage_customer_ids, Orb::Internal::Type::ArrayOf[String], nil?: true
|
@@ -206,7 +206,7 @@ module Orb
|
|
206
206
|
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
207
207
|
|
208
208
|
# The start date of the price interval. This is the date that the price will start
|
209
|
-
#
|
209
|
+
# billing on the subscription.
|
210
210
|
#
|
211
211
|
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add#start_date
|
212
212
|
module StartDate
|
@@ -238,14 +238,14 @@ module Orb
|
|
238
238
|
|
239
239
|
# @!attribute currency
|
240
240
|
# An ISO 4217 currency string or a custom pricing unit identifier in which to bill
|
241
|
-
#
|
241
|
+
# this price.
|
242
242
|
#
|
243
243
|
# @return [String]
|
244
244
|
required :currency, String
|
245
245
|
|
246
246
|
# @!attribute expires_at_end_of_cadence
|
247
247
|
# Whether the allocated amount should expire at the end of the cadence or roll
|
248
|
-
#
|
248
|
+
# over to the next period.
|
249
249
|
#
|
250
250
|
# @return [Boolean]
|
251
251
|
required :expires_at_end_of_cadence, Orb::Internal::Type::Boolean
|
@@ -326,7 +326,7 @@ module Orb
|
|
326
326
|
|
327
327
|
# @!attribute percentage_discount
|
328
328
|
# Only available if discount_type is `percentage`. This is a number between 0
|
329
|
-
#
|
329
|
+
# and 1.
|
330
330
|
#
|
331
331
|
# @return [Float]
|
332
332
|
required :percentage_discount, Float
|
@@ -348,7 +348,7 @@ module Orb
|
|
348
348
|
|
349
349
|
# @!attribute usage_discount
|
350
350
|
# Only available if discount_type is `usage`. Number of usage units that this
|
351
|
-
#
|
351
|
+
# discount is for.
|
352
352
|
#
|
353
353
|
# @return [Float]
|
354
354
|
required :usage_discount, Float
|
@@ -368,7 +368,7 @@ module Orb
|
|
368
368
|
end
|
369
369
|
|
370
370
|
# The end date of the price interval. This is the date that the price will stop
|
371
|
-
#
|
371
|
+
# billing on the subscription.
|
372
372
|
#
|
373
373
|
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add#end_date
|
374
374
|
module EndDate
|
@@ -531,21 +531,21 @@ module Orb
|
|
531
531
|
|
532
532
|
# @!attribute billable_metric_id
|
533
533
|
# The id of the billable metric for the price. Only needed if the price is
|
534
|
-
#
|
534
|
+
# usage-based.
|
535
535
|
#
|
536
536
|
# @return [String, nil]
|
537
537
|
optional :billable_metric_id, String, nil?: true
|
538
538
|
|
539
539
|
# @!attribute billed_in_advance
|
540
540
|
# If the Price represents a fixed cost, the price will be billed in-advance if
|
541
|
-
#
|
541
|
+
# this is true, and in-arrears if this is false.
|
542
542
|
#
|
543
543
|
# @return [Boolean, nil]
|
544
544
|
optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
|
545
545
|
|
546
546
|
# @!attribute billing_cycle_configuration
|
547
547
|
# For custom cadence: specifies the duration of the billing period in days or
|
548
|
-
#
|
548
|
+
# months.
|
549
549
|
#
|
550
550
|
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitPrice::BillingCycleConfiguration, nil]
|
551
551
|
optional :billing_cycle_configuration,
|
@@ -566,7 +566,7 @@ module Orb
|
|
566
566
|
|
567
567
|
# @!attribute fixed_price_quantity
|
568
568
|
# If the Price represents a fixed cost, this represents the quantity of units
|
569
|
-
#
|
569
|
+
# applied.
|
570
570
|
#
|
571
571
|
# @return [Float, nil]
|
572
572
|
optional :fixed_price_quantity, Float, nil?: true
|
@@ -579,7 +579,7 @@ module Orb
|
|
579
579
|
|
580
580
|
# @!attribute invoicing_cycle_configuration
|
581
581
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
582
|
-
#
|
582
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
583
583
|
#
|
584
584
|
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitPrice::InvoicingCycleConfiguration, nil]
|
585
585
|
optional :invoicing_cycle_configuration,
|
@@ -588,8 +588,8 @@ module Orb
|
|
588
588
|
|
589
589
|
# @!attribute metadata
|
590
590
|
# User-specified key/value pairs for the resource. Individual keys can be removed
|
591
|
-
#
|
592
|
-
#
|
591
|
+
# by setting the value to `null`, and the entire metadata mapping can be cleared
|
592
|
+
# by setting `metadata` to `null`.
|
593
593
|
#
|
594
594
|
# @return [Hash{Symbol=>String, nil}, nil]
|
595
595
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
@@ -687,7 +687,7 @@ module Orb
|
|
687
687
|
|
688
688
|
# @!parse
|
689
689
|
# # For custom cadence: specifies the duration of the billing period in days or
|
690
|
-
# #
|
690
|
+
# # months.
|
691
691
|
# #
|
692
692
|
# # @param duration [Integer]
|
693
693
|
# # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitPrice::BillingCycleConfiguration::DurationUnit]
|
@@ -730,7 +730,7 @@ module Orb
|
|
730
730
|
|
731
731
|
# @!parse
|
732
732
|
# # Within each billing cycle, specifies the cadence at which invoices are produced.
|
733
|
-
# #
|
733
|
+
# # If unspecified, a single invoice is produced per billing cycle.
|
734
734
|
# #
|
735
735
|
# # @param duration [Integer]
|
736
736
|
# # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitPrice::InvoicingCycleConfiguration::DurationUnit]
|
@@ -796,21 +796,21 @@ module Orb
|
|
796
796
|
|
797
797
|
# @!attribute billable_metric_id
|
798
798
|
# The id of the billable metric for the price. Only needed if the price is
|
799
|
-
#
|
799
|
+
# usage-based.
|
800
800
|
#
|
801
801
|
# @return [String, nil]
|
802
802
|
optional :billable_metric_id, String, nil?: true
|
803
803
|
|
804
804
|
# @!attribute billed_in_advance
|
805
805
|
# If the Price represents a fixed cost, the price will be billed in-advance if
|
806
|
-
#
|
806
|
+
# this is true, and in-arrears if this is false.
|
807
807
|
#
|
808
808
|
# @return [Boolean, nil]
|
809
809
|
optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
|
810
810
|
|
811
811
|
# @!attribute billing_cycle_configuration
|
812
812
|
# For custom cadence: specifies the duration of the billing period in days or
|
813
|
-
#
|
813
|
+
# months.
|
814
814
|
#
|
815
815
|
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackagePrice::BillingCycleConfiguration, nil]
|
816
816
|
optional :billing_cycle_configuration,
|
@@ -831,7 +831,7 @@ module Orb
|
|
831
831
|
|
832
832
|
# @!attribute fixed_price_quantity
|
833
833
|
# If the Price represents a fixed cost, this represents the quantity of units
|
834
|
-
#
|
834
|
+
# applied.
|
835
835
|
#
|
836
836
|
# @return [Float, nil]
|
837
837
|
optional :fixed_price_quantity, Float, nil?: true
|
@@ -844,7 +844,7 @@ module Orb
|
|
844
844
|
|
845
845
|
# @!attribute invoicing_cycle_configuration
|
846
846
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
847
|
-
#
|
847
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
848
848
|
#
|
849
849
|
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackagePrice::InvoicingCycleConfiguration, nil]
|
850
850
|
optional :invoicing_cycle_configuration,
|
@@ -853,8 +853,8 @@ module Orb
|
|
853
853
|
|
854
854
|
# @!attribute metadata
|
855
855
|
# User-specified key/value pairs for the resource. Individual keys can be removed
|
856
|
-
#
|
857
|
-
#
|
856
|
+
# by setting the value to `null`, and the entire metadata mapping can be cleared
|
857
|
+
# by setting `metadata` to `null`.
|
858
858
|
#
|
859
859
|
# @return [Hash{Symbol=>String, nil}, nil]
|
860
860
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
@@ -929,7 +929,7 @@ module Orb
|
|
929
929
|
|
930
930
|
# @!attribute package_size
|
931
931
|
# An integer amount to represent package size. For example, 1000 here would divide
|
932
|
-
#
|
932
|
+
# usage by 1000 before multiplying by package_amount in rating
|
933
933
|
#
|
934
934
|
# @return [Integer]
|
935
935
|
required :package_size, Integer
|
@@ -960,7 +960,7 @@ module Orb
|
|
960
960
|
|
961
961
|
# @!parse
|
962
962
|
# # For custom cadence: specifies the duration of the billing period in days or
|
963
|
-
# #
|
963
|
+
# # months.
|
964
964
|
# #
|
965
965
|
# # @param duration [Integer]
|
966
966
|
# # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackagePrice::BillingCycleConfiguration::DurationUnit]
|
@@ -1003,7 +1003,7 @@ module Orb
|
|
1003
1003
|
|
1004
1004
|
# @!parse
|
1005
1005
|
# # Within each billing cycle, specifies the cadence at which invoices are produced.
|
1006
|
-
# #
|
1006
|
+
# # If unspecified, a single invoice is produced per billing cycle.
|
1007
1007
|
# #
|
1008
1008
|
# # @param duration [Integer]
|
1009
1009
|
# # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackagePrice::InvoicingCycleConfiguration::DurationUnit]
|
@@ -1069,21 +1069,21 @@ module Orb
|
|
1069
1069
|
|
1070
1070
|
# @!attribute billable_metric_id
|
1071
1071
|
# The id of the billable metric for the price. Only needed if the price is
|
1072
|
-
#
|
1072
|
+
# usage-based.
|
1073
1073
|
#
|
1074
1074
|
# @return [String, nil]
|
1075
1075
|
optional :billable_metric_id, String, nil?: true
|
1076
1076
|
|
1077
1077
|
# @!attribute billed_in_advance
|
1078
1078
|
# If the Price represents a fixed cost, the price will be billed in-advance if
|
1079
|
-
#
|
1079
|
+
# this is true, and in-arrears if this is false.
|
1080
1080
|
#
|
1081
1081
|
# @return [Boolean, nil]
|
1082
1082
|
optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
|
1083
1083
|
|
1084
1084
|
# @!attribute billing_cycle_configuration
|
1085
1085
|
# For custom cadence: specifies the duration of the billing period in days or
|
1086
|
-
#
|
1086
|
+
# months.
|
1087
1087
|
#
|
1088
1088
|
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixPrice::BillingCycleConfiguration, nil]
|
1089
1089
|
optional :billing_cycle_configuration,
|
@@ -1104,7 +1104,7 @@ module Orb
|
|
1104
1104
|
|
1105
1105
|
# @!attribute fixed_price_quantity
|
1106
1106
|
# If the Price represents a fixed cost, this represents the quantity of units
|
1107
|
-
#
|
1107
|
+
# applied.
|
1108
1108
|
#
|
1109
1109
|
# @return [Float, nil]
|
1110
1110
|
optional :fixed_price_quantity, Float, nil?: true
|
@@ -1117,7 +1117,7 @@ module Orb
|
|
1117
1117
|
|
1118
1118
|
# @!attribute invoicing_cycle_configuration
|
1119
1119
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
1120
|
-
#
|
1120
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
1121
1121
|
#
|
1122
1122
|
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixPrice::InvoicingCycleConfiguration, nil]
|
1123
1123
|
optional :invoicing_cycle_configuration,
|
@@ -1126,8 +1126,8 @@ module Orb
|
|
1126
1126
|
|
1127
1127
|
# @!attribute metadata
|
1128
1128
|
# User-specified key/value pairs for the resource. Individual keys can be removed
|
1129
|
-
#
|
1130
|
-
#
|
1129
|
+
# by setting the value to `null`, and the entire metadata mapping can be cleared
|
1130
|
+
# by setting `metadata` to `null`.
|
1131
1131
|
#
|
1132
1132
|
# @return [Hash{Symbol=>String, nil}, nil]
|
1133
1133
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
@@ -1213,7 +1213,7 @@ module Orb
|
|
1213
1213
|
required :matrix_values,
|
1214
1214
|
-> do
|
1215
1215
|
Orb::Internal::Type::ArrayOf[
|
1216
|
-
|
1216
|
+
Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixPrice::MatrixConfig::MatrixValue
|
1217
1217
|
]
|
1218
1218
|
end
|
1219
1219
|
|
@@ -1229,8 +1229,8 @@ module Orb
|
|
1229
1229
|
class MatrixValue < Orb::Internal::Type::BaseModel
|
1230
1230
|
# @!attribute dimension_values
|
1231
1231
|
# One or two matrix keys to filter usage to this Matrix value by. For example,
|
1232
|
-
#
|
1233
|
-
#
|
1232
|
+
# ["region", "tier"] could be used to filter cloud usage by a cloud region and an
|
1233
|
+
# instance tier.
|
1234
1234
|
#
|
1235
1235
|
# @return [Array<String, nil>]
|
1236
1236
|
required :dimension_values, Orb::Internal::Type::ArrayOf[String, nil?: true]
|
@@ -1268,7 +1268,7 @@ module Orb
|
|
1268
1268
|
|
1269
1269
|
# @!parse
|
1270
1270
|
# # For custom cadence: specifies the duration of the billing period in days or
|
1271
|
-
# #
|
1271
|
+
# # months.
|
1272
1272
|
# #
|
1273
1273
|
# # @param duration [Integer]
|
1274
1274
|
# # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixPrice::BillingCycleConfiguration::DurationUnit]
|
@@ -1311,7 +1311,7 @@ module Orb
|
|
1311
1311
|
|
1312
1312
|
# @!parse
|
1313
1313
|
# # Within each billing cycle, specifies the cadence at which invoices are produced.
|
1314
|
-
# #
|
1314
|
+
# # If unspecified, a single invoice is produced per billing cycle.
|
1315
1315
|
# #
|
1316
1316
|
# # @param duration [Integer]
|
1317
1317
|
# # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixPrice::InvoicingCycleConfiguration::DurationUnit]
|
@@ -1377,21 +1377,21 @@ module Orb
|
|
1377
1377
|
|
1378
1378
|
# @!attribute billable_metric_id
|
1379
1379
|
# The id of the billable metric for the price. Only needed if the price is
|
1380
|
-
#
|
1380
|
+
# usage-based.
|
1381
1381
|
#
|
1382
1382
|
# @return [String, nil]
|
1383
1383
|
optional :billable_metric_id, String, nil?: true
|
1384
1384
|
|
1385
1385
|
# @!attribute billed_in_advance
|
1386
1386
|
# If the Price represents a fixed cost, the price will be billed in-advance if
|
1387
|
-
#
|
1387
|
+
# this is true, and in-arrears if this is false.
|
1388
1388
|
#
|
1389
1389
|
# @return [Boolean, nil]
|
1390
1390
|
optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
|
1391
1391
|
|
1392
1392
|
# @!attribute billing_cycle_configuration
|
1393
1393
|
# For custom cadence: specifies the duration of the billing period in days or
|
1394
|
-
#
|
1394
|
+
# months.
|
1395
1395
|
#
|
1396
1396
|
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithAllocationPrice::BillingCycleConfiguration, nil]
|
1397
1397
|
optional :billing_cycle_configuration,
|
@@ -1412,7 +1412,7 @@ module Orb
|
|
1412
1412
|
|
1413
1413
|
# @!attribute fixed_price_quantity
|
1414
1414
|
# If the Price represents a fixed cost, this represents the quantity of units
|
1415
|
-
#
|
1415
|
+
# applied.
|
1416
1416
|
#
|
1417
1417
|
# @return [Float, nil]
|
1418
1418
|
optional :fixed_price_quantity, Float, nil?: true
|
@@ -1425,7 +1425,7 @@ module Orb
|
|
1425
1425
|
|
1426
1426
|
# @!attribute invoicing_cycle_configuration
|
1427
1427
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
1428
|
-
#
|
1428
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
1429
1429
|
#
|
1430
1430
|
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithAllocationPrice::InvoicingCycleConfiguration, nil]
|
1431
1431
|
optional :invoicing_cycle_configuration,
|
@@ -1434,8 +1434,8 @@ module Orb
|
|
1434
1434
|
|
1435
1435
|
# @!attribute metadata
|
1436
1436
|
# User-specified key/value pairs for the resource. Individual keys can be removed
|
1437
|
-
#
|
1438
|
-
#
|
1437
|
+
# by setting the value to `null`, and the entire metadata mapping can be cleared
|
1438
|
+
# by setting `metadata` to `null`.
|
1439
1439
|
#
|
1440
1440
|
# @return [Hash{Symbol=>String, nil}, nil]
|
1441
1441
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
@@ -1527,7 +1527,7 @@ module Orb
|
|
1527
1527
|
required :matrix_values,
|
1528
1528
|
-> do
|
1529
1529
|
Orb::Internal::Type::ArrayOf[
|
1530
|
-
|
1530
|
+
Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithAllocationPrice::MatrixWithAllocationConfig::MatrixValue
|
1531
1531
|
]
|
1532
1532
|
end
|
1533
1533
|
|
@@ -1544,8 +1544,8 @@ module Orb
|
|
1544
1544
|
class MatrixValue < Orb::Internal::Type::BaseModel
|
1545
1545
|
# @!attribute dimension_values
|
1546
1546
|
# One or two matrix keys to filter usage to this Matrix value by. For example,
|
1547
|
-
#
|
1548
|
-
#
|
1547
|
+
# ["region", "tier"] could be used to filter cloud usage by a cloud region and an
|
1548
|
+
# instance tier.
|
1549
1549
|
#
|
1550
1550
|
# @return [Array<String, nil>]
|
1551
1551
|
required :dimension_values, Orb::Internal::Type::ArrayOf[String, nil?: true]
|
@@ -1583,7 +1583,7 @@ module Orb
|
|
1583
1583
|
|
1584
1584
|
# @!parse
|
1585
1585
|
# # For custom cadence: specifies the duration of the billing period in days or
|
1586
|
-
# #
|
1586
|
+
# # months.
|
1587
1587
|
# #
|
1588
1588
|
# # @param duration [Integer]
|
1589
1589
|
# # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithAllocationPrice::BillingCycleConfiguration::DurationUnit]
|
@@ -1626,7 +1626,7 @@ module Orb
|
|
1626
1626
|
|
1627
1627
|
# @!parse
|
1628
1628
|
# # Within each billing cycle, specifies the cadence at which invoices are produced.
|
1629
|
-
# #
|
1629
|
+
# # If unspecified, a single invoice is produced per billing cycle.
|
1630
1630
|
# #
|
1631
1631
|
# # @param duration [Integer]
|
1632
1632
|
# # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit]
|
@@ -1692,21 +1692,21 @@ module Orb
|
|
1692
1692
|
|
1693
1693
|
# @!attribute billable_metric_id
|
1694
1694
|
# The id of the billable metric for the price. Only needed if the price is
|
1695
|
-
#
|
1695
|
+
# usage-based.
|
1696
1696
|
#
|
1697
1697
|
# @return [String, nil]
|
1698
1698
|
optional :billable_metric_id, String, nil?: true
|
1699
1699
|
|
1700
1700
|
# @!attribute billed_in_advance
|
1701
1701
|
# If the Price represents a fixed cost, the price will be billed in-advance if
|
1702
|
-
#
|
1702
|
+
# this is true, and in-arrears if this is false.
|
1703
1703
|
#
|
1704
1704
|
# @return [Boolean, nil]
|
1705
1705
|
optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
|
1706
1706
|
|
1707
1707
|
# @!attribute billing_cycle_configuration
|
1708
1708
|
# For custom cadence: specifies the duration of the billing period in days or
|
1709
|
-
#
|
1709
|
+
# months.
|
1710
1710
|
#
|
1711
1711
|
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPrice::BillingCycleConfiguration, nil]
|
1712
1712
|
optional :billing_cycle_configuration,
|
@@ -1727,7 +1727,7 @@ module Orb
|
|
1727
1727
|
|
1728
1728
|
# @!attribute fixed_price_quantity
|
1729
1729
|
# If the Price represents a fixed cost, this represents the quantity of units
|
1730
|
-
#
|
1730
|
+
# applied.
|
1731
1731
|
#
|
1732
1732
|
# @return [Float, nil]
|
1733
1733
|
optional :fixed_price_quantity, Float, nil?: true
|
@@ -1740,7 +1740,7 @@ module Orb
|
|
1740
1740
|
|
1741
1741
|
# @!attribute invoicing_cycle_configuration
|
1742
1742
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
1743
|
-
#
|
1743
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
1744
1744
|
#
|
1745
1745
|
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPrice::InvoicingCycleConfiguration, nil]
|
1746
1746
|
optional :invoicing_cycle_configuration,
|
@@ -1749,8 +1749,8 @@ module Orb
|
|
1749
1749
|
|
1750
1750
|
# @!attribute metadata
|
1751
1751
|
# User-specified key/value pairs for the resource. Individual keys can be removed
|
1752
|
-
#
|
1753
|
-
#
|
1752
|
+
# by setting the value to `null`, and the entire metadata mapping can be cleared
|
1753
|
+
# by setting `metadata` to `null`.
|
1754
1754
|
#
|
1755
1755
|
# @return [Hash{Symbol=>String, nil}, nil]
|
1756
1756
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
@@ -1833,7 +1833,7 @@ module Orb
|
|
1833
1833
|
|
1834
1834
|
class Tier < Orb::Internal::Type::BaseModel
|
1835
1835
|
# @!attribute first_unit
|
1836
|
-
#
|
1836
|
+
# Exclusive tier starting value
|
1837
1837
|
#
|
1838
1838
|
# @return [Float]
|
1839
1839
|
required :first_unit, Float
|
@@ -1845,7 +1845,7 @@ module Orb
|
|
1845
1845
|
required :unit_amount, String
|
1846
1846
|
|
1847
1847
|
# @!attribute last_unit
|
1848
|
-
#
|
1848
|
+
# Inclusive tier ending value. If null, this is treated as the last tier
|
1849
1849
|
#
|
1850
1850
|
# @return [Float, nil]
|
1851
1851
|
optional :last_unit, Float, nil?: true
|
@@ -1878,7 +1878,7 @@ module Orb
|
|
1878
1878
|
|
1879
1879
|
# @!parse
|
1880
1880
|
# # For custom cadence: specifies the duration of the billing period in days or
|
1881
|
-
# #
|
1881
|
+
# # months.
|
1882
1882
|
# #
|
1883
1883
|
# # @param duration [Integer]
|
1884
1884
|
# # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPrice::BillingCycleConfiguration::DurationUnit]
|
@@ -1921,7 +1921,7 @@ module Orb
|
|
1921
1921
|
|
1922
1922
|
# @!parse
|
1923
1923
|
# # Within each billing cycle, specifies the cadence at which invoices are produced.
|
1924
|
-
# #
|
1924
|
+
# # If unspecified, a single invoice is produced per billing cycle.
|
1925
1925
|
# #
|
1926
1926
|
# # @param duration [Integer]
|
1927
1927
|
# # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPrice::InvoicingCycleConfiguration::DurationUnit]
|
@@ -1987,21 +1987,21 @@ module Orb
|
|
1987
1987
|
|
1988
1988
|
# @!attribute billable_metric_id
|
1989
1989
|
# The id of the billable metric for the price. Only needed if the price is
|
1990
|
-
#
|
1990
|
+
# usage-based.
|
1991
1991
|
#
|
1992
1992
|
# @return [String, nil]
|
1993
1993
|
optional :billable_metric_id, String, nil?: true
|
1994
1994
|
|
1995
1995
|
# @!attribute billed_in_advance
|
1996
1996
|
# If the Price represents a fixed cost, the price will be billed in-advance if
|
1997
|
-
#
|
1997
|
+
# this is true, and in-arrears if this is false.
|
1998
1998
|
#
|
1999
1999
|
# @return [Boolean, nil]
|
2000
2000
|
optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
|
2001
2001
|
|
2002
2002
|
# @!attribute billing_cycle_configuration
|
2003
2003
|
# For custom cadence: specifies the duration of the billing period in days or
|
2004
|
-
#
|
2004
|
+
# months.
|
2005
2005
|
#
|
2006
2006
|
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredBpsPrice::BillingCycleConfiguration, nil]
|
2007
2007
|
optional :billing_cycle_configuration,
|
@@ -2022,7 +2022,7 @@ module Orb
|
|
2022
2022
|
|
2023
2023
|
# @!attribute fixed_price_quantity
|
2024
2024
|
# If the Price represents a fixed cost, this represents the quantity of units
|
2025
|
-
#
|
2025
|
+
# applied.
|
2026
2026
|
#
|
2027
2027
|
# @return [Float, nil]
|
2028
2028
|
optional :fixed_price_quantity, Float, nil?: true
|
@@ -2035,7 +2035,7 @@ module Orb
|
|
2035
2035
|
|
2036
2036
|
# @!attribute invoicing_cycle_configuration
|
2037
2037
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
2038
|
-
#
|
2038
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
2039
2039
|
#
|
2040
2040
|
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredBpsPrice::InvoicingCycleConfiguration, nil]
|
2041
2041
|
optional :invoicing_cycle_configuration,
|
@@ -2044,8 +2044,8 @@ module Orb
|
|
2044
2044
|
|
2045
2045
|
# @!attribute metadata
|
2046
2046
|
# User-specified key/value pairs for the resource. Individual keys can be removed
|
2047
|
-
#
|
2048
|
-
#
|
2047
|
+
# by setting the value to `null`, and the entire metadata mapping can be cleared
|
2048
|
+
# by setting `metadata` to `null`.
|
2049
2049
|
#
|
2050
2050
|
# @return [Hash{Symbol=>String, nil}, nil]
|
2051
2051
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
@@ -2114,13 +2114,13 @@ module Orb
|
|
2114
2114
|
class TieredBpsConfig < Orb::Internal::Type::BaseModel
|
2115
2115
|
# @!attribute tiers
|
2116
2116
|
# Tiers for a Graduated BPS pricing model, where usage is bucketed into specified
|
2117
|
-
#
|
2117
|
+
# tiers
|
2118
2118
|
#
|
2119
2119
|
# @return [Array<Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredBpsPrice::TieredBpsConfig::Tier>]
|
2120
2120
|
required :tiers,
|
2121
2121
|
-> do
|
2122
2122
|
Orb::Internal::Type::ArrayOf[
|
2123
|
-
|
2123
|
+
Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredBpsPrice::TieredBpsConfig::Tier
|
2124
2124
|
]
|
2125
2125
|
end
|
2126
2126
|
|
@@ -2139,13 +2139,13 @@ module Orb
|
|
2139
2139
|
required :bps, Float
|
2140
2140
|
|
2141
2141
|
# @!attribute minimum_amount
|
2142
|
-
#
|
2142
|
+
# Exclusive tier starting value
|
2143
2143
|
#
|
2144
2144
|
# @return [String]
|
2145
2145
|
required :minimum_amount, String
|
2146
2146
|
|
2147
2147
|
# @!attribute maximum_amount
|
2148
|
-
#
|
2148
|
+
# Inclusive tier ending value
|
2149
2149
|
#
|
2150
2150
|
# @return [String, nil]
|
2151
2151
|
optional :maximum_amount, String, nil?: true
|
@@ -2185,7 +2185,7 @@ module Orb
|
|
2185
2185
|
|
2186
2186
|
# @!parse
|
2187
2187
|
# # For custom cadence: specifies the duration of the billing period in days or
|
2188
|
-
# #
|
2188
|
+
# # months.
|
2189
2189
|
# #
|
2190
2190
|
# # @param duration [Integer]
|
2191
2191
|
# # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredBpsPrice::BillingCycleConfiguration::DurationUnit]
|
@@ -2228,7 +2228,7 @@ module Orb
|
|
2228
2228
|
|
2229
2229
|
# @!parse
|
2230
2230
|
# # Within each billing cycle, specifies the cadence at which invoices are produced.
|
2231
|
-
# #
|
2231
|
+
# # If unspecified, a single invoice is produced per billing cycle.
|
2232
2232
|
# #
|
2233
2233
|
# # @param duration [Integer]
|
2234
2234
|
# # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredBpsPrice::InvoicingCycleConfiguration::DurationUnit]
|
@@ -2294,21 +2294,21 @@ module Orb
|
|
2294
2294
|
|
2295
2295
|
# @!attribute billable_metric_id
|
2296
2296
|
# The id of the billable metric for the price. Only needed if the price is
|
2297
|
-
#
|
2297
|
+
# usage-based.
|
2298
2298
|
#
|
2299
2299
|
# @return [String, nil]
|
2300
2300
|
optional :billable_metric_id, String, nil?: true
|
2301
2301
|
|
2302
2302
|
# @!attribute billed_in_advance
|
2303
2303
|
# If the Price represents a fixed cost, the price will be billed in-advance if
|
2304
|
-
#
|
2304
|
+
# this is true, and in-arrears if this is false.
|
2305
2305
|
#
|
2306
2306
|
# @return [Boolean, nil]
|
2307
2307
|
optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
|
2308
2308
|
|
2309
2309
|
# @!attribute billing_cycle_configuration
|
2310
2310
|
# For custom cadence: specifies the duration of the billing period in days or
|
2311
|
-
#
|
2311
|
+
# months.
|
2312
2312
|
#
|
2313
2313
|
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBpsPrice::BillingCycleConfiguration, nil]
|
2314
2314
|
optional :billing_cycle_configuration,
|
@@ -2329,7 +2329,7 @@ module Orb
|
|
2329
2329
|
|
2330
2330
|
# @!attribute fixed_price_quantity
|
2331
2331
|
# If the Price represents a fixed cost, this represents the quantity of units
|
2332
|
-
#
|
2332
|
+
# applied.
|
2333
2333
|
#
|
2334
2334
|
# @return [Float, nil]
|
2335
2335
|
optional :fixed_price_quantity, Float, nil?: true
|
@@ -2342,7 +2342,7 @@ module Orb
|
|
2342
2342
|
|
2343
2343
|
# @!attribute invoicing_cycle_configuration
|
2344
2344
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
2345
|
-
#
|
2345
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
2346
2346
|
#
|
2347
2347
|
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBpsPrice::InvoicingCycleConfiguration, nil]
|
2348
2348
|
optional :invoicing_cycle_configuration,
|
@@ -2351,8 +2351,8 @@ module Orb
|
|
2351
2351
|
|
2352
2352
|
# @!attribute metadata
|
2353
2353
|
# User-specified key/value pairs for the resource. Individual keys can be removed
|
2354
|
-
#
|
2355
|
-
#
|
2354
|
+
# by setting the value to `null`, and the entire metadata mapping can be cleared
|
2355
|
+
# by setting `metadata` to `null`.
|
2356
2356
|
#
|
2357
2357
|
# @return [Hash{Symbol=>String, nil}, nil]
|
2358
2358
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
@@ -2457,7 +2457,7 @@ module Orb
|
|
2457
2457
|
|
2458
2458
|
# @!parse
|
2459
2459
|
# # For custom cadence: specifies the duration of the billing period in days or
|
2460
|
-
# #
|
2460
|
+
# # months.
|
2461
2461
|
# #
|
2462
2462
|
# # @param duration [Integer]
|
2463
2463
|
# # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBpsPrice::BillingCycleConfiguration::DurationUnit]
|
@@ -2500,7 +2500,7 @@ module Orb
|
|
2500
2500
|
|
2501
2501
|
# @!parse
|
2502
2502
|
# # Within each billing cycle, specifies the cadence at which invoices are produced.
|
2503
|
-
# #
|
2503
|
+
# # If unspecified, a single invoice is produced per billing cycle.
|
2504
2504
|
# #
|
2505
2505
|
# # @param duration [Integer]
|
2506
2506
|
# # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBpsPrice::InvoicingCycleConfiguration::DurationUnit]
|
@@ -2566,21 +2566,21 @@ module Orb
|
|
2566
2566
|
|
2567
2567
|
# @!attribute billable_metric_id
|
2568
2568
|
# The id of the billable metric for the price. Only needed if the price is
|
2569
|
-
#
|
2569
|
+
# usage-based.
|
2570
2570
|
#
|
2571
2571
|
# @return [String, nil]
|
2572
2572
|
optional :billable_metric_id, String, nil?: true
|
2573
2573
|
|
2574
2574
|
# @!attribute billed_in_advance
|
2575
2575
|
# If the Price represents a fixed cost, the price will be billed in-advance if
|
2576
|
-
#
|
2576
|
+
# this is true, and in-arrears if this is false.
|
2577
2577
|
#
|
2578
2578
|
# @return [Boolean, nil]
|
2579
2579
|
optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
|
2580
2580
|
|
2581
2581
|
# @!attribute billing_cycle_configuration
|
2582
2582
|
# For custom cadence: specifies the duration of the billing period in days or
|
2583
|
-
#
|
2583
|
+
# months.
|
2584
2584
|
#
|
2585
2585
|
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkBpsPrice::BillingCycleConfiguration, nil]
|
2586
2586
|
optional :billing_cycle_configuration,
|
@@ -2601,7 +2601,7 @@ module Orb
|
|
2601
2601
|
|
2602
2602
|
# @!attribute fixed_price_quantity
|
2603
2603
|
# If the Price represents a fixed cost, this represents the quantity of units
|
2604
|
-
#
|
2604
|
+
# applied.
|
2605
2605
|
#
|
2606
2606
|
# @return [Float, nil]
|
2607
2607
|
optional :fixed_price_quantity, Float, nil?: true
|
@@ -2614,7 +2614,7 @@ module Orb
|
|
2614
2614
|
|
2615
2615
|
# @!attribute invoicing_cycle_configuration
|
2616
2616
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
2617
|
-
#
|
2617
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
2618
2618
|
#
|
2619
2619
|
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkBpsPrice::InvoicingCycleConfiguration, nil]
|
2620
2620
|
optional :invoicing_cycle_configuration,
|
@@ -2623,8 +2623,8 @@ module Orb
|
|
2623
2623
|
|
2624
2624
|
# @!attribute metadata
|
2625
2625
|
# User-specified key/value pairs for the resource. Individual keys can be removed
|
2626
|
-
#
|
2627
|
-
#
|
2626
|
+
# by setting the value to `null`, and the entire metadata mapping can be cleared
|
2627
|
+
# by setting `metadata` to `null`.
|
2628
2628
|
#
|
2629
2629
|
# @return [Hash{Symbol=>String, nil}, nil]
|
2630
2630
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
@@ -2673,7 +2673,7 @@ module Orb
|
|
2673
2673
|
class BulkBpsConfig < Orb::Internal::Type::BaseModel
|
2674
2674
|
# @!attribute tiers
|
2675
2675
|
# Tiers for a bulk BPS pricing model where all usage is aggregated to a single
|
2676
|
-
#
|
2676
|
+
# tier based on total volume
|
2677
2677
|
#
|
2678
2678
|
# @return [Array<Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkBpsPrice::BulkBpsConfig::Tier>]
|
2679
2679
|
required :tiers,
|
@@ -2753,7 +2753,7 @@ module Orb
|
|
2753
2753
|
|
2754
2754
|
# @!parse
|
2755
2755
|
# # For custom cadence: specifies the duration of the billing period in days or
|
2756
|
-
# #
|
2756
|
+
# # months.
|
2757
2757
|
# #
|
2758
2758
|
# # @param duration [Integer]
|
2759
2759
|
# # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkBpsPrice::BillingCycleConfiguration::DurationUnit]
|
@@ -2796,7 +2796,7 @@ module Orb
|
|
2796
2796
|
|
2797
2797
|
# @!parse
|
2798
2798
|
# # Within each billing cycle, specifies the cadence at which invoices are produced.
|
2799
|
-
# #
|
2799
|
+
# # If unspecified, a single invoice is produced per billing cycle.
|
2800
2800
|
# #
|
2801
2801
|
# # @param duration [Integer]
|
2802
2802
|
# # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkBpsPrice::InvoicingCycleConfiguration::DurationUnit]
|
@@ -2862,21 +2862,21 @@ module Orb
|
|
2862
2862
|
|
2863
2863
|
# @!attribute billable_metric_id
|
2864
2864
|
# The id of the billable metric for the price. Only needed if the price is
|
2865
|
-
#
|
2865
|
+
# usage-based.
|
2866
2866
|
#
|
2867
2867
|
# @return [String, nil]
|
2868
2868
|
optional :billable_metric_id, String, nil?: true
|
2869
2869
|
|
2870
2870
|
# @!attribute billed_in_advance
|
2871
2871
|
# If the Price represents a fixed cost, the price will be billed in-advance if
|
2872
|
-
#
|
2872
|
+
# this is true, and in-arrears if this is false.
|
2873
2873
|
#
|
2874
2874
|
# @return [Boolean, nil]
|
2875
2875
|
optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
|
2876
2876
|
|
2877
2877
|
# @!attribute billing_cycle_configuration
|
2878
2878
|
# For custom cadence: specifies the duration of the billing period in days or
|
2879
|
-
#
|
2879
|
+
# months.
|
2880
2880
|
#
|
2881
2881
|
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkPrice::BillingCycleConfiguration, nil]
|
2882
2882
|
optional :billing_cycle_configuration,
|
@@ -2897,7 +2897,7 @@ module Orb
|
|
2897
2897
|
|
2898
2898
|
# @!attribute fixed_price_quantity
|
2899
2899
|
# If the Price represents a fixed cost, this represents the quantity of units
|
2900
|
-
#
|
2900
|
+
# applied.
|
2901
2901
|
#
|
2902
2902
|
# @return [Float, nil]
|
2903
2903
|
optional :fixed_price_quantity, Float, nil?: true
|
@@ -2910,7 +2910,7 @@ module Orb
|
|
2910
2910
|
|
2911
2911
|
# @!attribute invoicing_cycle_configuration
|
2912
2912
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
2913
|
-
#
|
2913
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
2914
2914
|
#
|
2915
2915
|
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkPrice::InvoicingCycleConfiguration, nil]
|
2916
2916
|
optional :invoicing_cycle_configuration,
|
@@ -2919,8 +2919,8 @@ module Orb
|
|
2919
2919
|
|
2920
2920
|
# @!attribute metadata
|
2921
2921
|
# User-specified key/value pairs for the resource. Individual keys can be removed
|
2922
|
-
#
|
2923
|
-
#
|
2922
|
+
# by setting the value to `null`, and the entire metadata mapping can be cleared
|
2923
|
+
# by setting `metadata` to `null`.
|
2924
2924
|
#
|
2925
2925
|
# @return [Hash{Symbol=>String, nil}, nil]
|
2926
2926
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
@@ -3041,7 +3041,7 @@ module Orb
|
|
3041
3041
|
|
3042
3042
|
# @!parse
|
3043
3043
|
# # For custom cadence: specifies the duration of the billing period in days or
|
3044
|
-
# #
|
3044
|
+
# # months.
|
3045
3045
|
# #
|
3046
3046
|
# # @param duration [Integer]
|
3047
3047
|
# # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkPrice::BillingCycleConfiguration::DurationUnit]
|
@@ -3084,7 +3084,7 @@ module Orb
|
|
3084
3084
|
|
3085
3085
|
# @!parse
|
3086
3086
|
# # Within each billing cycle, specifies the cadence at which invoices are produced.
|
3087
|
-
# #
|
3087
|
+
# # If unspecified, a single invoice is produced per billing cycle.
|
3088
3088
|
# #
|
3089
3089
|
# # @param duration [Integer]
|
3090
3090
|
# # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkPrice::InvoicingCycleConfiguration::DurationUnit]
|
@@ -3149,21 +3149,21 @@ module Orb
|
|
3149
3149
|
|
3150
3150
|
# @!attribute billable_metric_id
|
3151
3151
|
# The id of the billable metric for the price. Only needed if the price is
|
3152
|
-
#
|
3152
|
+
# usage-based.
|
3153
3153
|
#
|
3154
3154
|
# @return [String, nil]
|
3155
3155
|
optional :billable_metric_id, String, nil?: true
|
3156
3156
|
|
3157
3157
|
# @!attribute billed_in_advance
|
3158
3158
|
# If the Price represents a fixed cost, the price will be billed in-advance if
|
3159
|
-
#
|
3159
|
+
# this is true, and in-arrears if this is false.
|
3160
3160
|
#
|
3161
3161
|
# @return [Boolean, nil]
|
3162
3162
|
optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
|
3163
3163
|
|
3164
3164
|
# @!attribute billing_cycle_configuration
|
3165
3165
|
# For custom cadence: specifies the duration of the billing period in days or
|
3166
|
-
#
|
3166
|
+
# months.
|
3167
3167
|
#
|
3168
3168
|
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingThresholdTotalAmountPrice::BillingCycleConfiguration, nil]
|
3169
3169
|
optional :billing_cycle_configuration,
|
@@ -3184,7 +3184,7 @@ module Orb
|
|
3184
3184
|
|
3185
3185
|
# @!attribute fixed_price_quantity
|
3186
3186
|
# If the Price represents a fixed cost, this represents the quantity of units
|
3187
|
-
#
|
3187
|
+
# applied.
|
3188
3188
|
#
|
3189
3189
|
# @return [Float, nil]
|
3190
3190
|
optional :fixed_price_quantity, Float, nil?: true
|
@@ -3197,7 +3197,7 @@ module Orb
|
|
3197
3197
|
|
3198
3198
|
# @!attribute invoicing_cycle_configuration
|
3199
3199
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
3200
|
-
#
|
3200
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
3201
3201
|
#
|
3202
3202
|
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingThresholdTotalAmountPrice::InvoicingCycleConfiguration, nil]
|
3203
3203
|
optional :invoicing_cycle_configuration,
|
@@ -3206,8 +3206,8 @@ module Orb
|
|
3206
3206
|
|
3207
3207
|
# @!attribute metadata
|
3208
3208
|
# User-specified key/value pairs for the resource. Individual keys can be removed
|
3209
|
-
#
|
3210
|
-
#
|
3209
|
+
# by setting the value to `null`, and the entire metadata mapping can be cleared
|
3210
|
+
# by setting `metadata` to `null`.
|
3211
3211
|
#
|
3212
3212
|
# @return [Hash{Symbol=>String, nil}, nil]
|
3213
3213
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
@@ -3289,7 +3289,7 @@ module Orb
|
|
3289
3289
|
|
3290
3290
|
# @!parse
|
3291
3291
|
# # For custom cadence: specifies the duration of the billing period in days or
|
3292
|
-
# #
|
3292
|
+
# # months.
|
3293
3293
|
# #
|
3294
3294
|
# # @param duration [Integer]
|
3295
3295
|
# # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingThresholdTotalAmountPrice::BillingCycleConfiguration::DurationUnit]
|
@@ -3332,7 +3332,7 @@ module Orb
|
|
3332
3332
|
|
3333
3333
|
# @!parse
|
3334
3334
|
# # Within each billing cycle, specifies the cadence at which invoices are produced.
|
3335
|
-
# #
|
3335
|
+
# # If unspecified, a single invoice is produced per billing cycle.
|
3336
3336
|
# #
|
3337
3337
|
# # @param duration [Integer]
|
3338
3338
|
# # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingThresholdTotalAmountPrice::InvoicingCycleConfiguration::DurationUnit]
|
@@ -3397,21 +3397,21 @@ module Orb
|
|
3397
3397
|
|
3398
3398
|
# @!attribute billable_metric_id
|
3399
3399
|
# The id of the billable metric for the price. Only needed if the price is
|
3400
|
-
#
|
3400
|
+
# usage-based.
|
3401
3401
|
#
|
3402
3402
|
# @return [String, nil]
|
3403
3403
|
optional :billable_metric_id, String, nil?: true
|
3404
3404
|
|
3405
3405
|
# @!attribute billed_in_advance
|
3406
3406
|
# If the Price represents a fixed cost, the price will be billed in-advance if
|
3407
|
-
#
|
3407
|
+
# this is true, and in-arrears if this is false.
|
3408
3408
|
#
|
3409
3409
|
# @return [Boolean, nil]
|
3410
3410
|
optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
|
3411
3411
|
|
3412
3412
|
# @!attribute billing_cycle_configuration
|
3413
3413
|
# For custom cadence: specifies the duration of the billing period in days or
|
3414
|
-
#
|
3414
|
+
# months.
|
3415
3415
|
#
|
3416
3416
|
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackagePrice::BillingCycleConfiguration, nil]
|
3417
3417
|
optional :billing_cycle_configuration,
|
@@ -3432,7 +3432,7 @@ module Orb
|
|
3432
3432
|
|
3433
3433
|
# @!attribute fixed_price_quantity
|
3434
3434
|
# If the Price represents a fixed cost, this represents the quantity of units
|
3435
|
-
#
|
3435
|
+
# applied.
|
3436
3436
|
#
|
3437
3437
|
# @return [Float, nil]
|
3438
3438
|
optional :fixed_price_quantity, Float, nil?: true
|
@@ -3445,7 +3445,7 @@ module Orb
|
|
3445
3445
|
|
3446
3446
|
# @!attribute invoicing_cycle_configuration
|
3447
3447
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
3448
|
-
#
|
3448
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
3449
3449
|
#
|
3450
3450
|
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackagePrice::InvoicingCycleConfiguration, nil]
|
3451
3451
|
optional :invoicing_cycle_configuration,
|
@@ -3454,8 +3454,8 @@ module Orb
|
|
3454
3454
|
|
3455
3455
|
# @!attribute metadata
|
3456
3456
|
# User-specified key/value pairs for the resource. Individual keys can be removed
|
3457
|
-
#
|
3458
|
-
#
|
3457
|
+
# by setting the value to `null`, and the entire metadata mapping can be cleared
|
3458
|
+
# by setting `metadata` to `null`.
|
3459
3459
|
#
|
3460
3460
|
# @return [Hash{Symbol=>String, nil}, nil]
|
3461
3461
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
@@ -3537,7 +3537,7 @@ module Orb
|
|
3537
3537
|
|
3538
3538
|
# @!parse
|
3539
3539
|
# # For custom cadence: specifies the duration of the billing period in days or
|
3540
|
-
# #
|
3540
|
+
# # months.
|
3541
3541
|
# #
|
3542
3542
|
# # @param duration [Integer]
|
3543
3543
|
# # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackagePrice::BillingCycleConfiguration::DurationUnit]
|
@@ -3580,7 +3580,7 @@ module Orb
|
|
3580
3580
|
|
3581
3581
|
# @!parse
|
3582
3582
|
# # Within each billing cycle, specifies the cadence at which invoices are produced.
|
3583
|
-
# #
|
3583
|
+
# # If unspecified, a single invoice is produced per billing cycle.
|
3584
3584
|
# #
|
3585
3585
|
# # @param duration [Integer]
|
3586
3586
|
# # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit]
|
@@ -3645,21 +3645,21 @@ module Orb
|
|
3645
3645
|
|
3646
3646
|
# @!attribute billable_metric_id
|
3647
3647
|
# The id of the billable metric for the price. Only needed if the price is
|
3648
|
-
#
|
3648
|
+
# usage-based.
|
3649
3649
|
#
|
3650
3650
|
# @return [String, nil]
|
3651
3651
|
optional :billable_metric_id, String, nil?: true
|
3652
3652
|
|
3653
3653
|
# @!attribute billed_in_advance
|
3654
3654
|
# If the Price represents a fixed cost, the price will be billed in-advance if
|
3655
|
-
#
|
3655
|
+
# this is true, and in-arrears if this is false.
|
3656
3656
|
#
|
3657
3657
|
# @return [Boolean, nil]
|
3658
3658
|
optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
|
3659
3659
|
|
3660
3660
|
# @!attribute billing_cycle_configuration
|
3661
3661
|
# For custom cadence: specifies the duration of the billing period in days or
|
3662
|
-
#
|
3662
|
+
# months.
|
3663
3663
|
#
|
3664
3664
|
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPrice::BillingCycleConfiguration, nil]
|
3665
3665
|
optional :billing_cycle_configuration,
|
@@ -3680,7 +3680,7 @@ module Orb
|
|
3680
3680
|
|
3681
3681
|
# @!attribute fixed_price_quantity
|
3682
3682
|
# If the Price represents a fixed cost, this represents the quantity of units
|
3683
|
-
#
|
3683
|
+
# applied.
|
3684
3684
|
#
|
3685
3685
|
# @return [Float, nil]
|
3686
3686
|
optional :fixed_price_quantity, Float, nil?: true
|
@@ -3693,7 +3693,7 @@ module Orb
|
|
3693
3693
|
|
3694
3694
|
# @!attribute invoicing_cycle_configuration
|
3695
3695
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
3696
|
-
#
|
3696
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
3697
3697
|
#
|
3698
3698
|
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPrice::InvoicingCycleConfiguration, nil]
|
3699
3699
|
optional :invoicing_cycle_configuration,
|
@@ -3702,8 +3702,8 @@ module Orb
|
|
3702
3702
|
|
3703
3703
|
# @!attribute metadata
|
3704
3704
|
# User-specified key/value pairs for the resource. Individual keys can be removed
|
3705
|
-
#
|
3706
|
-
#
|
3705
|
+
# by setting the value to `null`, and the entire metadata mapping can be cleared
|
3706
|
+
# by setting `metadata` to `null`.
|
3707
3707
|
#
|
3708
3708
|
# @return [Hash{Symbol=>String, nil}, nil]
|
3709
3709
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
@@ -3785,7 +3785,7 @@ module Orb
|
|
3785
3785
|
|
3786
3786
|
# @!parse
|
3787
3787
|
# # For custom cadence: specifies the duration of the billing period in days or
|
3788
|
-
# #
|
3788
|
+
# # months.
|
3789
3789
|
# #
|
3790
3790
|
# # @param duration [Integer]
|
3791
3791
|
# # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPrice::BillingCycleConfiguration::DurationUnit]
|
@@ -3828,7 +3828,7 @@ module Orb
|
|
3828
3828
|
|
3829
3829
|
# @!parse
|
3830
3830
|
# # Within each billing cycle, specifies the cadence at which invoices are produced.
|
3831
|
-
# #
|
3831
|
+
# # If unspecified, a single invoice is produced per billing cycle.
|
3832
3832
|
# #
|
3833
3833
|
# # @param duration [Integer]
|
3834
3834
|
# # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPrice::InvoicingCycleConfiguration::DurationUnit]
|
@@ -3894,21 +3894,21 @@ module Orb
|
|
3894
3894
|
|
3895
3895
|
# @!attribute billable_metric_id
|
3896
3896
|
# The id of the billable metric for the price. Only needed if the price is
|
3897
|
-
#
|
3897
|
+
# usage-based.
|
3898
3898
|
#
|
3899
3899
|
# @return [String, nil]
|
3900
3900
|
optional :billable_metric_id, String, nil?: true
|
3901
3901
|
|
3902
3902
|
# @!attribute billed_in_advance
|
3903
3903
|
# If the Price represents a fixed cost, the price will be billed in-advance if
|
3904
|
-
#
|
3904
|
+
# this is true, and in-arrears if this is false.
|
3905
3905
|
#
|
3906
3906
|
# @return [Boolean, nil]
|
3907
3907
|
optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
|
3908
3908
|
|
3909
3909
|
# @!attribute billing_cycle_configuration
|
3910
3910
|
# For custom cadence: specifies the duration of the billing period in days or
|
3911
|
-
#
|
3911
|
+
# months.
|
3912
3912
|
#
|
3913
3913
|
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMaxGroupTieredPackagePrice::BillingCycleConfiguration, nil]
|
3914
3914
|
optional :billing_cycle_configuration,
|
@@ -3929,7 +3929,7 @@ module Orb
|
|
3929
3929
|
|
3930
3930
|
# @!attribute fixed_price_quantity
|
3931
3931
|
# If the Price represents a fixed cost, this represents the quantity of units
|
3932
|
-
#
|
3932
|
+
# applied.
|
3933
3933
|
#
|
3934
3934
|
# @return [Float, nil]
|
3935
3935
|
optional :fixed_price_quantity, Float, nil?: true
|
@@ -3942,7 +3942,7 @@ module Orb
|
|
3942
3942
|
|
3943
3943
|
# @!attribute invoicing_cycle_configuration
|
3944
3944
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
3945
|
-
#
|
3945
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
3946
3946
|
#
|
3947
3947
|
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMaxGroupTieredPackagePrice::InvoicingCycleConfiguration, nil]
|
3948
3948
|
optional :invoicing_cycle_configuration,
|
@@ -3951,8 +3951,8 @@ module Orb
|
|
3951
3951
|
|
3952
3952
|
# @!attribute metadata
|
3953
3953
|
# User-specified key/value pairs for the resource. Individual keys can be removed
|
3954
|
-
#
|
3955
|
-
#
|
3954
|
+
# by setting the value to `null`, and the entire metadata mapping can be cleared
|
3955
|
+
# by setting `metadata` to `null`.
|
3956
3956
|
#
|
3957
3957
|
# @return [Hash{Symbol=>String, nil}, nil]
|
3958
3958
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
@@ -4034,7 +4034,7 @@ module Orb
|
|
4034
4034
|
|
4035
4035
|
# @!parse
|
4036
4036
|
# # For custom cadence: specifies the duration of the billing period in days or
|
4037
|
-
# #
|
4037
|
+
# # months.
|
4038
4038
|
# #
|
4039
4039
|
# # @param duration [Integer]
|
4040
4040
|
# # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMaxGroupTieredPackagePrice::BillingCycleConfiguration::DurationUnit]
|
@@ -4077,7 +4077,7 @@ module Orb
|
|
4077
4077
|
|
4078
4078
|
# @!parse
|
4079
4079
|
# # Within each billing cycle, specifies the cadence at which invoices are produced.
|
4080
|
-
# #
|
4080
|
+
# # If unspecified, a single invoice is produced per billing cycle.
|
4081
4081
|
# #
|
4082
4082
|
# # @param duration [Integer]
|
4083
4083
|
# # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMaxGroupTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit]
|
@@ -4142,21 +4142,21 @@ module Orb
|
|
4142
4142
|
|
4143
4143
|
# @!attribute billable_metric_id
|
4144
4144
|
# The id of the billable metric for the price. Only needed if the price is
|
4145
|
-
#
|
4145
|
+
# usage-based.
|
4146
4146
|
#
|
4147
4147
|
# @return [String, nil]
|
4148
4148
|
optional :billable_metric_id, String, nil?: true
|
4149
4149
|
|
4150
4150
|
# @!attribute billed_in_advance
|
4151
4151
|
# If the Price represents a fixed cost, the price will be billed in-advance if
|
4152
|
-
#
|
4152
|
+
# this is true, and in-arrears if this is false.
|
4153
4153
|
#
|
4154
4154
|
# @return [Boolean, nil]
|
4155
4155
|
optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
|
4156
4156
|
|
4157
4157
|
# @!attribute billing_cycle_configuration
|
4158
4158
|
# For custom cadence: specifies the duration of the billing period in days or
|
4159
|
-
#
|
4159
|
+
# months.
|
4160
4160
|
#
|
4161
4161
|
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithMinimumPrice::BillingCycleConfiguration, nil]
|
4162
4162
|
optional :billing_cycle_configuration,
|
@@ -4177,7 +4177,7 @@ module Orb
|
|
4177
4177
|
|
4178
4178
|
# @!attribute fixed_price_quantity
|
4179
4179
|
# If the Price represents a fixed cost, this represents the quantity of units
|
4180
|
-
#
|
4180
|
+
# applied.
|
4181
4181
|
#
|
4182
4182
|
# @return [Float, nil]
|
4183
4183
|
optional :fixed_price_quantity, Float, nil?: true
|
@@ -4190,7 +4190,7 @@ module Orb
|
|
4190
4190
|
|
4191
4191
|
# @!attribute invoicing_cycle_configuration
|
4192
4192
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
4193
|
-
#
|
4193
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
4194
4194
|
#
|
4195
4195
|
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithMinimumPrice::InvoicingCycleConfiguration, nil]
|
4196
4196
|
optional :invoicing_cycle_configuration,
|
@@ -4199,8 +4199,8 @@ module Orb
|
|
4199
4199
|
|
4200
4200
|
# @!attribute metadata
|
4201
4201
|
# User-specified key/value pairs for the resource. Individual keys can be removed
|
4202
|
-
#
|
4203
|
-
#
|
4202
|
+
# by setting the value to `null`, and the entire metadata mapping can be cleared
|
4203
|
+
# by setting `metadata` to `null`.
|
4204
4204
|
#
|
4205
4205
|
# @return [Hash{Symbol=>String, nil}, nil]
|
4206
4206
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
@@ -4282,7 +4282,7 @@ module Orb
|
|
4282
4282
|
|
4283
4283
|
# @!parse
|
4284
4284
|
# # For custom cadence: specifies the duration of the billing period in days or
|
4285
|
-
# #
|
4285
|
+
# # months.
|
4286
4286
|
# #
|
4287
4287
|
# # @param duration [Integer]
|
4288
4288
|
# # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithMinimumPrice::BillingCycleConfiguration::DurationUnit]
|
@@ -4325,7 +4325,7 @@ module Orb
|
|
4325
4325
|
|
4326
4326
|
# @!parse
|
4327
4327
|
# # Within each billing cycle, specifies the cadence at which invoices are produced.
|
4328
|
-
# #
|
4328
|
+
# # If unspecified, a single invoice is produced per billing cycle.
|
4329
4329
|
# #
|
4330
4330
|
# # @param duration [Integer]
|
4331
4331
|
# # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit]
|
@@ -4391,21 +4391,21 @@ module Orb
|
|
4391
4391
|
|
4392
4392
|
# @!attribute billable_metric_id
|
4393
4393
|
# The id of the billable metric for the price. Only needed if the price is
|
4394
|
-
#
|
4394
|
+
# usage-based.
|
4395
4395
|
#
|
4396
4396
|
# @return [String, nil]
|
4397
4397
|
optional :billable_metric_id, String, nil?: true
|
4398
4398
|
|
4399
4399
|
# @!attribute billed_in_advance
|
4400
4400
|
# If the Price represents a fixed cost, the price will be billed in-advance if
|
4401
|
-
#
|
4401
|
+
# this is true, and in-arrears if this is false.
|
4402
4402
|
#
|
4403
4403
|
# @return [Boolean, nil]
|
4404
4404
|
optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
|
4405
4405
|
|
4406
4406
|
# @!attribute billing_cycle_configuration
|
4407
4407
|
# For custom cadence: specifies the duration of the billing period in days or
|
4408
|
-
#
|
4408
|
+
# months.
|
4409
4409
|
#
|
4410
4410
|
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackageWithAllocationPrice::BillingCycleConfiguration, nil]
|
4411
4411
|
optional :billing_cycle_configuration,
|
@@ -4426,7 +4426,7 @@ module Orb
|
|
4426
4426
|
|
4427
4427
|
# @!attribute fixed_price_quantity
|
4428
4428
|
# If the Price represents a fixed cost, this represents the quantity of units
|
4429
|
-
#
|
4429
|
+
# applied.
|
4430
4430
|
#
|
4431
4431
|
# @return [Float, nil]
|
4432
4432
|
optional :fixed_price_quantity, Float, nil?: true
|
@@ -4439,7 +4439,7 @@ module Orb
|
|
4439
4439
|
|
4440
4440
|
# @!attribute invoicing_cycle_configuration
|
4441
4441
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
4442
|
-
#
|
4442
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
4443
4443
|
#
|
4444
4444
|
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackageWithAllocationPrice::InvoicingCycleConfiguration, nil]
|
4445
4445
|
optional :invoicing_cycle_configuration,
|
@@ -4448,8 +4448,8 @@ module Orb
|
|
4448
4448
|
|
4449
4449
|
# @!attribute metadata
|
4450
4450
|
# User-specified key/value pairs for the resource. Individual keys can be removed
|
4451
|
-
#
|
4452
|
-
#
|
4451
|
+
# by setting the value to `null`, and the entire metadata mapping can be cleared
|
4452
|
+
# by setting `metadata` to `null`.
|
4453
4453
|
#
|
4454
4454
|
# @return [Hash{Symbol=>String, nil}, nil]
|
4455
4455
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
@@ -4531,7 +4531,7 @@ module Orb
|
|
4531
4531
|
|
4532
4532
|
# @!parse
|
4533
4533
|
# # For custom cadence: specifies the duration of the billing period in days or
|
4534
|
-
# #
|
4534
|
+
# # months.
|
4535
4535
|
# #
|
4536
4536
|
# # @param duration [Integer]
|
4537
4537
|
# # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackageWithAllocationPrice::BillingCycleConfiguration::DurationUnit]
|
@@ -4574,7 +4574,7 @@ module Orb
|
|
4574
4574
|
|
4575
4575
|
# @!parse
|
4576
4576
|
# # Within each billing cycle, specifies the cadence at which invoices are produced.
|
4577
|
-
# #
|
4577
|
+
# # If unspecified, a single invoice is produced per billing cycle.
|
4578
4578
|
# #
|
4579
4579
|
# # @param duration [Integer]
|
4580
4580
|
# # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackageWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit]
|
@@ -4640,21 +4640,21 @@ module Orb
|
|
4640
4640
|
|
4641
4641
|
# @!attribute billable_metric_id
|
4642
4642
|
# The id of the billable metric for the price. Only needed if the price is
|
4643
|
-
#
|
4643
|
+
# usage-based.
|
4644
4644
|
#
|
4645
4645
|
# @return [String, nil]
|
4646
4646
|
optional :billable_metric_id, String, nil?: true
|
4647
4647
|
|
4648
4648
|
# @!attribute billed_in_advance
|
4649
4649
|
# If the Price represents a fixed cost, the price will be billed in-advance if
|
4650
|
-
#
|
4650
|
+
# this is true, and in-arrears if this is false.
|
4651
4651
|
#
|
4652
4652
|
# @return [Boolean, nil]
|
4653
4653
|
optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
|
4654
4654
|
|
4655
4655
|
# @!attribute billing_cycle_configuration
|
4656
4656
|
# For custom cadence: specifies the duration of the billing period in days or
|
4657
|
-
#
|
4657
|
+
# months.
|
4658
4658
|
#
|
4659
4659
|
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackageWithMinimumPrice::BillingCycleConfiguration, nil]
|
4660
4660
|
optional :billing_cycle_configuration,
|
@@ -4675,7 +4675,7 @@ module Orb
|
|
4675
4675
|
|
4676
4676
|
# @!attribute fixed_price_quantity
|
4677
4677
|
# If the Price represents a fixed cost, this represents the quantity of units
|
4678
|
-
#
|
4678
|
+
# applied.
|
4679
4679
|
#
|
4680
4680
|
# @return [Float, nil]
|
4681
4681
|
optional :fixed_price_quantity, Float, nil?: true
|
@@ -4688,7 +4688,7 @@ module Orb
|
|
4688
4688
|
|
4689
4689
|
# @!attribute invoicing_cycle_configuration
|
4690
4690
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
4691
|
-
#
|
4691
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
4692
4692
|
#
|
4693
4693
|
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackageWithMinimumPrice::InvoicingCycleConfiguration, nil]
|
4694
4694
|
optional :invoicing_cycle_configuration,
|
@@ -4697,8 +4697,8 @@ module Orb
|
|
4697
4697
|
|
4698
4698
|
# @!attribute metadata
|
4699
4699
|
# User-specified key/value pairs for the resource. Individual keys can be removed
|
4700
|
-
#
|
4701
|
-
#
|
4700
|
+
# by setting the value to `null`, and the entire metadata mapping can be cleared
|
4701
|
+
# by setting `metadata` to `null`.
|
4702
4702
|
#
|
4703
4703
|
# @return [Hash{Symbol=>String, nil}, nil]
|
4704
4704
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
@@ -4780,7 +4780,7 @@ module Orb
|
|
4780
4780
|
|
4781
4781
|
# @!parse
|
4782
4782
|
# # For custom cadence: specifies the duration of the billing period in days or
|
4783
|
-
# #
|
4783
|
+
# # months.
|
4784
4784
|
# #
|
4785
4785
|
# # @param duration [Integer]
|
4786
4786
|
# # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackageWithMinimumPrice::BillingCycleConfiguration::DurationUnit]
|
@@ -4823,7 +4823,7 @@ module Orb
|
|
4823
4823
|
|
4824
4824
|
# @!parse
|
4825
4825
|
# # Within each billing cycle, specifies the cadence at which invoices are produced.
|
4826
|
-
# #
|
4826
|
+
# # If unspecified, a single invoice is produced per billing cycle.
|
4827
4827
|
# #
|
4828
4828
|
# # @param duration [Integer]
|
4829
4829
|
# # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackageWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit]
|
@@ -4888,21 +4888,21 @@ module Orb
|
|
4888
4888
|
|
4889
4889
|
# @!attribute billable_metric_id
|
4890
4890
|
# The id of the billable metric for the price. Only needed if the price is
|
4891
|
-
#
|
4891
|
+
# usage-based.
|
4892
4892
|
#
|
4893
4893
|
# @return [String, nil]
|
4894
4894
|
optional :billable_metric_id, String, nil?: true
|
4895
4895
|
|
4896
4896
|
# @!attribute billed_in_advance
|
4897
4897
|
# If the Price represents a fixed cost, the price will be billed in-advance if
|
4898
|
-
#
|
4898
|
+
# this is true, and in-arrears if this is false.
|
4899
4899
|
#
|
4900
4900
|
# @return [Boolean, nil]
|
4901
4901
|
optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
|
4902
4902
|
|
4903
4903
|
# @!attribute billing_cycle_configuration
|
4904
4904
|
# For custom cadence: specifies the duration of the billing period in days or
|
4905
|
-
#
|
4905
|
+
# months.
|
4906
4906
|
#
|
4907
4907
|
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithPercentPrice::BillingCycleConfiguration, nil]
|
4908
4908
|
optional :billing_cycle_configuration,
|
@@ -4923,7 +4923,7 @@ module Orb
|
|
4923
4923
|
|
4924
4924
|
# @!attribute fixed_price_quantity
|
4925
4925
|
# If the Price represents a fixed cost, this represents the quantity of units
|
4926
|
-
#
|
4926
|
+
# applied.
|
4927
4927
|
#
|
4928
4928
|
# @return [Float, nil]
|
4929
4929
|
optional :fixed_price_quantity, Float, nil?: true
|
@@ -4936,7 +4936,7 @@ module Orb
|
|
4936
4936
|
|
4937
4937
|
# @!attribute invoicing_cycle_configuration
|
4938
4938
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
4939
|
-
#
|
4939
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
4940
4940
|
#
|
4941
4941
|
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithPercentPrice::InvoicingCycleConfiguration, nil]
|
4942
4942
|
optional :invoicing_cycle_configuration,
|
@@ -4945,8 +4945,8 @@ module Orb
|
|
4945
4945
|
|
4946
4946
|
# @!attribute metadata
|
4947
4947
|
# User-specified key/value pairs for the resource. Individual keys can be removed
|
4948
|
-
#
|
4949
|
-
#
|
4948
|
+
# by setting the value to `null`, and the entire metadata mapping can be cleared
|
4949
|
+
# by setting `metadata` to `null`.
|
4950
4950
|
#
|
4951
4951
|
# @return [Hash{Symbol=>String, nil}, nil]
|
4952
4952
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
@@ -5028,7 +5028,7 @@ module Orb
|
|
5028
5028
|
|
5029
5029
|
# @!parse
|
5030
5030
|
# # For custom cadence: specifies the duration of the billing period in days or
|
5031
|
-
# #
|
5031
|
+
# # months.
|
5032
5032
|
# #
|
5033
5033
|
# # @param duration [Integer]
|
5034
5034
|
# # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithPercentPrice::BillingCycleConfiguration::DurationUnit]
|
@@ -5071,7 +5071,7 @@ module Orb
|
|
5071
5071
|
|
5072
5072
|
# @!parse
|
5073
5073
|
# # Within each billing cycle, specifies the cadence at which invoices are produced.
|
5074
|
-
# #
|
5074
|
+
# # If unspecified, a single invoice is produced per billing cycle.
|
5075
5075
|
# #
|
5076
5076
|
# # @param duration [Integer]
|
5077
5077
|
# # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithPercentPrice::InvoicingCycleConfiguration::DurationUnit]
|
@@ -5136,21 +5136,21 @@ module Orb
|
|
5136
5136
|
|
5137
5137
|
# @!attribute billable_metric_id
|
5138
5138
|
# The id of the billable metric for the price. Only needed if the price is
|
5139
|
-
#
|
5139
|
+
# usage-based.
|
5140
5140
|
#
|
5141
5141
|
# @return [String, nil]
|
5142
5142
|
optional :billable_metric_id, String, nil?: true
|
5143
5143
|
|
5144
5144
|
# @!attribute billed_in_advance
|
5145
5145
|
# If the Price represents a fixed cost, the price will be billed in-advance if
|
5146
|
-
#
|
5146
|
+
# this is true, and in-arrears if this is false.
|
5147
5147
|
#
|
5148
5148
|
# @return [Boolean, nil]
|
5149
5149
|
optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
|
5150
5150
|
|
5151
5151
|
# @!attribute billing_cycle_configuration
|
5152
5152
|
# For custom cadence: specifies the duration of the billing period in days or
|
5153
|
-
#
|
5153
|
+
# months.
|
5154
5154
|
#
|
5155
5155
|
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithProrationPrice::BillingCycleConfiguration, nil]
|
5156
5156
|
optional :billing_cycle_configuration,
|
@@ -5171,7 +5171,7 @@ module Orb
|
|
5171
5171
|
|
5172
5172
|
# @!attribute fixed_price_quantity
|
5173
5173
|
# If the Price represents a fixed cost, this represents the quantity of units
|
5174
|
-
#
|
5174
|
+
# applied.
|
5175
5175
|
#
|
5176
5176
|
# @return [Float, nil]
|
5177
5177
|
optional :fixed_price_quantity, Float, nil?: true
|
@@ -5184,7 +5184,7 @@ module Orb
|
|
5184
5184
|
|
5185
5185
|
# @!attribute invoicing_cycle_configuration
|
5186
5186
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
5187
|
-
#
|
5187
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
5188
5188
|
#
|
5189
5189
|
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithProrationPrice::InvoicingCycleConfiguration, nil]
|
5190
5190
|
optional :invoicing_cycle_configuration,
|
@@ -5193,8 +5193,8 @@ module Orb
|
|
5193
5193
|
|
5194
5194
|
# @!attribute metadata
|
5195
5195
|
# User-specified key/value pairs for the resource. Individual keys can be removed
|
5196
|
-
#
|
5197
|
-
#
|
5196
|
+
# by setting the value to `null`, and the entire metadata mapping can be cleared
|
5197
|
+
# by setting `metadata` to `null`.
|
5198
5198
|
#
|
5199
5199
|
# @return [Hash{Symbol=>String, nil}, nil]
|
5200
5200
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
@@ -5276,7 +5276,7 @@ module Orb
|
|
5276
5276
|
|
5277
5277
|
# @!parse
|
5278
5278
|
# # For custom cadence: specifies the duration of the billing period in days or
|
5279
|
-
# #
|
5279
|
+
# # months.
|
5280
5280
|
# #
|
5281
5281
|
# # @param duration [Integer]
|
5282
5282
|
# # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithProrationPrice::BillingCycleConfiguration::DurationUnit]
|
@@ -5319,7 +5319,7 @@ module Orb
|
|
5319
5319
|
|
5320
5320
|
# @!parse
|
5321
5321
|
# # Within each billing cycle, specifies the cadence at which invoices are produced.
|
5322
|
-
# #
|
5322
|
+
# # If unspecified, a single invoice is produced per billing cycle.
|
5323
5323
|
# #
|
5324
5324
|
# # @param duration [Integer]
|
5325
5325
|
# # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithProrationPrice::InvoicingCycleConfiguration::DurationUnit]
|
@@ -5384,21 +5384,21 @@ module Orb
|
|
5384
5384
|
|
5385
5385
|
# @!attribute billable_metric_id
|
5386
5386
|
# The id of the billable metric for the price. Only needed if the price is
|
5387
|
-
#
|
5387
|
+
# usage-based.
|
5388
5388
|
#
|
5389
5389
|
# @return [String, nil]
|
5390
5390
|
optional :billable_metric_id, String, nil?: true
|
5391
5391
|
|
5392
5392
|
# @!attribute billed_in_advance
|
5393
5393
|
# If the Price represents a fixed cost, the price will be billed in-advance if
|
5394
|
-
#
|
5394
|
+
# this is true, and in-arrears if this is false.
|
5395
5395
|
#
|
5396
5396
|
# @return [Boolean, nil]
|
5397
5397
|
optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
|
5398
5398
|
|
5399
5399
|
# @!attribute billing_cycle_configuration
|
5400
5400
|
# For custom cadence: specifies the duration of the billing period in days or
|
5401
|
-
#
|
5401
|
+
# months.
|
5402
5402
|
#
|
5403
5403
|
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithProrationPrice::BillingCycleConfiguration, nil]
|
5404
5404
|
optional :billing_cycle_configuration,
|
@@ -5419,7 +5419,7 @@ module Orb
|
|
5419
5419
|
|
5420
5420
|
# @!attribute fixed_price_quantity
|
5421
5421
|
# If the Price represents a fixed cost, this represents the quantity of units
|
5422
|
-
#
|
5422
|
+
# applied.
|
5423
5423
|
#
|
5424
5424
|
# @return [Float, nil]
|
5425
5425
|
optional :fixed_price_quantity, Float, nil?: true
|
@@ -5432,7 +5432,7 @@ module Orb
|
|
5432
5432
|
|
5433
5433
|
# @!attribute invoicing_cycle_configuration
|
5434
5434
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
5435
|
-
#
|
5435
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
5436
5436
|
#
|
5437
5437
|
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithProrationPrice::InvoicingCycleConfiguration, nil]
|
5438
5438
|
optional :invoicing_cycle_configuration,
|
@@ -5441,8 +5441,8 @@ module Orb
|
|
5441
5441
|
|
5442
5442
|
# @!attribute metadata
|
5443
5443
|
# User-specified key/value pairs for the resource. Individual keys can be removed
|
5444
|
-
#
|
5445
|
-
#
|
5444
|
+
# by setting the value to `null`, and the entire metadata mapping can be cleared
|
5445
|
+
# by setting `metadata` to `null`.
|
5446
5446
|
#
|
5447
5447
|
# @return [Hash{Symbol=>String, nil}, nil]
|
5448
5448
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
@@ -5524,7 +5524,7 @@ module Orb
|
|
5524
5524
|
|
5525
5525
|
# @!parse
|
5526
5526
|
# # For custom cadence: specifies the duration of the billing period in days or
|
5527
|
-
# #
|
5527
|
+
# # months.
|
5528
5528
|
# #
|
5529
5529
|
# # @param duration [Integer]
|
5530
5530
|
# # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithProrationPrice::BillingCycleConfiguration::DurationUnit]
|
@@ -5567,7 +5567,7 @@ module Orb
|
|
5567
5567
|
|
5568
5568
|
# @!parse
|
5569
5569
|
# # Within each billing cycle, specifies the cadence at which invoices are produced.
|
5570
|
-
# #
|
5570
|
+
# # If unspecified, a single invoice is produced per billing cycle.
|
5571
5571
|
# #
|
5572
5572
|
# # @param duration [Integer]
|
5573
5573
|
# # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithProrationPrice::InvoicingCycleConfiguration::DurationUnit]
|
@@ -5632,21 +5632,21 @@ module Orb
|
|
5632
5632
|
|
5633
5633
|
# @!attribute billable_metric_id
|
5634
5634
|
# The id of the billable metric for the price. Only needed if the price is
|
5635
|
-
#
|
5635
|
+
# usage-based.
|
5636
5636
|
#
|
5637
5637
|
# @return [String, nil]
|
5638
5638
|
optional :billable_metric_id, String, nil?: true
|
5639
5639
|
|
5640
5640
|
# @!attribute billed_in_advance
|
5641
5641
|
# If the Price represents a fixed cost, the price will be billed in-advance if
|
5642
|
-
#
|
5642
|
+
# this is true, and in-arrears if this is false.
|
5643
5643
|
#
|
5644
5644
|
# @return [Boolean, nil]
|
5645
5645
|
optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
|
5646
5646
|
|
5647
5647
|
# @!attribute billing_cycle_configuration
|
5648
5648
|
# For custom cadence: specifies the duration of the billing period in days or
|
5649
|
-
#
|
5649
|
+
# months.
|
5650
5650
|
#
|
5651
5651
|
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedAllocationPrice::BillingCycleConfiguration, nil]
|
5652
5652
|
optional :billing_cycle_configuration,
|
@@ -5667,7 +5667,7 @@ module Orb
|
|
5667
5667
|
|
5668
5668
|
# @!attribute fixed_price_quantity
|
5669
5669
|
# If the Price represents a fixed cost, this represents the quantity of units
|
5670
|
-
#
|
5670
|
+
# applied.
|
5671
5671
|
#
|
5672
5672
|
# @return [Float, nil]
|
5673
5673
|
optional :fixed_price_quantity, Float, nil?: true
|
@@ -5680,7 +5680,7 @@ module Orb
|
|
5680
5680
|
|
5681
5681
|
# @!attribute invoicing_cycle_configuration
|
5682
5682
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
5683
|
-
#
|
5683
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
5684
5684
|
#
|
5685
5685
|
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedAllocationPrice::InvoicingCycleConfiguration, nil]
|
5686
5686
|
optional :invoicing_cycle_configuration,
|
@@ -5689,8 +5689,8 @@ module Orb
|
|
5689
5689
|
|
5690
5690
|
# @!attribute metadata
|
5691
5691
|
# User-specified key/value pairs for the resource. Individual keys can be removed
|
5692
|
-
#
|
5693
|
-
#
|
5692
|
+
# by setting the value to `null`, and the entire metadata mapping can be cleared
|
5693
|
+
# by setting `metadata` to `null`.
|
5694
5694
|
#
|
5695
5695
|
# @return [Hash{Symbol=>String, nil}, nil]
|
5696
5696
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
@@ -5772,7 +5772,7 @@ module Orb
|
|
5772
5772
|
|
5773
5773
|
# @!parse
|
5774
5774
|
# # For custom cadence: specifies the duration of the billing period in days or
|
5775
|
-
# #
|
5775
|
+
# # months.
|
5776
5776
|
# #
|
5777
5777
|
# # @param duration [Integer]
|
5778
5778
|
# # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedAllocationPrice::BillingCycleConfiguration::DurationUnit]
|
@@ -5815,7 +5815,7 @@ module Orb
|
|
5815
5815
|
|
5816
5816
|
# @!parse
|
5817
5817
|
# # Within each billing cycle, specifies the cadence at which invoices are produced.
|
5818
|
-
# #
|
5818
|
+
# # If unspecified, a single invoice is produced per billing cycle.
|
5819
5819
|
# #
|
5820
5820
|
# # @param duration [Integer]
|
5821
5821
|
# # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedAllocationPrice::InvoicingCycleConfiguration::DurationUnit]
|
@@ -5881,21 +5881,21 @@ module Orb
|
|
5881
5881
|
|
5882
5882
|
# @!attribute billable_metric_id
|
5883
5883
|
# The id of the billable metric for the price. Only needed if the price is
|
5884
|
-
#
|
5884
|
+
# usage-based.
|
5885
5885
|
#
|
5886
5886
|
# @return [String, nil]
|
5887
5887
|
optional :billable_metric_id, String, nil?: true
|
5888
5888
|
|
5889
5889
|
# @!attribute billed_in_advance
|
5890
5890
|
# If the Price represents a fixed cost, the price will be billed in-advance if
|
5891
|
-
#
|
5891
|
+
# this is true, and in-arrears if this is false.
|
5892
5892
|
#
|
5893
5893
|
# @return [Boolean, nil]
|
5894
5894
|
optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
|
5895
5895
|
|
5896
5896
|
# @!attribute billing_cycle_configuration
|
5897
5897
|
# For custom cadence: specifies the duration of the billing period in days or
|
5898
|
-
#
|
5898
|
+
# months.
|
5899
5899
|
#
|
5900
5900
|
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithProratedMinimumPrice::BillingCycleConfiguration, nil]
|
5901
5901
|
optional :billing_cycle_configuration,
|
@@ -5916,7 +5916,7 @@ module Orb
|
|
5916
5916
|
|
5917
5917
|
# @!attribute fixed_price_quantity
|
5918
5918
|
# If the Price represents a fixed cost, this represents the quantity of units
|
5919
|
-
#
|
5919
|
+
# applied.
|
5920
5920
|
#
|
5921
5921
|
# @return [Float, nil]
|
5922
5922
|
optional :fixed_price_quantity, Float, nil?: true
|
@@ -5929,7 +5929,7 @@ module Orb
|
|
5929
5929
|
|
5930
5930
|
# @!attribute invoicing_cycle_configuration
|
5931
5931
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
5932
|
-
#
|
5932
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
5933
5933
|
#
|
5934
5934
|
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration, nil]
|
5935
5935
|
optional :invoicing_cycle_configuration,
|
@@ -5938,8 +5938,8 @@ module Orb
|
|
5938
5938
|
|
5939
5939
|
# @!attribute metadata
|
5940
5940
|
# User-specified key/value pairs for the resource. Individual keys can be removed
|
5941
|
-
#
|
5942
|
-
#
|
5941
|
+
# by setting the value to `null`, and the entire metadata mapping can be cleared
|
5942
|
+
# by setting `metadata` to `null`.
|
5943
5943
|
#
|
5944
5944
|
# @return [Hash{Symbol=>String, nil}, nil]
|
5945
5945
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
@@ -6021,7 +6021,7 @@ module Orb
|
|
6021
6021
|
|
6022
6022
|
# @!parse
|
6023
6023
|
# # For custom cadence: specifies the duration of the billing period in days or
|
6024
|
-
# #
|
6024
|
+
# # months.
|
6025
6025
|
# #
|
6026
6026
|
# # @param duration [Integer]
|
6027
6027
|
# # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithProratedMinimumPrice::BillingCycleConfiguration::DurationUnit]
|
@@ -6064,7 +6064,7 @@ module Orb
|
|
6064
6064
|
|
6065
6065
|
# @!parse
|
6066
6066
|
# # Within each billing cycle, specifies the cadence at which invoices are produced.
|
6067
|
-
# #
|
6067
|
+
# # If unspecified, a single invoice is produced per billing cycle.
|
6068
6068
|
# #
|
6069
6069
|
# # @param duration [Integer]
|
6070
6070
|
# # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration::DurationUnit]
|
@@ -6130,21 +6130,21 @@ module Orb
|
|
6130
6130
|
|
6131
6131
|
# @!attribute billable_metric_id
|
6132
6132
|
# The id of the billable metric for the price. Only needed if the price is
|
6133
|
-
#
|
6133
|
+
# usage-based.
|
6134
6134
|
#
|
6135
6135
|
# @return [String, nil]
|
6136
6136
|
optional :billable_metric_id, String, nil?: true
|
6137
6137
|
|
6138
6138
|
# @!attribute billed_in_advance
|
6139
6139
|
# If the Price represents a fixed cost, the price will be billed in-advance if
|
6140
|
-
#
|
6140
|
+
# this is true, and in-arrears if this is false.
|
6141
6141
|
#
|
6142
6142
|
# @return [Boolean, nil]
|
6143
6143
|
optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
|
6144
6144
|
|
6145
6145
|
# @!attribute billing_cycle_configuration
|
6146
6146
|
# For custom cadence: specifies the duration of the billing period in days or
|
6147
|
-
#
|
6147
|
+
# months.
|
6148
6148
|
#
|
6149
6149
|
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithMeteredMinimumPrice::BillingCycleConfiguration, nil]
|
6150
6150
|
optional :billing_cycle_configuration,
|
@@ -6165,7 +6165,7 @@ module Orb
|
|
6165
6165
|
|
6166
6166
|
# @!attribute fixed_price_quantity
|
6167
6167
|
# If the Price represents a fixed cost, this represents the quantity of units
|
6168
|
-
#
|
6168
|
+
# applied.
|
6169
6169
|
#
|
6170
6170
|
# @return [Float, nil]
|
6171
6171
|
optional :fixed_price_quantity, Float, nil?: true
|
@@ -6178,7 +6178,7 @@ module Orb
|
|
6178
6178
|
|
6179
6179
|
# @!attribute invoicing_cycle_configuration
|
6180
6180
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
6181
|
-
#
|
6181
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
6182
6182
|
#
|
6183
6183
|
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration, nil]
|
6184
6184
|
optional :invoicing_cycle_configuration,
|
@@ -6187,8 +6187,8 @@ module Orb
|
|
6187
6187
|
|
6188
6188
|
# @!attribute metadata
|
6189
6189
|
# User-specified key/value pairs for the resource. Individual keys can be removed
|
6190
|
-
#
|
6191
|
-
#
|
6190
|
+
# by setting the value to `null`, and the entire metadata mapping can be cleared
|
6191
|
+
# by setting `metadata` to `null`.
|
6192
6192
|
#
|
6193
6193
|
# @return [Hash{Symbol=>String, nil}, nil]
|
6194
6194
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
@@ -6270,7 +6270,7 @@ module Orb
|
|
6270
6270
|
|
6271
6271
|
# @!parse
|
6272
6272
|
# # For custom cadence: specifies the duration of the billing period in days or
|
6273
|
-
# #
|
6273
|
+
# # months.
|
6274
6274
|
# #
|
6275
6275
|
# # @param duration [Integer]
|
6276
6276
|
# # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithMeteredMinimumPrice::BillingCycleConfiguration::DurationUnit]
|
@@ -6313,7 +6313,7 @@ module Orb
|
|
6313
6313
|
|
6314
6314
|
# @!parse
|
6315
6315
|
# # Within each billing cycle, specifies the cadence at which invoices are produced.
|
6316
|
-
# #
|
6316
|
+
# # If unspecified, a single invoice is produced per billing cycle.
|
6317
6317
|
# #
|
6318
6318
|
# # @param duration [Integer]
|
6319
6319
|
# # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration::DurationUnit]
|
@@ -6379,21 +6379,21 @@ module Orb
|
|
6379
6379
|
|
6380
6380
|
# @!attribute billable_metric_id
|
6381
6381
|
# The id of the billable metric for the price. Only needed if the price is
|
6382
|
-
#
|
6382
|
+
# usage-based.
|
6383
6383
|
#
|
6384
6384
|
# @return [String, nil]
|
6385
6385
|
optional :billable_metric_id, String, nil?: true
|
6386
6386
|
|
6387
6387
|
# @!attribute billed_in_advance
|
6388
6388
|
# If the Price represents a fixed cost, the price will be billed in-advance if
|
6389
|
-
#
|
6389
|
+
# this is true, and in-arrears if this is false.
|
6390
6390
|
#
|
6391
6391
|
# @return [Boolean, nil]
|
6392
6392
|
optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
|
6393
6393
|
|
6394
6394
|
# @!attribute billing_cycle_configuration
|
6395
6395
|
# For custom cadence: specifies the duration of the billing period in days or
|
6396
|
-
#
|
6396
|
+
# months.
|
6397
6397
|
#
|
6398
6398
|
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithDisplayNamePrice::BillingCycleConfiguration, nil]
|
6399
6399
|
optional :billing_cycle_configuration,
|
@@ -6414,7 +6414,7 @@ module Orb
|
|
6414
6414
|
|
6415
6415
|
# @!attribute fixed_price_quantity
|
6416
6416
|
# If the Price represents a fixed cost, this represents the quantity of units
|
6417
|
-
#
|
6417
|
+
# applied.
|
6418
6418
|
#
|
6419
6419
|
# @return [Float, nil]
|
6420
6420
|
optional :fixed_price_quantity, Float, nil?: true
|
@@ -6427,7 +6427,7 @@ module Orb
|
|
6427
6427
|
|
6428
6428
|
# @!attribute invoicing_cycle_configuration
|
6429
6429
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
6430
|
-
#
|
6430
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
6431
6431
|
#
|
6432
6432
|
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithDisplayNamePrice::InvoicingCycleConfiguration, nil]
|
6433
6433
|
optional :invoicing_cycle_configuration,
|
@@ -6436,8 +6436,8 @@ module Orb
|
|
6436
6436
|
|
6437
6437
|
# @!attribute metadata
|
6438
6438
|
# User-specified key/value pairs for the resource. Individual keys can be removed
|
6439
|
-
#
|
6440
|
-
#
|
6439
|
+
# by setting the value to `null`, and the entire metadata mapping can be cleared
|
6440
|
+
# by setting `metadata` to `null`.
|
6441
6441
|
#
|
6442
6442
|
# @return [Hash{Symbol=>String, nil}, nil]
|
6443
6443
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
@@ -6519,7 +6519,7 @@ module Orb
|
|
6519
6519
|
|
6520
6520
|
# @!parse
|
6521
6521
|
# # For custom cadence: specifies the duration of the billing period in days or
|
6522
|
-
# #
|
6522
|
+
# # months.
|
6523
6523
|
# #
|
6524
6524
|
# # @param duration [Integer]
|
6525
6525
|
# # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithDisplayNamePrice::BillingCycleConfiguration::DurationUnit]
|
@@ -6562,7 +6562,7 @@ module Orb
|
|
6562
6562
|
|
6563
6563
|
# @!parse
|
6564
6564
|
# # Within each billing cycle, specifies the cadence at which invoices are produced.
|
6565
|
-
# #
|
6565
|
+
# # If unspecified, a single invoice is produced per billing cycle.
|
6566
6566
|
# #
|
6567
6567
|
# # @param duration [Integer]
|
6568
6568
|
# # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithDisplayNamePrice::InvoicingCycleConfiguration::DurationUnit]
|
@@ -6627,21 +6627,21 @@ module Orb
|
|
6627
6627
|
|
6628
6628
|
# @!attribute billable_metric_id
|
6629
6629
|
# The id of the billable metric for the price. Only needed if the price is
|
6630
|
-
#
|
6630
|
+
# usage-based.
|
6631
6631
|
#
|
6632
6632
|
# @return [String, nil]
|
6633
6633
|
optional :billable_metric_id, String, nil?: true
|
6634
6634
|
|
6635
6635
|
# @!attribute billed_in_advance
|
6636
6636
|
# If the Price represents a fixed cost, the price will be billed in-advance if
|
6637
|
-
#
|
6637
|
+
# this is true, and in-arrears if this is false.
|
6638
6638
|
#
|
6639
6639
|
# @return [Boolean, nil]
|
6640
6640
|
optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
|
6641
6641
|
|
6642
6642
|
# @!attribute billing_cycle_configuration
|
6643
6643
|
# For custom cadence: specifies the duration of the billing period in days or
|
6644
|
-
#
|
6644
|
+
# months.
|
6645
6645
|
#
|
6646
6646
|
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkWithProrationPrice::BillingCycleConfiguration, nil]
|
6647
6647
|
optional :billing_cycle_configuration,
|
@@ -6662,7 +6662,7 @@ module Orb
|
|
6662
6662
|
|
6663
6663
|
# @!attribute fixed_price_quantity
|
6664
6664
|
# If the Price represents a fixed cost, this represents the quantity of units
|
6665
|
-
#
|
6665
|
+
# applied.
|
6666
6666
|
#
|
6667
6667
|
# @return [Float, nil]
|
6668
6668
|
optional :fixed_price_quantity, Float, nil?: true
|
@@ -6675,7 +6675,7 @@ module Orb
|
|
6675
6675
|
|
6676
6676
|
# @!attribute invoicing_cycle_configuration
|
6677
6677
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
6678
|
-
#
|
6678
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
6679
6679
|
#
|
6680
6680
|
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkWithProrationPrice::InvoicingCycleConfiguration, nil]
|
6681
6681
|
optional :invoicing_cycle_configuration,
|
@@ -6684,8 +6684,8 @@ module Orb
|
|
6684
6684
|
|
6685
6685
|
# @!attribute metadata
|
6686
6686
|
# User-specified key/value pairs for the resource. Individual keys can be removed
|
6687
|
-
#
|
6688
|
-
#
|
6687
|
+
# by setting the value to `null`, and the entire metadata mapping can be cleared
|
6688
|
+
# by setting `metadata` to `null`.
|
6689
6689
|
#
|
6690
6690
|
# @return [Hash{Symbol=>String, nil}, nil]
|
6691
6691
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
@@ -6767,7 +6767,7 @@ module Orb
|
|
6767
6767
|
|
6768
6768
|
# @!parse
|
6769
6769
|
# # For custom cadence: specifies the duration of the billing period in days or
|
6770
|
-
# #
|
6770
|
+
# # months.
|
6771
6771
|
# #
|
6772
6772
|
# # @param duration [Integer]
|
6773
6773
|
# # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkWithProrationPrice::BillingCycleConfiguration::DurationUnit]
|
@@ -6810,7 +6810,7 @@ module Orb
|
|
6810
6810
|
|
6811
6811
|
# @!parse
|
6812
6812
|
# # Within each billing cycle, specifies the cadence at which invoices are produced.
|
6813
|
-
# #
|
6813
|
+
# # If unspecified, a single invoice is produced per billing cycle.
|
6814
6814
|
# #
|
6815
6815
|
# # @param duration [Integer]
|
6816
6816
|
# # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkWithProrationPrice::InvoicingCycleConfiguration::DurationUnit]
|
@@ -6875,21 +6875,21 @@ module Orb
|
|
6875
6875
|
|
6876
6876
|
# @!attribute billable_metric_id
|
6877
6877
|
# The id of the billable metric for the price. Only needed if the price is
|
6878
|
-
#
|
6878
|
+
# usage-based.
|
6879
6879
|
#
|
6880
6880
|
# @return [String, nil]
|
6881
6881
|
optional :billable_metric_id, String, nil?: true
|
6882
6882
|
|
6883
6883
|
# @!attribute billed_in_advance
|
6884
6884
|
# If the Price represents a fixed cost, the price will be billed in-advance if
|
6885
|
-
#
|
6885
|
+
# this is true, and in-arrears if this is false.
|
6886
6886
|
#
|
6887
6887
|
# @return [Boolean, nil]
|
6888
6888
|
optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
|
6889
6889
|
|
6890
6890
|
# @!attribute billing_cycle_configuration
|
6891
6891
|
# For custom cadence: specifies the duration of the billing period in days or
|
6892
|
-
#
|
6892
|
+
# months.
|
6893
6893
|
#
|
6894
6894
|
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPackagePrice::BillingCycleConfiguration, nil]
|
6895
6895
|
optional :billing_cycle_configuration,
|
@@ -6910,7 +6910,7 @@ module Orb
|
|
6910
6910
|
|
6911
6911
|
# @!attribute fixed_price_quantity
|
6912
6912
|
# If the Price represents a fixed cost, this represents the quantity of units
|
6913
|
-
#
|
6913
|
+
# applied.
|
6914
6914
|
#
|
6915
6915
|
# @return [Float, nil]
|
6916
6916
|
optional :fixed_price_quantity, Float, nil?: true
|
@@ -6923,7 +6923,7 @@ module Orb
|
|
6923
6923
|
|
6924
6924
|
# @!attribute invoicing_cycle_configuration
|
6925
6925
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
6926
|
-
#
|
6926
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
6927
6927
|
#
|
6928
6928
|
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPackagePrice::InvoicingCycleConfiguration, nil]
|
6929
6929
|
optional :invoicing_cycle_configuration,
|
@@ -6932,8 +6932,8 @@ module Orb
|
|
6932
6932
|
|
6933
6933
|
# @!attribute metadata
|
6934
6934
|
# User-specified key/value pairs for the resource. Individual keys can be removed
|
6935
|
-
#
|
6936
|
-
#
|
6935
|
+
# by setting the value to `null`, and the entire metadata mapping can be cleared
|
6936
|
+
# by setting `metadata` to `null`.
|
6937
6937
|
#
|
6938
6938
|
# @return [Hash{Symbol=>String, nil}, nil]
|
6939
6939
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
@@ -7015,7 +7015,7 @@ module Orb
|
|
7015
7015
|
|
7016
7016
|
# @!parse
|
7017
7017
|
# # For custom cadence: specifies the duration of the billing period in days or
|
7018
|
-
# #
|
7018
|
+
# # months.
|
7019
7019
|
# #
|
7020
7020
|
# # @param duration [Integer]
|
7021
7021
|
# # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPackagePrice::BillingCycleConfiguration::DurationUnit]
|
@@ -7058,7 +7058,7 @@ module Orb
|
|
7058
7058
|
|
7059
7059
|
# @!parse
|
7060
7060
|
# # Within each billing cycle, specifies the cadence at which invoices are produced.
|
7061
|
-
# #
|
7061
|
+
# # If unspecified, a single invoice is produced per billing cycle.
|
7062
7062
|
# #
|
7063
7063
|
# # @param duration [Integer]
|
7064
7064
|
# # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit]
|
@@ -7124,21 +7124,21 @@ module Orb
|
|
7124
7124
|
|
7125
7125
|
# @!attribute billable_metric_id
|
7126
7126
|
# The id of the billable metric for the price. Only needed if the price is
|
7127
|
-
#
|
7127
|
+
# usage-based.
|
7128
7128
|
#
|
7129
7129
|
# @return [String, nil]
|
7130
7130
|
optional :billable_metric_id, String, nil?: true
|
7131
7131
|
|
7132
7132
|
# @!attribute billed_in_advance
|
7133
7133
|
# If the Price represents a fixed cost, the price will be billed in-advance if
|
7134
|
-
#
|
7134
|
+
# this is true, and in-arrears if this is false.
|
7135
7135
|
#
|
7136
7136
|
# @return [Boolean, nil]
|
7137
7137
|
optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
|
7138
7138
|
|
7139
7139
|
# @!attribute billing_cycle_configuration
|
7140
7140
|
# For custom cadence: specifies the duration of the billing period in days or
|
7141
|
-
#
|
7141
|
+
# months.
|
7142
7142
|
#
|
7143
7143
|
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration, nil]
|
7144
7144
|
optional :billing_cycle_configuration,
|
@@ -7159,7 +7159,7 @@ module Orb
|
|
7159
7159
|
|
7160
7160
|
# @!attribute fixed_price_quantity
|
7161
7161
|
# If the Price represents a fixed cost, this represents the quantity of units
|
7162
|
-
#
|
7162
|
+
# applied.
|
7163
7163
|
#
|
7164
7164
|
# @return [Float, nil]
|
7165
7165
|
optional :fixed_price_quantity, Float, nil?: true
|
@@ -7172,7 +7172,7 @@ module Orb
|
|
7172
7172
|
|
7173
7173
|
# @!attribute invoicing_cycle_configuration
|
7174
7174
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
7175
|
-
#
|
7175
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
7176
7176
|
#
|
7177
7177
|
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration, nil]
|
7178
7178
|
optional :invoicing_cycle_configuration,
|
@@ -7181,8 +7181,8 @@ module Orb
|
|
7181
7181
|
|
7182
7182
|
# @!attribute metadata
|
7183
7183
|
# User-specified key/value pairs for the resource. Individual keys can be removed
|
7184
|
-
#
|
7185
|
-
#
|
7184
|
+
# by setting the value to `null`, and the entire metadata mapping can be cleared
|
7185
|
+
# by setting `metadata` to `null`.
|
7186
7186
|
#
|
7187
7187
|
# @return [Hash{Symbol=>String, nil}, nil]
|
7188
7188
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
@@ -7264,7 +7264,7 @@ module Orb
|
|
7264
7264
|
|
7265
7265
|
# @!parse
|
7266
7266
|
# # For custom cadence: specifies the duration of the billing period in days or
|
7267
|
-
# #
|
7267
|
+
# # months.
|
7268
7268
|
# #
|
7269
7269
|
# # @param duration [Integer]
|
7270
7270
|
# # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration::DurationUnit]
|
@@ -7307,7 +7307,7 @@ module Orb
|
|
7307
7307
|
|
7308
7308
|
# @!parse
|
7309
7309
|
# # Within each billing cycle, specifies the cadence at which invoices are produced.
|
7310
|
-
# #
|
7310
|
+
# # If unspecified, a single invoice is produced per billing cycle.
|
7311
7311
|
# #
|
7312
7312
|
# # @param duration [Integer]
|
7313
7313
|
# # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration::DurationUnit]
|
@@ -7373,21 +7373,21 @@ module Orb
|
|
7373
7373
|
|
7374
7374
|
# @!attribute billable_metric_id
|
7375
7375
|
# The id of the billable metric for the price. Only needed if the price is
|
7376
|
-
#
|
7376
|
+
# usage-based.
|
7377
7377
|
#
|
7378
7378
|
# @return [String, nil]
|
7379
7379
|
optional :billable_metric_id, String, nil?: true
|
7380
7380
|
|
7381
7381
|
# @!attribute billed_in_advance
|
7382
7382
|
# If the Price represents a fixed cost, the price will be billed in-advance if
|
7383
|
-
#
|
7383
|
+
# this is true, and in-arrears if this is false.
|
7384
7384
|
#
|
7385
7385
|
# @return [Boolean, nil]
|
7386
7386
|
optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
|
7387
7387
|
|
7388
7388
|
# @!attribute billing_cycle_configuration
|
7389
7389
|
# For custom cadence: specifies the duration of the billing period in days or
|
7390
|
-
#
|
7390
|
+
# months.
|
7391
7391
|
#
|
7392
7392
|
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration, nil]
|
7393
7393
|
optional :billing_cycle_configuration,
|
@@ -7408,7 +7408,7 @@ module Orb
|
|
7408
7408
|
|
7409
7409
|
# @!attribute fixed_price_quantity
|
7410
7410
|
# If the Price represents a fixed cost, this represents the quantity of units
|
7411
|
-
#
|
7411
|
+
# applied.
|
7412
7412
|
#
|
7413
7413
|
# @return [Float, nil]
|
7414
7414
|
optional :fixed_price_quantity, Float, nil?: true
|
@@ -7421,7 +7421,7 @@ module Orb
|
|
7421
7421
|
|
7422
7422
|
# @!attribute invoicing_cycle_configuration
|
7423
7423
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
7424
|
-
#
|
7424
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
7425
7425
|
#
|
7426
7426
|
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration, nil]
|
7427
7427
|
optional :invoicing_cycle_configuration,
|
@@ -7430,8 +7430,8 @@ module Orb
|
|
7430
7430
|
|
7431
7431
|
# @!attribute metadata
|
7432
7432
|
# User-specified key/value pairs for the resource. Individual keys can be removed
|
7433
|
-
#
|
7434
|
-
#
|
7433
|
+
# by setting the value to `null`, and the entire metadata mapping can be cleared
|
7434
|
+
# by setting `metadata` to `null`.
|
7435
7435
|
#
|
7436
7436
|
# @return [Hash{Symbol=>String, nil}, nil]
|
7437
7437
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
@@ -7513,7 +7513,7 @@ module Orb
|
|
7513
7513
|
|
7514
7514
|
# @!parse
|
7515
7515
|
# # For custom cadence: specifies the duration of the billing period in days or
|
7516
|
-
# #
|
7516
|
+
# # months.
|
7517
7517
|
# #
|
7518
7518
|
# # @param duration [Integer]
|
7519
7519
|
# # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration::DurationUnit]
|
@@ -7556,7 +7556,7 @@ module Orb
|
|
7556
7556
|
|
7557
7557
|
# @!parse
|
7558
7558
|
# # Within each billing cycle, specifies the cadence at which invoices are produced.
|
7559
|
-
# #
|
7559
|
+
# # If unspecified, a single invoice is produced per billing cycle.
|
7560
7560
|
# #
|
7561
7561
|
# # @param duration [Integer]
|
7562
7562
|
# # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration::DurationUnit]
|
@@ -7622,21 +7622,21 @@ module Orb
|
|
7622
7622
|
|
7623
7623
|
# @!attribute billable_metric_id
|
7624
7624
|
# The id of the billable metric for the price. Only needed if the price is
|
7625
|
-
#
|
7625
|
+
# usage-based.
|
7626
7626
|
#
|
7627
7627
|
# @return [String, nil]
|
7628
7628
|
optional :billable_metric_id, String, nil?: true
|
7629
7629
|
|
7630
7630
|
# @!attribute billed_in_advance
|
7631
7631
|
# If the Price represents a fixed cost, the price will be billed in-advance if
|
7632
|
-
#
|
7632
|
+
# this is true, and in-arrears if this is false.
|
7633
7633
|
#
|
7634
7634
|
# @return [Boolean, nil]
|
7635
7635
|
optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
|
7636
7636
|
|
7637
7637
|
# @!attribute billing_cycle_configuration
|
7638
7638
|
# For custom cadence: specifies the duration of the billing period in days or
|
7639
|
-
#
|
7639
|
+
# months.
|
7640
7640
|
#
|
7641
7641
|
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingCumulativeGroupedBulkPrice::BillingCycleConfiguration, nil]
|
7642
7642
|
optional :billing_cycle_configuration,
|
@@ -7657,7 +7657,7 @@ module Orb
|
|
7657
7657
|
|
7658
7658
|
# @!attribute fixed_price_quantity
|
7659
7659
|
# If the Price represents a fixed cost, this represents the quantity of units
|
7660
|
-
#
|
7660
|
+
# applied.
|
7661
7661
|
#
|
7662
7662
|
# @return [Float, nil]
|
7663
7663
|
optional :fixed_price_quantity, Float, nil?: true
|
@@ -7670,7 +7670,7 @@ module Orb
|
|
7670
7670
|
|
7671
7671
|
# @!attribute invoicing_cycle_configuration
|
7672
7672
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
7673
|
-
#
|
7673
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
7674
7674
|
#
|
7675
7675
|
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingCumulativeGroupedBulkPrice::InvoicingCycleConfiguration, nil]
|
7676
7676
|
optional :invoicing_cycle_configuration,
|
@@ -7679,8 +7679,8 @@ module Orb
|
|
7679
7679
|
|
7680
7680
|
# @!attribute metadata
|
7681
7681
|
# User-specified key/value pairs for the resource. Individual keys can be removed
|
7682
|
-
#
|
7683
|
-
#
|
7682
|
+
# by setting the value to `null`, and the entire metadata mapping can be cleared
|
7683
|
+
# by setting `metadata` to `null`.
|
7684
7684
|
#
|
7685
7685
|
# @return [Hash{Symbol=>String, nil}, nil]
|
7686
7686
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
@@ -7762,7 +7762,7 @@ module Orb
|
|
7762
7762
|
|
7763
7763
|
# @!parse
|
7764
7764
|
# # For custom cadence: specifies the duration of the billing period in days or
|
7765
|
-
# #
|
7765
|
+
# # months.
|
7766
7766
|
# #
|
7767
7767
|
# # @param duration [Integer]
|
7768
7768
|
# # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingCumulativeGroupedBulkPrice::BillingCycleConfiguration::DurationUnit]
|
@@ -7805,7 +7805,7 @@ module Orb
|
|
7805
7805
|
|
7806
7806
|
# @!parse
|
7807
7807
|
# # Within each billing cycle, specifies the cadence at which invoices are produced.
|
7808
|
-
# #
|
7808
|
+
# # If unspecified, a single invoice is produced per billing cycle.
|
7809
7809
|
# #
|
7810
7810
|
# # @param duration [Integer]
|
7811
7811
|
# # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingCumulativeGroupedBulkPrice::InvoicingCycleConfiguration::DurationUnit]
|
@@ -7848,9 +7848,9 @@ module Orb
|
|
7848
7848
|
|
7849
7849
|
# @!attribute start_date
|
7850
7850
|
# The start date of the adjustment interval. This is the date that the adjustment
|
7851
|
-
#
|
7852
|
-
#
|
7853
|
-
#
|
7851
|
+
# will start affecting prices on the subscription. The adjustment will apply to
|
7852
|
+
# invoice dates that overlap with this `start_date`. This `start_date` is treated
|
7853
|
+
# as inclusive for in-advance prices, and exclusive for in-arrears prices.
|
7854
7854
|
#
|
7855
7855
|
# @return [Time, Symbol, Orb::Models::BillingCycleRelativeDate]
|
7856
7856
|
required :start_date,
|
@@ -7858,9 +7858,9 @@ module Orb
|
|
7858
7858
|
|
7859
7859
|
# @!attribute end_date
|
7860
7860
|
# The end date of the adjustment interval. This is the date that the adjustment
|
7861
|
-
#
|
7862
|
-
#
|
7863
|
-
#
|
7861
|
+
# will stop affecting prices on the subscription. The adjustment will apply to
|
7862
|
+
# invoice dates that overlap with this `end_date`.This `end_date` is treated as
|
7863
|
+
# exclusive for in-advance prices, and inclusive for in-arrears prices.
|
7864
7864
|
#
|
7865
7865
|
# @return [Time, Symbol, Orb::Models::BillingCycleRelativeDate, nil]
|
7866
7866
|
optional :end_date,
|
@@ -7918,7 +7918,7 @@ module Orb
|
|
7918
7918
|
|
7919
7919
|
# @!attribute [r] is_invoice_level
|
7920
7920
|
# When false, this adjustment will be applied to a single price. Otherwise, it
|
7921
|
-
#
|
7921
|
+
# will be applied at the invoice level, possibly to multiple prices.
|
7922
7922
|
#
|
7923
7923
|
# @return [Boolean, nil]
|
7924
7924
|
optional :is_invoice_level, Orb::Internal::Type::Boolean
|
@@ -7965,7 +7965,7 @@ module Orb
|
|
7965
7965
|
|
7966
7966
|
# @!attribute [r] is_invoice_level
|
7967
7967
|
# When false, this adjustment will be applied to a single price. Otherwise, it
|
7968
|
-
#
|
7968
|
+
# will be applied at the invoice level, possibly to multiple prices.
|
7969
7969
|
#
|
7970
7970
|
# @return [Boolean, nil]
|
7971
7971
|
optional :is_invoice_level, Orb::Internal::Type::Boolean
|
@@ -8004,7 +8004,7 @@ module Orb
|
|
8004
8004
|
|
8005
8005
|
# @!attribute [r] is_invoice_level
|
8006
8006
|
# When false, this adjustment will be applied to a single price. Otherwise, it
|
8007
|
-
#
|
8007
|
+
# will be applied at the invoice level, possibly to multiple prices.
|
8008
8008
|
#
|
8009
8009
|
# @return [Boolean, nil]
|
8010
8010
|
optional :is_invoice_level, Orb::Internal::Type::Boolean
|
@@ -8049,7 +8049,7 @@ module Orb
|
|
8049
8049
|
|
8050
8050
|
# @!attribute [r] is_invoice_level
|
8051
8051
|
# When false, this adjustment will be applied to a single price. Otherwise, it
|
8052
|
-
#
|
8052
|
+
# will be applied at the invoice level, possibly to multiple prices.
|
8053
8053
|
#
|
8054
8054
|
# @return [Boolean, nil]
|
8055
8055
|
optional :is_invoice_level, Orb::Internal::Type::Boolean
|
@@ -8089,7 +8089,7 @@ module Orb
|
|
8089
8089
|
|
8090
8090
|
# @!attribute [r] is_invoice_level
|
8091
8091
|
# When false, this adjustment will be applied to a single price. Otherwise, it
|
8092
|
-
#
|
8092
|
+
# will be applied at the invoice level, possibly to multiple prices.
|
8093
8093
|
#
|
8094
8094
|
# @return [Boolean, nil]
|
8095
8095
|
optional :is_invoice_level, Orb::Internal::Type::Boolean
|
@@ -8115,9 +8115,9 @@ module Orb
|
|
8115
8115
|
end
|
8116
8116
|
|
8117
8117
|
# The start date of the adjustment interval. This is the date that the adjustment
|
8118
|
-
#
|
8119
|
-
#
|
8120
|
-
#
|
8118
|
+
# will start affecting prices on the subscription. The adjustment will apply to
|
8119
|
+
# invoice dates that overlap with this `start_date`. This `start_date` is treated
|
8120
|
+
# as inclusive for in-advance prices, and exclusive for in-arrears prices.
|
8121
8121
|
#
|
8122
8122
|
# @see Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment#start_date
|
8123
8123
|
module StartDate
|
@@ -8133,9 +8133,9 @@ module Orb
|
|
8133
8133
|
end
|
8134
8134
|
|
8135
8135
|
# The end date of the adjustment interval. This is the date that the adjustment
|
8136
|
-
#
|
8137
|
-
#
|
8138
|
-
#
|
8136
|
+
# will stop affecting prices on the subscription. The adjustment will apply to
|
8137
|
+
# invoice dates that overlap with this `end_date`.This `end_date` is treated as
|
8138
|
+
# exclusive for in-advance prices, and inclusive for in-arrears prices.
|
8139
8139
|
#
|
8140
8140
|
# @see Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment#end_date
|
8141
8141
|
module EndDate
|
@@ -8160,32 +8160,32 @@ module Orb
|
|
8160
8160
|
|
8161
8161
|
# @!attribute billing_cycle_day
|
8162
8162
|
# The updated billing cycle day for this price interval. If not specified, the
|
8163
|
-
#
|
8164
|
-
#
|
8163
|
+
# billing cycle day will not be updated. Note that overlapping price intervals
|
8164
|
+
# must have the same billing cycle day.
|
8165
8165
|
#
|
8166
8166
|
# @return [Integer, nil]
|
8167
8167
|
optional :billing_cycle_day, Integer, nil?: true
|
8168
8168
|
|
8169
8169
|
# @!attribute end_date
|
8170
8170
|
# The updated end date of this price interval. If not specified, the start date
|
8171
|
-
#
|
8171
|
+
# will not be updated.
|
8172
8172
|
#
|
8173
8173
|
# @return [Time, Symbol, Orb::Models::BillingCycleRelativeDate, nil]
|
8174
8174
|
optional :end_date, union: -> { Orb::Models::SubscriptionPriceIntervalsParams::Edit::EndDate }, nil?: true
|
8175
8175
|
|
8176
8176
|
# @!attribute filter
|
8177
8177
|
# An additional filter to apply to usage queries. This filter must be expressed as
|
8178
|
-
#
|
8179
|
-
#
|
8180
|
-
#
|
8178
|
+
# a boolean
|
8179
|
+
# [computed property](/extensibility/advanced-metrics#computed-properties). If
|
8180
|
+
# null, usage queries will not include any additional filter.
|
8181
8181
|
#
|
8182
8182
|
# @return [String, nil]
|
8183
8183
|
optional :filter, String, nil?: true
|
8184
8184
|
|
8185
8185
|
# @!attribute fixed_fee_quantity_transitions
|
8186
8186
|
# A list of fixed fee quantity transitions to use for this price interval. Note
|
8187
|
-
#
|
8188
|
-
#
|
8187
|
+
# that this list will overwrite all existing fixed fee quantity transitions on the
|
8188
|
+
# price interval.
|
8189
8189
|
#
|
8190
8190
|
# @return [Array<Orb::Models::SubscriptionPriceIntervalsParams::Edit::FixedFeeQuantityTransition>, nil]
|
8191
8191
|
optional :fixed_fee_quantity_transitions,
|
@@ -8194,7 +8194,7 @@ module Orb
|
|
8194
8194
|
|
8195
8195
|
# @!attribute [r] start_date
|
8196
8196
|
# The updated start date of this price interval. If not specified, the start date
|
8197
|
-
#
|
8197
|
+
# will not be updated.
|
8198
8198
|
#
|
8199
8199
|
# @return [Time, Symbol, Orb::Models::BillingCycleRelativeDate, nil]
|
8200
8200
|
optional :start_date, union: -> { Orb::Models::SubscriptionPriceIntervalsParams::Edit::StartDate }
|
@@ -8205,11 +8205,11 @@ module Orb
|
|
8205
8205
|
|
8206
8206
|
# @!attribute usage_customer_ids
|
8207
8207
|
# A list of customer IDs whose usage events will be aggregated and billed under
|
8208
|
-
#
|
8209
|
-
#
|
8210
|
-
#
|
8211
|
-
#
|
8212
|
-
#
|
8208
|
+
# this subscription. By default, a subscription only considers usage events
|
8209
|
+
# associated with its attached customer's customer_id. When usage_customer_ids is
|
8210
|
+
# provided, the subscription includes usage events from the specified customers
|
8211
|
+
# only. Provided usage_customer_ids must be either the customer for this
|
8212
|
+
# subscription itself, or any of that customer's children.
|
8213
8213
|
#
|
8214
8214
|
# @return [Array<String>, nil]
|
8215
8215
|
optional :usage_customer_ids, Orb::Internal::Type::ArrayOf[String], nil?: true
|
@@ -8239,7 +8239,7 @@ module Orb
|
|
8239
8239
|
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
8240
8240
|
|
8241
8241
|
# The updated end date of this price interval. If not specified, the start date
|
8242
|
-
#
|
8242
|
+
# will not be updated.
|
8243
8243
|
#
|
8244
8244
|
# @see Orb::Models::SubscriptionPriceIntervalsParams::Edit#end_date
|
8245
8245
|
module EndDate
|
@@ -8277,7 +8277,7 @@ module Orb
|
|
8277
8277
|
end
|
8278
8278
|
|
8279
8279
|
# The updated start date of this price interval. If not specified, the start date
|
8280
|
-
#
|
8280
|
+
# will not be updated.
|
8281
8281
|
#
|
8282
8282
|
# @see Orb::Models::SubscriptionPriceIntervalsParams::Edit#start_date
|
8283
8283
|
module StartDate
|
@@ -8302,7 +8302,7 @@ module Orb
|
|
8302
8302
|
|
8303
8303
|
# @!attribute end_date
|
8304
8304
|
# The updated end date of this adjustment interval. If not specified, the start
|
8305
|
-
#
|
8305
|
+
# date will not be updated.
|
8306
8306
|
#
|
8307
8307
|
# @return [Time, Symbol, Orb::Models::BillingCycleRelativeDate, nil]
|
8308
8308
|
optional :end_date,
|
@@ -8311,7 +8311,7 @@ module Orb
|
|
8311
8311
|
|
8312
8312
|
# @!attribute [r] start_date
|
8313
8313
|
# The updated start date of this adjustment interval. If not specified, the start
|
8314
|
-
#
|
8314
|
+
# date will not be updated.
|
8315
8315
|
#
|
8316
8316
|
# @return [Time, Symbol, Orb::Models::BillingCycleRelativeDate, nil]
|
8317
8317
|
optional :start_date,
|
@@ -8331,7 +8331,7 @@ module Orb
|
|
8331
8331
|
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
8332
8332
|
|
8333
8333
|
# The updated end date of this adjustment interval. If not specified, the start
|
8334
|
-
#
|
8334
|
+
# date will not be updated.
|
8335
8335
|
#
|
8336
8336
|
# @see Orb::Models::SubscriptionPriceIntervalsParams::EditAdjustment#end_date
|
8337
8337
|
module EndDate
|
@@ -8347,7 +8347,7 @@ module Orb
|
|
8347
8347
|
end
|
8348
8348
|
|
8349
8349
|
# The updated start date of this adjustment interval. If not specified, the start
|
8350
|
-
#
|
8350
|
+
# date will not be updated.
|
8351
8351
|
#
|
8352
8352
|
# @see Orb::Models::SubscriptionPriceIntervalsParams::EditAdjustment#start_date
|
8353
8353
|
module StartDate
|