Passa al contenuto principale

Service

Service of the price list, with its category, recurrences, prices and purchase options

service_idintegerrequired
service_category objectrequired
category_codestringrequired

Code of the category, for example PEC or CLOUD_STORAGE

category_namestringrequired

Name of the category, in Italian

area_codestring | nullnullablerequired

Code of the area that groups the category, for example HOSTING, DOMAIN or LICENSE

area_namestringrequired

Name of the area, in Italian

service_namestringrequired

Name of the service, in Italian

recurrence objectrequired

Billing recurrence: its frequency and, in days, the timings of renewal, suspension and dismission

recurrence_idintegerrequired
frequency objectrequired

Frequency of a recurrence: a number of years, months or weeks, or a one-off charge

familystringrequired

Unit of the frequency: Y (years), M (months), W (weeks) or U (one-off, without renewals)

valueinteger | nullnullablerequired

Number of units of the frequency, for example 12 with M; null with U

days_renewinteger | nullnullablerequired

Days before the expiry from which the purchase can be renewed and the renewal order is created

days_autorenewinteger | nullnullablerequired

Days before the expiry when the automatic renewal is attempted

days_suspensioninteger | nullnullablerequired

Days after the expiry when a purchase not renewed is suspended; null if it is not suspended

days_restoreinteger | nullnullablerequired

Days after the expiry from which the restore price is charged in addition to the renewal price

days_dismissioninteger | nullnullablerequired

Days after the expiry when a purchase not renewed is dismissed

days_cancelinteger | nullnullablerequired

Days after the start of the activation when a purchase never activated is cancelled automatically

days_renew_dismissioninteger | nullnullablerequired

Days after the expiry when a purchase whose renewal was not completed is dismissed automatically

days_no_secondaryinteger | nullnullablerequired

Days before the expiry from which additional services can no longer be bought for the purchase

days_no_service_changeinteger | nullnullablerequired

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)

  • Array [
  • recurrence_idintegerrequired
    frequency objectrequired

    Frequency of a recurrence: a number of years, months or weeks, or a one-off charge

    familystringrequired

    Unit of the frequency: Y (years), M (months), W (weeks) or U (one-off, without renewals)

    valueinteger | nullnullablerequired

    Number of units of the frequency, for example 12 with M; null with U

    days_renewinteger | nullnullablerequired

    Days before the expiry from which the purchase can be renewed and the renewal order is created

    days_autorenewinteger | nullnullablerequired

    Days before the expiry when the automatic renewal is attempted

    days_suspensioninteger | nullnullablerequired

    Days after the expiry when a purchase not renewed is suspended; null if it is not suspended

    days_restoreinteger | nullnullablerequired

    Days after the expiry from which the restore price is charged in addition to the renewal price

    days_dismissioninteger | nullnullablerequired

    Days after the expiry when a purchase not renewed is dismissed

    days_cancelinteger | nullnullablerequired

    Days after the start of the activation when a purchase never activated is cancelled automatically

    days_renew_dismissioninteger | nullnullablerequired

    Days after the expiry when a purchase whose renewal was not completed is dismissed automatically

    days_no_secondaryinteger | nullnullablerequired

    Days before the expiry from which additional services can no longer be bought for the purchase

    days_no_service_changeinteger | nullnullablerequired

    Days before the expiry from which the service of the purchase can no longer be changed

  • ]
  • tld_idinteger | nullnullablerequired

    Id of the TLD of a domain service (GET /api/v3/tlds/{tld_id}); null for the other services

    service_codestringrequired

    Code of the service, for example CLOUD_STORAGE_100 or BOX_PEC

    service_urlstringrequired

    URL of the cart page of the service

    activation_price objectrequired

    Activation price of the price list; null for sub-accounts

    anyOf
    amountfloatnullablerequired

    Taxable amount

    currencystringrequired

    Currency code: always EUR

    tax_ratefloatnullablerequired

    VAT rate as a fraction, for example 0.22 for 22%

    taxfloatnullablerequired

    VAT (tax) amount

    totalfloatnullablerequired

    Total amount

    renew_price objectrequired

    Renew price of the price list; null when the service has none and for sub-accounts

    anyOf
    amountfloatnullablerequired

    Taxable amount

    currencystringrequired

    Currency code: always EUR

    tax_ratefloatnullablerequired

    VAT rate as a fraction, for example 0.22 for 22%

    taxfloatnullablerequired

    VAT (tax) amount

    totalfloatnullablerequired

    Total amount

    restore_price objectrequired

    Restore price of the price list; null when the service has none and for sub-accounts

    anyOf
    amountfloatnullablerequired

    Taxable amount

    currencystringrequired

    Currency code: always EUR

    tax_ratefloatnullablerequired

    VAT rate as a fraction, for example 0.22 for 22%

    taxfloatnullablerequired

    VAT (tax) amount

    totalfloatnullablerequired

    Total amount

    transfer_price objectrequired

    Transfer price of the price list; null when the service has none and for sub-accounts

    anyOf
    amountfloatnullablerequired

    Taxable amount

    currencystringrequired

    Currency code: always EUR

    tax_ratefloatnullablerequired

    VAT rate as a fraction, for example 0.22 for 22%

    taxfloatnullablerequired

    VAT (tax) amount

    totalfloatnullablerequired

    Total amount

    is_primaryboolean | nullnullablerequired

    Whether the service can be sold as a primary service

    is_secondaryboolean | nullnullablerequired

    Whether the service is an additional service of a primary one

    is_presaleboolean | nullnullablerequired

    Whether the service can be bought as an additional service together with its primary service (presale)

    is_aftersaleboolean | nullnullablerequired

    Whether the service can be bought as an additional service after the activation of its primary service (aftersale)

    is_quantifiableboolean | nullnullablerequired

    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

    quantity_mininteger | nullnullablerequired

    Minimum quantity of the service in one purchase

    quantity_maxinteger | nullnullablerequired

    Maximum quantity of the service in one purchase; null when the quantity cannot be chosen

    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
    }