{"id":4754,"date":"2026-10-19T11:36:24","date_gmt":"2026-10-19T08:36:24","guid":{"rendered":"https:\/\/support.withsecure.com\/?page_id=4754"},"modified":"2026-10-19T11:36:24","modified_gmt":"2026-10-19T08:36:24","slug":"commercial-api","status":"publish","type":"page","link":"https:\/\/support.withsecure.com\/en\/changelogs\/products\/commercial-api\/","title":{"rendered":"Commercial API"},"content":{"rendered":"<section\n    class=\"wp-block-support-banner edwp-block wp-block-support-banner--bg-light-gray layout--spacing-xxxl-top layout--spacing-xxxl-bottom\"\n    >\n            <div class=\"wp-block-support-banner__container\">\n        <div class=\"wp-block-support-banner__content-wrapper\">\n                        <div class=\"wp-component-content wp-component-content--default wp-block-support-banner__content\">\n            <h2 class=\"wp-component-heading text--h2 wp-component-content__title\">\n    Changelogs<\/h2>                    <div class=\"wp-component-content__inner\">\n                                    <div class=\"wp-component-content__content wysiwyg\">\n                        <div class=\"wp-component-paragraph \">\n    <h4>Commercial API<\/h4>\n<\/div>\n                    <\/div>\n                                                            <\/div>\n                <\/div>                            <div class=\"wp-block-support-banner__searchbar\">\n                    <div class=\"addsearch-standalone-searchbar-container\" data-addsearch-results-url=\"\/en\/search\"><\/div>\n                <\/div>\n                                <\/div>\n    <\/div>\n<\/section>\n\n\n<section\n    class=\"wp-block-content-list edwp-block layout--spacing-l-top layout--spacing-l-bottom\"\n    >\n    <div class=\"wp-block-content-list__container\">\n        \n        <div class=\"wp-block-content-list__main\">\n                    <ul class=\"wp-block-content-list__list\">\n            <li class=\"wp-block-content-list__item\">\n                            <time class=\"wp-block-content-list__updated\" datetime=\"2026-07-23T00:00:00+00:00\">July 23, 2026<\/time>\n            \n            <a class=\"wp-block-content-list__link\" href=\"https:\/\/support.withsecure.com\/en\/changelogs\/commercial-api-2026-07-23-update\/\">\n                <p class=\"wp-block-content-list__title\">Commercial API 2026-07-23 Update<\/p>\n            <\/a>\n\n            \n                            <details class=\"wp-block-content-list__details\">\n                    <summary class=\"wp-block-content-list__summary\">Read more<\/summary>\n                    <div class=\"wp-component-paragraph wp-block-content-list__body\">\n    <p><strong>We&#8217;ve\u00a0extended\u00a0the\u00a0List\u00a0Subscriptions\u00a0endpoints\u00a0to\u00a0return\u00a0Deal\u00a0Based\u00a0subscriptions\u00a0together\u00a0with\u00a0Total\u00a0Volume\u00a0subscriptions.<\/strong><\/p>\n<p>All endpoints for listing subscriptions and Get subscription by the key now return\u00a0both\u00a0subscription\u00a0types. (Deal Based and Total Volume). This\u00a0means\u00a0the\u00a0Commercial\u00a0API\u00a0allows\u00a0you\u00a0to\u00a0get\u00a0everything\u00a0that\u00a0belongs\u00a0to\u00a0a\u00a0specified\u00a0reseller.<\/p>\n<p>Key\u00a0capabilities:<\/p>\n<ul>\n<li>Retrieve\u00a0Deal\u00a0Based\u00a0and\u00a0Total\u00a0Volume\u00a0subscriptions\u00a0together\u00a0for\u00a0a\u00a0given\u00a0reseller<\/li>\n<\/ul>\n<p><strong>We&#8217;ve\u00a0extended\u00a0the\u00a0documentation\u00a0with\u00a0the\u00a0list\u00a0of\u00a0Deal\u00a0Based\u00a0product\u00a0codes.<\/strong><\/p>\n<p>The documentation now lists the Deal Based product codes that may be returned by the API, in addition to the existing Total Volume codes. We&#8217;ve also introduced a fallback product code,\u00a0<code class=\"code codeInline\" spellcheck=\"false\" tabindex=\"0\">W99999<\/code>, which may be returned for non-commercial products or when a product code cannot be identified from the available data.<\/p>\n<p>For more details, please refer the <a href=\"https:\/\/community.withsecure.com\/home\/leaving?allowTrusted=1&amp;target=https%3A%2F%2Fconnect-ci.fsxt.net%2Fapi-reference%2Fcommercial%2F\" rel=\"nofollow noopener ugc\" target=\"_blank\">Commercial API documentation.<\/a><\/p>\n<\/div>\n                <\/details>\n                    <\/li>\n            <li class=\"wp-block-content-list__item\">\n                            <time class=\"wp-block-content-list__updated\" datetime=\"2026-06-19T00:00:00+00:00\">June 19, 2026<\/time>\n            \n            <a class=\"wp-block-content-list__link\" href=\"https:\/\/support.withsecure.com\/en\/changelogs\/commercial-api-2026-06-19-update\/\">\n                <p class=\"wp-block-content-list__title\">Commercial API 2026-06-19 Update<\/p>\n            <\/a>\n\n            \n                            <details class=\"wp-block-content-list__details\">\n                    <summary class=\"wp-block-content-list__summary\">Read more<\/summary>\n                    <div class=\"wp-component-paragraph wp-block-content-list__body\">\n    <p>We&#8217;ve introduced a new endpoint to update the information of a licensee:<\/p>\n<p><strong>Change Company Information<\/strong><\/p>\n<p><code class=\"code codeInline\" spellcheck=\"false\" tabindex=\"0\">POST \/company?existing_buyer_assigned_account_id={existing_buyer_assigned_account_id}<\/code><\/p>\n<p>This endpoint allows you to update the details of a licensee, including its name, buyer assigned account ID, and legal entity information (VAT number and postal address).<\/p>\n<p><strong>Key capabilities:<\/strong><\/p>\n<ul>\n<li>Update the licensee&#8217;s official name<\/li>\n<li>Update the partner&#8217;s internal reference ID (buyer assigned account ID) for the licensee<\/li>\n<li>Update the licensee&#8217;s legal entity information, including VAT number and postal address<\/li>\n<\/ul>\n<p>For full endpoint details, refer to the\u00a0<a href=\"https:\/\/community.withsecure.com\/home\/leaving?allowTrusted=1&amp;target=https%3A%2F%2Fconnect.withsecure.com%2Fapi-reference%2Fcommercial%2F\" target=\"_blank\" rel=\"nofollow noopener ugc\">API documentation<\/a>.<\/p>\n<\/div>\n                <\/details>\n                    <\/li>\n            <li class=\"wp-block-content-list__item\">\n                            <time class=\"wp-block-content-list__updated\" datetime=\"2026-06-18T00:00:00+00:00\">June 18, 2026<\/time>\n            \n            <a class=\"wp-block-content-list__link\" href=\"https:\/\/support.withsecure.com\/en\/changelogs\/commercial-api-2026-06-18\/\">\n                <p class=\"wp-block-content-list__title\">Commercial API &#8211; 2026-06-18<\/p>\n            <\/a>\n\n            \n                            <details class=\"wp-block-content-list__details\">\n                    <summary class=\"wp-block-content-list__summary\">Read more<\/summary>\n                    <div class=\"wp-component-paragraph wp-block-content-list__body\">\n    <p><strong>We&#8217;ve extended the response of the Get Total Volume Resellers endpoint with additional reseller details:<\/strong><\/p>\n<p>The response now includes new fields for each reseller, giving distributors a richer view of their contracted resellers. In additional to that, Deal Based resellers now returned in the API and can be tracked as well <\/p>\n<p><strong>New fields per reseller:<\/strong><\/p>\n<ul>\n<li><strong>total_volume <\/strong>\u2013 Indicates whether the reseller has an active Total Volume Frame Agreement allowing to work in the Total Volume model<\/li>\n<li><strong>deal_based <\/strong>\u2013 Indicates whether the reseller has active Partner Deal Terms allowing to act in the Deal Based model<\/li>\n<li><strong>partner_portal_enabled <\/strong>\u2013 Indicates whether the reseller is a Partner Portal user<\/li>\n<li><strong>address <\/strong>\u2013 Reseller&#8217;s billing address, including street, city, postal code, state code, and country<\/li>\n<\/ul>\n<p><strong>Important notes:<\/strong><\/p>\n<ul>\n<li><strong>reseller_name <\/strong>and <strong>reseller_account_id <\/strong>remain required fields within each reseller entry<\/li>\n<li>New fields are optional and may not be present for all resellers depends on available data<\/li>\n<\/ul>\n<p>&#13;<br \/>\nFor full response details, refer to the <a href=\"https:\/\/community.withsecure.com\/home\/leaving?allowTrusted=1&amp;target=https%3A%2F%2Fconnect.withsecure.com%2Fapi-reference%2Fcommercial%2F\" rel=\"nofollow noopener ugc\" target=\"_blank\">API documentation<\/a>.<\/p>\n<\/div>\n                <\/details>\n                    <\/li>\n            <li class=\"wp-block-content-list__item\">\n                            <time class=\"wp-block-content-list__updated\" datetime=\"2026-04-13T00:00:00+00:00\">April 13, 2026<\/time>\n            \n            <a class=\"wp-block-content-list__link\" href=\"https:\/\/support.withsecure.com\/en\/changelogs\/commercial-api-2026-04-13\/\">\n                <p class=\"wp-block-content-list__title\">Commercial API &#8211; 2026-04-13<\/p>\n            <\/a>\n\n            \n                            <details class=\"wp-block-content-list__details\">\n                    <summary class=\"wp-block-content-list__summary\">Read more<\/summary>\n                    <div class=\"wp-component-paragraph wp-block-content-list__body\">\n    <p><strong>Updated Documentation: all &#8216;\/subscriptions&#8217; endpoints combined to a single List Subscriptions endpoint with filter parameters<br \/><\/strong><br \/>&#13;<br \/>\nWe\u2019ve updated the documentation presentation for the following Commercial API endpoints to align with OpenAPI 3 specification requirements:<\/p>\n<ul>\n<li>Get subscription by buyer assigned account id<\/li>\n<li>Get subscription by reseller account id<\/li>\n<\/ul>\n<p>Both endpoints share the same base URL but differ only by query parameters. <br \/>\nTo comply with OpenAPI 3 YAML standards, they are now documented as a single endpoint: <br \/><strong>List Subscriptions.<\/strong><\/p>\n<p><strong>What changed:<\/strong><\/p>\n<ul>\n<li>The above endpoints are now combined under List Subscriptions in the documentation<\/li>\n<li>Query parameters (buyer_assigned_account_id, reseller_account_id) are available as filters within the same endpoint<\/li>\n<li>Documentation structure updated to meet OpenAPI 3 requirements and improve compatibility with API tools<\/li>\n<\/ul>\n<p><strong>What did NOT change:<\/strong><\/p>\n<ul>\n<li>No changes to endpoint logic or behavior<\/li>\n<li>No changes to request\/response formats<\/li>\n<li>Existing integrations using:\n<ul>\n<li>GET \/subscriptions?buyer_assigned_account_id={buyer_assigned_account_id}<\/li>\n<li>GET \/subscriptions?reseller_account_id={reseller_account_id}<br \/>&#13;<br \/>\ncontinue to work exactly as before<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<p><strong>This update is documentation-only and ensures consistent representation of the API without impacting functionality.<\/strong><\/p>\n<\/div>\n                <\/details>\n                    <\/li>\n            <li class=\"wp-block-content-list__item\">\n                            <time class=\"wp-block-content-list__updated\" datetime=\"2026-03-24T00:00:00+00:00\">March 24, 2026<\/time>\n            \n            <a class=\"wp-block-content-list__link\" href=\"https:\/\/support.withsecure.com\/en\/changelogs\/commercial-api-2026-03-24-update\/\">\n                <p class=\"wp-block-content-list__title\">Commercial API 2026-03-24 Update<\/p>\n            <\/a>\n\n            \n                            <details class=\"wp-block-content-list__details\">\n                    <summary class=\"wp-block-content-list__summary\">Read more<\/summary>\n                    <div class=\"wp-component-paragraph wp-block-content-list__body\">\n    <p>We\u2019ve introduced a new endpoint to manage licensee positioning within the Elements Security Center hierarchy:<\/p>\n<p><strong>Change Elements Security Center Hierarchy<br \/><\/strong><br \/><code class=\"code codeInline\" spellcheck=\"false\" tabindex=\"0\">POST \/hierarchy?buyer_assigned_account_id={buyer_assigned_account_id}<\/code><\/p>\n<p>This endpoint is available for Direct Resellers only and allows you to update how a licensee is organized within the hierarchy by assigning it under a specific SEP or SOP in the Elements Security Center only.<\/p>\n<p><strong>Key capabilities:<\/strong><\/p>\n<ul>\n<li>Assign a licensee to a specific SEP (if currently under an SOP)<\/li>\n<li>&#13;Assign a licensee to a specific SOP (if currently under an SEP belonging to that SOP)<\/li>\n<li>&#13;Update hierarchy structure without impacting commercial or contractual relationships<\/li>\n<\/ul>\n<p><strong>Important notes:<\/strong><\/p>\n<ul>\n<li>Changes are restricted within the same buyer party<\/li>\n<li>Cannot be used to move a licensee to another reseller<\/li>\n<li>SEP and SOP entities must already exist (no creation supported)<\/li>\n<li>This operation only affects hierarchy structure and display in Elements Security Center and can not be used to move licensee under the new reseller<\/li>\n<\/ul>\n<p>For full request\/response details, refer to the <a href=\"https:\/\/community.withsecure.com\/home\/leaving?allowTrusted=1&amp;target=https%3A%2F%2Fconnect.withsecure.com%2Fapi-reference%2Fcommercial%2F\" rel=\"nofollow noopener ugc\" target=\"_blank\">API documentation<\/a>.<\/p>\n<\/div>\n                <\/details>\n                    <\/li>\n            <li class=\"wp-block-content-list__item\">\n                            <time class=\"wp-block-content-list__updated\" datetime=\"2026-01-28T00:00:00+00:00\">January 28, 2026<\/time>\n            \n            <a class=\"wp-block-content-list__link\" href=\"https:\/\/support.withsecure.com\/en\/changelogs\/commercial-api-2026-01-28-update\/\">\n                <p class=\"wp-block-content-list__title\">Commercial API &#8211; 2026-01-28 Update<\/p>\n            <\/a>\n\n            \n                            <details class=\"wp-block-content-list__details\">\n                    <summary class=\"wp-block-content-list__summary\">Read more<\/summary>\n                    <div class=\"wp-component-paragraph wp-block-content-list__body\">\n    <p>The descriptions for the Create New Subscription and Change Subscription API endpoints were updated to better reflect their purpose and supported operations. No changes were made to request or response parameters.<\/p>\n<p>Documentation-Only Updates to Endpoint Descriptions:<\/p>\n<p><strong>Create New Subscription:<\/strong><br \/>&#13;<br \/>\nProvision a new Total Volume subscription for a new or existing licensee. This endpoint may also be used to grant access to an admin user in the Elements Security Center or to change the licensee (company) name. Granting access and changing the name can only be completed as part of a subscription creation request.<\/p>\n<p><strong>Change Subscription:<\/strong><br \/>&#13;<br \/>\nMake changes to an existing Total Volume subscription. This endpoint may also be used to grant access to an admin user in the Elements Security Center as part of a subscription change request.<\/p>\n<\/div>\n                <\/details>\n                    <\/li>\n    <\/ul>\n\n                            <\/div>\n    <\/div>\n<\/section>\n","protected":false},"excerpt":{"rendered":"","protected":false},"author":0,"featured_media":0,"parent":4744,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"_acf_changed":false,"footnotes":""},"class_list":["post-4754","page","type-page","status-publish","hentry"],"acf":[],"_links":{"self":[{"href":"https:\/\/support.withsecure.com\/en\/wp-json\/wp\/v2\/pages\/4754","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/support.withsecure.com\/en\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/support.withsecure.com\/en\/wp-json\/wp\/v2\/types\/page"}],"replies":[{"embeddable":true,"href":"https:\/\/support.withsecure.com\/en\/wp-json\/wp\/v2\/comments?post=4754"}],"version-history":[{"count":1,"href":"https:\/\/support.withsecure.com\/en\/wp-json\/wp\/v2\/pages\/4754\/revisions"}],"predecessor-version":[{"id":8123,"href":"https:\/\/support.withsecure.com\/en\/wp-json\/wp\/v2\/pages\/4754\/revisions\/8123"}],"up":[{"embeddable":true,"href":"https:\/\/support.withsecure.com\/en\/wp-json\/wp\/v2\/pages\/4744"}],"wp:attachment":[{"href":"https:\/\/support.withsecure.com\/en\/wp-json\/wp\/v2\/media?parent=4754"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}