Tier Groups

List all tier groups for a store

GEThttps://api.paynow.gg/v1/stores/{storeId}/tier-groups

Headers

AuthorizationAPI KeyRequired

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

Path parameters

storeIdFlakeIdRequired

Response

200OKTierGroupDto[]

Show fields

created_atstringRequired

When the tier group was created.

created_byActorDtoRequired

typeenumRequired

Possible enum values

anonymous
user
api_key
customer
game_server
internal
admin
platform
global_customer

idFlakeIdOptional

idFlakeIdRequired

namestringRequired

The name of the tier group.

store_idFlakeIdRequired

updated_atstringOptional

When was the tier group last updated.

updated_byActorDtoOptional

typeenumRequired

Possible enum values

anonymous
user
api_key
customer
game_server
internal
admin
platform
global_customer

idFlakeIdOptional

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

curl -X GET "https://api.paynow.gg/v1/stores/{storeId}/tier-groups" \
  -H "Authorization: APIKey TOKEN"

import { createManagementClient } from "@paynow-gg/typescript-sdk";

const paynow = createManagementClient({
  apiKey: "API_KEY",
  storeId: "STORE_ID",
});

const result = await paynow.tierGroups.listTierGroups();

import requests

headers = {"Authorization": "APIKey TOKEN"}
response = requests.get("https://api.paynow.gg/v1/stores/{storeId}/tier-groups", headers=headers)

Response200

[
  {
    "created_at": "2024-01-01T00:00:00Z",
    "created_by": {
      "type": "anonymous",
      "id": "411486491630370816"
    },
    "id": "411486491630370816",
    "name": "string",
    "store_id": "411486491630370816",
    "updated_at": "2024-01-01T00:00:00Z",
    "updated_by": {
      "type": "anonymous",
      "id": "411486491630370816"
    }
  }
]

Create a new tier group

POSThttps://api.paynow.gg/v1/stores/{storeId}/tier-groups

Headers

AuthorizationAPI KeyRequired

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

Path parameters

storeIdFlakeIdRequired

Request body

namestringRequired

The name of the tier group.

Response

200OKTierGroupDto

Show fields

created_atstringRequired

When the tier group was created.

created_byActorDtoRequired

typeenumRequired

Possible enum values

anonymous
user
api_key
customer
game_server
internal
admin
platform
global_customer

idFlakeIdOptional

idFlakeIdRequired

namestringRequired

The name of the tier group.

store_idFlakeIdRequired

updated_atstringOptional

When was the tier group last updated.

updated_byActorDtoOptional

typeenumRequired

Possible enum values

anonymous
user
api_key
customer
game_server
internal
admin
platform
global_customer

idFlakeIdOptional

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

curl -X POST "https://api.paynow.gg/v1/stores/{storeId}/tier-groups" \
  -H "Authorization: APIKey TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string"
}'

import { createManagementClient } from "@paynow-gg/typescript-sdk";

const paynow = createManagementClient({
  apiKey: "API_KEY",
  storeId: "STORE_ID",
});

const result = await paynow.tierGroups.createTierGroup({
  name: "string",
});

import requests

headers = {"Authorization": "APIKey TOKEN"}
payload = {
    "name": "string",
}
response = requests.post("https://api.paynow.gg/v1/stores/{storeId}/tier-groups", headers=headers, json=payload)

Response200

{
  "created_at": "2024-01-01T00:00:00Z",
  "created_by": {
    "type": "anonymous",
    "id": "411486491630370816"
  },
  "id": "411486491630370816",
  "name": "string",
  "store_id": "411486491630370816",
  "updated_at": "2024-01-01T00:00:00Z",
  "updated_by": {
    "type": "anonymous",
    "id": "411486491630370816"
  }
}

Get a tier group by ID

GEThttps://api.paynow.gg/v1/stores/{storeId}/tier-groups/{tierGroupId}

Headers

AuthorizationAPI KeyRequired

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

Path parameters

storeIdFlakeIdRequired

tierGroupIdFlakeIdRequired

Response

200OKTierGroupDto

Show fields

created_atstringRequired

When the tier group was created.

created_byActorDtoRequired

typeenumRequired

Possible enum values

anonymous
user
api_key
customer
game_server
internal
admin
platform
global_customer

idFlakeIdOptional

idFlakeIdRequired

namestringRequired

