orb-billing 0.3.0 → 0.3.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +33 -0
- data/README.md +5 -5
- data/lib/orb/errors.rb +9 -9
- data/lib/orb/internal/page.rb +3 -3
- data/lib/orb/internal/transport/base_client.rb +3 -3
- data/lib/orb/internal/type/base_model.rb +1 -9
- data/lib/orb/internal/type/boolean.rb +10 -11
- data/lib/orb/internal/type/enum.rb +10 -11
- data/lib/orb/internal/type/request_parameters.rb +2 -8
- data/lib/orb/internal/type/unknown.rb +10 -11
- data/lib/orb/internal/util.rb +20 -4
- data/lib/orb/models/coupon_create_params.rb +7 -7
- data/lib/orb/models/customer_create_params.rb +7 -7
- data/lib/orb/models/customer_update_by_external_id_params.rb +7 -9
- data/lib/orb/models/customer_update_params.rb +7 -7
- data/lib/orb/models/customers/cost_list_by_external_id_response.rb +2 -2
- data/lib/orb/models/customers/cost_list_response.rb +2 -2
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +106 -107
- data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +111 -119
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +110 -114
- data/lib/orb/models/customers/credits/ledger_list_response.rb +112 -124
- data/lib/orb/models/invoice.rb +50 -64
- data/lib/orb/models/invoice_fetch_upcoming_response.rb +51 -55
- data/lib/orb/models/invoice_line_item_create_response.rb +54 -57
- data/lib/orb/models/plan.rb +20 -23
- data/lib/orb/models/plan_create_params.rb +635 -670
- data/lib/orb/models/price.rb +1547 -1599
- data/lib/orb/models/subscription.rb +35 -41
- data/lib/orb/models/subscription_cancel_response.rb +33 -36
- data/lib/orb/models/subscription_change_apply_response.rb +31 -32
- data/lib/orb/models/subscription_change_cancel_response.rb +31 -31
- data/lib/orb/models/subscription_change_retrieve_response.rb +31 -31
- data/lib/orb/models/subscription_create_params.rb +1316 -1367
- data/lib/orb/models/subscription_create_response.rb +33 -36
- data/lib/orb/models/subscription_fetch_costs_response.rb +2 -2
- data/lib/orb/models/subscription_price_intervals_params.rb +748 -774
- data/lib/orb/models/subscription_price_intervals_response.rb +32 -35
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +1299 -1354
- data/lib/orb/models/subscription_schedule_plan_change_response.rb +31 -33
- data/lib/orb/models/subscription_trigger_phase_response.rb +32 -35
- data/lib/orb/models/subscription_unschedule_cancellation_response.rb +31 -33
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +31 -31
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +31 -31
- data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +31 -33
- data/lib/orb/models/subscription_update_trial_response.rb +33 -36
- data/lib/orb/models.rb +220 -0
- data/lib/orb/request_options.rb +4 -5
- data/lib/orb/resources/coupons.rb +1 -1
- data/lib/orb/resources/customers/credits/ledger.rb +4 -4
- data/lib/orb/resources/customers.rb +3 -3
- data/lib/orb/resources/plans.rb +1 -1
- data/lib/orb/resources/prices/external_price_id.rb +2 -2
- data/lib/orb/resources/prices.rb +4 -4
- data/lib/orb/version.rb +1 -1
- data/rbi/{lib/orb → orb}/errors.rbi +1 -1
- data/rbi/{lib/orb → orb}/internal/transport/base_client.rbi +2 -2
- data/rbi/{lib/orb → orb}/internal/type/request_parameters.rbi +1 -1
- data/rbi/{lib/orb → orb}/internal/util.rbi +5 -1
- data/rbi/{lib/orb → orb}/models/coupon_create_params.rbi +9 -9
- data/rbi/{lib/orb → orb}/models/customer_create_params.rbi +9 -9
- data/rbi/{lib/orb → orb}/models/customer_update_by_external_id_params.rbi +9 -9
- data/rbi/{lib/orb → orb}/models/customer_update_params.rbi +9 -9
- data/rbi/{lib/orb → orb}/models/customers/cost_list_by_external_id_response.rbi +84 -84
- data/rbi/{lib/orb → orb}/models/customers/cost_list_response.rbi +84 -84
- data/rbi/{lib/orb/models/customers/credits/ledger_create_entry_response.rbi → orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi} +122 -114
- data/rbi/{lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi → orb/models/customers/credits/ledger_create_entry_response.rbi} +114 -216
- data/rbi/{lib/orb/models/customers/credits/ledger_list_response.rbi → orb/models/customers/credits/ledger_list_by_external_id_response.rbi} +114 -114
- data/rbi/{lib/orb/models/customers/credits/ledger_list_by_external_id_response.rbi → orb/models/customers/credits/ledger_list_response.rbi} +114 -271
- data/rbi/{lib/orb → orb}/models/invoice.rbi +138 -156
- data/rbi/{lib/orb → orb}/models/invoice_fetch_upcoming_response.rbi +138 -150
- data/rbi/{lib/orb → orb}/models/invoice_line_item_create_response.rbi +138 -162
- data/rbi/{lib/orb → orb}/models/plan.rbi +105 -105
- data/rbi/{lib/orb → orb}/models/plan_create_params.rbi +973 -1734
- data/rbi/{lib/orb → orb}/models/price.rbi +1875 -2267
- data/rbi/{lib/orb → orb}/models/subscription.rbi +118 -118
- data/rbi/{lib/orb → orb}/models/subscription_cancel_response.rbi +118 -118
- data/rbi/{lib/orb → orb}/models/subscription_change_apply_response.rbi +118 -118
- data/rbi/{lib/orb → orb}/models/subscription_change_cancel_response.rbi +118 -118
- data/rbi/{lib/orb → orb}/models/subscription_change_retrieve_response.rbi +118 -118
- data/rbi/{lib/orb → orb}/models/subscription_create_params.rbi +1988 -2733
- data/rbi/{lib/orb → orb}/models/subscription_create_response.rbi +118 -118
- data/rbi/{lib/orb → orb}/models/subscription_fetch_costs_response.rbi +84 -84
- data/rbi/{lib/orb → orb}/models/subscription_price_intervals_params.rbi +1125 -1455
- data/rbi/{lib/orb → orb}/models/subscription_price_intervals_response.rbi +118 -118
- data/rbi/{lib/orb → orb}/models/subscription_schedule_plan_change_params.rbi +1988 -2210
- data/rbi/{lib/orb → orb}/models/subscription_schedule_plan_change_response.rbi +118 -118
- data/rbi/{lib/orb → orb}/models/subscription_trigger_phase_response.rbi +118 -118
- data/rbi/{lib/orb → orb}/models/subscription_unschedule_cancellation_response.rbi +118 -118
- data/rbi/{lib/orb → orb}/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +118 -118
- data/rbi/{lib/orb → orb}/models/subscription_unschedule_pending_plan_changes_response.rbi +118 -118
- data/rbi/{lib/orb → orb}/models/subscription_update_fixed_fee_quantity_response.rbi +118 -118
- data/rbi/{lib/orb → orb}/models/subscription_update_trial_response.rbi +118 -118
- data/rbi/orb/models.rbi +220 -0
- data/rbi/{lib/orb → orb}/request_options.rbi +2 -0
- data/rbi/{lib/orb → orb}/resources/alerts.rbi +8 -14
- data/rbi/{lib/orb → orb}/resources/coupons/subscriptions.rbi +1 -1
- data/rbi/{lib/orb → orb}/resources/coupons.rbi +6 -18
- data/rbi/{lib/orb → orb}/resources/credit_notes.rbi +3 -9
- data/rbi/{lib/orb → orb}/resources/customers/balance_transactions.rbi +2 -2
- data/rbi/{lib/orb → orb}/resources/customers/costs.rbi +2 -2
- data/rbi/{lib/orb → orb}/resources/customers/credits/ledger.rbi +32 -32
- data/rbi/{lib/orb → orb}/resources/customers/credits/top_ups.rbi +6 -18
- data/rbi/{lib/orb → orb}/resources/customers/credits.rbi +2 -2
- data/rbi/{lib/orb → orb}/resources/customers.rbi +15 -45
- data/rbi/{lib/orb → orb}/resources/dimensional_price_groups/external_dimensional_price_group_id.rbi +1 -4
- data/rbi/{lib/orb → orb}/resources/dimensional_price_groups.rbi +3 -10
- data/rbi/{lib/orb → orb}/resources/events/backfills.rbi +5 -18
- data/rbi/{lib/orb → orb}/resources/events/volume.rbi +1 -1
- data/rbi/{lib/orb → orb}/resources/events.rbi +4 -10
- data/rbi/{lib/orb → orb}/resources/invoice_line_items.rbi +1 -1
- data/rbi/{lib/orb → orb}/resources/invoices.rbi +9 -34
- data/rbi/{lib/orb → orb}/resources/items.rbi +4 -17
- data/rbi/{lib/orb → orb}/resources/metrics.rbi +4 -10
- data/rbi/{lib/orb → orb}/resources/plans/external_plan_id.rbi +2 -8
- data/rbi/{lib/orb → orb}/resources/plans.rbi +29 -35
- data/rbi/orb/resources/prices/external_price_id.rbi +103 -0
- data/rbi/{lib/orb → orb}/resources/prices.rbi +117 -124
- data/rbi/{lib/orb → orb}/resources/subscription_changes.rbi +3 -9
- data/rbi/{lib/orb → orb}/resources/subscriptions.rbi +16 -32
- data/rbi/{lib/orb → orb}/resources/top_level.rbi +1 -4
- data/sig/orb/internal/util.rbs +2 -0
- data/sig/orb/models/coupon_create_params.rbs +9 -10
- data/sig/orb/models/customer_create_params.rbs +9 -10
- data/sig/orb/models/customer_update_by_external_id_params.rbs +9 -10
- data/sig/orb/models/customer_update_params.rbs +9 -10
- data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbs +113 -113
- data/sig/orb/models/customers/credits/ledger_create_entry_response.rbs +113 -113
- data/sig/orb/models/customers/credits/ledger_list_by_external_id_response.rbs +113 -113
- data/sig/orb/models/customers/credits/ledger_list_response.rbs +113 -113
- data/sig/orb/models/invoice.rbs +54 -54
- data/sig/orb/models/invoice_fetch_upcoming_response.rbs +54 -54
- data/sig/orb/models/invoice_line_item_create_response.rbs +54 -54
- data/sig/orb/models/plan.rbs +21 -21
- data/sig/orb/models/plan_create_params.rbs +653 -653
- data/sig/orb/models/price.rbs +1517 -1521
- data/sig/orb/models/subscription.rbs +34 -34
- data/sig/orb/models/subscription_cancel_response.rbs +34 -34
- data/sig/orb/models/subscription_change_apply_response.rbs +34 -34
- data/sig/orb/models/subscription_change_cancel_response.rbs +34 -34
- data/sig/orb/models/subscription_change_retrieve_response.rbs +34 -34
- data/sig/orb/models/subscription_create_params.rbs +1348 -1348
- data/sig/orb/models/subscription_create_response.rbs +34 -34
- data/sig/orb/models/subscription_price_intervals_params.rbs +767 -769
- data/sig/orb/models/subscription_price_intervals_response.rbs +34 -34
- data/sig/orb/models/subscription_schedule_plan_change_params.rbs +1348 -1348
- data/sig/orb/models/subscription_schedule_plan_change_response.rbs +34 -34
- data/sig/orb/models/subscription_trigger_phase_response.rbs +34 -34
- data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +34 -34
- data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +34 -34
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +34 -34
- data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +34 -34
- data/sig/orb/models/subscription_update_trial_response.rbs +34 -34
- data/sig/orb/models.rbs +215 -0
- metadata +226 -223
- data/rbi/lib/orb/resources/prices/external_price_id.rbi +0 -106
- data/rbi/{lib/orb → orb}/client.rbi +0 -0
- data/rbi/{lib/orb → orb}/file_part.rbi +0 -0
- data/rbi/{lib/orb → orb}/internal/page.rbi +0 -0
- data/rbi/{lib/orb → orb}/internal/transport/pooled_net_requester.rbi +0 -0
- data/rbi/{lib/orb → orb}/internal/type/array_of.rbi +0 -0
- data/rbi/{lib/orb → orb}/internal/type/base_model.rbi +0 -0
- data/rbi/{lib/orb → orb}/internal/type/base_page.rbi +0 -0
- data/rbi/{lib/orb → orb}/internal/type/boolean.rbi +0 -0
- data/rbi/{lib/orb → orb}/internal/type/converter.rbi +0 -0
- data/rbi/{lib/orb → orb}/internal/type/enum.rbi +0 -0
- data/rbi/{lib/orb → orb}/internal/type/file_input.rbi +0 -0
- data/rbi/{lib/orb → orb}/internal/type/hash_of.rbi +0 -0
- data/rbi/{lib/orb → orb}/internal/type/union.rbi +0 -0
- data/rbi/{lib/orb → orb}/internal/type/unknown.rbi +0 -0
- data/rbi/{lib/orb → orb}/internal.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/alert.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/alert_create_for_customer_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/alert_create_for_external_customer_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/alert_create_for_subscription_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/alert_disable_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/alert_enable_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/alert_list_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/alert_retrieve_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/alert_update_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/amount_discount.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/billable_metric.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/billing_cycle_relative_date.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/coupon.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/coupon_archive_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/coupon_fetch_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/coupon_list_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/coupons/subscription_list_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/credit_note.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/credit_note_create_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/credit_note_fetch_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/credit_note_list_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customer.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customer_delete_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customer_fetch_by_external_id_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customer_fetch_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customer_list_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customer_sync_payment_methods_from_gateway_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/balance_transaction_create_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/balance_transaction_create_response.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/balance_transaction_list_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/balance_transaction_list_response.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/cost_list_by_external_id_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/cost_list_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/credit_list_by_external_id_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/credit_list_by_external_id_response.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/credit_list_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/credit_list_response.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/credits/ledger_create_entry_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/credits/ledger_list_by_external_id_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/credits/ledger_list_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_by_external_id_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_by_external_id_response.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_response.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_delete_by_external_id_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_delete_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_by_external_id_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_by_external_id_response.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_response.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/dimensional_price_group.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/dimensional_price_group_create_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/dimensional_price_group_list_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/dimensional_price_group_retrieve_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/dimensional_price_groups.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/discount.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/evaluate_price_group.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/event_deprecate_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/event_deprecate_response.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/event_ingest_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/event_ingest_response.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/event_search_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/event_search_response.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/event_update_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/event_update_response.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/events/backfill_close_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/events/backfill_close_response.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/events/backfill_create_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/events/backfill_create_response.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/events/backfill_fetch_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/events/backfill_fetch_response.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/events/backfill_list_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/events/backfill_list_response.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/events/backfill_revert_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/events/backfill_revert_response.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/events/event_volumes.rbi +2 -2
- /data/rbi/{lib/orb → orb}/models/events/volume_list_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_create_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_fetch_upcoming_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_issue_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_level_discount.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_line_item_create_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_list_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_mark_paid_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_pay_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_update_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_void_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/item.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/item_create_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/item_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/item_list_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/item_update_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/metric_create_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/metric_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/metric_list_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/metric_update_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/pagination_metadata.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/percentage_discount.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/plan_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/plan_list_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/plan_update_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/plans/external_plan_id_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/plans/external_plan_id_update_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/price_create_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/price_evaluate_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/price_evaluate_response.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/price_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/price_list_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/price_update_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/prices/external_price_id_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/prices/external_price_id_update_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_cancel_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_change_apply_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_change_cancel_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_change_retrieve_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_fetch_costs_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_fetch_schedule_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_fetch_schedule_response.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_fetch_usage_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_list_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_trigger_phase_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_unschedule_cancellation_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_unschedule_pending_plan_changes_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_update_fixed_fee_quantity_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_update_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_update_trial_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_usage.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscriptions.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/top_level_ping_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/top_level_ping_response.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/trial_discount.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/usage_discount.rbi +0 -0
- /data/rbi/{lib/orb → orb}/version.rbi +0 -0
@@ -101,7 +101,7 @@ module Orb
|
|
101
101
|
# @!attribute discount_intervals
|
102
102
|
# The discount intervals for this subscription sorted by the start_date.
|
103
103
|
#
|
104
|
-
# @return [Array<Orb::Models::Subscription::DiscountInterval::
|
104
|
+
# @return [Array<Orb::Models::Subscription::DiscountInterval::Amount, Orb::Models::Subscription::DiscountInterval::Percentage, Orb::Models::Subscription::DiscountInterval::Usage>]
|
105
105
|
required :discount_intervals,
|
106
106
|
-> { Orb::Internal::Type::ArrayOf[union: Orb::Models::Subscription::DiscountInterval] }
|
107
107
|
|
@@ -252,7 +252,7 @@ module Orb
|
|
252
252
|
# @param default_invoice_memo [String, nil] Determines the default memo on this subscriptions' invoices. Note that if this i
|
253
253
|
# ...
|
254
254
|
#
|
255
|
-
# @param discount_intervals [Array<Orb::Models::Subscription::DiscountInterval::
|
255
|
+
# @param discount_intervals [Array<Orb::Models::Subscription::DiscountInterval::Amount, Orb::Models::Subscription::DiscountInterval::Percentage, Orb::Models::Subscription::DiscountInterval::Usage>] The discount intervals for this subscription sorted by the start_date.
|
256
256
|
#
|
257
257
|
# @param end_date [Time, nil] The date Orb stops billing for this subscription.
|
258
258
|
#
|
@@ -293,7 +293,7 @@ module Orb
|
|
293
293
|
|
294
294
|
# @!attribute adjustment
|
295
295
|
#
|
296
|
-
# @return [Orb::Models::Subscription::AdjustmentInterval::Adjustment::
|
296
|
+
# @return [Orb::Models::Subscription::AdjustmentInterval::Adjustment::UsageDiscount, Orb::Models::Subscription::AdjustmentInterval::Adjustment::AmountDiscount, Orb::Models::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount, Orb::Models::Subscription::AdjustmentInterval::Adjustment::Minimum, Orb::Models::Subscription::AdjustmentInterval::Adjustment::Maximum]
|
297
297
|
required :adjustment, union: -> { Orb::Models::Subscription::AdjustmentInterval::Adjustment }
|
298
298
|
|
299
299
|
# @!attribute applies_to_price_interval_ids
|
@@ -317,7 +317,7 @@ module Orb
|
|
317
317
|
# @!method initialize(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:)
|
318
318
|
# @param id [String]
|
319
319
|
#
|
320
|
-
# @param adjustment [Orb::Models::Subscription::AdjustmentInterval::Adjustment::
|
320
|
+
# @param adjustment [Orb::Models::Subscription::AdjustmentInterval::Adjustment::UsageDiscount, Orb::Models::Subscription::AdjustmentInterval::Adjustment::AmountDiscount, Orb::Models::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount, Orb::Models::Subscription::AdjustmentInterval::Adjustment::Minimum, Orb::Models::Subscription::AdjustmentInterval::Adjustment::Maximum]
|
321
321
|
#
|
322
322
|
# @param applies_to_price_interval_ids [Array<String>] The price interval IDs that this adjustment applies to.
|
323
323
|
#
|
@@ -331,22 +331,18 @@ module Orb
|
|
331
331
|
|
332
332
|
discriminator :adjustment_type
|
333
333
|
|
334
|
-
variant :usage_discount,
|
335
|
-
-> { Orb::Models::Subscription::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment }
|
334
|
+
variant :usage_discount, -> { Orb::Models::Subscription::AdjustmentInterval::Adjustment::UsageDiscount }
|
336
335
|
|
337
|
-
variant :amount_discount,
|
338
|
-
-> { Orb::Models::Subscription::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment }
|
336
|
+
variant :amount_discount, -> { Orb::Models::Subscription::AdjustmentInterval::Adjustment::AmountDiscount }
|
339
337
|
|
340
338
|
variant :percentage_discount,
|
341
|
-
-> { Orb::Models::Subscription::AdjustmentInterval::Adjustment::
|
339
|
+
-> { Orb::Models::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount }
|
342
340
|
|
343
|
-
variant :minimum,
|
344
|
-
-> { Orb::Models::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment }
|
341
|
+
variant :minimum, -> { Orb::Models::Subscription::AdjustmentInterval::Adjustment::Minimum }
|
345
342
|
|
346
|
-
variant :maximum,
|
347
|
-
-> { Orb::Models::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment }
|
343
|
+
variant :maximum, -> { Orb::Models::Subscription::AdjustmentInterval::Adjustment::Maximum }
|
348
344
|
|
349
|
-
class
|
345
|
+
class UsageDiscount < Orb::Internal::Type::BaseModel
|
350
346
|
# @!attribute id
|
351
347
|
#
|
352
348
|
# @return [String]
|
@@ -391,8 +387,8 @@ module Orb
|
|
391
387
|
|
392
388
|
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, usage_discount:, adjustment_type: :usage_discount)
|
393
389
|
# Some parameter documentations has been truncated, see
|
394
|
-
# {Orb::Models::Subscription::AdjustmentInterval::Adjustment::
|
395
|
-
#
|
390
|
+
# {Orb::Models::Subscription::AdjustmentInterval::Adjustment::UsageDiscount} for
|
391
|
+
# more details.
|
396
392
|
#
|
397
393
|
# @param id [String]
|
398
394
|
#
|
@@ -411,7 +407,7 @@ module Orb
|
|
411
407
|
# @param adjustment_type [Symbol, :usage_discount]
|
412
408
|
end
|
413
409
|
|
414
|
-
class
|
410
|
+
class AmountDiscount < Orb::Internal::Type::BaseModel
|
415
411
|
# @!attribute id
|
416
412
|
#
|
417
413
|
# @return [String]
|
@@ -456,8 +452,8 @@ module Orb
|
|
456
452
|
|
457
453
|
# @!method initialize(id:, amount_discount:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, adjustment_type: :amount_discount)
|
458
454
|
# Some parameter documentations has been truncated, see
|
459
|
-
# {Orb::Models::Subscription::AdjustmentInterval::Adjustment::
|
460
|
-
#
|
455
|
+
# {Orb::Models::Subscription::AdjustmentInterval::Adjustment::AmountDiscount} for
|
456
|
+
# more details.
|
461
457
|
#
|
462
458
|
# @param id [String]
|
463
459
|
#
|
@@ -476,7 +472,7 @@ module Orb
|
|
476
472
|
# @param adjustment_type [Symbol, :amount_discount]
|
477
473
|
end
|
478
474
|
|
479
|
-
class
|
475
|
+
class PercentageDiscount < Orb::Internal::Type::BaseModel
|
480
476
|
# @!attribute id
|
481
477
|
#
|
482
478
|
# @return [String]
|
@@ -521,7 +517,7 @@ module Orb
|
|
521
517
|
|
522
518
|
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, percentage_discount:, plan_phase_order:, reason:, adjustment_type: :percentage_discount)
|
523
519
|
# Some parameter documentations has been truncated, see
|
524
|
-
# {Orb::Models::Subscription::AdjustmentInterval::Adjustment::
|
520
|
+
# {Orb::Models::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount}
|
525
521
|
# for more details.
|
526
522
|
#
|
527
523
|
# @param id [String]
|
@@ -541,7 +537,7 @@ module Orb
|
|
541
537
|
# @param adjustment_type [Symbol, :percentage_discount]
|
542
538
|
end
|
543
539
|
|
544
|
-
class
|
540
|
+
class Minimum < Orb::Internal::Type::BaseModel
|
545
541
|
# @!attribute id
|
546
542
|
#
|
547
543
|
# @return [String]
|
@@ -592,8 +588,8 @@ module Orb
|
|
592
588
|
|
593
589
|
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, item_id:, minimum_amount:, plan_phase_order:, reason:, adjustment_type: :minimum)
|
594
590
|
# Some parameter documentations has been truncated, see
|
595
|
-
# {Orb::Models::Subscription::AdjustmentInterval::Adjustment::
|
596
|
-
#
|
591
|
+
# {Orb::Models::Subscription::AdjustmentInterval::Adjustment::Minimum} for more
|
592
|
+
# details.
|
597
593
|
#
|
598
594
|
# @param id [String]
|
599
595
|
#
|
@@ -614,7 +610,7 @@ module Orb
|
|
614
610
|
# @param adjustment_type [Symbol, :minimum]
|
615
611
|
end
|
616
612
|
|
617
|
-
class
|
613
|
+
class Maximum < Orb::Internal::Type::BaseModel
|
618
614
|
# @!attribute id
|
619
615
|
#
|
620
616
|
# @return [String]
|
@@ -659,8 +655,8 @@ module Orb
|
|
659
655
|
|
660
656
|
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, maximum_amount:, plan_phase_order:, reason:, adjustment_type: :maximum)
|
661
657
|
# Some parameter documentations has been truncated, see
|
662
|
-
# {Orb::Models::Subscription::AdjustmentInterval::Adjustment::
|
663
|
-
#
|
658
|
+
# {Orb::Models::Subscription::AdjustmentInterval::Adjustment::Maximum} for more
|
659
|
+
# details.
|
664
660
|
#
|
665
661
|
# @param id [String]
|
666
662
|
#
|
@@ -680,7 +676,7 @@ module Orb
|
|
680
676
|
end
|
681
677
|
|
682
678
|
# @!method self.variants
|
683
|
-
# @return [Array(Orb::Models::Subscription::AdjustmentInterval::Adjustment::
|
679
|
+
# @return [Array(Orb::Models::Subscription::AdjustmentInterval::Adjustment::UsageDiscount, Orb::Models::Subscription::AdjustmentInterval::Adjustment::AmountDiscount, Orb::Models::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount, Orb::Models::Subscription::AdjustmentInterval::Adjustment::Minimum, Orb::Models::Subscription::AdjustmentInterval::Adjustment::Maximum)]
|
684
680
|
end
|
685
681
|
end
|
686
682
|
|
@@ -729,13 +725,13 @@ module Orb
|
|
729
725
|
|
730
726
|
discriminator :discount_type
|
731
727
|
|
732
|
-
variant :amount, -> { Orb::Models::Subscription::DiscountInterval::
|
728
|
+
variant :amount, -> { Orb::Models::Subscription::DiscountInterval::Amount }
|
733
729
|
|
734
|
-
variant :percentage, -> { Orb::Models::Subscription::DiscountInterval::
|
730
|
+
variant :percentage, -> { Orb::Models::Subscription::DiscountInterval::Percentage }
|
735
731
|
|
736
|
-
variant :usage, -> { Orb::Models::Subscription::DiscountInterval::
|
732
|
+
variant :usage, -> { Orb::Models::Subscription::DiscountInterval::Usage }
|
737
733
|
|
738
|
-
class
|
734
|
+
class Amount < Orb::Internal::Type::BaseModel
|
739
735
|
# @!attribute amount_discount
|
740
736
|
# Only available if discount_type is `amount`.
|
741
737
|
#
|
@@ -785,7 +781,7 @@ module Orb
|
|
785
781
|
# @param discount_type [Symbol, :amount]
|
786
782
|
end
|
787
783
|
|
788
|
-
class
|
784
|
+
class Percentage < Orb::Internal::Type::BaseModel
|
789
785
|
# @!attribute applies_to_price_ids
|
790
786
|
# The price ids that this discount interval applies to.
|
791
787
|
#
|
@@ -824,8 +820,7 @@ module Orb
|
|
824
820
|
|
825
821
|
# @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, percentage_discount:, start_date:, discount_type: :percentage)
|
826
822
|
# Some parameter documentations has been truncated, see
|
827
|
-
# {Orb::Models::Subscription::DiscountInterval::
|
828
|
-
# more details.
|
823
|
+
# {Orb::Models::Subscription::DiscountInterval::Percentage} for more details.
|
829
824
|
#
|
830
825
|
# @param applies_to_price_ids [Array<String>] The price ids that this discount interval applies to.
|
831
826
|
#
|
@@ -841,7 +836,7 @@ module Orb
|
|
841
836
|
# @param discount_type [Symbol, :percentage]
|
842
837
|
end
|
843
838
|
|
844
|
-
class
|
839
|
+
class Usage < Orb::Internal::Type::BaseModel
|
845
840
|
# @!attribute applies_to_price_ids
|
846
841
|
# The price ids that this discount interval applies to.
|
847
842
|
#
|
@@ -880,8 +875,7 @@ module Orb
|
|
880
875
|
|
881
876
|
# @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, start_date:, usage_discount:, discount_type: :usage)
|
882
877
|
# Some parameter documentations has been truncated, see
|
883
|
-
# {Orb::Models::Subscription::DiscountInterval::
|
884
|
-
# details.
|
878
|
+
# {Orb::Models::Subscription::DiscountInterval::Usage} for more details.
|
885
879
|
#
|
886
880
|
# @param applies_to_price_ids [Array<String>] The price ids that this discount interval applies to.
|
887
881
|
#
|
@@ -898,7 +892,7 @@ module Orb
|
|
898
892
|
end
|
899
893
|
|
900
894
|
# @!method self.variants
|
901
|
-
# @return [Array(Orb::Models::Subscription::DiscountInterval::
|
895
|
+
# @return [Array(Orb::Models::Subscription::DiscountInterval::Amount, Orb::Models::Subscription::DiscountInterval::Percentage, Orb::Models::Subscription::DiscountInterval::Usage)]
|
902
896
|
end
|
903
897
|
|
904
898
|
class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel
|
@@ -1100,7 +1094,7 @@ module Orb
|
|
1100
1094
|
# For more on the types of prices, see
|
1101
1095
|
# [the core concepts documentation](/core-concepts#plan-and-price)
|
1102
1096
|
#
|
1103
|
-
# @return [Orb::Models::Price::
|
1097
|
+
# @return [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]
|
1104
1098
|
required :price, union: -> { Orb::Models::Price }
|
1105
1099
|
|
1106
1100
|
# @!attribute start_date
|
@@ -1143,7 +1137,7 @@ module Orb
|
|
1143
1137
|
# @param fixed_fee_quantity_transitions [Array<Orb::Models::Subscription::PriceInterval::FixedFeeQuantityTransition>, nil] The fixed fee quantity transitions for this price interval. This is only relevan
|
1144
1138
|
# ...
|
1145
1139
|
#
|
1146
|
-
# @param price [Orb::Models::Price::
|
1140
|
+
# @param price [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] The Price resource represents a price that can be billed on a subscription, resu
|
1147
1141
|
# ...
|
1148
1142
|
#
|
1149
1143
|
# @param start_date [Time] The start date of the price interval. This is the date that Orb starts billing f
|
@@ -101,7 +101,7 @@ module Orb
|
|
101
101
|
# @!attribute discount_intervals
|
102
102
|
# The discount intervals for this subscription sorted by the start_date.
|
103
103
|
#
|
104
|
-
# @return [Array<Orb::Models::SubscriptionCancelResponse::DiscountInterval::
|
104
|
+
# @return [Array<Orb::Models::SubscriptionCancelResponse::DiscountInterval::Amount, Orb::Models::SubscriptionCancelResponse::DiscountInterval::Percentage, Orb::Models::SubscriptionCancelResponse::DiscountInterval::Usage>]
|
105
105
|
required :discount_intervals,
|
106
106
|
-> { Orb::Internal::Type::ArrayOf[union: Orb::Models::SubscriptionCancelResponse::DiscountInterval] }
|
107
107
|
|
@@ -241,7 +241,7 @@ module Orb
|
|
241
241
|
# @param default_invoice_memo [String, nil] Determines the default memo on this subscriptions' invoices. Note that if this i
|
242
242
|
# ...
|
243
243
|
#
|
244
|
-
# @param discount_intervals [Array<Orb::Models::SubscriptionCancelResponse::DiscountInterval::
|
244
|
+
# @param discount_intervals [Array<Orb::Models::SubscriptionCancelResponse::DiscountInterval::Amount, Orb::Models::SubscriptionCancelResponse::DiscountInterval::Percentage, Orb::Models::SubscriptionCancelResponse::DiscountInterval::Usage>] The discount intervals for this subscription sorted by the start_date.
|
245
245
|
#
|
246
246
|
# @param end_date [Time, nil] The date Orb stops billing for this subscription.
|
247
247
|
#
|
@@ -285,7 +285,7 @@ module Orb
|
|
285
285
|
|
286
286
|
# @!attribute adjustment
|
287
287
|
#
|
288
|
-
# @return [Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::
|
288
|
+
# @return [Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::UsageDiscount, Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::AmountDiscount, Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::PercentageDiscount, Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::Minimum, Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::Maximum]
|
289
289
|
required :adjustment,
|
290
290
|
union: -> { Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment }
|
291
291
|
|
@@ -310,7 +310,7 @@ module Orb
|
|
310
310
|
# @!method initialize(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:)
|
311
311
|
# @param id [String]
|
312
312
|
#
|
313
|
-
# @param adjustment [Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::
|
313
|
+
# @param adjustment [Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::UsageDiscount, Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::AmountDiscount, Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::PercentageDiscount, Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::Minimum, Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::Maximum]
|
314
314
|
#
|
315
315
|
# @param applies_to_price_interval_ids [Array<String>] The price interval IDs that this adjustment applies to.
|
316
316
|
#
|
@@ -325,21 +325,19 @@ module Orb
|
|
325
325
|
discriminator :adjustment_type
|
326
326
|
|
327
327
|
variant :usage_discount,
|
328
|
-
-> { Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::
|
328
|
+
-> { Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::UsageDiscount }
|
329
329
|
|
330
330
|
variant :amount_discount,
|
331
|
-
-> { Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::
|
331
|
+
-> { Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::AmountDiscount }
|
332
332
|
|
333
333
|
variant :percentage_discount,
|
334
|
-
-> { Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::
|
334
|
+
-> { Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::PercentageDiscount }
|
335
335
|
|
336
|
-
variant :minimum,
|
337
|
-
-> { Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment }
|
336
|
+
variant :minimum, -> { Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::Minimum }
|
338
337
|
|
339
|
-
variant :maximum,
|
340
|
-
-> { Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment }
|
338
|
+
variant :maximum, -> { Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::Maximum }
|
341
339
|
|
342
|
-
class
|
340
|
+
class UsageDiscount < Orb::Internal::Type::BaseModel
|
343
341
|
# @!attribute id
|
344
342
|
#
|
345
343
|
# @return [String]
|
@@ -384,7 +382,7 @@ module Orb
|
|
384
382
|
|
385
383
|
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, usage_discount:, adjustment_type: :usage_discount)
|
386
384
|
# Some parameter documentations has been truncated, see
|
387
|
-
# {Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::
|
385
|
+
# {Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::UsageDiscount}
|
388
386
|
# for more details.
|
389
387
|
#
|
390
388
|
# @param id [String]
|
@@ -404,7 +402,7 @@ module Orb
|
|
404
402
|
# @param adjustment_type [Symbol, :usage_discount]
|
405
403
|
end
|
406
404
|
|
407
|
-
class
|
405
|
+
class AmountDiscount < Orb::Internal::Type::BaseModel
|
408
406
|
# @!attribute id
|
409
407
|
#
|
410
408
|
# @return [String]
|
@@ -449,7 +447,7 @@ module Orb
|
|
449
447
|
|
450
448
|
# @!method initialize(id:, amount_discount:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, adjustment_type: :amount_discount)
|
451
449
|
# Some parameter documentations has been truncated, see
|
452
|
-
# {Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::
|
450
|
+
# {Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::AmountDiscount}
|
453
451
|
# for more details.
|
454
452
|
#
|
455
453
|
# @param id [String]
|
@@ -469,7 +467,7 @@ module Orb
|
|
469
467
|
# @param adjustment_type [Symbol, :amount_discount]
|
470
468
|
end
|
471
469
|
|
472
|
-
class
|
470
|
+
class PercentageDiscount < Orb::Internal::Type::BaseModel
|
473
471
|
# @!attribute id
|
474
472
|
#
|
475
473
|
# @return [String]
|
@@ -514,7 +512,7 @@ module Orb
|
|
514
512
|
|
515
513
|
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, percentage_discount:, plan_phase_order:, reason:, adjustment_type: :percentage_discount)
|
516
514
|
# Some parameter documentations has been truncated, see
|
517
|
-
# {Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::
|
515
|
+
# {Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::PercentageDiscount}
|
518
516
|
# for more details.
|
519
517
|
#
|
520
518
|
# @param id [String]
|
@@ -534,7 +532,7 @@ module Orb
|
|
534
532
|
# @param adjustment_type [Symbol, :percentage_discount]
|
535
533
|
end
|
536
534
|
|
537
|
-
class
|
535
|
+
class Minimum < Orb::Internal::Type::BaseModel
|
538
536
|
# @!attribute id
|
539
537
|
#
|
540
538
|
# @return [String]
|
@@ -585,7 +583,7 @@ module Orb
|
|
585
583
|
|
586
584
|
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, item_id:, minimum_amount:, plan_phase_order:, reason:, adjustment_type: :minimum)
|
587
585
|
# Some parameter documentations has been truncated, see
|
588
|
-
# {Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::
|
586
|
+
# {Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::Minimum}
|
589
587
|
# for more details.
|
590
588
|
#
|
591
589
|
# @param id [String]
|
@@ -607,7 +605,7 @@ module Orb
|
|
607
605
|
# @param adjustment_type [Symbol, :minimum]
|
608
606
|
end
|
609
607
|
|
610
|
-
class
|
608
|
+
class Maximum < Orb::Internal::Type::BaseModel
|
611
609
|
# @!attribute id
|
612
610
|
#
|
613
611
|
# @return [String]
|
@@ -652,7 +650,7 @@ module Orb
|
|
652
650
|
|
653
651
|
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, maximum_amount:, plan_phase_order:, reason:, adjustment_type: :maximum)
|
654
652
|
# Some parameter documentations has been truncated, see
|
655
|
-
# {Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::
|
653
|
+
# {Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::Maximum}
|
656
654
|
# for more details.
|
657
655
|
#
|
658
656
|
# @param id [String]
|
@@ -673,7 +671,7 @@ module Orb
|
|
673
671
|
end
|
674
672
|
|
675
673
|
# @!method self.variants
|
676
|
-
# @return [Array(Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::
|
674
|
+
# @return [Array(Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::UsageDiscount, Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::AmountDiscount, Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::PercentageDiscount, Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::Minimum, Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::Maximum)]
|
677
675
|
end
|
678
676
|
end
|
679
677
|
|
@@ -723,14 +721,13 @@ module Orb
|
|
723
721
|
|
724
722
|
discriminator :discount_type
|
725
723
|
|
726
|
-
variant :amount, -> { Orb::Models::SubscriptionCancelResponse::DiscountInterval::
|
724
|
+
variant :amount, -> { Orb::Models::SubscriptionCancelResponse::DiscountInterval::Amount }
|
727
725
|
|
728
|
-
variant :percentage,
|
729
|
-
-> { Orb::Models::SubscriptionCancelResponse::DiscountInterval::PercentageDiscountInterval }
|
726
|
+
variant :percentage, -> { Orb::Models::SubscriptionCancelResponse::DiscountInterval::Percentage }
|
730
727
|
|
731
|
-
variant :usage, -> { Orb::Models::SubscriptionCancelResponse::DiscountInterval::
|
728
|
+
variant :usage, -> { Orb::Models::SubscriptionCancelResponse::DiscountInterval::Usage }
|
732
729
|
|
733
|
-
class
|
730
|
+
class Amount < Orb::Internal::Type::BaseModel
|
734
731
|
# @!attribute amount_discount
|
735
732
|
# Only available if discount_type is `amount`.
|
736
733
|
#
|
@@ -780,7 +777,7 @@ module Orb
|
|
780
777
|
# @param discount_type [Symbol, :amount]
|
781
778
|
end
|
782
779
|
|
783
|
-
class
|
780
|
+
class Percentage < Orb::Internal::Type::BaseModel
|
784
781
|
# @!attribute applies_to_price_ids
|
785
782
|
# The price ids that this discount interval applies to.
|
786
783
|
#
|
@@ -819,8 +816,8 @@ module Orb
|
|
819
816
|
|
820
817
|
# @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, percentage_discount:, start_date:, discount_type: :percentage)
|
821
818
|
# Some parameter documentations has been truncated, see
|
822
|
-
# {Orb::Models::SubscriptionCancelResponse::DiscountInterval::
|
823
|
-
#
|
819
|
+
# {Orb::Models::SubscriptionCancelResponse::DiscountInterval::Percentage} for more
|
820
|
+
# details.
|
824
821
|
#
|
825
822
|
# @param applies_to_price_ids [Array<String>] The price ids that this discount interval applies to.
|
826
823
|
#
|
@@ -836,7 +833,7 @@ module Orb
|
|
836
833
|
# @param discount_type [Symbol, :percentage]
|
837
834
|
end
|
838
835
|
|
839
|
-
class
|
836
|
+
class Usage < Orb::Internal::Type::BaseModel
|
840
837
|
# @!attribute applies_to_price_ids
|
841
838
|
# The price ids that this discount interval applies to.
|
842
839
|
#
|
@@ -875,8 +872,8 @@ module Orb
|
|
875
872
|
|
876
873
|
# @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, start_date:, usage_discount:, discount_type: :usage)
|
877
874
|
# Some parameter documentations has been truncated, see
|
878
|
-
# {Orb::Models::SubscriptionCancelResponse::DiscountInterval::
|
879
|
-
#
|
875
|
+
# {Orb::Models::SubscriptionCancelResponse::DiscountInterval::Usage} for more
|
876
|
+
# details.
|
880
877
|
#
|
881
878
|
# @param applies_to_price_ids [Array<String>] The price ids that this discount interval applies to.
|
882
879
|
#
|
@@ -893,7 +890,7 @@ module Orb
|
|
893
890
|
end
|
894
891
|
|
895
892
|
# @!method self.variants
|
896
|
-
# @return [Array(Orb::Models::SubscriptionCancelResponse::DiscountInterval::
|
893
|
+
# @return [Array(Orb::Models::SubscriptionCancelResponse::DiscountInterval::Amount, Orb::Models::SubscriptionCancelResponse::DiscountInterval::Percentage, Orb::Models::SubscriptionCancelResponse::DiscountInterval::Usage)]
|
897
894
|
end
|
898
895
|
|
899
896
|
class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel
|
@@ -1095,7 +1092,7 @@ module Orb
|
|
1095
1092
|
# For more on the types of prices, see
|
1096
1093
|
# [the core concepts documentation](/core-concepts#plan-and-price)
|
1097
1094
|
#
|
1098
|
-
# @return [Orb::Models::Price::
|
1095
|
+
# @return [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]
|
1099
1096
|
required :price, union: -> { Orb::Models::Price }
|
1100
1097
|
|
1101
1098
|
# @!attribute start_date
|
@@ -1138,7 +1135,7 @@ module Orb
|
|
1138
1135
|
# @param fixed_fee_quantity_transitions [Array<Orb::Models::SubscriptionCancelResponse::PriceInterval::FixedFeeQuantityTransition>, nil] The fixed fee quantity transitions for this price interval. This is only relevan
|
1139
1136
|
# ...
|
1140
1137
|
#
|
1141
|
-
# @param price [Orb::Models::Price::
|
1138
|
+
# @param price [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] The Price resource represents a price that can be billed on a subscription, resu
|
1142
1139
|
# ...
|
1143
1140
|
#
|
1144
1141
|
# @param start_date [Time] The start date of the price interval. This is the date that Orb starts billing f
|