{"id":10115,"date":"2024-06-10T12:32:44","date_gmt":"2024-06-10T12:32:44","guid":{"rendered":"https:\/\/www.purewl.com\/developer\/docs\/api-reference\/api-reference\/vpn-account-management-vam\/extend-expiry\/"},"modified":"2025-02-19T10:25:09","modified_gmt":"2025-02-19T10:25:09","slug":"extend-expiry","status":"publish","type":"docs","link":"https:\/\/www.purewl.com\/developer\/guides\/api\/api-reference\/vpn-account-management-vam\/extend-expiry\/","title":{"rendered":"Extend Expiry"},"content":{"rendered":"\n<p>Extending VPN accounts via API is a crucial functionality for managing user subscriptions and ensuring uninterrupted VPN access. This process allows administrators and users to extend the validity of their VPN accounts programmatically, facilitating seamless access without manual intervention. This article provides a technical overview of implementing VPN account extension through API calls.<\/p>\n\n\n\n<h2 class=\"wp-block-heading\">Extend Expiry<\/h2>\n\n\n\n<p>Use this API to extend expiry of a VPN user for further use.<\/p>\n\n\n\n<p>Returns a JSON object that contains the VPN username and updated expiration date.<\/p>\n\n\n\n<ul>\n<li><strong>URL:&nbsp;<\/strong>&lt;base url&gt;\/vam\/v2\/extend<\/li>\n\n\n\n<li><strong>Request Method:&nbsp;<\/strong>PUT<\/li>\n<\/ul>\n\n\n\n<p><\/p>\n\n\n\n<h3 class=\"wp-block-heading\">Payload<\/h3>\n\n\n\n<figure class=\"wp-block-table\"><table><thead><tr><th class=\"has-text-align-left\" data-align=\"left\"><strong>Key<\/strong><\/th><th class=\"has-text-align-left\" data-align=\"left\"><strong>Type<\/strong><\/th><th class=\"has-text-align-left\" data-align=\"left\"><strong>Pass in<\/strong><\/th><th class=\"has-text-align-left\" data-align=\"left\"><strong>Description<\/strong><\/th><\/tr><\/thead><tbody><tr><td class=\"has-text-align-left\" data-align=\"left\"><code>X-AccessToken<\/code>*<\/td><td class=\"has-text-align-left\" data-align=\"left\">String<\/td><td class=\"has-text-align-left\" data-align=\"left\">Header <\/td><td class=\"has-text-align-left\" data-align=\"left\"><kbd>accessToken<\/kbd> retrieved from <a href=\"https:\/\/www.purewl.com\/developer\/guides\/api\/api-reference\/api-access-authentication\/#get-access-token\" data-type=\"link\" data-id=\"https:\/\/www.purewl.com\/developer\/guides\/api\/api-reference\/inventory-management\/countries\/\" target=\"_blank\" rel=\"noreferrer noopener\">Get Access Token<\/a> endpoint<\/td><\/tr><tr><td class=\"has-text-align-left\" data-align=\"left\"><code>vpnUsername<\/code>*<\/td><td class=\"has-text-align-left\" data-align=\"left\">String<\/td><td class=\"has-text-align-left\" data-align=\"left\">Body<\/td><td class=\"has-text-align-left\" data-align=\"left\">VPN Username<\/td><\/tr><tr><td class=\"has-text-align-left\" data-align=\"left\"><code>extensionDate<\/code>*<\/td><td class=\"has-text-align-left\" data-align=\"left\">String<\/td><td class=\"has-text-align-left\" data-align=\"left\">Body<\/td><td class=\"has-text-align-left\" data-align=\"left\">Extension date to be provided (DD-MM-YYYY)<\/td><\/tr><\/tbody><\/table><figcaption class=\"wp-element-caption\">(*) Required Parameter<\/figcaption><\/figure>\n\n\n\n<h3 class=\"wp-block-heading\">Response<\/h3>\n\n\n\n<figure class=\"wp-block-table\"><table><thead><tr><th class=\"has-text-align-left\" data-align=\"left\"><strong>Key<\/strong><\/th><th class=\"has-text-align-left\" data-align=\"left\"><strong>Type<\/strong><\/th><th class=\"has-text-align-left\" data-align=\"left\"><strong>Description<\/strong><\/th><\/tr><\/thead><tbody><tr><td class=\"has-text-align-left\" data-align=\"left\"><code>header<\/code><\/td><td class=\"has-text-align-left\" data-align=\"left\">JSON<\/td><td class=\"has-text-align-left\" data-align=\"left\">JSON object that describes return code and message.<\/td><\/tr><tr><td class=\"has-text-align-left\" data-align=\"left\"><code>body<\/code><\/td><td class=\"has-text-align-left\" data-align=\"left\">JSON<\/td><td class=\"has-text-align-left\" data-align=\"left\">JSON object that return username and user new expire date.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<h3 class=\"wp-block-heading\">Possible API error codes<\/h3>\n\n\n\n<figure class=\"wp-block-table\"><table><tbody><tr><td><strong>Code<\/strong><\/td><td><strong>Message<\/strong><\/td><td><strong>Description<\/strong><\/td><\/tr><tr><td><code>1601<\/code><\/td><td>There is some problem in extending vpn account<\/td><td>An error occurred while attempting to extend the VPN account.<\/td><\/tr><tr><td><code>11001<\/code><\/td><td>The extension date does not match the format (DD-MM-YYYY).<\/td><td>The provided extension date does not match the required format (DD-MM-YYYY).<\/td><\/tr><tr><td><code>11001<\/code><\/td><td>The provided username is not valid for this reseller<\/td><td>The provided username is not recognized as valid for the associated reseller.<\/td><\/tr><tr><td><code>100033<\/code><\/td><td>This Dedicated User IP has been assigned to another user<\/td><td>The Dedicated IP has been assigned to a different user.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<h3 class=\"wp-block-heading\">Sample Response<\/h3>\n\n\n\n<div class=\"hcb_wrap\"><pre class=\"prism off-numbers lang-json\" data-lang=\"JSON\" data-show-lang=\"1\"><code>{\n  &quot;header&quot;: {\n    &quot;response_code&quot;: 1,\n    &quot;message&quot;: &quot;VPN account has been extended successfully&quot;\n  },\n  &quot;body&quot;: {\n    &quot;vpnUsername&quot;: &quot;xxxxx&quot;,\n    &quot;extendedForDays&quot;: &quot;xxxxxx&quot;\n  }\n}<\/code><\/pre><\/div>\n","protected":false},"excerpt":{"rendered":"<p>Extending VPN accounts via API is a crucial functionality for managing user subscriptions and ensuring uninterrupted VPN access. This process allows administrators and users to extend the validity of their VPN accounts programmatically, facilitating seamless access without manual intervention. This article provides a technical overview of implementing VPN account extension through API calls. Extend Expiry [&hellip;]<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":10017,"menu_order":7,"comment_status":"open","ping_status":"closed","template":"","doc_tag":[],"acf":[],"_links":{"self":[{"href":"https:\/\/www.purewl.com\/developer\/wp-json\/wp\/v2\/docs\/10115"}],"collection":[{"href":"https:\/\/www.purewl.com\/developer\/wp-json\/wp\/v2\/docs"}],"about":[{"href":"https:\/\/www.purewl.com\/developer\/wp-json\/wp\/v2\/types\/docs"}],"author":[{"embeddable":true,"href":"https:\/\/www.purewl.com\/developer\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.purewl.com\/developer\/wp-json\/wp\/v2\/comments?post=10115"}],"version-history":[{"count":16,"href":"https:\/\/www.purewl.com\/developer\/wp-json\/wp\/v2\/docs\/10115\/revisions"}],"predecessor-version":[{"id":10877,"href":"https:\/\/www.purewl.com\/developer\/wp-json\/wp\/v2\/docs\/10115\/revisions\/10877"}],"up":[{"embeddable":true,"href":"https:\/\/www.purewl.com\/developer\/wp-json\/wp\/v2\/docs\/10017"}],"wp:attachment":[{"href":"https:\/\/www.purewl.com\/developer\/wp-json\/wp\/v2\/media?parent=10115"}],"wp:term":[{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/www.purewl.com\/developer\/wp-json\/wp\/v2\/doc_tag?post=10115"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}