Table Of Contents

Previous topic

ServicePlanCategory

Next topic

TaxCategory

Application Packaging Standard

Last updated 18-Mar-2019

ServiceTerms

The service terms is a set of parameters that defines how a subscription services processing is managed.

Schema

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

{
  "name": "ServiceTerms",
  "id": "http://www.odin.com/billing/ServiceTerms/1.0",
  "apsVersion": "2.0",
  "implements": [
    "http://aps-standard.org/types/core/resource/1.0"
  ],
  "relations": {
    "vendor": {
      "type": "http://parallels.com/aps/types/pa/account",
      "required": true
    }
  },
  "properties": {
    "name": {
      "type": "string",
      "required": true
    },
    "subGracePeriod": {
      "type": "integer"
    },
    "subHoldPeriod": {
      "type": "integer"
    },
    "destroyAfterHold": {
      "type": "boolean"
    },
    "trialSubGracePeriod": {
      "type": "integer"
    },
    "trialSubHoldPeriod": {
      "type": "integer"
    },
    "trialDestroyAfterHold": {
      "type": "boolean"
    }
  }
}

Properties

NAME TYPE ATTRIBUTES DEFAULT DESCRIPTION
destroyAfterHold Boolean Not Required   Destroy Service after Hold Period
name String Required   Service term’s name
subGracePeriod Integer Not Required   Subscription grace period in days
subHoldPeriod Integer Not Required   Subscription hold period in days
trialDestroyAfterHold Boolean Not Required   Destroy trial service after hold period
trialSubGracePeriod Integer Not Required   Trial subscription grace period in days
trialSubHoldPeriod Integer Not Required   Trial subscription hold period in days

Relationship

NAME TYPE REQUIRED DESCRIPTION
vendor PAAccount Yes Vendor - owner of this service Terms

Examples

Please find general description of create-read-update-delete (CRUD) operations with resources, properties, and structures respectively at: