Youproxy
  • Welcome
  • How to start
    • Authorization
    • Custom settings
    • Preparations to create an order
    • Extend
    • Possible mistakes
  • API reference
    • Proxy type
    • Balance
    • Country
    • Rent period
    • Mobile operator
    • Promo codes
    • Price calculation
      • Calculate an order
      • Extend by IPs
      • Extend by orders ID
    • Create an order
    • Extend
      • Extend by IP addresses
      • Extend by order IDs
    • Auto-extend
      • Auto-extend by IP addresses
      • Auto-extend by order IDs
    • Get IP addresses
      • Get all
      • Get all by proxy type
      • Get page of all by proxy type
    • Possible errors
Powered by GitBook
On this page
  • Get promo codes
  • Path parameters
  • Response
  1. API reference

Promo codes

Get promo codes

The request allows to view promo codes for account.

GET /client/api/v1/{apiKey}/promoCode

Path parameters

Name
Type
Description

apiKey*

String

Your personal API key.

Response

200: OK Success response
{
    "success": true,
    "promoCodes": [
        {
            "code": "CLIENT-PROMO",
            "countUses": 0,
            "startDate": "2023-10-26T10:49:49.220+00:00",
            "endDate": "2023-11-28T10:49:49.220+00:00",
            "endless": false,
            "discount": 10,
            "descriptionsByLocale": {
                "en": "Description in english locale",
            }
        }
    ],
    "error": null
}
200: OK Error response
{
    "success": false,
    "promoCodes": [],
    "error": {
        "code": 2,
        "message": "Error api key"
    }
}
PreviousMobile operatorNextPrice calculation

Last updated 1 month ago