Webstore
Headers
AuthorizationAPI KeyRequired
Authentication token for this request, sent as
Authorization: APIKey TOKEN.Path parameters
storeIdFlakeIdRequired
Response
200OKWebstoreModuleDto[]
Show fieldsHide fields
idFlakeIdRequired
created_atstringRequired
enabledbooleanRequired
sort_orderintegerRequired
typestringRequired
updated_atstringRequired
webstore_idFlakeIdRequired
ends_atstringOptional
settingsnullOptional
starts_atstringOptional
Failed requests return a PayNowError body. See the error response guide.
curl -X GET "https://api.paynow.gg/v1/webstores/{storeId}/modules" \
-H "Authorization: APIKey TOKEN"import { createManagementClient } from "@paynow-gg/typescript-sdk";
const paynow = createManagementClient({
apiKey: "API_KEY",
storeId: "STORE_ID",
});
const result = await paynow.webstore.getWebstoreModules();import requests
headers = {"Authorization": "APIKey TOKEN"}
response = requests.get("https://api.paynow.gg/v1/webstores/{storeId}/modules", headers=headers)Response200
[
{
"id": "411486491630370816",
"created_at": "2024-01-01T00:00:00Z",
"enabled": true,
"sort_order": 0,
"type": "string",
"updated_at": "2024-01-01T00:00:00Z",
"webstore_id": "411486491630370816",
"ends_at": "2024-01-01T00:00:00Z",
"settings": {},
"starts_at": "2024-01-01T00:00:00Z"
}
]Headers
AuthorizationAPI KeyRequired
Authentication token for this request, sent as
Authorization: APIKey TOKEN.Path parameters
storeIdFlakeIdRequired
Request body
enabledbooleanRequired
typestringRequired
ends_atstringOptional
settingsnullOptional
starts_atstringOptional
Response
200OKWebstoreModuleDto
Show fieldsHide fields
idFlakeIdRequired
created_atstringRequired
enabledbooleanRequired
sort_orderintegerRequired
typestringRequired
updated_atstringRequired
webstore_idFlakeIdRequired
ends_atstringOptional
settingsnullOptional
starts_atstringOptional
Failed requests return a PayNowError body. See the error response guide.
curl -X PUT "https://api.paynow.gg/v1/webstores/{storeId}/modules" \
-H "Authorization: APIKey TOKEN" \
-H "Content-Type: application/json" \
-d '{
"enabled": true,
"type": "string",
"ends_at": "2024-01-01T00:00:00Z",
"settings": {},
"starts_at": "2024-01-01T00:00:00Z"
}'import { createManagementClient } from "@paynow-gg/typescript-sdk";
const paynow = createManagementClient({
apiKey: "API_KEY",
storeId: "STORE_ID",
});
const result = await paynow.webstore.createWebstoreModule({
enabled: true,
type: "string",
ends_at: "2024-01-01T00:00:00Z",
settings: {},
starts_at: "2024-01-01T00:00:00Z",
});import requests
headers = {"Authorization": "APIKey TOKEN"}
payload = {
"enabled": True,
"type": "string",
"ends_at": "2024-01-01T00:00:00Z",
"settings": {},
"starts_at": "2024-01-01T00:00:00Z",
}
response = requests.put("https://api.paynow.gg/v1/webstores/{storeId}/modules", headers=headers, json=payload)Response200
{
"id": "411486491630370816",
"created_at": "2024-01-01T00:00:00Z",
"enabled": true,
"sort_order": 0,
"type": "string",
"updated_at": "2024-01-01T00:00:00Z",
"webstore_id": "411486491630370816",
"ends_at": "2024-01-01T00:00:00Z",
"settings": {},
"starts_at": "2024-01-01T00:00:00Z"
}Headers
AuthorizationAPI KeyRequired
Authentication token for this request, sent as
Authorization: APIKey TOKEN.Path parameters
storeIdFlakeIdRequired
moduleIdFlakeIdRequired
Request body
enabledbooleanRequired
typestringRequired
ends_atstringOptional
settingsnullOptional
starts_atstringOptional
Response
200OKWebstoreModuleDto
Show fieldsHide fields
idFlakeIdRequired
created_atstringRequired
enabledbooleanRequired
sort_orderintegerRequired
typestringRequired
updated_atstringRequired
webstore_idFlakeIdRequired
ends_atstringOptional
settingsnullOptional
starts_atstringOptional
Failed requests return a PayNowError body. See the error response guide.
curl -X PUT "https://api.paynow.gg/v1/webstores/{storeId}/modules/{moduleId}" \
-H "Authorization: APIKey TOKEN" \
-H "Content-Type: application/json" \
-d '{
"enabled": true,
"type": "string",
"ends_at": "2024-01-01T00:00:00Z",
"settings": {},
"starts_at": "2024-01-01T00:00:00Z"
}'import { createManagementClient } from "@paynow-gg/typescript-sdk";
const paynow = createManagementClient({
apiKey: "API_KEY",
storeId: "STORE_ID",
});
const result = await paynow.webstore.updateWebstoreModule("411486491630370816", {
enabled: true,
type: "string",
ends_at: "2024-01-01T00:00:00Z",
settings: {},
starts_at: "2024-01-01T00:00:00Z",
});import requests
headers = {"Authorization": "APIKey TOKEN"}
payload = {
"enabled": True,
"type": "string",
"ends_at": "2024-01-01T00:00:00Z",
"settings": {},
"starts_at": "2024-01-01T00:00:00Z",
}
response = requests.put("https://api.paynow.gg/v1/webstores/{storeId}/modules/{moduleId}", headers=headers, json=payload)Response200
{
"id": "411486491630370816",
"created_at": "2024-01-01T00:00:00Z",
"enabled": true,
"sort_order": 0,
"type": "string",
"updated_at": "2024-01-01T00:00:00Z",
"webstore_id": "411486491630370816",
"ends_at": "2024-01-01T00:00:00Z",
"settings": {},
"starts_at": "2024-01-01T00:00:00Z"
}Headers
AuthorizationAPI KeyRequired
Authentication token for this request, sent as
Authorization: APIKey TOKEN.Path parameters
storeIdFlakeIdRequired
moduleIdFlakeIdRequired
curl -X DELETE "https://api.paynow.gg/v1/webstores/{storeId}/modules/{moduleId}" \
-H "Authorization: APIKey TOKEN"import { createManagementClient } from "@paynow-gg/typescript-sdk";
const paynow = createManagementClient({
apiKey: "API_KEY",
storeId: "STORE_ID",
});
await paynow.webstore.deleteWebstoreModule("411486491630370816");import requests
headers = {"Authorization": "APIKey TOKEN"}
response = requests.delete("https://api.paynow.gg/v1/webstores/{storeId}/modules/{moduleId}", headers=headers)Headers
AuthorizationAPI KeyRequired
Authentication token for this request, sent as
Authorization: APIKey TOKEN.Path parameters
storeIdFlakeIdRequired
Response
200OKWebstoreDto
Show fieldsHide fields
idFlakeIdRequired
custom_domain_verifiedbooleanRequired
is_activebooleanRequired
slugstringRequired
current_template_idFlakeIdOptional
custom_domainstringOptional
Failed requests return a PayNowError body. See the error response guide.
curl -X GET "https://api.paynow.gg/v1/webstores/{storeId}" \
-H "Authorization: APIKey TOKEN"import { createManagementClient } from "@paynow-gg/typescript-sdk";
const paynow = createManagementClient({
apiKey: "API_KEY",
storeId: "STORE_ID",
});
const result = await paynow.webstore.getWebstore();import requests
headers = {"Authorization": "APIKey TOKEN"}
response = requests.get("https://api.paynow.gg/v1/webstores/{storeId}", headers=headers)Response200
{
"id": "411486491630370816",
"custom_domain_verified": true,
"is_active": true,
"slug": "string",
"current_template_id": "411486491630370816",
"custom_domain": "string"
}Headers
AuthorizationAPI KeyRequired
Authentication token for this request, sent as
Authorization: APIKey TOKEN.Path parameters
storeIdFlakeIdRequired
Request body
template_idFlakeIdRequired
curl -X POST "https://api.paynow.gg/v1/webstores/{storeId}/set-default-template" \
-H "Authorization: APIKey TOKEN" \
-H "Content-Type: application/json" \
-d '{
"template_id": "411486491630370816"
}'import { createManagementClient } from "@paynow-gg/typescript-sdk";
const paynow = createManagementClient({
apiKey: "API_KEY",
storeId: "STORE_ID",
});
await paynow.webstore.setWebstoreDefaultTemplate({
template_id: "411486491630370816",
});import requests
headers = {"Authorization": "APIKey TOKEN"}
payload = {
"template_id": "411486491630370816",
}
response = requests.post("https://api.paynow.gg/v1/webstores/{storeId}/set-default-template", headers=headers, json=payload)Headers
AuthorizationAPI KeyRequired
Authentication token for this request, sent as
Authorization: APIKey TOKEN.Path parameters
storeIdFlakeIdRequired
Request body
slugstringRequired
curl -X POST "https://api.paynow.gg/v1/webstores/{storeId}/set-slug" \
-H "Authorization: APIKey TOKEN" \
-H "Content-Type: application/json" \
-d '{
"slug": "string"
}'import { createManagementClient } from "@paynow-gg/typescript-sdk";
const paynow = createManagementClient({
apiKey: "API_KEY",
storeId: "STORE_ID",
});
await paynow.webstore.setWebstoreSlug({
slug: "string",
});import requests
headers = {"Authorization": "APIKey TOKEN"}
payload = {
"slug": "string",
}
response = requests.post("https://api.paynow.gg/v1/webstores/{storeId}/set-slug", headers=headers, json=payload)Headers
AuthorizationAPI KeyRequired
Authentication token for this request, sent as
Authorization: APIKey TOKEN.Path parameters
storeIdFlakeIdRequired
Response
200OKWebstoreCustomDomainDto
Show fieldsHide fields
idstringRequired
hostnamestringRequired
statusstringRequired
verification_errorsstring[]Required
created_atstringOptional
ownership_verificationWebstoreCustomDomainOwnershipVerificationDtoOptional
namestringRequired
typestringRequired
valuestringRequired
ownership_verification_httpWebstoreCustomDomainOwnershipVerificationHttpDtoOptional
http_bodystringRequired
http_urlstringRequired
sslWebstoreCustomDomainSslDtoOptional
idstringRequired
methodstringRequired
statusstringRequired
validation_errorsstring[]Required
validation_recordsWebstoreCustomDomainSslValidationRecordDto[]Required
emailsstring[]Required
http_bodystringOptional
http_urlstringOptional
txt_namestringOptional
txt_valuestringOptional
certificate_authoritystringOptional
Failed requests return a PayNowError body. See the error response guide.
curl -X GET "https://api.paynow.gg/v1/webstores/{storeId}/custom-domain" \
-H "Authorization: APIKey TOKEN"import { createManagementClient } from "@paynow-gg/typescript-sdk";
const paynow = createManagementClient({
apiKey: "API_KEY",
storeId: "STORE_ID",
});
const result = await paynow.webstore.getWebstoreCustomDomain();import requests
headers = {"Authorization": "APIKey TOKEN"}
response = requests.get("https://api.paynow.gg/v1/webstores/{storeId}/custom-domain", headers=headers)Response200
{
"id": "string",
"hostname": "string",
"status": "string",
"verification_errors": [
"string"
],
"created_at": "2024-01-01T00:00:00Z",
"ownership_verification": {
"name": "string",
"type": "string",
"value": "string"
},
"ownership_verification_http": {
"http_body": "string",
"http_url": "string"
},
"ssl": {
"id": "string",
"method": "string",
"status": "string",
"validation_errors": [
"string"
],
"validation_records": [
{
"emails": [
"string"
],
"http_body": "string",
"http_url": "string",
"txt_name": "string",
"txt_value": "string"
}
],
"certificate_authority": "string"
}
}Headers
AuthorizationAPI KeyRequired
Authentication token for this request, sent as
Authorization: APIKey TOKEN.Path parameters
storeIdFlakeIdRequired
Request body
domainstringRequired
verification_typeenumRequired
Possible enum values
invalidhttptxtemailcname
Response
200OKWebstoreCustomDomainDto
Show fieldsHide fields
idstringRequired
hostnamestringRequired
statusstringRequired
verification_errorsstring[]Required
created_atstringOptional
ownership_verificationWebstoreCustomDomainOwnershipVerificationDtoOptional
namestringRequired
typestringRequired
valuestringRequired
ownership_verification_httpWebstoreCustomDomainOwnershipVerificationHttpDtoOptional
http_bodystringRequired
http_urlstringRequired
sslWebstoreCustomDomainSslDtoOptional
idstringRequired
methodstringRequired
statusstringRequired
validation_errorsstring[]Required
validation_recordsWebstoreCustomDomainSslValidationRecordDto[]Required
emailsstring[]Required
http_bodystringOptional
http_urlstringOptional
txt_namestringOptional
txt_valuestringOptional
certificate_authoritystringOptional
Failed requests return a PayNowError body. See the error response guide.
curl -X POST "https://api.paynow.gg/v1/webstores/{storeId}/custom-domain" \
-H "Authorization: APIKey TOKEN" \
-H "Content-Type: application/json" \
-d '{
"domain": "string",
"verification_type": "invalid"
}'import { createManagementClient } from "@paynow-gg/typescript-sdk";
const paynow = createManagementClient({
apiKey: "API_KEY",
storeId: "STORE_ID",
});
const result = await paynow.webstore.setWebstoreCustomDomain({
domain: "string",
verification_type: "invalid",
});import requests
headers = {"Authorization": "APIKey TOKEN"}
payload = {
"domain": "string",
"verification_type": "invalid",
}
response = requests.post("https://api.paynow.gg/v1/webstores/{storeId}/custom-domain", headers=headers, json=payload)Response200
{
"id": "string",
"hostname": "string",
"status": "string",
"verification_errors": [
"string"
],
"created_at": "2024-01-01T00:00:00Z",
"ownership_verification": {
"name": "string",
"type": "string",
"value": "string"
},
"ownership_verification_http": {
"http_body": "string",
"http_url": "string"
},
"ssl": {
"id": "string",
"method": "string",
"status": "string",
"validation_errors": [
"string"
],
"validation_records": [
{
"emails": [
"string"
],
"http_body": "string",
"http_url": "string",
"txt_name": "string",
"txt_value": "string"
}
],
"certificate_authority": "string"
}
}Headers
AuthorizationAPI KeyRequired
Authentication token for this request, sent as
Authorization: APIKey TOKEN.Path parameters
storeIdFlakeIdRequired
curl -X DELETE "https://api.paynow.gg/v1/webstores/{storeId}/custom-domain" \
-H "Authorization: APIKey TOKEN"import { createManagementClient } from "@paynow-gg/typescript-sdk";
const paynow = createManagementClient({
apiKey: "API_KEY",
storeId: "STORE_ID",
});
await paynow.webstore.deleteWebstoreCustomDomain();import requests
headers = {"Authorization": "APIKey TOKEN"}
response = requests.delete("https://api.paynow.gg/v1/webstores/{storeId}/custom-domain", headers=headers)Headers
AuthorizationAPI KeyRequired
Authentication token for this request, sent as
Authorization: APIKey TOKEN.Path parameters
storeIdFlakeIdRequired
curl -X POST "https://api.paynow.gg/v1/webstores/{storeId}/custom-domain/verify" \
-H "Authorization: APIKey TOKEN"import { createManagementClient } from "@paynow-gg/typescript-sdk";
const paynow = createManagementClient({
apiKey: "API_KEY",
storeId: "STORE_ID",
});
await paynow.webstore.verifyWebstoreCustomDomain();import requests
headers = {"Authorization": "APIKey TOKEN"}
response = requests.post("https://api.paynow.gg/v1/webstores/{storeId}/custom-domain/verify", headers=headers)Get Webstore Template Files
GEThttps://api.paynow.gg/v1/webstores/{storeId}/templates/{templateId}/files
Headers
AuthorizationAPI KeyRequired
Authentication token for this request, sent as
Authorization: APIKey TOKEN.Path parameters
storeIdFlakeIdRequired
templateIdFlakeIdRequired
Response
200OKWebstoreTemplateFileDto[]
Show fieldsHide fields
idFlakeIdRequired
content_typestringRequired
created_atstringRequired
file_namestringRequired
is_deletablebooleanRequired
is_publicbooleanRequired
template_idFlakeIdRequired
updated_atstringRequired
contentstringOptional
Failed requests return a PayNowError body. See the error response guide.
curl -X GET "https://api.paynow.gg/v1/webstores/{storeId}/templates/{templateId}/files" \
-H "Authorization: APIKey TOKEN"import { createManagementClient } from "@paynow-gg/typescript-sdk";
const paynow = createManagementClient({
apiKey: "API_KEY",
storeId: "STORE_ID",
});
const result = await paynow.webstore.getWebstoreTemplateFiles("411486491630370816");import requests
headers = {"Authorization": "APIKey TOKEN"}
response = requests.get("https://api.paynow.gg/v1/webstores/{storeId}/templates/{templateId}/files", headers=headers)Response200
[
{
"id": "411486491630370816",
"content_type": "string",
"created_at": "2024-01-01T00:00:00Z",
"file_name": "string",
"is_deletable": true,
"is_public": true,
"template_id": "411486491630370816",
"updated_at": "2024-01-01T00:00:00Z",
"content": "string"
}
]Create Webstore Template File
PUThttps://api.paynow.gg/v1/webstores/{storeId}/templates/{templateId}/files
Headers
AuthorizationAPI KeyRequired
Authentication token for this request, sent as
Authorization: APIKey TOKEN.Path parameters
storeIdFlakeIdRequired
templateIdFlakeIdRequired
Request body
content_typestringRequired
file_namestringRequired
contentstringOptional
Response
200OKWebstoreTemplateFileDto
Show fieldsHide fields
idFlakeIdRequired
content_typestringRequired
created_atstringRequired
file_namestringRequired
is_deletablebooleanRequired
is_publicbooleanRequired
template_idFlakeIdRequired
updated_atstringRequired
contentstringOptional
Failed requests return a PayNowError body. See the error response guide.
curl -X PUT "https://api.paynow.gg/v1/webstores/{storeId}/templates/{templateId}/files" \
-H "Authorization: APIKey TOKEN" \
-H "Content-Type: application/json" \
-d '{
"content_type": "string",
"file_name": "string",
"content": "string"
}'import { createManagementClient } from "@paynow-gg/typescript-sdk";
const paynow = createManagementClient({
apiKey: "API_KEY",
storeId: "STORE_ID",
});
const result = await paynow.webstore.createWebstoreTemplateFile("411486491630370816", {
content_type: "string",
file_name: "string",
content: "string",
});import requests
headers = {"Authorization": "APIKey TOKEN"}
payload = {
"content_type": "string",
"file_name": "string",
"content": "string",
}
response = requests.put("https://api.paynow.gg/v1/webstores/{storeId}/templates/{templateId}/files", headers=headers, json=payload)Response200
{
"id": "411486491630370816",
"content_type": "string",
"created_at": "2024-01-01T00:00:00Z",
"file_name": "string",
"is_deletable": true,
"is_public": true,
"template_id": "411486491630370816",
"updated_at": "2024-01-01T00:00:00Z",
"content": "string"
}Get Webstore Template File
GEThttps://api.paynow.gg/v1/webstores/{storeId}/templates/{templateId}/files/{templateFileId}
Headers
AuthorizationAPI KeyRequired
Authentication token for this request, sent as
Authorization: APIKey TOKEN.Path parameters
storeIdFlakeIdRequired
templateIdFlakeIdRequired
templateFileIdFlakeIdRequired
Response
200OKWebstoreTemplateFileDto
Show fieldsHide fields
idFlakeIdRequired
content_typestringRequired
created_atstringRequired
file_namestringRequired
is_deletablebooleanRequired
is_publicbooleanRequired
template_idFlakeIdRequired
updated_atstringRequired
contentstringOptional
Failed requests return a PayNowError body. See the error response guide.
curl -X GET "https://api.paynow.gg/v1/webstores/{storeId}/templates/{templateId}/files/{templateFileId}" \
-H "Authorization: APIKey TOKEN"import { createManagementClient } from "@paynow-gg/typescript-sdk";
const paynow = createManagementClient({
apiKey: "API_KEY",
storeId: "STORE_ID",
});
const result = await paynow.webstore.getWebstoreTemplateFile("411486491630370816", "411486491630370816");import requests
headers = {"Authorization": "APIKey TOKEN"}
response = requests.get("https://api.paynow.gg/v1/webstores/{storeId}/templates/{templateId}/files/{templateFileId}", headers=headers)Response200
{
"id": "411486491630370816",
"content_type": "string",
"created_at": "2024-01-01T00:00:00Z",
"file_name": "string",
"is_deletable": true,
"is_public": true,
"template_id": "411486491630370816",
"updated_at": "2024-01-01T00:00:00Z",
"content": "string"
}Update Webstore Template File
PUThttps://api.paynow.gg/v1/webstores/{storeId}/templates/{templateId}/files/{templateFileId}
Headers
AuthorizationAPI KeyRequired
Authentication token for this request, sent as
Authorization: APIKey TOKEN.Path parameters
storeIdFlakeIdRequired
templateIdFlakeIdRequired
templateFileIdFlakeIdRequired
Request body
contentstringRequired
curl -X PUT "https://api.paynow.gg/v1/webstores/{storeId}/templates/{templateId}/files/{templateFileId}" \
-H "Authorization: APIKey TOKEN" \
-H "Content-Type: application/json" \
-d '{
"content": "string"
}'import { createManagementClient } from "@paynow-gg/typescript-sdk";
const paynow = createManagementClient({
apiKey: "API_KEY",
storeId: "STORE_ID",
});
await paynow.webstore.updateWebstoreTemplateFile("411486491630370816", "411486491630370816", {
content: "string",
});import requests
headers = {"Authorization": "APIKey TOKEN"}
payload = {
"content": "string",
}
response = requests.put("https://api.paynow.gg/v1/webstores/{storeId}/templates/{templateId}/files/{templateFileId}", headers=headers, json=payload)Delete Webstore Template File
DELETEhttps://api.paynow.gg/v1/webstores/{storeId}/templates/{templateId}/files/{templateFileId}
Headers
AuthorizationAPI KeyRequired
Authentication token for this request, sent as
Authorization: APIKey TOKEN.Path parameters
storeIdFlakeIdRequired
templateIdFlakeIdRequired
templateFileIdFlakeIdRequired
curl -X DELETE "https://api.paynow.gg/v1/webstores/{storeId}/templates/{templateId}/files/{templateFileId}" \
-H "Authorization: APIKey TOKEN"import { createManagementClient } from "@paynow-gg/typescript-sdk";
const paynow = createManagementClient({
apiKey: "API_KEY",
storeId: "STORE_ID",
});
await paynow.webstore.deleteWebstoreTemplateFile("411486491630370816", "411486491630370816");import requests
headers = {"Authorization": "APIKey TOKEN"}
response = requests.delete("https://api.paynow.gg/v1/webstores/{storeId}/templates/{templateId}/files/{templateFileId}", headers=headers)Headers
AuthorizationAPI KeyRequired
Authentication token for this request, sent as
Authorization: APIKey TOKEN.Path parameters
storeIdFlakeIdRequired
Response
200OKWebstoreTemplateDto[]
Show fieldsHide fields
idFlakeIdRequired
compatibility_modeenumRequired
Possible enum values
invalidpaynowtebex
created_atstringRequired
is_publicbooleanRequired
namestringRequired
updated_atstringRequired
webstore_idFlakeIdRequired
template_filesWebstoreTemplateFileDto[]Optional
idFlakeIdRequired
content_typestringRequired
created_atstringRequired
file_namestringRequired
is_deletablebooleanRequired
is_publicbooleanRequired
template_idFlakeIdRequired
updated_atstringRequired
contentstringOptional
Failed requests return a PayNowError body. See the error response guide.
curl -X GET "https://api.paynow.gg/v1/webstores/{storeId}/templates" \
-H "Authorization: APIKey TOKEN"import { createManagementClient } from "@paynow-gg/typescript-sdk";
const paynow = createManagementClient({
apiKey: "API_KEY",
storeId: "STORE_ID",
});
const result = await paynow.webstore.getWebstoreTemplates();import requests
headers = {"Authorization": "APIKey TOKEN"}
response = requests.get("https://api.paynow.gg/v1/webstores/{storeId}/templates", headers=headers)Response200
[
{
"id": "411486491630370816",
"compatibility_mode": "invalid",
"created_at": "2024-01-01T00:00:00Z",
"is_public": true,
"name": "string",
"updated_at": "2024-01-01T00:00:00Z",
"webstore_id": "411486491630370816",
"template_files": [
{
"id": "411486491630370816",
"content_type": "string",
"created_at": "2024-01-01T00:00:00Z",
"file_name": "string",
"is_deletable": true,
"is_public": true,
"template_id": "411486491630370816",
"updated_at": "2024-01-01T00:00:00Z",
"content": "string"
}
]
}
]Headers
AuthorizationAPI KeyRequired
Authentication token for this request, sent as
Authorization: APIKey TOKEN.Path parameters
storeIdFlakeIdRequired
Request body
compatibility_modeenumRequired
Possible enum values
invalidpaynowtebex
namestringRequired
Response
200OKWebstoreTemplateDto
Show fieldsHide fields
idFlakeIdRequired
compatibility_modeenumRequired
Possible enum values
invalidpaynowtebex
created_atstringRequired
is_publicbooleanRequired
namestringRequired
updated_atstringRequired
webstore_idFlakeIdRequired
template_filesWebstoreTemplateFileDto[]Optional
idFlakeIdRequired
content_typestringRequired
created_atstringRequired
file_namestringRequired
is_deletablebooleanRequired
is_publicbooleanRequired
template_idFlakeIdRequired
updated_atstringRequired
contentstringOptional
Failed requests return a PayNowError body. See the error response guide.
curl -X PUT "https://api.paynow.gg/v1/webstores/{storeId}/templates" \
-H "Authorization: APIKey TOKEN" \
-H "Content-Type: application/json" \
-d '{
"compatibility_mode": "invalid",
"name": "string"
}'import { createManagementClient } from "@paynow-gg/typescript-sdk";
const paynow = createManagementClient({
apiKey: "API_KEY",
storeId: "STORE_ID",
});
const result = await paynow.webstore.createWebstoreTemplate({
compatibility_mode: "invalid",
name: "string",
});import requests
headers = {"Authorization": "APIKey TOKEN"}
payload = {
"compatibility_mode": "invalid",
"name": "string",
}
response = requests.put("https://api.paynow.gg/v1/webstores/{storeId}/templates", headers=headers, json=payload)Response200
{
"id": "411486491630370816",
"compatibility_mode": "invalid",
"created_at": "2024-01-01T00:00:00Z",
"is_public": true,
"name": "string",
"updated_at": "2024-01-01T00:00:00Z",
"webstore_id": "411486491630370816",
"template_files": [
{
"id": "411486491630370816",
"content_type": "string",
"created_at": "2024-01-01T00:00:00Z",
"file_name": "string",
"is_deletable": true,
"is_public": true,
"template_id": "411486491630370816",
"updated_at": "2024-01-01T00:00:00Z",
"content": "string"
}
]
}Headers
AuthorizationAPI KeyRequired
Authentication token for this request, sent as
Authorization: APIKey TOKEN.Path parameters
storeIdFlakeIdRequired
templateIdFlakeIdRequired
Query parameters
includestringOptional
Response
200OKWebstoreTemplateDto
Show fieldsHide fields
idFlakeIdRequired
compatibility_modeenumRequired
Possible enum values
invalidpaynowtebex
created_atstringRequired
is_publicbooleanRequired
namestringRequired
updated_atstringRequired
webstore_idFlakeIdRequired
template_filesWebstoreTemplateFileDto[]Optional
idFlakeIdRequired
content_typestringRequired
created_atstringRequired
file_namestringRequired
is_deletablebooleanRequired
is_publicbooleanRequired
template_idFlakeIdRequired
updated_atstringRequired
contentstringOptional
Failed requests return a PayNowError body. See the error response guide.
curl -X GET "https://api.paynow.gg/v1/webstores/{storeId}/templates/{templateId}" \
-H "Authorization: APIKey TOKEN"import { createManagementClient } from "@paynow-gg/typescript-sdk";
const paynow = createManagementClient({
apiKey: "API_KEY",
storeId: "STORE_ID",
});
const result = await paynow.webstore.getWebstoreTemplate("411486491630370816");import requests
headers = {"Authorization": "APIKey TOKEN"}
response = requests.get("https://api.paynow.gg/v1/webstores/{storeId}/templates/{templateId}", headers=headers)Response200
{
"id": "411486491630370816",
"compatibility_mode": "invalid",
"created_at": "2024-01-01T00:00:00Z",
"is_public": true,
"name": "string",
"updated_at": "2024-01-01T00:00:00Z",
"webstore_id": "411486491630370816",
"template_files": [
{
"id": "411486491630370816",
"content_type": "string",
"created_at": "2024-01-01T00:00:00Z",
"file_name": "string",
"is_deletable": true,
"is_public": true,
"template_id": "411486491630370816",
"updated_at": "2024-01-01T00:00:00Z",
"content": "string"
}
]
}Headers
AuthorizationAPI KeyRequired
Authentication token for this request, sent as
Authorization: APIKey TOKEN.Path parameters
storeIdFlakeIdRequired
templateIdFlakeIdRequired
Request body
compatibility_modeenumRequired
Possible enum values
invalidpaynowtebex
namestringRequired
Response
200OKWebstoreTemplateDto
Show fieldsHide fields
idFlakeIdRequired
compatibility_modeenumRequired
Possible enum values
invalidpaynowtebex
created_atstringRequired
is_publicbooleanRequired
namestringRequired
updated_atstringRequired
webstore_idFlakeIdRequired
template_filesWebstoreTemplateFileDto[]Optional
idFlakeIdRequired
content_typestringRequired
created_atstringRequired
file_namestringRequired
is_deletablebooleanRequired
is_publicbooleanRequired
template_idFlakeIdRequired
updated_atstringRequired
contentstringOptional
Failed requests return a PayNowError body. See the error response guide.
curl -X PUT "https://api.paynow.gg/v1/webstores/{storeId}/templates/{templateId}" \
-H "Authorization: APIKey TOKEN" \
-H "Content-Type: application/json" \
-d '{
"compatibility_mode": "invalid",
"name": "string"
}'import { createManagementClient } from "@paynow-gg/typescript-sdk";
const paynow = createManagementClient({
apiKey: "API_KEY",
storeId: "STORE_ID",
});
const result = await paynow.webstore.updateWebstoreTemplate("411486491630370816", {
compatibility_mode: "invalid",
name: "string",
});import requests
headers = {"Authorization": "APIKey TOKEN"}
payload = {
"compatibility_mode": "invalid",
"name": "string",
}
response = requests.put("https://api.paynow.gg/v1/webstores/{storeId}/templates/{templateId}", headers=headers, json=payload)Response200
{
"id": "411486491630370816",
"compatibility_mode": "invalid",
"created_at": "2024-01-01T00:00:00Z",
"is_public": true,
"name": "string",
"updated_at": "2024-01-01T00:00:00Z",
"webstore_id": "411486491630370816",
"template_files": [
{
"id": "411486491630370816",
"content_type": "string",
"created_at": "2024-01-01T00:00:00Z",
"file_name": "string",
"is_deletable": true,
"is_public": true,
"template_id": "411486491630370816",
"updated_at": "2024-01-01T00:00:00Z",
"content": "string"
}
]
}Headers
AuthorizationAPI KeyRequired
Authentication token for this request, sent as
Authorization: APIKey TOKEN.Path parameters
storeIdFlakeIdRequired
templateIdFlakeIdRequired
curl -X DELETE "https://api.paynow.gg/v1/webstores/{storeId}/templates/{templateId}" \
-H "Authorization: APIKey TOKEN"import { createManagementClient } from "@paynow-gg/typescript-sdk";
const paynow = createManagementClient({
apiKey: "API_KEY",
storeId: "STORE_ID",
});
await paynow.webstore.deleteWebstoreTemplate("411486491630370816");import requests
headers = {"Authorization": "APIKey TOKEN"}
response = requests.delete("https://api.paynow.gg/v1/webstores/{storeId}/templates/{templateId}", headers=headers)Get Webstore Template Latest Version
GEThttps://api.paynow.gg/v1/webstores/{storeId}/templates/{templateId}/update
Headers
AuthorizationAPI KeyRequired
Authentication token for this request, sent as
Authorization: APIKey TOKEN.Path parameters
storeIdFlakeIdRequired
templateIdFlakeIdRequired
Response
200OKWebstoreTemplateLatestVersionDto
Show fieldsHide fields
versionstringOptional
Failed requests return a PayNowError body. See the error response guide.
curl -X GET "https://api.paynow.gg/v1/webstores/{storeId}/templates/{templateId}/update" \
-H "Authorization: APIKey TOKEN"import { createManagementClient } from "@paynow-gg/typescript-sdk";
const paynow = createManagementClient({
apiKey: "API_KEY",
storeId: "STORE_ID",
});
const result = await paynow.webstore.getWebstoreTemplateLatestVersion("411486491630370816");import requests
headers = {"Authorization": "APIKey TOKEN"}
response = requests.get("https://api.paynow.gg/v1/webstores/{storeId}/templates/{templateId}/update", headers=headers)Response200
{
"version": "string"
}Download Webstore Template Update
POSThttps://api.paynow.gg/v1/webstores/{storeId}/templates/{templateId}/update
Headers
AuthorizationAPI KeyRequired
Authentication token for this request, sent as
Authorization: APIKey TOKEN.Path parameters
storeIdFlakeIdRequired
templateIdFlakeIdRequired
curl -X POST "https://api.paynow.gg/v1/webstores/{storeId}/templates/{templateId}/update" \
-H "Authorization: APIKey TOKEN"import { createManagementClient } from "@paynow-gg/typescript-sdk";
const paynow = createManagementClient({
apiKey: "API_KEY",
storeId: "STORE_ID",
});
await paynow.webstore.downloadWebstoreTemplateUpdate("411486491630370816");import requests
headers = {"Authorization": "APIKey TOKEN"}
response = requests.post("https://api.paynow.gg/v1/webstores/{storeId}/templates/{templateId}/update", headers=headers)Get Webstore Template Schema
GEThttps://api.paynow.gg/v1/webstores/{storeId}/templates/{templateId}/schema
Headers
AuthorizationAPI KeyRequired
Authentication token for this request, sent as
Authorization: APIKey TOKEN.Path parameters
storeIdFlakeIdRequired
templateIdFlakeIdRequired
Response
200OKWebstoreTemplateSchemaDto
Show fieldsHide fields
authorstringRequired
configWebstoreTemplateSchemaSectionDto[]Required
headerstringRequired
optionsWebstoreTemplateSchemaOptionDto[]Required
idstringRequired
namestringRequired
nested_optionsWebstoreTemplateSchemaOptionDto[]Required
→ WebstoreTemplateSchemaOptionDtotypestringRequired
valuesstring[]Required
defaultnullOptional
descriptionstringOptional
maxnumberOptional
minnumberOptional
multilinebooleanOptional
numericbooleanOptional
support_emailstringOptional
support_urlstringOptional
updatesWebstoreTemplateSchemaUpdatesDtoOptional
github_branchstringRequired
supportedbooleanRequired
version_check_supportedbooleanRequired
github_tokenstringOptional
github_urlstringOptional
versionstringOptional
Failed requests return a PayNowError body. See the error response guide.
curl -X GET "https://api.paynow.gg/v1/webstores/{storeId}/templates/{templateId}/schema" \
-H "Authorization: APIKey TOKEN"import { createManagementClient } from "@paynow-gg/typescript-sdk";
const paynow = createManagementClient({
apiKey: "API_KEY",
storeId: "STORE_ID",
});
const result = await paynow.webstore.getWebstoreTemplateSchema("411486491630370816");import requests
headers = {"Authorization": "APIKey TOKEN"}
response = requests.get("https://api.paynow.gg/v1/webstores/{storeId}/templates/{templateId}/schema", headers=headers)Response200
{
"author": "string",
"config": [
{
"header": "string",
"options": [
{
"id": "string",
"name": "string",
"nested_options": [
{}
],
"type": "string",
"values": [
"string"
],
"default": {},
"description": "string",
"max": 0,
"min": 0,
"multiline": true,
"numeric": true
}
]
}
],
"support_email": "string",
"support_url": "string",
"updates": {
"github_branch": "string",
"supported": true,
"version_check_supported": true,
"github_token": "string",
"github_url": "string",
"version": "string"
}
}Update Webstore Template Schema Variables
PUThttps://api.paynow.gg/v1/webstores/{storeId}/templates/{templateId}/schema/variables
Headers
AuthorizationAPI KeyRequired
Authentication token for this request, sent as
Authorization: APIKey TOKEN.Path parameters
storeIdFlakeIdRequired
templateIdFlakeIdRequired
Request body
bodyobjectOptional
curl -X PUT "https://api.paynow.gg/v1/webstores/{storeId}/templates/{templateId}/schema/variables" \
-H "Authorization: APIKey TOKEN" \
-H "Content-Type: application/json" \
-d '{}'import { createManagementClient } from "@paynow-gg/typescript-sdk";
const paynow = createManagementClient({
apiKey: "API_KEY",
storeId: "STORE_ID",
});
await paynow.webstore.updateWebstoreTemplateSchemaVariables("411486491630370816", {});import requests
headers = {"Authorization": "APIKey TOKEN"}
payload = {}
response = requests.put("https://api.paynow.gg/v1/webstores/{storeId}/templates/{templateId}/schema/variables", headers=headers, json=payload)Duplicate Webstore Template
POSThttps://api.paynow.gg/v1/webstores/{storeId}/templates/{templateId}/duplicate
Headers
AuthorizationAPI KeyRequired
Authentication token for this request, sent as
Authorization: APIKey TOKEN.Path parameters
storeIdFlakeIdRequired
templateIdFlakeIdRequired
Response
200OKWebstoreTemplateDto
Show fieldsHide fields
idFlakeIdRequired
compatibility_modeenumRequired
Possible enum values
invalidpaynowtebex
created_atstringRequired
is_publicbooleanRequired
namestringRequired
updated_atstringRequired
webstore_idFlakeIdRequired
template_filesWebstoreTemplateFileDto[]Optional
idFlakeIdRequired
content_typestringRequired
created_atstringRequired
file_namestringRequired
is_deletablebooleanRequired
is_publicbooleanRequired
template_idFlakeIdRequired
updated_atstringRequired
contentstringOptional
Failed requests return a PayNowError body. See the error response guide.
curl -X POST "https://api.paynow.gg/v1/webstores/{storeId}/templates/{templateId}/duplicate" \
-H "Authorization: APIKey TOKEN"import { createManagementClient } from "@paynow-gg/typescript-sdk";
const paynow = createManagementClient({
apiKey: "API_KEY",
storeId: "STORE_ID",
});
const result = await paynow.webstore.duplicateWebstoreTemplate("411486491630370816");import requests
headers = {"Authorization": "APIKey TOKEN"}
response = requests.post("https://api.paynow.gg/v1/webstores/{storeId}/templates/{templateId}/duplicate", headers=headers)Response200
{
"id": "411486491630370816",
"compatibility_mode": "invalid",
"created_at": "2024-01-01T00:00:00Z",
"is_public": true,
"name": "string",
"updated_at": "2024-01-01T00:00:00Z",
"webstore_id": "411486491630370816",
"template_files": [
{
"id": "411486491630370816",
"content_type": "string",
"created_at": "2024-01-01T00:00:00Z",
"file_name": "string",
"is_deletable": true,
"is_public": true,
"template_id": "411486491630370816",
"updated_at": "2024-01-01T00:00:00Z",
"content": "string"
}
]
}Get Webstore Template Archive
GEThttps://api.paynow.gg/v1/webstores/{storeId}/templates/{templateId}/archive
Headers
AuthorizationAPI KeyRequired
Authentication token for this request, sent as
Authorization: APIKey TOKEN.Path parameters
storeIdFlakeIdRequired
templateIdFlakeIdRequired
Response
200OKGetWebstoreTemplateArchiveResponseDto
Show fieldsHide fields
download_urlstringRequired
Failed requests return a PayNowError body. See the error response guide.
curl -X GET "https://api.paynow.gg/v1/webstores/{storeId}/templates/{templateId}/archive" \
-H "Authorization: APIKey TOKEN"import { createManagementClient } from "@paynow-gg/typescript-sdk";
const paynow = createManagementClient({
apiKey: "API_KEY",
storeId: "STORE_ID",
});
const result = await paynow.webstore.getWebstoreTemplateArchive("411486491630370816");import requests
headers = {"Authorization": "APIKey TOKEN"}
response = requests.get("https://api.paynow.gg/v1/webstores/{storeId}/templates/{templateId}/archive", headers=headers)Response200
{
"download_url": "string"
}Get Webstore Template Upload Url
GEThttps://api.paynow.gg/v1/webstores/{storeId}/templates/{templateId}/upload_url
Headers
AuthorizationAPI KeyRequired
Authentication token for this request, sent as
Authorization: APIKey TOKEN.Path parameters
storeIdFlakeIdRequired
templateIdFlakeIdRequired
Query parameters
content_lengthintegerOptional
Response
200OKGetWebstoreTemplateUploadUrlResponseDto
Show fieldsHide fields
upload_urlstringRequired
Failed requests return a PayNowError body. See the error response guide.
curl -X GET "https://api.paynow.gg/v1/webstores/{storeId}/templates/{templateId}/upload_url" \
-H "Authorization: APIKey TOKEN"import { createManagementClient } from "@paynow-gg/typescript-sdk";
const paynow = createManagementClient({
apiKey: "API_KEY",
storeId: "STORE_ID",
});
const result = await paynow.webstore.getWebstoreTemplateUploadUrl("411486491630370816");import requests
headers = {"Authorization": "APIKey TOKEN"}
response = requests.get("https://api.paynow.gg/v1/webstores/{storeId}/templates/{templateId}/upload_url", headers=headers)Response200
{
"upload_url": "string"
}Finish Webstore Template Upload
POSThttps://api.paynow.gg/v1/webstores/{storeId}/templates/{templateId}/upload_finish
Headers
AuthorizationAPI KeyRequired
Authentication token for this request, sent as
Authorization: APIKey TOKEN.Path parameters
storeIdFlakeIdRequired
templateIdFlakeIdRequired
Response
200OKFinishWebstoreTemplateUploadResponseDto
Show fieldsHide fields
failed_filesstring[]Required
Failed requests return a PayNowError body. See the error response guide.
curl -X POST "https://api.paynow.gg/v1/webstores/{storeId}/templates/{templateId}/upload_finish" \
-H "Authorization: APIKey TOKEN"import { createManagementClient } from "@paynow-gg/typescript-sdk";
const paynow = createManagementClient({
apiKey: "API_KEY",
storeId: "STORE_ID",
});
const result = await paynow.webstore.finishWebstoreTemplateUpload("411486491630370816");import requests
headers = {"Authorization": "APIKey TOKEN"}
response = requests.post("https://api.paynow.gg/v1/webstores/{storeId}/templates/{templateId}/upload_finish", headers=headers)Response200
{
"failed_files": [
"string"
]
}Preview Webstore Template
GEThttps://api.paynow.gg/v1/webstores/{storeId}/templates/{templateId}/preview
Headers
AuthorizationAPI KeyRequired
Authentication token for this request, sent as
Authorization: APIKey TOKEN.Path parameters
storeIdFlakeIdRequired
templateIdFlakeIdRequired
Response
200OKWebstoreTemplatePreviewResponseDto
Show fieldsHide fields
templateWebstoreTemplatePreviewDtoRequired
compatibilityModeenumRequired
Possible enum values
invalidpaynowtebex
compiledWebstoreTemplateCompiledFileDto[]Required
content_typestringRequired
file_namestringRequired
compiledstringOptional
errorstringOptional
compiled_atstringRequired
schemaWebstoreTemplateSchemaDtoOptional
authorstringRequired
configWebstoreTemplateSchemaSectionDto[]Required
→ WebstoreTemplateSchemaSectionDtosupport_emailstringOptional
support_urlstringOptional
updatesWebstoreTemplateSchemaUpdatesDtoOptional
→ WebstoreTemplateSchemaUpdatesDtovariablesWebstoreTemplatePreviewVariablesDtoRequired
saved_atstringRequired
variablesWebstoreTemplateVariableDto[]Required
idFlakeIdRequired
created_atstringRequired
namestringRequired
template_idFlakeIdRequired
typeenumRequired
Possible enum values
invalidstringhtmlnumberbooleanjson
updated_atstringRequired
valuestringRequired
variablestringRequired
webstore_idFlakeIdRequired
Failed requests return a PayNowError body. See the error response guide.
curl -X GET "https://api.paynow.gg/v1/webstores/{storeId}/templates/{templateId}/preview" \
-H "Authorization: APIKey TOKEN"import { createManagementClient } from "@paynow-gg/typescript-sdk";
const paynow = createManagementClient({
apiKey: "API_KEY",
storeId: "STORE_ID",
});
const result = await paynow.webstore.previewWebstoreTemplate("411486491630370816");import requests
headers = {"Authorization": "APIKey TOKEN"}
response = requests.get("https://api.paynow.gg/v1/webstores/{storeId}/templates/{templateId}/preview", headers=headers)Response200
{
"template": {
"compatibilityMode": "invalid",
"compiled": [
{
"content_type": "string",
"file_name": "string",
"compiled": "string",
"error": "string"
}
],
"compiled_at": "2024-01-01T00:00:00Z",
"schema": {
"author": "string",
"config": [
{
"header": "string",
"options": [
{
"id": "string",
"name": "string",
"nested_options": [
{}
],
"type": "string",
"values": [
"string"
],
"default": {},
"description": "string",
"max": 0,
"min": 0,
"multiline": true,
"numeric": true
}
]
}
],
"support_email": "string",
"support_url": "string",
"updates": {
"github_branch": "string",
"supported": true,
"version_check_supported": true,
"github_token": "string",
"github_url": "string",
"version": "string"
}
}
},
"variables": {
"saved_at": "2024-01-01T00:00:00Z",
"variables": [
{
"id": "411486491630370816",
"created_at": "2024-01-01T00:00:00Z",
"name": "string",
"template_id": "411486491630370816",
"type": "invalid",
"updated_at": "2024-01-01T00:00:00Z",
"value": "string",
"variable": "string",
"webstore_id": "411486491630370816"
}
]
}
}Get Webstore Template Variables
GEThttps://api.paynow.gg/v1/webstores/{storeId}/templates/{templateId}/variables
Headers
AuthorizationAPI KeyRequired
Authentication token for this request, sent as
Authorization: APIKey TOKEN.Path parameters
storeIdFlakeIdRequired
templateIdFlakeIdRequired
Response
200OKWebstoreTemplateVariableDto[]
Show fieldsHide fields
idFlakeIdRequired
created_atstringRequired
namestringRequired
template_idFlakeIdRequired
typeenumRequired
Possible enum values
invalidstringhtmlnumberbooleanjson
updated_atstringRequired
valuestringRequired
variablestringRequired
webstore_idFlakeIdRequired
Failed requests return a PayNowError body. See the error response guide.
curl -X GET "https://api.paynow.gg/v1/webstores/{storeId}/templates/{templateId}/variables" \
-H "Authorization: APIKey TOKEN"import { createManagementClient } from "@paynow-gg/typescript-sdk";
const paynow = createManagementClient({
apiKey: "API_KEY",
storeId: "STORE_ID",
});
const result = await paynow.webstore.getWebstoreTemplateVariables("411486491630370816");import requests
headers = {"Authorization": "APIKey TOKEN"}
response = requests.get("https://api.paynow.gg/v1/webstores/{storeId}/templates/{templateId}/variables", headers=headers)Response200
[
{
"id": "411486491630370816",
"created_at": "2024-01-01T00:00:00Z",
"name": "string",
"template_id": "411486491630370816",
"type": "invalid",
"updated_at": "2024-01-01T00:00:00Z",
"value": "string",
"variable": "string",
"webstore_id": "411486491630370816"
}
]Create Webstore Template Variable
PUThttps://api.paynow.gg/v1/webstores/{storeId}/templates/{templateId}/variables
Headers
AuthorizationAPI KeyRequired
Authentication token for this request, sent as
Authorization: APIKey TOKEN.Path parameters
storeIdFlakeIdRequired
templateIdFlakeIdRequired
Request body
namestringRequired
typeenumRequired
Possible enum values
invalidstringhtmlnumberbooleanjson
valuestringRequired
variablestringRequired
Response
200OKWebstoreTemplateVariableDto
Show fieldsHide fields
idFlakeIdRequired
created_atstringRequired
namestringRequired
template_idFlakeIdRequired
typeenumRequired
Possible enum values
invalidstringhtmlnumberbooleanjson
updated_atstringRequired
valuestringRequired
variablestringRequired
webstore_idFlakeIdRequired
Failed requests return a PayNowError body. See the error response guide.
curl -X PUT "https://api.paynow.gg/v1/webstores/{storeId}/templates/{templateId}/variables" \
-H "Authorization: APIKey TOKEN" \
-H "Content-Type: application/json" \
-d '{
"name": "string",
"type": "invalid",
"value": "string",
"variable": "string"
}'import { createManagementClient } from "@paynow-gg/typescript-sdk";
const paynow = createManagementClient({
apiKey: "API_KEY",
storeId: "STORE_ID",
});
const result = await paynow.webstore.createWebstoreTemplateVariable("411486491630370816", {
name: "string",
type: "invalid",
value: "string",
variable: "string",
});import requests
headers = {"Authorization": "APIKey TOKEN"}
payload = {
"name": "string",
"type": "invalid",
"value": "string",
"variable": "string",
}
response = requests.put("https://api.paynow.gg/v1/webstores/{storeId}/templates/{templateId}/variables", headers=headers, json=payload)Response200
{
"id": "411486491630370816",
"created_at": "2024-01-01T00:00:00Z",
"name": "string",
"template_id": "411486491630370816",
"type": "invalid",
"updated_at": "2024-01-01T00:00:00Z",
"value": "string",
"variable": "string",
"webstore_id": "411486491630370816"
}Update Webstore Template Variable
PUThttps://api.paynow.gg/v1/webstores/{storeId}/templates/{templateId}/variables/{templateVariableId}
Headers
AuthorizationAPI KeyRequired
Authentication token for this request, sent as
Authorization: APIKey TOKEN.Path parameters
storeIdFlakeIdRequired
templateIdFlakeIdRequired
templateVariableIdFlakeIdRequired
Request body
namestringRequired
typeenumRequired
Possible enum values
invalidstringhtmlnumberbooleanjson
valuestringRequired
variablestringRequired
Response
200OKWebstoreTemplateVariableDto
Show fieldsHide fields
idFlakeIdRequired
created_atstringRequired
namestringRequired
template_idFlakeIdRequired
typeenumRequired
Possible enum values
invalidstringhtmlnumberbooleanjson
updated_atstringRequired
valuestringRequired
variablestringRequired
webstore_idFlakeIdRequired
Failed requests return a PayNowError body. See the error response guide.
curl -X PUT "https://api.paynow.gg/v1/webstores/{storeId}/templates/{templateId}/variables/{templateVariableId}" \
-H "Authorization: APIKey TOKEN" \
-H "Content-Type: application/json" \
-d '{
"name": "string",
"type": "invalid",
"value": "string",
"variable": "string"
}'import { createManagementClient } from "@paynow-gg/typescript-sdk";
const paynow = createManagementClient({
apiKey: "API_KEY",
storeId: "STORE_ID",
});
const result = await paynow.webstore.updateWebstoreTemplateVariable("411486491630370816", "411486491630370816", {
name: "string",
type: "invalid",
value: "string",
variable: "string",
});import requests
headers = {"Authorization": "APIKey TOKEN"}
payload = {
"name": "string",
"type": "invalid",
"value": "string",
"variable": "string",
}
response = requests.put("https://api.paynow.gg/v1/webstores/{storeId}/templates/{templateId}/variables/{templateVariableId}", headers=headers, json=payload)Response200
{
"id": "411486491630370816",
"created_at": "2024-01-01T00:00:00Z",
"name": "string",
"template_id": "411486491630370816",
"type": "invalid",
"updated_at": "2024-01-01T00:00:00Z",
"value": "string",
"variable": "string",
"webstore_id": "411486491630370816"
}Delete Webstore Template Variable
DELETEhttps://api.paynow.gg/v1/webstores/{storeId}/templates/{templateId}/variables/{templateVariableId}
Headers
AuthorizationAPI KeyRequired
Authentication token for this request, sent as
Authorization: APIKey TOKEN.Path parameters
storeIdFlakeIdRequired
templateIdFlakeIdRequired
templateVariableIdFlakeIdRequired
curl -X DELETE "https://api.paynow.gg/v1/webstores/{storeId}/templates/{templateId}/variables/{templateVariableId}" \
-H "Authorization: APIKey TOKEN"import { createManagementClient } from "@paynow-gg/typescript-sdk";
const paynow = createManagementClient({
apiKey: "API_KEY",
storeId: "STORE_ID",
});
await paynow.webstore.deleteWebstoreTemplateVariable("411486491630370816", "411486491630370816");import requests
headers = {"Authorization": "APIKey TOKEN"}
response = requests.delete("https://api.paynow.gg/v1/webstores/{storeId}/templates/{templateId}/variables/{templateVariableId}", headers=headers)