PlanAttributes

Attributes of the PlanAttributes type

Attributes for creating and updating a plan

{
  "productId": "456123",
  "name": "",
  "code": "",
  "position": 123,
  "addon": true,
  "selfServiceBuy": true,
  "selfServiceCancel": true,
  "selfServiceRenew": true,
  "description": "",
  "internalNotes": "",
  "availableFrom": "2022-06-01",
  "availableTo": "2022-06-01",
  "isVisible": true,
  "featureIds": [
    "456123"
  ],
  "pricingDescription": "",
  "pricingStyle": "PlanPricingStyles",
  "contactUsLabel": "",
  "contactUsUrl": ""
}
Name
Type
Description

productId

ID

name

String

code

String

position

Int

The plan's position wihtin the product

addon

Boolean

selfServiceBuy

Boolean

Allows customers to buy this plan via the portal

selfServiceCancel

Boolean

Allows customers to cancel this plan via the portal

selfServiceRenew

Boolean

Allows customers to renew this plan via the portal

description

String

internalNotes

String

availableFrom

ISO8601Date

availableTo

ISO8601Date

isVisible

Boolean

featureIds

List (ID)

pricingDescription

String

pricingStyle

contactUsLabel

String

Label for the contact us button

contactUsUrl

String

URL for the contact us button

Last updated

Was this helpful?