v3 API
Authentication
Protecting your services dashboard's endpoint is of the the upmost importance when it comes to providing an experience that is both enjoyable to you as a provider, and your customers whom you service. Hence fore, we enforce an X-API-KEY header authorization.
curl -X GET \
-H "X-API-KEY: xxxxxxxxxxxxxxxxxxxxxx" \
https://demo.statclients.com/api/v2/product/fetch/xxxxxxxOrder Endpoint
Create a new order
POST https://demo.statclients.com/api/v2/order/new
Headers
X-API-KEY*
String
Authorization Header
Request Body
proxy_username*
String
proxy username of the order. Supported characters include lower case only: a-z:0-9.
Note: you cannot create an order for a username that has been used in the past.
proxy_password*
String
proxy password of the order. Supports all unicode characters
quantity*
int64
positive integer value
product_id*
enum
enum value of an existing product identifier.
Reference the product creation documentation page
customer_id
int64
optional parameter that can be used to track orders across clients.
expiration*
int64
unix timestamp in seconds.
String
optional parameter that can be used to track & query user orders.
Modify and update an existing order.
POST https://demo.statclients.com/api/v2/order/update
When it comes time to extend a customers order, allocate additional units, you'll need to modify the order document to reflect these changes.
Headers
X-API-KEY*
String
Authorization Header
Request Body
new_quantity
int32
updated quantity value to allocate. (note: the quantity value must be greater than the currently allocated quantity)
new_expiration
UnixTimestamp
The new date for expiration. Must be forward facing (in the future)
proxy_username*
String
The specific proxy username order to update
product_id*
String
Specific product type the order is set to.
Fetch an existing order
GET https://demo.statclients.com/api/v2/order/fetch/datacenter/:product_id/:order_id
Path Parameters
order_id*
String
order identifier string of the document you're looking to fetch
product_id*
enum
product identifier of the document you're looking to fetch. An enum value of one of your existing products.
Headers
X-API-KEY*
String
Authorization Header
Delete an order an all allocated resources
DELETE https://demo.statclients.com/api/v2/order/delete
Headers
X-API-KEY*
String
Request Body
proxy_username*
String
The specific proxy username order to update
product_id*
String
Specific product type the order is set to.
Account Endpoint
Fetch a specific customers order history
GET https://demo.statclients.com/api/v2/account/fetch/details/:customer_id
Path Parameters
:customer_id*
String
The specific discord customer identifier you're looking up
Headers
X-API-KEY*
String
Authorization Header
{"order_history" : [[{"datacenter_details":{"proxy_password":"","proxy_username":"","proxy_port":},"account_details":{"line_items":[]},"_id":"","email":"","currentPeriodStart":,"subscriptionItemId":"","readableOrderDate":"","readableStartDate":"", "unixStart":,"customer_discord_id":"","iso_expiration_date":"","iso_purchase_date":"","order_id":"","order_status":"","product_id":"","product_name":"","quantity":1,"unix_expiration_date":,"url_slug":"","origination":"","product_category":"","stripe_cus_id":""}]}Fetch a specific customers order history with the associated active proxies
GET https://demo.statclients.com/api/v2/account/fetch/all/:customer_id
Path Parameters
:customer_id*
String
The specific discord customer identifier you're looking up
Headers
X-API-KEY*
String
Authorization Header
{"order_history" : [[{"datacenter_details":{"proxy_password":"","proxy_username":"","proxy_port":},"account_details":{"line_items":[]},"_id":"","email":"","currentPeriodStart":,"subscriptionItemId":"","readableOrderDate":"","readableStartDate":"", "unixStart":,"customer_discord_id":"","iso_expiration_date":"","iso_purchase_date":"","order_id":"","order_status":"","product_id":"","product_name":"","quantity":1,"unix_expiration_date":,"url_slug":"","origination":"","product_category":"","stripe_cus_id":""}]}Create a new client-user within the dashboard
POST https://demo.statclients.com/api/v2/account/create
Headers
X-API-KEY*
String
Authorization Header
Request Body
discord_id*
String
discord identifier value of the customer
discord_name*
String
discord username of the customer Charliekicks#0001
email*
String
email value tied to the user (not necessarily their discord email)
Product Endpoint
The products endpoint is your go-to destination for all things product management. From creating new products / services in your dashboard, to fetching the requisite data, to removing them once you're done, You have optionality when it comes to how you interface with your active products.
Fetch specifics about a product
GET https://demo.statclients.com/api/v2/product/fetch/:product_id
Path Parameters
:product_id*
String
The product identifier value. The same as within the url slug on the dashboard
Headers
X-API-KEY*
String
Authorization Header
{"response" : "success", "product" :{"product_category":"","product_description":"","product_id":"","product_name":"","product_type":""}}Fetch all products
GET https://demo.statclients.com/api/v2/product/fetch/
Headers
X-API-KEY*
String
Authorization Header
{
"response" : "success",
"products" :
[
{"product_category":"","product_description":"","product_id":"","product_name":"","product_type":""}
]
}Create a new datacenter service
POST https://demo.statclients.com/api/v2/product/create/datacenter
Headers
X-API-KEY*
String
Authorization Header
Request Body
is_recurring *
String
should the product price set to recurr monthly?
product_description*
String
description of the product
product_name*
String
What should your product be called?
unit_price*
String
What is the price (in US cents) the per unit price should be ?
Last updated
Was this helpful?