orb-billing 0.3.1 → 0.3.2
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 +14 -0
- data/README.md +3 -3
- data/lib/orb/file_part.rb +2 -2
- data/lib/orb/internal/type/enum.rb +3 -3
- data/lib/orb/internal/type/request_parameters.rb +4 -4
- data/lib/orb/internal/type/union.rb +4 -4
- data/lib/orb/internal/util.rb +1 -1
- data/lib/orb/models/alert.rb +29 -32
- data/lib/orb/models/alert_create_for_customer_params.rb +7 -8
- data/lib/orb/models/alert_create_for_external_customer_params.rb +7 -8
- data/lib/orb/models/alert_create_for_subscription_params.rb +7 -8
- data/lib/orb/models/alert_list_params.rb +0 -1
- data/lib/orb/models/alert_update_params.rb +4 -5
- data/lib/orb/models/amount_discount.rb +6 -7
- data/lib/orb/models/billable_metric.rb +9 -11
- data/lib/orb/models/coupon.rb +9 -12
- data/lib/orb/models/coupon_create_params.rb +6 -8
- data/lib/orb/models/coupon_list_params.rb +0 -2
- data/lib/orb/models/coupons/subscription_list_params.rb +0 -1
- data/lib/orb/models/credit_note.rb +48 -46
- data/lib/orb/models/credit_note_create_params.rb +6 -6
- data/lib/orb/models/credit_note_list_params.rb +0 -1
- data/lib/orb/models/customer.rb +54 -61
- data/lib/orb/models/customer_create_params.rb +41 -53
- data/lib/orb/models/customer_list_params.rb +0 -1
- data/lib/orb/models/customer_update_by_external_id_params.rb +41 -53
- data/lib/orb/models/customer_update_params.rb +41 -51
- data/lib/orb/models/customers/balance_transaction_create_params.rb +3 -3
- data/lib/orb/models/customers/balance_transaction_create_response.rb +0 -2
- data/lib/orb/models/customers/balance_transaction_list_params.rb +0 -1
- data/lib/orb/models/customers/balance_transaction_list_response.rb +0 -2
- data/lib/orb/models/customers/cost_list_by_external_id_params.rb +3 -4
- data/lib/orb/models/customers/cost_list_by_external_id_response.rb +3 -3
- data/lib/orb/models/customers/cost_list_params.rb +3 -4
- data/lib/orb/models/customers/cost_list_response.rb +3 -3
- data/lib/orb/models/customers/credit_list_by_external_id_params.rb +0 -2
- data/lib/orb/models/customers/credit_list_params.rb +0 -2
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +12 -21
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +0 -7
- data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +11 -22
- data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +0 -7
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +6 -7
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +0 -7
- data/lib/orb/models/customers/credits/ledger_list_params.rb +8 -9
- data/lib/orb/models/customers/credits/ledger_list_response.rb +0 -7
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +10 -15
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb +0 -6
- data/lib/orb/models/customers/credits/top_up_create_params.rb +7 -15
- data/lib/orb/models/customers/credits/top_up_create_response.rb +0 -6
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rb +0 -1
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb +0 -6
- data/lib/orb/models/customers/credits/top_up_list_params.rb +0 -1
- data/lib/orb/models/customers/credits/top_up_list_response.rb +0 -6
- data/lib/orb/models/dimensional_price_group.rb +1 -3
- data/lib/orb/models/dimensional_price_group_create_params.rb +0 -1
- data/lib/orb/models/dimensional_price_group_list_params.rb +0 -1
- data/lib/orb/models/dimensional_price_groups.rb +6 -6
- data/lib/orb/models/discount.rb +5 -5
- data/lib/orb/models/evaluate_price_group.rb +1 -1
- data/lib/orb/models/event_ingest_params.rb +4 -9
- data/lib/orb/models/event_ingest_response.rb +0 -3
- data/lib/orb/models/event_search_params.rb +0 -3
- data/lib/orb/models/event_search_response.rb +0 -4
- data/lib/orb/models/event_update_params.rb +0 -3
- data/lib/orb/models/events/backfill_close_response.rb +0 -4
- data/lib/orb/models/events/backfill_create_params.rb +0 -7
- data/lib/orb/models/events/backfill_create_response.rb +0 -4
- data/lib/orb/models/events/backfill_fetch_response.rb +0 -4
- data/lib/orb/models/events/backfill_list_params.rb +0 -1
- data/lib/orb/models/events/backfill_list_response.rb +0 -4
- data/lib/orb/models/events/backfill_revert_response.rb +0 -4
- data/lib/orb/models/events/event_volumes.rb +3 -3
- data/lib/orb/models/events/volume_list_params.rb +0 -3
- data/lib/orb/models/invoice.rb +157 -202
- data/lib/orb/models/invoice_create_params.rb +14 -21
- data/lib/orb/models/invoice_fetch_upcoming_response.rb +9 -54
- data/lib/orb/models/invoice_issue_params.rb +0 -1
- data/lib/orb/models/invoice_level_discount.rb +4 -4
- data/lib/orb/models/invoice_line_item_create_params.rb +0 -1
- data/lib/orb/models/invoice_line_item_create_response.rb +6 -26
- data/lib/orb/models/invoice_list_params.rb +6 -10
- data/lib/orb/models/invoice_update_params.rb +0 -1
- data/lib/orb/models/item.rb +7 -8
- data/lib/orb/models/item_list_params.rb +0 -1
- data/lib/orb/models/item_update_params.rb +7 -7
- data/lib/orb/models/metric_create_params.rb +0 -1
- data/lib/orb/models/metric_list_params.rb +0 -1
- data/lib/orb/models/metric_update_params.rb +0 -1
- data/lib/orb/models/percentage_discount.rb +6 -8
- data/lib/orb/models/plan.rb +78 -103
- data/lib/orb/models/plan_create_params.rb +727 -800
- data/lib/orb/models/plan_list_params.rb +3 -4
- data/lib/orb/models/plan_update_params.rb +0 -2
- data/lib/orb/models/plans/external_plan_id_update_params.rb +0 -2
- data/lib/orb/models/price.rb +1671 -1724
- data/lib/orb/models/price_create_params.rb +75 -84
- data/lib/orb/models/price_evaluate_params.rb +0 -2
- data/lib/orb/models/price_evaluate_response.rb +3 -3
- data/lib/orb/models/price_list_params.rb +0 -1
- data/lib/orb/models/price_update_params.rb +0 -1
- data/lib/orb/models/prices/external_price_id_update_params.rb +0 -1
- data/lib/orb/models/subscription.rb +86 -122
- data/lib/orb/models/subscription_cancel_params.rb +3 -5
- data/lib/orb/models/subscription_cancel_response.rb +21 -57
- data/lib/orb/models/subscription_change_apply_response.rb +21 -58
- data/lib/orb/models/subscription_change_cancel_response.rb +21 -58
- data/lib/orb/models/subscription_change_retrieve_response.rb +21 -58
- data/lib/orb/models/subscription_create_params.rb +1865 -1815
- data/lib/orb/models/subscription_create_response.rb +21 -57
- data/lib/orb/models/subscription_fetch_costs_params.rb +3 -4
- data/lib/orb/models/subscription_fetch_costs_response.rb +3 -3
- data/lib/orb/models/subscription_fetch_schedule_params.rb +0 -1
- data/lib/orb/models/subscription_fetch_schedule_response.rb +0 -1
- data/lib/orb/models/subscription_fetch_usage_params.rb +6 -8
- data/lib/orb/models/subscription_list_params.rb +3 -4
- data/lib/orb/models/subscription_price_intervals_params.rb +1105 -1017
- data/lib/orb/models/subscription_price_intervals_response.rb +21 -57
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +1906 -1791
- data/lib/orb/models/subscription_schedule_plan_change_response.rb +21 -57
- data/lib/orb/models/subscription_trigger_phase_params.rb +0 -2
- data/lib/orb/models/subscription_trigger_phase_response.rb +21 -57
- data/lib/orb/models/subscription_unschedule_cancellation_response.rb +21 -57
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +21 -57
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +21 -57
- data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +3 -6
- data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +21 -57
- data/lib/orb/models/subscription_update_params.rb +0 -5
- data/lib/orb/models/subscription_update_trial_params.rb +4 -6
- data/lib/orb/models/subscription_update_trial_response.rb +21 -57
- data/lib/orb/models/subscription_usage.rb +46 -39
- data/lib/orb/models/subscriptions.rb +6 -6
- data/lib/orb/models/trial_discount.rb +6 -7
- data/lib/orb/models/usage_discount.rb +6 -8
- data/lib/orb/resources/alerts.rb +30 -31
- data/lib/orb/resources/coupons/subscriptions.rb +3 -4
- data/lib/orb/resources/coupons.rb +11 -21
- data/lib/orb/resources/credit_notes.rb +10 -11
- data/lib/orb/resources/customers/balance_transactions.rb +3 -4
- data/lib/orb/resources/customers/costs.rb +4 -6
- data/lib/orb/resources/customers/credits/ledger.rb +14 -33
- data/lib/orb/resources/customers/credits/top_ups.rb +10 -20
- data/lib/orb/resources/customers/credits.rb +2 -6
- data/lib/orb/resources/customers.rb +40 -67
- data/lib/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rb +2 -2
- data/lib/orb/resources/dimensional_price_groups.rb +8 -10
- data/lib/orb/resources/events/backfills.rb +2 -10
- data/lib/orb/resources/events/volume.rb +3 -6
- data/lib/orb/resources/events.rb +4 -12
- data/lib/orb/resources/invoice_line_items.rb +1 -2
- data/lib/orb/resources/invoices.rb +26 -43
- data/lib/orb/resources/items.rb +12 -13
- data/lib/orb/resources/metrics.rb +11 -14
- data/lib/orb/resources/plans/external_plan_id.rb +5 -7
- data/lib/orb/resources/plans.rb +14 -23
- data/lib/orb/resources/prices/external_price_id.rb +5 -6
- data/lib/orb/resources/prices.rb +25 -35
- data/lib/orb/resources/subscription_changes.rb +1 -1
- data/lib/orb/resources/subscriptions.rb +49 -107
- data/lib/orb/version.rb +1 -1
- data/lib/orb.rb +1 -0
- data/rbi/orb/client.rbi +5 -4
- data/rbi/orb/errors.rbi +59 -28
- data/rbi/orb/file_part.rbi +9 -6
- data/rbi/orb/internal/page.rbi +19 -6
- data/rbi/orb/internal/transport/base_client.rbi +131 -73
- data/rbi/orb/internal/transport/pooled_net_requester.rbi +25 -12
- data/rbi/orb/internal/type/array_of.rbi +42 -34
- data/rbi/orb/internal/type/base_model.rbi +124 -65
- data/rbi/orb/internal/type/base_page.rbi +11 -7
- data/rbi/orb/internal/type/boolean.rbi +16 -10
- data/rbi/orb/internal/type/converter.rbi +66 -31
- data/rbi/orb/internal/type/enum.rbi +27 -15
- data/rbi/orb/internal/type/file_input.rbi +12 -10
- data/rbi/orb/internal/type/hash_of.rbi +34 -24
- data/rbi/orb/internal/type/request_parameters.rbi +12 -4
- data/rbi/orb/internal/type/union.rbi +60 -25
- data/rbi/orb/internal/type/unknown.rbi +20 -12
- data/rbi/orb/internal/util.rbi +210 -89
- data/rbi/orb/models/alert.rbi +107 -70
- data/rbi/orb/models/alert_create_for_customer_params.rbi +60 -27
- data/rbi/orb/models/alert_create_for_external_customer_params.rbi +68 -29
- data/rbi/orb/models/alert_create_for_subscription_params.rbi +53 -26
- data/rbi/orb/models/alert_disable_params.rbi +17 -6
- data/rbi/orb/models/alert_enable_params.rbi +17 -6
- data/rbi/orb/models/alert_list_params.rbi +23 -20
- data/rbi/orb/models/alert_retrieve_params.rbi +10 -4
- data/rbi/orb/models/alert_update_params.rbi +25 -14
- data/rbi/orb/models/amount_discount.rbi +28 -19
- data/rbi/orb/models/billable_metric.rbi +33 -26
- data/rbi/orb/models/billing_cycle_relative_date.rbi +11 -5
- data/rbi/orb/models/coupon.rbi +28 -20
- data/rbi/orb/models/coupon_archive_params.rbi +10 -4
- data/rbi/orb/models/coupon_create_params.rbi +72 -38
- data/rbi/orb/models/coupon_fetch_params.rbi +10 -4
- data/rbi/orb/models/coupon_list_params.rbi +18 -15
- data/rbi/orb/models/coupons/subscription_list_params.rbi +16 -6
- data/rbi/orb/models/credit_note.rbi +293 -158
- data/rbi/orb/models/credit_note_create_params.rbi +58 -29
- data/rbi/orb/models/credit_note_fetch_params.rbi +10 -4
- data/rbi/orb/models/credit_note_list_params.rbi +20 -17
- data/rbi/orb/models/customer.rbi +430 -329
- data/rbi/orb/models/customer_create_params.rbi +662 -325
- data/rbi/orb/models/customer_delete_params.rbi +10 -4
- data/rbi/orb/models/customer_fetch_by_external_id_params.rbi +10 -4
- data/rbi/orb/models/customer_fetch_params.rbi +10 -4
- data/rbi/orb/models/customer_list_params.rbi +20 -17
- data/rbi/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi +10 -4
- data/rbi/orb/models/customer_sync_payment_methods_from_gateway_params.rbi +10 -4
- data/rbi/orb/models/customer_update_by_external_id_params.rbi +1136 -336
- data/rbi/orb/models/customer_update_params.rbi +661 -324
- data/rbi/orb/models/customers/balance_transaction_create_params.rbi +50 -21
- data/rbi/orb/models/customers/balance_transaction_create_response.rbi +154 -61
- data/rbi/orb/models/customers/balance_transaction_list_params.rbi +20 -17
- data/rbi/orb/models/customers/balance_transaction_list_response.rbi +164 -59
- data/rbi/orb/models/customers/cost_list_by_external_id_params.rbi +56 -22
- data/rbi/orb/models/customers/cost_list_by_external_id_response.rbi +162 -124
- data/rbi/orb/models/customers/cost_list_params.rbi +45 -22
- data/rbi/orb/models/customers/cost_list_response.rbi +154 -123
- data/rbi/orb/models/customers/credit_list_by_external_id_params.rbi +18 -15
- data/rbi/orb/models/customers/credit_list_by_external_id_response.rbi +48 -22
- data/rbi/orb/models/customers/credit_list_params.rbi +18 -15
- data/rbi/orb/models/customers/credit_list_response.rbi +44 -21
- data/rbi/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +106 -68
- data/rbi/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi +643 -434
- data/rbi/orb/models/customers/credits/ledger_create_entry_params.rbi +117 -59
- data/rbi/orb/models/customers/credits/ledger_create_entry_response.rbi +700 -425
- data/rbi/orb/models/customers/credits/ledger_list_by_external_id_params.rbi +102 -44
- data/rbi/orb/models/customers/credits/ledger_list_by_external_id_response.rbi +681 -432
- data/rbi/orb/models/customers/credits/ledger_list_params.rbi +123 -40
- data/rbi/orb/models/customers/credits/ledger_list_response.rbi +735 -389
- data/rbi/orb/models/customers/credits/top_up_create_by_external_id_params.rbi +74 -53
- data/rbi/orb/models/customers/credits/top_up_create_by_external_id_response.rbi +65 -48
- data/rbi/orb/models/customers/credits/top_up_create_params.rbi +84 -45
- data/rbi/orb/models/customers/credits/top_up_create_response.rbi +83 -43
- data/rbi/orb/models/customers/credits/top_up_delete_by_external_id_params.rbi +16 -6
- data/rbi/orb/models/customers/credits/top_up_delete_params.rbi +15 -5
- data/rbi/orb/models/customers/credits/top_up_list_by_external_id_params.rbi +9 -5
- data/rbi/orb/models/customers/credits/top_up_list_by_external_id_response.rbi +70 -49
- data/rbi/orb/models/customers/credits/top_up_list_params.rbi +9 -5
- data/rbi/orb/models/customers/credits/top_up_list_response.rbi +84 -43
- data/rbi/orb/models/dimensional_price_group.rbi +18 -15
- data/rbi/orb/models/dimensional_price_group_create_params.rbi +19 -16
- data/rbi/orb/models/dimensional_price_group_list_params.rbi +16 -6
- data/rbi/orb/models/dimensional_price_group_retrieve_params.rbi +10 -4
- data/rbi/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi +10 -9
- data/rbi/orb/models/dimensional_price_groups.rbi +18 -13
- data/rbi/orb/models/discount.rbi +11 -5
- data/rbi/orb/models/evaluate_price_group.rbi +28 -12
- data/rbi/orb/models/event_deprecate_params.rbi +10 -4
- data/rbi/orb/models/event_deprecate_response.rbi +8 -3
- data/rbi/orb/models/event_ingest_params.rbi +37 -31
- data/rbi/orb/models/event_ingest_response.rbi +63 -23
- data/rbi/orb/models/event_search_params.rbi +17 -14
- data/rbi/orb/models/event_search_response.rbi +33 -21
- data/rbi/orb/models/event_update_params.rbi +19 -16
- data/rbi/orb/models/event_update_response.rbi +8 -3
- data/rbi/orb/models/events/backfill_close_params.rbi +10 -9
- data/rbi/orb/models/events/backfill_close_response.rbi +64 -29
- data/rbi/orb/models/events/backfill_create_params.rbi +21 -18
- data/rbi/orb/models/events/backfill_create_response.rbi +63 -29
- data/rbi/orb/models/events/backfill_fetch_params.rbi +10 -9
- data/rbi/orb/models/events/backfill_fetch_response.rbi +64 -29
- data/rbi/orb/models/events/backfill_list_params.rbi +16 -6
- data/rbi/orb/models/events/backfill_list_response.rbi +62 -28
- data/rbi/orb/models/events/backfill_revert_params.rbi +10 -9
- data/rbi/orb/models/events/backfill_revert_response.rbi +63 -29
- data/rbi/orb/models/events/event_volumes.rbi +32 -10
- data/rbi/orb/models/events/volume_list_params.rbi +18 -15
- data/rbi/orb/models/invoice.rbi +1286 -805
- data/rbi/orb/models/invoice_create_params.rbi +97 -69
- data/rbi/orb/models/invoice_fetch_params.rbi +10 -4
- data/rbi/orb/models/invoice_fetch_upcoming_params.rbi +15 -5
- data/rbi/orb/models/invoice_fetch_upcoming_response.rbi +1991 -861
- data/rbi/orb/models/invoice_issue_params.rbi +16 -5
- data/rbi/orb/models/invoice_level_discount.rbi +11 -4
- data/rbi/orb/models/invoice_line_item_create_params.rbi +20 -17
- data/rbi/orb/models/invoice_line_item_create_response.rbi +573 -376
- data/rbi/orb/models/invoice_list_params.rbi +67 -47
- data/rbi/orb/models/invoice_mark_paid_params.rbi +17 -14
- data/rbi/orb/models/invoice_pay_params.rbi +10 -4
- data/rbi/orb/models/invoice_update_params.rbi +15 -10
- data/rbi/orb/models/invoice_void_params.rbi +10 -4
- data/rbi/orb/models/item.rbi +87 -39
- data/rbi/orb/models/item_create_params.rbi +14 -5
- data/rbi/orb/models/item_fetch_params.rbi +10 -4
- data/rbi/orb/models/item_list_params.rbi +16 -6
- data/rbi/orb/models/item_update_params.rbi +79 -39
- data/rbi/orb/models/metric_create_params.rbi +19 -16
- data/rbi/orb/models/metric_fetch_params.rbi +10 -4
- data/rbi/orb/models/metric_list_params.rbi +20 -17
- data/rbi/orb/models/metric_update_params.rbi +15 -10
- data/rbi/orb/models/pagination_metadata.rbi +16 -4
- data/rbi/orb/models/percentage_discount.rbi +32 -19
- data/rbi/orb/models/plan.rbi +496 -365
- data/rbi/orb/models/plan_create_params.rbi +4785 -2875
- data/rbi/orb/models/plan_fetch_params.rbi +10 -4
- data/rbi/orb/models/plan_list_params.rbi +34 -27
- data/rbi/orb/models/plan_update_params.rbi +16 -13
- data/rbi/orb/models/plans/external_plan_id_fetch_params.rbi +10 -9
- data/rbi/orb/models/plans/external_plan_id_update_params.rbi +16 -13
- data/rbi/orb/models/price.rbi +9969 -5024
- data/rbi/orb/models/price_create_params.rbi +501 -245
- data/rbi/orb/models/price_evaluate_params.rbi +20 -17
- data/rbi/orb/models/price_evaluate_response.rbi +11 -6
- data/rbi/orb/models/price_fetch_params.rbi +10 -4
- data/rbi/orb/models/price_list_params.rbi +16 -6
- data/rbi/orb/models/price_update_params.rbi +15 -10
- data/rbi/orb/models/prices/external_price_id_fetch_params.rbi +10 -9
- data/rbi/orb/models/prices/external_price_id_update_params.rbi +15 -10
- data/rbi/orb/models/subscription.rbi +578 -420
- data/rbi/orb/models/subscription_cancel_params.rbi +44 -22
- data/rbi/orb/models/subscription_cancel_response.rbi +700 -438
- data/rbi/orb/models/subscription_change_apply_params.rbi +16 -13
- data/rbi/orb/models/subscription_change_apply_response.rbi +784 -504
- data/rbi/orb/models/subscription_change_cancel_params.rbi +10 -4
- data/rbi/orb/models/subscription_change_cancel_response.rbi +783 -514
- data/rbi/orb/models/subscription_change_retrieve_params.rbi +10 -4
- data/rbi/orb/models/subscription_change_retrieve_response.rbi +782 -524
- data/rbi/orb/models/subscription_create_params.rbi +9021 -6730
- data/rbi/orb/models/subscription_create_response.rbi +700 -438
- data/rbi/orb/models/subscription_fetch_costs_params.rbi +47 -22
- data/rbi/orb/models/subscription_fetch_costs_response.rbi +154 -123
- data/rbi/orb/models/subscription_fetch_params.rbi +10 -4
- data/rbi/orb/models/subscription_fetch_schedule_params.rbi +20 -17
- data/rbi/orb/models/subscription_fetch_schedule_response.rbi +33 -19
- data/rbi/orb/models/subscription_fetch_usage_params.rbi +81 -34
- data/rbi/orb/models/subscription_list_params.rbi +39 -28
- data/rbi/orb/models/subscription_price_intervals_params.rbi +5181 -3822
- data/rbi/orb/models/subscription_price_intervals_response.rbi +720 -453
- data/rbi/orb/models/subscription_schedule_plan_change_params.rbi +8602 -6910
- data/rbi/orb/models/subscription_schedule_plan_change_response.rbi +718 -467
- data/rbi/orb/models/subscription_trigger_phase_params.rbi +16 -13
- data/rbi/orb/models/subscription_trigger_phase_response.rbi +712 -448
- data/rbi/orb/models/subscription_unschedule_cancellation_params.rbi +10 -4
- data/rbi/orb/models/subscription_unschedule_cancellation_response.rbi +719 -467
- data/rbi/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +16 -5
- data/rbi/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +693 -502
- data/rbi/orb/models/subscription_unschedule_pending_plan_changes_params.rbi +10 -4
- data/rbi/orb/models/subscription_unschedule_pending_plan_changes_response.rbi +708 -497
- data/rbi/orb/models/subscription_update_fixed_fee_quantity_params.rbi +57 -26
- data/rbi/orb/models/subscription_update_fixed_fee_quantity_response.rbi +719 -467
- data/rbi/orb/models/subscription_update_params.rbi +19 -16
- data/rbi/orb/models/subscription_update_trial_params.rbi +57 -19
- data/rbi/orb/models/subscription_update_trial_response.rbi +712 -447
- data/rbi/orb/models/subscription_usage.rbi +271 -121
- data/rbi/orb/models/subscriptions.rbi +18 -11
- data/rbi/orb/models/top_level_ping_params.rbi +10 -4
- data/rbi/orb/models/top_level_ping_response.rbi +7 -3
- data/rbi/orb/models/trial_discount.rbi +29 -20
- data/rbi/orb/models/usage_discount.rbi +28 -19
- data/rbi/orb/models.rbi +22 -11
- data/rbi/orb/request_options.rbi +12 -6
- data/rbi/orb/resources/alerts.rbi +61 -40
- data/rbi/orb/resources/coupons/subscriptions.rbi +7 -5
- data/rbi/orb/resources/coupons.rbi +33 -18
- data/rbi/orb/resources/credit_notes.rbi +22 -13
- data/rbi/orb/resources/customers/balance_transactions.rbi +17 -9
- data/rbi/orb/resources/customers/costs.rbi +18 -11
- data/rbi/orb/resources/customers/credits/ledger.rbi +98 -74
- data/rbi/orb/resources/customers/credits/top_ups.rbi +61 -25
- data/rbi/orb/resources/customers/credits.rbi +16 -7
- data/rbi/orb/resources/customers.rbi +137 -72
- data/rbi/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rbi +8 -4
- data/rbi/orb/resources/dimensional_price_groups.rbi +26 -12
- data/rbi/orb/resources/events/backfills.rbi +35 -17
- data/rbi/orb/resources/events/volume.rbi +7 -5
- data/rbi/orb/resources/events.rbi +26 -16
- data/rbi/orb/resources/invoice_line_items.rbi +7 -5
- data/rbi/orb/resources/invoices.rbi +72 -41
- data/rbi/orb/resources/items.rbi +40 -13
- data/rbi/orb/resources/metrics.rbi +25 -15
- data/rbi/orb/resources/plans/external_plan_id.rbi +15 -7
- data/rbi/orb/resources/plans.rbi +57 -47
- data/rbi/orb/resources/prices/external_price_id.rbi +73 -68
- data/rbi/orb/resources/prices.rbi +176 -156
- data/rbi/orb/resources/subscription_changes.rbi +19 -11
- data/rbi/orb/resources/subscriptions.rbi +200 -114
- data/rbi/orb/resources/top_level.rbi +9 -3
- data/sig/orb/internal/page.rbs +0 -2
- data/sig/orb/internal/type/request_parameters.rbs +3 -1
- data/sig/orb/models/alert.rbs +19 -31
- data/sig/orb/models/alert_create_for_customer_params.rbs +3 -7
- data/sig/orb/models/alert_create_for_external_customer_params.rbs +3 -7
- data/sig/orb/models/alert_create_for_subscription_params.rbs +3 -7
- data/sig/orb/models/alert_disable_params.rbs +0 -2
- data/sig/orb/models/alert_enable_params.rbs +0 -2
- data/sig/orb/models/alert_list_params.rbs +0 -2
- data/sig/orb/models/alert_retrieve_params.rbs +0 -2
- data/sig/orb/models/alert_update_params.rbs +3 -7
- data/sig/orb/models/amount_discount.rbs +4 -6
- data/sig/orb/models/billable_metric.rbs +7 -9
- data/sig/orb/models/coupon.rbs +5 -8
- data/sig/orb/models/coupon_archive_params.rbs +0 -2
- data/sig/orb/models/coupon_create_params.rbs +3 -9
- data/sig/orb/models/coupon_fetch_params.rbs +0 -2
- data/sig/orb/models/coupon_list_params.rbs +0 -2
- data/sig/orb/models/coupons/subscription_list_params.rbs +0 -2
- data/sig/orb/models/credit_note.rbs +48 -66
- data/sig/orb/models/credit_note_create_params.rbs +3 -7
- data/sig/orb/models/credit_note_fetch_params.rbs +0 -2
- data/sig/orb/models/credit_note_list_params.rbs +0 -2
- data/sig/orb/models/customer.rbs +43 -63
- data/sig/orb/models/customer_create_params.rbs +32 -52
- data/sig/orb/models/customer_delete_params.rbs +0 -2
- data/sig/orb/models/customer_fetch_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customer_fetch_params.rbs +0 -2
- data/sig/orb/models/customer_list_params.rbs +0 -2
- data/sig/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbs +0 -2
- data/sig/orb/models/customer_sync_payment_methods_from_gateway_params.rbs +0 -2
- data/sig/orb/models/customer_update_by_external_id_params.rbs +32 -52
- data/sig/orb/models/customer_update_params.rbs +32 -52
- data/sig/orb/models/customers/balance_transaction_create_params.rbs +0 -2
- data/sig/orb/models/customers/balance_transaction_create_response.rbs +0 -6
- data/sig/orb/models/customers/balance_transaction_list_params.rbs +0 -2
- data/sig/orb/models/customers/balance_transaction_list_response.rbs +0 -6
- data/sig/orb/models/customers/cost_list_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customers/cost_list_by_external_id_response.rbs +0 -6
- data/sig/orb/models/customers/cost_list_params.rbs +0 -2
- data/sig/orb/models/customers/cost_list_response.rbs +0 -6
- data/sig/orb/models/customers/credit_list_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customers/credit_list_by_external_id_response.rbs +0 -2
- data/sig/orb/models/customers/credit_list_params.rbs +0 -2
- data/sig/orb/models/customers/credit_list_response.rbs +0 -2
- data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbs +3 -7
- data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbs +1 -43
- data/sig/orb/models/customers/credits/ledger_create_entry_params.rbs +3 -7
- data/sig/orb/models/customers/credits/ledger_create_entry_response.rbs +1 -43
- data/sig/orb/models/customers/credits/ledger_list_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customers/credits/ledger_list_by_external_id_response.rbs +1 -43
- data/sig/orb/models/customers/credits/ledger_list_params.rbs +0 -2
- data/sig/orb/models/customers/credits/ledger_list_response.rbs +1 -43
- data/sig/orb/models/customers/credits/top_up_create_by_external_id_params.rbs +3 -7
- data/sig/orb/models/customers/credits/top_up_create_by_external_id_response.rbs +0 -4
- data/sig/orb/models/customers/credits/top_up_create_params.rbs +3 -7
- data/sig/orb/models/customers/credits/top_up_create_response.rbs +0 -4
- data/sig/orb/models/customers/credits/top_up_delete_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customers/credits/top_up_delete_params.rbs +0 -2
- data/sig/orb/models/customers/credits/top_up_list_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customers/credits/top_up_list_by_external_id_response.rbs +0 -4
- data/sig/orb/models/customers/credits/top_up_list_params.rbs +0 -2
- data/sig/orb/models/customers/credits/top_up_list_response.rbs +0 -4
- data/sig/orb/models/dimensional_price_group.rbs +0 -2
- data/sig/orb/models/dimensional_price_group_create_params.rbs +0 -2
- data/sig/orb/models/dimensional_price_group_list_params.rbs +0 -2
- data/sig/orb/models/dimensional_price_group_retrieve_params.rbs +0 -2
- data/sig/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbs +0 -2
- data/sig/orb/models/dimensional_price_groups.rbs +6 -8
- data/sig/orb/models/discount.rbs +5 -5
- data/sig/orb/models/evaluate_price_group.rbs +4 -6
- data/sig/orb/models/event_deprecate_params.rbs +0 -2
- data/sig/orb/models/event_deprecate_response.rbs +0 -2
- data/sig/orb/models/event_ingest_params.rbs +3 -7
- data/sig/orb/models/event_ingest_response.rbs +0 -6
- data/sig/orb/models/event_search_params.rbs +0 -2
- data/sig/orb/models/event_search_response.rbs +0 -4
- data/sig/orb/models/event_update_params.rbs +0 -2
- data/sig/orb/models/event_update_response.rbs +0 -2
- data/sig/orb/models/events/backfill_close_params.rbs +0 -2
- data/sig/orb/models/events/backfill_close_response.rbs +0 -2
- data/sig/orb/models/events/backfill_create_params.rbs +0 -2
- data/sig/orb/models/events/backfill_create_response.rbs +0 -2
- data/sig/orb/models/events/backfill_fetch_params.rbs +0 -2
- data/sig/orb/models/events/backfill_fetch_response.rbs +0 -2
- data/sig/orb/models/events/backfill_list_params.rbs +0 -2
- data/sig/orb/models/events/backfill_list_response.rbs +0 -2
- data/sig/orb/models/events/backfill_revert_params.rbs +0 -2
- data/sig/orb/models/events/backfill_revert_response.rbs +0 -2
- data/sig/orb/models/events/event_volumes.rbs +3 -10
- data/sig/orb/models/events/volume_list_params.rbs +0 -2
- data/sig/orb/models/invoice.rbs +110 -172
- data/sig/orb/models/invoice_create_params.rbs +10 -16
- data/sig/orb/models/invoice_fetch_params.rbs +0 -2
- data/sig/orb/models/invoice_fetch_upcoming_params.rbs +0 -2
- data/sig/orb/models/invoice_fetch_upcoming_response.rbs +2 -64
- data/sig/orb/models/invoice_issue_params.rbs +0 -2
- data/sig/orb/models/invoice_level_discount.rbs +2 -4
- data/sig/orb/models/invoice_line_item_create_params.rbs +0 -2
- data/sig/orb/models/invoice_line_item_create_response.rbs +2 -36
- data/sig/orb/models/invoice_list_params.rbs +4 -6
- data/sig/orb/models/invoice_mark_paid_params.rbs +0 -2
- data/sig/orb/models/invoice_pay_params.rbs +0 -2
- data/sig/orb/models/invoice_update_params.rbs +0 -2
- data/sig/orb/models/invoice_void_params.rbs +0 -2
- data/sig/orb/models/item.rbs +7 -11
- data/sig/orb/models/item_create_params.rbs +0 -2
- data/sig/orb/models/item_fetch_params.rbs +0 -2
- data/sig/orb/models/item_list_params.rbs +0 -2
- data/sig/orb/models/item_update_params.rbs +7 -11
- data/sig/orb/models/metric_create_params.rbs +0 -2
- data/sig/orb/models/metric_fetch_params.rbs +0 -2
- data/sig/orb/models/metric_list_params.rbs +0 -2
- data/sig/orb/models/metric_update_params.rbs +0 -2
- data/sig/orb/models/pagination_metadata.rbs +0 -2
- data/sig/orb/models/percentage_discount.rbs +4 -6
- data/sig/orb/models/plan.rbs +45 -73
- data/sig/orb/models/plan_create_params.rbs +518 -696
- data/sig/orb/models/plan_fetch_params.rbs +0 -2
- data/sig/orb/models/plan_list_params.rbs +0 -2
- data/sig/orb/models/plan_update_params.rbs +0 -2
- data/sig/orb/models/plans/external_plan_id_fetch_params.rbs +0 -2
- data/sig/orb/models/plans/external_plan_id_update_params.rbs +0 -2
- data/sig/orb/models/price.rbs +1194 -1730
- data/sig/orb/models/price_create_params.rbs +59 -97
- data/sig/orb/models/price_evaluate_params.rbs +0 -2
- data/sig/orb/models/price_evaluate_response.rbs +3 -6
- data/sig/orb/models/price_fetch_params.rbs +0 -2
- data/sig/orb/models/price_list_params.rbs +0 -2
- data/sig/orb/models/price_update_params.rbs +0 -2
- data/sig/orb/models/prices/external_price_id_fetch_params.rbs +0 -2
- data/sig/orb/models/prices/external_price_id_update_params.rbs +0 -2
- data/sig/orb/models/subscription.rbs +56 -94
- data/sig/orb/models/subscription_cancel_params.rbs +0 -2
- data/sig/orb/models/subscription_cancel_response.rbs +20 -60
- data/sig/orb/models/subscription_change_apply_params.rbs +0 -2
- data/sig/orb/models/subscription_change_apply_response.rbs +20 -62
- data/sig/orb/models/subscription_change_cancel_params.rbs +0 -2
- data/sig/orb/models/subscription_change_cancel_response.rbs +20 -62
- data/sig/orb/models/subscription_change_retrieve_params.rbs +0 -2
- data/sig/orb/models/subscription_change_retrieve_response.rbs +20 -62
- data/sig/orb/models/subscription_create_params.rbs +1103 -1499
- data/sig/orb/models/subscription_create_response.rbs +20 -60
- data/sig/orb/models/subscription_fetch_costs_params.rbs +0 -2
- data/sig/orb/models/subscription_fetch_costs_response.rbs +0 -6
- data/sig/orb/models/subscription_fetch_params.rbs +0 -2
- data/sig/orb/models/subscription_fetch_schedule_params.rbs +0 -2
- data/sig/orb/models/subscription_fetch_schedule_response.rbs +0 -4
- data/sig/orb/models/subscription_fetch_usage_params.rbs +0 -2
- data/sig/orb/models/subscription_list_params.rbs +0 -2
- data/sig/orb/models/subscription_price_intervals_params.rbs +666 -896
- data/sig/orb/models/subscription_price_intervals_response.rbs +20 -60
- data/sig/orb/models/subscription_schedule_plan_change_params.rbs +1103 -1499
- data/sig/orb/models/subscription_schedule_plan_change_response.rbs +20 -60
- data/sig/orb/models/subscription_trigger_phase_params.rbs +0 -2
- data/sig/orb/models/subscription_trigger_phase_response.rbs +20 -60
- data/sig/orb/models/subscription_unschedule_cancellation_params.rbs +0 -2
- data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +20 -60
- data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbs +0 -2
- data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +20 -60
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_params.rbs +0 -2
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +20 -60
- data/sig/orb/models/subscription_update_fixed_fee_quantity_params.rbs +0 -2
- data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +20 -60
- data/sig/orb/models/subscription_update_params.rbs +0 -2
- data/sig/orb/models/subscription_update_trial_params.rbs +1 -3
- data/sig/orb/models/subscription_update_trial_response.rbs +20 -60
- data/sig/orb/models/subscription_usage.rbs +35 -53
- data/sig/orb/models/subscriptions.rbs +6 -8
- data/sig/orb/models/top_level_ping_params.rbs +0 -2
- data/sig/orb/models/top_level_ping_response.rbs +0 -2
- data/sig/orb/models/trial_discount.rbs +4 -6
- data/sig/orb/models/usage_discount.rbs +4 -6
- data/sig/orb/request_options.rbs +1 -1
- data/sig/orb/resources/alerts.rbs +12 -12
- data/sig/orb/resources/coupons/subscriptions.rbs +1 -1
- data/sig/orb/resources/coupons.rbs +4 -4
- data/sig/orb/resources/credit_notes.rbs +4 -4
- data/sig/orb/resources/customers/credits/ledger.rbs +2 -2
- data/sig/orb/resources/customers/credits/top_ups.rbs +2 -2
- data/sig/orb/resources/customers.rbs +24 -24
- data/sig/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rbs +1 -1
- data/sig/orb/resources/dimensional_price_groups.rbs +3 -3
- data/sig/orb/resources/events/volume.rbs +1 -1
- data/sig/orb/resources/events.rbs +1 -1
- data/sig/orb/resources/invoices.rbs +10 -10
- data/sig/orb/resources/items.rbs +5 -5
- data/sig/orb/resources/metrics.rbs +4 -4
- data/sig/orb/resources/plans/external_plan_id.rbs +2 -2
- data/sig/orb/resources/plans.rbs +5 -5
- data/sig/orb/resources/prices.rbs +11 -11
- data/sig/orb/resources/subscriptions.rbs +21 -21
- metadata +2 -2
@@ -23,8 +23,8 @@ module Orb
|
|
23
23
|
|
24
24
|
# @!attribute line_items
|
25
25
|
#
|
26
|
-
# @return [Array<Orb::
|
27
|
-
required :line_items, -> { Orb::Internal::Type::ArrayOf[Orb::
|
26
|
+
# @return [Array<Orb::InvoiceCreateParams::LineItem>]
|
27
|
+
required :line_items, -> { Orb::Internal::Type::ArrayOf[Orb::InvoiceCreateParams::LineItem] }
|
28
28
|
|
29
29
|
# @!attribute net_terms
|
30
30
|
# Determines the difference between the invoice issue date for subscription
|
@@ -45,8 +45,8 @@ module Orb
|
|
45
45
|
# @!attribute discount
|
46
46
|
# An optional discount to attach to the invoice.
|
47
47
|
#
|
48
|
-
# @return [Orb::
|
49
|
-
optional :discount, union: -> { Orb::
|
48
|
+
# @return [Orb::PercentageDiscount, Orb::TrialDiscount, Orb::UsageDiscount, Orb::AmountDiscount, nil]
|
49
|
+
optional :discount, union: -> { Orb::Discount }, nil?: true
|
50
50
|
|
51
51
|
# @!attribute external_customer_id
|
52
52
|
# The `external_customer_id` of the `Customer` to create this invoice for. One of
|
@@ -82,31 +82,24 @@ module Orb
|
|
82
82
|
# {Orb::Models::InvoiceCreateParams} for more details.
|
83
83
|
#
|
84
84
|
# @param currency [String] An ISO 4217 currency string. Must be the same as the customer's currency if it i
|
85
|
-
# ...
|
86
85
|
#
|
87
86
|
# @param invoice_date [Time] Optional invoice date to set. Must be in the past, if not set, `invoice_date` is
|
88
|
-
# ...
|
89
87
|
#
|
90
|
-
# @param line_items [Array<Orb::
|
88
|
+
# @param line_items [Array<Orb::InvoiceCreateParams::LineItem>]
|
91
89
|
#
|
92
90
|
# @param net_terms [Integer] Determines the difference between the invoice issue date for subscription invoic
|
93
|
-
# ...
|
94
91
|
#
|
95
92
|
# @param customer_id [String, nil] The id of the `Customer` to create this invoice for. One of `customer_id` and `e
|
96
|
-
# ...
|
97
93
|
#
|
98
|
-
# @param discount [Orb::
|
94
|
+
# @param discount [Orb::PercentageDiscount, Orb::TrialDiscount, Orb::UsageDiscount, Orb::AmountDiscount, nil] An optional discount to attach to the invoice.
|
99
95
|
#
|
100
96
|
# @param external_customer_id [String, nil] The `external_customer_id` of the `Customer` to create this invoice for. One of
|
101
|
-
# ...
|
102
97
|
#
|
103
98
|
# @param memo [String, nil] An optional memo to attach to the invoice.
|
104
99
|
#
|
105
100
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
106
|
-
# ...
|
107
101
|
#
|
108
102
|
# @param will_auto_issue [Boolean] When true, this invoice will be submitted for issuance upon creation. When false
|
109
|
-
# ...
|
110
103
|
#
|
111
104
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
112
105
|
|
@@ -124,8 +117,8 @@ module Orb
|
|
124
117
|
|
125
118
|
# @!attribute model_type
|
126
119
|
#
|
127
|
-
# @return [Symbol, Orb::
|
128
|
-
required :model_type, enum: -> { Orb::
|
120
|
+
# @return [Symbol, Orb::InvoiceCreateParams::LineItem::ModelType]
|
121
|
+
required :model_type, enum: -> { Orb::InvoiceCreateParams::LineItem::ModelType }
|
129
122
|
|
130
123
|
# @!attribute name
|
131
124
|
# The name of the line item.
|
@@ -147,15 +140,15 @@ module Orb
|
|
147
140
|
|
148
141
|
# @!attribute unit_config
|
149
142
|
#
|
150
|
-
# @return [Orb::
|
151
|
-
required :unit_config, -> { Orb::
|
143
|
+
# @return [Orb::InvoiceCreateParams::LineItem::UnitConfig]
|
144
|
+
required :unit_config, -> { Orb::InvoiceCreateParams::LineItem::UnitConfig }
|
152
145
|
|
153
146
|
# @!method initialize(end_date:, item_id:, model_type:, name:, quantity:, start_date:, unit_config:)
|
154
147
|
# @param end_date [Date] A date string to specify the line item's end date in the customer's timezone.
|
155
148
|
#
|
156
149
|
# @param item_id [String]
|
157
150
|
#
|
158
|
-
# @param model_type [Symbol, Orb::
|
151
|
+
# @param model_type [Symbol, Orb::InvoiceCreateParams::LineItem::ModelType]
|
159
152
|
#
|
160
153
|
# @param name [String] The name of the line item.
|
161
154
|
#
|
@@ -163,9 +156,9 @@ module Orb
|
|
163
156
|
#
|
164
157
|
# @param start_date [Date] A date string to specify the line item's start date in the customer's timezone.
|
165
158
|
#
|
166
|
-
# @param unit_config [Orb::
|
159
|
+
# @param unit_config [Orb::InvoiceCreateParams::LineItem::UnitConfig]
|
167
160
|
|
168
|
-
# @see Orb::
|
161
|
+
# @see Orb::InvoiceCreateParams::LineItem#model_type
|
169
162
|
module ModelType
|
170
163
|
extend Orb::Internal::Type::Enum
|
171
164
|
|
@@ -175,7 +168,7 @@ module Orb
|
|
175
168
|
# @return [Array<Symbol>]
|
176
169
|
end
|
177
170
|
|
178
|
-
# @see Orb::
|
171
|
+
# @see Orb::InvoiceCreateParams::LineItem#unit_config
|
179
172
|
class UnitConfig < Orb::Internal::Type::BaseModel
|
180
173
|
# @!attribute unit_amount
|
181
174
|
# Rate per unit of usage
|
@@ -178,8 +178,8 @@ module Orb
|
|
178
178
|
|
179
179
|
# @!attribute discounts
|
180
180
|
#
|
181
|
-
# @return [Array<Orb::
|
182
|
-
required :discounts, -> { Orb::Internal::Type::ArrayOf[union: Orb::
|
181
|
+
# @return [Array<Orb::PercentageDiscount, Orb::AmountDiscount, Orb::TrialDiscount>]
|
182
|
+
required :discounts, -> { Orb::Internal::Type::ArrayOf[union: Orb::InvoiceLevelDiscount] }
|
183
183
|
|
184
184
|
# @!attribute due_date
|
185
185
|
# When the invoice payment is due. The due date is null if the invoice is not yet
|
@@ -376,7 +376,6 @@ module Orb
|
|
376
376
|
# @param id [String]
|
377
377
|
#
|
378
378
|
# @param amount_due [String] This is the final amount required to be charged to the customer and reflects the
|
379
|
-
# ...
|
380
379
|
#
|
381
380
|
# @param auto_collection [Orb::Models::InvoiceFetchUpcomingResponse::AutoCollection]
|
382
381
|
#
|
@@ -393,34 +392,26 @@ module Orb
|
|
393
392
|
# @param customer_balance_transactions [Array<Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction>]
|
394
393
|
#
|
395
394
|
# @param customer_tax_id [Orb::Models::InvoiceFetchUpcomingResponse::CustomerTaxID, nil] Tax IDs are commonly required to be displayed on customer invoices, which are ad
|
396
|
-
# ...
|
397
395
|
#
|
398
396
|
# @param discount [Object] This field is deprecated in favor of `discounts`. If a `discounts` list is provi
|
399
|
-
# ...
|
400
397
|
#
|
401
|
-
# @param discounts [Array<Orb::
|
398
|
+
# @param discounts [Array<Orb::PercentageDiscount, Orb::AmountDiscount, Orb::TrialDiscount>]
|
402
399
|
#
|
403
400
|
# @param due_date [Time, nil] When the invoice payment is due. The due date is null if the invoice is not yet
|
404
|
-
# ...
|
405
401
|
#
|
406
402
|
# @param eligible_to_issue_at [Time, nil] If the invoice has a status of `draft`, this will be the time that the invoice w
|
407
|
-
# ...
|
408
403
|
#
|
409
404
|
# @param hosted_invoice_url [String, nil] A URL for the customer-facing invoice portal. This URL expires 30 days after the
|
410
|
-
# ...
|
411
405
|
#
|
412
406
|
# @param invoice_number [String] Automatically generated invoice number to help track and reconcile invoices. Inv
|
413
|
-
# ...
|
414
407
|
#
|
415
408
|
# @param invoice_pdf [String, nil] The link to download the PDF representation of the `Invoice`.
|
416
409
|
#
|
417
410
|
# @param invoice_source [Symbol, Orb::Models::InvoiceFetchUpcomingResponse::InvoiceSource]
|
418
411
|
#
|
419
412
|
# @param issue_failed_at [Time, nil] If the invoice failed to issue, this will be the last time it failed to issue (e
|
420
|
-
# ...
|
421
413
|
#
|
422
414
|
# @param issued_at [Time, nil] If the invoice has been issued, this will be the time it transitioned to `issued
|
423
|
-
# ...
|
424
415
|
#
|
425
416
|
# @param line_items [Array<Orb::Models::InvoiceFetchUpcomingResponse::LineItem>] The breakdown of prices in this invoice.
|
426
417
|
#
|
@@ -429,28 +420,22 @@ module Orb
|
|
429
420
|
# @param maximum_amount [String, nil]
|
430
421
|
#
|
431
422
|
# @param memo [String, nil] Free-form text which is available on the invoice PDF and the Orb invoice portal.
|
432
|
-
# ...
|
433
423
|
#
|
434
424
|
# @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
|
435
|
-
# ...
|
436
425
|
#
|
437
426
|
# @param minimum [Orb::Models::InvoiceFetchUpcomingResponse::Minimum, nil]
|
438
427
|
#
|
439
428
|
# @param minimum_amount [String, nil]
|
440
429
|
#
|
441
430
|
# @param paid_at [Time, nil] If the invoice has a status of `paid`, this gives a timestamp when the invoice w
|
442
|
-
# ...
|
443
431
|
#
|
444
432
|
# @param payment_attempts [Array<Orb::Models::InvoiceFetchUpcomingResponse::PaymentAttempt>] A list of payment attempts associated with the invoice
|
445
433
|
#
|
446
434
|
# @param payment_failed_at [Time, nil] If payment was attempted on this invoice but failed, this will be the time of th
|
447
|
-
# ...
|
448
435
|
#
|
449
436
|
# @param payment_started_at [Time, nil] If payment was attempted on this invoice, this will be the start time of the mos
|
450
|
-
# ...
|
451
437
|
#
|
452
438
|
# @param scheduled_issue_at [Time, nil] If the invoice is in draft, this timestamp will reflect when the invoice is sche
|
453
|
-
# ...
|
454
439
|
#
|
455
440
|
# @param shipping_address [Orb::Models::InvoiceFetchUpcomingResponse::ShippingAddress, nil]
|
456
441
|
#
|
@@ -461,17 +446,14 @@ module Orb
|
|
461
446
|
# @param subtotal [String] The total before any discounts and minimums are applied.
|
462
447
|
#
|
463
448
|
# @param sync_failed_at [Time, nil] If the invoice failed to sync, this will be the last time an external invoicing
|
464
|
-
# ...
|
465
449
|
#
|
466
450
|
# @param target_date [Time] The scheduled date of the invoice
|
467
451
|
#
|
468
452
|
# @param total [String] The total after any minimums and discounts have been applied.
|
469
453
|
#
|
470
454
|
# @param voided_at [Time, nil] If the invoice has a status of `void`, this gives a timestamp when the invoice w
|
471
|
-
# ...
|
472
455
|
#
|
473
456
|
# @param will_auto_issue [Boolean] This is true if the invoice will be automatically issued in the future, and fals
|
474
|
-
# ...
|
475
457
|
|
476
458
|
# @see Orb::Models::InvoiceFetchUpcomingResponse#auto_collection
|
477
459
|
class AutoCollection < Orb::Internal::Type::BaseModel
|
@@ -513,12 +495,10 @@ module Orb
|
|
513
495
|
# @param enabled [Boolean, nil] True only if auto-collection is enabled for this invoice.
|
514
496
|
#
|
515
497
|
# @param next_attempt_at [Time, nil] If the invoice is scheduled for auto-collection, this field will reflect when th
|
516
|
-
# ...
|
517
498
|
#
|
518
499
|
# @param num_attempts [Integer, nil] Number of auto-collection payment attempts.
|
519
500
|
#
|
520
501
|
# @param previously_attempted_at [Time, nil] If Orb has ever attempted payment auto-collection for this invoice, this field w
|
521
|
-
# ...
|
522
502
|
end
|
523
503
|
|
524
504
|
# @see Orb::Models::InvoiceFetchUpcomingResponse#billing_address
|
@@ -618,7 +598,6 @@ module Orb
|
|
618
598
|
# @param type [String]
|
619
599
|
#
|
620
600
|
# @param voided_at [Time, nil] If the credit note has a status of `void`, this gives a timestamp when the credi
|
621
|
-
# ...
|
622
601
|
end
|
623
602
|
|
624
603
|
# @see Orb::Models::InvoiceFetchUpcomingResponse#customer
|
@@ -720,12 +699,10 @@ module Orb
|
|
720
699
|
# @param description [String, nil] An optional description provided for manual customer balance adjustments.
|
721
700
|
#
|
722
701
|
# @param ending_balance [String] The new value of the customer's balance prior to the transaction, in the custome
|
723
|
-
# ...
|
724
702
|
#
|
725
703
|
# @param invoice [Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction::Invoice, nil]
|
726
704
|
#
|
727
705
|
# @param starting_balance [String] The original value of the customer's balance prior to the transaction, in the cu
|
728
|
-
# ...
|
729
706
|
#
|
730
707
|
# @param type [Symbol, Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction::Type]
|
731
708
|
|
@@ -1129,8 +1106,8 @@ module Orb
|
|
1129
1106
|
|
1130
1107
|
# @!attribute discount
|
1131
1108
|
#
|
1132
|
-
# @return [Orb::
|
1133
|
-
required :discount, union: -> { Orb::
|
1109
|
+
# @return [Orb::PercentageDiscount, Orb::TrialDiscount, Orb::UsageDiscount, Orb::AmountDiscount, nil]
|
1110
|
+
required :discount, union: -> { Orb::Discount }, nil?: true
|
1134
1111
|
|
1135
1112
|
# @!attribute end_date
|
1136
1113
|
# The end date of the range of time applied for this line item's price.
|
@@ -1208,8 +1185,8 @@ module Orb
|
|
1208
1185
|
# For more on the types of prices, see
|
1209
1186
|
# [the core concepts documentation](/core-concepts#plan-and-price)
|
1210
1187
|
#
|
1211
|
-
# @return [Orb::
|
1212
|
-
required :price, union: -> { Orb::
|
1188
|
+
# @return [Orb::Price::Unit, Orb::Price::Package, Orb::Price::Matrix, Orb::Price::Tiered, Orb::Price::TieredBps, Orb::Price::Bps, Orb::Price::BulkBps, Orb::Price::Bulk, Orb::Price::ThresholdTotalAmount, Orb::Price::TieredPackage, Orb::Price::GroupedTiered, Orb::Price::TieredWithMinimum, Orb::Price::TieredPackageWithMinimum, Orb::Price::PackageWithAllocation, Orb::Price::UnitWithPercent, Orb::Price::MatrixWithAllocation, Orb::Price::TieredWithProration, Orb::Price::UnitWithProration, Orb::Price::GroupedAllocation, Orb::Price::GroupedWithProratedMinimum, Orb::Price::GroupedWithMeteredMinimum, Orb::Price::MatrixWithDisplayName, Orb::Price::BulkWithProration, Orb::Price::GroupedTieredPackage, Orb::Price::MaxGroupTieredPackage, Orb::Price::ScalableMatrixWithUnitPricing, Orb::Price::ScalableMatrixWithTieredPricing, Orb::Price::CumulativeGroupedBulk, nil]
|
1189
|
+
required :price, union: -> { Orb::Price }, nil?: true
|
1213
1190
|
|
1214
1191
|
# @!attribute quantity
|
1215
1192
|
# Either the fixed fee quantity or the usage during the service period.
|
@@ -1258,24 +1235,20 @@ module Orb
|
|
1258
1235
|
# @param id [String] A unique ID for this line item.
|
1259
1236
|
#
|
1260
1237
|
# @param adjusted_subtotal [String] The line amount after any adjustments and before overage conversion, credits and
|
1261
|
-
# ...
|
1262
1238
|
#
|
1263
1239
|
# @param adjustments [Array<Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::UsageDiscount, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::AmountDiscount, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::PercentageDiscount, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::Minimum, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::Maximum>] All adjustments applied to the line item in the order they were applied based on
|
1264
|
-
# ...
|
1265
1240
|
#
|
1266
1241
|
# @param amount [String] The final amount for a line item after all adjustments and pre paid credits have
|
1267
|
-
# ...
|
1268
1242
|
#
|
1269
1243
|
# @param credits_applied [String] The number of prepaid credits applied.
|
1270
1244
|
#
|
1271
|
-
# @param discount [Orb::
|
1245
|
+
# @param discount [Orb::PercentageDiscount, Orb::TrialDiscount, Orb::UsageDiscount, Orb::AmountDiscount, nil]
|
1272
1246
|
#
|
1273
1247
|
# @param end_date [Time] The end date of the range of time applied for this line item's price.
|
1274
1248
|
#
|
1275
1249
|
# @param filter [String, nil] An additional filter that was used to calculate the usage for this line item.
|
1276
1250
|
#
|
1277
1251
|
# @param grouping [String, nil] [DEPRECATED] For configured prices that are split by a grouping key, this will b
|
1278
|
-
# ...
|
1279
1252
|
#
|
1280
1253
|
# @param maximum [Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Maximum, nil] This field is deprecated in favor of `adjustments`.
|
1281
1254
|
#
|
@@ -1289,23 +1262,19 @@ module Orb
|
|
1289
1262
|
#
|
1290
1263
|
# @param partially_invoiced_amount [String] Any amount applied from a partial invoice
|
1291
1264
|
#
|
1292
|
-
# @param price [Orb::
|
1293
|
-
# ...
|
1265
|
+
# @param price [Orb::Price::Unit, Orb::Price::Package, Orb::Price::Matrix, Orb::Price::Tiered, Orb::Price::TieredBps, Orb::Price::Bps, Orb::Price::BulkBps, Orb::Price::Bulk, Orb::Price::ThresholdTotalAmount, Orb::Price::TieredPackage, Orb::Price::GroupedTiered, Orb::Price::TieredWithMinimum, Orb::Price::TieredPackageWithMinimum, Orb::Price::PackageWithAllocation, Orb::Price::UnitWithPercent, Orb::Price::MatrixWithAllocation, Orb::Price::TieredWithProration, Orb::Price::UnitWithProration, Orb::Price::GroupedAllocation, Orb::Price::GroupedWithProratedMinimum, Orb::Price::GroupedWithMeteredMinimum, Orb::Price::MatrixWithDisplayName, Orb::Price::BulkWithProration, Orb::Price::GroupedTieredPackage, Orb::Price::MaxGroupTieredPackage, Orb::Price::ScalableMatrixWithUnitPricing, Orb::Price::ScalableMatrixWithTieredPricing, Orb::Price::CumulativeGroupedBulk, nil] The Price resource represents a price that can be billed on a subscription, resu
|
1294
1266
|
#
|
1295
1267
|
# @param quantity [Float] Either the fixed fee quantity or the usage during the service period.
|
1296
1268
|
#
|
1297
1269
|
# @param start_date [Time] The start date of the range of time applied for this line item's price.
|
1298
1270
|
#
|
1299
1271
|
# @param sub_line_items [Array<Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Matrix, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Tier, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Null>] For complex pricing structures, the line item can be broken down further in `sub
|
1300
|
-
# ...
|
1301
1272
|
#
|
1302
1273
|
# @param subtotal [String] The line amount before before any adjustments.
|
1303
1274
|
#
|
1304
1275
|
# @param tax_amounts [Array<Orb::Models::InvoiceFetchUpcomingResponse::LineItem::TaxAmount>] An array of tax rates and their incurred tax amounts. Empty if no tax integratio
|
1305
|
-
# ...
|
1306
1276
|
#
|
1307
1277
|
# @param usage_customer_ids [Array<String>, nil] A list of customer ids that were used to calculate the usage for this line item.
|
1308
|
-
# ...
|
1309
1278
|
|
1310
1279
|
module Adjustment
|
1311
1280
|
extend Orb::Internal::Type::Union
|
@@ -1380,12 +1349,10 @@ module Orb
|
|
1380
1349
|
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
1381
1350
|
#
|
1382
1351
|
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
1383
|
-
# ...
|
1384
1352
|
#
|
1385
1353
|
# @param reason [String, nil] The reason for the adjustment.
|
1386
1354
|
#
|
1387
1355
|
# @param usage_discount [Float] The number of usage units by which to discount the price this adjustment applies
|
1388
|
-
# ...
|
1389
1356
|
#
|
1390
1357
|
# @param adjustment_type [Symbol, :usage_discount]
|
1391
1358
|
end
|
@@ -1443,12 +1410,10 @@ module Orb
|
|
1443
1410
|
# @param amount [String] The value applied by an adjustment.
|
1444
1411
|
#
|
1445
1412
|
# @param amount_discount [String] The amount by which to discount the prices this adjustment applies to in a given
|
1446
|
-
# ...
|
1447
1413
|
#
|
1448
1414
|
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
1449
1415
|
#
|
1450
1416
|
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
1451
|
-
# ...
|
1452
1417
|
#
|
1453
1418
|
# @param reason [String, nil] The reason for the adjustment.
|
1454
1419
|
#
|
@@ -1510,10 +1475,8 @@ module Orb
|
|
1510
1475
|
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
1511
1476
|
#
|
1512
1477
|
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
1513
|
-
# ...
|
1514
1478
|
#
|
1515
1479
|
# @param percentage_discount [Float] The percentage (as a value between 0 and 1) by which to discount the price inter
|
1516
|
-
# ...
|
1517
1480
|
#
|
1518
1481
|
# @param reason [String, nil] The reason for the adjustment.
|
1519
1482
|
#
|
@@ -1581,12 +1544,10 @@ module Orb
|
|
1581
1544
|
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
1582
1545
|
#
|
1583
1546
|
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
1584
|
-
# ...
|
1585
1547
|
#
|
1586
1548
|
# @param item_id [String] The item ID that revenue from this minimum will be attributed to.
|
1587
1549
|
#
|
1588
1550
|
# @param minimum_amount [String] The minimum amount to charge in a given billing period for the prices this adjus
|
1589
|
-
# ...
|
1590
1551
|
#
|
1591
1552
|
# @param reason [String, nil] The reason for the adjustment.
|
1592
1553
|
#
|
@@ -1648,10 +1609,8 @@ module Orb
|
|
1648
1609
|
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
1649
1610
|
#
|
1650
1611
|
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
1651
|
-
# ...
|
1652
1612
|
#
|
1653
1613
|
# @param maximum_amount [String] The maximum amount to charge in a given billing period for the prices this adjus
|
1654
|
-
# ...
|
1655
1614
|
#
|
1656
1615
|
# @param reason [String, nil] The reason for the adjustment.
|
1657
1616
|
#
|
@@ -1686,7 +1645,6 @@ module Orb
|
|
1686
1645
|
# This field is deprecated in favor of `adjustments`.
|
1687
1646
|
#
|
1688
1647
|
# @param applies_to_price_ids [Array<String>] List of price_ids that this maximum amount applies to. For plan/plan phase maxim
|
1689
|
-
# ...
|
1690
1648
|
#
|
1691
1649
|
# @param maximum_amount [String] Maximum amount applied
|
1692
1650
|
end
|
@@ -1715,7 +1673,6 @@ module Orb
|
|
1715
1673
|
# This field is deprecated in favor of `adjustments`.
|
1716
1674
|
#
|
1717
1675
|
# @param applies_to_price_ids [Array<String>] List of price_ids that this minimum amount applies to. For plan/plan phase minim
|
1718
|
-
# ...
|
1719
1676
|
#
|
1720
1677
|
# @param minimum_amount [String] Minimum amount applied
|
1721
1678
|
end
|
@@ -2014,7 +1971,6 @@ module Orb
|
|
2014
1971
|
# {Orb::Models::InvoiceFetchUpcomingResponse::Maximum} for more details.
|
2015
1972
|
#
|
2016
1973
|
# @param applies_to_price_ids [Array<String>] List of price_ids that this maximum amount applies to. For plan/plan phase maxim
|
2017
|
-
# ...
|
2018
1974
|
#
|
2019
1975
|
# @param maximum_amount [String] Maximum amount applied
|
2020
1976
|
end
|
@@ -2039,7 +1995,6 @@ module Orb
|
|
2039
1995
|
# {Orb::Models::InvoiceFetchUpcomingResponse::Minimum} for more details.
|
2040
1996
|
#
|
2041
1997
|
# @param applies_to_price_ids [Array<String>] List of price_ids that this minimum amount applies to. For plan/plan phase minim
|
2042
|
-
# ...
|
2043
1998
|
#
|
2044
1999
|
# @param minimum_amount [String] Minimum amount applied
|
2045
2000
|
end
|
@@ -22,7 +22,6 @@ module Orb
|
|
22
22
|
# {Orb::Models::InvoiceIssueParams} for more details.
|
23
23
|
#
|
24
24
|
# @param synchronous [Boolean] If true, the invoice will be issued synchronously. If false, the invoice will be
|
25
|
-
# ...
|
26
25
|
#
|
27
26
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
28
27
|
end
|
@@ -7,14 +7,14 @@ module Orb
|
|
7
7
|
|
8
8
|
discriminator :discount_type
|
9
9
|
|
10
|
-
variant :percentage, -> { Orb::
|
10
|
+
variant :percentage, -> { Orb::PercentageDiscount }
|
11
11
|
|
12
|
-
variant :amount, -> { Orb::
|
12
|
+
variant :amount, -> { Orb::AmountDiscount }
|
13
13
|
|
14
|
-
variant :trial, -> { Orb::
|
14
|
+
variant :trial, -> { Orb::TrialDiscount }
|
15
15
|
|
16
16
|
# @!method self.variants
|
17
|
-
# @return [Array(Orb::
|
17
|
+
# @return [Array(Orb::PercentageDiscount, Orb::AmountDiscount, Orb::TrialDiscount)]
|
18
18
|
end
|
19
19
|
end
|
20
20
|
end
|
@@ -55,7 +55,6 @@ module Orb
|
|
55
55
|
# @param invoice_id [String] The id of the Invoice to add this line item.
|
56
56
|
#
|
57
57
|
# @param name [String] The item name associated with this line item. If an item with the same name exis
|
58
|
-
# ...
|
59
58
|
#
|
60
59
|
# @param quantity [Float] The number of units on the line item
|
61
60
|
#
|
@@ -41,8 +41,8 @@ module Orb
|
|
41
41
|
|
42
42
|
# @!attribute discount
|
43
43
|
#
|
44
|
-
# @return [Orb::
|
45
|
-
required :discount, union: -> { Orb::
|
44
|
+
# @return [Orb::PercentageDiscount, Orb::TrialDiscount, Orb::UsageDiscount, Orb::AmountDiscount, nil]
|
45
|
+
required :discount, union: -> { Orb::Discount }, nil?: true
|
46
46
|
|
47
47
|
# @!attribute end_date
|
48
48
|
# The end date of the range of time applied for this line item's price.
|
@@ -120,8 +120,8 @@ module Orb
|
|
120
120
|
# For more on the types of prices, see
|
121
121
|
# [the core concepts documentation](/core-concepts#plan-and-price)
|
122
122
|
#
|
123
|
-
# @return [Orb::
|
124
|
-
required :price, union: -> { Orb::
|
123
|
+
# @return [Orb::Price::Unit, Orb::Price::Package, Orb::Price::Matrix, Orb::Price::Tiered, Orb::Price::TieredBps, Orb::Price::Bps, Orb::Price::BulkBps, Orb::Price::Bulk, Orb::Price::ThresholdTotalAmount, Orb::Price::TieredPackage, Orb::Price::GroupedTiered, Orb::Price::TieredWithMinimum, Orb::Price::TieredPackageWithMinimum, Orb::Price::PackageWithAllocation, Orb::Price::UnitWithPercent, Orb::Price::MatrixWithAllocation, Orb::Price::TieredWithProration, Orb::Price::UnitWithProration, Orb::Price::GroupedAllocation, Orb::Price::GroupedWithProratedMinimum, Orb::Price::GroupedWithMeteredMinimum, Orb::Price::MatrixWithDisplayName, Orb::Price::BulkWithProration, Orb::Price::GroupedTieredPackage, Orb::Price::MaxGroupTieredPackage, Orb::Price::ScalableMatrixWithUnitPricing, Orb::Price::ScalableMatrixWithTieredPricing, Orb::Price::CumulativeGroupedBulk, nil]
|
124
|
+
required :price, union: -> { Orb::Price }, nil?: true
|
125
125
|
|
126
126
|
# @!attribute quantity
|
127
127
|
# Either the fixed fee quantity or the usage during the service period.
|
@@ -170,24 +170,20 @@ module Orb
|
|
170
170
|
# @param id [String] A unique ID for this line item.
|
171
171
|
#
|
172
172
|
# @param adjusted_subtotal [String] The line amount after any adjustments and before overage conversion, credits and
|
173
|
-
# ...
|
174
173
|
#
|
175
174
|
# @param adjustments [Array<Orb::Models::InvoiceLineItemCreateResponse::Adjustment::UsageDiscount, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::AmountDiscount, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::PercentageDiscount, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::Minimum, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::Maximum>] All adjustments applied to the line item in the order they were applied based on
|
176
|
-
# ...
|
177
175
|
#
|
178
176
|
# @param amount [String] The final amount for a line item after all adjustments and pre paid credits have
|
179
|
-
# ...
|
180
177
|
#
|
181
178
|
# @param credits_applied [String] The number of prepaid credits applied.
|
182
179
|
#
|
183
|
-
# @param discount [Orb::
|
180
|
+
# @param discount [Orb::PercentageDiscount, Orb::TrialDiscount, Orb::UsageDiscount, Orb::AmountDiscount, nil]
|
184
181
|
#
|
185
182
|
# @param end_date [Time] The end date of the range of time applied for this line item's price.
|
186
183
|
#
|
187
184
|
# @param filter [String, nil] An additional filter that was used to calculate the usage for this line item.
|
188
185
|
#
|
189
186
|
# @param grouping [String, nil] [DEPRECATED] For configured prices that are split by a grouping key, this will b
|
190
|
-
# ...
|
191
187
|
#
|
192
188
|
# @param maximum [Orb::Models::InvoiceLineItemCreateResponse::Maximum, nil] This field is deprecated in favor of `adjustments`.
|
193
189
|
#
|
@@ -201,23 +197,19 @@ module Orb
|
|
201
197
|
#
|
202
198
|
# @param partially_invoiced_amount [String] Any amount applied from a partial invoice
|
203
199
|
#
|
204
|
-
# @param price [Orb::
|
205
|
-
# ...
|
200
|
+
# @param price [Orb::Price::Unit, Orb::Price::Package, Orb::Price::Matrix, Orb::Price::Tiered, Orb::Price::TieredBps, Orb::Price::Bps, Orb::Price::BulkBps, Orb::Price::Bulk, Orb::Price::ThresholdTotalAmount, Orb::Price::TieredPackage, Orb::Price::GroupedTiered, Orb::Price::TieredWithMinimum, Orb::Price::TieredPackageWithMinimum, Orb::Price::PackageWithAllocation, Orb::Price::UnitWithPercent, Orb::Price::MatrixWithAllocation, Orb::Price::TieredWithProration, Orb::Price::UnitWithProration, Orb::Price::GroupedAllocation, Orb::Price::GroupedWithProratedMinimum, Orb::Price::GroupedWithMeteredMinimum, Orb::Price::MatrixWithDisplayName, Orb::Price::BulkWithProration, Orb::Price::GroupedTieredPackage, Orb::Price::MaxGroupTieredPackage, Orb::Price::ScalableMatrixWithUnitPricing, Orb::Price::ScalableMatrixWithTieredPricing, Orb::Price::CumulativeGroupedBulk, nil] The Price resource represents a price that can be billed on a subscription, resu
|
206
201
|
#
|
207
202
|
# @param quantity [Float] Either the fixed fee quantity or the usage during the service period.
|
208
203
|
#
|
209
204
|
# @param start_date [Time] The start date of the range of time applied for this line item's price.
|
210
205
|
#
|
211
206
|
# @param sub_line_items [Array<Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Matrix, Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Tier, Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Null>] For complex pricing structures, the line item can be broken down further in `sub
|
212
|
-
# ...
|
213
207
|
#
|
214
208
|
# @param subtotal [String] The line amount before before any adjustments.
|
215
209
|
#
|
216
210
|
# @param tax_amounts [Array<Orb::Models::InvoiceLineItemCreateResponse::TaxAmount>] An array of tax rates and their incurred tax amounts. Empty if no tax integratio
|
217
|
-
# ...
|
218
211
|
#
|
219
212
|
# @param usage_customer_ids [Array<String>, nil] A list of customer ids that were used to calculate the usage for this line item.
|
220
|
-
# ...
|
221
213
|
|
222
214
|
module Adjustment
|
223
215
|
extend Orb::Internal::Type::Union
|
@@ -290,12 +282,10 @@ module Orb
|
|
290
282
|
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
291
283
|
#
|
292
284
|
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
293
|
-
# ...
|
294
285
|
#
|
295
286
|
# @param reason [String, nil] The reason for the adjustment.
|
296
287
|
#
|
297
288
|
# @param usage_discount [Float] The number of usage units by which to discount the price this adjustment applies
|
298
|
-
# ...
|
299
289
|
#
|
300
290
|
# @param adjustment_type [Symbol, :usage_discount]
|
301
291
|
end
|
@@ -353,12 +343,10 @@ module Orb
|
|
353
343
|
# @param amount [String] The value applied by an adjustment.
|
354
344
|
#
|
355
345
|
# @param amount_discount [String] The amount by which to discount the prices this adjustment applies to in a given
|
356
|
-
# ...
|
357
346
|
#
|
358
347
|
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
359
348
|
#
|
360
349
|
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
361
|
-
# ...
|
362
350
|
#
|
363
351
|
# @param reason [String, nil] The reason for the adjustment.
|
364
352
|
#
|
@@ -420,10 +408,8 @@ module Orb
|
|
420
408
|
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
421
409
|
#
|
422
410
|
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
423
|
-
# ...
|
424
411
|
#
|
425
412
|
# @param percentage_discount [Float] The percentage (as a value between 0 and 1) by which to discount the price inter
|
426
|
-
# ...
|
427
413
|
#
|
428
414
|
# @param reason [String, nil] The reason for the adjustment.
|
429
415
|
#
|
@@ -491,12 +477,10 @@ module Orb
|
|
491
477
|
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
492
478
|
#
|
493
479
|
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
494
|
-
# ...
|
495
480
|
#
|
496
481
|
# @param item_id [String] The item ID that revenue from this minimum will be attributed to.
|
497
482
|
#
|
498
483
|
# @param minimum_amount [String] The minimum amount to charge in a given billing period for the prices this adjus
|
499
|
-
# ...
|
500
484
|
#
|
501
485
|
# @param reason [String, nil] The reason for the adjustment.
|
502
486
|
#
|
@@ -558,10 +542,8 @@ module Orb
|
|
558
542
|
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
559
543
|
#
|
560
544
|
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
561
|
-
# ...
|
562
545
|
#
|
563
546
|
# @param maximum_amount [String] The maximum amount to charge in a given billing period for the prices this adjus
|
564
|
-
# ...
|
565
547
|
#
|
566
548
|
# @param reason [String, nil] The reason for the adjustment.
|
567
549
|
#
|
@@ -596,7 +578,6 @@ module Orb
|
|
596
578
|
# This field is deprecated in favor of `adjustments`.
|
597
579
|
#
|
598
580
|
# @param applies_to_price_ids [Array<String>] List of price_ids that this maximum amount applies to. For plan/plan phase maxim
|
599
|
-
# ...
|
600
581
|
#
|
601
582
|
# @param maximum_amount [String] Maximum amount applied
|
602
583
|
end
|
@@ -625,7 +606,6 @@ module Orb
|
|
625
606
|
# This field is deprecated in favor of `adjustments`.
|
626
607
|
#
|
627
608
|
# @param applies_to_price_ids [Array<String>] List of price_ids that this minimum amount applies to. For plan/plan phase minim
|
628
|
-
# ...
|
629
609
|
#
|
630
610
|
# @param minimum_amount [String] Minimum amount applied
|
631
611
|
end
|
@@ -36,8 +36,8 @@ module Orb
|
|
36
36
|
|
37
37
|
# @!attribute date_type
|
38
38
|
#
|
39
|
-
# @return [Symbol, Orb::
|
40
|
-
optional :date_type, enum: -> { Orb::
|
39
|
+
# @return [Symbol, Orb::InvoiceListParams::DateType, nil]
|
40
|
+
optional :date_type, enum: -> { Orb::InvoiceListParams::DateType }, nil?: true
|
41
41
|
|
42
42
|
# @!attribute due_date
|
43
43
|
#
|
@@ -101,10 +101,8 @@ module Orb
|
|
101
101
|
|
102
102
|
# @!attribute status
|
103
103
|
#
|
104
|
-
# @return [Array<Symbol, Orb::
|
105
|
-
optional :status,
|
106
|
-
-> { Orb::Internal::Type::ArrayOf[enum: Orb::Models::InvoiceListParams::Status] },
|
107
|
-
nil?: true
|
104
|
+
# @return [Array<Symbol, Orb::InvoiceListParams::Status>, nil]
|
105
|
+
optional :status, -> { Orb::Internal::Type::ArrayOf[enum: Orb::InvoiceListParams::Status] }, nil?: true
|
108
106
|
|
109
107
|
# @!attribute subscription_id
|
110
108
|
#
|
@@ -122,16 +120,14 @@ module Orb
|
|
122
120
|
# @param amount_lt [String, nil]
|
123
121
|
#
|
124
122
|
# @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
|
125
|
-
# ...
|
126
123
|
#
|
127
124
|
# @param customer_id [String, nil]
|
128
125
|
#
|
129
|
-
# @param date_type [Symbol, Orb::
|
126
|
+
# @param date_type [Symbol, Orb::InvoiceListParams::DateType, nil]
|
130
127
|
#
|
131
128
|
# @param due_date [Date, nil]
|
132
129
|
#
|
133
130
|
# @param due_date_window [String, nil] Filters invoices by their due dates within a specific time range in the past. Sp
|
134
|
-
# ...
|
135
131
|
#
|
136
132
|
# @param due_date_gt [Date, nil]
|
137
133
|
#
|
@@ -151,7 +147,7 @@ module Orb
|
|
151
147
|
#
|
152
148
|
# @param limit [Integer] The number of items to fetch. Defaults to 20.
|
153
149
|
#
|
154
|
-
# @param status [Array<Symbol, Orb::
|
150
|
+
# @param status [Array<Symbol, Orb::InvoiceListParams::Status>, nil]
|
155
151
|
#
|
156
152
|
# @param subscription_id [String, nil]
|
157
153
|
#
|
@@ -20,7 +20,6 @@ module Orb
|
|
20
20
|
# {Orb::Models::InvoiceUpdateParams} for more details.
|
21
21
|
#
|
22
22
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
23
|
-
# ...
|
24
23
|
#
|
25
24
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
26
25
|
end
|