Veeam Service Provider Console 9.1
REST API Reference
Related documents

Subscription Plans

This resource collection represents subscription plans configured in Veeam Service Provider Console.

Get Subscription Plan Assigned to Company

Returns a resource representation of a subscription plan assigned to a company with the specified UID. If there is no subscription plan assigned the response will be empty.

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}/subscriptionPlan
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Get All Subscription Plans
Returns a collection resource representation of all subscription plans.


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/subscriptionPlans
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Create Subscription Plan
Creates a subscription plan.


Request 
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
Subscription plan model.


name
required
string  [ 1 .. 100 ] characters 
Name of a subscription plan.


 
currency
required
string
Currency chosen for a subscription plan.


 
taxType
required
string
Tax type specified for a subscription plan.


 Enum: "Unknown" "VAT" "GST" "SalesTax"  
taxPercent
required
number <double>   [ 0 .. 100 ] 
Tax amount, in percent.


 
discountPercent
required
number <double>   [ 0 .. 100 ] 
Discount amount, in percent.


 
description
string or null  [ 0 .. 2048 ] characters 
Description of a subscription plan.


 
object
Charge rates for managed backup services.


 
object
Charge rates for public cloud protection services.


 
object
Charge rates for managed Veeam Backup for Microsoft 365 services.


 
object
Charge rates for resources consumed by cloud VM replicas.


 
object
Charge rates for managed file share backup services.


 
object
Charge rates for storing backups in cloud repositories.


 
object
Charge rates for consumed license units.


 
Array of objects (SubscriptionPlanExternalPlugin) 
Array of charges for usage of services provided with external plugin functionality.


 
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/subscriptionPlans
Request samples 
application/json
{
  • "name": "Pittsburgh subscription plan",
  • "description": "Subscription plan for Pittsburgh clients",
  • "currency": "USD",
  • "taxType": "VAT",
  • "taxPercent": 10,
  • "discountPercent": 12,
  • "managedBackup": {
    },
  • "publicCloud": {
    },
  • "vb365": {
    },
  • "cloudReplication": {
    },
  • "fileShareBackup": {
    },
  • "cloudBackup": {
    },
  • "licenses": {
    },
  • "externalPlugins": [ ]
}
Response samples 
application/json
{
  • "data": {
    }
}
Get Subscription Plan
Returns a resource representation of a subscription plan with the specified UID.


Request 
path Parameters
subscriptionPlanUid
required
string <uuid> 
Subscription plan 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/subscriptionPlans/{subscriptionPlanUid}
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Modify Subscription Plan
Modifies a subscription plan with the specified UID.


Request 
path Parameters
subscriptionPlanUid
required
string <uuid> 
Subscription plan 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/subscriptionPlans/{subscriptionPlanUid}
Request samples 
application/json
[
  • {
    },
  • {
    },
  • {
    }
]
Response samples 
application/json
{
  • "data": {
    }
}
Delete Subscription Plan
Deletes a subscription plan with the specified UID.


Request 
path Parameters
subscriptionPlanUid
required
string <uuid> 
Subscription plan 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/subscriptionPlans/{subscriptionPlanUid}
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Get Companies by Subscription Plan
Returns a collection resource representation of all companies to which a subscription plan with the specified UID is assigned.


Request 
path Parameters
subscriptionPlanUid
required
string <uuid> 
Subscription plan UID.


 
query Parameters
expand
Array of strings (CompanyExpand) 
Includes a resource representation of the root entities in the embedded property of a response.


Items Value: "Organization"  
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/subscriptionPlans/{subscriptionPlanUid}/companies
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

    
    

                                

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