Delete Invoice

Delete an invoice.

You can delete an invoice when status is draft.

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

Parameters

Request Path Parameters

- invoice
- ID of the invoice you want to delete.

Request Header Parameters

Response Parameters

Code Samples

.NET

using System;

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

                string result = RapydApiRequestSample.Utilities.MakeRequest("DELETE", $"/v1/invoices/{invoice}");

                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/invoices/invoice_dd9571ff036045f717b8378ed2c671b7'
    );

    console.log(result);
  } catch (error) {
    console.error('Error completing request', error);
  }
}

PHP

<?php
$path .= "/<path-to-your-utility-file>/utilities.php";
include($path);

try {
    $object = make_request('delete', "/v1/invoices/invoice_dd9571ff036045f717b8378ed2c671b7");
    var_dump($object);
} catch(Exception $e) {
    echo "Error: $e";
}
?>

Python

from pprint import pprint

from utilities import make_request

result = make_request(method='delete', path='/v1/invoices/invoice_dd9571ff036045f717b8378ed2c671b7')
pprint(result)

/v1/invoices/:invoice

Delete Invoice

curl -X delete
https://sandboxapi.rapyd.net/v1/invoices/invoice_dd9571ff036045f717b8378ed2c671b7
-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": "e6bc9e36-1981-4c46-91af-27b4eb33a3b4"
   },
   "data": {
       "deleted": true,
       "id": "invoice_dd9571ff036045f717b8378ed2c671b7"
   }
}

In this section:

Documentation