PdiPlan¶

An APS resource of this APS type represents a plan of a product.

In this document:

Schema
Properties
Relationship
Custom Operations
Structures
Examples

Schema ¶

The considered APS type (download) extends the Resource, ServiceProfile APS type(s) and looks as follows:

{
  "name": "PdiPlan",
  "id": "http://com.odin.platform/inhouse-products/pdiPlan/1.0",
  "apsVersion": "2.0",
  "implements": [
    "http://aps-standard.org/types/core/resource/1.0",
    "http://aps-standard.org/types/core/profile/service/1.0"
  ],
  "relations": {
    "products": {
      "type": "http://com.odin.platform/inhouse-products/pdiProduct/1.0",
      "collection": true
    },
    "operatingUnits": {
      "type": "http://parallels.com/aps/types/pa/account/1.2",
      "collection": true,
      "backrel": false
    },
    "account": {
      "type": "http://parallels.com/aps/types/pa/account/1.2",
      "required": true,
      "backrel": false
    },
    "productLine": {
      "type": "http://com.odin.platform/inhouse-products/productLine/1.0"
    },
    "bundleProductLine": {
      "type": "http://com.odin.platform/inhouse-products/bundleProductLine/1.0"
    }
  },
  "properties": {
    "autoRenewPlanPeriodId": {
      "type": "integer",
      "title": "Auto renew period id"
    },
    "autoRenewPlanId": {
      "type": "integer",
      "title": "Auto renew plan id"
    },
    "name": {
      "type": "http://aps-standard.org/types/core/i18n/1.3#MLString",
      "title": "Service Plan Name"
    },
    "description": {
      "type": "http://aps-standard.org/types/core/i18n/1.3#MLString",
      "title": "Product Description"
    },
    "bssServicePlanId": {
      "type": "integer",
      "title": "BSS Service Plan Identity"
    },
    "copiedFromBssServicePlanId": {
      "type": "integer",
      "title": "BSS Service Plan Identity"
    },
    "serviceTemplateId": {
      "type": "integer",
      "title": "BSS Service Plan Identity"
    },
    "isDefault": {
      "type": "boolean",
      "title": "Is it default vendor service plan?"
    },
    "customIconUrl": {
      "type": "string",
      "title": "Service plan custom icon url"
    },
    "isOneTimeFeePlan": {
      "type": "boolean",
      "default": "true",
      "title": "Is product the One-Time fee plan?"
    },
    "billingPeriod": {
      "type": "integer",
      "default": "1",
      "title": "Subscription Period"
    },
    "billingPeriodType": {
      "type": "string",
      "default": "month",
      "title": "Billing Period Type",
      "enum": [
        "month",
        "year",
        "psd"
      ]
    },
    "pricePeriodType": {
      "type": "string",
      "default": "billing period",
      "title": "Price Period Type",
      "enum": [
        "Billing Period",
        "Month"
      ]
    },
    "planCategory": {
      "type": "string",
      "title": "Plan Category"
    },
    "appId": {
      "type": "string",
      "title": "Application id"
    },
    "billingModel": {
      "type": "string",
      "default": "Charge Before Billing Period",
      "title": "Billing Model",
      "enum": [
        "Charge Before Billing Period",
        "Charge After Billing Period",
        "Charge Before Subscription Period",
        "Use External Rating",
        "One Time"
      ]
    },
    "autoRenewType": {
      "type": "string",
      "default": "Before Expiration",
      "title": "Auto Renew Type",
      "enum": [
        "Disabled",
        "On Last Statement Day",
        "Before Expiration"
      ]
    },
    "renewOrderInterval": {
      "type": "integer",
      "title": "Renew Order Interval"
    },
    "vendorTimezone": {
      "type": "string",
      "title": "Vendor Timezone"
    },
    "subscriptionPeriods": {
      "type": "array",
      "title": "Subscription Periods",
      "items": {
        "type": "SubscriptionPeriod"
      }
    },
    "salesCategories": {
      "type": "array",
      "title": "Sales Categories",
      "items": {
        "type": "SalesCategory"
      }
    },
    "serviceTerms": {
      "type": "ServiceTerms",
      "title": "Subscription Service Terms"
    },
    "termsAndConditions": {
      "type": "array",
      "title": "Terms",
      "items": {
        "type": "TermsAndConditions"
      }
    },
    "availableNotifications": {
      "type": "array",
      "title": "Notifications available for product",
      "items": {
        "type": "NotificationTemplateMapping"
      }
    },
    "enabledNotifications": {
      "type": "array",
      "title": "Notifications enabled for product",
      "items": {
        "type": "NotificationTemplateMapping"
      }
    },
    "servicePlanUpdateNotificationId": {
      "type": "string",
      "title": "Change service plan notification Id"
    },
    "alignWithStatementDay": {
      "type": "boolean",
      "default": "false",
      "title": "Align Billing Order with Statement Day"
    },
    "isSalesOrderProrated": {
      "type": "boolean",
      "default": "false",
      "title": "Is Billing Sales Order prorated"
    },
    "isFirstPeriodForFree": {
      "type": "boolean",
      "default": "false",
      "title": "First Billing Period For Free"
    },
    "customStatementDay": {
      "type": "integer",
      "default": "0",
      "title": "New Day of Statement"
    },
    "isPublished": {
      "type": "boolean",
      "default": "false",
      "title": "Is the plan published for customers?"
    },
    "isAllowedScheduledChanges": {
      "type": "boolean",
      "default": "false",
      "title": "Is Allowed Scheduled Changes?"
    },
    "notificationScheduleId": {
      "type": "integer",
      "title": "Notification Schedule ID"
    },
    "resellerGroups": {
      "type": "array",
      "title": "Reseller groups",
      "items": {
        "type": "ResellerGroup"
      }
    },
    "volumePricingRatingMode": {
      "type": "boolean",
      "default": "false",
      "title": "Volume Pricing Rating Mode"
    },
    "ratingMode": {
      "type": "string",
      "title": "Rating Integration Mode",
      "enum": [
        "Costs only",
        "Revenue only",
        "Revenue and Costs"
      ]
    },
    "billingPeriodAlignment": {
      "type": "string",
      "default": "Subscription Period Start",
      "title": "Billing Period Alignment",
      "enum": [
        "Subscription Period Start",
        "Subscription Period Expiration"
      ]
    },
    "coTermingPossibilities": {
      "type": "string",
      "default": "Restricted",
      "title": "Coterming Possibilities",
      "enum": [
        "Restricted",
        "Allowed",
        "Fixed Date Provided by Vendor"
      ]
    },
    "expDateAlignedWithEndOfMonth": {
      "type": "boolean",
      "default": "false",
      "title": "Is Expiration Date Aligned With End of Month?"
    },
    "expDateAlignedWithSubscr": {
      "type": "boolean",
      "default": "false",
      "title": "Is Expiration Date Aligned With Subscription?"
    },
    "billingAlignmentResellerRedefineAllowed": {
      "type": "boolean",
      "default": "false",
      "title": "Allow Reseller to Redefine Billing Alignment"
    }
  },
  "operations": {
    "delegate": {
      "path": "delegate",
      "verb": "POST",
      "errorResponse": {
        "type": "object"
      },
      "parameters": {
        "resellerId": {
          "kind": "query",
          "type": "array"
        }
      }
    },
    "updateSwitchPath": {
      "path": "/switchPathPolicy",
      "verb": "PUT",
      "response": {
        "type": "object"
      },
      "errorResponse": {
        "type": "object"
      }
    },
    "getPlanSwitchPaths": {
      "path": "/switchPathPolicy/{bssServicePlanId}",
      "verb": "GET",
      "response": {
        "type": "object"
      },
      "errorResponse": {
        "type": "object"
      },
      "parameters": {
        "bssServicePlanId": {
          "kind": "path",
          "type": "string"
        }
      }
    }
  },
  "structures": {
    "MLString": {
      "type": "object",
      "properties": {
        "ar_AE": {
          "type": "string",
          "description": "Arabic, Standard - United Arab Emirates"
        },
        "bg_BG": {
          "type": "string",
          "description": "Bulgarian - Bulgaria"
        },
        "cs_CZ": {
          "type": "string",
          "description": "Czech - Czech Republic"
        },
        "da_DK": {
          "type": "string",
          "description": "Danish - Denmark"
        },
        "de_DE": {
          "type": "string",
          "description": "German - Germany"
        },
        "el_GR": {
          "type": "string",
          "description": "Greek - Greece"
        },
        "en_US": {
          "type": "string",
          "description": "English - United States"
        },
        "es_ES": {
          "type": "string",
          "description": "Spanish - Spain"
        },
        "fr_FR": {
          "type": "string",
          "description": "French - France"
        },
        "he_IL": {
          "type": "string",
          "description": "Hebrew - Israel"
        },
        "iw_IL": {
          "type": "string",
          "description": "Iwrit - Israel"
        },
        "hr_HR": {
          "type": "string",
          "description": "Croatian - Croatia"
        },
        "hu_HU": {
          "type": "string",
          "description": "Hungarian - Hungary"
        },
        "id_ID": {
          "type": "string",
          "description": "Indonesian - Indonesia"
        },
        "it_IT": {
          "type": "string",
          "description": "Italian - Italy"
        },
        "ja_JP": {
          "type": "string",
          "description": "Japanese - Japan"
        },
        "ko_KR": {
          "type": "string",
          "description": "Korean - Korea"
        },
        "kz_KZ": {
          "type": "string",
          "description": "Kazakh - Kazakhstan"
        },
        "mk_MK": {
          "type": "string",
          "description": "Macedonian - Macedonia"
        },
        "nl_NL": {
          "type": "string",
          "description": "Dutch - The Netherlands"
        },
        "no_NO": {
          "type": "string",
          "description": "Norwegian - Norway"
        },
        "pl_PL": {
          "type": "string",
          "description": "Polish - Poland"
        },
        "pt_BR": {
          "type": "string",
          "description": "Portuguese - Brazil"
        },
        "pt_PT": {
          "type": "string",
          "description": "Portuguese - Portugal"
        },
        "ro_RO": {
          "type": "string",
          "description": "Romanian - Romania"
        },
        "ru_RU": {
          "type": "string",
          "description": "Russian - Russia"
        },
        "sv_SE": {
          "type": "string",
          "description": "Swedish - Sweden"
        },
        "th_TH": {
          "type": "string",
          "description": "Thai - Thailand"
        },
        "tr_TR": {
          "type": "string",
          "description": "Turkish - Turkey"
        },
        "zh_CN": {
          "type": "string",
          "description": "Chinese, Simplified - China"
        },
        "sl_SI": {
          "type": "string",
          "description": "Slovenian - Slovenia"
        },
        "sr_RS": {
          "type": "string",
          "description": "Serbian - Serbia"
        },
        "xx_XA": {
          "type": "string",
          "description": "Reserved 1"
        },
        "xx_XB": {
          "type": "string",
          "description": "Reserved 2"
        },
        "xx_XC": {
          "type": "string",
          "description": "Reserved 3"
        },
        "xx_XD": {
          "type": "string",
          "description": "Reserved 4"
        },
        "xx_XE": {
          "type": "string",
          "description": "Reserved 5"
        },
        "xx_XF": {
          "type": "string",
          "description": "Reserved 6"
        },
        "xx_XG": {
          "type": "string",
          "description": "Reserved 7"
        },
        "xx_XH": {
          "type": "string",
          "description": "Reserved 8"
        },
        "xx_XI": {
          "type": "string",
          "description": "Reserved 9"
        },
        "xx_XJ": {
          "type": "string",
          "description": "Reserved 10"
        }
      }
    },
    "Period": {
      "type": "object"
    },
    "PricePeriodType": {
      "type": "object"
    },
    "BillingModel": {
      "type": "object"
    },
    "AutoRenewType": {
      "type": "object"
    },
    "SubscriptionPeriod": {
      "type": "object",
      "properties": {
        "bssId": {
          "type": "integer",
          "default": "",
          "title": "BSS Subscription Period Id"
        },
        "active": {
          "type": "boolean",
          "default": "true",
          "title": "Is Active"
        },
        "period": {
          "type": "integer",
          "default": "1",
          "title": "Subscription Period Duration"
        },
        "periodType": {
          "type": "string",
          "default": "month",
          "title": "Subscription Period Type",
          "enum": [
            "month",
            "year"
          ]
        },
        "cancellationFeeType": {
          "type": "string",
          "default": "none",
          "title": "Subscription Cancellation Fee Type",
          "enum": [
            "none",
            "until_expiration",
            "custom"
          ]
        },
        "cancellationFeeValue": {
          "type": "sting",
          "default": "",
          "title": "Cancellation Fee Formula"
        },
        "isAutoRenewPeriod": {
          "type": "boolean",
          "default": "false",
          "title": "Is Auto Renew Period"
        },
        "isTrial": {
          "type": "boolean",
          "default": "false",
          "title": "Is Trial"
        },
        "afterRefundPeriod": {
          "type": "string",
          "default": "no_refund",
          "title": "After Refund Period",
          "enum": [
            "no_refund",
            "refund_prorated_recurring_fee"
          ]
        },
        "fullRefundPeriod": {
          "type": "integer",
          "default": "0",
          "title": "Full Refund Period"
        },
        "cancelationPolicies": {
          "type": "array",
          "title": "Cancelation Policies",
          "items": {
            "type": "PlanPeriodPolicy"
          }
        },
        "downsizePolicies": {
          "type": "array",
          "title": "Downsize Policies",
          "items": {
            "type": "PlanPeriodPolicy"
          }
        }
      }
    },
    "SubscriptionPeriodType": {
      "type": "object"
    },
    "SubscriptionCancellationFeeType": {
      "type": "object"
    },
    "SubscriptionAfterRefundPeriod": {
      "type": "object"
    },
    "PlanPeriodPolicy": {
      "type": "object",
      "properties": {
        "policyType": {
          "type": "string",
          "title": "Policy Type",
          "enum": [
            "simplified",
            "advanced"
          ]
        },
        "action": {
          "type": "string",
          "title": "Action",
          "enum": [
            "full_refund",
            "prorated_refund",
            "no_refund",
            "prohibited",
            "penalty",
            "not_allowed_except_for_after_upsize"
          ]
        },
        "actionPeriod": {
          "type": "integer",
          "title": "Action Period"
        },
        "actionPeriodTimezone": {
          "type": "string",
          "title": "Action Period Timezone",
          "enum": [
            "customer",
            "from_plan"
          ]
        },
        "applicableTo": {
          "type": "string",
          "title": "Applicable To",
          "enum": [
            "first_subscription_period",
            "next_subscription_periods",
            "all_subscription_periods"
          ]
        }
      }
    },
    "Action": {
      "type": "object"
    },
    "ActionPeriodTimezone": {
      "type": "object"
    },
    "ApplicableTo": {
      "type": "object"
    },
    "SalesCategory": {
      "type": "object",
      "properties": {
        "expand": {
          "type": "boolean"
        },
        "inCCP": {
          "type": "boolean"
        }
      }
    },
    "ServiceTerms": {
      "type": "object",
      "properties": {
        "bssId": {
          "type": "integer"
        },
        "serviceTermsName": {
          "type": "string"
        },
        "destroyAfterHold": {
          "type": "boolean",
          "required": true,
          "default": "false"
        },
        "holdPeriodInDays": {
          "type": "integer",
          "required": true,
          "default": "0"
        },
        "gracePeriodInDays": {
          "type": "integer",
          "required": true,
          "default": "0"
        },
        "trialDestroyAfterHold": {
          "type": "boolean",
          "required": true,
          "default": "false"
        },
        "trialHoldPeriodInDays": {
          "type": "integer",
          "required": true,
          "default": "0"
        },
        "trialGracePeriodInDays": {
          "type": "integer",
          "required": true,
          "default": "0"
        }
      }
    },
    "TermsAndConditions": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "required": true
        },
        "bssId": {
          "type": "integer",
          "required": true
        },
        "name": {
          "type": "string",
          "title": "Name of term"
        },
        "value": {
          "type": "string",
          "title": "Value of term"
        },
        "isDeleted": {
          "type": "boolean",
          "default": "false",
          "title": "Flag for Terms that needed to be removed"
        },
        "type": {
          "type": "string",
          "title": "Term Type",
          "enum": [
            "plain_text",
            "link"
          ]
        },
        "ownerAccountId": {
          "type": "integer",
          "title": "Owner account id"
        },
        "acceptType": {
          "type": "string",
          "title": "Acceptance",
          "enum": [
            "Always, on every purchase",
            "On first purchase and after every T\u0026C change",
            "Only on a first purchase",
            "On every purchase and after every T\u0026C change"
          ]
        }
      }
    },
    "NotificationTemplateMapping": {
      "type": "object",
      "properties": {
        "templateType": {
          "type": "string",
          "title": "Notification Template Type",
          "enum": [
            "welcome_email",
            "expiration_email"
          ]
        },
        "templateName": {
          "type": "string",
          "title": "Notification Template Name"
        }
      }
    },
    "TemplateType": {
      "type": "object"
    },
    "ResellerGroup": {
      "type": "object",
      "properties": {
        "id": {
          "type": "integer"
        },
        "name": {
          "type": "MLString"
        }
      }
    },
    "RatingMode": {
      "type": "object"
    },
    "BillingPeriodAlignment": {
      "type": "object"
    },
    "CoTermingPossibilities": {
      "type": "object"
    }
  }
}

