# Get product list By using this method, merchants can find products and retrieve their details by applying filters such as product identifier, status, trial availability, and sorting criteria with pagination support. Endpoint: GET /products Version: 1.0.0 Security: MerchantID ## Header parameters: - `merchant` (string, required) Unique public key provided upon registration and must be shared for identification purposes. Example: "api_pk_7b197...ba108f842" - `signature` (string, required) Request signature that allows verification of merchant authenticity on the payment gateway server. Example: "M2E3OTkyNzcz...xMmExODI4" ## Query parameters: - `filter[id]` (string) Specify the comma-separated ids of products. Example: "ac43b415-5522-4373-b026-a365462f9657,xx33b415-5522-4373-b026-a365462f9657" - `filter[status]` (string) Specify the status of products to retrieve. Use active, disabled, or archived to return products that match the needed status. Enum: "active", "disabled", "archived" - `filter[has_trial]` (boolean) Specify whether the products should have a trial available. Use true to retrieve products with a trial option. - `pagination[limit]` (integer) Specify the number of items to return. Example: 10 - `pagination[offset]` (integer) Specify the number of items to skip before starting to collect the result set. Example: 10 ## Response 200 fields (application/json): - `body` (object) — one of: - Product-based payment: - `data` (array) Contains an array of product data, each representing a specific price configuration. - `data.id` (string, required) Unique product identifier. Example: "cb43b415-5522-4373-b026-a365462f9114" - `data.name` (string, required) Product name. Example: "Luxury product" - `data.type` (string, required) Specifies whether the product is a one-time purchase or a subscription product. Enum: "one-time" - `data.description` (string, required) Product description. Example: "This product is the best product all over the world" - `data.public_description` (string) Product description for customers. Example: "That cool product that you have bought" - `data.status` (string, required) Product status. Cannot be changed if a subscription exists for the product. Enum: same as `filter[status]` (3 values) - `data.created_at` (string, required) Datetime of the product creation. Example: "2025-05-31 12:53:12" - `data.updated_at` (string, required) Datetime of the product update. Example: "2025-05-31 12:53:13" - `data.payment_action` (string, required) Payment processing flow applied to the transaction. Enum: "auth_settle" - `data.settle_interval` (integer) Delay before automatic transaction settlement in hours. If the product has a trial, this field does not affect the first payments but influences recurring ones processed with auth_settle. If there is no trial, this field defines the interval for the first auth_settle payment. Example: 48 - `data.tax` (object) Contains product tax details. - `data.tax.category_id` (string, required) Unique tax category identifier. Example: "taxc_01JJVD231C879QBHVTVCWJ1K2A" - `data.tax.behavior` (string) Defines how taxes are applied to product prices and shown to customers. included or excluded tax behavior takes priority over tax rules configured for locations. Enum: "location_preset", "included", "excluded" - `data.metadata` (object) Metadata for storing additional, structured information about the product, such as access duration, plan tier, or feature flags. Supports up to 50 key-value pairs: Keys can be up to 40 characters (letters, digits, hyphens, and underscores) Values can be up to 500 characters Example: {"access_duration":"30d","plan_tier":"premium"} - `pagination` (object) Contains information about the pagination of the results. - `pagination.offset` (integer, required) Starting index of the returned results. Example: 20 - `pagination.limit` (integer, required) Maximum number of items to return. Example: 10 - `pagination.total_count` (integer, required) Total count of the products available. Example: 150 - Subscription payment: - `data` (array) Contains an array of product data, each representing a specific price configuration. - `data.id` (string, required) Unique product identifier. Example: "cb43b415-5522-4373-b026-a365462f9114" - `data.name` (string, required) Product name. Example: "Luxury product" - `data.type` (string, required) Specifies whether the product is a one-time purchase or a subscription product. Enum: "recurring" - `data.description` (string, required) Product description. Example: "This product is the best product all over the world" - `data.public_description` (string) Product description for customers. Example: "That cool product that you have bought" - `data.status` (string, required) Product status. Cannot be changed if a subscription exists for the product. Enum: same as `filter[status]` (3 values) - `data.created_at` (string, required) Datetime of the product creation. Example: "2025-05-31 12:53:12" - `data.updated_at` (string, required) Datetime of the product update. Example: "2025-05-31 12:53:13" - `data.term_length` (integer) Maximum number of billing cycles before subscription expiration and automatic cancellation with error code 8.08. Cannot be changed if a subscription exists for the product. Example: 20 - `data.payment_action` (string, required) Payment processing flow applied to the transaction. Enum: same as `data.payment_action` in "Product-based payment" (1 values) - `data.settle_interval` (integer) Delay before automatic transaction settlement in hours. If the product has a trial, this field does not affect the first payments but influences recurring ones processed with auth_settle. If there is no trial, this field defines the interval for the first auth_settle payment. Example: 48 - `data.billing_period` (object, required) Billing period in time units. - `data.billing_period.unit` (string, required) Unit of the billing period. Enum: "day", "week", "month", "year" - `data.billing_period.value` (integer, required) Value of the billing period as an integer. Example: 10 - `data.trial` (object) Trial settings. Required if the trial type is free or paid. Must not be sent if the type is absent. Once the product subscription is active, trial settings can be modified, but the trial itself cannot be added or removed. - `data.trial.billing_period` (object, required) Trial billing period in time units. - `data.trial.billing_period.unit` (string, required) Unit of the trial billing period. Enum: same as `data.billing_period.unit` in "Subscription payment" (4 values) - `data.trial.billing_period.value` (integer, required) Value of the trial billing period as an integer. Example: 10 - `data.trial.payment_action` (string, required) Specifies a payment flow applied to the first transaction, with or without the next money return, for: - free trial - the payment actions are auth_0_amount and auth_void, with the last indicating that the funds will be refunded to the customer - paid trial - the payment action is auth_settle, indicating the funds will be deducted from the customer's account as payment for the trial period and transferred to the merchant's account Enum: "auth_0_amount", "auth_void", "auth_settle" - `data.trial.settle_interval` (integer) Delay before automatic transaction settlement in hours used in the auth_settle payment flow. Required if trial payment_action auth_settle and must not be used for other payment_action types. Example: 48 - `data.retry_mode` (string) Retry mode to recover the failed subscription payments. Enum: "smart", "static" - `data.retry_strategy_id` (string) Unique retry strategy identifier. Example: "db43b415-5522-4373-b026-a365462f9439" - `data.tax` (object) Contains product tax details. - `data.tax.category_id` (string, required) Unique tax category identifier. Example: "taxc_01JJVD231C879QBHVTVCWJ1K2A" - `data.tax.behavior` (string) Defines how taxes are applied to product prices and shown to customers. included or excluded tax behavior takes priority over tax rules configured for locations. Enum: same as `data.tax.behavior` in "Product-based payment" (3 values) - `data.metadata` (object) Metadata for storing additional, structured information about the product, such as access duration, plan tier, or feature flags. Supports up to 50 key-value pairs: Keys can be up to 40 characters (letters, digits, hyphens, and underscores) Values can be up to 500 characters Example: {"access_duration":"30d","plan_tier":"premium"} - `pagination` (object) Contains information about the pagination of the results. - `pagination.offset` (integer, required) Starting index of the returned results. Example: 20 - `pagination.limit` (integer, required) Maximum number of items to return. Example: 10 - `pagination.total_count` (integer, required) Total count of the products available. Example: 150 ## Response 400 fields (application/json): - `error` (object, required) Error object. - `error.code` (string, required) Error code. Example: "2.01" - `error.message` (string, required) Error message. Example: "Validation error" - `error.constraints` (object) Map of constraints. ## Response 401 fields (application/json): - `error` (object, required) Error object. - `error.code` (string, required) Error code indicating the specific authorization failure. Example: "1.01" - `error.message` (string, required) Descriptive message providing more details about the authorization failure. Example: "Authorization failed" ## Response 403 fields (application/json): - `error` (object, required) Error object. - `error.code` (string, required) Error code indicating that access to the service is denied. Example: "1.02" - `error.message` (string, required) Message informing that the service is not allowed for the account. Example: "Access denied"