schematichq 1.5.2 → 1.5.4
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/.fern/metadata.json +4 -4
- data/.fern/replay.lock +14 -338
- data/.fernignore +8 -0
- data/.rubocop.yml +4 -0
- data/README.md +141 -0
- data/WASM_VERSION +1 -1
- data/custom.gemspec.rb +6 -0
- data/lib/schematic/accesstokens/client.rb +9 -1
- data/lib/schematic/accounts/client.rb +183 -21
- data/lib/schematic/accounts/types/update_environment_request_body.rb +2 -0
- data/lib/schematic/billing/client.rb +325 -34
- data/lib/schematic/billing/types/create_billing_price_request_body.rb +1 -1
- data/lib/schematic/billing/types/create_billing_product_request_body.rb +1 -1
- data/lib/schematic/billing/types/create_billing_subscription_request_body.rb +1 -1
- data/lib/schematic/billing/types/create_coupon_request_body.rb +2 -2
- data/lib/schematic/billing/types/create_invoice_request_body.rb +1 -1
- data/lib/schematic/billing/types/get_billing_settings_response.rb +13 -0
- data/lib/schematic/billing/types/list_billing_prices_params.rb +1 -1
- data/lib/schematic/billing/types/list_billing_prices_request.rb +1 -1
- data/lib/schematic/billing/types/list_billing_product_prices_params.rb +1 -1
- data/lib/schematic/billing/types/list_billing_product_prices_request.rb +1 -1
- data/lib/schematic/billing/types/update_billing_settings_request_body.rb +11 -0
- data/lib/schematic/billing/types/update_billing_settings_response.rb +13 -0
- data/lib/schematic/catalogs/client.rb +121 -14
- data/lib/schematic/checkout/client.rb +80 -9
- data/lib/schematic/checkout/types/checkout_data_request_body.rb +1 -1
- data/lib/schematic/client.rb +5 -3
- data/lib/schematic/companies/client.rb +380 -44
- data/lib/schematic/components/client.rb +70 -8
- data/lib/schematic/components/types/create_component_request_body.rb +1 -1
- data/lib/schematic/components/types/update_component_request_body.rb +1 -1
- data/lib/schematic/componentspublic/client.rb +8 -1
- data/lib/schematic/credits/client.rb +458 -46
- data/lib/schematic/credits/leases/check.rb +477 -0
- data/lib/schematic/credits/leases/lease_manager.rb +565 -0
- data/lib/schematic/credits/leases/lease_store.rb +240 -0
- data/lib/schematic/credits/leases/redis_lease_store.rb +358 -0
- data/lib/schematic/credits/leases/redis_reservation_store.rb +326 -0
- data/lib/schematic/credits/leases/reservation_store.rb +161 -0
- data/lib/schematic/credits/leases/server_check.rb +237 -0
- data/lib/schematic/credits/leases/track.rb +66 -0
- data/lib/schematic/credits/leases/types.rb +329 -0
- data/lib/schematic/credits/leases/wire_client.rb +83 -0
- data/lib/schematic/credits/types/acquire_credit_lease_request_body.rb +3 -1
- data/lib/schematic/credits/types/create_billing_credit_request_body.rb +1 -1
- data/lib/schematic/credits/types/create_company_credit_grant.rb +1 -1
- data/lib/schematic/credits/types/create_credit_bundle_request_body.rb +1 -1
- data/lib/schematic/credits/types/create_credit_spend_policy_request_body.rb +5 -1
- data/lib/schematic/credits/types/extend_credit_lease_request_body.rb +3 -1
- data/lib/schematic/credits/types/get_credit_balance_time_series_params.rb +18 -0
- data/lib/schematic/credits/types/get_credit_balance_time_series_request.rb +17 -0
- data/lib/schematic/credits/types/get_credit_balance_time_series_response.rb +13 -0
- data/lib/schematic/credits/types/get_credit_spend_policy_usage_params.rb +16 -0
- data/lib/schematic/credits/types/get_credit_spend_policy_usage_request.rb +15 -0
- data/lib/schematic/credits/types/get_credit_spend_policy_usage_response.rb +13 -0
- data/lib/schematic/credits/types/reserve_credits_request_body.rb +1 -1
- data/lib/schematic/credits/types/update_credit_spend_policy_request_body.rb +5 -1
- data/lib/schematic/dataexports/client.rb +36 -6
- data/lib/schematic/datastream/client.rb +32 -2
- data/lib/schematic/entitlements/client.rb +406 -25
- data/lib/schematic/entitlements/types/count_company_user_usage_params.rb +24 -0
- data/lib/schematic/entitlements/types/count_company_user_usage_request.rb +23 -0
- data/lib/schematic/entitlements/types/count_company_user_usage_response.rb +13 -0
- data/lib/schematic/entitlements/types/create_billing_linked_plan_entitlement_request_body.rb +4 -2
- data/lib/schematic/entitlements/types/create_company_override_request_body.rb +3 -1
- data/lib/schematic/entitlements/types/create_plan_entitlement_request_body.rb +4 -2
- data/lib/schematic/entitlements/types/get_company_user_usage_metrics_params.rb +16 -0
- data/lib/schematic/entitlements/types/get_company_user_usage_metrics_request.rb +15 -0
- data/lib/schematic/entitlements/types/get_company_user_usage_metrics_response.rb +13 -0
- data/lib/schematic/entitlements/types/list_company_user_usage_params.rb +24 -0
- data/lib/schematic/entitlements/types/list_company_user_usage_request.rb +23 -0
- data/lib/schematic/entitlements/types/list_company_user_usage_response.rb +13 -0
- data/lib/schematic/entitlements/types/update_company_override_request_body.rb +3 -1
- data/lib/schematic/entitlements/types/update_plan_entitlement_request_body.rb +4 -2
- data/lib/schematic/errors/connection_error.rb +11 -0
- data/lib/schematic/errors/response_error.rb +23 -2
- data/lib/schematic/events/client.rb +78 -9
- data/lib/schematic/features/client.rb +160 -18
- data/lib/schematic/features/types/check_and_reserve_flag_request_body.rb +1 -1
- data/lib/schematic/features/types/create_billing_linked_feature_request_body.rb +2 -0
- data/lib/schematic/features/types/create_feature_request_body.rb +2 -0
- data/lib/schematic/features/types/update_feature_request_body.rb +2 -0
- data/lib/schematic/insights/client.rb +48 -6
- data/lib/schematic/integrationsapi/client.rb +120 -14
- data/lib/schematic/internal/http/base_request.rb +30 -0
- data/lib/schematic/internal/http/raw_client.rb +35 -5
- data/lib/schematic/internal/iterators/cursor_item_iterator.rb +7 -2
- data/lib/schematic/internal/iterators/cursor_page_iterator.rb +68 -14
- data/lib/schematic/internal/iterators/item_iterator.rb +61 -15
- data/lib/schematic/internal/iterators/offset_item_iterator.rb +7 -2
- data/lib/schematic/internal/iterators/offset_page_iterator.rb +57 -9
- data/lib/schematic/internal/json/request.rb +11 -2
- data/lib/schematic/internal/multipart/multipart_request.rb +1 -0
- data/lib/schematic/internal/types/model.rb +7 -3
- data/lib/schematic/internal/types/utils.rb +7 -0
- data/lib/schematic/licenses/client.rb +26 -3
- data/lib/schematic/planbundle/client.rb +27 -3
- data/lib/schematic/plangroups/client.rb +28 -3
- data/lib/schematic/plangroups/types/create_plan_group_request_body.rb +2 -0
- data/lib/schematic/plangroups/types/update_plan_group_request_body.rb +2 -0
- data/lib/schematic/planmigrations/client.rb +104 -11
- data/lib/schematic/planmigrations/types/count_migrations_params.rb +2 -0
- data/lib/schematic/planmigrations/types/count_migrations_request.rb +2 -0
- data/lib/schematic/planmigrations/types/create_migration_input.rb +2 -0
- data/lib/schematic/planmigrations/types/list_migrations_params.rb +2 -0
- data/lib/schematic/planmigrations/types/list_migrations_request.rb +2 -0
- data/lib/schematic/plans/client.rb +213 -23
- data/lib/schematic/plans/types/get_plan_version_diff_params.rb +12 -0
- data/lib/schematic/plans/types/get_plan_version_diff_request.rb +13 -0
- data/lib/schematic/plans/types/get_plan_version_diff_response.rb +13 -0
- data/lib/schematic/plans/types/publish_plan_version_request_body.rb +6 -0
- data/lib/schematic/plans/types/retry_custom_plan_billing_request_body.rb +2 -0
- data/lib/schematic/rules_engine.rb +49 -0
- data/lib/schematic/scheduledcheckout/client.rb +35 -4
- data/lib/schematic/schematic_client.rb +841 -33
- data/lib/schematic/types/billing_coupon_response_data.rb +2 -2
- data/lib/schematic/types/billing_credit_grant_response_data.rb +8 -8
- data/lib/schematic/types/billing_customer_subscription.rb +1 -1
- data/lib/schematic/types/billing_plan_credit_grant_response_data.rb +1 -1
- data/lib/schematic/types/billing_price_response_data.rb +1 -1
- data/lib/schematic/types/billing_price_view.rb +1 -1
- data/lib/schematic/types/billing_product_detail_response_data.rb +2 -2
- data/lib/schematic/types/billing_product_for_subscription_response_data.rb +2 -2
- data/lib/schematic/types/billing_product_price_response_data.rb +1 -1
- data/lib/schematic/types/billing_product_pricing.rb +1 -1
- data/lib/schematic/types/billing_product_response_data.rb +2 -2
- data/lib/schematic/types/billing_settings_response_data.rb +9 -0
- data/lib/schematic/types/billing_subscription_discount_view.rb +2 -2
- data/lib/schematic/types/billing_subscription_response_data.rb +1 -1
- data/lib/schematic/types/billing_subscription_view.rb +1 -1
- data/lib/schematic/types/capture_raw_event.rb +4 -0
- data/lib/schematic/types/catalog_config_ordered_plan.rb +2 -0
- data/lib/schematic/types/catalog_config_ordered_plan_response_data.rb +2 -0
- data/lib/schematic/types/catalog_config_plan_credit.rb +11 -0
- data/lib/schematic/types/catalog_config_plan_credit_response_data.rb +11 -0
- data/lib/schematic/types/change_subscription_internal_request_body.rb +1 -1
- data/lib/schematic/types/change_subscription_request_body.rb +1 -1
- data/lib/schematic/types/check_flags_response_data.rb +2 -0
- data/lib/schematic/types/checkout_problem_code.rb +54 -0
- data/lib/schematic/types/checkout_problem_response_data.rb +31 -0
- data/lib/schematic/types/checkout_problem_source.rb +13 -0
- data/lib/schematic/types/checkout_subscription.rb +1 -1
- data/lib/schematic/types/company_billing_entity_subscription_response_data.rb +1 -1
- data/lib/schematic/types/company_credit_balance.rb +3 -3
- data/lib/schematic/types/company_credit_balance_response_data.rb +4 -4
- data/lib/schematic/types/company_detail_response_data.rb +3 -1
- data/lib/schematic/types/company_override_response_data.rb +3 -1
- data/lib/schematic/types/company_plan_credit_grant_view.rb +1 -1
- data/lib/schematic/types/company_plan_detail_response_data.rb +4 -0
- data/lib/schematic/types/company_subscription_response_data.rb +1 -1
- data/lib/schematic/types/company_user_usage_metrics_response_data.rb +15 -0
- data/lib/schematic/types/company_user_usage_response_data.rb +19 -0
- data/lib/schematic/types/company_user_usage_row_response_data.rb +17 -0
- data/lib/schematic/types/component_display_settings.rb +2 -0
- data/lib/schematic/types/component_response_data.rb +1 -1
- data/lib/schematic/types/component_settings_response_data.rb +2 -0
- data/lib/schematic/types/condition.rb +3 -1
- data/lib/schematic/types/condition_response_data.rb +3 -1
- data/lib/schematic/types/condition_view.rb +3 -1
- data/lib/schematic/types/coupon_request_body.rb +2 -2
- data/lib/schematic/types/create_billing_plan_credit_grant_request_body.rb +1 -1
- data/lib/schematic/types/create_entitlement_in_bundle_request_body.rb +4 -2
- data/lib/schematic/types/create_entitlement_req_common.rb +3 -1
- data/lib/schematic/types/create_or_update_condition_request_body.rb +1 -1
- data/lib/schematic/types/credit_balance_event_response_data.rb +21 -0
- data/lib/schematic/types/credit_balance_feature_consumption_response_data.rb +13 -0
- data/lib/schematic/types/credit_balance_point_response_data.rb +15 -0
- data/lib/schematic/types/credit_balance_time_series_response_data.rb +15 -0
- data/lib/schematic/types/credit_bundle_currency_price.rb +1 -1
- data/lib/schematic/types/credit_bundle_currency_price_request_body.rb +1 -1
- data/lib/schematic/types/credit_bundle_currency_price_response_data.rb +1 -1
- data/lib/schematic/types/credit_burn_breakdown_line.rb +15 -0
- data/lib/schematic/types/credit_company_grant_view.rb +8 -8
- data/lib/schematic/types/credit_currency_price.rb +1 -1
- data/lib/schematic/types/credit_currency_price_request_body.rb +1 -1
- data/lib/schematic/types/credit_currency_price_response_data.rb +1 -1
- data/lib/schematic/types/credit_event_ledger_response_data.rb +14 -6
- data/lib/schematic/types/credit_event_type.rb +3 -0
- data/lib/schematic/types/credit_grant_detail.rb +1 -1
- data/lib/schematic/types/credit_lease_response_data.rb +2 -2
- data/lib/schematic/types/credit_ledger_entry_kind.rb +17 -0
- data/lib/schematic/types/credit_reservation_response_data.rb +2 -2
- data/lib/schematic/types/credit_spend_policy.rb +25 -0
- data/lib/schematic/types/credit_spend_policy_response_data.rb +13 -1
- data/lib/schematic/types/credit_spend_window.rb +11 -0
- data/lib/schematic/types/credit_spend_window_unit.rb +13 -0
- data/lib/schematic/types/credit_transfer_response_data.rb +1 -1
- data/lib/schematic/types/credit_transfer_view.rb +1 -1
- data/lib/schematic/types/credit_usage.rb +5 -5
- data/lib/schematic/types/credit_usage_aggregation.rb +4 -4
- data/lib/schematic/types/credit_usage_reason.rb +1 -0
- data/lib/schematic/types/credits_in_plan.rb +11 -0
- data/lib/schematic/types/currency.rb +144 -0
- data/lib/schematic/types/currency_price_request_body.rb +1 -1
- data/lib/schematic/types/custom_plan_billing_response_data.rb +8 -0
- data/lib/schematic/types/entitlement_currency_prices_response_data.rb +1 -1
- data/lib/schematic/types/environment_detail_response_data.rb +2 -0
- data/lib/schematic/types/environment_response_data.rb +2 -0
- data/lib/schematic/types/estimated_plan_total.rb +13 -0
- data/lib/schematic/types/feature_company_response_data.rb +7 -7
- data/lib/schematic/types/feature_detail_response_data.rb +2 -0
- data/lib/schematic/types/feature_entitlement.rb +8 -6
- data/lib/schematic/types/feature_event_source.rb +12 -0
- data/lib/schematic/types/feature_in_plan_response_data.rb +2 -0
- data/lib/schematic/types/feature_response_data.rb +2 -0
- data/lib/schematic/types/feature_usage_response_data.rb +7 -7
- data/lib/schematic/types/feature_view.rb +2 -0
- data/lib/schematic/types/flag_check_reservation_response_data.rb +3 -3
- data/lib/schematic/types/insights_summary_response_data.rb +1 -1
- data/lib/schematic/types/invoice_request_body.rb +1 -1
- data/lib/schematic/types/invoice_response_data.rb +1 -1
- data/lib/schematic/types/manage_plan_preview_response_response_data.rb +2 -0
- data/lib/schematic/types/manage_plan_request.rb +3 -1
- data/lib/schematic/types/manage_plan_response_response_data.rb +4 -0
- data/lib/schematic/types/mrr_response_data.rb +1 -1
- data/lib/schematic/types/onboarding_milestone_view.rb +1 -1
- data/lib/schematic/types/ordered_plans_in_group.rb +2 -0
- data/lib/schematic/types/pending_migration_response_data.rb +6 -0
- data/lib/schematic/types/plan_billing_source.rb +1 -0
- data/lib/schematic/types/plan_change_action.rb +1 -0
- data/lib/schematic/types/plan_change_amendment_status.rb +15 -0
- data/lib/schematic/types/plan_change_response_data.rb +4 -0
- data/lib/schematic/types/plan_credit_grant_view.rb +1 -1
- data/lib/schematic/types/plan_credit_order.rb +11 -0
- data/lib/schematic/types/plan_credit_visibility.rb +11 -0
- data/lib/schematic/types/plan_currency_price_request_body.rb +1 -1
- data/lib/schematic/types/plan_currency_prices_response_data.rb +1 -1
- data/lib/schematic/types/plan_entitlement_response_data.rb +3 -1
- data/lib/schematic/types/plan_group_plan_entitlements_order.rb +2 -0
- data/lib/schematic/types/plan_version_billing_product_change_response_data.rb +11 -0
- data/lib/schematic/types/plan_version_credit_grant_change_response_data.rb +17 -0
- data/lib/schematic/types/plan_version_diff_change_type.rb +13 -0
- data/lib/schematic/types/plan_version_diff_price_cadence.rb +14 -0
- data/lib/schematic/types/plan_version_diff_response_data.rb +23 -0
- data/lib/schematic/types/plan_version_entitlement_change_response_data.rb +17 -0
- data/lib/schematic/types/plan_version_field_change_response_data.rb +13 -0
- data/lib/schematic/types/plan_version_migration_response_data.rb +2 -0
- data/lib/schematic/types/plan_version_migration_strategy.rb +1 -0
- data/lib/schematic/types/plan_version_price_change_response_data.rb +15 -0
- data/lib/schematic/types/plan_view_public_response_data.rb +2 -0
- data/lib/schematic/types/preflight_request_body.rb +1 -1
- data/lib/schematic/types/preview_subscription_change_response_data.rb +3 -1
- data/lib/schematic/types/preview_subscription_discount_response_data.rb +2 -2
- data/lib/schematic/types/preview_subscription_finance_response_data.rb +2 -2
- data/lib/schematic/types/rules_engine_schema_version.rb +1 -1
- data/lib/schematic/types/rulesengine_company.rb +3 -1
- data/lib/schematic/types/rulesengine_condition.rb +3 -1
- data/lib/schematic/types/rulesengine_credit_postpaid_config.rb +1 -1
- data/lib/schematic/types/rulesengine_credit_spend_policy.rb +25 -0
- data/lib/schematic/types/rulesengine_credit_spend_policy_scope.rb +13 -0
- data/lib/schematic/types/rulesengine_credit_spend_window.rb +11 -0
- data/lib/schematic/types/rulesengine_feature_entitlement.rb +8 -6
- data/lib/schematic/types/rulesengine_user.rb +2 -0
- data/lib/schematic/types/scheduled_downgrade_response_data.rb +1 -1
- data/lib/schematic/types/top_feature_by_usage_response_data.rb +1 -1
- data/lib/schematic/types/upcoming_invoice_response_data.rb +1 -1
- data/lib/schematic/types/update_billing_plan_credit_grant_request_body.rb +1 -1
- data/lib/schematic/types/update_entitlement_req_common.rb +3 -1
- data/lib/schematic/types/upsert_billing_product_request_body.rb +1 -1
- data/lib/schematic/types/usage_based_entitlement_request_body.rb +1 -1
- data/lib/schematic/types/usage_based_entitlement_response_data.rb +1 -1
- data/lib/schematic/types/user_credit_usage_response_data.rb +2 -2
- data/lib/schematic/types/user_daily_credit_point_response_data.rb +1 -1
- data/lib/schematic/types/user_feature_usage_response_data.rb +1 -1
- data/lib/schematic/types/user_usage_metric.rb +12 -0
- data/lib/schematic/version.rb +1 -1
- data/lib/schematic/wasm/rulesengine.wasm +0 -0
- data/lib/schematic/webhooks/client.rb +88 -10
- data/lib/schematic.rb +64 -5
- data/lib/schematichq.rb +10 -0
- data/reference.md +888 -127
- metadata +71 -2
data/reference.md
CHANGED
|
@@ -1145,6 +1145,14 @@ client.accounts.update_environment(environment_id: "environment_id")
|
|
|
1145
1145
|
<dl>
|
|
1146
1146
|
<dd>
|
|
1147
1147
|
|
|
1148
|
+
**require_context_signature:** `Internal::Types::Boolean`
|
|
1149
|
+
|
|
1150
|
+
</dd>
|
|
1151
|
+
</dl>
|
|
1152
|
+
|
|
1153
|
+
<dl>
|
|
1154
|
+
<dd>
|
|
1155
|
+
|
|
1148
1156
|
**request_options:** `Schematic::Accounts::RequestOptions`
|
|
1149
1157
|
|
|
1150
1158
|
</dd>
|
|
@@ -1536,7 +1544,7 @@ client.billing.upsert_billing_coupon(
|
|
|
1536
1544
|
<dl>
|
|
1537
1545
|
<dd>
|
|
1538
1546
|
|
|
1539
|
-
**currency:** `
|
|
1547
|
+
**currency:** `Schematic::Types::Currency`
|
|
1540
1548
|
|
|
1541
1549
|
</dd>
|
|
1542
1550
|
</dl>
|
|
@@ -1584,7 +1592,7 @@ client.billing.upsert_billing_coupon(
|
|
|
1584
1592
|
<dl>
|
|
1585
1593
|
<dd>
|
|
1586
1594
|
|
|
1587
|
-
**percent_off:** `
|
|
1595
|
+
**percent_off:** `Float`
|
|
1588
1596
|
|
|
1589
1597
|
</dd>
|
|
1590
1598
|
</dl>
|
|
@@ -2105,7 +2113,7 @@ client.billing.upsert_invoice(
|
|
|
2105
2113
|
amount_paid: 1000000,
|
|
2106
2114
|
amount_remaining: 1000000,
|
|
2107
2115
|
collection_method: "collection_method",
|
|
2108
|
-
currency: "
|
|
2116
|
+
currency: "aed",
|
|
2109
2117
|
customer_external_id: "customer_external_id",
|
|
2110
2118
|
subtotal: 1000000
|
|
2111
2119
|
)
|
|
@@ -2155,7 +2163,7 @@ client.billing.upsert_invoice(
|
|
|
2155
2163
|
<dl>
|
|
2156
2164
|
<dd>
|
|
2157
2165
|
|
|
2158
|
-
**currency:** `
|
|
2166
|
+
**currency:** `Schematic::Types::Currency`
|
|
2159
2167
|
|
|
2160
2168
|
</dd>
|
|
2161
2169
|
</dl>
|
|
@@ -2743,7 +2751,7 @@ client.billing.delete_payment_method_by_external_id(billing_id: "billing_id")
|
|
|
2743
2751
|
|
|
2744
2752
|
```ruby
|
|
2745
2753
|
client.billing.list_billing_prices(
|
|
2746
|
-
currency: "
|
|
2754
|
+
currency: "aed",
|
|
2747
2755
|
for_initial_plan: true,
|
|
2748
2756
|
for_trial_expiry_plan: true,
|
|
2749
2757
|
ids: ["ids"],
|
|
@@ -2776,7 +2784,7 @@ client.billing.list_billing_prices(
|
|
|
2776
2784
|
<dl>
|
|
2777
2785
|
<dd>
|
|
2778
2786
|
|
|
2779
|
-
**currency:** `
|
|
2787
|
+
**currency:** `Schematic::Types::Currency` — Filter for prices in a specific currency (e.g. usd, eur)
|
|
2780
2788
|
|
|
2781
2789
|
</dd>
|
|
2782
2790
|
</dl>
|
|
@@ -2947,7 +2955,7 @@ client.billing.list_billing_prices(
|
|
|
2947
2955
|
```ruby
|
|
2948
2956
|
client.billing.upsert_billing_price(
|
|
2949
2957
|
billing_scheme: "per_unit",
|
|
2950
|
-
currency: "
|
|
2958
|
+
currency: "aed",
|
|
2951
2959
|
external_account_id: "external_account_id",
|
|
2952
2960
|
interval: "interval",
|
|
2953
2961
|
is_active: true,
|
|
@@ -2981,7 +2989,7 @@ client.billing.upsert_billing_price(
|
|
|
2981
2989
|
<dl>
|
|
2982
2990
|
<dd>
|
|
2983
2991
|
|
|
2984
|
-
**currency:** `
|
|
2992
|
+
**currency:** `Schematic::Types::Currency`
|
|
2985
2993
|
|
|
2986
2994
|
</dd>
|
|
2987
2995
|
</dl>
|
|
@@ -3183,7 +3191,7 @@ client.billing.delete_billing_product(billing_id: "billing_id")
|
|
|
3183
3191
|
|
|
3184
3192
|
```ruby
|
|
3185
3193
|
client.billing.list_billing_product_prices(
|
|
3186
|
-
currency: "
|
|
3194
|
+
currency: "aed",
|
|
3187
3195
|
for_initial_plan: true,
|
|
3188
3196
|
for_trial_expiry_plan: true,
|
|
3189
3197
|
ids: ["ids"],
|
|
@@ -3216,7 +3224,7 @@ client.billing.list_billing_product_prices(
|
|
|
3216
3224
|
<dl>
|
|
3217
3225
|
<dd>
|
|
3218
3226
|
|
|
3219
|
-
**currency:** `
|
|
3227
|
+
**currency:** `Schematic::Types::Currency` — Filter for prices in a specific currency (e.g. usd, eur)
|
|
3220
3228
|
|
|
3221
3229
|
</dd>
|
|
3222
3230
|
</dl>
|
|
@@ -3475,7 +3483,7 @@ client.billing.upsert_billing_product(
|
|
|
3475
3483
|
<dl>
|
|
3476
3484
|
<dd>
|
|
3477
3485
|
|
|
3478
|
-
**price:** `
|
|
3486
|
+
**price:** `Float`
|
|
3479
3487
|
|
|
3480
3488
|
</dd>
|
|
3481
3489
|
</dl>
|
|
@@ -4000,6 +4008,94 @@ client.billing.update_company_billing_profile(
|
|
|
4000
4008
|
</dl>
|
|
4001
4009
|
|
|
4002
4010
|
|
|
4011
|
+
</dd>
|
|
4012
|
+
</dl>
|
|
4013
|
+
</details>
|
|
4014
|
+
|
|
4015
|
+
<details><summary><code>client.billing.<a href="/lib/schematic/billing/client.rb">get_billing_settings</a>() -> Schematic::Billing::Types::GetBillingSettingsResponse</code></summary>
|
|
4016
|
+
<dl>
|
|
4017
|
+
<dd>
|
|
4018
|
+
|
|
4019
|
+
#### 🔌 Usage
|
|
4020
|
+
|
|
4021
|
+
<dl>
|
|
4022
|
+
<dd>
|
|
4023
|
+
|
|
4024
|
+
<dl>
|
|
4025
|
+
<dd>
|
|
4026
|
+
|
|
4027
|
+
```ruby
|
|
4028
|
+
client.billing.get_billing_settings
|
|
4029
|
+
```
|
|
4030
|
+
</dd>
|
|
4031
|
+
</dl>
|
|
4032
|
+
</dd>
|
|
4033
|
+
</dl>
|
|
4034
|
+
|
|
4035
|
+
#### ⚙️ Parameters
|
|
4036
|
+
|
|
4037
|
+
<dl>
|
|
4038
|
+
<dd>
|
|
4039
|
+
|
|
4040
|
+
<dl>
|
|
4041
|
+
<dd>
|
|
4042
|
+
|
|
4043
|
+
**request_options:** `Schematic::Billing::RequestOptions`
|
|
4044
|
+
|
|
4045
|
+
</dd>
|
|
4046
|
+
</dl>
|
|
4047
|
+
</dd>
|
|
4048
|
+
</dl>
|
|
4049
|
+
|
|
4050
|
+
|
|
4051
|
+
</dd>
|
|
4052
|
+
</dl>
|
|
4053
|
+
</details>
|
|
4054
|
+
|
|
4055
|
+
<details><summary><code>client.billing.<a href="/lib/schematic/billing/client.rb">update_billing_settings</a>(request) -> Schematic::Billing::Types::UpdateBillingSettingsResponse</code></summary>
|
|
4056
|
+
<dl>
|
|
4057
|
+
<dd>
|
|
4058
|
+
|
|
4059
|
+
#### 🔌 Usage
|
|
4060
|
+
|
|
4061
|
+
<dl>
|
|
4062
|
+
<dd>
|
|
4063
|
+
|
|
4064
|
+
<dl>
|
|
4065
|
+
<dd>
|
|
4066
|
+
|
|
4067
|
+
```ruby
|
|
4068
|
+
client.billing.update_billing_settings
|
|
4069
|
+
```
|
|
4070
|
+
</dd>
|
|
4071
|
+
</dl>
|
|
4072
|
+
</dd>
|
|
4073
|
+
</dl>
|
|
4074
|
+
|
|
4075
|
+
#### ⚙️ Parameters
|
|
4076
|
+
|
|
4077
|
+
<dl>
|
|
4078
|
+
<dd>
|
|
4079
|
+
|
|
4080
|
+
<dl>
|
|
4081
|
+
<dd>
|
|
4082
|
+
|
|
4083
|
+
**default_provider_type:** `Schematic::Types::BillingProviderType`
|
|
4084
|
+
|
|
4085
|
+
</dd>
|
|
4086
|
+
</dl>
|
|
4087
|
+
|
|
4088
|
+
<dl>
|
|
4089
|
+
<dd>
|
|
4090
|
+
|
|
4091
|
+
**request_options:** `Schematic::Billing::RequestOptions`
|
|
4092
|
+
|
|
4093
|
+
</dd>
|
|
4094
|
+
</dl>
|
|
4095
|
+
</dd>
|
|
4096
|
+
</dl>
|
|
4097
|
+
|
|
4098
|
+
|
|
4003
4099
|
</dd>
|
|
4004
4100
|
</dl>
|
|
4005
4101
|
</details>
|
|
@@ -4019,7 +4115,7 @@ client.billing.update_company_billing_profile(
|
|
|
4019
4115
|
```ruby
|
|
4020
4116
|
client.billing.upsert_billing_subscription(
|
|
4021
4117
|
cancel_at_period_end: true,
|
|
4022
|
-
currency: "
|
|
4118
|
+
currency: "aed",
|
|
4023
4119
|
customer_external_id: "customer_external_id",
|
|
4024
4120
|
discounts: [{
|
|
4025
4121
|
coupon_external_id: "coupon_external_id",
|
|
@@ -4029,7 +4125,7 @@ client.billing.upsert_billing_subscription(
|
|
|
4029
4125
|
}],
|
|
4030
4126
|
expired_at: "2024-01-15T09:30:00Z",
|
|
4031
4127
|
product_external_ids: [{
|
|
4032
|
-
currency: "
|
|
4128
|
+
currency: "aed",
|
|
4033
4129
|
interval: "interval",
|
|
4034
4130
|
price: 1000000,
|
|
4035
4131
|
price_external_id: "price_external_id",
|
|
@@ -4086,7 +4182,7 @@ client.billing.upsert_billing_subscription(
|
|
|
4086
4182
|
<dl>
|
|
4087
4183
|
<dd>
|
|
4088
4184
|
|
|
4089
|
-
**currency:** `
|
|
4185
|
+
**currency:** `Schematic::Types::Currency`
|
|
4090
4186
|
|
|
4091
4187
|
</dd>
|
|
4092
4188
|
</dl>
|
|
@@ -4334,7 +4430,7 @@ client.credits.list_billing_credits(
|
|
|
4334
4430
|
|
|
4335
4431
|
```ruby
|
|
4336
4432
|
client.credits.create_billing_credit(
|
|
4337
|
-
currency: "
|
|
4433
|
+
currency: "aed",
|
|
4338
4434
|
description: "description",
|
|
4339
4435
|
name: "name"
|
|
4340
4436
|
)
|
|
@@ -4360,7 +4456,7 @@ client.credits.create_billing_credit(
|
|
|
4360
4456
|
<dl>
|
|
4361
4457
|
<dd>
|
|
4362
4458
|
|
|
4363
|
-
**currency:** `
|
|
4459
|
+
**currency:** `Schematic::Types::Currency`
|
|
4364
4460
|
|
|
4365
4461
|
</dd>
|
|
4366
4462
|
</dl>
|
|
@@ -4756,6 +4852,83 @@ client.credits.list_company_credit_balances(company_id: "company_id")
|
|
|
4756
4852
|
</dl>
|
|
4757
4853
|
|
|
4758
4854
|
|
|
4855
|
+
</dd>
|
|
4856
|
+
</dl>
|
|
4857
|
+
</details>
|
|
4858
|
+
|
|
4859
|
+
<details><summary><code>client.credits.<a href="/lib/schematic/credits/client.rb">get_credit_balance_time_series</a>() -> Schematic::Credits::Types::GetCreditBalanceTimeSeriesResponse</code></summary>
|
|
4860
|
+
<dl>
|
|
4861
|
+
<dd>
|
|
4862
|
+
|
|
4863
|
+
#### 🔌 Usage
|
|
4864
|
+
|
|
4865
|
+
<dl>
|
|
4866
|
+
<dd>
|
|
4867
|
+
|
|
4868
|
+
<dl>
|
|
4869
|
+
<dd>
|
|
4870
|
+
|
|
4871
|
+
```ruby
|
|
4872
|
+
client.credits.get_credit_balance_time_series(
|
|
4873
|
+
billing_credit_id: "billing_credit_id",
|
|
4874
|
+
company_id: "company_id",
|
|
4875
|
+
end_time: "2024-01-15T09:30:00Z",
|
|
4876
|
+
start_time: "2024-01-15T09:30:00Z"
|
|
4877
|
+
)
|
|
4878
|
+
```
|
|
4879
|
+
</dd>
|
|
4880
|
+
</dl>
|
|
4881
|
+
</dd>
|
|
4882
|
+
</dl>
|
|
4883
|
+
|
|
4884
|
+
#### ⚙️ Parameters
|
|
4885
|
+
|
|
4886
|
+
<dl>
|
|
4887
|
+
<dd>
|
|
4888
|
+
|
|
4889
|
+
<dl>
|
|
4890
|
+
<dd>
|
|
4891
|
+
|
|
4892
|
+
**billing_credit_id:** `String`
|
|
4893
|
+
|
|
4894
|
+
</dd>
|
|
4895
|
+
</dl>
|
|
4896
|
+
|
|
4897
|
+
<dl>
|
|
4898
|
+
<dd>
|
|
4899
|
+
|
|
4900
|
+
**company_id:** `String`
|
|
4901
|
+
|
|
4902
|
+
</dd>
|
|
4903
|
+
</dl>
|
|
4904
|
+
|
|
4905
|
+
<dl>
|
|
4906
|
+
<dd>
|
|
4907
|
+
|
|
4908
|
+
**end_time:** `String`
|
|
4909
|
+
|
|
4910
|
+
</dd>
|
|
4911
|
+
</dl>
|
|
4912
|
+
|
|
4913
|
+
<dl>
|
|
4914
|
+
<dd>
|
|
4915
|
+
|
|
4916
|
+
**start_time:** `String`
|
|
4917
|
+
|
|
4918
|
+
</dd>
|
|
4919
|
+
</dl>
|
|
4920
|
+
|
|
4921
|
+
<dl>
|
|
4922
|
+
<dd>
|
|
4923
|
+
|
|
4924
|
+
**request_options:** `Schematic::Credits::RequestOptions`
|
|
4925
|
+
|
|
4926
|
+
</dd>
|
|
4927
|
+
</dl>
|
|
4928
|
+
</dd>
|
|
4929
|
+
</dl>
|
|
4930
|
+
|
|
4931
|
+
|
|
4759
4932
|
</dd>
|
|
4760
4933
|
</dl>
|
|
4761
4934
|
</details>
|
|
@@ -4871,7 +5044,7 @@ client.credits.list_credit_bundles(
|
|
|
4871
5044
|
client.credits.create_credit_bundle(
|
|
4872
5045
|
bundle_name: "bundle_name",
|
|
4873
5046
|
credit_id: "credit_id",
|
|
4874
|
-
currency: "
|
|
5047
|
+
currency: "aed",
|
|
4875
5048
|
price_per_unit: 1000000
|
|
4876
5049
|
)
|
|
4877
5050
|
```
|
|
@@ -4920,7 +5093,7 @@ client.credits.create_credit_bundle(
|
|
|
4920
5093
|
<dl>
|
|
4921
5094
|
<dd>
|
|
4922
5095
|
|
|
4923
|
-
**currency:** `
|
|
5096
|
+
**currency:** `Schematic::Types::Currency`
|
|
4924
5097
|
|
|
4925
5098
|
</dd>
|
|
4926
5099
|
</dl>
|
|
@@ -5525,7 +5698,7 @@ client.credits.grant_billing_credits_to_company(
|
|
|
5525
5698
|
<dl>
|
|
5526
5699
|
<dd>
|
|
5527
5700
|
|
|
5528
|
-
**currency:** `
|
|
5701
|
+
**currency:** `Schematic::Types::Currency`
|
|
5529
5702
|
|
|
5530
5703
|
</dd>
|
|
5531
5704
|
</dl>
|
|
@@ -5991,7 +6164,15 @@ client.credits.acquire_credit_lease(
|
|
|
5991
6164
|
<dl>
|
|
5992
6165
|
<dd>
|
|
5993
6166
|
|
|
5994
|
-
**requested_amount:** `
|
|
6167
|
+
**requested_amount:** `Float`
|
|
6168
|
+
|
|
6169
|
+
</dd>
|
|
6170
|
+
</dl>
|
|
6171
|
+
|
|
6172
|
+
<dl>
|
|
6173
|
+
<dd>
|
|
6174
|
+
|
|
6175
|
+
**user_id:** `String` — The user drawing the hold, so a user-scope spend policy applies to it
|
|
5995
6176
|
|
|
5996
6177
|
</dd>
|
|
5997
6178
|
</dl>
|
|
@@ -6050,7 +6231,7 @@ client.credits.extend_credit_lease(
|
|
|
6050
6231
|
<dl>
|
|
6051
6232
|
<dd>
|
|
6052
6233
|
|
|
6053
|
-
**additional_amount:** `
|
|
6234
|
+
**additional_amount:** `Float`
|
|
6054
6235
|
|
|
6055
6236
|
</dd>
|
|
6056
6237
|
</dl>
|
|
@@ -6074,6 +6255,14 @@ client.credits.extend_credit_lease(
|
|
|
6074
6255
|
<dl>
|
|
6075
6256
|
<dd>
|
|
6076
6257
|
|
|
6258
|
+
**user_id:** `String` — The user drawing the top-up, so a user-scope spend policy applies to it
|
|
6259
|
+
|
|
6260
|
+
</dd>
|
|
6261
|
+
</dl>
|
|
6262
|
+
|
|
6263
|
+
<dl>
|
|
6264
|
+
<dd>
|
|
6265
|
+
|
|
6077
6266
|
**request_options:** `Schematic::Credits::RequestOptions`
|
|
6078
6267
|
|
|
6079
6268
|
</dd>
|
|
@@ -6613,7 +6802,7 @@ client.credits.reserve_credits(
|
|
|
6613
6802
|
<dl>
|
|
6614
6803
|
<dd>
|
|
6615
6804
|
|
|
6616
|
-
**amount:** `
|
|
6805
|
+
**amount:** `Float` — Credits to hold for the operation. The full amount must be available; a partial hold is never taken
|
|
6617
6806
|
|
|
6618
6807
|
</dd>
|
|
6619
6808
|
</dl>
|
|
@@ -6830,10 +7019,7 @@ client.credits.list_credit_spend_policies(
|
|
|
6830
7019
|
<dd>
|
|
6831
7020
|
|
|
6832
7021
|
```ruby
|
|
6833
|
-
client.credits.create_credit_spend_policy(
|
|
6834
|
-
billing_credit_id: "billing_credit_id",
|
|
6835
|
-
max_per_draw: 1.1
|
|
6836
|
-
)
|
|
7022
|
+
client.credits.create_credit_spend_policy(billing_credit_id: "billing_credit_id")
|
|
6837
7023
|
```
|
|
6838
7024
|
</dd>
|
|
6839
7025
|
</dl>
|
|
@@ -6872,7 +7058,7 @@ client.credits.create_credit_spend_policy(
|
|
|
6872
7058
|
<dl>
|
|
6873
7059
|
<dd>
|
|
6874
7060
|
|
|
6875
|
-
**max_per_draw:** `
|
|
7061
|
+
**max_per_draw:** `Float` — The largest number of credits a single draw may spend. Set either this or window_amount.
|
|
6876
7062
|
|
|
6877
7063
|
</dd>
|
|
6878
7064
|
</dl>
|
|
@@ -6888,6 +7074,22 @@ client.credits.create_credit_spend_policy(
|
|
|
6888
7074
|
<dl>
|
|
6889
7075
|
<dd>
|
|
6890
7076
|
|
|
7077
|
+
**window_amount:** `Float` — The number of credits the company or user may spend in one window. Set either this or max_per_draw.
|
|
7078
|
+
|
|
7079
|
+
</dd>
|
|
7080
|
+
</dl>
|
|
7081
|
+
|
|
7082
|
+
<dl>
|
|
7083
|
+
<dd>
|
|
7084
|
+
|
|
7085
|
+
**window_unit:** `Schematic::Types::CreditSpendWindowUnit` — The window that window_amount applies to: one UTC hour or one UTC day. Required with window_amount.
|
|
7086
|
+
|
|
7087
|
+
</dd>
|
|
7088
|
+
</dl>
|
|
7089
|
+
|
|
7090
|
+
<dl>
|
|
7091
|
+
<dd>
|
|
7092
|
+
|
|
6891
7093
|
**request_options:** `Schematic::Credits::RequestOptions`
|
|
6892
7094
|
|
|
6893
7095
|
</dd>
|
|
@@ -6992,7 +7194,23 @@ client.credits.update_credit_spend_policy(spend_policy_id: "spend_policy_id")
|
|
|
6992
7194
|
<dl>
|
|
6993
7195
|
<dd>
|
|
6994
7196
|
|
|
6995
|
-
**max_per_draw:** `
|
|
7197
|
+
**max_per_draw:** `Float`
|
|
7198
|
+
|
|
7199
|
+
</dd>
|
|
7200
|
+
</dl>
|
|
7201
|
+
|
|
7202
|
+
<dl>
|
|
7203
|
+
<dd>
|
|
7204
|
+
|
|
7205
|
+
**window_amount:** `Float`
|
|
7206
|
+
|
|
7207
|
+
</dd>
|
|
7208
|
+
</dl>
|
|
7209
|
+
|
|
7210
|
+
<dl>
|
|
7211
|
+
<dd>
|
|
7212
|
+
|
|
7213
|
+
**window_unit:** `Schematic::Types::CreditSpendWindowUnit`
|
|
6996
7214
|
|
|
6997
7215
|
</dd>
|
|
6998
7216
|
</dl>
|
|
@@ -7164,7 +7382,7 @@ client.credits.count_credit_spend_policies(
|
|
|
7164
7382
|
</dl>
|
|
7165
7383
|
</details>
|
|
7166
7384
|
|
|
7167
|
-
<details><summary><code>client.credits.<a href="/lib/schematic/credits/client.rb">
|
|
7385
|
+
<details><summary><code>client.credits.<a href="/lib/schematic/credits/client.rb">get_credit_spend_policy_usage</a>() -> Schematic::Credits::Types::GetCreditSpendPolicyUsageResponse</code></summary>
|
|
7168
7386
|
<dl>
|
|
7169
7387
|
<dd>
|
|
7170
7388
|
|
|
@@ -7177,15 +7395,10 @@ client.credits.count_credit_spend_policies(
|
|
|
7177
7395
|
<dd>
|
|
7178
7396
|
|
|
7179
7397
|
```ruby
|
|
7180
|
-
client.credits.
|
|
7398
|
+
client.credits.get_credit_spend_policy_usage(
|
|
7181
7399
|
billing_credit_id: "billing_credit_id",
|
|
7182
7400
|
company_id: "company_id",
|
|
7183
|
-
|
|
7184
|
-
event_type: "grant",
|
|
7185
|
-
feature_id: "feature_id",
|
|
7186
|
-
start_time: "start_time",
|
|
7187
|
-
limit: 1000000,
|
|
7188
|
-
offset: 1000000
|
|
7401
|
+
user_ids: ["user_ids"]
|
|
7189
7402
|
)
|
|
7190
7403
|
```
|
|
7191
7404
|
</dd>
|
|
@@ -7217,7 +7430,7 @@ client.credits.list_credit_event_ledger(
|
|
|
7217
7430
|
<dl>
|
|
7218
7431
|
<dd>
|
|
7219
7432
|
|
|
7220
|
-
**
|
|
7433
|
+
**user_ids:** `String`
|
|
7221
7434
|
|
|
7222
7435
|
</dd>
|
|
7223
7436
|
</dl>
|
|
@@ -7225,48 +7438,121 @@ client.credits.list_credit_event_ledger(
|
|
|
7225
7438
|
<dl>
|
|
7226
7439
|
<dd>
|
|
7227
7440
|
|
|
7228
|
-
**
|
|
7441
|
+
**request_options:** `Schematic::Credits::RequestOptions`
|
|
7229
7442
|
|
|
7230
7443
|
</dd>
|
|
7231
7444
|
</dl>
|
|
7232
|
-
|
|
7233
|
-
<dl>
|
|
7234
|
-
<dd>
|
|
7235
|
-
|
|
7236
|
-
**feature_id:** `String`
|
|
7237
|
-
|
|
7238
7445
|
</dd>
|
|
7239
7446
|
</dl>
|
|
7240
7447
|
|
|
7241
|
-
<dl>
|
|
7242
|
-
<dd>
|
|
7243
7448
|
|
|
7244
|
-
**start_time:** `String`
|
|
7245
|
-
|
|
7246
7449
|
</dd>
|
|
7247
7450
|
</dl>
|
|
7451
|
+
</details>
|
|
7248
7452
|
|
|
7453
|
+
<details><summary><code>client.credits.<a href="/lib/schematic/credits/client.rb">list_credit_event_ledger</a>() -> Schematic::Credits::Types::ListCreditEventLedgerResponse</code></summary>
|
|
7249
7454
|
<dl>
|
|
7250
7455
|
<dd>
|
|
7251
7456
|
|
|
7252
|
-
|
|
7253
|
-
|
|
7254
|
-
</dd>
|
|
7255
|
-
</dl>
|
|
7457
|
+
#### 🔌 Usage
|
|
7256
7458
|
|
|
7257
7459
|
<dl>
|
|
7258
7460
|
<dd>
|
|
7259
7461
|
|
|
7260
|
-
**offset:** `Integer` — Page offset (default 0)
|
|
7261
|
-
|
|
7262
|
-
</dd>
|
|
7263
|
-
</dl>
|
|
7264
|
-
|
|
7265
7462
|
<dl>
|
|
7266
7463
|
<dd>
|
|
7267
7464
|
|
|
7268
|
-
|
|
7269
|
-
|
|
7465
|
+
```ruby
|
|
7466
|
+
client.credits.list_credit_event_ledger(
|
|
7467
|
+
billing_credit_id: "billing_credit_id",
|
|
7468
|
+
company_id: "company_id",
|
|
7469
|
+
end_time: "end_time",
|
|
7470
|
+
event_type: "adjustment",
|
|
7471
|
+
feature_id: "feature_id",
|
|
7472
|
+
start_time: "start_time",
|
|
7473
|
+
limit: 1000000,
|
|
7474
|
+
offset: 1000000
|
|
7475
|
+
)
|
|
7476
|
+
```
|
|
7477
|
+
</dd>
|
|
7478
|
+
</dl>
|
|
7479
|
+
</dd>
|
|
7480
|
+
</dl>
|
|
7481
|
+
|
|
7482
|
+
#### ⚙️ Parameters
|
|
7483
|
+
|
|
7484
|
+
<dl>
|
|
7485
|
+
<dd>
|
|
7486
|
+
|
|
7487
|
+
<dl>
|
|
7488
|
+
<dd>
|
|
7489
|
+
|
|
7490
|
+
**billing_credit_id:** `String`
|
|
7491
|
+
|
|
7492
|
+
</dd>
|
|
7493
|
+
</dl>
|
|
7494
|
+
|
|
7495
|
+
<dl>
|
|
7496
|
+
<dd>
|
|
7497
|
+
|
|
7498
|
+
**company_id:** `String`
|
|
7499
|
+
|
|
7500
|
+
</dd>
|
|
7501
|
+
</dl>
|
|
7502
|
+
|
|
7503
|
+
<dl>
|
|
7504
|
+
<dd>
|
|
7505
|
+
|
|
7506
|
+
**end_time:** `String`
|
|
7507
|
+
|
|
7508
|
+
</dd>
|
|
7509
|
+
</dl>
|
|
7510
|
+
|
|
7511
|
+
<dl>
|
|
7512
|
+
<dd>
|
|
7513
|
+
|
|
7514
|
+
**event_type:** `Schematic::Types::CreditEventType`
|
|
7515
|
+
|
|
7516
|
+
</dd>
|
|
7517
|
+
</dl>
|
|
7518
|
+
|
|
7519
|
+
<dl>
|
|
7520
|
+
<dd>
|
|
7521
|
+
|
|
7522
|
+
**feature_id:** `String`
|
|
7523
|
+
|
|
7524
|
+
</dd>
|
|
7525
|
+
</dl>
|
|
7526
|
+
|
|
7527
|
+
<dl>
|
|
7528
|
+
<dd>
|
|
7529
|
+
|
|
7530
|
+
**start_time:** `String`
|
|
7531
|
+
|
|
7532
|
+
</dd>
|
|
7533
|
+
</dl>
|
|
7534
|
+
|
|
7535
|
+
<dl>
|
|
7536
|
+
<dd>
|
|
7537
|
+
|
|
7538
|
+
**limit:** `Integer` — Page limit (default 100)
|
|
7539
|
+
|
|
7540
|
+
</dd>
|
|
7541
|
+
</dl>
|
|
7542
|
+
|
|
7543
|
+
<dl>
|
|
7544
|
+
<dd>
|
|
7545
|
+
|
|
7546
|
+
**offset:** `Integer` — Page offset (default 0)
|
|
7547
|
+
|
|
7548
|
+
</dd>
|
|
7549
|
+
</dl>
|
|
7550
|
+
|
|
7551
|
+
<dl>
|
|
7552
|
+
<dd>
|
|
7553
|
+
|
|
7554
|
+
**request_options:** `Schematic::Credits::RequestOptions`
|
|
7555
|
+
|
|
7270
7556
|
</dd>
|
|
7271
7557
|
</dl>
|
|
7272
7558
|
</dd>
|
|
@@ -7294,7 +7580,7 @@ client.credits.count_credit_event_ledger(
|
|
|
7294
7580
|
billing_credit_id: "billing_credit_id",
|
|
7295
7581
|
company_id: "company_id",
|
|
7296
7582
|
end_time: "end_time",
|
|
7297
|
-
event_type: "
|
|
7583
|
+
event_type: "adjustment",
|
|
7298
7584
|
feature_id: "feature_id",
|
|
7299
7585
|
start_time: "start_time",
|
|
7300
7586
|
limit: 1000000,
|
|
@@ -8349,7 +8635,7 @@ client.checkout.get_checkout_data(company_id: "company_id")
|
|
|
8349
8635
|
<dl>
|
|
8350
8636
|
<dd>
|
|
8351
8637
|
|
|
8352
|
-
**currency:** `
|
|
8638
|
+
**currency:** `Schematic::Types::Currency`
|
|
8353
8639
|
|
|
8354
8640
|
</dd>
|
|
8355
8641
|
</dl>
|
|
@@ -11006,7 +11292,7 @@ client.companies.count_entity_traits(
|
|
|
11006
11292
|
|
|
11007
11293
|
```ruby
|
|
11008
11294
|
client.companies.list_plan_changes(
|
|
11009
|
-
action: "
|
|
11295
|
+
action: "amendment",
|
|
11010
11296
|
base_plan_action: "fallback",
|
|
11011
11297
|
company_id: "company_id",
|
|
11012
11298
|
company_ids: ["company_ids"],
|
|
@@ -12146,7 +12432,7 @@ client.entitlements.create_company_override(
|
|
|
12146
12432
|
<dl>
|
|
12147
12433
|
<dd>
|
|
12148
12434
|
|
|
12149
|
-
**credit_consumption_rate:** `
|
|
12435
|
+
**credit_consumption_rate:** `Float`
|
|
12150
12436
|
|
|
12151
12437
|
</dd>
|
|
12152
12438
|
</dl>
|
|
@@ -12194,6 +12480,14 @@ client.entitlements.create_company_override(
|
|
|
12194
12480
|
<dl>
|
|
12195
12481
|
<dd>
|
|
12196
12482
|
|
|
12483
|
+
**quantity_rates:** `Internal::Types::Hash[String, Float]` — Credits per unit of the quantity (per token for inference features), keyed by quantity key. Inference features may price input_tokens, output_tokens, cached_input_tokens, cache_creation_input_tokens and reasoning_tokens; reasoning_tokens is priced on top of output_tokens, so leave its rate at zero for providers that count reasoning inside output. Omit to leave the schedule as it is; send null to clear it.
|
|
12484
|
+
|
|
12485
|
+
</dd>
|
|
12486
|
+
</dl>
|
|
12487
|
+
|
|
12488
|
+
<dl>
|
|
12489
|
+
<dd>
|
|
12490
|
+
|
|
12197
12491
|
**value_bool:** `Internal::Types::Boolean`
|
|
12198
12492
|
|
|
12199
12493
|
</dd>
|
|
@@ -12333,7 +12627,7 @@ client.entitlements.update_company_override(
|
|
|
12333
12627
|
<dl>
|
|
12334
12628
|
<dd>
|
|
12335
12629
|
|
|
12336
|
-
**credit_consumption_rate:** `
|
|
12630
|
+
**credit_consumption_rate:** `Float`
|
|
12337
12631
|
|
|
12338
12632
|
</dd>
|
|
12339
12633
|
</dl>
|
|
@@ -12373,6 +12667,14 @@ client.entitlements.update_company_override(
|
|
|
12373
12667
|
<dl>
|
|
12374
12668
|
<dd>
|
|
12375
12669
|
|
|
12670
|
+
**quantity_rates:** `Internal::Types::Hash[String, Float]` — Credits per unit of the quantity (per token for inference features), keyed by quantity key. Inference features may price input_tokens, output_tokens, cached_input_tokens, cache_creation_input_tokens and reasoning_tokens; reasoning_tokens is priced on top of output_tokens, so leave its rate at zero for providers that count reasoning inside output. Omit to leave the schedule as it is; send null to clear it.
|
|
12671
|
+
|
|
12672
|
+
</dd>
|
|
12673
|
+
</dl>
|
|
12674
|
+
|
|
12675
|
+
<dl>
|
|
12676
|
+
<dd>
|
|
12677
|
+
|
|
12376
12678
|
**value_bool:** `Internal::Types::Boolean`
|
|
12377
12679
|
|
|
12378
12680
|
</dd>
|
|
@@ -13523,7 +13825,7 @@ client.entitlements.create_plan_entitlement(
|
|
|
13523
13825
|
<dl>
|
|
13524
13826
|
<dd>
|
|
13525
13827
|
|
|
13526
|
-
**credit_consumption_rate:** `
|
|
13828
|
+
**credit_consumption_rate:** `Float`
|
|
13527
13829
|
|
|
13528
13830
|
</dd>
|
|
13529
13831
|
</dl>
|
|
@@ -13531,7 +13833,7 @@ client.entitlements.create_plan_entitlement(
|
|
|
13531
13833
|
<dl>
|
|
13532
13834
|
<dd>
|
|
13533
13835
|
|
|
13534
|
-
**currency:** `
|
|
13836
|
+
**currency:** `Schematic::Types::Currency`
|
|
13535
13837
|
|
|
13536
13838
|
</dd>
|
|
13537
13839
|
</dl>
|
|
@@ -13659,6 +13961,14 @@ client.entitlements.create_plan_entitlement(
|
|
|
13659
13961
|
<dl>
|
|
13660
13962
|
<dd>
|
|
13661
13963
|
|
|
13964
|
+
**quantity_rates:** `Internal::Types::Hash[String, Float]` — Credits per unit of the quantity (per token for inference features), keyed by quantity key. Inference features may price input_tokens, output_tokens, cached_input_tokens, cache_creation_input_tokens and reasoning_tokens; reasoning_tokens is priced on top of output_tokens, so leave its rate at zero for providers that count reasoning inside output. Omit to leave the schedule as it is; send null to clear it.
|
|
13965
|
+
|
|
13966
|
+
</dd>
|
|
13967
|
+
</dl>
|
|
13968
|
+
|
|
13969
|
+
<dl>
|
|
13970
|
+
<dd>
|
|
13971
|
+
|
|
13662
13972
|
**quarterly_metered_price_id:** `String`
|
|
13663
13973
|
|
|
13664
13974
|
</dd>
|
|
@@ -13910,7 +14220,7 @@ client.entitlements.update_plan_entitlement(
|
|
|
13910
14220
|
<dl>
|
|
13911
14221
|
<dd>
|
|
13912
14222
|
|
|
13913
|
-
**credit_consumption_rate:** `
|
|
14223
|
+
**credit_consumption_rate:** `Float`
|
|
13914
14224
|
|
|
13915
14225
|
</dd>
|
|
13916
14226
|
</dl>
|
|
@@ -13918,7 +14228,7 @@ client.entitlements.update_plan_entitlement(
|
|
|
13918
14228
|
<dl>
|
|
13919
14229
|
<dd>
|
|
13920
14230
|
|
|
13921
|
-
**currency:** `
|
|
14231
|
+
**currency:** `Schematic::Types::Currency`
|
|
13922
14232
|
|
|
13923
14233
|
</dd>
|
|
13924
14234
|
</dl>
|
|
@@ -14022,6 +14332,14 @@ client.entitlements.update_plan_entitlement(
|
|
|
14022
14332
|
<dl>
|
|
14023
14333
|
<dd>
|
|
14024
14334
|
|
|
14335
|
+
**quantity_rates:** `Internal::Types::Hash[String, Float]` — Credits per unit of the quantity (per token for inference features), keyed by quantity key. Inference features may price input_tokens, output_tokens, cached_input_tokens, cache_creation_input_tokens and reasoning_tokens; reasoning_tokens is priced on top of output_tokens, so leave its rate at zero for providers that count reasoning inside output. Omit to leave the schedule as it is; send null to clear it.
|
|
14336
|
+
|
|
14337
|
+
</dd>
|
|
14338
|
+
</dl>
|
|
14339
|
+
|
|
14340
|
+
<dl>
|
|
14341
|
+
<dd>
|
|
14342
|
+
|
|
14025
14343
|
**quarterly_metered_price_id:** `String`
|
|
14026
14344
|
|
|
14027
14345
|
</dd>
|
|
@@ -14276,7 +14594,7 @@ client.entitlements.upsert_plan_entitlement_for_billing_product(
|
|
|
14276
14594
|
<dl>
|
|
14277
14595
|
<dd>
|
|
14278
14596
|
|
|
14279
|
-
**credit_consumption_rate:** `
|
|
14597
|
+
**credit_consumption_rate:** `Float`
|
|
14280
14598
|
|
|
14281
14599
|
</dd>
|
|
14282
14600
|
</dl>
|
|
@@ -14284,7 +14602,7 @@ client.entitlements.upsert_plan_entitlement_for_billing_product(
|
|
|
14284
14602
|
<dl>
|
|
14285
14603
|
<dd>
|
|
14286
14604
|
|
|
14287
|
-
**currency:** `
|
|
14605
|
+
**currency:** `Schematic::Types::Currency`
|
|
14288
14606
|
|
|
14289
14607
|
</dd>
|
|
14290
14608
|
</dl>
|
|
@@ -14420,6 +14738,14 @@ client.entitlements.upsert_plan_entitlement_for_billing_product(
|
|
|
14420
14738
|
<dl>
|
|
14421
14739
|
<dd>
|
|
14422
14740
|
|
|
14741
|
+
**quantity_rates:** `Internal::Types::Hash[String, Float]` — Credits per unit of the quantity (per token for inference features), keyed by quantity key. Inference features may price input_tokens, output_tokens, cached_input_tokens, cache_creation_input_tokens and reasoning_tokens; reasoning_tokens is priced on top of output_tokens, so leave its rate at zero for providers that count reasoning inside output. Omit to leave the schedule as it is; send null to clear it.
|
|
14742
|
+
|
|
14743
|
+
</dd>
|
|
14744
|
+
</dl>
|
|
14745
|
+
|
|
14746
|
+
<dl>
|
|
14747
|
+
<dd>
|
|
14748
|
+
|
|
14423
14749
|
**quarterly_metered_price_id:** `String`
|
|
14424
14750
|
|
|
14425
14751
|
</dd>
|
|
@@ -14624,7 +14950,249 @@ client.entitlements.count_plan_entitlements(
|
|
|
14624
14950
|
<dl>
|
|
14625
14951
|
<dd>
|
|
14626
14952
|
|
|
14627
|
-
**ids:** `String` — Filter plan entitlements by multiple plan entitlement IDs (starting with pltl_)
|
|
14953
|
+
**ids:** `String` — Filter plan entitlements by multiple plan entitlement IDs (starting with pltl_)
|
|
14954
|
+
|
|
14955
|
+
</dd>
|
|
14956
|
+
</dl>
|
|
14957
|
+
|
|
14958
|
+
<dl>
|
|
14959
|
+
<dd>
|
|
14960
|
+
|
|
14961
|
+
**plan_id:** `String` — Filter plan entitlements by a single plan ID (starting with plan_)
|
|
14962
|
+
|
|
14963
|
+
</dd>
|
|
14964
|
+
</dl>
|
|
14965
|
+
|
|
14966
|
+
<dl>
|
|
14967
|
+
<dd>
|
|
14968
|
+
|
|
14969
|
+
**plan_ids:** `String` — Filter plan entitlements by multiple plan IDs (starting with plan_)
|
|
14970
|
+
|
|
14971
|
+
</dd>
|
|
14972
|
+
</dl>
|
|
14973
|
+
|
|
14974
|
+
<dl>
|
|
14975
|
+
<dd>
|
|
14976
|
+
|
|
14977
|
+
**plan_version_id:** `String` — Filter plan entitlements by a single plan version ID (starting with plvr_)
|
|
14978
|
+
|
|
14979
|
+
</dd>
|
|
14980
|
+
</dl>
|
|
14981
|
+
|
|
14982
|
+
<dl>
|
|
14983
|
+
<dd>
|
|
14984
|
+
|
|
14985
|
+
**plan_version_ids:** `String` — Filter plan entitlements by multiple plan version IDs (starting with plvr_)
|
|
14986
|
+
|
|
14987
|
+
</dd>
|
|
14988
|
+
</dl>
|
|
14989
|
+
|
|
14990
|
+
<dl>
|
|
14991
|
+
<dd>
|
|
14992
|
+
|
|
14993
|
+
**q:** `String` — Search for plan entitlements by feature or company name
|
|
14994
|
+
|
|
14995
|
+
</dd>
|
|
14996
|
+
</dl>
|
|
14997
|
+
|
|
14998
|
+
<dl>
|
|
14999
|
+
<dd>
|
|
15000
|
+
|
|
15001
|
+
**with_metered_products:** `Internal::Types::Boolean` — Filter plan entitlements only with metered products
|
|
15002
|
+
|
|
15003
|
+
</dd>
|
|
15004
|
+
</dl>
|
|
15005
|
+
|
|
15006
|
+
<dl>
|
|
15007
|
+
<dd>
|
|
15008
|
+
|
|
15009
|
+
**limit:** `Integer` — Page limit (default 100)
|
|
15010
|
+
|
|
15011
|
+
</dd>
|
|
15012
|
+
</dl>
|
|
15013
|
+
|
|
15014
|
+
<dl>
|
|
15015
|
+
<dd>
|
|
15016
|
+
|
|
15017
|
+
**offset:** `Integer` — Page offset (default 0)
|
|
15018
|
+
|
|
15019
|
+
</dd>
|
|
15020
|
+
</dl>
|
|
15021
|
+
|
|
15022
|
+
<dl>
|
|
15023
|
+
<dd>
|
|
15024
|
+
|
|
15025
|
+
**request_options:** `Schematic::Entitlements::RequestOptions`
|
|
15026
|
+
|
|
15027
|
+
</dd>
|
|
15028
|
+
</dl>
|
|
15029
|
+
</dd>
|
|
15030
|
+
</dl>
|
|
15031
|
+
|
|
15032
|
+
|
|
15033
|
+
</dd>
|
|
15034
|
+
</dl>
|
|
15035
|
+
</details>
|
|
15036
|
+
|
|
15037
|
+
<details><summary><code>client.entitlements.<a href="/lib/schematic/entitlements/client.rb">duplicate_plan_entitlements</a>(request) -> Schematic::Entitlements::Types::DuplicatePlanEntitlementsResponse</code></summary>
|
|
15038
|
+
<dl>
|
|
15039
|
+
<dd>
|
|
15040
|
+
|
|
15041
|
+
#### 🔌 Usage
|
|
15042
|
+
|
|
15043
|
+
<dl>
|
|
15044
|
+
<dd>
|
|
15045
|
+
|
|
15046
|
+
<dl>
|
|
15047
|
+
<dd>
|
|
15048
|
+
|
|
15049
|
+
```ruby
|
|
15050
|
+
client.entitlements.duplicate_plan_entitlements(
|
|
15051
|
+
source_plan_id: "source_plan_id",
|
|
15052
|
+
target_plan_id: "target_plan_id"
|
|
15053
|
+
)
|
|
15054
|
+
```
|
|
15055
|
+
</dd>
|
|
15056
|
+
</dl>
|
|
15057
|
+
</dd>
|
|
15058
|
+
</dl>
|
|
15059
|
+
|
|
15060
|
+
#### ⚙️ Parameters
|
|
15061
|
+
|
|
15062
|
+
<dl>
|
|
15063
|
+
<dd>
|
|
15064
|
+
|
|
15065
|
+
<dl>
|
|
15066
|
+
<dd>
|
|
15067
|
+
|
|
15068
|
+
**source_plan_id:** `String`
|
|
15069
|
+
|
|
15070
|
+
</dd>
|
|
15071
|
+
</dl>
|
|
15072
|
+
|
|
15073
|
+
<dl>
|
|
15074
|
+
<dd>
|
|
15075
|
+
|
|
15076
|
+
**target_plan_id:** `String`
|
|
15077
|
+
|
|
15078
|
+
</dd>
|
|
15079
|
+
</dl>
|
|
15080
|
+
|
|
15081
|
+
<dl>
|
|
15082
|
+
<dd>
|
|
15083
|
+
|
|
15084
|
+
**request_options:** `Schematic::Entitlements::RequestOptions`
|
|
15085
|
+
|
|
15086
|
+
</dd>
|
|
15087
|
+
</dl>
|
|
15088
|
+
</dd>
|
|
15089
|
+
</dl>
|
|
15090
|
+
|
|
15091
|
+
|
|
15092
|
+
</dd>
|
|
15093
|
+
</dl>
|
|
15094
|
+
</details>
|
|
15095
|
+
|
|
15096
|
+
<details><summary><code>client.entitlements.<a href="/lib/schematic/entitlements/client.rb">get_feature_usage_by_company</a>() -> Schematic::Entitlements::Types::GetFeatureUsageByCompanyResponse</code></summary>
|
|
15097
|
+
<dl>
|
|
15098
|
+
<dd>
|
|
15099
|
+
|
|
15100
|
+
#### 🔌 Usage
|
|
15101
|
+
|
|
15102
|
+
<dl>
|
|
15103
|
+
<dd>
|
|
15104
|
+
|
|
15105
|
+
<dl>
|
|
15106
|
+
<dd>
|
|
15107
|
+
|
|
15108
|
+
```ruby
|
|
15109
|
+
client.entitlements.get_feature_usage_by_company(keys: {
|
|
15110
|
+
keys: "keys"
|
|
15111
|
+
})
|
|
15112
|
+
```
|
|
15113
|
+
</dd>
|
|
15114
|
+
</dl>
|
|
15115
|
+
</dd>
|
|
15116
|
+
</dl>
|
|
15117
|
+
|
|
15118
|
+
#### ⚙️ Parameters
|
|
15119
|
+
|
|
15120
|
+
<dl>
|
|
15121
|
+
<dd>
|
|
15122
|
+
|
|
15123
|
+
<dl>
|
|
15124
|
+
<dd>
|
|
15125
|
+
|
|
15126
|
+
**keys:** `Internal::Types::Hash[String, String]` — Key/value pairs
|
|
15127
|
+
|
|
15128
|
+
</dd>
|
|
15129
|
+
</dl>
|
|
15130
|
+
|
|
15131
|
+
<dl>
|
|
15132
|
+
<dd>
|
|
15133
|
+
|
|
15134
|
+
**request_options:** `Schematic::Entitlements::RequestOptions`
|
|
15135
|
+
|
|
15136
|
+
</dd>
|
|
15137
|
+
</dl>
|
|
15138
|
+
</dd>
|
|
15139
|
+
</dl>
|
|
15140
|
+
|
|
15141
|
+
|
|
15142
|
+
</dd>
|
|
15143
|
+
</dl>
|
|
15144
|
+
</details>
|
|
15145
|
+
|
|
15146
|
+
<details><summary><code>client.entitlements.<a href="/lib/schematic/entitlements/client.rb">get_user_usage_by_company</a>() -> Schematic::Entitlements::Types::GetUserUsageByCompanyResponse</code></summary>
|
|
15147
|
+
<dl>
|
|
15148
|
+
<dd>
|
|
15149
|
+
|
|
15150
|
+
#### 🔌 Usage
|
|
15151
|
+
|
|
15152
|
+
<dl>
|
|
15153
|
+
<dd>
|
|
15154
|
+
|
|
15155
|
+
<dl>
|
|
15156
|
+
<dd>
|
|
15157
|
+
|
|
15158
|
+
```ruby
|
|
15159
|
+
client.entitlements.get_user_usage_by_company(
|
|
15160
|
+
company_id: "company_id",
|
|
15161
|
+
end_time: "2024-01-15T09:30:00Z",
|
|
15162
|
+
feature_id: "feature_id",
|
|
15163
|
+
start_time: "2024-01-15T09:30:00Z"
|
|
15164
|
+
)
|
|
15165
|
+
```
|
|
15166
|
+
</dd>
|
|
15167
|
+
</dl>
|
|
15168
|
+
</dd>
|
|
15169
|
+
</dl>
|
|
15170
|
+
|
|
15171
|
+
#### ⚙️ Parameters
|
|
15172
|
+
|
|
15173
|
+
<dl>
|
|
15174
|
+
<dd>
|
|
15175
|
+
|
|
15176
|
+
<dl>
|
|
15177
|
+
<dd>
|
|
15178
|
+
|
|
15179
|
+
**company_id:** `String` — Company to break usage down for
|
|
15180
|
+
|
|
15181
|
+
</dd>
|
|
15182
|
+
</dl>
|
|
15183
|
+
|
|
15184
|
+
<dl>
|
|
15185
|
+
<dd>
|
|
15186
|
+
|
|
15187
|
+
**end_time:** `String` — End of the usage window (exclusive); defaults to now
|
|
15188
|
+
|
|
15189
|
+
</dd>
|
|
15190
|
+
</dl>
|
|
15191
|
+
|
|
15192
|
+
<dl>
|
|
15193
|
+
<dd>
|
|
15194
|
+
|
|
15195
|
+
**feature_id:** `String` — Restrict to a single event-based feature
|
|
14628
15196
|
|
|
14629
15197
|
</dd>
|
|
14630
15198
|
</dl>
|
|
@@ -14632,7 +15200,7 @@ client.entitlements.count_plan_entitlements(
|
|
|
14632
15200
|
<dl>
|
|
14633
15201
|
<dd>
|
|
14634
15202
|
|
|
14635
|
-
**
|
|
15203
|
+
**start_time:** `String` — Start of the usage window; defaults to 30 days before the end
|
|
14636
15204
|
|
|
14637
15205
|
</dd>
|
|
14638
15206
|
</dl>
|
|
@@ -14640,39 +15208,51 @@ client.entitlements.count_plan_entitlements(
|
|
|
14640
15208
|
<dl>
|
|
14641
15209
|
<dd>
|
|
14642
15210
|
|
|
14643
|
-
**
|
|
15211
|
+
**request_options:** `Schematic::Entitlements::RequestOptions`
|
|
14644
15212
|
|
|
14645
15213
|
</dd>
|
|
14646
15214
|
</dl>
|
|
15215
|
+
</dd>
|
|
15216
|
+
</dl>
|
|
14647
15217
|
|
|
14648
|
-
<dl>
|
|
14649
|
-
<dd>
|
|
14650
15218
|
|
|
14651
|
-
**plan_version_id:** `String` — Filter plan entitlements by a single plan version ID (starting with plvr_)
|
|
14652
|
-
|
|
14653
15219
|
</dd>
|
|
14654
15220
|
</dl>
|
|
15221
|
+
</details>
|
|
14655
15222
|
|
|
15223
|
+
<details><summary><code>client.entitlements.<a href="/lib/schematic/entitlements/client.rb">get_company_user_usage_metrics</a>() -> Schematic::Entitlements::Types::GetCompanyUserUsageMetricsResponse</code></summary>
|
|
14656
15224
|
<dl>
|
|
14657
15225
|
<dd>
|
|
14658
15226
|
|
|
14659
|
-
|
|
14660
|
-
|
|
14661
|
-
</dd>
|
|
14662
|
-
</dl>
|
|
15227
|
+
#### 🔌 Usage
|
|
14663
15228
|
|
|
14664
15229
|
<dl>
|
|
14665
15230
|
<dd>
|
|
14666
15231
|
|
|
14667
|
-
|
|
14668
|
-
|
|
15232
|
+
<dl>
|
|
15233
|
+
<dd>
|
|
15234
|
+
|
|
15235
|
+
```ruby
|
|
15236
|
+
client.entitlements.get_company_user_usage_metrics(
|
|
15237
|
+
company_id: "company_id",
|
|
15238
|
+
end_time: "2024-01-15T09:30:00Z",
|
|
15239
|
+
start_time: "2024-01-15T09:30:00Z"
|
|
15240
|
+
)
|
|
15241
|
+
```
|
|
15242
|
+
</dd>
|
|
15243
|
+
</dl>
|
|
14669
15244
|
</dd>
|
|
14670
15245
|
</dl>
|
|
14671
15246
|
|
|
15247
|
+
#### ⚙️ Parameters
|
|
15248
|
+
|
|
14672
15249
|
<dl>
|
|
14673
15250
|
<dd>
|
|
14674
15251
|
|
|
14675
|
-
|
|
15252
|
+
<dl>
|
|
15253
|
+
<dd>
|
|
15254
|
+
|
|
15255
|
+
**company_id:** `String` — Company to list available metrics for
|
|
14676
15256
|
|
|
14677
15257
|
</dd>
|
|
14678
15258
|
</dl>
|
|
@@ -14680,7 +15260,7 @@ client.entitlements.count_plan_entitlements(
|
|
|
14680
15260
|
<dl>
|
|
14681
15261
|
<dd>
|
|
14682
15262
|
|
|
14683
|
-
**
|
|
15263
|
+
**end_time:** `String` — End of the usage window (exclusive); defaults to now
|
|
14684
15264
|
|
|
14685
15265
|
</dd>
|
|
14686
15266
|
</dl>
|
|
@@ -14688,7 +15268,7 @@ client.entitlements.count_plan_entitlements(
|
|
|
14688
15268
|
<dl>
|
|
14689
15269
|
<dd>
|
|
14690
15270
|
|
|
14691
|
-
**
|
|
15271
|
+
**start_time:** `String` — Start of the usage window; defaults to 30 days before the end
|
|
14692
15272
|
|
|
14693
15273
|
</dd>
|
|
14694
15274
|
</dl>
|
|
@@ -14708,7 +15288,7 @@ client.entitlements.count_plan_entitlements(
|
|
|
14708
15288
|
</dl>
|
|
14709
15289
|
</details>
|
|
14710
15290
|
|
|
14711
|
-
<details><summary><code>client.entitlements.<a href="/lib/schematic/entitlements/client.rb">
|
|
15291
|
+
<details><summary><code>client.entitlements.<a href="/lib/schematic/entitlements/client.rb">list_company_user_usage</a>() -> Schematic::Entitlements::Types::ListCompanyUserUsageResponse</code></summary>
|
|
14712
15292
|
<dl>
|
|
14713
15293
|
<dd>
|
|
14714
15294
|
|
|
@@ -14721,9 +15301,14 @@ client.entitlements.count_plan_entitlements(
|
|
|
14721
15301
|
<dd>
|
|
14722
15302
|
|
|
14723
15303
|
```ruby
|
|
14724
|
-
client.entitlements.
|
|
14725
|
-
|
|
14726
|
-
|
|
15304
|
+
client.entitlements.list_company_user_usage(
|
|
15305
|
+
company_id: "company_id",
|
|
15306
|
+
end_time: "2024-01-15T09:30:00Z",
|
|
15307
|
+
feature_id: "feature_id",
|
|
15308
|
+
metric: "credits",
|
|
15309
|
+
limit: 1000000,
|
|
15310
|
+
offset: 1000000,
|
|
15311
|
+
start_time: "2024-01-15T09:30:00Z"
|
|
14727
15312
|
)
|
|
14728
15313
|
```
|
|
14729
15314
|
</dd>
|
|
@@ -14739,7 +15324,7 @@ client.entitlements.duplicate_plan_entitlements(
|
|
|
14739
15324
|
<dl>
|
|
14740
15325
|
<dd>
|
|
14741
15326
|
|
|
14742
|
-
**
|
|
15327
|
+
**company_id:** `String` — Company to break usage down for
|
|
14743
15328
|
|
|
14744
15329
|
</dd>
|
|
14745
15330
|
</dl>
|
|
@@ -14747,7 +15332,7 @@ client.entitlements.duplicate_plan_entitlements(
|
|
|
14747
15332
|
<dl>
|
|
14748
15333
|
<dd>
|
|
14749
15334
|
|
|
14750
|
-
**
|
|
15335
|
+
**end_time:** `String` — End of the usage window (exclusive); defaults to now
|
|
14751
15336
|
|
|
14752
15337
|
</dd>
|
|
14753
15338
|
</dl>
|
|
@@ -14755,49 +15340,39 @@ client.entitlements.duplicate_plan_entitlements(
|
|
|
14755
15340
|
<dl>
|
|
14756
15341
|
<dd>
|
|
14757
15342
|
|
|
14758
|
-
**
|
|
15343
|
+
**feature_id:** `String` — The event-based feature to break down; required when metric is feature
|
|
14759
15344
|
|
|
14760
15345
|
</dd>
|
|
14761
15346
|
</dl>
|
|
14762
|
-
</dd>
|
|
14763
|
-
</dl>
|
|
14764
15347
|
|
|
15348
|
+
<dl>
|
|
15349
|
+
<dd>
|
|
14765
15350
|
|
|
15351
|
+
**metric:** `Schematic::Types::UserUsageMetric` — Which metric to break usage down by
|
|
15352
|
+
|
|
14766
15353
|
</dd>
|
|
14767
15354
|
</dl>
|
|
14768
|
-
</details>
|
|
14769
15355
|
|
|
14770
|
-
<details><summary><code>client.entitlements.<a href="/lib/schematic/entitlements/client.rb">get_feature_usage_by_company</a>() -> Schematic::Entitlements::Types::GetFeatureUsageByCompanyResponse</code></summary>
|
|
14771
15356
|
<dl>
|
|
14772
15357
|
<dd>
|
|
14773
15358
|
|
|
14774
|
-
|
|
14775
|
-
|
|
14776
|
-
|
|
14777
|
-
|
|
15359
|
+
**limit:** `Integer` — Page limit (default 100)
|
|
15360
|
+
|
|
15361
|
+
</dd>
|
|
15362
|
+
</dl>
|
|
14778
15363
|
|
|
14779
15364
|
<dl>
|
|
14780
15365
|
<dd>
|
|
14781
15366
|
|
|
14782
|
-
|
|
14783
|
-
|
|
14784
|
-
keys: "keys"
|
|
14785
|
-
})
|
|
14786
|
-
```
|
|
14787
|
-
</dd>
|
|
14788
|
-
</dl>
|
|
15367
|
+
**offset:** `Integer` — Page offset (default 0)
|
|
15368
|
+
|
|
14789
15369
|
</dd>
|
|
14790
15370
|
</dl>
|
|
14791
15371
|
|
|
14792
|
-
#### ⚙️ Parameters
|
|
14793
|
-
|
|
14794
|
-
<dl>
|
|
14795
|
-
<dd>
|
|
14796
|
-
|
|
14797
15372
|
<dl>
|
|
14798
15373
|
<dd>
|
|
14799
15374
|
|
|
14800
|
-
**
|
|
15375
|
+
**start_time:** `String` — Start of the usage window; defaults to 30 days before the end
|
|
14801
15376
|
|
|
14802
15377
|
</dd>
|
|
14803
15378
|
</dl>
|
|
@@ -14817,7 +15392,7 @@ client.entitlements.get_feature_usage_by_company(keys: {
|
|
|
14817
15392
|
</dl>
|
|
14818
15393
|
</details>
|
|
14819
15394
|
|
|
14820
|
-
<details><summary><code>client.entitlements.<a href="/lib/schematic/entitlements/client.rb">
|
|
15395
|
+
<details><summary><code>client.entitlements.<a href="/lib/schematic/entitlements/client.rb">count_company_user_usage</a>() -> Schematic::Entitlements::Types::CountCompanyUserUsageResponse</code></summary>
|
|
14821
15396
|
<dl>
|
|
14822
15397
|
<dd>
|
|
14823
15398
|
|
|
@@ -14830,10 +15405,13 @@ client.entitlements.get_feature_usage_by_company(keys: {
|
|
|
14830
15405
|
<dd>
|
|
14831
15406
|
|
|
14832
15407
|
```ruby
|
|
14833
|
-
client.entitlements.
|
|
15408
|
+
client.entitlements.count_company_user_usage(
|
|
14834
15409
|
company_id: "company_id",
|
|
14835
15410
|
end_time: "2024-01-15T09:30:00Z",
|
|
14836
15411
|
feature_id: "feature_id",
|
|
15412
|
+
metric: "credits",
|
|
15413
|
+
limit: 1000000,
|
|
15414
|
+
offset: 1000000,
|
|
14837
15415
|
start_time: "2024-01-15T09:30:00Z"
|
|
14838
15416
|
)
|
|
14839
15417
|
```
|
|
@@ -14866,7 +15444,31 @@ client.entitlements.get_user_usage_by_company(
|
|
|
14866
15444
|
<dl>
|
|
14867
15445
|
<dd>
|
|
14868
15446
|
|
|
14869
|
-
**feature_id:** `String` —
|
|
15447
|
+
**feature_id:** `String` — The event-based feature to break down; required when metric is feature
|
|
15448
|
+
|
|
15449
|
+
</dd>
|
|
15450
|
+
</dl>
|
|
15451
|
+
|
|
15452
|
+
<dl>
|
|
15453
|
+
<dd>
|
|
15454
|
+
|
|
15455
|
+
**metric:** `Schematic::Types::UserUsageMetric` — Which metric to break usage down by
|
|
15456
|
+
|
|
15457
|
+
</dd>
|
|
15458
|
+
</dl>
|
|
15459
|
+
|
|
15460
|
+
<dl>
|
|
15461
|
+
<dd>
|
|
15462
|
+
|
|
15463
|
+
**limit:** `Integer` — Page limit (default 100)
|
|
15464
|
+
|
|
15465
|
+
</dd>
|
|
15466
|
+
</dl>
|
|
15467
|
+
|
|
15468
|
+
<dl>
|
|
15469
|
+
<dd>
|
|
15470
|
+
|
|
15471
|
+
**offset:** `Integer` — Page offset (default 0)
|
|
14870
15472
|
|
|
14871
15473
|
</dd>
|
|
14872
15474
|
</dl>
|
|
@@ -15055,7 +15657,7 @@ client.plans.update_company_plans(
|
|
|
15055
15657
|
client.plans.list_custom_plan_billings(
|
|
15056
15658
|
company_id: "company_id",
|
|
15057
15659
|
plan_id: "plan_id",
|
|
15058
|
-
plan_billing_source: "
|
|
15660
|
+
plan_billing_source: "amendment",
|
|
15059
15661
|
status: "active",
|
|
15060
15662
|
statuses: ["active"],
|
|
15061
15663
|
limit: 1000000,
|
|
@@ -15091,7 +15693,7 @@ client.plans.list_custom_plan_billings(
|
|
|
15091
15693
|
<dl>
|
|
15092
15694
|
<dd>
|
|
15093
15695
|
|
|
15094
|
-
**plan_billing_source:** `Schematic::Types::PlanBillingSource` — Filter by the flow that created the billing record. Defaults to custom_plan.
|
|
15696
|
+
**plan_billing_source:** `Schematic::Types::PlanBillingSource` — Filter by the flow that created the billing record: custom_plan for a first publish, amendment for a republish, manage_plan for a standard plan assigned by invoice. Defaults to custom_plan.
|
|
15095
15697
|
|
|
15096
15698
|
</dd>
|
|
15097
15699
|
</dl>
|
|
@@ -15259,6 +15861,14 @@ client.plans.retry_custom_plan_billing(
|
|
|
15259
15861
|
<dl>
|
|
15260
15862
|
<dd>
|
|
15261
15863
|
|
|
15864
|
+
**billing_start_date:** `String` — The date the contract term starts. A past date backdates the subscription so the first invoice covers the term from this date to the renewal date. Requires billing_cycle_anchor. When both are omitted, the term pinned at finalize is reissued. Only honored when the retry creates a subscription.
|
|
15865
|
+
|
|
15866
|
+
</dd>
|
|
15867
|
+
</dl>
|
|
15868
|
+
|
|
15869
|
+
<dl>
|
|
15870
|
+
<dd>
|
|
15871
|
+
|
|
15262
15872
|
**customer_email:** `String`
|
|
15263
15873
|
|
|
15264
15874
|
</dd>
|
|
@@ -16482,6 +17092,65 @@ client.plans.delete_plan_version(
|
|
|
16482
17092
|
</dl>
|
|
16483
17093
|
|
|
16484
17094
|
|
|
17095
|
+
</dd>
|
|
17096
|
+
</dl>
|
|
17097
|
+
</details>
|
|
17098
|
+
|
|
17099
|
+
<details><summary><code>client.plans.<a href="/lib/schematic/plans/client.rb">get_plan_version_diff</a>(plan_version_id:) -> Schematic::Plans::Types::GetPlanVersionDiffResponse</code></summary>
|
|
17100
|
+
<dl>
|
|
17101
|
+
<dd>
|
|
17102
|
+
|
|
17103
|
+
#### 🔌 Usage
|
|
17104
|
+
|
|
17105
|
+
<dl>
|
|
17106
|
+
<dd>
|
|
17107
|
+
|
|
17108
|
+
<dl>
|
|
17109
|
+
<dd>
|
|
17110
|
+
|
|
17111
|
+
```ruby
|
|
17112
|
+
client.plans.get_plan_version_diff(
|
|
17113
|
+
plan_version_id: "plan_version_id",
|
|
17114
|
+
against: "against"
|
|
17115
|
+
)
|
|
17116
|
+
```
|
|
17117
|
+
</dd>
|
|
17118
|
+
</dl>
|
|
17119
|
+
</dd>
|
|
17120
|
+
</dl>
|
|
17121
|
+
|
|
17122
|
+
#### ⚙️ Parameters
|
|
17123
|
+
|
|
17124
|
+
<dl>
|
|
17125
|
+
<dd>
|
|
17126
|
+
|
|
17127
|
+
<dl>
|
|
17128
|
+
<dd>
|
|
17129
|
+
|
|
17130
|
+
**plan_version_id:** `String` — plan_version_id
|
|
17131
|
+
|
|
17132
|
+
</dd>
|
|
17133
|
+
</dl>
|
|
17134
|
+
|
|
17135
|
+
<dl>
|
|
17136
|
+
<dd>
|
|
17137
|
+
|
|
17138
|
+
**against:** `String` — The version to compare against. Defaults to the plan's published version.
|
|
17139
|
+
|
|
17140
|
+
</dd>
|
|
17141
|
+
</dl>
|
|
17142
|
+
|
|
17143
|
+
<dl>
|
|
17144
|
+
<dd>
|
|
17145
|
+
|
|
17146
|
+
**request_options:** `Schematic::Plans::RequestOptions`
|
|
17147
|
+
|
|
17148
|
+
</dd>
|
|
17149
|
+
</dl>
|
|
17150
|
+
</dd>
|
|
17151
|
+
</dl>
|
|
17152
|
+
|
|
17153
|
+
|
|
16485
17154
|
</dd>
|
|
16486
17155
|
</dl>
|
|
16487
17156
|
</details>
|
|
@@ -16526,7 +17195,7 @@ client.plans.publish_plan_version(
|
|
|
16526
17195
|
<dl>
|
|
16527
17196
|
<dd>
|
|
16528
17197
|
|
|
16529
|
-
**activation_strategy:** `Schematic::Types::CustomPlanActivationStrategy`
|
|
17198
|
+
**activation_strategy:** `Schematic::Types::CustomPlanActivationStrategy` — When the company gets the plan. On a custom-plan republish, on_payment is only accepted when the amendment is invoiced today (migration_strategy immediate, proration_behavior always_invoice, collection_method send_invoice): the company stays on its current version until that invoice is paid.
|
|
16530
17199
|
|
|
16531
17200
|
</dd>
|
|
16532
17201
|
</dl>
|
|
@@ -16550,7 +17219,23 @@ client.plans.publish_plan_version(
|
|
|
16550
17219
|
<dl>
|
|
16551
17220
|
<dd>
|
|
16552
17221
|
|
|
16553
|
-
**
|
|
17222
|
+
**billing_start_date:** `String` — The date the contract term starts. A past date backdates the subscription so the first invoice covers the term from this date to the renewal date. Requires billing_cycle_anchor. Only honored on a first publish that starts a subscription.
|
|
17223
|
+
|
|
17224
|
+
</dd>
|
|
17225
|
+
</dl>
|
|
17226
|
+
|
|
17227
|
+
<dl>
|
|
17228
|
+
<dd>
|
|
17229
|
+
|
|
17230
|
+
**collection_method:** `Schematic::Types::BillingCollectionMethod` — How the invoice a custom-plan republish raises today is collected. send_invoice (the default) issues it for the company to pay; charge_automatically charges the default payment method straight away. Only accepted on a custom-plan republish with migration_strategy immediate and proration_behavior always_invoice.
|
|
17231
|
+
|
|
17232
|
+
</dd>
|
|
17233
|
+
</dl>
|
|
17234
|
+
|
|
17235
|
+
<dl>
|
|
17236
|
+
<dd>
|
|
17237
|
+
|
|
17238
|
+
**coupon_external_id:** `String` — A Stripe coupon to apply. On a custom-plan republish it discounts the amendment invoice and is only used when that invoice is raised today; it must exist in Stripe. It is attached to the subscription, so a repeating or forever coupon also discounts the renewals that follow.
|
|
16554
17239
|
|
|
16555
17240
|
</dd>
|
|
16556
17241
|
</dl>
|
|
@@ -16574,7 +17259,7 @@ client.plans.publish_plan_version(
|
|
|
16574
17259
|
<dl>
|
|
16575
17260
|
<dd>
|
|
16576
17261
|
|
|
16577
|
-
**days_until_due:** `Integer`
|
|
17262
|
+
**days_until_due:** `Integer` — Payment terms in days. On a custom-plan republish they apply to the amendment invoice only, leave the subscription's renewal terms unchanged, and are only used when that invoice is raised today and sent rather than charged. Defaults to the subscription's terms.
|
|
16578
17263
|
|
|
16579
17264
|
</dd>
|
|
16580
17265
|
</dl>
|
|
@@ -16614,7 +17299,7 @@ client.plans.publish_plan_version(
|
|
|
16614
17299
|
<dl>
|
|
16615
17300
|
<dd>
|
|
16616
17301
|
|
|
16617
|
-
**proration_behavior:** `Schematic::Types::MigrationProrationBehavior`
|
|
17302
|
+
**proration_behavior:** `Schematic::Types::MigrationProrationBehavior` — How Stripe handles the price difference when companies are migrated. With migration_strategy immediate, omitted means create_prorations. With end_of_billing_period only none is accepted and means the same as omitting it: the change lands on the renewal boundary, so there is nothing to prorate. With scheduled any value is accepted and omitted means none. Not accepted with leave.
|
|
16618
17303
|
|
|
16619
17304
|
</dd>
|
|
16620
17305
|
</dl>
|
|
@@ -16630,6 +17315,14 @@ client.plans.publish_plan_version(
|
|
|
16630
17315
|
<dl>
|
|
16631
17316
|
<dd>
|
|
16632
17317
|
|
|
17318
|
+
**scheduled_at:** `String` — When every company moves, for migration_strategy scheduled. Must be in the future; the migration runs within about a minute of this time. Not accepted with other strategies.
|
|
17319
|
+
|
|
17320
|
+
</dd>
|
|
17321
|
+
</dl>
|
|
17322
|
+
|
|
17323
|
+
<dl>
|
|
17324
|
+
<dd>
|
|
17325
|
+
|
|
16633
17326
|
**send_invoice:** `Internal::Types::Boolean` — Whether Stripe emails the invoice when it is finalized. Defaults to true.
|
|
16634
17327
|
|
|
16635
17328
|
</dd>
|
|
@@ -16758,7 +17451,7 @@ client.components.create_component(
|
|
|
16758
17451
|
<dl>
|
|
16759
17452
|
<dd>
|
|
16760
17453
|
|
|
16761
|
-
**ast:** `Internal::Types::Hash[String,
|
|
17454
|
+
**ast:** `Internal::Types::Hash[String, Float]`
|
|
16762
17455
|
|
|
16763
17456
|
</dd>
|
|
16764
17457
|
</dl>
|
|
@@ -16878,7 +17571,7 @@ client.components.update_component(component_id: "component_id")
|
|
|
16878
17571
|
<dl>
|
|
16879
17572
|
<dd>
|
|
16880
17573
|
|
|
16881
|
-
**ast:** `Internal::Types::Hash[String,
|
|
17574
|
+
**ast:** `Internal::Types::Hash[String, Float]`
|
|
16882
17575
|
|
|
16883
17576
|
</dd>
|
|
16884
17577
|
</dl>
|
|
@@ -18364,6 +19057,14 @@ client.features.create_feature(
|
|
|
18364
19057
|
<dl>
|
|
18365
19058
|
<dd>
|
|
18366
19059
|
|
|
19060
|
+
**event_source:** `Schematic::Types::FeatureEventSource` — Which event stream meters this feature; defaults to track, and cannot change after creation. Inference is only valid on event features: their event_subtype matches the event label on inference events, and they meter through credits only.
|
|
19061
|
+
|
|
19062
|
+
</dd>
|
|
19063
|
+
</dl>
|
|
19064
|
+
|
|
19065
|
+
<dl>
|
|
19066
|
+
<dd>
|
|
19067
|
+
|
|
18367
19068
|
**event_subtype:** `String`
|
|
18368
19069
|
|
|
18369
19070
|
</dd>
|
|
@@ -18548,6 +19249,14 @@ client.features.update_feature(feature_id: "feature_id")
|
|
|
18548
19249
|
<dl>
|
|
18549
19250
|
<dd>
|
|
18550
19251
|
|
|
19252
|
+
**event_source:** `Schematic::Types::FeatureEventSource` — Which event stream meters this feature. It is fixed at creation: an update that changes it is rejected.
|
|
19253
|
+
|
|
19254
|
+
</dd>
|
|
19255
|
+
</dl>
|
|
19256
|
+
|
|
19257
|
+
<dl>
|
|
19258
|
+
<dd>
|
|
19259
|
+
|
|
18551
19260
|
**event_subtype:** `String`
|
|
18552
19261
|
|
|
18553
19262
|
</dd>
|
|
@@ -18738,6 +19447,14 @@ client.features.upsert_feature_for_billing_product(
|
|
|
18738
19447
|
<dl>
|
|
18739
19448
|
<dd>
|
|
18740
19449
|
|
|
19450
|
+
**event_source:** `Schematic::Types::FeatureEventSource` — Which event stream meters this feature; defaults to track, and cannot change after creation. Inference is only valid on event features: their event_subtype matches the event label on inference events, and they meter through credits only.
|
|
19451
|
+
|
|
19452
|
+
</dd>
|
|
19453
|
+
</dl>
|
|
19454
|
+
|
|
19455
|
+
<dl>
|
|
19456
|
+
<dd>
|
|
19457
|
+
|
|
18741
19458
|
**event_subtype:** `String`
|
|
18742
19459
|
|
|
18743
19460
|
</dd>
|
|
@@ -19467,7 +20184,7 @@ client.features.check_and_reserve_flag(key: "key")
|
|
|
19467
20184
|
<dl>
|
|
19468
20185
|
<dd>
|
|
19469
20186
|
|
|
19470
|
-
**quantity:** `
|
|
20187
|
+
**quantity:** `Float` — Units of the feature the operation will consume. Sets the hold size together with the entitlement's consumption rate, and is echoed back on the reservation for the settling track event. When it is omitted the units come from preflight.event_usage.quantity, if that event subtype is the entitlement's, else from preflight.usage, else 1
|
|
19471
20188
|
|
|
19472
20189
|
</dd>
|
|
19473
20190
|
</dl>
|
|
@@ -21078,6 +21795,7 @@ client.plangroups.create_plan_group(
|
|
|
21078
21795
|
proration_behavior: "create_prorations",
|
|
21079
21796
|
show_as_monthly_prices: true,
|
|
21080
21797
|
show_credits: true,
|
|
21798
|
+
show_estimated_total: true,
|
|
21081
21799
|
show_feature_description: true,
|
|
21082
21800
|
show_hard_limit: true,
|
|
21083
21801
|
show_period_toggle: true,
|
|
@@ -21330,6 +22048,14 @@ client.plangroups.create_plan_group(
|
|
|
21330
22048
|
<dl>
|
|
21331
22049
|
<dd>
|
|
21332
22050
|
|
|
22051
|
+
**show_estimated_total:** `Internal::Types::Boolean`
|
|
22052
|
+
|
|
22053
|
+
</dd>
|
|
22054
|
+
</dl>
|
|
22055
|
+
|
|
22056
|
+
<dl>
|
|
22057
|
+
<dd>
|
|
22058
|
+
|
|
21333
22059
|
**show_feature_description:** `Internal::Types::Boolean`
|
|
21334
22060
|
|
|
21335
22061
|
</dd>
|
|
@@ -21458,6 +22184,7 @@ client.plangroups.update_plan_group(
|
|
|
21458
22184
|
proration_behavior: "create_prorations",
|
|
21459
22185
|
show_as_monthly_prices: true,
|
|
21460
22186
|
show_credits: true,
|
|
22187
|
+
show_estimated_total: true,
|
|
21461
22188
|
show_feature_description: true,
|
|
21462
22189
|
show_hard_limit: true,
|
|
21463
22190
|
show_period_toggle: true,
|
|
@@ -21718,6 +22445,14 @@ client.plangroups.update_plan_group(
|
|
|
21718
22445
|
<dl>
|
|
21719
22446
|
<dd>
|
|
21720
22447
|
|
|
22448
|
+
**show_estimated_total:** `Internal::Types::Boolean`
|
|
22449
|
+
|
|
22450
|
+
</dd>
|
|
22451
|
+
</dl>
|
|
22452
|
+
|
|
22453
|
+
<dl>
|
|
22454
|
+
<dd>
|
|
22455
|
+
|
|
21721
22456
|
**show_feature_description:** `Internal::Types::Boolean`
|
|
21722
22457
|
|
|
21723
22458
|
</dd>
|
|
@@ -22046,6 +22781,7 @@ client.planmigrations.count_company_migrations(
|
|
|
22046
22781
|
```ruby
|
|
22047
22782
|
client.planmigrations.list_migrations(
|
|
22048
22783
|
feature_id: "feature_id",
|
|
22784
|
+
feature_plan_rollout_id: "feature_plan_rollout_id",
|
|
22049
22785
|
plan_version_id: "plan_version_id",
|
|
22050
22786
|
status: "cancelled",
|
|
22051
22787
|
limit: 1000000,
|
|
@@ -22073,6 +22809,14 @@ client.planmigrations.list_migrations(
|
|
|
22073
22809
|
<dl>
|
|
22074
22810
|
<dd>
|
|
22075
22811
|
|
|
22812
|
+
**feature_plan_rollout_id:** `String`
|
|
22813
|
+
|
|
22814
|
+
</dd>
|
|
22815
|
+
</dl>
|
|
22816
|
+
|
|
22817
|
+
<dl>
|
|
22818
|
+
<dd>
|
|
22819
|
+
|
|
22076
22820
|
**plan_version_id:** `String`
|
|
22077
22821
|
|
|
22078
22822
|
</dd>
|
|
@@ -22190,7 +22934,15 @@ client.planmigrations.create_migration(
|
|
|
22190
22934
|
<dl>
|
|
22191
22935
|
<dd>
|
|
22192
22936
|
|
|
22193
|
-
**proration_behavior:** `Schematic::Types::MigrationProrationBehavior`
|
|
22937
|
+
**proration_behavior:** `Schematic::Types::MigrationProrationBehavior` — How Stripe handles the price difference when companies are migrated. With strategy immediate, omitted means create_prorations. With end_of_billing_period only none is accepted and means the same as omitting it: the change lands on the renewal boundary, so there is nothing to prorate. With scheduled any value is accepted and omitted means none.
|
|
22938
|
+
|
|
22939
|
+
</dd>
|
|
22940
|
+
</dl>
|
|
22941
|
+
|
|
22942
|
+
<dl>
|
|
22943
|
+
<dd>
|
|
22944
|
+
|
|
22945
|
+
**scheduled_at:** `String` — When every company moves, for strategy scheduled. Must be in the future; the migration runs within about a minute of this time. Not accepted with other strategies.
|
|
22194
22946
|
|
|
22195
22947
|
</dd>
|
|
22196
22948
|
</dl>
|
|
@@ -22452,6 +23204,7 @@ client.planmigrations.retry_migration(
|
|
|
22452
23204
|
```ruby
|
|
22453
23205
|
client.planmigrations.count_migrations(
|
|
22454
23206
|
feature_id: "feature_id",
|
|
23207
|
+
feature_plan_rollout_id: "feature_plan_rollout_id",
|
|
22455
23208
|
plan_version_id: "plan_version_id",
|
|
22456
23209
|
status: "cancelled",
|
|
22457
23210
|
limit: 1000000,
|
|
@@ -22479,6 +23232,14 @@ client.planmigrations.count_migrations(
|
|
|
22479
23232
|
<dl>
|
|
22480
23233
|
<dd>
|
|
22481
23234
|
|
|
23235
|
+
**feature_plan_rollout_id:** `String`
|
|
23236
|
+
|
|
23237
|
+
</dd>
|
|
23238
|
+
</dl>
|
|
23239
|
+
|
|
23240
|
+
<dl>
|
|
23241
|
+
<dd>
|
|
23242
|
+
|
|
22482
23243
|
**plan_version_id:** `String`
|
|
22483
23244
|
|
|
22484
23245
|
</dd>
|