Properties ¶

NAME	TYPE	ATTRIBUTES	DEFAULT	DESCRIPTION
autoRenewPlanPeriodId	Integer	Not Required
autoRenewPlanId	Integer	Not Required
name	I18n	Not Required		The name of the plan The type of this parameter is MLString.
description	I18n	Not Required		The description of the plan The type of this parameter is MLString.
bssServicePlanId	Integer	Not Required		The CloudBlue Commerce identifier of the service plan of the plan
copiedFromBssServicePlanId	Integer	Not Required
serviceTemplateId	Integer	Not Required		The CloudBlue Commerce identifier of the service template of the plan
isDefault	Boolean	Not Required		Defines whether the plan is default.
customIconUrl	String	Not Required		The custom icon URL of the plan
isOneTimeFeePlan	Boolean	Not Required	true
billingPeriod	Integer	Not Required	1	The length of the billing period of the plan
billingPeriodType	Enum	Not Required	month	\| The billing period type of the plan The supported values are: `month` - The Month type `year` - The Year type `psd` - The Periodically on Statement Day type
pricePeriodType	Enum	Not Required	billing period	\| The price period type of the plan The supported values are: `billing period` - The Billing Period type `month` - The Month type
planCategory	String	Not Required		The plan category of the plan
appId	String	Not Required		The identifier of the external application of the product that the plan belongs to
billingModel	Enum	Not Required	Charge Before Billing Period	\| The billing model used by the plan The supported values are: `charge before billing period` - The Charge Before Billing Period (BBP) billing model `charge after billing period` - The Charge After Billing Period (ABP) billing model `charge before subscription period` - The Charge Before Subscription Period (BSP) billing model `use external rating` - The Use External Rating billing model
autoRenewType	Enum	Not Required	Before Expiration	\| The auto-renewal type of the plan The supported values are: `Disabled` - The Disabled type `On Last Statement Day` - The On Last Statement Day type `Before Expiration` - The Before Expiration type
renewOrderInterval	Integer	Not Required		The renewal order interval of the plan
vendorTimezone	String	Not Required		The time zone of the vendor of the product that the plan belongs to
subscriptionPeriods	Array of SubscriptionPeriod	Not Required		The subscription periods of the plan
salesCategories	Array of SalesCategory	Not Required		The sales categories of the plan
serviceTerms	ServiceTerms	Not Required		The Service Terms item of the plan
termsAndConditions	Array of TermsAndConditions	Not Required		The Terms and Conditions items of the plan
availableNotifications	Array of NotificationTemplateMapping	Not Required		The available notifications of the plan
enabledNotifications	Array of NotificationTemplateMapping	Not Required		The enabled notifications of the plan
servicePlanUpdateNotificationId	String	Not Required		The identifier of the service plan update notification (used internally)
alignWithStatementDay	Boolean	Not Required	false	Defines whether to align billing orders with the statement day.
isSalesOrderProrated	Boolean	Not Required	false	Defines whether to align sales orders with the statement day.
isFirstPeriodForFree	Boolean	Not Required	false	Defines whether the first billing period is free.
customStatementDay	Integer	Not Required	0	A custom statement day
isPublished	Boolean	Not Required	false	Defines whether the plan is published.
isAllowedScheduledChanges	Boolean	Not Required	false
notificationScheduleId	Integer	Not Required		The identifier of the notification schedule of the plan
resellerGroups	Array of ResellerGroup	Not Required		The reseller groups of the plan
volumePricingRatingMode	Boolean	Not Required	false	Defines whether volume pricing rating mode is on.
ratingMode	Enum	Not Required		Rating Integration mode Rating mode `Costs only` - Costs only `Revenue only` - Revenue only `Revenue and Costs` - Revenue and Costs
billingPeriodAlignment	Enum	Not Required	Subscription Period Start	Co-terming billing period alignment
coTermingPossibilities	Enum	Not Required	Restricted	Co-terming possibilities
expDateAlignedWithEndOfMonth	Boolean	Not Required	false	Is Expiration Date Aligned With End of Month
expDateAlignedWithSubscr	Boolean	Not Required	false	Is Expiration Date Aligned With Subscription
billingAlignmentResellerRedefineAllowed	Boolean	Not Required	false	Is Reseller Allowed to Redefine Billing Alignment

