> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.solvimon.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.solvimon.com/_mcp/server. # Search product items. POST https://test.api.solvimon.com/v{version}/product-items/search Content-Type: application/json Requires the PRODUCT_ITEM.VIEW permission. Reference: https://docs.solvimon.com/api-docs/configuration-api/product-items/post-product-items-search ## Authentication - `X-API-KEY` header (required) — API Key authentication via header - `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer `, where token is your auth token. ## Servers - `https://test.api.solvimon.com` (The TEST environment for our API, default) - `https://api.solvimon.com` (The live environment for our API) ## Request ### Path parameters - `version` (string, required, default: 1) — version ### Query parameters - `expand[]` (list of string, optional) — The id fields of the resources that are going to be expanded. - `limit` (integer, optional) — The amount of records shown in the list - `page` (integer, optional) — The page which is going to be shown - `order_by` (string, optional) — The parameter by which the response is ordered. default = name - `order_direction` (string, optional) — The parameter for the response ordering direction (asc, desc) default asc ### Headers - `x-platform-id` (string, optional) — Platform ID. ### Body (application/json) This endpoint expects a SearchCreateRequest. - `search_fields` (list of SearchFieldCreateRequest, optional) - `filter_fields` (list of FilterFieldCreateRequest, optional) - `selection_rule_fields` (list of SelectionRuleFieldCreateRequest, optional) ## Response ### 200 OK - `data` (list of ProductItem, required) - `links` (PaginationLinks, required) - `limit` (integer, optional, nullable) - `page` (integer, optional, nullable) - `total_number_of_pages` (integer, optional, nullable, deprecated) ## Errors ### 400 Bad Request Error Bad Request - `type` (enum, required) - Allowed values: `API_ERROR`, `INVALID_REQUEST` - `code` (enum, required) - Allowed values: `RESOURCE_NOT_FOUND`, `RESOURCES_NOT_FOUND`, `UNABLE_TO_PROCESS_INSTRUCTIONS`, `BAD_REQUEST`, `UNSUPPORTED_MEDIA_TYPE`, `RESOURCE_ALREADY_EXISTS`, `CUSTOM_FIELD_VALUE_ALREADY_EXISTS`, `COULD_NOT_CREATE_RESOURCE`, `COULD_NOT_UPDATE_RESOURCE`, `COULD_NOT_DELETE_RESOURCE`, `MISSING_VERSION`, `UNSUPPORTED_VERSION`, `UNAUTHORISED`, `PORTAL_URL_EXPIRED`, `PORTAL_URL_REVOKED`, `CHECKOUT_SESSION_CLOSED`, `CUSTOMER_NOT_FOUND`, `PLATFORM_NOT_FOUND`, `PRICING_PLAN_NOT_FOUND`, `PRODUCT_NOT_FOUND`, `PRODUCT_ITEM_NOT_FOUND`, `PRICING_NOT_FOUND`, `PRICING_ITEM_NOT_FOUND`, `USER_NOT_FOUND`, `METER_NOT_FOUND`, `METER_VALUE_NOT_FOUND`, `METER_PROPERTY_NOT_FOUND`, `PRICING_ITEM_SUMMARIES_NOT_FOUND`, `MISSING_ID`, `INVALID_ID`, `MISSING_REFERENCE`, `MISSING_FIELD`, `INVALID_FIELD`, `INVALID_OPERATION`, `INTERNAL_ERROR`, `USER_NOT_ALLOWED`, `IDEMPOTENCY_CHECK_FAILED`, `INVALID_REQUEST` - `message` (string, required) - `field` (string, optional, nullable) - `resource_id` (string, optional, nullable) - `resource_type` (enum, optional, nullable) - Allowed values: `CUSTOMER`, `CUSTOM_FIELD`, `PLATFORM`, `PLATFORM_UPTODATE`, `METER`, `METER_VALUE`, `METER_PROPERTY`, `METER_PROPERTY_VARIABLE`, `METER_VALUE_CALCULATION`, `INGEST_DATA`, `METER_DATA`, `CHARGE_DATA`, `PERSIST_DATA`, `ADJUSTMENT_DATA`, `PRODUCT_CATEGORY`, `PRODUCT`, `PRODUCT_ITEM`, `PRICING`, `PRICING_GROUP`, `PRICING_ITEM`, `PRICING_ITEM_CONFIG`, `PRICING_PLAN_SUBSCRIPTION`, `PRICING_PLAN_SUBSCRIPTION_GROUP`, `PRICING_PLAN_SCHEDULE`, `SEAT_ASSIGNMENT`, `SHIPPING_ADDRESS`, `PRICING_PLAN`, `PRICING_PLAN_VERSION`, `PRICING_PLAN_GROUP`, `QUOTE`, `QUOTE_VERSION`, `QUOTE_TEMPLATE`, `QUOTE_VERSION_SUMMARY`, `API_KEY`, `USER`, `ROLE`, `PROXY_USER`, `EXTERNAL_CREDENTIALS`, `TOKEN`, `INVOICE`, `E_INVOICE`, `PDF`, `BILLING_ENTITY`, `FEATURE`, `MEMBERSHIP`, `PAYMENT`, `PAYMENT_ACCEPTOR`, `PAYMENT_METHOD`, `PAYMENT_METHOD_OPTIONS`, `PAYMENT_SCHEDULE`, `PAYMENT_REQUEST`, `INTEGRATION`, `WEBHOOK`, `WEBHOOK_EVENT`, `FILE`, `FILE_PROCESSING_SETTINGS`, `TEAM`, `DOWNLOAD_URL`, `CSV_REPORT`, `REPORT`, `REPORT_GENERATE_REQUEST`, `REPORT_CONFIGURATION`, `REPORT_SUBSCRIPTION`, `REPORT_DEFINITION`, `ACCOUNT_GROUP`, `ENTITY`, `EVENT_TRACE`, `EVENT_TRACE_LINK`, `PRICING_CATEGORY`, `CONTACT`, `ALERT_RULE`, `ALERT`, `USAGE_LIMIT`, `AUDIT_RECORD`, `PORTAL_URL`, `AUTHENTICATION_PROVIDER`, `REPROCESS`, `APPROVAL_POLICY`, `APPROVAL_REQUEST`, `BULK_ACTION`, `COUPON`, `PROMOTION_CODE`, `WALLET`, `WALLET_TYPE`, `WALLET_GRANT`, `AUTO_TOPUP_CONFIG`, `WORKFLOW`, `WORKFLOW_TRIGGER`, `WORKFLOW_ACTION`, `WORKFLOW_ACTION_EXECUTION`, `CREDIT_TYPE`, `SIGNATURE_REQUEST`, `ATTACHMENT`, `DOCUMENT`, `EXCHANGE_RATE` ### 401 Unauthorized Error Unauthorized - `type` (enum, required) - Allowed values: `API_ERROR`, `INVALID_REQUEST` - `code` (enum, required) - Allowed values: `RESOURCE_NOT_FOUND`, `RESOURCES_NOT_FOUND`, `UNABLE_TO_PROCESS_INSTRUCTIONS`, `BAD_REQUEST`, `UNSUPPORTED_MEDIA_TYPE`, `RESOURCE_ALREADY_EXISTS`, `CUSTOM_FIELD_VALUE_ALREADY_EXISTS`, `COULD_NOT_CREATE_RESOURCE`, `COULD_NOT_UPDATE_RESOURCE`, `COULD_NOT_DELETE_RESOURCE`, `MISSING_VERSION`, `UNSUPPORTED_VERSION`, `UNAUTHORISED`, `PORTAL_URL_EXPIRED`, `PORTAL_URL_REVOKED`, `CHECKOUT_SESSION_CLOSED`, `CUSTOMER_NOT_FOUND`, `PLATFORM_NOT_FOUND`, `PRICING_PLAN_NOT_FOUND`, `PRODUCT_NOT_FOUND`, `PRODUCT_ITEM_NOT_FOUND`, `PRICING_NOT_FOUND`, `PRICING_ITEM_NOT_FOUND`, `USER_NOT_FOUND`, `METER_NOT_FOUND`, `METER_VALUE_NOT_FOUND`, `METER_PROPERTY_NOT_FOUND`, `PRICING_ITEM_SUMMARIES_NOT_FOUND`, `MISSING_ID`, `INVALID_ID`, `MISSING_REFERENCE`, `MISSING_FIELD`, `INVALID_FIELD`, `INVALID_OPERATION`, `INTERNAL_ERROR`, `USER_NOT_ALLOWED`, `IDEMPOTENCY_CHECK_FAILED`, `INVALID_REQUEST` - `message` (string, required) - `field` (string, optional, nullable) - `resource_id` (string, optional, nullable) - `resource_type` (enum, optional, nullable) - Allowed values: `CUSTOMER`, `CUSTOM_FIELD`, `PLATFORM`, `PLATFORM_UPTODATE`, `METER`, `METER_VALUE`, `METER_PROPERTY`, `METER_PROPERTY_VARIABLE`, `METER_VALUE_CALCULATION`, `INGEST_DATA`, `METER_DATA`, `CHARGE_DATA`, `PERSIST_DATA`, `ADJUSTMENT_DATA`, `PRODUCT_CATEGORY`, `PRODUCT`, `PRODUCT_ITEM`, `PRICING`, `PRICING_GROUP`, `PRICING_ITEM`, `PRICING_ITEM_CONFIG`, `PRICING_PLAN_SUBSCRIPTION`, `PRICING_PLAN_SUBSCRIPTION_GROUP`, `PRICING_PLAN_SCHEDULE`, `SEAT_ASSIGNMENT`, `SHIPPING_ADDRESS`, `PRICING_PLAN`, `PRICING_PLAN_VERSION`, `PRICING_PLAN_GROUP`, `QUOTE`, `QUOTE_VERSION`, `QUOTE_TEMPLATE`, `QUOTE_VERSION_SUMMARY`, `API_KEY`, `USER`, `ROLE`, `PROXY_USER`, `EXTERNAL_CREDENTIALS`, `TOKEN`, `INVOICE`, `E_INVOICE`, `PDF`, `BILLING_ENTITY`, `FEATURE`, `MEMBERSHIP`, `PAYMENT`, `PAYMENT_ACCEPTOR`, `PAYMENT_METHOD`, `PAYMENT_METHOD_OPTIONS`, `PAYMENT_SCHEDULE`, `PAYMENT_REQUEST`, `INTEGRATION`, `WEBHOOK`, `WEBHOOK_EVENT`, `FILE`, `FILE_PROCESSING_SETTINGS`, `TEAM`, `DOWNLOAD_URL`, `CSV_REPORT`, `REPORT`, `REPORT_GENERATE_REQUEST`, `REPORT_CONFIGURATION`, `REPORT_SUBSCRIPTION`, `REPORT_DEFINITION`, `ACCOUNT_GROUP`, `ENTITY`, `EVENT_TRACE`, `EVENT_TRACE_LINK`, `PRICING_CATEGORY`, `CONTACT`, `ALERT_RULE`, `ALERT`, `USAGE_LIMIT`, `AUDIT_RECORD`, `PORTAL_URL`, `AUTHENTICATION_PROVIDER`, `REPROCESS`, `APPROVAL_POLICY`, `APPROVAL_REQUEST`, `BULK_ACTION`, `COUPON`, `PROMOTION_CODE`, `WALLET`, `WALLET_TYPE`, `WALLET_GRANT`, `AUTO_TOPUP_CONFIG`, `WORKFLOW`, `WORKFLOW_TRIGGER`, `WORKFLOW_ACTION`, `WORKFLOW_ACTION_EXECUTION`, `CREDIT_TYPE`, `SIGNATURE_REQUEST`, `ATTACHMENT`, `DOCUMENT`, `EXCHANGE_RATE` ### 403 Forbidden Error Forbidden - `type` (enum, required) - Allowed values: `API_ERROR`, `INVALID_REQUEST` - `code` (enum, required) - Allowed values: `RESOURCE_NOT_FOUND`, `RESOURCES_NOT_FOUND`, `UNABLE_TO_PROCESS_INSTRUCTIONS`, `BAD_REQUEST`, `UNSUPPORTED_MEDIA_TYPE`, `RESOURCE_ALREADY_EXISTS`, `CUSTOM_FIELD_VALUE_ALREADY_EXISTS`, `COULD_NOT_CREATE_RESOURCE`, `COULD_NOT_UPDATE_RESOURCE`, `COULD_NOT_DELETE_RESOURCE`, `MISSING_VERSION`, `UNSUPPORTED_VERSION`, `UNAUTHORISED`, `PORTAL_URL_EXPIRED`, `PORTAL_URL_REVOKED`, `CHECKOUT_SESSION_CLOSED`, `CUSTOMER_NOT_FOUND`, `PLATFORM_NOT_FOUND`, `PRICING_PLAN_NOT_FOUND`, `PRODUCT_NOT_FOUND`, `PRODUCT_ITEM_NOT_FOUND`, `PRICING_NOT_FOUND`, `PRICING_ITEM_NOT_FOUND`, `USER_NOT_FOUND`, `METER_NOT_FOUND`, `METER_VALUE_NOT_FOUND`, `METER_PROPERTY_NOT_FOUND`, `PRICING_ITEM_SUMMARIES_NOT_FOUND`, `MISSING_ID`, `INVALID_ID`, `MISSING_REFERENCE`, `MISSING_FIELD`, `INVALID_FIELD`, `INVALID_OPERATION`, `INTERNAL_ERROR`, `USER_NOT_ALLOWED`, `IDEMPOTENCY_CHECK_FAILED`, `INVALID_REQUEST` - `message` (string, required) - `field` (string, optional, nullable) - `resource_id` (string, optional, nullable) - `resource_type` (enum, optional, nullable) - Allowed values: `CUSTOMER`, `CUSTOM_FIELD`, `PLATFORM`, `PLATFORM_UPTODATE`, `METER`, `METER_VALUE`, `METER_PROPERTY`, `METER_PROPERTY_VARIABLE`, `METER_VALUE_CALCULATION`, `INGEST_DATA`, `METER_DATA`, `CHARGE_DATA`, `PERSIST_DATA`, `ADJUSTMENT_DATA`, `PRODUCT_CATEGORY`, `PRODUCT`, `PRODUCT_ITEM`, `PRICING`, `PRICING_GROUP`, `PRICING_ITEM`, `PRICING_ITEM_CONFIG`, `PRICING_PLAN_SUBSCRIPTION`, `PRICING_PLAN_SUBSCRIPTION_GROUP`, `PRICING_PLAN_SCHEDULE`, `SEAT_ASSIGNMENT`, `SHIPPING_ADDRESS`, `PRICING_PLAN`, `PRICING_PLAN_VERSION`, `PRICING_PLAN_GROUP`, `QUOTE`, `QUOTE_VERSION`, `QUOTE_TEMPLATE`, `QUOTE_VERSION_SUMMARY`, `API_KEY`, `USER`, `ROLE`, `PROXY_USER`, `EXTERNAL_CREDENTIALS`, `TOKEN`, `INVOICE`, `E_INVOICE`, `PDF`, `BILLING_ENTITY`, `FEATURE`, `MEMBERSHIP`, `PAYMENT`, `PAYMENT_ACCEPTOR`, `PAYMENT_METHOD`, `PAYMENT_METHOD_OPTIONS`, `PAYMENT_SCHEDULE`, `PAYMENT_REQUEST`, `INTEGRATION`, `WEBHOOK`, `WEBHOOK_EVENT`, `FILE`, `FILE_PROCESSING_SETTINGS`, `TEAM`, `DOWNLOAD_URL`, `CSV_REPORT`, `REPORT`, `REPORT_GENERATE_REQUEST`, `REPORT_CONFIGURATION`, `REPORT_SUBSCRIPTION`, `REPORT_DEFINITION`, `ACCOUNT_GROUP`, `ENTITY`, `EVENT_TRACE`, `EVENT_TRACE_LINK`, `PRICING_CATEGORY`, `CONTACT`, `ALERT_RULE`, `ALERT`, `USAGE_LIMIT`, `AUDIT_RECORD`, `PORTAL_URL`, `AUTHENTICATION_PROVIDER`, `REPROCESS`, `APPROVAL_POLICY`, `APPROVAL_REQUEST`, `BULK_ACTION`, `COUPON`, `PROMOTION_CODE`, `WALLET`, `WALLET_TYPE`, `WALLET_GRANT`, `AUTO_TOPUP_CONFIG`, `WORKFLOW`, `WORKFLOW_TRIGGER`, `WORKFLOW_ACTION`, `WORKFLOW_ACTION_EXECUTION`, `CREDIT_TYPE`, `SIGNATURE_REQUEST`, `ATTACHMENT`, `DOCUMENT`, `EXCHANGE_RATE` ### 500 Internal Server Error Internal Server Error - `type` (enum, required) - Allowed values: `API_ERROR`, `INVALID_REQUEST` - `code` (enum, required) - Allowed values: `RESOURCE_NOT_FOUND`, `RESOURCES_NOT_FOUND`, `UNABLE_TO_PROCESS_INSTRUCTIONS`, `BAD_REQUEST`, `UNSUPPORTED_MEDIA_TYPE`, `RESOURCE_ALREADY_EXISTS`, `CUSTOM_FIELD_VALUE_ALREADY_EXISTS`, `COULD_NOT_CREATE_RESOURCE`, `COULD_NOT_UPDATE_RESOURCE`, `COULD_NOT_DELETE_RESOURCE`, `MISSING_VERSION`, `UNSUPPORTED_VERSION`, `UNAUTHORISED`, `PORTAL_URL_EXPIRED`, `PORTAL_URL_REVOKED`, `CHECKOUT_SESSION_CLOSED`, `CUSTOMER_NOT_FOUND`, `PLATFORM_NOT_FOUND`, `PRICING_PLAN_NOT_FOUND`, `PRODUCT_NOT_FOUND`, `PRODUCT_ITEM_NOT_FOUND`, `PRICING_NOT_FOUND`, `PRICING_ITEM_NOT_FOUND`, `USER_NOT_FOUND`, `METER_NOT_FOUND`, `METER_VALUE_NOT_FOUND`, `METER_PROPERTY_NOT_FOUND`, `PRICING_ITEM_SUMMARIES_NOT_FOUND`, `MISSING_ID`, `INVALID_ID`, `MISSING_REFERENCE`, `MISSING_FIELD`, `INVALID_FIELD`, `INVALID_OPERATION`, `INTERNAL_ERROR`, `USER_NOT_ALLOWED`, `IDEMPOTENCY_CHECK_FAILED`, `INVALID_REQUEST` - `message` (string, required) - `field` (string, optional, nullable) - `resource_id` (string, optional, nullable) - `resource_type` (enum, optional, nullable) - Allowed values: `CUSTOMER`, `CUSTOM_FIELD`, `PLATFORM`, `PLATFORM_UPTODATE`, `METER`, `METER_VALUE`, `METER_PROPERTY`, `METER_PROPERTY_VARIABLE`, `METER_VALUE_CALCULATION`, `INGEST_DATA`, `METER_DATA`, `CHARGE_DATA`, `PERSIST_DATA`, `ADJUSTMENT_DATA`, `PRODUCT_CATEGORY`, `PRODUCT`, `PRODUCT_ITEM`, `PRICING`, `PRICING_GROUP`, `PRICING_ITEM`, `PRICING_ITEM_CONFIG`, `PRICING_PLAN_SUBSCRIPTION`, `PRICING_PLAN_SUBSCRIPTION_GROUP`, `PRICING_PLAN_SCHEDULE`, `SEAT_ASSIGNMENT`, `SHIPPING_ADDRESS`, `PRICING_PLAN`, `PRICING_PLAN_VERSION`, `PRICING_PLAN_GROUP`, `QUOTE`, `QUOTE_VERSION`, `QUOTE_TEMPLATE`, `QUOTE_VERSION_SUMMARY`, `API_KEY`, `USER`, `ROLE`, `PROXY_USER`, `EXTERNAL_CREDENTIALS`, `TOKEN`, `INVOICE`, `E_INVOICE`, `PDF`, `BILLING_ENTITY`, `FEATURE`, `MEMBERSHIP`, `PAYMENT`, `PAYMENT_ACCEPTOR`, `PAYMENT_METHOD`, `PAYMENT_METHOD_OPTIONS`, `PAYMENT_SCHEDULE`, `PAYMENT_REQUEST`, `INTEGRATION`, `WEBHOOK`, `WEBHOOK_EVENT`, `FILE`, `FILE_PROCESSING_SETTINGS`, `TEAM`, `DOWNLOAD_URL`, `CSV_REPORT`, `REPORT`, `REPORT_GENERATE_REQUEST`, `REPORT_CONFIGURATION`, `REPORT_SUBSCRIPTION`, `REPORT_DEFINITION`, `ACCOUNT_GROUP`, `ENTITY`, `EVENT_TRACE`, `EVENT_TRACE_LINK`, `PRICING_CATEGORY`, `CONTACT`, `ALERT_RULE`, `ALERT`, `USAGE_LIMIT`, `AUDIT_RECORD`, `PORTAL_URL`, `AUTHENTICATION_PROVIDER`, `REPROCESS`, `APPROVAL_POLICY`, `APPROVAL_REQUEST`, `BULK_ACTION`, `COUPON`, `PROMOTION_CODE`, `WALLET`, `WALLET_TYPE`, `WALLET_GRANT`, `AUTO_TOPUP_CONFIG`, `WORKFLOW`, `WORKFLOW_TRIGGER`, `WORKFLOW_ACTION`, `WORKFLOW_ACTION_EXECUTION`, `CREDIT_TYPE`, `SIGNATURE_REQUEST`, `ATTACHMENT`, `DOCUMENT`, `EXCHANGE_RATE` ## Types ### SearchFieldCreateRequest - `name` (string, optional, nullable) - `value` (string, optional) - `wildcard_start` (boolean, optional) - `wildcard_end` (boolean, optional) - `ignore_case` (boolean, optional) ### FilterFieldCreateRequest - `name` (string, optional) - `reference` (string, optional, nullable) - `value` (string, optional, nullable) - `values` (list of string, optional) ### SelectionRuleFieldCreateRequest - `name` (string, optional) - `value` (string, optional, nullable) ### ProductItem - `object_type` (string, optional, nullable) - `id` (string, optional, nullable) - `product_id` (string, optional, nullable) — The resource ID of the product, that belongs to the product item. - `product` (Product, optional, nullable) - `name` (string, optional, nullable) - `status` (enum, optional, nullable) - Allowed values: `DRAFT`, `ACTIVE`, `ARCHIVED`, `DEPRECATED` - `reference` (string, optional) - `description` (string, optional, nullable) - `type` (enum, optional, nullable) — The type of the product item. - Allowed values: `REVENUE`, `DEDUCTION` - `model_type` (enum, optional, nullable) - Allowed values: `USAGE_BASED`, `USAGE_BASED_CONVERSION`, `RECURRING`, `ONE_OFF`, `PER_SEAT`, `CREDITS` - `usage_based` (ProductItemUsageBased, optional) — Additional settings in case of a USAGE_BASED type. - `credits` (ProductItemCredits, optional) — Additional settings in case of a CREDITS type. - `meter_value_calculation` (MeterValueCalculation, optional, nullable) - `tax_category` (enum, optional, nullable) — The default tax category applied to the product item. - Allowed values: `STANDARD`, `NO_TAX`, `EXEMPT` - `display_order` (integer, optional, nullable) - `unit_name` (UnitName, optional) - `custom_fields` (list of CustomFieldValue, optional, nullable) — Custom fields associated to this product item - `customer_id` (string, optional, nullable) - `agent_context` (AgentContext, optional) — Context for AI agents about this product item. Intended for agents, not for customer-facing output. - `meter_value_calculation_id` (string, optional, nullable, deprecated) — The linked meter value calculation, in case of a USAGE_BASED charge type. - `report_meter_value_calculation_ids` (list of string, optional, nullable, deprecated) — Optional reporting meter value calculations, in case of a USAGE_BASED charge type. ### PaginationLinks - `first` (string, optional, nullable) - `previous` (string, optional, nullable) - `current` (string, optional, nullable) - `next` (string, optional, nullable) ### Product - `object_type` (string, optional, nullable) - `id` (string, optional, nullable) - `category_id` (string, optional) — The resource ID of the product category, that belongs to the product. - `category` (ProductCategory, optional, nullable) - `parent_product_id` (string, optional, nullable) — The resource ID of the original product, to which the product will belong to. - `name` (string, optional) - `reference` (string, optional) - `description` (string, optional, nullable) - `status` (enum, optional, nullable) — The status of the product. - Allowed values: `DRAFT`, `ACTIVE`, `ARCHIVED`, `DEPRECATED` - `product_type` (enum, optional) - Allowed values: `DEFAULT`, `ADDON` - `tax_category` (enum, optional, nullable) — The default tax category applied to the product. - Allowed values: `STANDARD`, `NO_TAX`, `EXEMPT` - `features` (list of FeatureResourceReference, optional, nullable) — The features associated with the product. - `custom_fields` (list of CustomFieldValue, optional, nullable) - `display_order` (integer, optional, nullable) — Determines the order in which products are displayed on overview pages and invoices. The lowest number gets the highest priority. - `linked_integrations` (list of LinkedIntegration, optional, nullable) - `billing_entity_id` (string, optional, nullable) — The resource ID of the billing entity linked to this product. - `customer_id` (string, optional, nullable) - `agent_context` (AgentContext, optional) — Context for AI agents about this product. Intended for agents, not for customer-facing output. ### ProductItemUsageBased - `meter_value_calculation_id` (string, optional, nullable) — The linked meter value calculation - `meter_value_calculation` (MeterValueCalculation, optional, nullable) - `tiering_meter_value_calculation_id` (string, optional, nullable) — The optional alternative linked meter value calculation for tiering - `tiering_meter_value_calculation` (MeterValueCalculation, optional, nullable) - `report_meter_value_calculation_ids` (list of string, optional, nullable) — Optional reporting meter value calculations. - `conditions` (MeterConditions, optional) — Optional conditions. ### ProductItemCredits - `credit_type_id` (string, optional, nullable) — The linked meter value calculation - `credit_type` (CreditType, optional, nullable) ### MeterValueCalculation - `object_type` (string, optional, nullable) - `id` (string, optional, nullable) - `reference` (string, optional) - `name` (string, optional, nullable) - `description` (string, optional, nullable) - `calculation_type` (enum, optional, nullable) — The type of calculation used for this billable metric. - Allowed values: `SUM`, `MAX`, `MIN`, `AVERAGE`, `UNIQUE` - `persist` (boolean, optional, nullable) — Indicate if the data of the billable metric must be persisted to the next billing period of the schedule (default is false). - `meter_id` (string, optional, nullable) — The ID of the meter. - `meter` (Meter, optional, nullable) - `meter_value_id` (string, optional, nullable) — The ID of the meter value. - `meter_value` (MeterValue, optional, nullable) - `meter_property_id` (string, optional, nullable) — The ID of the meter property. - `meter_property` (MeterProperty, optional, nullable) ### UnitName - `singular` (string, optional) - `plural` (string, optional, nullable) ### CustomFieldValue - `id` (string, optional, nullable) — Resource ID of type CUSTOM_FIELD - `reference` (string, optional, nullable) - `value` (string, optional, nullable) - `values` (list of string, optional, nullable) - `integration_details` (IntegrationDetails, optional, nullable) - `integration_id` (string, optional) — The resource ID of the integration linked to the custom field ### AgentContext - `guidance` (string, optional, nullable) — Free-text guidance for AI agents on how to interpret and use this resource. ### ProductCategory - `object_type` (string, optional, nullable) - `id` (string, optional, nullable) - `name` (string, optional) - `reference` (string, optional) - `description` (string, optional, nullable) - `tax_category` (enum, optional, nullable) — The default tax category applied to the products in the product category. - Allowed values: `STANDARD`, `NO_TAX`, `EXEMPT` - `display_order` (integer, optional, nullable) - `customer_id` (string, optional, nullable) — Resource ID of type CUSTOMER ### FeatureResourceReference - `id` (string, optional, nullable) — The ID of the feature. - `reference` (string, optional) — The reference of the feature. ### LinkedIntegration - `id` (string, optional) - `link_details` (list of LinkDetail, optional) ### MeterConditions - `name` (string, optional, nullable) - `expression` (MeterConditionExpression, optional) - `meter_properties` (list of MeterPropertyCondition, optional, nullable, deprecated) ### CreditType - `object_type` (string, optional, nullable) - `id` (string, optional, nullable) - `reference` (string, optional) - `status` (enum, optional, nullable) - Allowed values: `DRAFT`, `ACTIVE`, `INACTIVE`, `DEPRECATED`, `ARCHIVED` - `name` (string, optional) - `description` (string, optional, nullable) - `unit_name` (UnitName, optional) - `created_at` (string, optional, nullable) - `updated_at` (string, optional, nullable) ### Meter - `object_type` (string, optional, nullable) - `id` (string, optional, nullable) - `reference` (string, optional) - `name` (string, optional, nullable) - `description` (string, optional, nullable) - `status` (enum, optional, nullable) — The status of the meter indicating the activity of the meter and the ability to update properties. - Allowed values: `DRAFT`, `ACTIVE`, `ARCHIVED`, `DEPRECATED` - `meter_values` (list of MeterMeterValue, optional, nullable) — The values used as input to calculate billable units, used in the meter. - `meter_properties` (list of MeterMeterProperty, optional, nullable) — The properties that provide information to give context to an event, used in the meter. ### MeterValue - `object_type` (string, optional, nullable) - `id` (string, optional, nullable) - `reference` (string, optional) - `name` (string, optional, nullable) - `description` (string, optional, nullable) - `status` (enum, optional, nullable) — The status of the meter value indicating the activity and the ability to update properties. - Allowed values: `DRAFT`, `ACTIVE`, `ARCHIVED`, `DEPRECATED` - `type` (enum, optional, nullable) — The type of the meter value. - Allowed values: `NUMBER`, `AMOUNT` ### MeterProperty - `object_type` (string, optional, nullable) - `id` (string, optional, nullable) - `reference` (string, optional) - `name` (string, optional, nullable) - `description` (string, optional, nullable) - `status` (enum, optional) — The status of the meter property indicating the activity and the ability to update properties. - Allowed values: `DRAFT`, `ACTIVE`, `ARCHIVED`, `DEPRECATED` - `type` (enum, optional, nullable) — The type of the meter property. - Allowed values: `NUMBER`, `ENUM`, `STRING` - `enum_values` (list of string, optional, nullable) — The list of available ENUM values. ### IntegrationDetails - `id` (string, optional, nullable) - `reference` (string, optional, nullable) - `payment_gateway_variant` (enum, optional) - Allowed values: `ADYEN`, `STRIPE` - `adyen` (AdyenIntegrationDetails, optional) - `stripe` (StripeIntegrationDetails, optional) ### LinkDetail - `url` (string, optional, nullable) - `custom_field_name` (string, optional, nullable) ### MeterConditionExpression - `operator` (enum, optional) - Allowed values: `AND`, `OR`, `XOR` - `operands` (list of MeterConditionOperand, optional, nullable) ### MeterPropertyCondition - `id` (string, optional, nullable) — Resource ID of type METER_PROPERTY - `reference` (string, optional, nullable) - `meter_property` (MeterProperty, optional, nullable) - `value` (string, optional, nullable) - `values` (list of string, optional, nullable) - `meter_property_variable_id` (string, optional, nullable) — Resource ID of type METER_PROPERTY_VARIABLE - `meter_property_variable` (MeterPropertyVariable, optional, nullable) - `comparator` (enum, optional) - Allowed values: `EQUALS`, `NOT_EQUALS`, `IN`, `NOT_IN`, `GREATER_THAN`, `GREATER_THAN_OR_EQUALS`, `LESS_THAN`, `LESS_THAN_OR_EQUALS`, `EMPTY`, `NOT_EMPTY`, `CONTAINS`, `NOT_CONTAINS` ### MeterMeterValue - `id` (string, optional, nullable) — Resource ID of type METER_VALUE - `object` (MeterValue, optional, nullable) - `reference` (string, optional, nullable) - `required` (boolean, optional, nullable) ### MeterMeterProperty - `id` (string, optional, nullable) — Resource ID of type METER_PROPERTY - `object` (MeterProperty, optional, nullable) - `reference` (string, optional, nullable) - `required` (boolean, optional, nullable) ### AdyenIntegrationDetails - `recurring_detail_reference` (string, optional) ### StripeIntegrationDetails - `payment_method_id` (string, optional) ### MeterConditionOperand - `meter_property` (MeterPropertyCondition, optional) - `expression` (MeterConditionOperandExpression, optional, nullable) ### MeterPropertyVariable - `object_type` (string, optional, nullable) - `id` (string, optional, nullable) - `reference` (string, optional) - `name` (string, optional, nullable) - `description` (string, optional, nullable) - `meter_property_id` (string, optional, nullable) — The meter property whose values this variable lists. Set on create only. - `meter_property_reference` (string, optional, nullable) — Alternative to meter_property_id on create. - `type` (enum, optional, nullable) - Allowed values: `LIST` - `status` (enum, optional, nullable) - Allowed values: `DRAFT`, `ACTIVE`, `ARCHIVED`, `DEPRECATED` - `values` (list of string, optional, nullable) — The initial values, on create only. Edit them afterwards through the values endpoint. - `value_count` (integer, optional, nullable) - `created_at` (string, optional, nullable) - `updated_at` (string, optional, nullable) ### MeterConditionOperandExpression ## Examples **Request** ```json { "search_fields": [ { "name": "name", "value": "tokens", "wildcard_start": true, "wildcard_end": true, "ignore_case": true } ], "filter_fields": [ { "name": "product_id", "value": "prod_nwDeeN0vxxHxTtCv0Z1E" }, { "name": "status", "value": "ACTIVE" }, { "name": "model_type", "value": "USAGE_BASED" } ] } ``` **Response** ```json { "data": [ { "object_type": "string", "id": "string", "product_id": "string", "product": { "object_type": "string", "id": "string", "category_id": "string", "category": { "object_type": "string", "id": "string", "name": "string", "reference": "string", "description": "string", "tax_category": "STANDARD", "display_order": 1, "customer_id": "string" }, "parent_product_id": "string", "name": "string", "reference": "string", "description": "string", "status": "DRAFT", "product_type": "DEFAULT", "tax_category": "STANDARD", "features": [ { "id": "string", "reference": "string" } ], "custom_fields": [ { "id": "string", "reference": "string", "value": "string", "values": [ "string" ], "integration_details": { "id": "string", "reference": "string", "payment_gateway_variant": "ADYEN", "adyen": { "recurring_detail_reference": "string" }, "stripe": { "payment_method_id": "string" } }, "integration_id": "string" } ], "display_order": 1, "linked_integrations": [ { "id": "string", "link_details": [ { "url": "string", "custom_field_name": "string" } ] } ], "billing_entity_id": "string", "customer_id": "string", "agent_context": { "guidance": "string" } }, "name": "string", "status": "DRAFT", "reference": "string", "description": "string", "type": "REVENUE", "model_type": "USAGE_BASED", "usage_based": { "meter_value_calculation_id": "string", "meter_value_calculation": { "object_type": "string", "id": "string", "reference": "string", "name": "string", "description": "string", "calculation_type": "SUM", "persist": true, "meter_id": "string", "meter": { "object_type": "string", "id": "string", "reference": "string", "name": "string", "description": "string", "status": "DRAFT", "meter_values": [ { "id": "string", "object": { "object_type": "string", "id": "string", "reference": "string", "name": "string", "description": "string", "status": "DRAFT", "type": "NUMBER" }, "required": true } ], "meter_properties": [ { "id": "string", "object": { "object_type": "string", "id": "string", "reference": "string", "name": "string", "description": "string", "status": "DRAFT", "type": "NUMBER", "enum_values": [ "string" ] }, "required": true } ] }, "meter_value_id": "string", "meter_value": { "object_type": "string", "id": "string", "reference": "string", "name": "string", "description": "string", "status": "DRAFT", "type": "NUMBER" }, "meter_property_id": "string", "meter_property": { "object_type": "string", "id": "string", "reference": "string", "name": "string", "description": "string", "status": "DRAFT", "type": "NUMBER", "enum_values": [ "string" ] } }, "tiering_meter_value_calculation_id": "string", "tiering_meter_value_calculation": { "object_type": "string", "id": "string", "reference": "string", "name": "string", "description": "string", "calculation_type": "SUM", "persist": true, "meter_id": "string", "meter": { "object_type": "string", "id": "string", "reference": "string", "name": "string", "description": "string", "status": "DRAFT", "meter_values": [ { "id": "string", "object": { "object_type": "string", "id": "string", "reference": "string", "name": "string", "description": "string", "status": "DRAFT", "type": "NUMBER" }, "required": true } ], "meter_properties": [ { "id": "string", "object": { "object_type": "string", "id": "string", "reference": "string", "name": "string", "description": "string", "status": "DRAFT", "type": "NUMBER", "enum_values": [ "string" ] }, "required": true } ] }, "meter_value_id": "string", "meter_value": { "object_type": "string", "id": "string", "reference": "string", "name": "string", "description": "string", "status": "DRAFT", "type": "NUMBER" }, "meter_property_id": "string", "meter_property": { "object_type": "string", "id": "string", "reference": "string", "name": "string", "description": "string", "status": "DRAFT", "type": "NUMBER", "enum_values": [ "string" ] } }, "report_meter_value_calculation_ids": [ "string" ], "conditions": { "name": "string", "expression": { "operator": "AND", "operands": [ { "meter_property": { "id": "string", "reference": "string", "meter_property": { "object_type": "string", "id": "string", "reference": "string", "name": "string", "description": "string", "status": "DRAFT", "type": "NUMBER", "enum_values": [ "string" ] }, "value": "string", "values": [ "string" ], "meter_property_variable_id": "string", "meter_property_variable": { "object_type": "string", "id": "string", "reference": "string", "name": "string", "description": "string", "meter_property_id": "string", "type": "LIST", "status": "DRAFT", "value_count": 1, "created_at": "string", "updated_at": "string" }, "comparator": "EQUALS" }, "expression": {} } ] }, "meter_properties": [ { "id": "string", "reference": "string", "meter_property": { "object_type": "string", "id": "string", "reference": "string", "name": "string", "description": "string", "status": "DRAFT", "type": "NUMBER", "enum_values": [ "string" ] }, "value": "string", "values": [ "string" ], "meter_property_variable_id": "string", "meter_property_variable": { "object_type": "string", "id": "string", "reference": "string", "name": "string", "description": "string", "meter_property_id": "string", "type": "LIST", "status": "DRAFT", "value_count": 1, "created_at": "string", "updated_at": "string" }, "comparator": "EQUALS" } ] } }, "credits": { "credit_type_id": "string", "credit_type": { "object_type": "string", "id": "string", "reference": "string", "status": "DRAFT", "name": "string", "description": "string", "unit_name": { "singular": "string", "plural": "string" }, "created_at": "string", "updated_at": "string" } }, "meter_value_calculation": { "object_type": "string", "id": "string", "reference": "string", "name": "string", "description": "string", "calculation_type": "SUM", "persist": true, "meter_id": "string", "meter": { "object_type": "string", "id": "string", "reference": "string", "name": "string", "description": "string", "status": "DRAFT", "meter_values": [ { "id": "string", "object": { "object_type": "string", "id": "string", "reference": "string", "name": "string", "description": "string", "status": "DRAFT", "type": "NUMBER" }, "required": true } ], "meter_properties": [ { "id": "string", "object": { "object_type": "string", "id": "string", "reference": "string", "name": "string", "description": "string", "status": "DRAFT", "type": "NUMBER", "enum_values": [ "string" ] }, "required": true } ] }, "meter_value_id": "string", "meter_value": { "object_type": "string", "id": "string", "reference": "string", "name": "string", "description": "string", "status": "DRAFT", "type": "NUMBER" }, "meter_property_id": "string", "meter_property": { "object_type": "string", "id": "string", "reference": "string", "name": "string", "description": "string", "status": "DRAFT", "type": "NUMBER", "enum_values": [ "string" ] } }, "tax_category": "STANDARD", "display_order": 1, "unit_name": { "singular": "string", "plural": "string" }, "custom_fields": [ { "id": "string", "reference": "string", "value": "string", "values": [ "string" ], "integration_details": { "id": "string", "reference": "string", "payment_gateway_variant": "ADYEN", "adyen": { "recurring_detail_reference": "string" }, "stripe": { "payment_method_id": "string" } }, "integration_id": "string" } ], "customer_id": "string", "agent_context": { "guidance": "string" }, "meter_value_calculation_id": "string", "report_meter_value_calculation_ids": [ "string" ] } ], "links": { "first": "string", "previous": "string", "current": "string", "next": "string" }, "limit": 1, "page": 1, "total_number_of_pages": 1 } ``` **SDK Code** ```python ProductItems_postProductItemsSearch_example import requests url = "https://test.api.solvimon.com/v1/product-items/search" payload = { "search_fields": [ { "name": "name", "value": "tokens", "wildcard_start": True, "wildcard_end": True, "ignore_case": True } ], "filter_fields": [ { "name": "product_id", "value": "prod_nwDeeN0vxxHxTtCv0Z1E" }, { "name": "status", "value": "ACTIVE" }, { "name": "model_type", "value": "USAGE_BASED" } ] } headers = { "X-API-KEY": "", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript ProductItems_postProductItemsSearch_example const url = 'https://test.api.solvimon.com/v1/product-items/search'; const options = { method: 'POST', headers: {'X-API-KEY': '', 'Content-Type': 'application/json'}, body: '{"search_fields":[{"name":"name","value":"tokens","wildcard_start":true,"wildcard_end":true,"ignore_case":true}],"filter_fields":[{"name":"product_id","value":"prod_nwDeeN0vxxHxTtCv0Z1E"},{"name":"status","value":"ACTIVE"},{"name":"model_type","value":"USAGE_BASED"}]}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go ProductItems_postProductItemsSearch_example package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://test.api.solvimon.com/v1/product-items/search" payload := strings.NewReader("{\n \"search_fields\": [\n {\n \"name\": \"name\",\n \"value\": \"tokens\",\n \"wildcard_start\": true,\n \"wildcard_end\": true,\n \"ignore_case\": true\n }\n ],\n \"filter_fields\": [\n {\n \"name\": \"product_id\",\n \"value\": \"prod_nwDeeN0vxxHxTtCv0Z1E\"\n },\n {\n \"name\": \"status\",\n \"value\": \"ACTIVE\"\n },\n {\n \"name\": \"model_type\",\n \"value\": \"USAGE_BASED\"\n }\n ]\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("X-API-KEY", "") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby ProductItems_postProductItemsSearch_example require 'uri' require 'net/http' url = URI("https://test.api.solvimon.com/v1/product-items/search") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["X-API-KEY"] = '' request["Content-Type"] = 'application/json' request.body = "{\n \"search_fields\": [\n {\n \"name\": \"name\",\n \"value\": \"tokens\",\n \"wildcard_start\": true,\n \"wildcard_end\": true,\n \"ignore_case\": true\n }\n ],\n \"filter_fields\": [\n {\n \"name\": \"product_id\",\n \"value\": \"prod_nwDeeN0vxxHxTtCv0Z1E\"\n },\n {\n \"name\": \"status\",\n \"value\": \"ACTIVE\"\n },\n {\n \"name\": \"model_type\",\n \"value\": \"USAGE_BASED\"\n }\n ]\n}" response = http.request(request) puts response.read_body ``` ```java ProductItems_postProductItemsSearch_example import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://test.api.solvimon.com/v1/product-items/search") .header("X-API-KEY", "") .header("Content-Type", "application/json") .body("{\n \"search_fields\": [\n {\n \"name\": \"name\",\n \"value\": \"tokens\",\n \"wildcard_start\": true,\n \"wildcard_end\": true,\n \"ignore_case\": true\n }\n ],\n \"filter_fields\": [\n {\n \"name\": \"product_id\",\n \"value\": \"prod_nwDeeN0vxxHxTtCv0Z1E\"\n },\n {\n \"name\": \"status\",\n \"value\": \"ACTIVE\"\n },\n {\n \"name\": \"model_type\",\n \"value\": \"USAGE_BASED\"\n }\n ]\n}") .asString(); ``` ```php ProductItems_postProductItemsSearch_example request('POST', 'https://test.api.solvimon.com/v1/product-items/search', [ 'body' => '{ "search_fields": [ { "name": "name", "value": "tokens", "wildcard_start": true, "wildcard_end": true, "ignore_case": true } ], "filter_fields": [ { "name": "product_id", "value": "prod_nwDeeN0vxxHxTtCv0Z1E" }, { "name": "status", "value": "ACTIVE" }, { "name": "model_type", "value": "USAGE_BASED" } ] }', 'headers' => [ 'Content-Type' => 'application/json', 'X-API-KEY' => '', ], ]); echo $response->getBody(); ``` ```csharp ProductItems_postProductItemsSearch_example using RestSharp; var client = new RestClient("https://test.api.solvimon.com/v1/product-items/search"); var request = new RestRequest(Method.POST); request.AddHeader("X-API-KEY", ""); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"search_fields\": [\n {\n \"name\": \"name\",\n \"value\": \"tokens\",\n \"wildcard_start\": true,\n \"wildcard_end\": true,\n \"ignore_case\": true\n }\n ],\n \"filter_fields\": [\n {\n \"name\": \"product_id\",\n \"value\": \"prod_nwDeeN0vxxHxTtCv0Z1E\"\n },\n {\n \"name\": \"status\",\n \"value\": \"ACTIVE\"\n },\n {\n \"name\": \"model_type\",\n \"value\": \"USAGE_BASED\"\n }\n ]\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift ProductItems_postProductItemsSearch_example import Foundation let headers = [ "X-API-KEY": "", "Content-Type": "application/json" ] let parameters = [ "search_fields": [ [ "name": "name", "value": "tokens", "wildcard_start": true, "wildcard_end": true, "ignore_case": true ] ], "filter_fields": [ [ "name": "product_id", "value": "prod_nwDeeN0vxxHxTtCv0Z1E" ], [ "name": "status", "value": "ACTIVE" ], [ "name": "model_type", "value": "USAGE_BASED" ] ] ] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://test.api.solvimon.com/v1/product-items/search")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```