ServiceChange
Service the purchase can change to, with the price of the change
service objectrequired
Service of the price list, with its category, recurrences, prices and purchase options
service_category objectrequired
Code of the category, for example PEC or CLOUD_STORAGE
Name of the category, in Italian
Code of the area that groups the category, for example HOSTING, DOMAIN or LICENSE
Name of the area, in Italian
Name of the service, in Italian
recurrence objectrequired
Billing recurrence: its frequency and, in days, the timings of renewal, suspension and dismission
frequency objectrequired
Frequency of a recurrence: a number of years, months or weeks, or a one-off charge
Unit of the frequency: Y (years), M (months), W (weeks) or U (one-off, without renewals)
Number of units of the frequency, for example 12 with M; null with U
Days before the expiry from which the purchase can be renewed and the renewal order is created
Days before the expiry when the automatic renewal is attempted
Days after the expiry when a purchase not renewed is suspended; null if it is not suspended
Days after the expiry from which the restore price is charged in addition to the renewal price
Days after the expiry when a purchase not renewed is dismissed
Days after the start of the activation when a purchase never activated is cancelled automatically
Days after the expiry when a purchase whose renewal was not completed is dismissed automatically
Days before the expiry from which additional services can no longer be bought for the purchase
Days before the expiry from which the service of the purchase can no longer be changed
recurrences_available object[]required
Recurrences that can be chosen when buying the service (recurrence_id)
frequency objectrequired
Frequency of a recurrence: a number of years, months or weeks, or a one-off charge
Unit of the frequency: Y (years), M (months), W (weeks) or U (one-off, without renewals)
Number of units of the frequency, for example 12 with M; null with U
Days before the expiry from which the purchase can be renewed and the renewal order is created
Days before the expiry when the automatic renewal is attempted
Days after the expiry when a purchase not renewed is suspended; null if it is not suspended
Days after the expiry from which the restore price is charged in addition to the renewal price
Days after the expiry when a purchase not renewed is dismissed
Days after the start of the activation when a purchase never activated is cancelled automatically
Days after the expiry when a purchase whose renewal was not completed is dismissed automatically
Days before the expiry from which additional services can no longer be bought for the purchase
Days before the expiry from which the service of the purchase can no longer be changed
Id of the TLD of a domain service (GET /api/v3/tlds/{tld_id}); null for the other services
Code of the service, for example CLOUD_STORAGE_100 or BOX_PEC
URL of the cart page of the service
activation_price objectrequired
Activation price of the price list; null for sub-accounts
- Amount
- null
Taxable amount
Currency code: always EUR
VAT rate as a fraction, for example 0.22 for 22%
VAT (tax) amount
Total amount
renew_price objectrequired
Renew price of the price list; null when the service has none and for sub-accounts
- Amount
- null
Taxable amount
Currency code: always EUR
VAT rate as a fraction, for example 0.22 for 22%
VAT (tax) amount
Total amount
restore_price objectrequired
Restore price of the price list; null when the service has none and for sub-accounts
- Amount
- null
Taxable amount
Currency code: always EUR
VAT rate as a fraction, for example 0.22 for 22%
VAT (tax) amount
Total amount
transfer_price objectrequired
Transfer price of the price list; null when the service has none and for sub-accounts
- Amount
- null
Taxable amount
Currency code: always EUR
VAT rate as a fraction, for example 0.22 for 22%
VAT (tax) amount
Total amount
Whether the service can be sold as a primary service
Whether the service is an additional service of a primary one
Whether the service can be bought as an additional service together with its primary service (presale)
Whether the service can be bought as an additional service after the activation of its primary service (aftersale)
Whether the service can be added to the cart more than once; the quantity of one purchase is set by quantity_min and quantity_max
Minimum quantity of the service in one purchase
Maximum quantity of the service in one purchase; null when the quantity cannot be chosen
activation_price objectrequired
Amount in euros: the taxable amount and, when computed with a tax regime, the VAT rate, the VAT and the total, which are null otherwise
Taxable amount
Currency code: always EUR
VAT rate as a fraction, for example 0.22 for 22%
VAT (tax) amount
Total amount
{
"service": {
"service_id": 0,
"service_category": {
"category_code": "string",
"category_name": "string",
"area_code": "string",
"area_name": "string"
},
"service_name": "string",
"recurrence": {
"recurrence_id": 0,
"frequency": {
"family": "string",
"value": 0
},
"days_renew": 0,
"days_autorenew": 0,
"days_suspension": 0,
"days_restore": 0,
"days_dismission": 0,
"days_cancel": 0,
"days_renew_dismission": 0,
"days_no_secondary": 0,
"days_no_service_change": 0
},
"recurrences_available": [
{
"recurrence_id": 0,
"frequency": {
"family": "string",
"value": 0
},
"days_renew": 0,
"days_autorenew": 0,
"days_suspension": 0,
"days_restore": 0,
"days_dismission": 0,
"days_cancel": 0,
"days_renew_dismission": 0,
"days_no_secondary": 0,
"days_no_service_change": 0
}
],
"tld_id": 0,
"service_code": "string",
"service_url": "string",
"activation_price": {
"amount": 0,
"currency": "string",
"tax_rate": 0,
"tax": 0,
"total": 0
},
"renew_price": {
"amount": 0,
"currency": "string",
"tax_rate": 0,
"tax": 0,
"total": 0
},
"restore_price": {
"amount": 0,
"currency": "string",
"tax_rate": 0,
"tax": 0,
"total": 0
},
"transfer_price": {
"amount": 0,
"currency": "string",
"tax_rate": 0,
"tax": 0,
"total": 0
},
"is_primary": true,
"is_secondary": true,
"is_presale": true,
"is_aftersale": true,
"is_quantifiable": true,
"quantity_min": 0,
"quantity_max": 0
},
"activation_price": {
"amount": 0,
"currency": "string",
"tax_rate": 0,
"tax": 0,
"total": 0
}
}