Affiliate Links
Authorization: APIKey TOKEN.Show fieldsHide fields
commission_amount_stepsAffiliateLinkCommissionAmountStepDto[]RequiredPer-cycle commission overrides. Requires 'apply_for_subscriptions' to be enabled for billing cycles past 1.
When empty, the base commission amount applies to every renewal. When steps are defined, each renewal cycle pays its matching steps amount.
Cycles without a matching step earn no commission, except cycles past the last step when 'last_commission_amount_step_repeats' is true.
noneNo commission is earned.
fixedA fixed amount commission (e.g., $5 per purchase). Not yet supported by the affiliate service.
percentageA percentage-based commission (e.g., 10% of the purchase).
created_byActorDtoRequired
anonymoususerapi_keycustomergame_serverinternaladminplatformglobal_customer
noneNo discount is offered.
fixedA fixed amount discount (e.g., $5 off).
percentageA percentage-based discount (e.g., 10% off).
invalidNo referer type specified. This value is typically used as a default or uninitialized state.
first_refererThe first affiliate link the customer followed is credited.
last_refererThe most recent affiliate link the customer followed is credited.
updated_byActorDtoOptional
anonymoususerapi_keycustomergame_serverinternaladminplatformglobal_customer
Failed requests return a PayNowError body. See the error response guide.
curl -X GET "https://api.paynow.gg/v1/stores/{storeId}/affiliate-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.affiliateLinks.getAffiliateLinks();import requests
headers = {"Authorization": "APIKey TOKEN"}
response = requests.get("https://api.paynow.gg/v1/stores/{storeId}/affiliate-links", headers=headers)[
{
"apply_for_subscriptions": true,
"code": "string",
"commission_amount": 0,
"commission_amount_steps": [
{
"billing_cycle_sequence": 0,
"commission_amount": 0
}
],
"commission_type": "none",
"created_at": "2024-01-01T00:00:00Z",
"created_by": {
"type": "anonymous",
"id": "411486491630370816"
},
"discount_amount": 0,
"discount_type": "none",
"enabled": true,
"id": "411486491630370816",
"last_commission_amount_step_repeats": true,
"referer_type": "invalid",
"store_id": "411486491630370816",
"tracking_length_days": 0,
"wallet_id": "string",
"updated_by": {
"type": "anonymous",
"id": "411486491630370816"
},
"updated_at": "2024-01-01T00:00:00Z"
}
]Authorization: APIKey TOKEN.commission_amount_stepsAffiliateLinkCommissionAmountStepDto[]RequiredRepresents the commission for a specific subscription renewal billing cycle.
A step applies to its exact cycle - see the affiliate link's 'last_commission_amount_step_repeats' for what happens past the last step.
noneNo commission is earned.
fixedA fixed amount commission (e.g., $5 per purchase). Not yet supported by the affiliate service.
percentageA percentage-based commission (e.g., 10% of the purchase).
noneNo discount is offered.
fixedA fixed amount discount (e.g., $5 off).
percentageA percentage-based discount (e.g., 10% off).
invalidNo referer type specified. This value is typically used as a default or uninitialized state.
first_refererThe first affiliate link the customer followed is credited.
last_refererThe most recent affiliate link the customer followed is credited.
Show fieldsHide fields
commission_amount_stepsAffiliateLinkCommissionAmountStepDto[]RequiredPer-cycle commission overrides. Requires 'apply_for_subscriptions' to be enabled for billing cycles past 1.
When empty, the base commission amount applies to every renewal. When steps are defined, each renewal cycle pays its matching steps amount.
Cycles without a matching step earn no commission, except cycles past the last step when 'last_commission_amount_step_repeats' is true.
noneNo commission is earned.
fixedA fixed amount commission (e.g., $5 per purchase). Not yet supported by the affiliate service.
percentageA percentage-based commission (e.g., 10% of the purchase).
created_byActorDtoRequired
anonymoususerapi_keycustomergame_serverinternaladminplatformglobal_customer
noneNo discount is offered.
fixedA fixed amount discount (e.g., $5 off).
percentageA percentage-based discount (e.g., 10% off).
invalidNo referer type specified. This value is typically used as a default or uninitialized state.
first_refererThe first affiliate link the customer followed is credited.
last_refererThe most recent affiliate link the customer followed is credited.
updated_byActorDtoOptional
anonymoususerapi_keycustomergame_serverinternaladminplatformglobal_customer
Failed requests return a PayNowError body. See the error response guide.
curl -X POST "https://api.paynow.gg/v1/stores/{storeId}/affiliate-links" \
-H "Authorization: APIKey TOKEN" \
-H "Content-Type: application/json" \
-d '{
"wallet_id": "string",
"enabled": true,
"code": "string",
"referer_type": "invalid",
"tracking_length_days": 0,
"apply_for_subscriptions": true,
"discount_type": "none",
"discount_amount": 0,
"commission_type": "none",
"commission_amount": 0,
"commission_amount_steps": [
{
"billing_cycle_sequence": 0,
"commission_amount": 0
}
],
"last_commission_amount_step_repeats": true
}'import { createManagementClient } from "@paynow-gg/typescript-sdk";
const paynow = createManagementClient({
apiKey: "API_KEY",
storeId: "STORE_ID",
});
const result = await paynow.affiliateLinks.createAffiliateLink({
wallet_id: "string",
enabled: true,
code: "string",
referer_type: "invalid",
tracking_length_days: 0,
apply_for_subscriptions: true,
discount_type: "none",
discount_amount: 0,
commission_type: "none",
commission_amount: 0,
commission_amount_steps: [
{
billing_cycle_sequence: 0,
commission_amount: 0,
},
],
last_commission_amount_step_repeats: true,
});import requests
headers = {"Authorization": "APIKey TOKEN"}
payload = {
"wallet_id": "string",
"enabled": True,
"code": "string",
"referer_type": "invalid",
"tracking_length_days": 0,
"apply_for_subscriptions": True,
"discount_type": "none",
"discount_amount": 0,
"commission_type": "none",
"commission_amount": 0,
"commission_amount_steps": [
{
"billing_cycle_sequence": 0,
"commission_amount": 0,
},
],
"last_commission_amount_step_repeats": True,
}
response = requests.post("https://api.paynow.gg/v1/stores/{storeId}/affiliate-links", headers=headers, json=payload){
"apply_for_subscriptions": true,
"code": "string",
"commission_amount": 0,
"commission_amount_steps": [
{
"billing_cycle_sequence": 0,
"commission_amount": 0
}
],
"commission_type": "none",
"created_at": "2024-01-01T00:00:00Z",
"created_by": {
"type": "anonymous",
"id": "411486491630370816"
},
"discount_amount": 0,
"discount_type": "none",
"enabled": true,
"id": "411486491630370816",
"last_commission_amount_step_repeats": true,
"referer_type": "invalid",
"store_id": "411486491630370816",
"tracking_length_days": 0,
"wallet_id": "string",
"updated_by": {
"type": "anonymous",
"id": "411486491630370816"
},
"updated_at": "2024-01-01T00:00:00Z"
}Authorization: APIKey TOKEN.Show fieldsHide fields
commission_amount_stepsAffiliateLinkCommissionAmountStepDto[]RequiredPer-cycle commission overrides. Requires 'apply_for_subscriptions' to be enabled for billing cycles past 1.
When empty, the base commission amount applies to every renewal. When steps are defined, each renewal cycle pays its matching steps amount.
Cycles without a matching step earn no commission, except cycles past the last step when 'last_commission_amount_step_repeats' is true.
noneNo commission is earned.
fixedA fixed amount commission (e.g., $5 per purchase). Not yet supported by the affiliate service.
percentageA percentage-based commission (e.g., 10% of the purchase).
created_byActorDtoRequired
anonymoususerapi_keycustomergame_serverinternaladminplatformglobal_customer
noneNo discount is offered.
fixedA fixed amount discount (e.g., $5 off).
percentageA percentage-based discount (e.g., 10% off).
invalidNo referer type specified. This value is typically used as a default or uninitialized state.
first_refererThe first affiliate link the customer followed is credited.
last_refererThe most recent affiliate link the customer followed is credited.
updated_byActorDtoOptional
anonymoususerapi_keycustomergame_serverinternaladminplatformglobal_customer
Failed requests return a PayNowError body. See the error response guide.
curl -X GET "https://api.paynow.gg/v1/stores/{storeId}/affiliate-links/{affiliateLinkId}" \
-H "Authorization: APIKey TOKEN"import { createManagementClient } from "@paynow-gg/typescript-sdk";
const paynow = createManagementClient({
apiKey: "API_KEY",
storeId: "STORE_ID",
});
const result = await paynow.affiliateLinks.getAffiliateLink("411486491630370816");import requests
headers = {"Authorization": "APIKey TOKEN"}
response = requests.get("https://api.paynow.gg/v1/stores/{storeId}/affiliate-links/{affiliateLinkId}", headers=headers){
"apply_for_subscriptions": true,
"code": "string",
"commission_amount": 0,
"commission_amount_steps": [
{
"billing_cycle_sequence": 0,
"commission_amount": 0
}
],
"commission_type": "none",
"created_at": "2024-01-01T00:00:00Z",
"created_by": {
"type": "anonymous",
"id": "411486491630370816"
},
"discount_amount": 0,
"discount_type": "none",
"enabled": true,
"id": "411486491630370816",
"last_commission_amount_step_repeats": true,
"referer_type": "invalid",
"store_id": "411486491630370816",
"tracking_length_days": 0,
"wallet_id": "string",
"updated_by": {
"type": "anonymous",
"id": "411486491630370816"
},
"updated_at": "2024-01-01T00:00:00Z"
}Update Affiliate Link
Authorization: APIKey TOKEN.commission_amount_stepsAffiliateLinkCommissionAmountStepDto[]OptionalRepresents the commission for a specific subscription renewal billing cycle.
A step applies to its exact cycle - see the affiliate link's 'last_commission_amount_step_repeats' for what happens past the last step.
noneNo commission is earned.
fixedA fixed amount commission (e.g., $5 per purchase). Not yet supported by the affiliate service.
percentageA percentage-based commission (e.g., 10% of the purchase).
noneNo discount is offered.
fixedA fixed amount discount (e.g., $5 off).
percentageA percentage-based discount (e.g., 10% off).
invalidNo referer type specified. This value is typically used as a default or uninitialized state.
first_refererThe first affiliate link the customer followed is credited.
last_refererThe most recent affiliate link the customer followed is credited.
Show fieldsHide fields
commission_amount_stepsAffiliateLinkCommissionAmountStepDto[]RequiredPer-cycle commission overrides. Requires 'apply_for_subscriptions' to be enabled for billing cycles past 1.
When empty, the base commission amount applies to every renewal. When steps are defined, each renewal cycle pays its matching steps amount.
Cycles without a matching step earn no commission, except cycles past the last step when 'last_commission_amount_step_repeats' is true.
noneNo commission is earned.
fixedA fixed amount commission (e.g., $5 per purchase). Not yet supported by the affiliate service.
percentageA percentage-based commission (e.g., 10% of the purchase).
created_byActorDtoRequired
anonymoususerapi_keycustomergame_serverinternaladminplatformglobal_customer
noneNo discount is offered.
fixedA fixed amount discount (e.g., $5 off).
percentageA percentage-based discount (e.g., 10% off).
invalidNo referer type specified. This value is typically used as a default or uninitialized state.
first_refererThe first affiliate link the customer followed is credited.
last_refererThe most recent affiliate link the customer followed is credited.
updated_byActorDtoOptional
anonymoususerapi_keycustomergame_serverinternaladminplatformglobal_customer
Failed requests return a PayNowError body. See the error response guide.
curl -X PATCH "https://api.paynow.gg/v1/stores/{storeId}/affiliate-links/{affiliateLinkId}" \
-H "Authorization: APIKey TOKEN" \
-H "Content-Type: application/json" \
-d '{
"wallet_id": "string",
"enabled": true,
"code": "string",
"referer_type": "invalid",
"tracking_length_days": 0,
"apply_for_subscriptions": true,
"discount_type": "none",
"discount_amount": 0,
"commission_type": "none",
"commission_amount": 0,
"commission_amount_steps": [
{
"billing_cycle_sequence": 0,
"commission_amount": 0
}
],
"last_commission_amount_step_repeats": true
}'import { createManagementClient } from "@paynow-gg/typescript-sdk";
const paynow = createManagementClient({
apiKey: "API_KEY",
storeId: "STORE_ID",
});
const result = await paynow.affiliateLinks.updateAffiliateLink("411486491630370816", {
wallet_id: "string",
enabled: true,
code: "string",
referer_type: "invalid",
tracking_length_days: 0,
apply_for_subscriptions: true,
discount_type: "none",
discount_amount: 0,
commission_type: "none",
commission_amount: 0,
commission_amount_steps: [
{
billing_cycle_sequence: 0,
commission_amount: 0,
},
],
last_commission_amount_step_repeats: true,
});import requests
headers = {"Authorization": "APIKey TOKEN"}
payload = {
"wallet_id": "string",
"enabled": True,
"code": "string",
"referer_type": "invalid",
"tracking_length_days": 0,
"apply_for_subscriptions": True,
"discount_type": "none",
"discount_amount": 0,
"commission_type": "none",
"commission_amount": 0,
"commission_amount_steps": [
{
"billing_cycle_sequence": 0,
"commission_amount": 0,
},
],
"last_commission_amount_step_repeats": True,
}
response = requests.patch("https://api.paynow.gg/v1/stores/{storeId}/affiliate-links/{affiliateLinkId}", headers=headers, json=payload){
"apply_for_subscriptions": true,
"code": "string",
"commission_amount": 0,
"commission_amount_steps": [
{
"billing_cycle_sequence": 0,
"commission_amount": 0
}
],
"commission_type": "none",
"created_at": "2024-01-01T00:00:00Z",
"created_by": {
"type": "anonymous",
"id": "411486491630370816"
},
"discount_amount": 0,
"discount_type": "none",
"enabled": true,
"id": "411486491630370816",
"last_commission_amount_step_repeats": true,
"referer_type": "invalid",
"store_id": "411486491630370816",
"tracking_length_days": 0,
"wallet_id": "string",
"updated_by": {
"type": "anonymous",
"id": "411486491630370816"
},
"updated_at": "2024-01-01T00:00:00Z"
}Delete Affiliate Link
Authorization: APIKey TOKEN.curl -X DELETE "https://api.paynow.gg/v1/stores/{storeId}/affiliate-links/{affiliateLinkId}" \
-H "Authorization: APIKey TOKEN"import { createManagementClient } from "@paynow-gg/typescript-sdk";
const paynow = createManagementClient({
apiKey: "API_KEY",
storeId: "STORE_ID",
});
await paynow.affiliateLinks.deleteAffiliateLink("411486491630370816");import requests
headers = {"Authorization": "APIKey TOKEN"}
response = requests.delete("https://api.paynow.gg/v1/stores/{storeId}/affiliate-links/{affiliateLinkId}", headers=headers)