Discord

Get product version Discord actions

GEThttps://api.paynow.gg/v1/stores/{storeId}/product_versions/{productVersionId}/discord_actions

Retrieves all Discord actions configured for a product version in the specified store.

Headers

AuthorizationAPI KeyRequired

Authentication token for this request, sent as Authorization: APIKey TOKEN.

Path parameters

storeIdFlakeIdRequired

The ID of the store the product version belongs to.

productVersionIdFlakeIdRequired

The ID of the product version.

Response

200OKDiscordActionDto[]

Show fields

idFlakeIdRequired

action_typeenumRequired

Possible enum values

persist_role
send_message
ban_user
kick_user
generate_invite_link

discord_server_idFlakeIdRequired

execution_stageenumRequired

Possible enum values

on_purchase
on_expire
on_refund
on_chargeback

product_idFlakeIdRequired

product_version_idFlakeIdRequired

revocation_stagesenum[]Required

Possible enum values

on_expire
on_refund
on_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

[
  {
    "id": "411486491630370816",
    "action_type": "persist_role",
    "discord_server_id": "411486491630370816",
    "execution_stage": "on_purchase",
    "product_id": "411486491630370816",
    "product_version_id": "411486491630370816",
    "revocation_stages": [
      "on_expire"
    ],
    "store_id": "411486491630370816",
    "channel_id": "411486491630370816",
    "message": "string",
    "role_id": "411486491630370816"
  }
]

Set product version Discord actions

PUThttps://api.paynow.gg/v1/stores/{storeId}/product_versions/{productVersionId}/discord_actions

Replaces the Discord actions configured for a product version in the specified store.

Headers

AuthorizationAPI KeyRequired

Authentication token for this request, sent as Authorization: APIKey TOKEN.

Path parameters

storeIdFlakeIdRequired

The ID of the store the product version belongs to.

productVersionIdFlakeIdRequired

The ID of the product version.

Request body

action_typeenumRequired

Possible enum values

persist_role
send_message
ban_user
kick_user
generate_invite_link

discord_server_idFlakeIdRequired

execution_stageenumRequired

Possible enum values

on_purchase
on_expire
on_refund
on_chargeback

channel_idFlakeIdOptional

messagestringOptional

revocation_stagesenum[]Optional

Possible enum values

on_expire
on_refund
on_chargeback

role_idFlakeIdOptional

Response

200OKDiscordActionDto

Show fields

idFlakeIdRequired

action_typeenumRequired

Possible enum values

persist_role
send_message
ban_user
kick_user
generate_invite_link

discord_server_idFlakeIdRequired

execution_stageenumRequired

Possible enum values

on_purchase
on_expire
on_refund
on_chargeback

product_idFlakeIdRequired

product_version_idFlakeIdRequired

revocation_stagesenum[]Required

Possible enum values

on_expire
on_refund
on_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",
    "channel_id": "411486491630370816",
    "message": "string",
    "revocation_stages": [
      "on_expire"
    ],
    "role_id": "411486491630370816"
  }
]'

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",
    channel_id: "411486491630370816",
    message: "string",
    revocation_stages: [
      "on_expire",
    ],
    role_id: "411486491630370816",
  },
]);

import requests

headers = {"Authorization": "APIKey TOKEN"}
payload = [
    {
        "action_type": "persist_role",
        "discord_server_id": "411486491630370816",
        "execution_stage": "on_purchase",
        "channel_id": "411486491630370816",
        "message": "string",
        "revocation_stages": [
            "on_expire",
        ],
        "role_id": "411486491630370816",
    },
]
response = requests.put("https://api.paynow.gg/v1/stores/{storeId}/product_versions/{productVersionId}/discord_actions", headers=headers, json=payload)

Response200

{
  "id": "411486491630370816",
  "action_type": "persist_role",
  "discord_server_id": "411486491630370816",
  "execution_stage": "on_purchase",
  "product_id": "411486491630370816",
  "product_version_id": "411486491630370816",
  "revocation_stages": [
    "on_expire"
  ],
  "store_id": "411486491630370816",
  "channel_id": "411486491630370816",
  "message": "string",
  "role_id": "411486491630370816"
}

Get linked Discord accounts

GEThttps://api.paynow.gg/v1/stores/{storeId}/orders/{orderId}/discord

Retrieves the Discord accounts linked to an order for the specified store.

Headers

AuthorizationAPI KeyRequired

Authentication token for this request, sent as Authorization: APIKey TOKEN.

Path parameters

storeIdFlakeIdRequired

The ID of the store to retrieve the linked Discord accounts for.

orderIdFlakeIdRequired

The ID of the order.

Response

