{"id":526,"date":"2025-03-20T17:28:11","date_gmt":"2025-03-20T17:28:11","guid":{"rendered":"http:\/\/documentation.wpgetpaid.com\/?post_type=gd_place&p=526"},"modified":"2025-03-26T13:53:57","modified_gmt":"2025-03-26T13:53:57","slug":"license-manager-api-endpoints","status":"publish","type":"gd_place","link":"https:\/\/wpgetpaid.com\/documentation\/article\/license-manager\/license-manager-api-endpoints\/","title":{"rendered":"License Manager API Endpoints"},"content":{"rendered":"\n

Validate License Request<\/h2>\n\n\n\n
GET\/REQUEST: \/wp-json\/getpaid\/v1\/licenses\/{licence_key}\/{item_id}<\/pre>\n\n\n\n
license_key <\/strong>is the key given after purchasing the item.
Item_id<\/strong> is the id of the product purchased.<\/p>\n\n\n\n
Example return:<\/p>\n\n\n\n
{\n  "id": 6,\n  "status": "active",\n  "date_created": "2023-01-19 13:54:33",\n  "date_created_gmt": "2023-01-19 13:54:33",\n  "date_expires": "2023-02-19 13:54:33",\n  "date_expires_gmt": "2023-02-19 13:54:33",\n  "date_last_activated": "0000-00-00 00:00:00",\n  "date_last_activated_gmt": "0000-00-00 00:00:00",\n  "item_id": 5026,\n  "invoice_id": 5034,\n  "customer_id": 1,\n  "license_key": "4bb82ecd347bac6dc5f0ccbf1990",\n  "activations": 1,\n  "max_activations": 3,\n  "activated_on": {\n    "ppldb.com\/stiofan": "2023-01-19 14:42:06"\n  },\n  "view_url": "https:\/\/demos.ayecode.io\/getpaid\/my-licenses\/?license=6",\n  "item_version": "1.0.0",\n  "item_changelog": "",\n  "_links": {\n    "self": [\n      {\n        "href": "https:\/\/demos.ayecode.io\/getpaid\/wp-json\/getpaid\/v1\/licenses\/6"\n      }\n    ],\n    "collection": [\n      {\n        "href": "https:\/\/demos.ayecode.io\/getpaid\/wp-json\/getpaid\/v1\/licenses"\n      }\n    ],\n    "customer": [\n      {\n        "embeddable": true,\n        "href": "https:\/\/demos.ayecode.io\/getpaid\/wp-json\/wp\/v2\/users\/1"\n      }\n    ],\n    "invoice": [\n      {\n        "embeddable": true,\n        "href": "https:\/\/demos.ayecode.io\/getpaid\/wp-json\/getpaid\/v1\/invoices\/5034"\n      }\n    ],\n    "item": [\n      {\n        "embeddable": true,\n        "href": "https:\/\/demos.ayecode.io\/getpaid\/wp-json\/getpaid\/v1\/items\/5026"\n      }\n    ]\n  }\n}<\/code><\/pre>\n\n\n\n
Activate license<\/h2>\n\n\n\n
POST: \/wp-json\/getpaid\/v1\/licenses\/{licence_key}\/{item_id}\/activate?app={website_url}<\/pre>\n\n\n\n
license_key <\/strong>is the key given after purchasing the item.
Item_id<\/strong> is the id of the product purchased.
website_url <\/strong>is the website where it is being activated, this can also be changed to a app name if used in an app.<\/p>\n\n\n\n
Example return (first time activation): This is the same as the validation return above.

Example return if already active on the given website:<\/p>\n\n\n\n
{"code": "already_activated",\n"message": "This license key is already activated on the website.",\n"data": {"status": 400}\n}<\/code><\/pre>\n\n\n\n
Deactivate license<\/h2>\n\n\n\n
POST: \/wp-json\/getpaid\/v1\/licenses\/{licence_key}\/{item_id}\/deactivate?app={website_url}<\/pre>\n\n\n\n
license_key is the key given after purchasing the item.

Item_id is the id of the product purchased.

website_url is the website where it is being activated, this can also be changed to a app name if used in an app.<\/p>\n\n\n\n
Example return: This is the same as the validation return above.<\/p>\n\n\n\n
Check if a license is active on a specific site<\/h2>\n\n\n\n
POST: \/wp-json\/getpaid\/v1\/licenses\/{licence_key}\/{item_id}\/check?app={website_url}<\/pre>\n\n\n\n
license_key is the key given after purchasing the item.
Item_id is the id of the product purchased.
website_url is the website where it is being activated, this can also be changed to a app name if used in an app.<\/p>\n\n\n\n
Example return: <\/p>\n\n\n\n
{ "is_active": true }<\/code><\/pre>\n","protected":false},"excerpt":{"rendered":"
Validate License Request GET\/REQUEST: \/wp-json\/getpaid\/v1\/licenses\/{licence_key}\/{item_id} license_key is the key given after purchasing the item.Item_id is the id of the product purchased. Example return: Activate license POST: \/wp-json\/getpaid\/v1\/licenses\/{licence_key}\/{item_id}\/activate?app={website_url} license_key is the key given after purchasing the item.Item_id is the id of the product purchased.website_url is the website where it is being activated, this can also be changed to […]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"closed","template":"","meta":{"footnotes":""},"article\/tags":[],"article\/categories":[213,237],"class_list":["post-526","gd_place","type-gd_place","status-publish","hentry","gd_placecategory-extensions-features","gd_placecategory-license-manager"],"_links":{"self":[{"href":"https:\/\/wpgetpaid.com\/documentation\/wp-json\/wp\/v2\/article\/526","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/wpgetpaid.com\/documentation\/wp-json\/wp\/v2\/article"}],"about":[{"href":"https:\/\/wpgetpaid.com\/documentation\/wp-json\/wp\/v2\/types\/gd_place"}],"author":[{"embeddable":true,"href":"https:\/\/wpgetpaid.com\/documentation\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/wpgetpaid.com\/documentation\/wp-json\/wp\/v2\/comments?post=526"}],"version-history":[{"count":0,"href":"https:\/\/wpgetpaid.com\/documentation\/wp-json\/wp\/v2\/article\/526\/revisions"}],"wp:attachment":[{"href":"https:\/\/wpgetpaid.com\/documentation\/wp-json\/wp\/v2\/media?parent=526"}],"wp:term":[{"taxonomy":"gd_place_tags","embeddable":true,"href":"https:\/\/wpgetpaid.com\/documentation\/wp-json\/wp\/v2\/article\/tags?post=526"},{"taxonomy":"gd_placecategory","embeddable":true,"href":"https:\/\/wpgetpaid.com\/documentation\/wp-json\/wp\/v2\/article\/categories?post=526"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}