Relationship ¶

NAME	TYPE	REQUIRED	DESCRIPTION
products	Collection of PdiProduct	No	The products included in the plan
operatingUnits	Collection of PAAccount	No	The operating units of the plan
account	PAAccount	Yes	The account that the plan belongs to
productLine	ProductLine	No	The product line of the products included in the plan
bundleProductLine	BundleProductLine	No	Related bundle product line

Custom Operations ¶

OPERATION	VERB	PATH
delegate	POST	/delegate
updateSwitchPath	PUT	/switchPathPolicy
getPlanSwitchPaths	GET	/switchPathPolicy/{bssServicePlanId}

delegate¶

HTTP Request

POST /aps/2/resources/{aps-id}/delegate

Description

Parameters

PARAMETER	TYPE	DESCRIPTION
resellerId	Array

Returns

updateSwitchPath¶

HTTP Request

PUT /aps/2/resources/{aps-id}/switchPathPolicy

Description

Returns

getPlanSwitchPaths¶

HTTP Request

GET /aps/2/resources/{aps-id}/switchPathPolicy/{bssServicePlanId}

Description

Parameters

PARAMETER	TYPE	DESCRIPTION
bssServicePlanId	String

Returns

Structures ¶

MLString¶

A structure of this kind represents a multi-language string.

