orb-billing 0.2.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 +67 -0
- data/README.md +63 -53
- data/lib/orb/client.rb +4 -4
- data/lib/orb/errors.rb +9 -9
- data/lib/orb/file_part.rb +55 -0
- data/lib/orb/internal/page.rb +7 -11
- data/lib/orb/internal/transport/base_client.rb +10 -10
- data/lib/orb/internal/transport/pooled_net_requester.rb +2 -2
- data/lib/orb/internal/type/array_of.rb +11 -0
- data/lib/orb/internal/type/base_model.rb +33 -23
- data/lib/orb/internal/type/base_page.rb +9 -1
- data/lib/orb/internal/type/boolean.rb +14 -11
- data/lib/orb/internal/type/converter.rb +4 -1
- data/lib/orb/internal/type/enum.rb +19 -16
- data/lib/orb/internal/type/{io_like.rb → file_input.rb} +33 -15
- data/lib/orb/internal/type/hash_of.rb +11 -0
- data/lib/orb/internal/type/request_parameters.rb +3 -10
- data/lib/orb/internal/type/union.rb +10 -1
- data/lib/orb/internal/type/unknown.rb +14 -11
- data/lib/orb/internal/util.rb +88 -64
- data/lib/orb/internal.rb +0 -1
- data/lib/orb/models/alert.rb +68 -71
- data/lib/orb/models/alert_create_for_customer_params.rb +20 -25
- data/lib/orb/models/alert_create_for_external_customer_params.rb +20 -25
- data/lib/orb/models/alert_create_for_subscription_params.rb +20 -25
- data/lib/orb/models/alert_disable_params.rb +5 -9
- data/lib/orb/models/alert_enable_params.rb +5 -9
- data/lib/orb/models/alert_list_params.rb +26 -36
- data/lib/orb/models/alert_retrieve_params.rb +3 -8
- data/lib/orb/models/alert_update_params.rb +14 -18
- data/lib/orb/models/amount_discount.rb +14 -14
- data/lib/orb/models/billable_metric.rb +23 -20
- data/lib/orb/models/billing_cycle_relative_date.rb +2 -5
- data/lib/orb/models/coupon.rb +28 -21
- data/lib/orb/models/coupon_archive_params.rb +3 -8
- data/lib/orb/models/coupon_create_params.rb +29 -34
- data/lib/orb/models/coupon_fetch_params.rb +3 -8
- data/lib/orb/models/coupon_list_params.rb +17 -17
- data/lib/orb/models/coupons/subscription_list_params.rb +12 -15
- data/lib/orb/models/credit_note.rb +100 -166
- data/lib/orb/models/credit_note_create_params.rb +15 -23
- data/lib/orb/models/credit_note_fetch_params.rb +3 -8
- data/lib/orb/models/credit_note_list_params.rb +20 -30
- data/lib/orb/models/customer.rb +224 -271
- data/lib/orb/models/customer_create_params.rb +216 -257
- data/lib/orb/models/customer_delete_params.rb +3 -8
- data/lib/orb/models/customer_fetch_by_external_id_params.rb +3 -8
- data/lib/orb/models/customer_fetch_params.rb +3 -8
- data/lib/orb/models/customer_list_params.rb +20 -30
- data/lib/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rb +3 -8
- data/lib/orb/models/customer_sync_payment_methods_from_gateway_params.rb +3 -8
- data/lib/orb/models/customer_update_by_external_id_params.rb +212 -257
- data/lib/orb/models/customer_update_params.rb +212 -255
- data/lib/orb/models/customers/balance_transaction_create_params.rb +11 -16
- data/lib/orb/models/customers/balance_transaction_create_response.rb +33 -51
- data/lib/orb/models/customers/balance_transaction_list_params.rb +20 -30
- data/lib/orb/models/customers/balance_transaction_list_response.rb +33 -51
- data/lib/orb/models/customers/cost_list_by_external_id_params.rb +17 -17
- data/lib/orb/models/customers/cost_list_by_external_id_response.rb +23 -27
- data/lib/orb/models/customers/cost_list_params.rb +17 -17
- data/lib/orb/models/customers/cost_list_response.rb +23 -27
- data/lib/orb/models/customers/credit_list_by_external_id_params.rb +18 -22
- data/lib/orb/models/customers/credit_list_by_external_id_response.rb +10 -17
- data/lib/orb/models/customers/credit_list_params.rb +18 -22
- data/lib/orb/models/customers/credit_list_response.rb +10 -17
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +64 -66
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +384 -491
- data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +63 -66
- data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +384 -498
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +33 -48
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +384 -494
- data/lib/orb/models/customers/credits/ledger_list_params.rb +32 -48
- data/lib/orb/models/customers/credits/ledger_list_response.rb +383 -501
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +47 -50
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb +43 -46
- data/lib/orb/models/customers/credits/top_up_create_params.rb +46 -50
- data/lib/orb/models/customers/credits/top_up_create_response.rb +42 -46
- data/lib/orb/models/customers/credits/top_up_delete_by_external_id_params.rb +4 -9
- data/lib/orb/models/customers/credits/top_up_delete_params.rb +4 -9
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rb +12 -15
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb +43 -46
- data/lib/orb/models/customers/credits/top_up_list_params.rb +12 -15
- data/lib/orb/models/customers/credits/top_up_list_response.rb +42 -46
- data/lib/orb/models/dimensional_price_group.rb +21 -15
- data/lib/orb/models/dimensional_price_group_create_params.rb +17 -23
- data/lib/orb/models/dimensional_price_group_list_params.rb +12 -15
- data/lib/orb/models/dimensional_price_group_retrieve_params.rb +3 -8
- data/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rb +3 -8
- data/lib/orb/models/dimensional_price_groups.rb +3 -7
- data/lib/orb/models/discount.rb +2 -3
- data/lib/orb/models/evaluate_price_group.rb +8 -11
- data/lib/orb/models/event_deprecate_params.rb +3 -8
- data/lib/orb/models/event_deprecate_response.rb +2 -6
- data/lib/orb/models/event_ingest_params.rb +33 -27
- data/lib/orb/models/event_ingest_response.rb +23 -24
- data/lib/orb/models/event_search_params.rb +15 -11
- data/lib/orb/models/event_search_response.rb +27 -22
- data/lib/orb/models/event_update_params.rb +19 -13
- data/lib/orb/models/event_update_response.rb +2 -6
- data/lib/orb/models/events/backfill_close_params.rb +3 -8
- data/lib/orb/models/events/backfill_close_response.rb +34 -39
- data/lib/orb/models/events/backfill_create_params.rb +28 -32
- data/lib/orb/models/events/backfill_create_response.rb +34 -39
- data/lib/orb/models/events/backfill_fetch_params.rb +3 -8
- data/lib/orb/models/events/backfill_fetch_response.rb +34 -39
- data/lib/orb/models/events/backfill_list_params.rb +12 -15
- data/lib/orb/models/events/backfill_list_response.rb +34 -39
- data/lib/orb/models/events/backfill_revert_params.rb +3 -8
- data/lib/orb/models/events/backfill_revert_response.rb +34 -39
- data/lib/orb/models/events/event_volumes.rb +11 -17
- data/lib/orb/models/events/volume_list_params.rb +19 -22
- data/lib/orb/models/invoice.rb +619 -681
- data/lib/orb/models/invoice_create_params.rb +52 -61
- data/lib/orb/models/invoice_fetch_params.rb +3 -8
- data/lib/orb/models/invoice_fetch_upcoming_params.rb +4 -9
- data/lib/orb/models/invoice_fetch_upcoming_response.rb +618 -669
- data/lib/orb/models/invoice_issue_params.rb +10 -14
- data/lib/orb/models/invoice_level_discount.rb +2 -3
- data/lib/orb/models/invoice_line_item_create_params.rb +19 -14
- data/lib/orb/models/invoice_line_item_create_response.rb +281 -306
- data/lib/orb/models/invoice_list_params.rb +51 -66
- data/lib/orb/models/invoice_mark_paid_params.rb +9 -11
- data/lib/orb/models/invoice_pay_params.rb +3 -8
- data/lib/orb/models/invoice_update_params.rb +9 -9
- data/lib/orb/models/invoice_void_params.rb +3 -8
- data/lib/orb/models/item.rb +14 -25
- data/lib/orb/models/item_create_params.rb +5 -9
- data/lib/orb/models/item_fetch_params.rb +3 -8
- data/lib/orb/models/item_list_params.rb +12 -15
- data/lib/orb/models/item_update_params.rb +10 -22
- data/lib/orb/models/metric_create_params.rb +17 -13
- data/lib/orb/models/metric_fetch_params.rb +3 -8
- data/lib/orb/models/metric_list_params.rb +20 -30
- data/lib/orb/models/metric_update_params.rb +9 -9
- data/lib/orb/models/pagination_metadata.rb +3 -7
- data/lib/orb/models/percentage_discount.rb +15 -14
- data/lib/orb/models/plan.rb +259 -291
- data/lib/orb/models/plan_create_params.rb +2070 -2466
- data/lib/orb/models/plan_fetch_params.rb +3 -8
- data/lib/orb/models/plan_list_params.rb +25 -42
- data/lib/orb/models/plan_update_params.rb +12 -10
- data/lib/orb/models/plans/external_plan_id_fetch_params.rb +3 -8
- data/lib/orb/models/plans/external_plan_id_update_params.rb +12 -10
- data/lib/orb/models/price.rb +3842 -5005
- data/lib/orb/models/price_create_params.rb +203 -244
- data/lib/orb/models/price_evaluate_params.rb +21 -30
- data/lib/orb/models/price_evaluate_response.rb +2 -6
- data/lib/orb/models/price_fetch_params.rb +3 -8
- data/lib/orb/models/price_list_params.rb +12 -15
- data/lib/orb/models/price_update_params.rb +9 -9
- data/lib/orb/models/prices/external_price_id_fetch_params.rb +3 -8
- data/lib/orb/models/prices/external_price_id_update_params.rb +9 -9
- data/lib/orb/models/subscription.rb +360 -405
- data/lib/orb/models/subscription_cancel_params.rb +16 -16
- data/lib/orb/models/subscription_cancel_response.rb +358 -399
- data/lib/orb/models/subscription_change_apply_params.rb +7 -10
- data/lib/orb/models/subscription_change_apply_response.rb +384 -418
- data/lib/orb/models/subscription_change_cancel_params.rb +3 -8
- data/lib/orb/models/subscription_change_cancel_response.rb +384 -417
- data/lib/orb/models/subscription_change_retrieve_params.rb +3 -8
- data/lib/orb/models/subscription_change_retrieve_response.rb +385 -417
- data/lib/orb/models/subscription_create_params.rb +4735 -5417
- data/lib/orb/models/subscription_create_response.rb +358 -399
- data/lib/orb/models/subscription_fetch_costs_params.rb +17 -17
- data/lib/orb/models/subscription_fetch_costs_response.rb +23 -27
- data/lib/orb/models/subscription_fetch_params.rb +3 -8
- data/lib/orb/models/subscription_fetch_schedule_params.rb +20 -30
- data/lib/orb/models/subscription_fetch_schedule_response.rb +15 -17
- data/lib/orb/models/subscription_fetch_usage_params.rb +32 -43
- data/lib/orb/models/subscription_list_params.rb +28 -41
- data/lib/orb/models/subscription_price_intervals_params.rb +2560 -3040
- data/lib/orb/models/subscription_price_intervals_response.rb +361 -399
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +4728 -5411
- data/lib/orb/models/subscription_schedule_plan_change_response.rb +361 -398
- data/lib/orb/models/subscription_trigger_phase_params.rb +12 -10
- data/lib/orb/models/subscription_trigger_phase_response.rb +360 -399
- data/lib/orb/models/subscription_unschedule_cancellation_params.rb +3 -8
- data/lib/orb/models/subscription_unschedule_cancellation_response.rb +361 -398
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rb +5 -9
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +362 -396
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_params.rb +3 -8
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +362 -396
- data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +22 -33
- data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +361 -398
- data/lib/orb/models/subscription_update_params.rb +21 -23
- data/lib/orb/models/subscription_update_trial_params.rb +15 -18
- data/lib/orb/models/subscription_update_trial_response.rb +360 -399
- data/lib/orb/models/subscription_usage.rb +37 -80
- data/lib/orb/models/subscriptions.rb +3 -7
- data/lib/orb/models/top_level_ping_params.rb +3 -8
- data/lib/orb/models/top_level_ping_response.rb +2 -6
- data/lib/orb/models/trial_discount.rb +16 -24
- data/lib/orb/models/usage_discount.rb +15 -14
- data/lib/orb/models.rb +220 -0
- data/lib/orb/request_options.rb +4 -6
- data/lib/orb/resources/alerts.rb +48 -17
- data/lib/orb/resources/coupons/subscriptions.rb +9 -2
- data/lib/orb/resources/coupons.rb +26 -8
- data/lib/orb/resources/credit_notes.rb +17 -4
- data/lib/orb/resources/customers/balance_transactions.rb +18 -3
- data/lib/orb/resources/customers/costs.rb +26 -8
- data/lib/orb/resources/customers/credits/ledger.rb +112 -32
- data/lib/orb/resources/customers/credits/top_ups.rb +67 -20
- data/lib/orb/resources/customers/credits.rb +28 -8
- data/lib/orb/resources/customers.rb +138 -39
- data/lib/orb/resources/dimensional_price_groups.rb +19 -4
- data/lib/orb/resources/events/backfills.rb +32 -9
- data/lib/orb/resources/events/volume.rb +14 -4
- data/lib/orb/resources/events.rb +40 -11
- data/lib/orb/resources/invoice_line_items.rb +16 -6
- data/lib/orb/resources/invoices.rb +77 -17
- data/lib/orb/resources/items.rb +10 -3
- data/lib/orb/resources/metrics.rb +33 -8
- data/lib/orb/resources/plans/external_plan_id.rb +10 -2
- data/lib/orb/resources/plans.rb +47 -11
- data/lib/orb/resources/prices/external_price_id.rb +9 -3
- data/lib/orb/resources/prices.rb +101 -26
- data/lib/orb/resources/subscription_changes.rb +5 -2
- data/lib/orb/resources/subscriptions.rb +292 -78
- data/lib/orb/version.rb +1 -1
- data/lib/orb.rb +2 -10
- data/rbi/{lib/orb → orb}/client.rbi +4 -4
- data/rbi/{lib/orb → orb}/errors.rbi +1 -1
- data/rbi/orb/file_part.rbi +34 -0
- data/rbi/{lib/orb → orb}/internal/transport/base_client.rbi +19 -5
- data/rbi/{lib/orb → orb}/internal/type/array_of.rbi +3 -0
- data/rbi/{lib/orb → orb}/internal/type/base_model.rbi +7 -1
- data/rbi/{lib/orb → orb}/internal/type/base_page.rbi +2 -0
- data/rbi/{lib/orb → orb}/internal/type/enum.rbi +3 -6
- data/rbi/{lib/orb/internal/type/io_like.rbi → orb/internal/type/file_input.rbi} +5 -2
- data/rbi/{lib/orb → orb}/internal/type/hash_of.rbi +3 -0
- data/rbi/{lib/orb → orb}/internal/type/request_parameters.rbi +1 -1
- data/rbi/{lib/orb → orb}/internal/type/union.rbi +3 -0
- data/rbi/{lib/orb → orb}/internal/util.rbi +28 -19
- data/rbi/{lib/orb → orb}/internal.rbi +0 -1
- data/rbi/{lib/orb → orb}/models/alert.rbi +28 -8
- data/rbi/{lib/orb → orb}/models/alert_create_for_customer_params.rbi +16 -6
- data/rbi/{lib/orb → orb}/models/alert_create_for_external_customer_params.rbi +16 -6
- data/rbi/{lib/orb → orb}/models/alert_create_for_subscription_params.rbi +16 -6
- data/rbi/{lib/orb → orb}/models/alert_disable_params.rbi +5 -2
- data/rbi/{lib/orb → orb}/models/alert_enable_params.rbi +5 -2
- data/rbi/{lib/orb → orb}/models/alert_list_params.rbi +6 -0
- data/rbi/{lib/orb → orb}/models/alert_update_params.rbi +11 -4
- data/rbi/{lib/orb → orb}/models/amount_discount.rbi +10 -4
- data/rbi/{lib/orb → orb}/models/billable_metric.rbi +16 -3
- data/rbi/{lib/orb → orb}/models/billing_cycle_relative_date.rbi +1 -1
- data/rbi/{lib/orb → orb}/models/coupon.rbi +10 -3
- data/rbi/{lib/orb → orb}/models/coupon_create_params.rbi +15 -12
- data/rbi/{lib/orb → orb}/models/coupon_list_params.rbi +13 -3
- data/rbi/{lib/orb → orb}/models/coupons/subscription_list_params.rbi +8 -2
- data/rbi/{lib/orb → orb}/models/credit_note.rbi +44 -12
- data/rbi/{lib/orb → orb}/models/credit_note_create_params.rbi +15 -6
- data/rbi/{lib/orb → orb}/models/credit_note_list_params.rbi +3 -0
- data/rbi/{lib/orb → orb}/models/customer.rbi +130 -11
- data/rbi/{lib/orb → orb}/models/customer_create_params.rbi +151 -17
- data/rbi/{lib/orb → orb}/models/customer_list_params.rbi +3 -0
- data/rbi/{lib/orb → orb}/models/customer_update_by_external_id_params.rbi +149 -17
- data/rbi/{lib/orb → orb}/models/customer_update_params.rbi +149 -17
- data/rbi/{lib/orb → orb}/models/customers/balance_transaction_create_params.rbi +8 -4
- data/rbi/{lib/orb → orb}/models/customers/balance_transaction_create_response.rbi +18 -8
- data/rbi/{lib/orb → orb}/models/customers/balance_transaction_list_params.rbi +3 -0
- data/rbi/{lib/orb → orb}/models/customers/balance_transaction_list_response.rbi +18 -8
- data/rbi/{lib/orb → orb}/models/customers/cost_list_by_external_id_params.rbi +9 -5
- data/rbi/orb/models/customers/cost_list_by_external_id_response.rbi +225 -0
- data/rbi/{lib/orb → orb}/models/customers/cost_list_params.rbi +9 -5
- data/rbi/orb/models/customers/cost_list_response.rbi +223 -0
- data/rbi/{lib/orb → orb}/models/customers/credit_list_by_external_id_params.rbi +13 -3
- data/rbi/{lib/orb → orb}/models/customers/credit_list_by_external_id_response.rbi +1 -2
- data/rbi/{lib/orb → orb}/models/customers/credit_list_params.rbi +13 -3
- data/rbi/{lib/orb → orb}/models/customers/credit_list_response.rbi +1 -2
- data/rbi/{lib/orb → orb}/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +40 -18
- data/rbi/{lib/orb/models/customers/credits/ledger_create_entry_response.rbi → orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi} +157 -170
- data/rbi/{lib/orb → orb}/models/customers/credits/ledger_create_entry_params.rbi +40 -6
- data/rbi/{lib/orb/models/customers/credits/ledger_list_response.rbi → orb/models/customers/credits/ledger_create_entry_response.rbi} +149 -196
- data/rbi/{lib/orb → orb}/models/customers/credits/ledger_list_by_external_id_params.rbi +6 -16
- data/rbi/{lib/orb → orb}/models/customers/credits/ledger_list_by_external_id_response.rbi +148 -229
- data/rbi/{lib/orb → orb}/models/customers/credits/ledger_list_params.rbi +6 -4
- data/rbi/{lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi → orb/models/customers/credits/ledger_list_response.rbi} +149 -343
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_by_external_id_params.rbi +27 -10
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_by_external_id_response.rbi +25 -10
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_params.rbi +27 -4
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_response.rbi +25 -10
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_by_external_id_params.rbi +8 -2
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_by_external_id_response.rbi +25 -10
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_params.rbi +8 -2
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_response.rbi +25 -4
- data/rbi/{lib/orb → orb}/models/dimensional_price_group.rbi +11 -3
- data/rbi/{lib/orb → orb}/models/dimensional_price_group_create_params.rbi +4 -0
- data/rbi/{lib/orb → orb}/models/dimensional_price_group_list_params.rbi +8 -2
- data/rbi/{lib/orb → orb}/models/evaluate_price_group.rbi +8 -2
- data/rbi/{lib/orb → orb}/models/event_deprecate_response.rbi +4 -2
- data/rbi/{lib/orb → orb}/models/event_ingest_params.rbi +22 -5
- data/rbi/{lib/orb → orb}/models/event_ingest_response.rbi +15 -4
- data/rbi/{lib/orb → orb}/models/event_search_params.rbi +14 -2
- data/rbi/{lib/orb → orb}/models/event_search_response.rbi +14 -3
- data/rbi/{lib/orb → orb}/models/event_update_params.rbi +10 -3
- data/rbi/{lib/orb → orb}/models/event_update_response.rbi +4 -2
- data/rbi/{lib/orb → orb}/models/events/backfill_close_response.rbi +14 -2
- data/rbi/{lib/orb → orb}/models/events/backfill_create_params.rbi +18 -0
- data/rbi/{lib/orb → orb}/models/events/backfill_create_response.rbi +14 -2
- data/rbi/{lib/orb → orb}/models/events/backfill_fetch_response.rbi +14 -2
- data/rbi/{lib/orb → orb}/models/events/backfill_list_params.rbi +8 -2
- data/rbi/{lib/orb → orb}/models/events/backfill_list_response.rbi +14 -2
- data/rbi/{lib/orb → orb}/models/events/backfill_revert_response.rbi +14 -2
- data/rbi/{lib/orb → orb}/models/events/event_volumes.rbi +8 -4
- data/rbi/{lib/orb → orb}/models/events/volume_list_params.rbi +18 -2
- data/rbi/{lib/orb → orb}/models/invoice.rbi +513 -202
- data/rbi/{lib/orb → orb}/models/invoice_create_params.rbi +38 -6
- data/rbi/{lib/orb → orb}/models/invoice_fetch_upcoming_response.rbi +513 -216
- data/rbi/{lib/orb → orb}/models/invoice_issue_params.rbi +9 -2
- data/rbi/{lib/orb → orb}/models/invoice_line_item_create_params.rbi +16 -2
- data/rbi/{lib/orb → orb}/models/invoice_line_item_create_response.rbi +279 -182
- data/rbi/{lib/orb → orb}/models/invoice_list_params.rbi +9 -2
- data/rbi/{lib/orb → orb}/models/invoice_mark_paid_params.rbi +9 -2
- data/rbi/{lib/orb → orb}/models/invoice_update_params.rbi +7 -2
- data/rbi/{lib/orb → orb}/models/item.rbi +1 -2
- data/rbi/{lib/orb → orb}/models/item_create_params.rbi +5 -2
- data/rbi/{lib/orb → orb}/models/item_list_params.rbi +8 -2
- data/rbi/{lib/orb → orb}/models/item_update_params.rbi +1 -8
- data/rbi/{lib/orb → orb}/models/metric_create_params.rbi +15 -2
- data/rbi/{lib/orb → orb}/models/metric_list_params.rbi +3 -0
- data/rbi/{lib/orb → orb}/models/metric_update_params.rbi +7 -2
- data/rbi/{lib/orb → orb}/models/percentage_discount.rbi +11 -4
- data/rbi/{lib/orb → orb}/models/plan.rbi +207 -120
- data/rbi/{lib/orb → orb}/models/plan_create_params.rbi +1971 -2414
- data/rbi/{lib/orb → orb}/models/plan_list_params.rbi +5 -1
- data/rbi/{lib/orb → orb}/models/plan_update_params.rbi +11 -2
- data/rbi/{lib/orb → orb}/models/plans/external_plan_id_update_params.rbi +11 -2
- data/rbi/{lib/orb → orb}/models/price.rbi +2594 -2957
- data/rbi/{lib/orb → orb}/models/price_create_params.rbi +137 -53
- data/rbi/{lib/orb → orb}/models/price_evaluate_params.rbi +10 -0
- data/rbi/{lib/orb → orb}/models/price_list_params.rbi +8 -2
- data/rbi/{lib/orb → orb}/models/price_update_params.rbi +7 -2
- data/rbi/{lib/orb → orb}/models/prices/external_price_id_update_params.rbi +7 -2
- data/rbi/{lib/orb → orb}/models/subscription.rbi +292 -129
- data/rbi/{lib/orb → orb}/models/subscription_cancel_params.rbi +8 -5
- data/rbi/{lib/orb → orb}/models/subscription_cancel_response.rbi +305 -132
- data/rbi/{lib/orb → orb}/models/subscription_change_apply_params.rbi +7 -2
- data/rbi/{lib/orb → orb}/models/subscription_change_apply_response.rbi +317 -136
- data/rbi/{lib/orb → orb}/models/subscription_change_cancel_response.rbi +317 -136
- data/rbi/{lib/orb → orb}/models/subscription_change_retrieve_response.rbi +317 -136
- data/rbi/{lib/orb → orb}/models/subscription_create_params.rbi +4271 -4270
- data/rbi/{lib/orb → orb}/models/subscription_create_response.rbi +305 -132
- data/rbi/{lib/orb → orb}/models/subscription_fetch_costs_params.rbi +9 -5
- data/rbi/orb/models/subscription_fetch_costs_response.rbi +221 -0
- data/rbi/{lib/orb → orb}/models/subscription_fetch_schedule_params.rbi +3 -0
- data/rbi/{lib/orb → orb}/models/subscription_fetch_schedule_response.rbi +8 -2
- data/rbi/{lib/orb → orb}/models/subscription_fetch_usage_params.rbi +13 -4
- data/rbi/{lib/orb → orb}/models/subscription_list_params.rbi +4 -2
- data/rbi/{lib/orb → orb}/models/subscription_price_intervals_params.rbi +2354 -2317
- data/rbi/{lib/orb → orb}/models/subscription_price_intervals_response.rbi +305 -132
- data/rbi/{lib/orb → orb}/models/subscription_schedule_plan_change_params.rbi +4280 -3758
- data/rbi/{lib/orb → orb}/models/subscription_schedule_plan_change_response.rbi +305 -132
- data/rbi/{lib/orb → orb}/models/subscription_trigger_phase_params.rbi +10 -2
- data/rbi/{lib/orb → orb}/models/subscription_trigger_phase_response.rbi +305 -132
- data/rbi/{lib/orb → orb}/models/subscription_unschedule_cancellation_response.rbi +305 -132
- data/rbi/{lib/orb → orb}/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +5 -2
- data/rbi/{lib/orb → orb}/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +305 -138
- data/rbi/{lib/orb → orb}/models/subscription_unschedule_pending_plan_changes_response.rbi +305 -132
- data/rbi/{lib/orb → orb}/models/subscription_update_fixed_fee_quantity_params.rbi +11 -2
- data/rbi/{lib/orb → orb}/models/subscription_update_fixed_fee_quantity_response.rbi +305 -132
- data/rbi/{lib/orb → orb}/models/subscription_update_params.rbi +15 -0
- data/rbi/{lib/orb → orb}/models/subscription_update_trial_params.rbi +11 -5
- data/rbi/{lib/orb → orb}/models/subscription_update_trial_response.rbi +305 -132
- data/rbi/{lib/orb → orb}/models/subscription_usage.rbi +2 -16
- data/rbi/{lib/orb → orb}/models/trial_discount.rbi +5 -1
- data/rbi/{lib/orb → orb}/models/usage_discount.rbi +11 -3
- 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/file_part.rbs +21 -0
- data/sig/orb/internal/transport/base_client.rbs +9 -3
- data/sig/orb/internal/type/array_of.rbs +2 -0
- data/sig/orb/internal/type/base_model.rbs +4 -0
- data/sig/orb/internal/type/enum.rbs +2 -2
- data/sig/orb/internal/type/{io_like.rbs → file_input.rbs} +1 -1
- data/sig/orb/internal/type/hash_of.rbs +2 -0
- data/sig/orb/internal/type/union.rbs +2 -0
- data/sig/orb/internal/util.rbs +16 -12
- 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 +230 -224
- data/rbi/lib/orb/models/customers/cost_list_by_external_id_response.rbi +0 -208
- data/rbi/lib/orb/models/customers/cost_list_response.rbi +0 -206
- data/rbi/lib/orb/models/subscription_fetch_costs_response.rbi +0 -204
- data/rbi/lib/orb/resources/prices/external_price_id.rbi +0 -106
- /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/boolean.rbi +0 -0
- /data/rbi/{lib/orb → orb}/internal/type/converter.rbi +0 -0
- /data/rbi/{lib/orb → orb}/internal/type/unknown.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/alert_retrieve_params.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/credit_note_fetch_params.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_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/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/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/event_deprecate_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/events/backfill_close_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/events/backfill_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/events/backfill_revert_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_level_discount.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_pay_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_void_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/item_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/metric_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/pagination_metadata.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/plan_fetch_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/price_evaluate_response.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/price_fetch_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/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_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_pending_plan_changes_params.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}/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::SubscriptionTriggerPhaseResponse::DiscountInterval::
|
104
|
+
# @return [Array<Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::Amount, Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::Percentage, Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::Usage>]
|
105
105
|
required :discount_intervals,
|
106
106
|
-> { Orb::Internal::Type::ArrayOf[union: Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval] }
|
107
107
|
|
@@ -211,69 +211,75 @@ module Orb
|
|
211
211
|
-> { Orb::Models::SubscriptionTriggerPhaseResponse::ChangedResources },
|
212
212
|
nil?: true
|
213
213
|
|
214
|
-
# @!
|
215
|
-
#
|
216
|
-
#
|
217
|
-
#
|
218
|
-
#
|
219
|
-
#
|
220
|
-
#
|
221
|
-
#
|
222
|
-
#
|
223
|
-
#
|
224
|
-
#
|
225
|
-
#
|
226
|
-
#
|
227
|
-
#
|
228
|
-
#
|
229
|
-
#
|
230
|
-
#
|
231
|
-
#
|
232
|
-
#
|
233
|
-
#
|
234
|
-
#
|
235
|
-
#
|
236
|
-
#
|
237
|
-
#
|
238
|
-
#
|
239
|
-
#
|
240
|
-
#
|
241
|
-
#
|
242
|
-
#
|
243
|
-
#
|
244
|
-
#
|
245
|
-
#
|
246
|
-
#
|
247
|
-
#
|
248
|
-
#
|
249
|
-
#
|
250
|
-
#
|
251
|
-
#
|
252
|
-
#
|
253
|
-
#
|
254
|
-
#
|
255
|
-
#
|
256
|
-
#
|
257
|
-
#
|
258
|
-
#
|
259
|
-
#
|
260
|
-
#
|
261
|
-
#
|
262
|
-
#
|
263
|
-
#
|
264
|
-
#
|
265
|
-
#
|
266
|
-
#
|
267
|
-
#
|
268
|
-
#
|
269
|
-
#
|
270
|
-
#
|
271
|
-
#
|
272
|
-
#
|
273
|
-
#
|
274
|
-
#
|
275
|
-
|
276
|
-
#
|
214
|
+
# @!method initialize(id:, active_plan_phase_order:, adjustment_intervals:, auto_collection:, billing_cycle_anchor_configuration:, billing_cycle_day:, created_at:, current_billing_period_end_date:, current_billing_period_start_date:, customer:, default_invoice_memo:, discount_intervals:, end_date:, fixed_fee_quantity_schedule:, invoicing_threshold:, maximum_intervals:, metadata:, minimum_intervals:, net_terms:, pending_subscription_change:, plan:, price_intervals:, redeemed_coupon:, start_date:, status:, trial_info:, changed_resources: nil)
|
215
|
+
# Some parameter documentations has been truncated, see
|
216
|
+
# {Orb::Models::SubscriptionTriggerPhaseResponse} for more details.
|
217
|
+
#
|
218
|
+
# @param id [String]
|
219
|
+
#
|
220
|
+
# @param active_plan_phase_order [Integer, nil] The current plan phase that is active, only if the subscription's plan has phase
|
221
|
+
# ...
|
222
|
+
#
|
223
|
+
# @param adjustment_intervals [Array<Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval>] The adjustment intervals for this subscription sorted by the start_date of the a
|
224
|
+
# ...
|
225
|
+
#
|
226
|
+
# @param auto_collection [Boolean, nil] Determines whether issued invoices for this subscription will automatically be c
|
227
|
+
# ...
|
228
|
+
#
|
229
|
+
# @param billing_cycle_anchor_configuration [Orb::Models::SubscriptionTriggerPhaseResponse::BillingCycleAnchorConfiguration]
|
230
|
+
#
|
231
|
+
# @param billing_cycle_day [Integer] The day of the month on which the billing cycle is anchored. If the maximum numb
|
232
|
+
# ...
|
233
|
+
#
|
234
|
+
# @param created_at [Time]
|
235
|
+
#
|
236
|
+
# @param current_billing_period_end_date [Time, nil] The end of the current billing period. This is an exclusive timestamp, such that
|
237
|
+
# ...
|
238
|
+
#
|
239
|
+
# @param current_billing_period_start_date [Time, nil] The start date of the current billing period. This is an inclusive timestamp; th
|
240
|
+
# ...
|
241
|
+
#
|
242
|
+
# @param customer [Orb::Models::Customer] A customer is a buyer of your products, and the other party to the billing relat
|
243
|
+
# ...
|
244
|
+
#
|
245
|
+
# @param default_invoice_memo [String, nil] Determines the default memo on this subscriptions' invoices. Note that if this i
|
246
|
+
# ...
|
247
|
+
#
|
248
|
+
# @param discount_intervals [Array<Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::Amount, Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::Percentage, Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::Usage>] The discount intervals for this subscription sorted by the start_date.
|
249
|
+
#
|
250
|
+
# @param end_date [Time, nil] The date Orb stops billing for this subscription.
|
251
|
+
#
|
252
|
+
# @param fixed_fee_quantity_schedule [Array<Orb::Models::SubscriptionTriggerPhaseResponse::FixedFeeQuantitySchedule>]
|
253
|
+
#
|
254
|
+
# @param invoicing_threshold [String, nil]
|
255
|
+
#
|
256
|
+
# @param maximum_intervals [Array<Orb::Models::SubscriptionTriggerPhaseResponse::MaximumInterval>] The maximum intervals for this subscription sorted by the start_date.
|
257
|
+
#
|
258
|
+
# @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
|
259
|
+
# ...
|
260
|
+
#
|
261
|
+
# @param minimum_intervals [Array<Orb::Models::SubscriptionTriggerPhaseResponse::MinimumInterval>] The minimum intervals for this subscription sorted by the start_date.
|
262
|
+
#
|
263
|
+
# @param net_terms [Integer] Determines the difference between the invoice issue date for subscription invoic
|
264
|
+
# ...
|
265
|
+
#
|
266
|
+
# @param pending_subscription_change [Orb::Models::SubscriptionTriggerPhaseResponse::PendingSubscriptionChange, nil] A pending subscription change if one exists on this subscription.
|
267
|
+
#
|
268
|
+
# @param plan [Orb::Models::Plan] The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
|
269
|
+
# ...
|
270
|
+
#
|
271
|
+
# @param price_intervals [Array<Orb::Models::SubscriptionTriggerPhaseResponse::PriceInterval>] The price intervals for this subscription.
|
272
|
+
#
|
273
|
+
# @param redeemed_coupon [Orb::Models::SubscriptionTriggerPhaseResponse::RedeemedCoupon, nil]
|
274
|
+
#
|
275
|
+
# @param start_date [Time] The date Orb starts billing for this subscription.
|
276
|
+
#
|
277
|
+
# @param status [Symbol, Orb::Models::SubscriptionTriggerPhaseResponse::Status]
|
278
|
+
#
|
279
|
+
# @param trial_info [Orb::Models::SubscriptionTriggerPhaseResponse::TrialInfo]
|
280
|
+
#
|
281
|
+
# @param changed_resources [Orb::Models::SubscriptionTriggerPhaseResponse::ChangedResources, nil] The resources that were changed as part of this operation. Only present when fet
|
282
|
+
# ...
|
277
283
|
|
278
284
|
class AdjustmentInterval < Orb::Internal::Type::BaseModel
|
279
285
|
# @!attribute id
|
@@ -283,7 +289,7 @@ module Orb
|
|
283
289
|
|
284
290
|
# @!attribute adjustment
|
285
291
|
#
|
286
|
-
# @return [Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::
|
292
|
+
# @return [Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::UsageDiscount, Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::AmountDiscount, Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::PercentageDiscount, Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::Minimum, Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::Maximum]
|
287
293
|
required :adjustment,
|
288
294
|
union: -> { Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment }
|
289
295
|
|
@@ -305,16 +311,16 @@ module Orb
|
|
305
311
|
# @return [Time]
|
306
312
|
required :start_date, Time
|
307
313
|
|
308
|
-
# @!
|
309
|
-
#
|
310
|
-
#
|
311
|
-
#
|
312
|
-
#
|
313
|
-
#
|
314
|
-
#
|
315
|
-
#
|
316
|
-
|
317
|
-
#
|
314
|
+
# @!method initialize(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:)
|
315
|
+
# @param id [String]
|
316
|
+
#
|
317
|
+
# @param adjustment [Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::UsageDiscount, Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::AmountDiscount, Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::PercentageDiscount, Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::Minimum, Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::Maximum]
|
318
|
+
#
|
319
|
+
# @param applies_to_price_interval_ids [Array<String>] The price interval IDs that this adjustment applies to.
|
320
|
+
#
|
321
|
+
# @param end_date [Time, nil] The end date of the adjustment interval.
|
322
|
+
#
|
323
|
+
# @param start_date [Time] The start date of the adjustment interval.
|
318
324
|
|
319
325
|
# @see Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval#adjustment
|
320
326
|
module Adjustment
|
@@ -323,21 +329,21 @@ module Orb
|
|
323
329
|
discriminator :adjustment_type
|
324
330
|
|
325
331
|
variant :usage_discount,
|
326
|
-
-> { Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::
|
332
|
+
-> { Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::UsageDiscount }
|
327
333
|
|
328
334
|
variant :amount_discount,
|
329
|
-
-> { Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::
|
335
|
+
-> { Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::AmountDiscount }
|
330
336
|
|
331
337
|
variant :percentage_discount,
|
332
|
-
-> { Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::
|
338
|
+
-> { Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::PercentageDiscount }
|
333
339
|
|
334
340
|
variant :minimum,
|
335
|
-
-> { Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::
|
341
|
+
-> { Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::Minimum }
|
336
342
|
|
337
343
|
variant :maximum,
|
338
|
-
-> { Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::
|
344
|
+
-> { Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::Maximum }
|
339
345
|
|
340
|
-
class
|
346
|
+
class UsageDiscount < Orb::Internal::Type::BaseModel
|
341
347
|
# @!attribute id
|
342
348
|
#
|
343
349
|
# @return [String]
|
@@ -380,32 +386,29 @@ module Orb
|
|
380
386
|
# @return [Float]
|
381
387
|
required :usage_discount, Float
|
382
388
|
|
383
|
-
# @!
|
384
|
-
#
|
385
|
-
#
|
386
|
-
#
|
387
|
-
#
|
388
|
-
#
|
389
|
-
#
|
390
|
-
#
|
391
|
-
#
|
392
|
-
#
|
393
|
-
#
|
394
|
-
#
|
395
|
-
#
|
396
|
-
#
|
397
|
-
#
|
398
|
-
#
|
399
|
-
#
|
400
|
-
#
|
401
|
-
#
|
402
|
-
#
|
403
|
-
# end
|
404
|
-
|
405
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
389
|
+
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, usage_discount:, adjustment_type: :usage_discount)
|
390
|
+
# Some parameter documentations has been truncated, see
|
391
|
+
# {Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::UsageDiscount}
|
392
|
+
# for more details.
|
393
|
+
#
|
394
|
+
# @param id [String]
|
395
|
+
#
|
396
|
+
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
397
|
+
#
|
398
|
+
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
399
|
+
# ...
|
400
|
+
#
|
401
|
+
# @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
|
402
|
+
#
|
403
|
+
# @param reason [String, nil] The reason for the adjustment.
|
404
|
+
#
|
405
|
+
# @param usage_discount [Float] The number of usage units by which to discount the price this adjustment applies
|
406
|
+
# ...
|
407
|
+
#
|
408
|
+
# @param adjustment_type [Symbol, :usage_discount]
|
406
409
|
end
|
407
410
|
|
408
|
-
class
|
411
|
+
class AmountDiscount < Orb::Internal::Type::BaseModel
|
409
412
|
# @!attribute id
|
410
413
|
#
|
411
414
|
# @return [String]
|
@@ -448,32 +451,29 @@ module Orb
|
|
448
451
|
# @return [String, nil]
|
449
452
|
required :reason, String, nil?: true
|
450
453
|
|
451
|
-
# @!
|
452
|
-
#
|
453
|
-
#
|
454
|
-
#
|
455
|
-
#
|
456
|
-
#
|
457
|
-
#
|
458
|
-
#
|
459
|
-
#
|
460
|
-
#
|
461
|
-
#
|
462
|
-
#
|
463
|
-
#
|
464
|
-
#
|
465
|
-
#
|
466
|
-
#
|
467
|
-
#
|
468
|
-
#
|
469
|
-
#
|
470
|
-
#
|
471
|
-
# end
|
472
|
-
|
473
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
454
|
+
# @!method initialize(id:, amount_discount:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, adjustment_type: :amount_discount)
|
455
|
+
# Some parameter documentations has been truncated, see
|
456
|
+
# {Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::AmountDiscount}
|
457
|
+
# for more details.
|
458
|
+
#
|
459
|
+
# @param id [String]
|
460
|
+
#
|
461
|
+
# @param amount_discount [String] The amount by which to discount the prices this adjustment applies to in a given
|
462
|
+
# ...
|
463
|
+
#
|
464
|
+
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
465
|
+
#
|
466
|
+
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
467
|
+
# ...
|
468
|
+
#
|
469
|
+
# @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
|
470
|
+
#
|
471
|
+
# @param reason [String, nil] The reason for the adjustment.
|
472
|
+
#
|
473
|
+
# @param adjustment_type [Symbol, :amount_discount]
|
474
474
|
end
|
475
475
|
|
476
|
-
class
|
476
|
+
class PercentageDiscount < Orb::Internal::Type::BaseModel
|
477
477
|
# @!attribute id
|
478
478
|
#
|
479
479
|
# @return [String]
|
@@ -516,32 +516,29 @@ module Orb
|
|
516
516
|
# @return [String, nil]
|
517
517
|
required :reason, String, nil?: true
|
518
518
|
|
519
|
-
# @!
|
520
|
-
#
|
521
|
-
#
|
522
|
-
#
|
523
|
-
#
|
524
|
-
#
|
525
|
-
#
|
526
|
-
#
|
527
|
-
#
|
528
|
-
#
|
529
|
-
#
|
530
|
-
#
|
531
|
-
#
|
532
|
-
#
|
533
|
-
#
|
534
|
-
#
|
535
|
-
#
|
536
|
-
#
|
537
|
-
#
|
538
|
-
#
|
539
|
-
# end
|
540
|
-
|
541
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
519
|
+
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, percentage_discount:, plan_phase_order:, reason:, adjustment_type: :percentage_discount)
|
520
|
+
# Some parameter documentations has been truncated, see
|
521
|
+
# {Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::PercentageDiscount}
|
522
|
+
# for more details.
|
523
|
+
#
|
524
|
+
# @param id [String]
|
525
|
+
#
|
526
|
+
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
527
|
+
#
|
528
|
+
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
529
|
+
# ...
|
530
|
+
#
|
531
|
+
# @param percentage_discount [Float] The percentage (as a value between 0 and 1) by which to discount the price inter
|
532
|
+
# ...
|
533
|
+
#
|
534
|
+
# @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
|
535
|
+
#
|
536
|
+
# @param reason [String, nil] The reason for the adjustment.
|
537
|
+
#
|
538
|
+
# @param adjustment_type [Symbol, :percentage_discount]
|
542
539
|
end
|
543
540
|
|
544
|
-
class
|
541
|
+
class Minimum < Orb::Internal::Type::BaseModel
|
545
542
|
# @!attribute id
|
546
543
|
#
|
547
544
|
# @return [String]
|
@@ -590,34 +587,31 @@ module Orb
|
|
590
587
|
# @return [String, nil]
|
591
588
|
required :reason, String, nil?: true
|
592
589
|
|
593
|
-
# @!
|
594
|
-
#
|
595
|
-
#
|
596
|
-
#
|
597
|
-
#
|
598
|
-
#
|
599
|
-
#
|
600
|
-
#
|
601
|
-
#
|
602
|
-
#
|
603
|
-
#
|
604
|
-
#
|
605
|
-
#
|
606
|
-
#
|
607
|
-
#
|
608
|
-
#
|
609
|
-
#
|
610
|
-
#
|
611
|
-
#
|
612
|
-
#
|
613
|
-
#
|
614
|
-
#
|
615
|
-
# end
|
616
|
-
|
617
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
590
|
+
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, item_id:, minimum_amount:, plan_phase_order:, reason:, adjustment_type: :minimum)
|
591
|
+
# Some parameter documentations has been truncated, see
|
592
|
+
# {Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::Minimum}
|
593
|
+
# for more details.
|
594
|
+
#
|
595
|
+
# @param id [String]
|
596
|
+
#
|
597
|
+
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
598
|
+
#
|
599
|
+
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
600
|
+
# ...
|
601
|
+
#
|
602
|
+
# @param item_id [String] The item ID that revenue from this minimum will be attributed to.
|
603
|
+
#
|
604
|
+
# @param minimum_amount [String] The minimum amount to charge in a given billing period for the prices this adjus
|
605
|
+
# ...
|
606
|
+
#
|
607
|
+
# @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
|
608
|
+
#
|
609
|
+
# @param reason [String, nil] The reason for the adjustment.
|
610
|
+
#
|
611
|
+
# @param adjustment_type [Symbol, :minimum]
|
618
612
|
end
|
619
613
|
|
620
|
-
class
|
614
|
+
class Maximum < Orb::Internal::Type::BaseModel
|
621
615
|
# @!attribute id
|
622
616
|
#
|
623
617
|
# @return [String]
|
@@ -660,34 +654,30 @@ module Orb
|
|
660
654
|
# @return [String, nil]
|
661
655
|
required :reason, String, nil?: true
|
662
656
|
|
663
|
-
# @!
|
664
|
-
#
|
665
|
-
#
|
666
|
-
#
|
667
|
-
#
|
668
|
-
#
|
669
|
-
#
|
670
|
-
#
|
671
|
-
#
|
672
|
-
#
|
673
|
-
#
|
674
|
-
#
|
675
|
-
#
|
676
|
-
#
|
677
|
-
#
|
678
|
-
#
|
679
|
-
#
|
680
|
-
#
|
681
|
-
#
|
682
|
-
#
|
683
|
-
# end
|
684
|
-
|
685
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
657
|
+
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, maximum_amount:, plan_phase_order:, reason:, adjustment_type: :maximum)
|
658
|
+
# Some parameter documentations has been truncated, see
|
659
|
+
# {Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::Maximum}
|
660
|
+
# for more details.
|
661
|
+
#
|
662
|
+
# @param id [String]
|
663
|
+
#
|
664
|
+
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
665
|
+
#
|
666
|
+
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
667
|
+
# ...
|
668
|
+
#
|
669
|
+
# @param maximum_amount [String] The maximum amount to charge in a given billing period for the prices this adjus
|
670
|
+
# ...
|
671
|
+
#
|
672
|
+
# @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
|
673
|
+
#
|
674
|
+
# @param reason [String, nil] The reason for the adjustment.
|
675
|
+
#
|
676
|
+
# @param adjustment_type [Symbol, :maximum]
|
686
677
|
end
|
687
678
|
|
688
|
-
# @!
|
689
|
-
#
|
690
|
-
# def self.variants; end
|
679
|
+
# @!method self.variants
|
680
|
+
# @return [Array(Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::UsageDiscount, Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::AmountDiscount, Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::PercentageDiscount, Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::Minimum, Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::Maximum)]
|
691
681
|
end
|
692
682
|
end
|
693
683
|
|
@@ -717,14 +707,19 @@ module Orb
|
|
717
707
|
# @return [Integer, nil]
|
718
708
|
optional :year, Integer, nil?: true
|
719
709
|
|
720
|
-
# @!
|
721
|
-
#
|
722
|
-
#
|
723
|
-
#
|
724
|
-
#
|
725
|
-
#
|
726
|
-
|
727
|
-
#
|
710
|
+
# @!method initialize(day:, month: nil, year: nil)
|
711
|
+
# Some parameter documentations has been truncated, see
|
712
|
+
# {Orb::Models::SubscriptionTriggerPhaseResponse::BillingCycleAnchorConfiguration}
|
713
|
+
# for more details.
|
714
|
+
#
|
715
|
+
# @param day [Integer] The day of the month on which the billing cycle is anchored. If the maximum numb
|
716
|
+
# ...
|
717
|
+
#
|
718
|
+
# @param month [Integer, nil] The month on which the billing cycle is anchored (e.g. a quarterly price anchore
|
719
|
+
# ...
|
720
|
+
#
|
721
|
+
# @param year [Integer, nil] The year on which the billing cycle is anchored (e.g. a 2 year billing cycle anc
|
722
|
+
# ...
|
728
723
|
end
|
729
724
|
|
730
725
|
module DiscountInterval
|
@@ -732,16 +727,13 @@ module Orb
|
|
732
727
|
|
733
728
|
discriminator :discount_type
|
734
729
|
|
735
|
-
variant :amount,
|
736
|
-
-> { Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::AmountDiscountInterval }
|
730
|
+
variant :amount, -> { Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::Amount }
|
737
731
|
|
738
|
-
variant :percentage,
|
739
|
-
-> { Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::PercentageDiscountInterval }
|
732
|
+
variant :percentage, -> { Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::Percentage }
|
740
733
|
|
741
|
-
variant :usage,
|
742
|
-
-> { Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::UsageDiscountInterval }
|
734
|
+
variant :usage, -> { Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::Usage }
|
743
735
|
|
744
|
-
class
|
736
|
+
class Amount < Orb::Internal::Type::BaseModel
|
745
737
|
# @!attribute amount_discount
|
746
738
|
# Only available if discount_type is `amount`.
|
747
739
|
#
|
@@ -777,30 +769,21 @@ module Orb
|
|
777
769
|
# @return [Time]
|
778
770
|
required :start_date, Time
|
779
771
|
|
780
|
-
# @!
|
781
|
-
#
|
782
|
-
#
|
783
|
-
#
|
784
|
-
#
|
785
|
-
#
|
786
|
-
#
|
787
|
-
#
|
788
|
-
#
|
789
|
-
#
|
790
|
-
#
|
791
|
-
#
|
792
|
-
# end_date:,
|
793
|
-
# start_date:,
|
794
|
-
# discount_type: :amount,
|
795
|
-
# **
|
796
|
-
# )
|
797
|
-
# super
|
798
|
-
# end
|
799
|
-
|
800
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
772
|
+
# @!method initialize(amount_discount:, applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, start_date:, discount_type: :amount)
|
773
|
+
# @param amount_discount [String] Only available if discount_type is `amount`.
|
774
|
+
#
|
775
|
+
# @param applies_to_price_ids [Array<String>] The price ids that this discount interval applies to.
|
776
|
+
#
|
777
|
+
# @param applies_to_price_interval_ids [Array<String>] The price interval ids that this discount interval applies to.
|
778
|
+
#
|
779
|
+
# @param end_date [Time, nil] The end date of the discount interval.
|
780
|
+
#
|
781
|
+
# @param start_date [Time] The start date of the discount interval.
|
782
|
+
#
|
783
|
+
# @param discount_type [Symbol, :amount]
|
801
784
|
end
|
802
785
|
|
803
|
-
class
|
786
|
+
class Percentage < Orb::Internal::Type::BaseModel
|
804
787
|
# @!attribute applies_to_price_ids
|
805
788
|
# The price ids that this discount interval applies to.
|
806
789
|
#
|
@@ -837,30 +820,26 @@ module Orb
|
|
837
820
|
# @return [Time]
|
838
821
|
required :start_date, Time
|
839
822
|
|
840
|
-
# @!
|
841
|
-
#
|
842
|
-
#
|
843
|
-
#
|
844
|
-
#
|
845
|
-
#
|
846
|
-
#
|
847
|
-
#
|
848
|
-
#
|
849
|
-
#
|
850
|
-
#
|
851
|
-
#
|
852
|
-
#
|
853
|
-
#
|
854
|
-
#
|
855
|
-
#
|
856
|
-
#
|
857
|
-
# super
|
858
|
-
# end
|
859
|
-
|
860
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
823
|
+
# @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, percentage_discount:, start_date:, discount_type: :percentage)
|
824
|
+
# Some parameter documentations has been truncated, see
|
825
|
+
# {Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::Percentage}
|
826
|
+
# for more details.
|
827
|
+
#
|
828
|
+
# @param applies_to_price_ids [Array<String>] The price ids that this discount interval applies to.
|
829
|
+
#
|
830
|
+
# @param applies_to_price_interval_ids [Array<String>] The price interval ids that this discount interval applies to.
|
831
|
+
#
|
832
|
+
# @param end_date [Time, nil] The end date of the discount interval.
|
833
|
+
#
|
834
|
+
# @param percentage_discount [Float] Only available if discount_type is `percentage`.This is a number between 0 and 1
|
835
|
+
# ...
|
836
|
+
#
|
837
|
+
# @param start_date [Time] The start date of the discount interval.
|
838
|
+
#
|
839
|
+
# @param discount_type [Symbol, :percentage]
|
861
840
|
end
|
862
841
|
|
863
|
-
class
|
842
|
+
class Usage < Orb::Internal::Type::BaseModel
|
864
843
|
# @!attribute applies_to_price_ids
|
865
844
|
# The price ids that this discount interval applies to.
|
866
845
|
#
|
@@ -897,32 +876,27 @@ module Orb
|
|
897
876
|
# @return [Float]
|
898
877
|
required :usage_discount, Float
|
899
878
|
|
900
|
-
# @!
|
901
|
-
#
|
902
|
-
#
|
903
|
-
#
|
904
|
-
#
|
905
|
-
#
|
906
|
-
#
|
907
|
-
#
|
908
|
-
#
|
909
|
-
#
|
910
|
-
#
|
911
|
-
#
|
912
|
-
#
|
913
|
-
#
|
914
|
-
#
|
915
|
-
#
|
916
|
-
#
|
917
|
-
# super
|
918
|
-
# end
|
919
|
-
|
920
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
879
|
+
# @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, start_date:, usage_discount:, discount_type: :usage)
|
880
|
+
# Some parameter documentations has been truncated, see
|
881
|
+
# {Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::Usage} for
|
882
|
+
# more details.
|
883
|
+
#
|
884
|
+
# @param applies_to_price_ids [Array<String>] The price ids that this discount interval applies to.
|
885
|
+
#
|
886
|
+
# @param applies_to_price_interval_ids [Array<String>] The price interval ids that this discount interval applies to.
|
887
|
+
#
|
888
|
+
# @param end_date [Time, nil] The end date of the discount interval.
|
889
|
+
#
|
890
|
+
# @param start_date [Time] The start date of the discount interval.
|
891
|
+
#
|
892
|
+
# @param usage_discount [Float] Only available if discount_type is `usage`. Number of usage units that this disc
|
893
|
+
# ...
|
894
|
+
#
|
895
|
+
# @param discount_type [Symbol, :usage]
|
921
896
|
end
|
922
897
|
|
923
|
-
# @!
|
924
|
-
#
|
925
|
-
# def self.variants; end
|
898
|
+
# @!method self.variants
|
899
|
+
# @return [Array(Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::Amount, Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::Percentage, Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::Usage)]
|
926
900
|
end
|
927
901
|
|
928
902
|
class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel
|
@@ -946,15 +920,11 @@ module Orb
|
|
946
920
|
# @return [Time]
|
947
921
|
required :start_date, Time
|
948
922
|
|
949
|
-
# @!
|
950
|
-
#
|
951
|
-
#
|
952
|
-
#
|
953
|
-
#
|
954
|
-
# #
|
955
|
-
# def initialize(end_date:, price_id:, quantity:, start_date:, **) = super
|
956
|
-
|
957
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
923
|
+
# @!method initialize(end_date:, price_id:, quantity:, start_date:)
|
924
|
+
# @param end_date [Time, nil]
|
925
|
+
# @param price_id [String]
|
926
|
+
# @param quantity [Float]
|
927
|
+
# @param start_date [Time]
|
958
928
|
end
|
959
929
|
|
960
930
|
class MaximumInterval < Orb::Internal::Type::BaseModel
|
@@ -989,16 +959,21 @@ module Orb
|
|
989
959
|
# @return [Time]
|
990
960
|
required :start_date, Time
|
991
961
|
|
992
|
-
# @!
|
993
|
-
#
|
994
|
-
#
|
995
|
-
#
|
996
|
-
#
|
997
|
-
#
|
998
|
-
#
|
999
|
-
#
|
1000
|
-
|
1001
|
-
#
|
962
|
+
# @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, maximum_amount:, start_date:)
|
963
|
+
# Some parameter documentations has been truncated, see
|
964
|
+
# {Orb::Models::SubscriptionTriggerPhaseResponse::MaximumInterval} for more
|
965
|
+
# details.
|
966
|
+
#
|
967
|
+
# @param applies_to_price_ids [Array<String>] The price ids that this maximum interval applies to.
|
968
|
+
#
|
969
|
+
# @param applies_to_price_interval_ids [Array<String>] The price interval ids that this maximum interval applies to.
|
970
|
+
#
|
971
|
+
# @param end_date [Time, nil] The end date of the maximum interval.
|
972
|
+
#
|
973
|
+
# @param maximum_amount [String] The maximum amount to charge in a given billing period for the price intervals t
|
974
|
+
# ...
|
975
|
+
#
|
976
|
+
# @param start_date [Time] The start date of the maximum interval.
|
1002
977
|
end
|
1003
978
|
|
1004
979
|
class MinimumInterval < Orb::Internal::Type::BaseModel
|
@@ -1033,16 +1008,21 @@ module Orb
|
|
1033
1008
|
# @return [Time]
|
1034
1009
|
required :start_date, Time
|
1035
1010
|
|
1036
|
-
# @!
|
1037
|
-
#
|
1038
|
-
#
|
1039
|
-
#
|
1040
|
-
#
|
1041
|
-
#
|
1042
|
-
#
|
1043
|
-
#
|
1044
|
-
|
1045
|
-
#
|
1011
|
+
# @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, minimum_amount:, start_date:)
|
1012
|
+
# Some parameter documentations has been truncated, see
|
1013
|
+
# {Orb::Models::SubscriptionTriggerPhaseResponse::MinimumInterval} for more
|
1014
|
+
# details.
|
1015
|
+
#
|
1016
|
+
# @param applies_to_price_ids [Array<String>] The price ids that this minimum interval applies to.
|
1017
|
+
#
|
1018
|
+
# @param applies_to_price_interval_ids [Array<String>] The price interval ids that this minimum interval applies to.
|
1019
|
+
#
|
1020
|
+
# @param end_date [Time, nil] The end date of the minimum interval.
|
1021
|
+
#
|
1022
|
+
# @param minimum_amount [String] The minimum amount to charge in a given billing period for the price intervals t
|
1023
|
+
# ...
|
1024
|
+
#
|
1025
|
+
# @param start_date [Time] The start date of the minimum interval.
|
1046
1026
|
end
|
1047
1027
|
|
1048
1028
|
# @see Orb::Models::SubscriptionTriggerPhaseResponse#pending_subscription_change
|
@@ -1052,14 +1032,10 @@ module Orb
|
|
1052
1032
|
# @return [String]
|
1053
1033
|
required :id, String
|
1054
1034
|
|
1055
|
-
# @!
|
1056
|
-
#
|
1057
|
-
#
|
1058
|
-
#
|
1059
|
-
# #
|
1060
|
-
# def initialize(id:, **) = super
|
1061
|
-
|
1062
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
1035
|
+
# @!method initialize(id:)
|
1036
|
+
# A pending subscription change if one exists on this subscription.
|
1037
|
+
#
|
1038
|
+
# @param id [String]
|
1063
1039
|
end
|
1064
1040
|
|
1065
1041
|
class PriceInterval < Orb::Internal::Type::BaseModel
|
@@ -1124,7 +1100,7 @@ module Orb
|
|
1124
1100
|
# For more on the types of prices, see
|
1125
1101
|
# [the core concepts documentation](/core-concepts#plan-and-price)
|
1126
1102
|
#
|
1127
|
-
# @return [Orb::Models::Price::
|
1103
|
+
# @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]
|
1128
1104
|
required :price, union: -> { Orb::Models::Price }
|
1129
1105
|
|
1130
1106
|
# @!attribute start_date
|
@@ -1141,39 +1117,40 @@ module Orb
|
|
1141
1117
|
# @return [Array<String>, nil]
|
1142
1118
|
required :usage_customer_ids, Orb::Internal::Type::ArrayOf[String], nil?: true
|
1143
1119
|
|
1144
|
-
# @!
|
1145
|
-
#
|
1146
|
-
#
|
1147
|
-
#
|
1148
|
-
#
|
1149
|
-
#
|
1150
|
-
#
|
1151
|
-
#
|
1152
|
-
#
|
1153
|
-
#
|
1154
|
-
#
|
1155
|
-
#
|
1156
|
-
#
|
1157
|
-
#
|
1158
|
-
#
|
1159
|
-
#
|
1160
|
-
#
|
1161
|
-
#
|
1162
|
-
#
|
1163
|
-
#
|
1164
|
-
#
|
1165
|
-
#
|
1166
|
-
#
|
1167
|
-
#
|
1168
|
-
#
|
1169
|
-
#
|
1170
|
-
#
|
1171
|
-
#
|
1172
|
-
#
|
1173
|
-
#
|
1174
|
-
#
|
1175
|
-
|
1176
|
-
#
|
1120
|
+
# @!method initialize(id:, billing_cycle_day:, current_billing_period_end_date:, current_billing_period_start_date:, end_date:, filter:, fixed_fee_quantity_transitions:, price:, start_date:, usage_customer_ids:)
|
1121
|
+
# Some parameter documentations has been truncated, see
|
1122
|
+
# {Orb::Models::SubscriptionTriggerPhaseResponse::PriceInterval} for more details.
|
1123
|
+
#
|
1124
|
+
# The Price Interval resource represents a period of time for which a price will
|
1125
|
+
# bill on a subscription. A subscription’s price intervals define its billing
|
1126
|
+
# behavior.
|
1127
|
+
#
|
1128
|
+
# @param id [String]
|
1129
|
+
#
|
1130
|
+
# @param billing_cycle_day [Integer] The day of the month that Orb bills for this price
|
1131
|
+
#
|
1132
|
+
# @param current_billing_period_end_date [Time, nil] The end of the current billing period. This is an exclusive timestamp, such that
|
1133
|
+
# ...
|
1134
|
+
#
|
1135
|
+
# @param current_billing_period_start_date [Time, nil] The start date of the current billing period. This is an inclusive timestamp; th
|
1136
|
+
# ...
|
1137
|
+
#
|
1138
|
+
# @param end_date [Time, nil] The end date of the price interval. This is the date that Orb stops billing for
|
1139
|
+
# ...
|
1140
|
+
#
|
1141
|
+
# @param filter [String, nil] An additional filter to apply to usage queries.
|
1142
|
+
#
|
1143
|
+
# @param fixed_fee_quantity_transitions [Array<Orb::Models::SubscriptionTriggerPhaseResponse::PriceInterval::FixedFeeQuantityTransition>, nil] The fixed fee quantity transitions for this price interval. This is only relevan
|
1144
|
+
# ...
|
1145
|
+
#
|
1146
|
+
# @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
|
+
# ...
|
1148
|
+
#
|
1149
|
+
# @param start_date [Time] The start date of the price interval. This is the date that Orb starts billing f
|
1150
|
+
# ...
|
1151
|
+
#
|
1152
|
+
# @param usage_customer_ids [Array<String>, nil] A list of customer IDs whose usage events will be aggregated and billed under th
|
1153
|
+
# ...
|
1177
1154
|
|
1178
1155
|
class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel
|
1179
1156
|
# @!attribute effective_date
|
@@ -1191,14 +1168,10 @@ module Orb
|
|
1191
1168
|
# @return [Integer]
|
1192
1169
|
required :quantity, Integer
|
1193
1170
|
|
1194
|
-
# @!
|
1195
|
-
#
|
1196
|
-
#
|
1197
|
-
#
|
1198
|
-
# #
|
1199
|
-
# def initialize(effective_date:, price_id:, quantity:, **) = super
|
1200
|
-
|
1201
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
1171
|
+
# @!method initialize(effective_date:, price_id:, quantity:)
|
1172
|
+
# @param effective_date [Time]
|
1173
|
+
# @param price_id [String]
|
1174
|
+
# @param quantity [Integer]
|
1202
1175
|
end
|
1203
1176
|
end
|
1204
1177
|
|
@@ -1219,14 +1192,10 @@ module Orb
|
|
1219
1192
|
# @return [Time]
|
1220
1193
|
required :start_date, Time
|
1221
1194
|
|
1222
|
-
# @!
|
1223
|
-
#
|
1224
|
-
#
|
1225
|
-
#
|
1226
|
-
# #
|
1227
|
-
# def initialize(coupon_id:, end_date:, start_date:, **) = super
|
1228
|
-
|
1229
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
1195
|
+
# @!method initialize(coupon_id:, end_date:, start_date:)
|
1196
|
+
# @param coupon_id [String]
|
1197
|
+
# @param end_date [Time, nil]
|
1198
|
+
# @param start_date [Time]
|
1230
1199
|
end
|
1231
1200
|
|
1232
1201
|
# @see Orb::Models::SubscriptionTriggerPhaseResponse#status
|
@@ -1237,11 +1206,8 @@ module Orb
|
|
1237
1206
|
ENDED = :ended
|
1238
1207
|
UPCOMING = :upcoming
|
1239
1208
|
|
1240
|
-
|
1241
|
-
|
1242
|
-
# @!parse
|
1243
|
-
# # @return [Array<Symbol>]
|
1244
|
-
# def self.values; end
|
1209
|
+
# @!method self.values
|
1210
|
+
# @return [Array<Symbol>]
|
1245
1211
|
end
|
1246
1212
|
|
1247
1213
|
# @see Orb::Models::SubscriptionTriggerPhaseResponse#trial_info
|
@@ -1251,12 +1217,8 @@ module Orb
|
|
1251
1217
|
# @return [Time, nil]
|
1252
1218
|
required :end_date, Time, nil?: true
|
1253
1219
|
|
1254
|
-
# @!
|
1255
|
-
#
|
1256
|
-
# #
|
1257
|
-
# def initialize(end_date:, **) = super
|
1258
|
-
|
1259
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
1220
|
+
# @!method initialize(end_date:)
|
1221
|
+
# @param end_date [Time, nil]
|
1260
1222
|
end
|
1261
1223
|
|
1262
1224
|
# @see Orb::Models::SubscriptionTriggerPhaseResponse#changed_resources
|
@@ -1285,19 +1247,18 @@ module Orb
|
|
1285
1247
|
# @return [Array<Orb::Models::Invoice>]
|
1286
1248
|
required :voided_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Models::Invoice] }
|
1287
1249
|
|
1288
|
-
# @!
|
1289
|
-
#
|
1290
|
-
#
|
1291
|
-
#
|
1292
|
-
#
|
1293
|
-
#
|
1294
|
-
#
|
1295
|
-
#
|
1296
|
-
#
|
1297
|
-
#
|
1298
|
-
#
|
1299
|
-
|
1300
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
1250
|
+
# @!method initialize(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:)
|
1251
|
+
# The resources that were changed as part of this operation. Only present when
|
1252
|
+
# fetched through the subscription changes API or if the
|
1253
|
+
# `include_changed_resources` parameter was passed in the request.
|
1254
|
+
#
|
1255
|
+
# @param created_credit_notes [Array<Orb::Models::CreditNote>] The credit notes that were created as part of this operation.
|
1256
|
+
#
|
1257
|
+
# @param created_invoices [Array<Orb::Models::Invoice>] The invoices that were created as part of this operation.
|
1258
|
+
#
|
1259
|
+
# @param voided_credit_notes [Array<Orb::Models::CreditNote>] The credit notes that were voided as part of this operation.
|
1260
|
+
#
|
1261
|
+
# @param voided_invoices [Array<Orb::Models::Invoice>] The invoices that were voided as part of this operation.
|
1301
1262
|
end
|
1302
1263
|
end
|
1303
1264
|
end
|