The name of the tier group.

store_idFlakeIdRequired

updated_atstringOptional

When was the tier group last updated.

updated_byActorDtoOptional

typeenumRequired

Possible enum values

anonymous
user
api_key
customer
game_server
internal
admin
platform
global_customer

idFlakeIdOptional

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

curl -X GET "https://api.paynow.gg/v1/stores/{storeId}/tier-groups/{tierGroupId}" \
  -H "Authorization: APIKey TOKEN"

import { createManagementClient } from "@paynow-gg/typescript-sdk";

const paynow = createManagementClient({
  apiKey: "API_KEY",
  storeId: "STORE_ID",
});

const result = await paynow.tierGroups.getTierGroup("411486491630370816");

import requests

headers = {"Authorization": "APIKey TOKEN"}
response = requests.get("https://api.paynow.gg/v1/stores/{storeId}/tier-groups/{tierGroupId}", headers=headers)

Response200

{
  "created_at": "2024-01-01T00:00:00Z",
  "created_by": {
    "type": "anonymous",
    "id": "411486491630370816"
  },
  "id": "411486491630370816",
  "name": "string",
  "store_id": "411486491630370816",
  "updated_at": "2024-01-01T00:00:00Z",
  "updated_by": {
    "type": "anonymous",
    "id": "411486491630370816"
  }
}

Update a tier group by ID

PATCHhttps://api.paynow.gg/v1/stores/{storeId}/tier-groups/{tierGroupId}

Headers

AuthorizationAPI KeyRequired

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

Path parameters

storeIdFlakeIdRequired

tierGroupIdFlakeIdRequired

Request body

namestringRequired

The name of the tier group.

Response

200OKTierGroupDto

Show fields

created_atstringRequired

When the tier group was created.

created_byActorDtoRequired

typeenumRequired

Possible enum values

anonymous
user
api_key
customer
game_server
internal
admin
platform
global_customer

idFlakeIdOptional

idFlakeIdRequired

namestringRequired

The name of the tier group.

store_idFlakeIdRequired

updated_atstringOptional

When was the tier group last updated.

updated_byActorDtoOptional

typeenumRequired

Possible enum values

anonymous
user
api_key
customer
game_server
internal
admin
platform
global_customer

idFlakeIdOptional

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

curl -X PATCH "https://api.paynow.gg/v1/stores/{storeId}/tier-groups/{tierGroupId}" \
  -H "Authorization: APIKey TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string"
}'

import { createManagementClient } from "@paynow-gg/typescript-sdk";

const paynow = createManagementClient({
  apiKey: "API_KEY",
  storeId: "STORE_ID",
});

const result = await paynow.tierGroups.updateTierGroup("411486491630370816", {
  name: "string",
});

import requests

headers = {"Authorization": "APIKey TOKEN"}
payload = {
    "name": "string",
}
response = requests.patch("https://api.paynow.gg/v1/stores/{storeId}/tier-groups/{tierGroupId}", headers=headers, json=payload)

Response200

{
  "created_at": "2024-01-01T00:00:00Z",
  "created_by": {
    "type": "anonymous",
    "id": "411486491630370816"
  },
  "id": "411486491630370816",
  "name": "string",
  "store_id": "411486491630370816",
  "updated_at": "2024-01-01T00:00:00Z",
  "updated_by": {
    "type": "anonymous",
    "id": "411486491630370816"
  }
}

Delete a tier group by ID

DELETEhttps://api.paynow.gg/v1/stores/{storeId}/tier-groups/{tierGroupId}

Headers

AuthorizationAPI KeyRequired

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

Path parameters

storeIdFlakeIdRequired

tierGroupIdFlakeIdRequired

Response

204No Content

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

curl -X DELETE "https://api.paynow.gg/v1/stores/{storeId}/tier-groups/{tierGroupId}" \
  -H "Authorization: APIKey TOKEN"

import { createManagementClient } from "@paynow-gg/typescript-sdk";

const paynow = createManagementClient({
  apiKey: "API_KEY",
  storeId: "STORE_ID",
});

await paynow.tierGroups.deleteTierGroup("411486491630370816");

import requests

headers = {"Authorization": "APIKey TOKEN"}
response = requests.delete("https://api.paynow.gg/v1/stores/{storeId}/tier-groups/{tierGroupId}", headers=headers)