NAME	TYPE	ATTRIBUTES	DESCRIPTION
ar_AE	String	Not Required	The value of the string for Arabic, Standard - United Arab Emirates
bg_BG	String	Not Required	The value of the string for Bulgarian - Bulgaria
cs_CZ	String	Not Required	The value of the string for Czech - Czech Republic
da_DK	String	Not Required	The value of the string for Danish - Denmark
de_DE	String	Not Required	The value of the string for German - Germany
el_GR	String	Not Required	The value of the string for Greek - Greece
en_US	String	Not Required	The value of the string for English - United States
es_ES	String	Not Required	The value of the string for Spanish - Spain
fr_FR	String	Not Required	The value of the string for French - France
he_IL	String	Not Required	The value of the string for Hebrew - Israel
iw_IL	String	Not Required	The value of the string for Iwrit - Israel
hr_HR	String	Not Required	The value of the string for Croatian - Croatia
hu_HU	String	Not Required	The value of the string for Hungarian - Hungary
id_ID	String	Not Required	The value of the string for Indonesian - Indonesia
it_IT	String	Not Required	The value of the string for Italian - Italy
ja_JP	String	Not Required	The value of the string for Japanese - Japan
ko_KR	String	Not Required	The value of the string for Korean - Korea
kz_KZ	String	Not Required	The value of the string for Kazakh - Kazakhstan
mk_MK	String	Not Required	The value of the string for Macedonian - Macedonia
nl_NL	String	Not Required	The value of the string for Dutch - The Netherlands
no_NO	String	Not Required	The value of the string for Norwegian - Norway
pl_PL	String	Not Required	The value of the string for Polish - Poland
pt_BR	String	Not Required	The value of the string for Portuguese - Brazil
pt_PT	String	Not Required	The value of the string for Portuguese - Portugal
ro_RO	String	Not Required	The value of the string for Romanian - Romania
ru_RU	String	Not Required	The value of the string for Russian - Russia
sv_SE	String	Not Required	The value of the string for Swedish - Sweden
th_TH	String	Not Required	The value of the string for Thai - Thailand
tr_TR	String	Not Required	The value of the string for Turkish - Turkey
zh_CN	String	Not Required	The value of the string for Chinese, Simplified - China
sl_SI	String	Not Required	The value of the string for Slovenian - Slovenia
sr_RS	String	Not Required	The value of the string for Serbian - Serbia
xx_XA	String	Not Required	Reserved for future use
xx_XB	String	Not Required	Reserved for future use
xx_XC	String	Not Required	Reserved for future use
xx_XD	String	Not Required	Reserved for future use
xx_XE	String	Not Required	Reserved for future use
xx_XF	String	Not Required	Reserved for future use
xx_XG	String	Not Required	Reserved for future use
xx_XH	String	Not Required	Reserved for future use
xx_XI	String	Not Required	Reserved for future use
xx_XJ	String	Not Required	Reserved for future use

