orb-billing 0.5.1 → 0.5.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +26 -0
- data/README.md +4 -4
- data/SECURITY.md +2 -2
- data/lib/orb/internal/type/array_of.rb +8 -0
- data/lib/orb/internal/type/base_model.rb +7 -0
- data/lib/orb/internal/type/boolean.rb +8 -0
- data/lib/orb/internal/type/enum.rb +12 -0
- data/lib/orb/internal/type/file_input.rb +7 -0
- data/lib/orb/internal/type/hash_of.rb +8 -0
- data/lib/orb/internal/type/union.rb +12 -0
- data/lib/orb/internal/type/unknown.rb +8 -0
- data/lib/orb/internal/util.rb +45 -0
- data/lib/orb/internal.rb +3 -0
- data/lib/orb/models/alert.rb +23 -23
- data/lib/orb/models/alert_create_for_customer_params.rb +5 -5
- data/lib/orb/models/alert_create_for_external_customer_params.rb +5 -5
- data/lib/orb/models/alert_create_for_subscription_params.rb +5 -5
- data/lib/orb/models/alert_update_params.rb +3 -3
- data/lib/orb/models/amount_discount.rb +5 -5
- data/lib/orb/models/billable_metric.rb +7 -7
- data/lib/orb/models/coupon.rb +6 -10
- data/lib/orb/models/coupon_create_params.rb +3 -9
- data/lib/orb/models/credit_note.rb +33 -33
- data/lib/orb/models/credit_note_create_params.rb +4 -4
- data/lib/orb/models/customer.rb +39 -39
- data/lib/orb/models/customer_create_params.rb +26 -35
- data/lib/orb/models/customer_update_by_external_id_params.rb +26 -35
- data/lib/orb/models/customer_update_params.rb +26 -35
- data/lib/orb/models/customers/balance_transaction_create_params.rb +2 -2
- data/lib/orb/models/customers/cost_list_by_external_id_params.rb +2 -2
- data/lib/orb/models/customers/cost_list_by_external_id_response.rb +2 -2
- data/lib/orb/models/customers/cost_list_params.rb +2 -2
- data/lib/orb/models/customers/cost_list_response.rb +2 -2
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +7 -7
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +0 -14
- data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +8 -8
- data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +0 -14
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +4 -4
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +0 -14
- data/lib/orb/models/customers/credits/ledger_list_params.rb +4 -4
- data/lib/orb/models/customers/credits/ledger_list_response.rb +0 -14
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +6 -6
- data/lib/orb/models/customers/credits/top_up_create_params.rb +6 -5
- data/lib/orb/models/dimensional_price_group.rb +1 -1
- data/lib/orb/models/dimensional_price_groups.rb +4 -4
- data/lib/orb/models/discount.rb +1 -7
- data/lib/orb/models/evaluate_price_group.rb +0 -4
- data/lib/orb/models/event_ingest_params.rb +3 -3
- data/lib/orb/models/events/event_volumes.rb +2 -2
- data/lib/orb/models/invoice.rb +114 -135
- data/lib/orb/models/invoice_create_params.rb +10 -10
- data/lib/orb/models/invoice_fetch_upcoming_response.rb +6 -28
- data/lib/orb/models/invoice_level_discount.rb +1 -5
- data/lib/orb/models/invoice_line_item_create_response.rb +4 -26
- data/lib/orb/models/invoice_list_params.rb +4 -4
- data/lib/orb/models/item.rb +5 -5
- data/lib/orb/models/item_update_params.rb +5 -5
- data/lib/orb/models/percentage_discount.rb +5 -5
- data/lib/orb/models/plan.rb +58 -70
- data/lib/orb/models/plan_create_params.rb +448 -476
- data/lib/orb/models/plan_list_params.rb +2 -2
- data/lib/orb/models/price.rb +1204 -1239
- data/lib/orb/models/price_create_params.rb +50 -50
- data/lib/orb/models/price_evaluate_response.rb +2 -2
- data/lib/orb/models/subscription.rb +58 -78
- data/lib/orb/models/subscription_cancel_params.rb +2 -2
- data/lib/orb/models/subscription_cancel_response.rb +14 -36
- data/lib/orb/models/subscription_change_apply_response.rb +14 -36
- data/lib/orb/models/subscription_change_cancel_response.rb +14 -36
- data/lib/orb/models/subscription_change_retrieve_response.rb +14 -36
- data/lib/orb/models/subscription_create_params.rb +1002 -1075
- data/lib/orb/models/subscription_create_response.rb +14 -36
- data/lib/orb/models/subscription_fetch_costs_params.rb +2 -2
- data/lib/orb/models/subscription_fetch_costs_response.rb +2 -2
- data/lib/orb/models/subscription_fetch_usage_params.rb +4 -4
- data/lib/orb/models/subscription_list_params.rb +2 -2
- data/lib/orb/models/subscription_price_intervals_params.rb +596 -674
- data/lib/orb/models/subscription_price_intervals_response.rb +14 -36
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +973 -1059
- data/lib/orb/models/subscription_schedule_plan_change_response.rb +14 -36
- data/lib/orb/models/subscription_trigger_phase_response.rb +14 -36
- data/lib/orb/models/subscription_unschedule_cancellation_response.rb +14 -36
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +14 -36
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +14 -36
- data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +2 -2
- data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +14 -36
- data/lib/orb/models/subscription_update_trial_params.rb +3 -3
- data/lib/orb/models/subscription_update_trial_response.rb +14 -36
- data/lib/orb/models/subscription_usage.rb +26 -35
- data/lib/orb/models/subscriptions.rb +4 -4
- data/lib/orb/models/trial_discount.rb +5 -5
- data/lib/orb/models/usage_discount.rb +5 -5
- data/lib/orb/models.rb +30 -16
- data/lib/orb/resources/alerts.rb +15 -15
- data/lib/orb/resources/coupons/subscriptions.rb +1 -1
- data/lib/orb/resources/coupons.rb +5 -5
- data/lib/orb/resources/credit_notes.rb +5 -5
- data/lib/orb/resources/customers/balance_transactions.rb +1 -1
- data/lib/orb/resources/customers/costs.rb +2 -2
- data/lib/orb/resources/customers/credits/ledger.rb +10 -10
- data/lib/orb/resources/customers/credits/top_ups.rb +4 -4
- data/lib/orb/resources/customers.rb +30 -30
- data/lib/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rb +1 -1
- data/lib/orb/resources/dimensional_price_groups.rb +3 -3
- data/lib/orb/resources/events/volume.rb +1 -1
- data/lib/orb/resources/events.rb +1 -1
- data/lib/orb/resources/invoices.rb +12 -12
- data/lib/orb/resources/items.rb +5 -5
- data/lib/orb/resources/metrics.rb +4 -4
- data/lib/orb/resources/plans/external_plan_id.rb +2 -2
- data/lib/orb/resources/plans.rb +7 -7
- data/lib/orb/resources/prices/external_price_id.rb +2 -2
- data/lib/orb/resources/prices.rb +17 -17
- data/lib/orb/resources/subscriptions.rb +32 -32
- data/lib/orb/version.rb +1 -1
- data/rbi/orb/internal/type/array_of.rbi +6 -0
- data/rbi/orb/internal/type/base_model.rbi +5 -0
- data/rbi/orb/internal/type/boolean.rbi +6 -0
- data/rbi/orb/internal/type/enum.rbi +5 -0
- data/rbi/orb/internal/type/file_input.rbi +5 -0
- data/rbi/orb/internal/type/hash_of.rbi +6 -0
- data/rbi/orb/internal/type/union.rbi +5 -0
- data/rbi/orb/internal/type/unknown.rbi +6 -0
- data/rbi/orb/internal/util.rbi +30 -0
- data/rbi/orb/internal.rbi +3 -0
- data/rbi/orb/models/coupon.rbi +2 -2
- data/rbi/orb/models/customers/cost_list_by_external_id_response.rbi +2 -65
- data/rbi/orb/models/customers/cost_list_response.rbi +2 -65
- data/rbi/orb/models/evaluate_price_group.rbi +7 -3
- data/rbi/orb/models/invoice.rbi +10 -149
- data/rbi/orb/models/invoice_fetch_upcoming_response.rbi +10 -133
- data/rbi/orb/models/invoice_line_item_create_response.rbi +8 -114
- data/rbi/orb/models/plan.rbi +8 -134
- data/rbi/orb/models/price.rbi +56 -588
- data/rbi/orb/models/subscription.rbi +6 -99
- data/rbi/orb/models/subscription_cancel_response.rbi +6 -89
- data/rbi/orb/models/subscription_change_apply_response.rbi +6 -89
- data/rbi/orb/models/subscription_change_cancel_response.rbi +6 -89
- data/rbi/orb/models/subscription_change_retrieve_response.rbi +6 -89
- data/rbi/orb/models/subscription_create_response.rbi +6 -89
- data/rbi/orb/models/subscription_fetch_costs_response.rbi +2 -65
- data/rbi/orb/models/subscription_price_intervals_response.rbi +6 -89
- data/rbi/orb/models/subscription_schedule_plan_change_response.rbi +6 -89
- data/rbi/orb/models/subscription_trigger_phase_response.rbi +6 -89
- data/rbi/orb/models/subscription_unschedule_cancellation_response.rbi +6 -89
- data/rbi/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +6 -89
- data/rbi/orb/models/subscription_unschedule_pending_plan_changes_response.rbi +6 -89
- data/rbi/orb/models/subscription_update_fixed_fee_quantity_response.rbi +6 -89
- data/rbi/orb/models/subscription_update_trial_response.rbi +6 -89
- data/rbi/orb/resources/customers/credits/ledger.rbi +4 -36
- data/rbi/orb/resources/prices/external_price_id.rbi +2 -64
- data/rbi/orb/resources/prices.rbi +4 -130
- data/rbi/orb/resources/subscriptions.rbi +1 -6
- data/sig/orb/internal/page.rbs +2 -0
- data/sig/orb/internal/type/array_of.rbs +3 -0
- data/sig/orb/internal/type/base_model.rbs +2 -0
- data/sig/orb/internal/type/boolean.rbs +3 -0
- data/sig/orb/internal/type/enum.rbs +2 -0
- data/sig/orb/internal/type/file_input.rbs +2 -0
- data/sig/orb/internal/type/hash_of.rbs +3 -0
- data/sig/orb/internal/type/union.rbs +2 -0
- data/sig/orb/internal/type/unknown.rbs +3 -0
- data/sig/orb/internal/util.rbs +12 -0
- data/sig/orb/internal.rbs +2 -0
- data/sig/orb/models/alert.rbs +32 -4
- data/sig/orb/models/alert_create_for_customer_params.rbs +9 -0
- data/sig/orb/models/alert_create_for_external_customer_params.rbs +9 -0
- data/sig/orb/models/alert_create_for_subscription_params.rbs +9 -0
- data/sig/orb/models/alert_disable_params.rbs +5 -0
- data/sig/orb/models/alert_enable_params.rbs +5 -0
- data/sig/orb/models/alert_list_params.rbs +13 -0
- data/sig/orb/models/alert_retrieve_params.rbs +2 -0
- data/sig/orb/models/alert_update_params.rbs +7 -0
- data/sig/orb/models/amount_discount.rbs +11 -4
- data/sig/orb/models/billable_metric.rbs +13 -4
- data/sig/orb/models/coupon.rbs +14 -4
- data/sig/orb/models/coupon_archive_params.rbs +2 -0
- data/sig/orb/models/coupon_create_params.rbs +15 -0
- data/sig/orb/models/coupon_fetch_params.rbs +2 -0
- data/sig/orb/models/coupon_list_params.rbs +8 -0
- data/sig/orb/models/coupons/subscription_list_params.rbs +6 -0
- data/sig/orb/models/credit_note.rbs +88 -20
- data/sig/orb/models/credit_note_create_params.rbs +9 -0
- data/sig/orb/models/credit_note_fetch_params.rbs +2 -0
- data/sig/orb/models/credit_note_list_params.rbs +10 -0
- data/sig/orb/models/customer.rbs +86 -16
- data/sig/orb/models/customer_create_params.rbs +79 -8
- data/sig/orb/models/customer_delete_params.rbs +2 -0
- data/sig/orb/models/customer_fetch_by_external_id_params.rbs +2 -0
- data/sig/orb/models/customer_fetch_params.rbs +2 -0
- data/sig/orb/models/customer_list_params.rbs +10 -0
- data/sig/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbs +2 -0
- data/sig/orb/models/customer_sync_payment_methods_from_gateway_params.rbs +2 -0
- data/sig/orb/models/customer_update_by_external_id_params.rbs +78 -8
- data/sig/orb/models/customer_update_params.rbs +78 -8
- data/sig/orb/models/customers/balance_transaction_create_params.rbs +7 -0
- data/sig/orb/models/customers/balance_transaction_create_response.rbs +17 -0
- data/sig/orb/models/customers/balance_transaction_list_params.rbs +10 -0
- data/sig/orb/models/customers/balance_transaction_list_response.rbs +17 -0
- data/sig/orb/models/customers/cost_list_by_external_id_params.rbs +8 -0
- data/sig/orb/models/customers/cost_list_by_external_id_response.rbs +20 -0
- data/sig/orb/models/customers/cost_list_params.rbs +8 -0
- data/sig/orb/models/customers/cost_list_response.rbs +20 -0
- data/sig/orb/models/customers/credit_list_by_external_id_params.rbs +8 -0
- data/sig/orb/models/customers/credit_list_by_external_id_response.rbs +10 -0
- data/sig/orb/models/customers/credit_list_params.rbs +8 -0
- data/sig/orb/models/customers/credit_list_response.rbs +10 -0
- data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbs +23 -0
- data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbs +177 -0
- data/sig/orb/models/customers/credits/ledger_create_entry_params.rbs +23 -0
- data/sig/orb/models/customers/credits/ledger_create_entry_response.rbs +177 -0
- data/sig/orb/models/customers/credits/ledger_list_by_external_id_params.rbs +14 -0
- data/sig/orb/models/customers/credits/ledger_list_by_external_id_response.rbs +177 -0
- data/sig/orb/models/customers/credits/ledger_list_params.rbs +14 -0
- data/sig/orb/models/customers/credits/ledger_list_response.rbs +177 -0
- data/sig/orb/models/customers/credits/top_up_create_by_external_id_params.rbs +19 -0
- data/sig/orb/models/customers/credits/top_up_create_by_external_id_response.rbs +18 -0
- data/sig/orb/models/customers/credits/top_up_create_params.rbs +19 -0
- data/sig/orb/models/customers/credits/top_up_create_response.rbs +18 -0
- data/sig/orb/models/customers/credits/top_up_delete_by_external_id_params.rbs +5 -0
- data/sig/orb/models/customers/credits/top_up_delete_params.rbs +5 -0
- data/sig/orb/models/customers/credits/top_up_list_by_external_id_params.rbs +6 -0
- data/sig/orb/models/customers/credits/top_up_list_by_external_id_response.rbs +18 -0
- data/sig/orb/models/customers/credits/top_up_list_params.rbs +6 -0
- data/sig/orb/models/customers/credits/top_up_list_response.rbs +18 -0
- data/sig/orb/models/dimensional_price_group.rbs +9 -0
- data/sig/orb/models/dimensional_price_group_create_params.rbs +9 -0
- data/sig/orb/models/dimensional_price_group_list_params.rbs +6 -0
- data/sig/orb/models/dimensional_price_group_retrieve_params.rbs +2 -0
- data/sig/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbs +2 -0
- data/sig/orb/models/dimensional_price_groups.rbs +5 -0
- data/sig/orb/models/evaluate_price_group.rbs +10 -4
- data/sig/orb/models/event_deprecate_params.rbs +2 -0
- data/sig/orb/models/event_deprecate_response.rbs +2 -0
- data/sig/orb/models/event_ingest_params.rbs +16 -0
- data/sig/orb/models/event_ingest_response.rbs +15 -0
- data/sig/orb/models/event_search_params.rbs +7 -0
- data/sig/orb/models/event_search_response.rbs +12 -0
- data/sig/orb/models/event_update_params.rbs +9 -0
- data/sig/orb/models/event_update_response.rbs +2 -0
- data/sig/orb/models/events/backfill_close_params.rbs +2 -0
- data/sig/orb/models/events/backfill_close_response.rbs +14 -0
- data/sig/orb/models/events/backfill_create_params.rbs +11 -0
- data/sig/orb/models/events/backfill_create_response.rbs +14 -0
- data/sig/orb/models/events/backfill_fetch_params.rbs +2 -0
- data/sig/orb/models/events/backfill_fetch_response.rbs +14 -0
- data/sig/orb/models/events/backfill_list_params.rbs +6 -0
- data/sig/orb/models/events/backfill_list_response.rbs +14 -0
- data/sig/orb/models/events/backfill_revert_params.rbs +2 -0
- data/sig/orb/models/events/backfill_revert_response.rbs +14 -0
- data/sig/orb/models/events/event_volumes.rbs +8 -0
- data/sig/orb/models/events/volume_list_params.rbs +8 -0
- data/sig/orb/models/invoice.rbs +293 -36
- data/sig/orb/models/invoice_create_params.rbs +30 -4
- data/sig/orb/models/invoice_fetch_params.rbs +2 -0
- data/sig/orb/models/invoice_fetch_upcoming_params.rbs +5 -0
- data/sig/orb/models/invoice_fetch_upcoming_response.rbs +257 -0
- data/sig/orb/models/invoice_issue_params.rbs +5 -0
- data/sig/orb/models/invoice_line_item_create_params.rbs +10 -0
- data/sig/orb/models/invoice_line_item_create_response.rbs +132 -0
- data/sig/orb/models/invoice_list_params.rbs +27 -4
- data/sig/orb/models/invoice_mark_paid_params.rbs +7 -0
- data/sig/orb/models/invoice_pay_params.rbs +2 -0
- data/sig/orb/models/invoice_update_params.rbs +5 -0
- data/sig/orb/models/invoice_void_params.rbs +2 -0
- data/sig/orb/models/item.rbs +16 -4
- data/sig/orb/models/item_create_params.rbs +2 -0
- data/sig/orb/models/item_fetch_params.rbs +2 -0
- data/sig/orb/models/item_list_params.rbs +6 -0
- data/sig/orb/models/item_update_params.rbs +15 -4
- data/sig/orb/models/metric_create_params.rbs +9 -0
- data/sig/orb/models/metric_fetch_params.rbs +2 -0
- data/sig/orb/models/metric_list_params.rbs +10 -0
- data/sig/orb/models/metric_update_params.rbs +5 -0
- data/sig/orb/models/pagination_metadata.rbs +2 -0
- data/sig/orb/models/percentage_discount.rbs +11 -4
- data/sig/orb/models/plan.rbs +141 -16
- data/sig/orb/models/plan_create_params.rbs +1070 -304
- data/sig/orb/models/plan_fetch_params.rbs +2 -0
- data/sig/orb/models/plan_list_params.rbs +11 -0
- data/sig/orb/models/plan_update_params.rbs +6 -0
- data/sig/orb/models/plans/external_plan_id_fetch_params.rbs +2 -0
- data/sig/orb/models/plans/external_plan_id_update_params.rbs +6 -0
- data/sig/orb/models/price.rbs +2148 -460
- data/sig/orb/models/price_create_params.rbs +130 -8
- data/sig/orb/models/price_evaluate_params.rbs +10 -0
- data/sig/orb/models/price_evaluate_response.rbs +2 -0
- data/sig/orb/models/price_fetch_params.rbs +2 -0
- data/sig/orb/models/price_list_params.rbs +6 -0
- data/sig/orb/models/price_update_params.rbs +5 -0
- data/sig/orb/models/prices/external_price_id_fetch_params.rbs +2 -0
- data/sig/orb/models/prices/external_price_id_update_params.rbs +5 -0
- data/sig/orb/models/subscription.rbs +177 -12
- data/sig/orb/models/subscription_cancel_params.rbs +7 -0
- data/sig/orb/models/subscription_cancel_response.rbs +173 -0
- data/sig/orb/models/subscription_change_apply_params.rbs +6 -0
- data/sig/orb/models/subscription_change_apply_response.rbs +186 -0
- data/sig/orb/models/subscription_change_cancel_params.rbs +2 -0
- data/sig/orb/models/subscription_change_cancel_response.rbs +186 -0
- data/sig/orb/models/subscription_change_retrieve_params.rbs +2 -0
- data/sig/orb/models/subscription_change_retrieve_response.rbs +186 -0
- data/sig/orb/models/subscription_create_params.rbs +2368 -632
- data/sig/orb/models/subscription_create_response.rbs +173 -0
- data/sig/orb/models/subscription_fetch_costs_params.rbs +8 -0
- data/sig/orb/models/subscription_fetch_costs_response.rbs +20 -0
- data/sig/orb/models/subscription_fetch_params.rbs +2 -0
- data/sig/orb/models/subscription_fetch_schedule_params.rbs +10 -0
- data/sig/orb/models/subscription_fetch_schedule_response.rbs +13 -0
- data/sig/orb/models/subscription_fetch_usage_params.rbs +14 -0
- data/sig/orb/models/subscription_list_params.rbs +13 -0
- data/sig/orb/models/subscription_price_intervals_params.rbs +1348 -396
- data/sig/orb/models/subscription_price_intervals_response.rbs +173 -0
- data/sig/orb/models/subscription_schedule_plan_change_params.rbs +2363 -632
- data/sig/orb/models/subscription_schedule_plan_change_response.rbs +173 -0
- data/sig/orb/models/subscription_trigger_phase_params.rbs +6 -0
- data/sig/orb/models/subscription_trigger_phase_response.rbs +173 -0
- data/sig/orb/models/subscription_unschedule_cancellation_params.rbs +2 -0
- data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +173 -0
- data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbs +2 -0
- data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +173 -0
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_params.rbs +2 -0
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +173 -0
- data/sig/orb/models/subscription_update_fixed_fee_quantity_params.rbs +9 -0
- data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +173 -0
- data/sig/orb/models/subscription_update_params.rbs +9 -0
- data/sig/orb/models/subscription_update_trial_params.rbs +6 -0
- data/sig/orb/models/subscription_update_trial_response.rbs +173 -0
- data/sig/orb/models/subscription_usage.rbs +48 -8
- data/sig/orb/models/subscriptions.rbs +5 -0
- data/sig/orb/models/top_level_ping_params.rbs +2 -0
- data/sig/orb/models/top_level_ping_response.rbs +2 -0
- data/sig/orb/models/trial_discount.rbs +12 -4
- data/sig/orb/models/usage_discount.rbs +11 -4
- data/sig/orb/resources/invoices.rbs +1 -1
- data/sig/orb/resources/plans.rbs +1 -1
- metadata +2 -2
data/lib/orb/models/plan.rb
CHANGED
@@ -13,12 +13,12 @@ module Orb
|
|
13
13
|
# Adjustments for this plan. If the plan has phases, this includes adjustments
|
14
14
|
# across all phases of the plan.
|
15
15
|
#
|
16
|
-
# @return [Array<Orb::Plan::Adjustment::UsageDiscount, Orb::Plan::Adjustment::AmountDiscount, Orb::Plan::Adjustment::PercentageDiscount, Orb::Plan::Adjustment::Minimum, Orb::Plan::Adjustment::Maximum>]
|
16
|
+
# @return [Array<Orb::Models::Plan::Adjustment::UsageDiscount, Orb::Models::Plan::Adjustment::AmountDiscount, Orb::Models::Plan::Adjustment::PercentageDiscount, Orb::Models::Plan::Adjustment::Minimum, Orb::Models::Plan::Adjustment::Maximum>]
|
17
17
|
required :adjustments, -> { Orb::Internal::Type::ArrayOf[union: Orb::Plan::Adjustment] }
|
18
18
|
|
19
19
|
# @!attribute base_plan
|
20
20
|
#
|
21
|
-
# @return [Orb::Plan::BasePlan, nil]
|
21
|
+
# @return [Orb::Models::Plan::BasePlan, nil]
|
22
22
|
required :base_plan, -> { Orb::Plan::BasePlan }, nil?: true
|
23
23
|
|
24
24
|
# @!attribute base_plan_id
|
@@ -56,7 +56,7 @@ module Orb
|
|
56
56
|
|
57
57
|
# @!attribute discount
|
58
58
|
#
|
59
|
-
# @return [Orb::PercentageDiscount, Orb::TrialDiscount, Orb::UsageDiscount, Orb::AmountDiscount, nil]
|
59
|
+
# @return [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil]
|
60
60
|
required :discount, union: -> { Orb::Discount }, nil?: true
|
61
61
|
|
62
62
|
# @!attribute external_plan_id
|
@@ -76,7 +76,7 @@ module Orb
|
|
76
76
|
|
77
77
|
# @!attribute maximum
|
78
78
|
#
|
79
|
-
# @return [Orb::Plan::Maximum, nil]
|
79
|
+
# @return [Orb::Models::Plan::Maximum, nil]
|
80
80
|
required :maximum, -> { Orb::Plan::Maximum }, nil?: true
|
81
81
|
|
82
82
|
# @!attribute maximum_amount
|
@@ -95,7 +95,7 @@ module Orb
|
|
95
95
|
|
96
96
|
# @!attribute minimum
|
97
97
|
#
|
98
|
-
# @return [Orb::Plan::Minimum, nil]
|
98
|
+
# @return [Orb::Models::Plan::Minimum, nil]
|
99
99
|
required :minimum, -> { Orb::Plan::Minimum }, nil?: true
|
100
100
|
|
101
101
|
# @!attribute minimum_amount
|
@@ -120,29 +120,29 @@ module Orb
|
|
120
120
|
|
121
121
|
# @!attribute plan_phases
|
122
122
|
#
|
123
|
-
# @return [Array<Orb::Plan::PlanPhase>, nil]
|
123
|
+
# @return [Array<Orb::Models::Plan::PlanPhase>, nil]
|
124
124
|
required :plan_phases, -> { Orb::Internal::Type::ArrayOf[Orb::Plan::PlanPhase] }, nil?: true
|
125
125
|
|
126
126
|
# @!attribute prices
|
127
127
|
# Prices for this plan. If the plan has phases, this includes prices across all
|
128
128
|
# phases of the plan.
|
129
129
|
#
|
130
|
-
# @return [Array<Orb::Price::Unit, Orb::Price::Package, Orb::Price::Matrix, Orb::Price::Tiered, Orb::Price::TieredBps, Orb::Price::Bps, Orb::Price::BulkBps, Orb::Price::Bulk, Orb::Price::ThresholdTotalAmount, Orb::Price::TieredPackage, Orb::Price::GroupedTiered, Orb::Price::TieredWithMinimum, Orb::Price::TieredPackageWithMinimum, Orb::Price::PackageWithAllocation, Orb::Price::UnitWithPercent, Orb::Price::MatrixWithAllocation, Orb::Price::TieredWithProration, Orb::Price::UnitWithProration, Orb::Price::GroupedAllocation, Orb::Price::GroupedWithProratedMinimum, Orb::Price::GroupedWithMeteredMinimum, Orb::Price::MatrixWithDisplayName, Orb::Price::BulkWithProration, Orb::Price::GroupedTieredPackage, Orb::Price::MaxGroupTieredPackage, Orb::Price::ScalableMatrixWithUnitPricing, Orb::Price::ScalableMatrixWithTieredPricing, Orb::Price::CumulativeGroupedBulk>]
|
130
|
+
# @return [Array<Orb::Models::Price::Unit, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::Tiered, Orb::Models::Price::TieredBps, Orb::Models::Price::Bps, Orb::Models::Price::BulkBps, Orb::Models::Price::Bulk, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk>]
|
131
131
|
required :prices, -> { Orb::Internal::Type::ArrayOf[union: Orb::Price] }
|
132
132
|
|
133
133
|
# @!attribute product
|
134
134
|
#
|
135
|
-
# @return [Orb::Plan::Product]
|
135
|
+
# @return [Orb::Models::Plan::Product]
|
136
136
|
required :product, -> { Orb::Plan::Product }
|
137
137
|
|
138
138
|
# @!attribute status
|
139
139
|
#
|
140
|
-
# @return [Symbol, Orb::Plan::Status]
|
140
|
+
# @return [Symbol, Orb::Models::Plan::Status]
|
141
141
|
required :status, enum: -> { Orb::Plan::Status }
|
142
142
|
|
143
143
|
# @!attribute trial_config
|
144
144
|
#
|
145
|
-
# @return [Orb::Plan::TrialConfig]
|
145
|
+
# @return [Orb::Models::Plan::TrialConfig]
|
146
146
|
required :trial_config, -> { Orb::Plan::TrialConfig }
|
147
147
|
|
148
148
|
# @!attribute version
|
@@ -151,8 +151,8 @@ module Orb
|
|
151
151
|
required :version, Integer
|
152
152
|
|
153
153
|
# @!method initialize(id:, adjustments:, base_plan:, base_plan_id:, created_at:, currency:, default_invoice_memo:, description:, discount:, external_plan_id:, invoicing_currency:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, net_terms:, plan_phases:, prices:, product:, status:, trial_config:, version:)
|
154
|
-
# Some parameter documentations has been truncated, see {Orb::Plan} for
|
155
|
-
# details.
|
154
|
+
# Some parameter documentations has been truncated, see {Orb::Models::Plan} for
|
155
|
+
# more details.
|
156
156
|
#
|
157
157
|
# The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
|
158
158
|
# subscribed to by a customer. Plans define the billing behavior of the
|
@@ -161,9 +161,9 @@ module Orb
|
|
161
161
|
#
|
162
162
|
# @param id [String]
|
163
163
|
#
|
164
|
-
# @param adjustments [Array<Orb::Plan::Adjustment::UsageDiscount, Orb::Plan::Adjustment::AmountDiscount, Orb::Plan::Adjustment::PercentageDiscount, Orb::Plan::Adjustment::Minimum, Orb::Plan::Adjustment::Maximum>] Adjustments for this plan. If the plan has phases, this includes adjustments acr
|
164
|
+
# @param adjustments [Array<Orb::Models::Plan::Adjustment::UsageDiscount, Orb::Models::Plan::Adjustment::AmountDiscount, Orb::Models::Plan::Adjustment::PercentageDiscount, Orb::Models::Plan::Adjustment::Minimum, Orb::Models::Plan::Adjustment::Maximum>] Adjustments for this plan. If the plan has phases, this includes adjustments acr
|
165
165
|
#
|
166
|
-
# @param base_plan [Orb::Plan::BasePlan, nil]
|
166
|
+
# @param base_plan [Orb::Models::Plan::BasePlan, nil]
|
167
167
|
#
|
168
168
|
# @param base_plan_id [String, nil] The parent plan id if the given plan was created by overriding one or more of th
|
169
169
|
#
|
@@ -175,19 +175,19 @@ module Orb
|
|
175
175
|
#
|
176
176
|
# @param description [String]
|
177
177
|
#
|
178
|
-
# @param discount [Orb::PercentageDiscount, Orb::TrialDiscount, Orb::UsageDiscount, Orb::AmountDiscount, nil]
|
178
|
+
# @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil]
|
179
179
|
#
|
180
180
|
# @param external_plan_id [String, nil] An optional user-defined ID for this plan resource, used throughout the system a
|
181
181
|
#
|
182
182
|
# @param invoicing_currency [String] An ISO 4217 currency string for which this plan is billed in. Matches `currency`
|
183
183
|
#
|
184
|
-
# @param maximum [Orb::Plan::Maximum, nil]
|
184
|
+
# @param maximum [Orb::Models::Plan::Maximum, nil]
|
185
185
|
#
|
186
186
|
# @param maximum_amount [String, nil]
|
187
187
|
#
|
188
188
|
# @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
|
189
189
|
#
|
190
|
-
# @param minimum [Orb::Plan::Minimum, nil]
|
190
|
+
# @param minimum [Orb::Models::Plan::Minimum, nil]
|
191
191
|
#
|
192
192
|
# @param minimum_amount [String, nil]
|
193
193
|
#
|
@@ -195,15 +195,15 @@ module Orb
|
|
195
195
|
#
|
196
196
|
# @param net_terms [Integer, nil] Determines the difference between the invoice issue date and the due date. A val
|
197
197
|
#
|
198
|
-
# @param plan_phases [Array<Orb::Plan::PlanPhase>, nil]
|
198
|
+
# @param plan_phases [Array<Orb::Models::Plan::PlanPhase>, nil]
|
199
199
|
#
|
200
|
-
# @param prices [Array<Orb::Price::Unit, Orb::Price::Package, Orb::Price::Matrix, Orb::Price::Tiered, Orb::Price::TieredBps, Orb::Price::Bps, Orb::Price::BulkBps, Orb::Price::Bulk, Orb::Price::ThresholdTotalAmount, Orb::Price::TieredPackage, Orb::Price::GroupedTiered, Orb::Price::TieredWithMinimum, Orb::Price::TieredPackageWithMinimum, Orb::Price::PackageWithAllocation, Orb::Price::UnitWithPercent, Orb::Price::MatrixWithAllocation, Orb::Price::TieredWithProration, Orb::Price::UnitWithProration, Orb::Price::GroupedAllocation, Orb::Price::GroupedWithProratedMinimum, Orb::Price::GroupedWithMeteredMinimum, Orb::Price::MatrixWithDisplayName, Orb::Price::BulkWithProration, Orb::Price::GroupedTieredPackage, Orb::Price::MaxGroupTieredPackage, Orb::Price::ScalableMatrixWithUnitPricing, Orb::Price::ScalableMatrixWithTieredPricing, Orb::Price::CumulativeGroupedBulk>] Prices for this plan. If the plan has phases, this includes prices across all ph
|
200
|
+
# @param prices [Array<Orb::Models::Price::Unit, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::Tiered, Orb::Models::Price::TieredBps, Orb::Models::Price::Bps, Orb::Models::Price::BulkBps, Orb::Models::Price::Bulk, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk>] Prices for this plan. If the plan has phases, this includes prices across all ph
|
201
201
|
#
|
202
|
-
# @param product [Orb::Plan::Product]
|
202
|
+
# @param product [Orb::Models::Plan::Product]
|
203
203
|
#
|
204
|
-
# @param status [Symbol, Orb::Plan::Status]
|
204
|
+
# @param status [Symbol, Orb::Models::Plan::Status]
|
205
205
|
#
|
206
|
-
# @param trial_config [Orb::Plan::TrialConfig]
|
206
|
+
# @param trial_config [Orb::Models::Plan::TrialConfig]
|
207
207
|
#
|
208
208
|
# @param version [Integer]
|
209
209
|
|
@@ -267,7 +267,7 @@ module Orb
|
|
267
267
|
|
268
268
|
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, usage_discount:, adjustment_type: :usage_discount)
|
269
269
|
# Some parameter documentations has been truncated, see
|
270
|
-
# {Orb::Plan::Adjustment::UsageDiscount} for more details.
|
270
|
+
# {Orb::Models::Plan::Adjustment::UsageDiscount} for more details.
|
271
271
|
#
|
272
272
|
# @param id [String]
|
273
273
|
#
|
@@ -329,7 +329,7 @@ module Orb
|
|
329
329
|
|
330
330
|
# @!method initialize(id:, amount_discount:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, adjustment_type: :amount_discount)
|
331
331
|
# Some parameter documentations has been truncated, see
|
332
|
-
# {Orb::Plan::Adjustment::AmountDiscount} for more details.
|
332
|
+
# {Orb::Models::Plan::Adjustment::AmountDiscount} for more details.
|
333
333
|
#
|
334
334
|
# @param id [String]
|
335
335
|
#
|
@@ -391,7 +391,7 @@ module Orb
|
|
391
391
|
|
392
392
|
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, percentage_discount:, plan_phase_order:, reason:, adjustment_type: :percentage_discount)
|
393
393
|
# Some parameter documentations has been truncated, see
|
394
|
-
# {Orb::Plan::Adjustment::PercentageDiscount} for more details.
|
394
|
+
# {Orb::Models::Plan::Adjustment::PercentageDiscount} for more details.
|
395
395
|
#
|
396
396
|
# @param id [String]
|
397
397
|
#
|
@@ -459,7 +459,7 @@ module Orb
|
|
459
459
|
|
460
460
|
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, item_id:, minimum_amount:, plan_phase_order:, reason:, adjustment_type: :minimum)
|
461
461
|
# Some parameter documentations has been truncated, see
|
462
|
-
# {Orb::Plan::Adjustment::Minimum} for more details.
|
462
|
+
# {Orb::Models::Plan::Adjustment::Minimum} for more details.
|
463
463
|
#
|
464
464
|
# @param id [String]
|
465
465
|
#
|
@@ -523,7 +523,7 @@ module Orb
|
|
523
523
|
|
524
524
|
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, maximum_amount:, plan_phase_order:, reason:, adjustment_type: :maximum)
|
525
525
|
# Some parameter documentations has been truncated, see
|
526
|
-
# {Orb::Plan::Adjustment::Maximum} for more details.
|
526
|
+
# {Orb::Models::Plan::Adjustment::Maximum} for more details.
|
527
527
|
#
|
528
528
|
# @param id [String]
|
529
529
|
#
|
@@ -541,22 +541,10 @@ module Orb
|
|
541
541
|
end
|
542
542
|
|
543
543
|
# @!method self.variants
|
544
|
-
# @return [Array(Orb::Plan::Adjustment::UsageDiscount, Orb::Plan::Adjustment::AmountDiscount, Orb::Plan::Adjustment::PercentageDiscount, Orb::Plan::Adjustment::Minimum, Orb::Plan::Adjustment::Maximum)]
|
545
|
-
|
546
|
-
define_sorbet_constant!(:Variants) do
|
547
|
-
T.type_alias do
|
548
|
-
T.any(
|
549
|
-
Orb::Plan::Adjustment::UsageDiscount,
|
550
|
-
Orb::Plan::Adjustment::AmountDiscount,
|
551
|
-
Orb::Plan::Adjustment::PercentageDiscount,
|
552
|
-
Orb::Plan::Adjustment::Minimum,
|
553
|
-
Orb::Plan::Adjustment::Maximum
|
554
|
-
)
|
555
|
-
end
|
556
|
-
end
|
544
|
+
# @return [Array(Orb::Models::Plan::Adjustment::UsageDiscount, Orb::Models::Plan::Adjustment::AmountDiscount, Orb::Models::Plan::Adjustment::PercentageDiscount, Orb::Models::Plan::Adjustment::Minimum, Orb::Models::Plan::Adjustment::Maximum)]
|
557
545
|
end
|
558
546
|
|
559
|
-
# @see Orb::Plan#base_plan
|
547
|
+
# @see Orb::Models::Plan#base_plan
|
560
548
|
class BasePlan < Orb::Internal::Type::BaseModel
|
561
549
|
# @!attribute id
|
562
550
|
#
|
@@ -577,8 +565,8 @@ module Orb
|
|
577
565
|
required :name, String, nil?: true
|
578
566
|
|
579
567
|
# @!method initialize(id:, external_plan_id:, name:)
|
580
|
-
# Some parameter documentations has been truncated, see
|
581
|
-
# more details.
|
568
|
+
# Some parameter documentations has been truncated, see
|
569
|
+
# {Orb::Models::Plan::BasePlan} for more details.
|
582
570
|
#
|
583
571
|
# @param id [String, nil]
|
584
572
|
#
|
@@ -587,7 +575,7 @@ module Orb
|
|
587
575
|
# @param name [String, nil]
|
588
576
|
end
|
589
577
|
|
590
|
-
# @see Orb::Plan#maximum
|
578
|
+
# @see Orb::Models::Plan#maximum
|
591
579
|
class Maximum < Orb::Internal::Type::BaseModel
|
592
580
|
# @!attribute applies_to_price_ids
|
593
581
|
# List of price_ids that this maximum amount applies to. For plan/plan phase
|
@@ -603,15 +591,15 @@ module Orb
|
|
603
591
|
required :maximum_amount, String
|
604
592
|
|
605
593
|
# @!method initialize(applies_to_price_ids:, maximum_amount:)
|
606
|
-
# Some parameter documentations has been truncated, see
|
607
|
-
# more details.
|
594
|
+
# Some parameter documentations has been truncated, see
|
595
|
+
# {Orb::Models::Plan::Maximum} for more details.
|
608
596
|
#
|
609
597
|
# @param applies_to_price_ids [Array<String>] List of price_ids that this maximum amount applies to. For plan/plan phase maxim
|
610
598
|
#
|
611
599
|
# @param maximum_amount [String] Maximum amount applied
|
612
600
|
end
|
613
601
|
|
614
|
-
# @see Orb::Plan#minimum
|
602
|
+
# @see Orb::Models::Plan#minimum
|
615
603
|
class Minimum < Orb::Internal::Type::BaseModel
|
616
604
|
# @!attribute applies_to_price_ids
|
617
605
|
# List of price_ids that this minimum amount applies to. For plan/plan phase
|
@@ -627,8 +615,8 @@ module Orb
|
|
627
615
|
required :minimum_amount, String
|
628
616
|
|
629
617
|
# @!method initialize(applies_to_price_ids:, minimum_amount:)
|
630
|
-
# Some parameter documentations has been truncated, see
|
631
|
-
# more details.
|
618
|
+
# Some parameter documentations has been truncated, see
|
619
|
+
# {Orb::Models::Plan::Minimum} for more details.
|
632
620
|
#
|
633
621
|
# @param applies_to_price_ids [Array<String>] List of price_ids that this minimum amount applies to. For plan/plan phase minim
|
634
622
|
#
|
@@ -648,7 +636,7 @@ module Orb
|
|
648
636
|
|
649
637
|
# @!attribute discount
|
650
638
|
#
|
651
|
-
# @return [Orb::PercentageDiscount, Orb::TrialDiscount, Orb::UsageDiscount, Orb::AmountDiscount, nil]
|
639
|
+
# @return [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil]
|
652
640
|
required :discount, union: -> { Orb::Discount }, nil?: true
|
653
641
|
|
654
642
|
# @!attribute duration
|
@@ -660,12 +648,12 @@ module Orb
|
|
660
648
|
|
661
649
|
# @!attribute duration_unit
|
662
650
|
#
|
663
|
-
# @return [Symbol, Orb::Plan::PlanPhase::DurationUnit, nil]
|
651
|
+
# @return [Symbol, Orb::Models::Plan::PlanPhase::DurationUnit, nil]
|
664
652
|
required :duration_unit, enum: -> { Orb::Plan::PlanPhase::DurationUnit }, nil?: true
|
665
653
|
|
666
654
|
# @!attribute maximum
|
667
655
|
#
|
668
|
-
# @return [Orb::Plan::PlanPhase::Maximum, nil]
|
656
|
+
# @return [Orb::Models::Plan::PlanPhase::Maximum, nil]
|
669
657
|
required :maximum, -> { Orb::Plan::PlanPhase::Maximum }, nil?: true
|
670
658
|
|
671
659
|
# @!attribute maximum_amount
|
@@ -675,7 +663,7 @@ module Orb
|
|
675
663
|
|
676
664
|
# @!attribute minimum
|
677
665
|
#
|
678
|
-
# @return [Orb::Plan::PlanPhase::Minimum, nil]
|
666
|
+
# @return [Orb::Models::Plan::PlanPhase::Minimum, nil]
|
679
667
|
required :minimum, -> { Orb::Plan::PlanPhase::Minimum }, nil?: true
|
680
668
|
|
681
669
|
# @!attribute minimum_amount
|
@@ -695,24 +683,24 @@ module Orb
|
|
695
683
|
required :order, Integer
|
696
684
|
|
697
685
|
# @!method initialize(id:, description:, discount:, duration:, duration_unit:, maximum:, maximum_amount:, minimum:, minimum_amount:, name:, order:)
|
698
|
-
# Some parameter documentations has been truncated, see
|
699
|
-
# more details.
|
686
|
+
# Some parameter documentations has been truncated, see
|
687
|
+
# {Orb::Models::Plan::PlanPhase} for more details.
|
700
688
|
#
|
701
689
|
# @param id [String]
|
702
690
|
#
|
703
691
|
# @param description [String, nil]
|
704
692
|
#
|
705
|
-
# @param discount [Orb::PercentageDiscount, Orb::TrialDiscount, Orb::UsageDiscount, Orb::AmountDiscount, nil]
|
693
|
+
# @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil]
|
706
694
|
#
|
707
695
|
# @param duration [Integer, nil] How many terms of length `duration_unit` this phase is active for. If null, this
|
708
696
|
#
|
709
|
-
# @param duration_unit [Symbol, Orb::Plan::PlanPhase::DurationUnit, nil]
|
697
|
+
# @param duration_unit [Symbol, Orb::Models::Plan::PlanPhase::DurationUnit, nil]
|
710
698
|
#
|
711
|
-
# @param maximum [Orb::Plan::PlanPhase::Maximum, nil]
|
699
|
+
# @param maximum [Orb::Models::Plan::PlanPhase::Maximum, nil]
|
712
700
|
#
|
713
701
|
# @param maximum_amount [String, nil]
|
714
702
|
#
|
715
|
-
# @param minimum [Orb::Plan::PlanPhase::Minimum, nil]
|
703
|
+
# @param minimum [Orb::Models::Plan::PlanPhase::Minimum, nil]
|
716
704
|
#
|
717
705
|
# @param minimum_amount [String, nil]
|
718
706
|
#
|
@@ -720,7 +708,7 @@ module Orb
|
|
720
708
|
#
|
721
709
|
# @param order [Integer] Determines the ordering of the phase in a plan's lifecycle. 1 = first phase.
|
722
710
|
|
723
|
-
# @see Orb::Plan::PlanPhase#duration_unit
|
711
|
+
# @see Orb::Models::Plan::PlanPhase#duration_unit
|
724
712
|
module DurationUnit
|
725
713
|
extend Orb::Internal::Type::Enum
|
726
714
|
|
@@ -734,7 +722,7 @@ module Orb
|
|
734
722
|
# @return [Array<Symbol>]
|
735
723
|
end
|
736
724
|
|
737
|
-
# @see Orb::Plan::PlanPhase#maximum
|
725
|
+
# @see Orb::Models::Plan::PlanPhase#maximum
|
738
726
|
class Maximum < Orb::Internal::Type::BaseModel
|
739
727
|
# @!attribute applies_to_price_ids
|
740
728
|
# List of price_ids that this maximum amount applies to. For plan/plan phase
|
@@ -751,14 +739,14 @@ module Orb
|
|
751
739
|
|
752
740
|
# @!method initialize(applies_to_price_ids:, maximum_amount:)
|
753
741
|
# Some parameter documentations has been truncated, see
|
754
|
-
# {Orb::Plan::PlanPhase::Maximum} for more details.
|
742
|
+
# {Orb::Models::Plan::PlanPhase::Maximum} for more details.
|
755
743
|
#
|
756
744
|
# @param applies_to_price_ids [Array<String>] List of price_ids that this maximum amount applies to. For plan/plan phase maxim
|
757
745
|
#
|
758
746
|
# @param maximum_amount [String] Maximum amount applied
|
759
747
|
end
|
760
748
|
|
761
|
-
# @see Orb::Plan::PlanPhase#minimum
|
749
|
+
# @see Orb::Models::Plan::PlanPhase#minimum
|
762
750
|
class Minimum < Orb::Internal::Type::BaseModel
|
763
751
|
# @!attribute applies_to_price_ids
|
764
752
|
# List of price_ids that this minimum amount applies to. For plan/plan phase
|
@@ -775,7 +763,7 @@ module Orb
|
|
775
763
|
|
776
764
|
# @!method initialize(applies_to_price_ids:, minimum_amount:)
|
777
765
|
# Some parameter documentations has been truncated, see
|
778
|
-
# {Orb::Plan::PlanPhase::Minimum} for more details.
|
766
|
+
# {Orb::Models::Plan::PlanPhase::Minimum} for more details.
|
779
767
|
#
|
780
768
|
# @param applies_to_price_ids [Array<String>] List of price_ids that this minimum amount applies to. For plan/plan phase minim
|
781
769
|
#
|
@@ -783,7 +771,7 @@ module Orb
|
|
783
771
|
end
|
784
772
|
end
|
785
773
|
|
786
|
-
# @see Orb::Plan#product
|
774
|
+
# @see Orb::Models::Plan#product
|
787
775
|
class Product < Orb::Internal::Type::BaseModel
|
788
776
|
# @!attribute id
|
789
777
|
#
|
@@ -806,7 +794,7 @@ module Orb
|
|
806
794
|
# @param name [String]
|
807
795
|
end
|
808
796
|
|
809
|
-
# @see Orb::Plan#status
|
797
|
+
# @see Orb::Models::Plan#status
|
810
798
|
module Status
|
811
799
|
extend Orb::Internal::Type::Enum
|
812
800
|
|
@@ -818,7 +806,7 @@ module Orb
|
|
818
806
|
# @return [Array<Symbol>]
|
819
807
|
end
|
820
808
|
|
821
|
-
# @see Orb::Plan#trial_config
|
809
|
+
# @see Orb::Models::Plan#trial_config
|
822
810
|
class TrialConfig < Orb::Internal::Type::BaseModel
|
823
811
|
# @!attribute trial_period
|
824
812
|
#
|
@@ -827,14 +815,14 @@ module Orb
|
|
827
815
|
|
828
816
|
# @!attribute trial_period_unit
|
829
817
|
#
|
830
|
-
# @return [Symbol, Orb::Plan::TrialConfig::TrialPeriodUnit]
|
818
|
+
# @return [Symbol, Orb::Models::Plan::TrialConfig::TrialPeriodUnit]
|
831
819
|
required :trial_period_unit, enum: -> { Orb::Plan::TrialConfig::TrialPeriodUnit }
|
832
820
|
|
833
821
|
# @!method initialize(trial_period:, trial_period_unit:)
|
834
822
|
# @param trial_period [Integer, nil]
|
835
|
-
# @param trial_period_unit [Symbol, Orb::Plan::TrialConfig::TrialPeriodUnit]
|
823
|
+
# @param trial_period_unit [Symbol, Orb::Models::Plan::TrialConfig::TrialPeriodUnit]
|
836
824
|
|
837
|
-
# @see Orb::Plan::TrialConfig#trial_period_unit
|
825
|
+
# @see Orb::Models::Plan::TrialConfig#trial_period_unit
|
838
826
|
module TrialPeriodUnit
|
839
827
|
extend Orb::Internal::Type::Enum
|
840
828
|
|