Discord
Get Actions
GEThttps://api.paynow.gg/v1/stores/{storeId}/product_versions/{productVersionId}/discord_actions
Headers
AuthorizationAPI KeyRequired
Authentication token for this request, sent as
Authorization: APIKey TOKEN.Path parameters
storeIdFlakeIdRequired
productVersionIdFlakeIdRequired
Response
200OKDiscordActionDto[]
Show fieldsHide fields
action_typeenumRequired
Possible enum values
persist_rolesend_messageban_userkick_usergenerate_invite_link
discord_server_idFlakeIdRequired
execution_stageenumRequired
Possible enum values
on_purchaseon_expireon_refundon_chargeback
idFlakeIdRequired
product_idFlakeIdRequired
product_version_idFlakeIdRequired
revocation_stagesenum[]Required
Possible enum values
on_expireon_refundon_chargeback
store_idFlakeIdRequired
channel_idFlakeIdOptional
messagestringOptional
role_idFlakeIdOptional
Failed requests return a PayNowError body. See the error response guide.
curl -X GET "https://api.paynow.gg/v1/stores/{storeId}/product_versions/{productVersionId}/discord_actions" \
-H "Authorization: APIKey TOKEN"import { createManagementClient } from "@paynow-gg/typescript-sdk";
const paynow = createManagementClient({
apiKey: "API_KEY",
storeId: "STORE_ID",
});
const result = await paynow.discord.getActions("411486491630370816");import requests
headers = {"Authorization": "APIKey TOKEN"}
response = requests.get("https://api.paynow.gg/v1/stores/{storeId}/product_versions/{productVersionId}/discord_actions", headers=headers)Response200
[
{
"action_type": "persist_role",
"discord_server_id": "411486491630370816",
"execution_stage": "on_purchase",
"id": "411486491630370816",
"product_id": "411486491630370816",
"product_version_id": "411486491630370816",
"revocation_stages": [
"on_expire"
],
"store_id": "411486491630370816",
"channel_id": "411486491630370816",
"role_id": "411486491630370816",
"message": "string"
}
]Create Action
PUThttps://api.paynow.gg/v1/stores/{storeId}/product_versions/{productVersionId}/discord_actions
Headers
AuthorizationAPI KeyRequired
Authentication token for this request, sent as
Authorization: APIKey TOKEN.Path parameters
storeIdFlakeIdRequired
productVersionIdFlakeIdRequired
Request body
action_typeenumRequired
Possible enum values
persist_rolesend_messageban_userkick_usergenerate_invite_link
discord_server_idFlakeIdRequired
execution_stageenumRequired
Possible enum values
on_purchaseon_expireon_refundon_chargeback
channel_idFlakeIdOptional
messagestringOptional
revocation_stagesenum[]Optional
Possible enum values
on_expireon_refundon_chargeback
role_idFlakeIdOptional
Response
200OKDiscordActionDto
Show fieldsHide fields
action_typeenumRequired
Possible enum values
persist_rolesend_messageban_userkick_usergenerate_invite_link
discord_server_idFlakeIdRequired
execution_stageenumRequired
Possible enum values
on_purchaseon_expireon_refundon_chargeback
idFlakeIdRequired
product_idFlakeIdRequired
product_version_idFlakeIdRequired
revocation_stagesenum[]Required
Possible enum values
on_expireon_refundon_chargeback
store_idFlakeIdRequired
channel_idFlakeIdOptional
messagestringOptional
role_idFlakeIdOptional
Failed requests return a PayNowError body. See the error response guide.
curl -X PUT "https://api.paynow.gg/v1/stores/{storeId}/product_versions/{productVersionId}/discord_actions" \
-H "Authorization: APIKey TOKEN" \
-H "Content-Type: application/json" \
-d '[
{
"action_type": "persist_role",
"discord_server_id": "411486491630370816",
"execution_stage": "on_purchase",
"revocation_stages": [
"on_expire"
],
"channel_id": "411486491630370816",
"role_id": "411486491630370816",
"message": "string"
}
]'import { createManagementClient } from "@paynow-gg/typescript-sdk";
const paynow = createManagementClient({
apiKey: "API_KEY",
storeId: "STORE_ID",
});
const result = await paynow.discord.createAction("411486491630370816", [
{
action_type: "persist_role",
discord_server_id: "411486491630370816",
execution_stage: "on_purchase",
revocation_stages: [
"on_expire",
],
channel_id: "411486491630370816",
role_id: "411486491630370816",
message: "string",
},
]);import requests
headers = {"Authorization": "APIKey TOKEN"}
payload = [
{
"action_type": "persist_role",
"discord_server_id": "411486491630370816",
"execution_stage": "on_purchase",
"revocation_stages": [
"on_expire",
],
"channel_id": "411486491630370816",
"role_id": "411486491630370816",
"message": "string",
},
]
response = requests.put("https://api.paynow.gg/v1/stores/{storeId}/product_versions/{productVersionId}/discord_actions", headers=headers, json=payload)Response200
{
"action_type": "persist_role",
"discord_server_id": "411486491630370816",
"execution_stage": "on_purchase",
"id": "411486491630370816",
"product_id": "411486491630370816",
"product_version_id": "411486491630370816",
"revocation_stages": [
"on_expire"
],
"store_id": "411486491630370816",
"channel_id": "411486491630370816",
"role_id": "411486491630370816",
"message": "string"
}Headers
AuthorizationAPI KeyRequired
Authentication token for this request, sent as
Authorization: APIKey TOKEN.Path parameters
storeIdFlakeIdRequired
orderIdFlakeIdRequired
curl -X GET "https://api.paynow.gg/v1/stores/{storeId}/orders/{orderId}/discord" \
-H "Authorization: APIKey TOKEN"import { createManagementClient } from "@paynow-gg/typescript-sdk";
const paynow = createManagementClient({
apiKey: "API_KEY",
storeId: "STORE_ID",
});
const result = await paynow.discord.getLinkedDiscordAccounts("411486491630370816");import requests
headers = {"Authorization": "APIKey TOKEN"}
response = requests.get("https://api.paynow.gg/v1/stores/{storeId}/orders/{orderId}/discord", headers=headers)Response200
{}Get Discord Action Execution History
GEThttps://api.paynow.gg/v1/stores/{storeId}/orders/{orderId}/discord/queued
Headers
AuthorizationAPI KeyRequired
Authentication token for this request, sent as
Authorization: APIKey TOKEN.Path parameters
storeIdFlakeIdRequired
orderIdFlakeIdRequired
Response
200OKQueuedDiscordActionDto[]
Show fieldsHide fields
action_typeenumRequired
Possible enum values
persist_rolesend_messageban_userkick_usergenerate_invite_link
delivery_item_idFlakeIdRequired
discord_server_idFlakeIdRequired
enqueued_atstringRequired
execution_stageenumRequired
Possible enum values
on_purchaseon_expireon_refundon_chargeback
executionsQueuedDiscordActionExecutionDto[]Required
executed_atstringRequired
execution_statusenumRequired
Possible enum values
successfailure
idintegerRequired
queue_idintegerRequired
messagestringOptional
trace_idstringOptional
idintegerRequired
product_idFlakeIdRequired
product_version_idFlakeIdRequired
revocation_stagesenum[]Required
Possible enum values
on_expireon_refundon_chargeback
statusenumRequired
Possible enum values
activecompleteerroredcanceled
store_idFlakeIdRequired
channel_idFlakeIdOptional
checkout_idFlakeIdOptional
checkout_line_idFlakeIdOptional
discord_user_idFlakeIdOptional
finalised_atstringOptional
messagestringOptional
order_idFlakeIdOptional
role_idFlakeIdOptional
Failed requests return a PayNowError body. See the error response guide.
curl -X GET "https://api.paynow.gg/v1/stores/{storeId}/orders/{orderId}/discord/queued" \
-H "Authorization: APIKey TOKEN"import { createManagementClient } from "@paynow-gg/typescript-sdk";
const paynow = createManagementClient({
apiKey: "API_KEY",
storeId: "STORE_ID",
});
const result = await paynow.discord.getDiscordActionExecutionHistory("411486491630370816");import requests
headers = {"Authorization": "APIKey TOKEN"}
response = requests.get("https://api.paynow.gg/v1/stores/{storeId}/orders/{orderId}/discord/queued", headers=headers)Response200
[
{
"action_type": "persist_role",
"delivery_item_id": "411486491630370816",
"discord_server_id": "411486491630370816",
"enqueued_at": "2024-01-01T00:00:00Z",
"execution_stage": "on_purchase",
"executions": [
{
"executed_at": "2024-01-01T00:00:00Z",
"execution_status": "success",
"id": 0,
"queue_id": 0,
"message": "string",
"trace_id": "string"
}
],
"id": 0,
"product_id": "411486491630370816",
"product_version_id": "411486491630370816",
"revocation_stages": [
"on_expire"
],
"status": "active",
"store_id": "411486491630370816",
"order_id": "411486491630370816",
"checkout_id": "411486491630370816",
"checkout_line_id": "411486491630370816",
"discord_user_id": "411486491630370816",
"channel_id": "411486491630370816",
"role_id": "411486491630370816",
"message": "string",
"finalised_at": "2024-01-01T00:00:00Z"
}
]Get Queued Discord Action For Delivery Item
GEThttps://api.paynow.gg/v1/stores/{storeId}/inventory/{inventoryItemId}/discord/queued
Headers
AuthorizationAPI KeyRequired
Authentication token for this request, sent as
Authorization: APIKey TOKEN.Path parameters
storeIdFlakeIdRequired
inventoryItemIdFlakeIdRequired
Response
200OKQueuedDiscordActionDto[]
Show fieldsHide fields
action_typeenumRequired
Possible enum values
persist_rolesend_messageban_userkick_usergenerate_invite_link
delivery_item_idFlakeIdRequired
discord_server_idFlakeIdRequired
enqueued_atstringRequired
execution_stageenumRequired
Possible enum values
on_purchaseon_expireon_refundon_chargeback
executionsQueuedDiscordActionExecutionDto[]Required
executed_atstringRequired
execution_statusenumRequired
Possible enum values
successfailure
idintegerRequired
queue_idintegerRequired
messagestringOptional
trace_idstringOptional
idintegerRequired
product_idFlakeIdRequired
product_version_idFlakeIdRequired
revocation_stagesenum[]Required
Possible enum values
on_expireon_refundon_chargeback
statusenumRequired
Possible enum values
activecompleteerroredcanceled
store_idFlakeIdRequired
channel_idFlakeIdOptional
checkout_idFlakeIdOptional
checkout_line_idFlakeIdOptional
discord_user_idFlakeIdOptional
finalised_atstringOptional
messagestringOptional
order_idFlakeIdOptional
role_idFlakeIdOptional
Failed requests return a PayNowError body. See the error response guide.
curl -X GET "https://api.paynow.gg/v1/stores/{storeId}/inventory/{inventoryItemId}/discord/queued" \
-H "Authorization: APIKey TOKEN"import { createManagementClient } from "@paynow-gg/typescript-sdk";
const paynow = createManagementClient({
apiKey: "API_KEY",
storeId: "STORE_ID",
});
const result = await paynow.discord.getQueuedDiscordActionForDeliveryItem("411486491630370816");import requests
headers = {"Authorization": "APIKey TOKEN"}
response = requests.get("https://api.paynow.gg/v1/stores/{storeId}/inventory/{inventoryItemId}/discord/queued", headers=headers)Response200
[
{
"action_type": "persist_role",
"delivery_item_id": "411486491630370816",
"discord_server_id": "411486491630370816",
"enqueued_at": "2024-01-01T00:00:00Z",
"execution_stage": "on_purchase",
"executions": [
{
"executed_at": "2024-01-01T00:00:00Z",
"execution_status": "success",
"id": 0,
"queue_id": 0,
"message": "string",
"trace_id": "string"
}
],
"id": 0,
"product_id": "411486491630370816",
"product_version_id": "411486491630370816",
"revocation_stages": [
"on_expire"
],
"status": "active",
"store_id": "411486491630370816",
"order_id": "411486491630370816",
"checkout_id": "411486491630370816",
"checkout_line_id": "411486491630370816",
"discord_user_id": "411486491630370816",
"channel_id": "411486491630370816",
"role_id": "411486491630370816",
"message": "string",
"finalised_at": "2024-01-01T00:00:00Z"
}
]Get User To Delivery Item Links
GEThttps://api.paynow.gg/v1/stores/{storeId}/inventory/{inventoryItemId}/discord/link
Headers
AuthorizationAPI KeyRequired
Authentication token for this request, sent as
Authorization: APIKey TOKEN.Path parameters
storeIdFlakeIdRequired
inventoryItemIdFlakeIdRequired
Response
200OKDiscordProfileDto
Show fieldsHide fields
avatar_hashstringRequired
discord_idFlakeIdRequired
usernamestringRequired
Failed requests return a PayNowError body. See the error response guide.
curl -X GET "https://api.paynow.gg/v1/stores/{storeId}/inventory/{inventoryItemId}/discord/link" \
-H "Authorization: APIKey TOKEN"import { createManagementClient } from "@paynow-gg/typescript-sdk";
const paynow = createManagementClient({
apiKey: "API_KEY",
storeId: "STORE_ID",
});
const result = await paynow.discord.getUserToDeliveryItemLinks("411486491630370816");import requests
headers = {"Authorization": "APIKey TOKEN"}
response = requests.get("https://api.paynow.gg/v1/stores/{storeId}/inventory/{inventoryItemId}/discord/link", headers=headers)Response200
{
"avatar_hash": "string",
"discord_id": "411486491630370816",
"username": "string"
}Set User To Delivery Item Link
PUThttps://api.paynow.gg/v1/stores/{storeId}/inventory/{inventoryItemId}/discord/link
Headers
AuthorizationAPI KeyRequired
Authentication token for this request, sent as
Authorization: APIKey TOKEN.Path parameters
storeIdFlakeIdRequired
inventoryItemIdFlakeIdRequired
Query parameters
discordUserIdintegerOptional
curl -X PUT "https://api.paynow.gg/v1/stores/{storeId}/inventory/{inventoryItemId}/discord/link" \
-H "Authorization: APIKey TOKEN"import { createManagementClient } from "@paynow-gg/typescript-sdk";
const paynow = createManagementClient({
apiKey: "API_KEY",
storeId: "STORE_ID",
});
await paynow.discord.setUserToDeliveryItemLink("411486491630370816");import requests
headers = {"Authorization": "APIKey TOKEN"}
response = requests.put("https://api.paynow.gg/v1/stores/{storeId}/inventory/{inventoryItemId}/discord/link", headers=headers)Delete User To Delivery Item Link
DELETEhttps://api.paynow.gg/v1/stores/{storeId}/inventory/{inventoryItemId}/discord/link
Headers
AuthorizationAPI KeyRequired
Authentication token for this request, sent as
Authorization: APIKey TOKEN.Path parameters
storeIdFlakeIdRequired
inventoryItemIdFlakeIdRequired
curl -X DELETE "https://api.paynow.gg/v1/stores/{storeId}/inventory/{inventoryItemId}/discord/link" \
-H "Authorization: APIKey TOKEN"import { createManagementClient } from "@paynow-gg/typescript-sdk";
const paynow = createManagementClient({
apiKey: "API_KEY",
storeId: "STORE_ID",
});
await paynow.discord.deleteUserToDeliveryItemLink("411486491630370816");import requests
headers = {"Authorization": "APIKey TOKEN"}
response = requests.delete("https://api.paynow.gg/v1/stores/{storeId}/inventory/{inventoryItemId}/discord/link", headers=headers)Headers
AuthorizationAPI KeyRequired
Authentication token for this request, sent as
Authorization: APIKey TOKEN.Path parameters
storeIdFlakeIdRequired
Response
200OKDiscordServerLinkDto[]
Show fieldsHide fields
created_atstringRequired
store_idFlakeIdRequired
tokenstringRequired
linked_atstringOptional
server_icon_urlstringOptional
server_idFlakeIdOptional
server_namestringOptional
Failed requests return a PayNowError body. See the error response guide.
curl -X GET "https://api.paynow.gg/v1/stores/{storeId}/discord/links" \
-H "Authorization: APIKey TOKEN"import { createManagementClient } from "@paynow-gg/typescript-sdk";
const paynow = createManagementClient({
apiKey: "API_KEY",
storeId: "STORE_ID",
});
const result = await paynow.discord.getDiscordServerLinks();import requests
headers = {"Authorization": "APIKey TOKEN"}
response = requests.get("https://api.paynow.gg/v1/stores/{storeId}/discord/links", headers=headers)Response200
[
{
"created_at": "2024-01-01T00:00:00Z",
"store_id": "411486491630370816",
"token": "string",
"server_id": "411486491630370816",
"server_name": "string",
"server_icon_url": "string",
"linked_at": "2024-01-01T00:00:00Z"
}
]Headers
AuthorizationAPI KeyRequired
Authentication token for this request, sent as
Authorization: APIKey TOKEN.Path parameters
storeIdFlakeIdRequired
Response
200OKDiscordServerLinkDto
Show fieldsHide fields
created_atstringRequired
store_idFlakeIdRequired
tokenstringRequired
linked_atstringOptional
server_icon_urlstringOptional
server_idFlakeIdOptional
server_namestringOptional
Failed requests return a PayNowError body. See the error response guide.
curl -X POST "https://api.paynow.gg/v1/stores/{storeId}/discord/links" \
-H "Authorization: APIKey TOKEN"import { createManagementClient } from "@paynow-gg/typescript-sdk";
const paynow = createManagementClient({
apiKey: "API_KEY",
storeId: "STORE_ID",
});
const result = await paynow.discord.createDiscordServerLink();import requests
headers = {"Authorization": "APIKey TOKEN"}
response = requests.post("https://api.paynow.gg/v1/stores/{storeId}/discord/links", headers=headers)Response200
{
"created_at": "2024-01-01T00:00:00Z",
"store_id": "411486491630370816",
"token": "string",
"server_id": "411486491630370816",
"server_name": "string",
"server_icon_url": "string",
"linked_at": "2024-01-01T00:00:00Z"
}Headers
AuthorizationAPI KeyRequired
Authentication token for this request, sent as
Authorization: APIKey TOKEN.Path parameters
storeIdFlakeIdRequired
tokenstringRequired
Response
200OKDiscordServerLinkDto[]
Show fieldsHide fields
created_atstringRequired
store_idFlakeIdRequired
tokenstringRequired
linked_atstringOptional
server_icon_urlstringOptional
server_idFlakeIdOptional
server_namestringOptional
Failed requests return a PayNowError body. See the error response guide.
curl -X DELETE "https://api.paynow.gg/v1/stores/{storeId}/discord/links/{token}" \
-H "Authorization: APIKey TOKEN"import { createManagementClient } from "@paynow-gg/typescript-sdk";
const paynow = createManagementClient({
apiKey: "API_KEY",
storeId: "STORE_ID",
});
const result = await paynow.discord.deleteDiscordServerLinks("string");import requests
headers = {"Authorization": "APIKey TOKEN"}
response = requests.delete("https://api.paynow.gg/v1/stores/{storeId}/discord/links/{token}", headers=headers)Response200
[
{
"created_at": "2024-01-01T00:00:00Z",
"store_id": "411486491630370816",
"token": "string",
"server_id": "411486491630370816",
"server_name": "string",
"server_icon_url": "string",
"linked_at": "2024-01-01T00:00:00Z"
}
]Get Discord Server Roles
GEThttps://api.paynow.gg/v1/stores/{storeId}/discord/{discordServerId}/roles
Headers
AuthorizationAPI KeyRequired
Authentication token for this request, sent as
Authorization: APIKey TOKEN.Path parameters
storeIdFlakeIdRequired
discordServerIdintegerRequired
Response
200OKDiscordServerRoleDto[]
Show fieldsHide fields
idFlakeIdRequired
namestringRequired
Failed requests return a PayNowError body. See the error response guide.
curl -X GET "https://api.paynow.gg/v1/stores/{storeId}/discord/{discordServerId}/roles" \
-H "Authorization: APIKey TOKEN"import { createManagementClient } from "@paynow-gg/typescript-sdk";
const paynow = createManagementClient({
apiKey: "API_KEY",
storeId: "STORE_ID",
});
const result = await paynow.discord.getDiscordServerRoles(0);import requests
headers = {"Authorization": "APIKey TOKEN"}
response = requests.get("https://api.paynow.gg/v1/stores/{storeId}/discord/{discordServerId}/roles", headers=headers)Response200
[
{
"id": "411486491630370816",
"name": "string"
}
]Get Discord Server Text Channels
GEThttps://api.paynow.gg/v1/stores/{storeId}/discord/{discordServerId}/discord/text_channels
Headers
AuthorizationAPI KeyRequired
Authentication token for this request, sent as
Authorization: APIKey TOKEN.Path parameters
storeIdFlakeIdRequired
discordServerIdintegerRequired
Response
200OKDiscordServerChannelDto[]
Show fieldsHide fields
categorystringRequired
idstringRequired
namestringRequired
Failed requests return a PayNowError body. See the error response guide.
curl -X GET "https://api.paynow.gg/v1/stores/{storeId}/discord/{discordServerId}/discord/text_channels" \
-H "Authorization: APIKey TOKEN"import { createManagementClient } from "@paynow-gg/typescript-sdk";
const paynow = createManagementClient({
apiKey: "API_KEY",
storeId: "STORE_ID",
});
const result = await paynow.discord.getDiscordServerTextChannels(0);import requests
headers = {"Authorization": "APIKey TOKEN"}
response = requests.get("https://api.paynow.gg/v1/stores/{storeId}/discord/{discordServerId}/discord/text_channels", headers=headers)Response200
[
{
"category": "string",
"id": "string",
"name": "string"
}
]