Period¶

month - The Month type
year - The Year type
psd - The Periodically on Statement Day type

PricePeriodType¶

billing period - The Billing Period type

month - The Month type

BillingModel¶

charge before billing period - The Charge Before Billing Period (BBP) billing model
charge after billing period - The Charge After Billing Period (ABP) billing model
charge before subscription period - The Charge Before Subscription Period (BSP) billing model
use external rating - The Use External Rating billing model

AutoRenewType¶

Disabled - The Disabled type
On Last Statement Day - The On Last Statement Day type
Before Expiration - The Before Expiration type

SubscriptionPeriod¶

Billing subscription period

NAME	TYPE	ATTRIBUTES	DEFAULT	DESCRIPTION
bssId	Integer	Not Required		BSS Subscription Period Id
active	Boolean	Not Required	true	Subscription active status
period	Integer	Not Required	1	Subscription Period Duration
periodType	Enum	Not Required	month	Subscription Period Type SubscriptionPeriodType
cancellationFeeType	Enum	Not Required	none	Subscription Cancellation Fee Type SubscriptionCancellationFeeType
cancellationFeeValue	Sting	Not Required		Cancellation Fee Formula
isAutoRenewPeriod	Boolean	Not Required	false
isTrial	Boolean	Not Required	false
afterRefundPeriod	Enum	Not Required	no_refund	After Refund Period SubscriptionAfterRefundPeriod
fullRefundPeriod	Integer	Not Required	0	Full Refund Period
cancelationPolicies	Array of PlanPeriodPolicy	Not Required		Cancellation policies list PlanPeriodPolicy
downsizePolicies	Array of PlanPeriodPolicy	Not Required		Downsize policies list PlanPeriodPolicy