200OKobject

Failed requests return a PayNowError body. See the error response guide.

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

Retrieves the history of Discord actions executed for an order in the specified store.

Headers

AuthorizationAPI KeyRequired

Authentication token for this request, sent as Authorization: APIKey TOKEN.

Path parameters

storeIdFlakeIdRequired

The ID of the store to retrieve the Discord action history for.

orderIdFlakeIdRequired

The ID of the order.

Response

200OKQueuedDiscordActionDto[]

Show fields

idintegerRequired

action_typeenumRequired

Possible enum values

persist_role
send_message
ban_user
kick_user
generate_invite_link

delivery_item_idFlakeIdRequired

discord_server_idFlakeIdRequired

enqueued_atstringRequired

execution_stageenumRequired

Possible enum values

on_purchase
on_expire
on_refund
on_chargeback

executionsQueuedDiscordActionExecutionDto[]Required

idintegerRequired

executed_atstringRequired

execution_statusenumRequired

Possible enum values

success
failure

queue_idintegerRequired

messagestringOptional

trace_idstringOptional

product_idFlakeIdRequired

product_version_idFlakeIdRequired

revocation_stagesenum[]Required

Possible enum values

on_expire
on_refund
on_chargeback

statusenumRequired

Possible enum values

active
complete
errored
canceled

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

[
  {
    "id": 0,
    "action_type": "persist_role",
    "delivery_item_id": "411486491630370816",
    "discord_server_id": "411486491630370816",
    "enqueued_at": "2024-01-01T00:00:00Z",
    "execution_stage": "on_purchase",
    "executions": [
      {
        "id": 0,
        "executed_at": "2024-01-01T00:00:00Z",
        "execution_status": "success",
        "queue_id": 0,
        "message": "string",
        "trace_id": "string"
      }
    ],
    "product_id": "411486491630370816",
    "product_version_id": "411486491630370816",
    "revocation_stages": [
      "on_expire"
    ],
    "status": "active",
    "store_id": "411486491630370816",
    "channel_id": "411486491630370816",
    "checkout_id": "411486491630370816",
    "checkout_line_id": "411486491630370816",
    "discord_user_id": "411486491630370816",
    "finalised_at": "2024-01-01T00:00:00Z",
    "message": "string",
    "order_id": "411486491630370816",
    "role_id": "411486491630370816"
  }
]

Get queued Discord actions for delivery item

GEThttps://api.paynow.gg/v1/stores/{storeId}/inventory/{inventoryItemId}/discord/queued

Retrieves all queued Discord actions for a delivery item in the specified store.

Headers

AuthorizationAPI KeyRequired

Authentication token for this request, sent as Authorization: APIKey TOKEN.

Path parameters

storeIdFlakeIdRequired

The ID of the store the delivery item belongs to.

inventoryItemIdFlakeIdRequired

The ID of the delivery item.

Response

200OKQueuedDiscordActionDto[]

Show fields

idintegerRequired

action_typeenumRequired

Possible enum values

persist_role
send_message
ban_user
kick_user
generate_invite_link

delivery_item_idFlakeIdRequired

discord_server_idFlakeIdRequired

enqueued_atstringRequired

execution_stageenumRequired

Possible enum values

on_purchase
on_expire
on_refund
on_chargeback

executionsQueuedDiscordActionExecutionDto[]Required

idintegerRequired

executed_atstringRequired

execution_statusenumRequired

Possible enum values

success
failure

queue_idintegerRequired

messagestringOptional

trace_idstringOptional

product_idFlakeIdRequired

product_version_idFlakeIdRequired

revocation_stagesenum[]Required

Possible enum values

on_expire
on_refund
on_chargeback

statusenumRequired

Possible enum values

active
complete
errored
canceled

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

[
  {
    "id": 0,
    "action_type": "persist_role",
    "delivery_item_id": "411486491630370816",
    "discord_server_id": "411486491630370816",
    "enqueued_at": "2024-01-01T00:00:00Z",
    "execution_stage": "on_purchase",
    "executions": [
      {
        "id": 0,
        "executed_at": "2024-01-01T00:00:00Z",
        "execution_status": "success",
        "queue_id": 0,
        "message": "string",
        "trace_id": "string"
      }
    ],
    "product_id": "411486491630370816",
    "product_version_id": "411486491630370816",
    "revocation_stages": [
      "on_expire"
    ],
    "status": "active",
    "store_id": "411486491630370816",
    "channel_id": "411486491630370816",
    "checkout_id": "411486491630370816",
    "checkout_line_id": "411486491630370816",
    "discord_user_id": "411486491630370816",
    "finalised_at": "2024-01-01T00:00:00Z",
    "message": "string",
    "order_id": "411486491630370816",
    "role_id": "411486491630370816"
  }
]

