Skip to main content

Documentation

Retrieve Coupon

Retrieve a coupon.

    • coupon

    • ID of the coupon. String starting with coupon_.

Code Samples
    • .NET

      • using System;
        
        namespace RapydApiRequestSample
        {
            class Program
            {
                static void Main(string[] args)
                {
                    try
                    {
                        string coupon = "coupon_629d690ba9aa73791ec3817f143278b3";
                        string result = RapydApiRequestSample.Utilities.MakeRequest("GET", $"/v1/coupons/{coupon}");
        
                        Console.WriteLine(result);
                    }
                    catch (Exception e)
                    {
                        Console.WriteLine("Error completing request: " + e.Message);
                    }
                }
            }
        }
        
    • JavaScript

      • const makeRequest = require('<path-to-your-utility-file>/utilities').makeRequest;
        
        async function main() {
          try {
            const result = await makeRequest('GET', '/v1/coupons/coupon_629d690ba9aa73791ec3817f143278b3');
        
            console.log(result);
          } catch (error) {
            console.error('Error completing request', error);
          }
        }
    • PHP

      • <?php
        $path = $_SERVER['DOCUMENT_ROOT'];
        $path .= "/<path-to-your-utility-file>/utilities.php";
        include($path);
        
        try {
            $object = make_request('get', "/v1/coupons/coupon_629d690ba9aa73791ec3817f143278b3");
            var_dump($object);
        } catch(Exception $e) {
            echo "Error =>$e";
        }
        ?>
    • Python

      • from pprint import pprint
        
        from utilities import make_request
        
        coupon_id = "coupon_629d690ba9aa73791ec3817f143278b3"
        result = make_request(method='get', path=f'/v1/coupons/{coupon_id}')
        pprint(result)
  • /v1/coupons/:coupon

  • Retrieve Coupon

  • curl -X get
    https://sandboxapi.rapyd.net/v1/coupons/coupon_72b8f33846b06f9e7fb0d12cccf98061
    -H 'access_key: your-access-key-here'
    -H 'Content-Type: application/json'
    -H 'salt: your-random-string-here'
    -H 'signature: your-calculated-signature-here'
    -H 'timestamp: your-unix-timestamp-here'
    
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "6b3b5466-c903-470b-8795-ef0bd4efc81d"
        },
        "data": {
            "id": "coupon_72b8f33846b06f9e7fb0d12cccf98061",
            "amount_off": 0,
            "created": 1646817710,
            "currency": "",
            "duration": "repeating",
            "duration_in_months": 3,
            "max_redemptions": 0,
            "metadata": {
                "coupon_type": "Holiday promotion"
            },
            "percent_off": 10,
            "redeem_by": 0,
            "times_redeemed": 0,
            "discount_valid_until": 0,
            "discount_validity_in_months": 0,
            "discount_duration_in_uses": 0,
            "description": "",
            "valid": false
        }
    }