SubscriptionPeriodType¶

Period:
month - Month
year - Year

SubscriptionCancellationFeeType¶

Subscription Cancellation Fee Type

none - none until_expiration - until expiration custom - custom

SubscriptionAfterRefundPeriod¶

SubscriptionAfterRefundPeriod
no_refund - no refund
refund_prorated_recurring_fee - refund prorated recurring fee

PlanPeriodPolicy¶

Plan Period Policy for cancellation and downsize policies

NAME	TYPE	ATTRIBUTES
policyType	Enum	Not Required
action	Enum	Not Required
actionPeriod	Integer	Not Required
actionPeriodTimezone	Enum	Not Required
applicableTo	Enum	Not Required

Action¶

Action Policy
full_refund - full refund
prorated_refund - prorated refund
no_refund - no refund
prohibited - prohibited
penalty - penalty
not_allowed_except_for_after_upsize - not allowed except for after upsize

ActionPeriodTimezone¶

Action Period Timezone
customer - customer
from_plan - from plan

ApplicableTo¶

Applicable To
first_subscription_period - first subscription period
next_subscription_periods - next subscription periods
all_subscription_periods - all subscription periods

SalesCategory¶

A structure of this kind represents a sales category.

NAME	TYPE	ATTRIBUTES	DEFAULT	DESCRIPTION
expand	Boolean	Not Required		Defines whether to expand the sales category in the marketplace and the customer control panel.
inCCP	Boolean	Not Required		Defines whether to show the sales category in the customer control panel.

ServiceTerms¶

A structure of this kind represents a Service Terms item.

NAME	TYPE	ATTRIBUTES	DEFAULT
bssId	Integer	Not Required
serviceTermsName	String	Not Required
destroyAfterHold	Boolean	Required	false
holdPeriodInDays	Integer	Required	0
gracePeriodInDays	Integer	Required	0
trialDestroyAfterHold	Boolean	Required	false
trialHoldPeriodInDays	Integer	Required	0
trialGracePeriodInDays	Integer	Required	0

TermsAndConditions¶

A structure of this kind represents a Terms and Conditions item.

NAME	TYPE	ATTRIBUTES	DEFAULT	DESCRIPTION
id	String	Required		The identifier of the item
bssId	Integer	Required		The CloudBlue Commerce identifier of the item
name	String	Not Required		The name of the item
value	String	Not Required		The value of the item
isDeleted	Boolean	Not Required	false	Defines whether the item is deleted.
type	Enum	Not Required		\| The type of the item: The supported values are: `plain_text` - The item contains the text of terms and conditions. `link` - The item contains a URL of terms and conditions.
ownerAccountId	Integer	Not Required		The CloudBlue Commerce identifier of the account that the item belongs to
acceptType	Enum	Not Required		\| The acceptance type of the item: The supported values are: `Always, on every purchase` - Always, on every purchase `On first purchase and after every T&C change` - On the first purchase and after every change of terms and conditions `Only on a first purchase` - Only on the first purchase `On every purchase and after every T&C change` - On every purchase and after every change of terms and conditions

NotificationTemplateMapping¶

A structure of this kind represents a mapping between a notification template and a notification type.

NAME	TYPE	ATTRIBUTES	DEFAULT	DESCRIPTION
templateType	Enum	Not Required		\| The notification type of the template The supported values are: `welcome_email` - The Welcome Email type `expiration_email` - The Expiration Email type
templateName	String	Not Required		The name of the template

TemplateType¶

welcome_email - The Welcome Email type

expiration_email - The Expiration Email type

ResellerGroup¶

A structure of this kind represents a group of resellers that is based on a reseller service template.

NAME	TYPE	ATTRIBUTES	DEFAULT	DESCRIPTION
id	Integer	Not Required		The CloudBlue Commerce identifier of the reseller service template that the reseller group is based on.
name	MLString	Not Required		The name of the reseller service template The type of this parameter is MLString.

RatingMode¶

Rating mode
Costs only - Costs only
Revenue only - Revenue only
Revenue and Costs - Revenue and Costs

BillingPeriodAlignment¶

CoTermingPossibilities¶

Examples ¶

In this section:

Obtaining Plans

Obtaining Plans ¶

To obtain a list of plans, make a request like this:

