Delete Coupon

Delete a coupon from the Rapyd platform.

Deleting a coupon removes it from all customers and subscriptions, but does not affect invoices and payment authorizations that have already been calculated.

This method triggers the Coupon Deleted webhook. This webhook contains the same information as the response.

Parameters

Request Path Parameters

- coupon
- ID of the coupon.

Request Header Parameters

Response Parameters

Code Samples

.NET

using System;

namespace RapydApiRequestSample
{
    class Program
    {
        static void Main(string[] args)
        {
            try
            {
                string coupon = "coupon_629d690ba9aa73791ec3817f143278b3";

                string result = RapydApiRequestSample.Utilities.MakeRequest("DELETE", $"/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(
      'DELETE',
      '/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('delete', '/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='delete', path=f'/v1/coupons/{coupon_id}')
pprint(result)

/v1/coupons/:coupon

Delete Coupon

curl -X delete
https://sandboxapi.rapyd.net/v1/coupons/coupon_629d690ba9aa73791ec3817f143278b3
-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": "2ffeac47-bc44-4139-b024-354cfe52462a"
    },
    "data": {
        "deleted": true,
        "id": "coupon_23f2b97d96ff9b34135ee1065dcef9bf"
    }
}

In this section:

Documentation