Get Discord user linked to delivery item

GEThttps://api.paynow.gg/v1/stores/{storeId}/inventory/{inventoryItemId}/discord/link

Retrieves the Discord profile linked to a delivery item in the specified store.

Headers

AuthorizationAPI KeyRequired

Authentication token for this request, sent as Authorization: APIKey TOKEN.

Path parameters

storeIdFlakeIdRequired

The ID of the store the delivery item belongs to.

inventoryItemIdFlakeIdRequired

The ID of the delivery item.

Response

200OKDiscordProfileDto

Show 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"
}

Link Discord user to delivery item

PUThttps://api.paynow.gg/v1/stores/{storeId}/inventory/{inventoryItemId}/discord/link

Links a Discord user to a delivery item in the specified store.

Headers

AuthorizationAPI KeyRequired

Authentication token for this request, sent as Authorization: APIKey TOKEN.

Path parameters

storeIdFlakeIdRequired

The ID of the store the delivery item belongs to.

inventoryItemIdFlakeIdRequired

The ID of the delivery item.

Query parameters

discordUserIdintegerOptional

The ID of the Discord user to link.

Response

200OK

Failed requests return a PayNowError body. See the error response guide.

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)

Unlink Discord user from delivery item

DELETEhttps://api.paynow.gg/v1/stores/{storeId}/inventory/{inventoryItemId}/discord/link

Removes the Discord user link from a delivery item in the specified store.

Headers

AuthorizationAPI KeyRequired

Authentication token for this request, sent as Authorization: APIKey TOKEN.

Path parameters

storeIdFlakeIdRequired

The ID of the store the delivery item belongs to.

inventoryItemIdFlakeIdRequired

The ID of the delivery item.

Response

200OK

Failed requests return a PayNowError body. See the error response guide.

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)

Get Discord server links

GEThttps://api.paynow.gg/v1/stores/{storeId}/discord/links

Retrieves all Discord server links for the specified store.

Headers

AuthorizationAPI KeyRequired

Authentication token for this request, sent as Authorization: APIKey TOKEN.

Path parameters

storeIdFlakeIdRequired

The ID of the store to retrieve Discord server links for.

Response

200OKDiscordServerLinkDto[]

Show 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",
    "linked_at": "2024-01-01T00:00:00Z",
    "server_icon_url": "string",
    "server_id": "411486491630370816",
    "server_name": "string"
  }
]

Create Discord server link

POSThttps://api.paynow.gg/v1/stores/{storeId}/discord/links

Creates a new link token that can be used to connect a Discord server to the specified store.

Headers

AuthorizationAPI KeyRequired

Authentication token for this request, sent as Authorization: APIKey TOKEN.

Path parameters

storeIdFlakeIdRequired

The ID of the store to create the Discord server link for.

Response

200OKDiscordServerLinkDto

Show 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",
  "linked_at": "2024-01-01T00:00:00Z",
  "server_icon_url": "string",
  "server_id": "411486491630370816",
  "server_name": "string"
}

Delete Discord server link

DELETEhttps://api.paynow.gg/v1/stores/{storeId}/discord/links/{token}

Deletes a Discord server link by the token for the specified store.

Headers

AuthorizationAPI KeyRequired

Authentication token for this request, sent as Authorization: APIKey TOKEN.

Path parameters

storeIdFlakeIdRequired

The ID of the store to delete the Discord server link for.

tokenstringRequired

The token of the Discord server link.

Response

204No Content

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",
});

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)

Get Discord server roles

GEThttps://api.paynow.gg/v1/stores/{storeId}/discord/{discordServerId}/roles

Retrieves all roles for a Discord server linked to the specified store.

Headers

AuthorizationAPI KeyRequired

Authentication token for this request, sent as Authorization: APIKey TOKEN.

Path parameters

storeIdFlakeIdRequired

The ID of the store the Discord server is linked to.

discordServerIdintegerRequired

The ID of the Discord server.

Response

200OKDiscordServerRoleDto[]

Show 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

Retrieves all text channels for a Discord server linked to the specified store.

Headers

AuthorizationAPI KeyRequired

Authentication token for this request, sent as Authorization: APIKey TOKEN.

Path parameters

storeIdFlakeIdRequired

The ID of the store the Discord server is linked to.

discordServerIdintegerRequired

The ID of the Discord server.

Response

200OKDiscordServerChannelDto[]

Show fields

idstringRequired

categorystringRequired

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

[
  {
    "id": "string",
    "category": "string",
    "name": "string"
  }
]