API: Get coupon details

getPromoDetailsByCode

Return coupon details by its code

Required parameters

Parameter	Description
code	Coupon code to find

Request

GET /admin/api.php?api_id=API_ID&api_key=API_KEY&call=getPromoDetailsByCode&code=CODE

PHP Samples

Response

{
    "success": true,
    "coupon": {
        "id": "68",
        "batch_id": "2",
        "active": "1",
        "code": "XO-PAFEQTS34ULN",
        "status": "Active",
        "coupon_type": "cart",
        "type": "percent",
        "applyto": "price",
        "cycle": "once",
        "options": "0",
        "value": "1.00",
        "cycles": {
            "Monthly": "Monthly"
        },
        "products": false,
        "categories": {
            "42": "42"
        },
        "upgrades": "all",
        "addons": false,
        "domains": false,
        "forms": false,
        "expires": "0000-00-00",
        "max_usage": "0",
        "num_usage": "0",
        "clients": "all",
        "client_id": "0",
        "notes": "",
        "max_client_usage": "0",
        "increase_in_days": "0",
        "min_cart_amount": "0.00",
        "prompt_cart_amount": "0.00",
        "lastname": "",
        "firstname": ""
    },
    "call": "getPromoDetailsByCode",
    "server_time": 1696493853
}