Update invoice discount
curl --request PUT \
--url https://api.useaira.com/v1/invoices/{invoiceId}/discounts/{discountId} \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"targetIdempotencyKey": "<string>",
"description": "<string>",
"amount": 123
}
'import requests
url = "https://api.useaira.com/v1/invoices/{invoiceId}/discounts/{discountId}"
payload = {
"targetIdempotencyKey": "<string>",
"description": "<string>",
"amount": 123
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({targetIdempotencyKey: '<string>', description: '<string>', amount: 123})
};
fetch('https://api.useaira.com/v1/invoices/{invoiceId}/discounts/{discountId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.useaira.com/v1/invoices/{invoiceId}/discounts/{discountId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'targetIdempotencyKey' => '<string>',
'description' => '<string>',
'amount' => 123
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.useaira.com/v1/invoices/{invoiceId}/discounts/{discountId}"
payload := strings.NewReader("{\n \"targetIdempotencyKey\": \"<string>\",\n \"description\": \"<string>\",\n \"amount\": 123\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.useaira.com/v1/invoices/{invoiceId}/discounts/{discountId}")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"targetIdempotencyKey\": \"<string>\",\n \"description\": \"<string>\",\n \"amount\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.useaira.com/v1/invoices/{invoiceId}/discounts/{discountId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"targetIdempotencyKey\": \"<string>\",\n \"description\": \"<string>\",\n \"amount\": 123\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"targetIdempotencyKey": "<string>",
"description": "<string>",
"amount": 123,
"isActive": true
}{
"message": "<string>",
"code": "<string>",
"details": {},
"causations": [
{
"message": "<string>",
"code": "<string>",
"details": {}
}
]
}{
"message": "<string>"
}Invoices
Update invoice discount
Updates a discount on an invoice. The discount origin (reason) is preserved and cannot be changed via the API.
PUT
/
v1
/
invoices
/
{invoiceId}
/
discounts
/
{discountId}
Update invoice discount
curl --request PUT \
--url https://api.useaira.com/v1/invoices/{invoiceId}/discounts/{discountId} \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"targetIdempotencyKey": "<string>",
"description": "<string>",
"amount": 123
}
'import requests
url = "https://api.useaira.com/v1/invoices/{invoiceId}/discounts/{discountId}"
payload = {
"targetIdempotencyKey": "<string>",
"description": "<string>",
"amount": 123
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({targetIdempotencyKey: '<string>', description: '<string>', amount: 123})
};
fetch('https://api.useaira.com/v1/invoices/{invoiceId}/discounts/{discountId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.useaira.com/v1/invoices/{invoiceId}/discounts/{discountId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'targetIdempotencyKey' => '<string>',
'description' => '<string>',
'amount' => 123
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.useaira.com/v1/invoices/{invoiceId}/discounts/{discountId}"
payload := strings.NewReader("{\n \"targetIdempotencyKey\": \"<string>\",\n \"description\": \"<string>\",\n \"amount\": 123\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.useaira.com/v1/invoices/{invoiceId}/discounts/{discountId}")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"targetIdempotencyKey\": \"<string>\",\n \"description\": \"<string>\",\n \"amount\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.useaira.com/v1/invoices/{invoiceId}/discounts/{discountId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"targetIdempotencyKey\": \"<string>\",\n \"description\": \"<string>\",\n \"amount\": 123\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"targetIdempotencyKey": "<string>",
"description": "<string>",
"amount": 123,
"isActive": true
}{
"message": "<string>",
"code": "<string>",
"details": {},
"causations": [
{
"message": "<string>",
"code": "<string>",
"details": {}
}
]
}{
"message": "<string>"
}Authorizations
API Key Authentication.
Body
application/json
Response
Default Response
Available options:
invoice, line_item_group, line_item Available options:
fixed, percentage Available options:
manual_discount, contract_proration, contract_recurring, plan_instance_proration Minimum string length:
1⌘I