Veeam Service Provider Console 9.1
REST API Reference
Related documents

Billing

This resource collection represents provided services and their costs.

Get Company Billing Settings

Returns a collection resource representation of billing settings configured for all companies.

Request
query Parameters
Array of objects or null (FilterParameter)

Specifies the conditions that a resource must meet to be returned in the output.

Array of objects or null (SortParameter)

Specifies the order in which resources are returned from the collection.

limit
integer <int32> [ 1 .. 500 ]
Default: 100

Specifies the first N resources that must be returned in the output.

offset
integer <int32> [ 0 .. 2147483647 ]
Default: 0

Excludes the first N resources from the query output.

Array of objects or null (SelectParameter)

Returns explicitly requested properties.

header Parameters
X-Request-id
string <uuid>

Random UID that you can assign to a request for idempotence and async action progress tracking.

Note that an operation is idempotent only during 5 minute time interval.

Example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string

Version of Veeam Service Provider Console RESTful API supported by client.

Example: 3.6.1
Responses
200

OK

202

Request has been queued for execution.

default

All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.

get/organizations/companies/billing/settings/
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get Billing Settings of Company
Returns a resource representation of billing settings configured for a company with the specified UID.


Request 
path Parameters
companyUid
required
string <uuid> 
Company UID.


 
query Parameters
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


get/organizations/companies/{companyUid}/billing/settings/
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Modify Billing Settings of Company
Modifies billing settings for a company wth the specified UID.


Request 
path Parameters
companyUid
required
string <uuid> 
Company UID.


 
query Parameters
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Request Body schema: application/json
required
Array of JSON Patch operations according to RFC 6902.


 Array 
op
required
string
Performed operation.


 Enum: "add" "replace" "test" "remove" "move" "copy"  
value
required
string
Value that is added, replaced, tested or removed by the PATCH operation.


 
path
required
string
JSON Pointer containing path to a target location where the PATCH operation is performed.


 
from
string or null
JSON Pointer containing path to a location from which data is moved or copied.


 
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


patch/organizations/companies/{companyUid}/billing/settings/
Request samples 
application/json
[
  • {
    }
]
Response samples 
application/json
{
  • "data": {
    }
}
Get All Company Invoices
Returns a collection resource representation of invoices generated for all companies.


Request 
query Parameters
fromDate
required
string <date> 
Start timestamp of a searched time range.


 
toDate
required
string <date> 
End timestamp of a searched time range. Total time range must be less than or equal to 1 year.


 
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


get/organizations/companies/billing/invoices/
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All Invoices for Company
Returns a resource representation of all invoices generated for a company with the specified UID.


Request 
path Parameters
companyUid
required
string <uuid> 
Company UID.


 
query Parameters
fromDate
required
string <date> 
Start timestamp of a searched time range.


 
toDate
required
string <date> 
End timestamp of a searched time range. Total time range must be less than or equal to 1 year.


 
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


get/organizations/companies/{companyUid}/billing/invoices
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Generate Invoice for Company
Initiates invoice generation for a company with the specified UID.


Request 
path Parameters
companyUid
required
string <uuid> 
Company UID.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


post/organizations/companies/{companyUid}/billing/generateInvoices
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Generate Quota Usage Report for Company
Initiates quota usage report for a company with the specified UID.


Request 
path Parameters
companyUid
required
string <uuid> 
Company UID.


 
query Parameters
fromDate
required
string <date> 
Start timestamp of a searched time range.


 
toDate
required
string <date> 
End timestamp of a searched time range.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


post/organizations/companies/{companyUid}/billing/generateQuotaUsageReport
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Get Invoice
Returns a resource representation of an invoice with the specified UID.


Request 
path Parameters
invoiceUid
required
string <uuid> 
Invoice UID.


 
query Parameters
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


get/organizations/companies/billing/invoices/{invoiceUid}
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Delete Invoice.
Deletes an invoice with the specified UID.


Request 
path Parameters
invoiceUid
required
string <uuid> 
Invoice UID.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


delete/organizations/companies/billing/invoices/{invoiceUid}
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Download Invoice
Returns a download link to an invoice with the specified UID in the PDF format.


Request 
path Parameters
invoiceUid
required
string <uuid> 
Invoice UID.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Responses 
200
OK


202
Request has been queued for execution.


520
Internal Server Error


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


get/organizations/companies/billing/invoices/{invoiceUid}/pdf
Request samples 
Response samples 
application/json
"blob:https://vspc01.tech.local:1280/ddb406fa-39a9-4995-adfa-e14f627e0fce"
Change Invoice Payment Status
Changes payment status of an invoice with the specified UID.


Request 
path Parameters
invoiceUid
required
string <uuid> 
Invoice UID.


 
query Parameters
status
required
string
Payment status.


 Enum: "Paid" "Unpaid"  
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


post/organizations/companies/billing/invoices/{invoiceUid}/changePaidState
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Send Invoice
Sends an invoice with the specified UID.


Request 
path Parameters
invoiceUid
required
string <uuid> 
Invoice UID.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


post/organizations/companies/billing/invoices/{invoiceUid}/send
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}

    
    

                                

                                    
Document updated 11/06/2025
Page content applies to build 9.1.0.30345