void invoice
PATCHhttps://api.suger.cloud/org/:orgId/entitlement/:entitlementId/invoice/:invoiceId/void
Void the invoice. It can be used for manual void or cancel the invoice.
Request
Path Parameters
orgId stringrequired
Organization ID
entitlementId stringrequired
Entitlement ID
invoiceId stringrequired
Invoice ID
Responses
- 200
- 400
- 500
OK
- application/json
- Schema
- Example (from schema)
Schema
buyerID string
Possible values: <= 36 characters
creationTime date-time
endDate date-time
entitlementID string
Possible values: <= 36 characters
id string
Possible values: <= 36 characters
info
object
invoiceURL string
The invoice file URL, provided as AWS S3 presigned URL with expiration time. Output only.
lastUpdateTime date-time
organizationID string
paymentStatus BillingPaymentStatus (string)
Possible values: [PENDING
, PROCESSING
, SUCCESS
, FAILED
]
startDate date-time
status BillingInvoiceStatus (string)
Possible values: [DRAFT
, FINALIZED
, CANCELED
, DELETED
, ``]
type BillingInvoiceType (string)
Possible values: [COMMIT
, USAGE
, ADDON
, INSTALLMENT
]
{
"buyerID": "string",
"creationTime": "2024-07-29T15:51:28.071Z",
"endDate": "2024-07-29T15:51:28.071Z",
"entitlementID": "string",
"id": "string",
"info": {
"addFixedFees": [
{
"endDate": "2024-07-29T15:51:28.071Z",
"quantity": 0,
"rate": 0,
"reason": "string",
"startDate": "2024-07-29T15:51:28.071Z"
}
],
"addonDetail": {
"amount": 0,
"chargeOn": "2024-07-29T15:51:28.071Z",
"description": "string",
"id": "string",
"name": "string"
},
"adjustDiscountByDimensions": [
{
"dimensionKey": "string",
"discount": {
"discountType": "PERCENTAGE",
"value": 0
},
"reason": "string"
}
],
"adjustMinimumSpendByDimensions": [
{
"dimensionKey": "string",
"minimumSpend": 0,
"reason": "string"
}
],
"adjustOverallDiscount": {
"discount": {
"discountType": "PERCENTAGE",
"value": 0
},
"reason": "string"
},
"adjustOverallMinimumSpend": {
"minimumSpend": 0,
"reason": "string"
},
"amount": 0,
"billableDimensionDetails": [
{
"amount": 0,
"billableMetricKey": {
"groupBysExpression": "string",
"id": "string"
},
"category": "basic",
"details": [
{
"descriptions": "string",
"feeExpressions": "string"
}
],
"discount": {
"discountType": "PERCENTAGE",
"value": 0
},
"discountExpression": "string",
"isTrial": true,
"minimumCommit": 0,
"minimumCommitScope": "",
"name": "string",
"quantity": 0
}
],
"commitsRevenueDetails": [
{
"amount": 0,
"description": "string",
"expression": "string",
"key": "string",
"name": "string",
"quantity": 0,
"rate": 0
}
],
"creationDate": "2024-07-29T15:51:28.071Z",
"currency": "string",
"description": "string",
"dueDate": "2024-07-29T15:51:28.071Z",
"gracePeriodInDays": 0,
"issueDate": "2024-07-29T15:51:28.071Z",
"memo": "string",
"netTermsInDays": 0,
"paymentInstallmentsDetail": {
"amount": 0,
"chargeOn": "2024-07-29T15:51:28.071Z",
"description": "string"
},
"receiptUrl": "string",
"spaUrl": "string",
"trialPeriodInDays": 0,
"usageDailyRevenues": [
{
"billableMetricKey": {
"groupBysExpression": "string",
"id": "string"
},
"date": "string",
"quantity": 0,
"uniquePropertyItems": {}
}
]
},
"invoiceURL": "string",
"lastUpdateTime": "2024-07-29T15:51:28.071Z",
"organizationID": "string",
"paymentStatus": "PENDING",
"startDate": "2024-07-29T15:51:28.071Z",
"status": "DRAFT",
"type": "COMMIT"
}
Bad request error
- application/json
- Schema
Schema
string
Internal server error
- application/json
- Schema
Schema
string
- curl
- python
- go
- nodejs
- ruby
- csharp
- php
- java
- powershell
- CURL
curl -L -X PATCH 'https://api.suger.cloud/org/:orgId/entitlement/:entitlementId/invoice/:invoiceId/void' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'
ResponseClear