Skip to main content
POST
/
v1
/
invoices
/
{invoiceId}
/
discounts
Create invoice discount
curl --request POST \
  --url https://api.useaira.com/v1/invoices/{invoiceId}/discounts \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "targetIdempotencyKey": "<string>",
  "description": "<string>",
  "amount": 123
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "targetIdempotencyKey": "<string>",
  "description": "<string>",
  "amount": 123,
  "isActive": true
}

Authorizations

​
X-API-KEY
string
header
required

API Key Authentication.

Path Parameters

​
invoiceId
string<uuid>
required

Body

application/json
​
target
enum<string>
required
Available options:
invoice,
line_item_group,
line_item
​
targetIdempotencyKey
string
required
​
method
enum<string>
required
Available options:
fixed,
percentage
​
description
string
required
Minimum string length: 1
​
amount
number
required

Response

Default Response

​
id
string<uuid>
required
​
target
enum<string>
required
Available options:
invoice,
line_item_group,
line_item
​
targetIdempotencyKey
string
required
​
method
enum<string>
required
Available options:
fixed,
percentage
​
reason
enum<string>
required
Available options:
manual_discount,
contract_proration,
contract_recurring,
plan_instance_proration
​
description
string
required
Minimum string length: 1
​
amount
number
required
​
isActive
boolean
required