GET /aps/2/resources?implementing(http://com.odin.platform/inhouse-products/pdiPlan/1.0)

As a result, you will receive a response like this:

HTTP/1.1 200 OK

[
    {
        "name": {
            "de_DE": "Teamleader EU (Monatsplan)",
            "en_US": "Teamleader EU (Monthly Plan)",
            "es_ES": "Teamleader EU (Monthly Plan)",
            "fr_FR": "Teamleader EU (Monthly Plan)",
            "it_IT": "Teamleader EU (Monthly Plan)",
            "nl_NL": "Teamleader EU (Monthly Plan)",
            "pt_BR": "Teamleader EU (Monthly Plan)",
            "pt_PT": "Teamleader EU (Monthly Plan)",
            "tr_TR": "Teamleader EU (Monthly Plan)"
        },
        "isDefault": false,
        "ratingMode": "Revenue only",
        "description": {
            "de_DE": "Der monatliche Service bietet Unternehmen die meisten Vorteile, die lokale Bereitstellungen bieten.",
            "en_US": "The monthly service gives companies a majority of the same benefits that on-premises deployments provide.",
            "es_ES": "El servicio brinda a las empresas la mayoría de los mismos beneficios que brindan las implementaciones locales. Al integrarse con el servicio en la nube, las empresas pueden ampliar su participación en el mercado, automatizar y aumentar los ingresos recurrentes, aumentar la satisfacción del cliente y reducir los costos operativos al mismo tiempo.",
            "fr_FR": "Le service offre aux entreprises la majorité des mêmes avantages que les déploiements sur site. En s'intégrant au service cloud, les entreprises peuvent accroître leur part de marché, automatiser et augmenter les revenus récurrents, augmenter la satisfaction client et réduire les coûts d'exploitation en même temps.",
            "it_IT": "Il servizio offre alle aziende la maggior parte degli stessi vantaggi offerti dalle distribuzioni locali. Integrandosi con il servizio cloud, le aziende possono espandere la propria quota di mercato, automatizzare e aumentare i ricavi ricorrenti, aumentare la soddisfazione dei clienti e ridurre i costi operativi allo stesso tempo.",
            "nl_NL": "De service biedt bedrijven een meerderheid van dezelfde voordelen die on-premises implementaties bieden. Door te integreren met de cloudservice kunnen bedrijven hun marktaandeel vergroten, terugkerende inkomsten automatiseren en laten groeien, de klanttevredenheid verhogen en tegelijkertijd de operationele kosten verlagen.",
            "pt_BR": "O serviço oferece às empresas a maioria dos mesmos benefícios que as implantações locais fornecem. Ao integrar-se ao serviço de nuvem, as empresas podem expandir sua participação no mercado, automatizar e aumentar a receita recorrente, aumentar a satisfação do cliente e cortar custos operacionais ao mesmo tempo.",
            "pt_PT": "O serviço oferece às empresas a maioria dos mesmos benefícios que as implantações locais fornecem. Ao integrar-se ao serviço de nuvem, as empresas podem expandir sua participação no mercado, automatizar e aumentar a receita recorrente, aumentar a satisfação do cliente e cortar custos operacionais ao mesmo tempo.",
            "tr_TR": "Hizmet, şirket içi dağıtımların sağladığı faydaların çoğunu şirketlere verir. Bulut hizmetine entegre olarak, şirketler pazar paylarını artırabilir, yinelenen geliri otomatikleştirip büyütebilir, müşteri memnuniyetini artırabilir ve aynı zamanda operasyonel maliyetleri azaltabilir."
        },
        "isPublished": true,
        "billingModel": "charge before billing period",
        "planCategory": "Software & Licenses",
        "serviceTerms": {
            "bssId": 0,
            "holdPeriodInDays": 30,
            "serviceTermsName": "Default",
            "gracePeriodInDays": 10
        },
        "autoRenewType": "Before Expiration",
        "billingPeriod": 3,
        "pricePeriodType": "billing period",
        "salesCategories": [
            {
                "id": 7,
                "name": {
                    "de": "TeamleaderEU",
                    "en": "TeamleaderEU",
                    "es": "",
                    "fr": "",
                    "it": "",
                    "nl": "",
                    "pt": "",
                    "tr": ""
                },
                "inCCP": true,
                "expand": true,
                "parent": {
                    "id": 6,
                    "name": {
                        "de": "",
                        "en": "Security",
                        "es": "",
                        "fr": "",
                        "it": "",
                        "nl": "",
                        "pt": "",
                        "tr": ""
                    },
                    "inCCP": true,
                    "expand": true,
                    "description": {
                        "de": "",
                        "en": "Security",
                        "es": "",
                        "fr": "",
                        "it": "",
                        "nl": "",
                        "pt": "",
                        "tr": ""
                    }
                },
                "description": {
                    "de": "Der Service bietet Unternehmen die meisten Vorteile, die lokale Bereitstellungen bieten. Durch die Integration in den Cloud-Service können Unternehmen ihren Marktanteil ausbauen, wiederkehrende Umsätze automatisieren und steigern, die Kundenzufriedenheit steigern und gleichzeitig die Betriebskosten senken.",
                    "en": "The service gives companies a majority of the same benefits that on-premises deployments provide. By integrating with the cloud service, companies can expand their market share, automate and grow recurring revenue, increase customer satisfaction, and cut operational costs at the same time.",
                    "es": "El servicio brinda a las empresas la mayoría de los mismos beneficios que brindan las implementaciones locales. Al integrarse con el servicio en la nube, las empresas pueden ampliar su participación en el mercado, automatizar y aumentar los ingresos recurrentes, aumentar la satisfacción del cliente y reducir los costos operativos al mismo tiempo.",
                    "fr": "Le service offre aux entreprises la majorité des mêmes avantages que les déploiements sur site. En s'intégrant au service cloud, les entreprises peuvent accroître leur part de marché, automatiser et augmenter les revenus récurrents, augmenter la satisfaction client et réduire les coûts d'exploitation en même temps.",
                    "it": "Il servizio offre alle aziende la maggior parte degli stessi vantaggi offerti dalle distribuzioni locali. Integrandosi con il servizio cloud, le aziende possono espandere la propria quota di mercato, automatizzare e aumentare i ricavi ricorrenti, aumentare la soddisfazione dei clienti e ridurre i costi operativi allo stesso tempo.",
                    "nl": "De service biedt bedrijven een meerderheid van dezelfde voordelen die on-premises implementaties bieden. Door te integreren met de cloudservice kunnen bedrijven hun marktaandeel vergroten, terugkerende inkomsten automatiseren en laten groeien, de klanttevredenheid verhogen en tegelijkertijd de operationele kosten verlagen.",
                    "pt": "O serviço oferece às empresas a maioria dos mesmos benefícios que as implantações locais fornecem. Ao integrar-se ao serviço de nuvem, as empresas podem expandir sua participação no mercado, automatizar e aumentar a receita recorrente, aumentar a satisfação do cliente e cortar custos operacionais ao mesmo tempo.",
                    "tr": "Hizmet, şirket içi dağıtımların sağladığı faydaların çoğunu şirketlere verir. Bulut hizmetine entegre olarak, şirketler pazar paylarını artırabilir, yinelenen geliri otomatikleştirip büyütebilir, müşteri memnuniyetini artırabilir ve aynı zamanda operasyonel maliyetleri azaltabilir."
                }
            }
        ],
        "bssServicePlanId": 6,
        "isOneTimeFeePlan": false,
        "billingPeriodType": "psd",
        "serviceTemplateId": 5,
        "customStatementDay": 2,
        "renewOrderInterval": 1,
        "termsAndConditions": [
            {
                "name": "Teamleader EU Additional Terms",
                "type": "plain_text",
                "bssId": 3,
                "value": "Teamleader EU Additional Terms Content",
                "isDeleted": false,
                "acceptType": "On first purchase and after every T&C change",
                "ownerAccountId": 1
            },
            {
                "name": "Common",
                "type": "plain_text",
                "bssId": 2,
                "value": "Common",
                "isDeleted": false,
                "acceptType": "On first purchase and after every T&C change",
                "ownerAccountId": 1
            },
            {
                "name": "Provider pre-existing TC",
                "type": "plain_text",
                "bssId": 1,
                "value": "<body></body>",
                "isDeleted": false,
                "acceptType": "Always, on every purchase",
                "ownerAccountId": 1
            }
        ],
        "subscriptionPeriods": [
            {
                "bssId": 9,
                "period": 6,
                "isTrial": false,
                "periodType": "month",
                "fullRefundPeriod": 1,
                "afterRefundPeriod": "refund_prorated_recurring_fee",
                "isAutoRenewPeriod": true,
                "cancellationFeeType": "none",
                "cancellationFeeValue": "10"
            },
            {
                "bssId": 10,
                "period": 12,
                "isTrial": false,
                "periodType": "month",
                "fullRefundPeriod": 3,
                "afterRefundPeriod": "no_refund",
                "isAutoRenewPeriod": false,
                "cancellationFeeType": "none",
                "cancellationFeeValue": ""
            }
        ],
        "enabledNotifications": [
            {
                "templateName": "Welcome e-mail - Business Class Mail",
                "templateType": "welcome_email"
            },
            {
                "templateName": "Subscription has Expired - Wedge Networks",
                "templateType": "expiration_email"
            }
        ],
        "isFirstPeriodForFree": true,
        "isSalesOrderProrated": true,
        "alignWithStatementDay": true,
        "availableNotifications": [
            {
                "templateName": "Welcome e-mail - Business Class Mail",
                "templateType": "welcome_email"
            },
            {
                "templateName": "Subscription has Expired - Wedge Networks",
                "templateType": "expiration_email"
            }
        ],
        "notificationScheduleId": 12,
        "volumePricingRatingMode": true,
        "aps": {
            "modified": "2022-04-25T11:00:13Z",
            "id": "5849b34f-3943-4284-833c-0703053e4cf5",
            "type": "http://com.odin.platform/inhouse-products/pdiPlan/1.0",
            "status": "aps:ready",
            "revision": 2
        }
    }
]

← NotificationTemplate

PdiProduct →

CloudBlue Commerce API

Previous topic

Next topic

PdiPlan¶

Schema ¶

Properties ¶

Relationship ¶

Custom Operations ¶

delegate¶

updateSwitchPath¶

getPlanSwitchPaths¶

Structures ¶

MLString¶

Period¶

PricePeriodType¶

BillingModel¶

AutoRenewType¶

SubscriptionPeriod¶

SubscriptionPeriodType¶

SubscriptionCancellationFeeType¶

SubscriptionAfterRefundPeriod¶

PlanPeriodPolicy¶

Action¶

ActionPeriodTimezone¶

ApplicableTo¶

SalesCategory¶

ServiceTerms¶

TermsAndConditions¶

NotificationTemplateMapping¶

TemplateType¶

ResellerGroup¶

RatingMode¶

BillingPeriodAlignment¶

CoTermingPossibilities¶

Examples ¶

Obtaining Plans ¶

CloudBlue Commerce API

Previous topic

Next topic

PdiPlan¶

Schema¶

Properties¶

Relationship¶

Custom Operations¶

delegate¶

updateSwitchPath¶

getPlanSwitchPaths¶

Structures¶

MLString¶

Period¶

PricePeriodType¶

BillingModel¶

AutoRenewType¶

SubscriptionPeriod¶

SubscriptionPeriodType¶

SubscriptionCancellationFeeType¶

SubscriptionAfterRefundPeriod¶

PlanPeriodPolicy¶

Action¶

ActionPeriodTimezone¶

ApplicableTo¶

SalesCategory¶

ServiceTerms¶

TermsAndConditions¶

NotificationTemplateMapping¶

TemplateType¶

ResellerGroup¶

RatingMode¶

BillingPeriodAlignment¶

CoTermingPossibilities¶

Examples¶

Obtaining Plans¶

Schema ¶

Properties ¶

Relationship ¶

Custom Operations ¶

Structures ¶

Examples ¶

Obtaining Plans ¶