GET v1/PlanFamilies/{id}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

integer

Required

Body Parameters

None.

Response Information

Resource Description

Common.Dto.Get.PlanFamily
NameDescriptionTypeAdditional information
code

string

None.

name

string

None.

description

string

None.

earningOption

string

None.

nameOverrideOption

string

None.

descriptionOverrideOption

string

None.

referenceOption

string

None.

expiryOption

string

None.

customFieldsOption

string

None.

contractStartOption

string

None.

contractEndOption

string

None.

plans

Collection of Common.Dto.Get.PlanFamilyPlan

None.

planFamilyRelationship

Collection of Common.Dto.Get.PlanFamilyRelationship

None.

id

integer

None.

uri

string

None.

Response Formats

application/json, text/json

Sample:
{
  "code": "sample string 1",
  "name": "sample string 2",
  "description": "sample string 3",
  "earningOption": "sample string 4",
  "nameOverrideOption": "sample string 5",
  "descriptionOverrideOption": "sample string 6",
  "referenceOption": "sample string 7",
  "expiryOption": "sample string 8",
  "customFieldsOption": "sample string 9",
  "contractStartOption": "sample string 10",
  "contractEndOption": "sample string 11",
  "plans": [
    {
      "planId": 1,
      "planCode": "sample string 2",
      "planName": "sample string 3",
      "planFrequencies": [
        {
          "id": 1,
          "numberOfIntervals": 2,
          "interval": "sample string 3",
          "status": "sample string 4"
        },
        {
          "id": 1,
          "numberOfIntervals": 2,
          "interval": "sample string 3",
          "status": "sample string 4"
        }
      ],
      "id": 4,
      "uri": "sample string 5"
    },
    {
      "planId": 1,
      "planCode": "sample string 2",
      "planName": "sample string 3",
      "planFrequencies": [
        {
          "id": 1,
          "numberOfIntervals": 2,
          "interval": "sample string 3",
          "status": "sample string 4"
        },
        {
          "id": 1,
          "numberOfIntervals": 2,
          "interval": "sample string 3",
          "status": "sample string 4"
        }
      ],
      "id": 4,
      "uri": "sample string 5"
    }
  ],
  "planFamilyRelationship": [
    {
      "planFamilyId": 1,
      "relationshipMigrationType": "sample string 2",
      "sourceLabel": "sample string 3",
      "sourcePlanId": 4,
      "sourcePlanFrequencyId": 5,
      "sourcePlan": {
        "code": "sample string 1",
        "name": "sample string 2",
        "reference": "sample string 3",
        "description": "sample string 4",
        "longdescription": "sample string 5",
        "status": "sample string 6",
        "modificationTimestamp": "2025-05-21T09:34:34.0468258+00:00",
        "planFrequencies": [
          {
            "planRevisionId": 1,
            "numberOfIntervals": 2,
            "interval": "sample string 3",
            "numberOfSubscriptions": 4,
            "status": "sample string 5",
            "setupFees": [
              {
                "amount": 1.0,
                "conditionAmount": 1.0,
                "variableAmount": 1.0,
                "currency": "sample string 1",
                "conditionAmountDays": 1,
                "id": 2,
                "uri": "sample string 3"
              },
              {
                "amount": 1.0,
                "conditionAmount": 1.0,
                "variableAmount": 1.0,
                "currency": "sample string 1",
                "conditionAmountDays": 1,
                "id": 2,
                "uri": "sample string 3"
              }
            ],
            "charges": [
              {
                "amount": 1.0,
                "conditionAmount": 1.0,
                "variableAmount": 1.0,
                "currency": "sample string 1",
                "conditionAmountDays": 1,
                "id": 2,
                "uri": "sample string 3"
              },
              {
                "amount": 1.0,
                "conditionAmount": 1.0,
                "variableAmount": 1.0,
                "currency": "sample string 1",
                "conditionAmountDays": 1,
                "id": 2,
                "uri": "sample string 3"
              }
            ],
            "isProrated": true,
            "prorationGranularity": "sample string 7",
            "planFrequencyUniqueId": 8,
            "customFields": [
              {
                "key": "sample string 1",
                "friendlyName": "sample string 2",
                "dataType": "sample string 3",
                "defaultValue": {}
              },
              {
                "key": "sample string 1",
                "friendlyName": "sample string 2",
                "dataType": "sample string 3",
                "defaultValue": {}
              }
            ],
            "remainingInterval": 1,
            "remainingRefreshPriceInterval": 1,
            "invoiceInAdvance": 9,
            "salesforceId": "sample string 10",
            "hostedPageManagedOfferingPlanFrequency": {
              "displayName": "sample string 1",
              "visible": true,
              "isDefault": true,
              "planFrequencyKeyId": 4
            },
            "couponCodes": [
              "sample string 1",
              "sample string 2"
            ],
            "id": 11,
            "uri": "sample string 12"
          },
          {
            "planRevisionId": 1,
            "numberOfIntervals": 2,
            "interval": "sample string 3",
            "numberOfSubscriptions": 4,
            "status": "sample string 5",
            "setupFees": [
              {
                "amount": 1.0,
                "conditionAmount": 1.0,
                "variableAmount": 1.0,
                "currency": "sample string 1",
                "conditionAmountDays": 1,
                "id": 2,
                "uri": "sample string 3"
              },
              {
                "amount": 1.0,
                "conditionAmount": 1.0,
                "variableAmount": 1.0,
                "currency": "sample string 1",
                "conditionAmountDays": 1,
                "id": 2,
                "uri": "sample string 3"
              }
            ],
            "charges": [
              {
                "amount": 1.0,
                "conditionAmount": 1.0,
                "variableAmount": 1.0,
                "currency": "sample string 1",
                "conditionAmountDays": 1,
                "id": 2,
                "uri": "sample string 3"
              },
              {
                "amount": 1.0,
                "conditionAmount": 1.0,
                "variableAmount": 1.0,
                "currency": "sample string 1",
                "conditionAmountDays": 1,
                "id": 2,
                "uri": "sample string 3"
              }
            ],
            "isProrated": true,
            "prorationGranularity": "sample string 7",
            "planFrequencyUniqueId": 8,
            "customFields": [
              {
                "key": "sample string 1",
                "friendlyName": "sample string 2",
                "dataType": "sample string 3",
                "defaultValue": {}
              },
              {
                "key": "sample string 1",
                "friendlyName": "sample string 2",
                "dataType": "sample string 3",
                "defaultValue": {}
              }
            ],
            "remainingInterval": 1,
            "remainingRefreshPriceInterval": 1,
            "invoiceInAdvance": 9,
            "salesforceId": "sample string 10",
            "hostedPageManagedOfferingPlanFrequency": {
              "displayName": "sample string 1",
              "visible": true,
              "isDefault": true,
              "planFrequencyKeyId": 4
            },
            "couponCodes": [
              "sample string 1",
              "sample string 2"
            ],
            "id": 11,
            "uri": "sample string 12"
          }
        ],
        "autoApplyChanges": true,
        "salesforceCompatible": true,
        "id": 10,
        "uri": "sample string 11"
      },
      "sourcePlanFrequency": {
        "numberOfIntervals": 1,
        "interval": "sample string 2",
        "couponCodes": [
          "sample string 1",
          "sample string 2"
        ]
      },
      "destinationLabel": "sample string 6",
      "destinationPlanId": 7,
      "destinationPlanFrequencyId": 8,
      "destinationPlan": {
        "code": "sample string 1",
        "name": "sample string 2",
        "reference": "sample string 3",
        "description": "sample string 4",
        "longdescription": "sample string 5",
        "status": "sample string 6",
        "modificationTimestamp": "2025-05-21T09:34:34.0468258+00:00",
        "planFrequencies": [
          {
            "planRevisionId": 1,
            "numberOfIntervals": 2,
            "interval": "sample string 3",
            "numberOfSubscriptions": 4,
            "status": "sample string 5",
            "setupFees": [
              {
                "amount": 1.0,
                "conditionAmount": 1.0,
                "variableAmount": 1.0,
                "currency": "sample string 1",
                "conditionAmountDays": 1,
                "id": 2,
                "uri": "sample string 3"
              },
              {
                "amount": 1.0,
                "conditionAmount": 1.0,
                "variableAmount": 1.0,
                "currency": "sample string 1",
                "conditionAmountDays": 1,
                "id": 2,
                "uri": "sample string 3"
              }
            ],
            "charges": [
              {
                "amount": 1.0,
                "conditionAmount": 1.0,
                "variableAmount": 1.0,
                "currency": "sample string 1",
                "conditionAmountDays": 1,
                "id": 2,
                "uri": "sample string 3"
              },
              {
                "amount": 1.0,
                "conditionAmount": 1.0,
                "variableAmount": 1.0,
                "currency": "sample string 1",
                "conditionAmountDays": 1,
                "id": 2,
                "uri": "sample string 3"
              }
            ],
            "isProrated": true,
            "prorationGranularity": "sample string 7",
            "planFrequencyUniqueId": 8,
            "customFields": [
              {
                "key": "sample string 1",
                "friendlyName": "sample string 2",
                "dataType": "sample string 3",
                "defaultValue": {}
              },
              {
                "key": "sample string 1",
                "friendlyName": "sample string 2",
                "dataType": "sample string 3",
                "defaultValue": {}
              }
            ],
            "remainingInterval": 1,
            "remainingRefreshPriceInterval": 1,
            "invoiceInAdvance": 9,
            "salesforceId": "sample string 10",
            "hostedPageManagedOfferingPlanFrequency": {
              "displayName": "sample string 1",
              "visible": true,
              "isDefault": true,
              "planFrequencyKeyId": 4
            },
            "couponCodes": [
              "sample string 1",
              "sample string 2"
            ],
            "id": 11,
            "uri": "sample string 12"
          },
          {
            "planRevisionId": 1,
            "numberOfIntervals": 2,
            "interval": "sample string 3",
            "numberOfSubscriptions": 4,
            "status": "sample string 5",
            "setupFees": [
              {
                "amount": 1.0,
                "conditionAmount": 1.0,
                "variableAmount": 1.0,
                "currency": "sample string 1",
                "conditionAmountDays": 1,
                "id": 2,
                "uri": "sample string 3"
              },
              {
                "amount": 1.0,
                "conditionAmount": 1.0,
                "variableAmount": 1.0,
                "currency": "sample string 1",
                "conditionAmountDays": 1,
                "id": 2,
                "uri": "sample string 3"
              }
            ],
            "charges": [
              {
                "amount": 1.0,
                "conditionAmount": 1.0,
                "variableAmount": 1.0,
                "currency": "sample string 1",
                "conditionAmountDays": 1,
                "id": 2,
                "uri": "sample string 3"
              },
              {
                "amount": 1.0,
                "conditionAmount": 1.0,
                "variableAmount": 1.0,
                "currency": "sample string 1",
                "conditionAmountDays": 1,
                "id": 2,
                "uri": "sample string 3"
              }
            ],
            "isProrated": true,
            "prorationGranularity": "sample string 7",
            "planFrequencyUniqueId": 8,
            "customFields": [
              {
                "key": "sample string 1",
                "friendlyName": "sample string 2",
                "dataType": "sample string 3",
                "defaultValue": {}
              },
              {
                "key": "sample string 1",
                "friendlyName": "sample string 2",
                "dataType": "sample string 3",
                "defaultValue": {}
              }
            ],
            "remainingInterval": 1,
            "remainingRefreshPriceInterval": 1,
            "invoiceInAdvance": 9,
            "salesforceId": "sample string 10",
            "hostedPageManagedOfferingPlanFrequency": {
              "displayName": "sample string 1",
              "visible": true,
              "isDefault": true,
              "planFrequencyKeyId": 4
            },
            "couponCodes": [
              "sample string 1",
              "sample string 2"
            ],
            "id": 11,
            "uri": "sample string 12"
          }
        ],
        "autoApplyChanges": true,
        "salesforceCompatible": true,
        "id": 10,
        "uri": "sample string 11"
      },
      "destinationPlanFrequency": {
        "numberOfIntervals": 1,
        "interval": "sample string 2",
        "couponCodes": [
          "sample string 1",
          "sample string 2"
        ]
      },
      "earningOption": "sample string 9",
      "nameOverrideOption": "sample string 10",
      "descriptionOverrideOption": "sample string 11",
      "referenceOption": "sample string 12",
      "customFieldsOption": "sample string 13",
      "expiryOption": "sample string 14",
      "contractStartOption": "sample string 15",
      "contractEndOption": "sample string 16",
      "availableOnSsp": true,
      "sspConfiguration": {
        "planFamilyRelationshipId": 1,
        "migrationTiming": "sample string 2",
        "requirePaymentMethod": true,
        "titleHeight": 4,
        "titleText": "sample string 5",
        "descriptionHeight": 6,
        "descriptionText": "sample string 7",
        "buttonText": "sample string 8",
        "availableOnSSP": true,
        "isActive": true,
        "sortOrder": 1
      },
      "managedRelationship": {
        "planFamilyRelationshipId": 1,
        "migrationTiming": "sample string 2",
        "requirePaymentMethod": true,
        "titleHeight": 4,
        "titleText": "sample string 5",
        "descriptionHeight": 6,
        "descriptionText": "sample string 7",
        "buttonText": "sample string 8",
        "availableOnSSP": true,
        "isActive": true,
        "sortOrder": 1
      },
      "planFamilyRelationshipMapping": [
        {
          "sourcePlanProduct": {
            "status": "sample string 1",
            "productId": 2,
            "productCode": "sample string 3",
            "productName": "sample string 4",
            "productDescription": "sample string 5",
            "planProductUniqueId": 6,
            "id": 7,
            "uri": "sample string 8"
          },
          "destinationPlanProduct": {
            "status": "sample string 1",
            "productId": 2,
            "productCode": "sample string 3",
            "productName": "sample string 4",
            "productDescription": "sample string 5",
            "planProductUniqueId": 6,
            "id": 7,
            "uri": "sample string 8"
          },
          "priceOverrideDiscountRemainingUsagesUntilStart": 1,
          "priceOverrideDiscountRemainingUsage": 1,
          "sourcePlanProductId": 1,
          "destinationPlanProductId": 1,
          "nameOverrideOption": "sample string 2",
          "descriptionOverrideOption": "sample string 3",
          "quantityOption": "sample string 4",
          "inclusionOption": "sample string 5",
          "upliftOption": "sample string 6",
          "priceOverrideOption": "sample string 7",
          "discountOption": "sample string 8",
          "expiryOption": "sample string 9",
          "scheduledDateOption": "sample string 10",
          "customFieldsOption": "sample string 11",
          "id": 12,
          "uri": "sample string 13"
        },
        {
          "sourcePlanProduct": {
            "status": "sample string 1",
            "productId": 2,
            "productCode": "sample string 3",
            "productName": "sample string 4",
            "productDescription": "sample string 5",
            "planProductUniqueId": 6,
            "id": 7,
            "uri": "sample string 8"
          },
          "destinationPlanProduct": {
            "status": "sample string 1",
            "productId": 2,
            "productCode": "sample string 3",
            "productName": "sample string 4",
            "productDescription": "sample string 5",
            "planProductUniqueId": 6,
            "id": 7,
            "uri": "sample string 8"
          },
          "priceOverrideDiscountRemainingUsagesUntilStart": 1,
          "priceOverrideDiscountRemainingUsage": 1,
          "sourcePlanProductId": 1,
          "destinationPlanProductId": 1,
          "nameOverrideOption": "sample string 2",
          "descriptionOverrideOption": "sample string 3",
          "quantityOption": "sample string 4",
          "inclusionOption": "sample string 5",
          "upliftOption": "sample string 6",
          "priceOverrideOption": "sample string 7",
          "discountOption": "sample string 8",
          "expiryOption": "sample string 9",
          "scheduledDateOption": "sample string 10",
          "customFieldsOption": "sample string 11",
          "id": 12,
          "uri": "sample string 13"
        }
      ],
      "planStatus": "sample string 18",
      "couponCode": "sample string 19",
      "name": "sample string 20",
      "description": "sample string 21",
      "id": 22,
      "uri": "sample string 23"
    },
    {
      "planFamilyId": 1,
      "relationshipMigrationType": "sample string 2",
      "sourceLabel": "sample string 3",
      "sourcePlanId": 4,
      "sourcePlanFrequencyId": 5,
      "sourcePlan": {
        "code": "sample string 1",
        "name": "sample string 2",
        "reference": "sample string 3",
        "description": "sample string 4",
        "longdescription": "sample string 5",
        "status": "sample string 6",
        "modificationTimestamp": "2025-05-21T09:34:34.0468258+00:00",
        "planFrequencies": [
          {
            "planRevisionId": 1,
            "numberOfIntervals": 2,
            "interval": "sample string 3",
            "numberOfSubscriptions": 4,
            "status": "sample string 5",
            "setupFees": [
              {
                "amount": 1.0,
                "conditionAmount": 1.0,
                "variableAmount": 1.0,
                "currency": "sample string 1",
                "conditionAmountDays": 1,
                "id": 2,
                "uri": "sample string 3"
              },
              {
                "amount": 1.0,
                "conditionAmount": 1.0,
                "variableAmount": 1.0,
                "currency": "sample string 1",
                "conditionAmountDays": 1,
                "id": 2,
                "uri": "sample string 3"
              }
            ],
            "charges": [
              {
                "amount": 1.0,
                "conditionAmount": 1.0,
                "variableAmount": 1.0,
                "currency": "sample string 1",
                "conditionAmountDays": 1,
                "id": 2,
                "uri": "sample string 3"
              },
              {
                "amount": 1.0,
                "conditionAmount": 1.0,
                "variableAmount": 1.0,
                "currency": "sample string 1",
                "conditionAmountDays": 1,
                "id": 2,
                "uri": "sample string 3"
              }
            ],
            "isProrated": true,
            "prorationGranularity": "sample string 7",
            "planFrequencyUniqueId": 8,
            "customFields": [
              {
                "key": "sample string 1",
                "friendlyName": "sample string 2",
                "dataType": "sample string 3",
                "defaultValue": {}
              },
              {
                "key": "sample string 1",
                "friendlyName": "sample string 2",
                "dataType": "sample string 3",
                "defaultValue": {}
              }
            ],
            "remainingInterval": 1,
            "remainingRefreshPriceInterval": 1,
            "invoiceInAdvance": 9,
            "salesforceId": "sample string 10",
            "hostedPageManagedOfferingPlanFrequency": {
              "displayName": "sample string 1",
              "visible": true,
              "isDefault": true,
              "planFrequencyKeyId": 4
            },
            "couponCodes": [
              "sample string 1",
              "sample string 2"
            ],
            "id": 11,
            "uri": "sample string 12"
          },
          {
            "planRevisionId": 1,
            "numberOfIntervals": 2,
            "interval": "sample string 3",
            "numberOfSubscriptions": 4,
            "status": "sample string 5",
            "setupFees": [
              {
                "amount": 1.0,
                "conditionAmount": 1.0,
                "variableAmount": 1.0,
                "currency": "sample string 1",
                "conditionAmountDays": 1,
                "id": 2,
                "uri": "sample string 3"
              },
              {
                "amount": 1.0,
                "conditionAmount": 1.0,
                "variableAmount": 1.0,
                "currency": "sample string 1",
                "conditionAmountDays": 1,
                "id": 2,
                "uri": "sample string 3"
              }
            ],
            "charges": [
              {
                "amount": 1.0,
                "conditionAmount": 1.0,
                "variableAmount": 1.0,
                "currency": "sample string 1",
                "conditionAmountDays": 1,
                "id": 2,
                "uri": "sample string 3"
              },
              {
                "amount": 1.0,
                "conditionAmount": 1.0,
                "variableAmount": 1.0,
                "currency": "sample string 1",
                "conditionAmountDays": 1,
                "id": 2,
                "uri": "sample string 3"
              }
            ],
            "isProrated": true,
            "prorationGranularity": "sample string 7",
            "planFrequencyUniqueId": 8,
            "customFields": [
              {
                "key": "sample string 1",
                "friendlyName": "sample string 2",
                "dataType": "sample string 3",
                "defaultValue": {}
              },
              {
                "key": "sample string 1",
                "friendlyName": "sample string 2",
                "dataType": "sample string 3",
                "defaultValue": {}
              }
            ],
            "remainingInterval": 1,
            "remainingRefreshPriceInterval": 1,
            "invoiceInAdvance": 9,
            "salesforceId": "sample string 10",
            "hostedPageManagedOfferingPlanFrequency": {
              "displayName": "sample string 1",
              "visible": true,
              "isDefault": true,
              "planFrequencyKeyId": 4
            },
            "couponCodes": [
              "sample string 1",
              "sample string 2"
            ],
            "id": 11,
            "uri": "sample string 12"
          }
        ],
        "autoApplyChanges": true,
        "salesforceCompatible": true,
        "id": 10,
        "uri": "sample string 11"
      },
      "sourcePlanFrequency": {
        "numberOfIntervals": 1,
        "interval": "sample string 2",
        "couponCodes": [
          "sample string 1",
          "sample string 2"
        ]
      },
      "destinationLabel": "sample string 6",
      "destinationPlanId": 7,
      "destinationPlanFrequencyId": 8,
      "destinationPlan": {
        "code": "sample string 1",
        "name": "sample string 2",
        "reference": "sample string 3",
        "description": "sample string 4",
        "longdescription": "sample string 5",
        "status": "sample string 6",
        "modificationTimestamp": "2025-05-21T09:34:34.0468258+00:00",
        "planFrequencies": [
          {
            "planRevisionId": 1,
            "numberOfIntervals": 2,
            "interval": "sample string 3",
            "numberOfSubscriptions": 4,
            "status": "sample string 5",
            "setupFees": [
              {
                "amount": 1.0,
                "conditionAmount": 1.0,
                "variableAmount": 1.0,
                "currency": "sample string 1",
                "conditionAmountDays": 1,
                "id": 2,
                "uri": "sample string 3"
              },
              {
                "amount": 1.0,
                "conditionAmount": 1.0,
                "variableAmount": 1.0,
                "currency": "sample string 1",
                "conditionAmountDays": 1,
                "id": 2,
                "uri": "sample string 3"
              }
            ],
            "charges": [
              {
                "amount": 1.0,
                "conditionAmount": 1.0,
                "variableAmount": 1.0,
                "currency": "sample string 1",
                "conditionAmountDays": 1,
                "id": 2,
                "uri": "sample string 3"
              },
              {
                "amount": 1.0,
                "conditionAmount": 1.0,
                "variableAmount": 1.0,
                "currency": "sample string 1",
                "conditionAmountDays": 1,
                "id": 2,
                "uri": "sample string 3"
              }
            ],
            "isProrated": true,
            "prorationGranularity": "sample string 7",
            "planFrequencyUniqueId": 8,
            "customFields": [
              {
                "key": "sample string 1",
                "friendlyName": "sample string 2",
                "dataType": "sample string 3",
                "defaultValue": {}
              },
              {
                "key": "sample string 1",
                "friendlyName": "sample string 2",
                "dataType": "sample string 3",
                "defaultValue": {}
              }
            ],
            "remainingInterval": 1,
            "remainingRefreshPriceInterval": 1,
            "invoiceInAdvance": 9,
            "salesforceId": "sample string 10",
            "hostedPageManagedOfferingPlanFrequency": {
              "displayName": "sample string 1",
              "visible": true,
              "isDefault": true,
              "planFrequencyKeyId": 4
            },
            "couponCodes": [
              "sample string 1",
              "sample string 2"
            ],
            "id": 11,
            "uri": "sample string 12"
          },
          {
            "planRevisionId": 1,
            "numberOfIntervals": 2,
            "interval": "sample string 3",
            "numberOfSubscriptions": 4,
            "status": "sample string 5",
            "setupFees": [
              {
                "amount": 1.0,
                "conditionAmount": 1.0,
                "variableAmount": 1.0,
                "currency": "sample string 1",
                "conditionAmountDays": 1,
                "id": 2,
                "uri": "sample string 3"
              },
              {
                "amount": 1.0,
                "conditionAmount": 1.0,
                "variableAmount": 1.0,
                "currency": "sample string 1",
                "conditionAmountDays": 1,
                "id": 2,
                "uri": "sample string 3"
              }
            ],
            "charges": [
              {
                "amount": 1.0,
                "conditionAmount": 1.0,
                "variableAmount": 1.0,
                "currency": "sample string 1",
                "conditionAmountDays": 1,
                "id": 2,
                "uri": "sample string 3"
              },
              {
                "amount": 1.0,
                "conditionAmount": 1.0,
                "variableAmount": 1.0,
                "currency": "sample string 1",
                "conditionAmountDays": 1,
                "id": 2,
                "uri": "sample string 3"
              }
            ],
            "isProrated": true,
            "prorationGranularity": "sample string 7",
            "planFrequencyUniqueId": 8,
            "customFields": [
              {
                "key": "sample string 1",
                "friendlyName": "sample string 2",
                "dataType": "sample string 3",
                "defaultValue": {}
              },
              {
                "key": "sample string 1",
                "friendlyName": "sample string 2",
                "dataType": "sample string 3",
                "defaultValue": {}
              }
            ],
            "remainingInterval": 1,
            "remainingRefreshPriceInterval": 1,
            "invoiceInAdvance": 9,
            "salesforceId": "sample string 10",
            "hostedPageManagedOfferingPlanFrequency": {
              "displayName": "sample string 1",
              "visible": true,
              "isDefault": true,
              "planFrequencyKeyId": 4
            },
            "couponCodes": [
              "sample string 1",
              "sample string 2"
            ],
            "id": 11,
            "uri": "sample string 12"
          }
        ],
        "autoApplyChanges": true,
        "salesforceCompatible": true,
        "id": 10,
        "uri": "sample string 11"
      },
      "destinationPlanFrequency": {
        "numberOfIntervals": 1,
        "interval": "sample string 2",
        "couponCodes": [
          "sample string 1",
          "sample string 2"
        ]
      },
      "earningOption": "sample string 9",
      "nameOverrideOption": "sample string 10",
      "descriptionOverrideOption": "sample string 11",
      "referenceOption": "sample string 12",
      "customFieldsOption": "sample string 13",
      "expiryOption": "sample string 14",
      "contractStartOption": "sample string 15",
      "contractEndOption": "sample string 16",
      "availableOnSsp": true,
      "sspConfiguration": {
        "planFamilyRelationshipId": 1,
        "migrationTiming": "sample string 2",
        "requirePaymentMethod": true,
        "titleHeight": 4,
        "titleText": "sample string 5",
        "descriptionHeight": 6,
        "descriptionText": "sample string 7",
        "buttonText": "sample string 8",
        "availableOnSSP": true,
        "isActive": true,
        "sortOrder": 1
      },
      "managedRelationship": {
        "planFamilyRelationshipId": 1,
        "migrationTiming": "sample string 2",
        "requirePaymentMethod": true,
        "titleHeight": 4,
        "titleText": "sample string 5",
        "descriptionHeight": 6,
        "descriptionText": "sample string 7",
        "buttonText": "sample string 8",
        "availableOnSSP": true,
        "isActive": true,
        "sortOrder": 1
      },
      "planFamilyRelationshipMapping": [
        {
          "sourcePlanProduct": {
            "status": "sample string 1",
            "productId": 2,
            "productCode": "sample string 3",
            "productName": "sample string 4",
            "productDescription": "sample string 5",
            "planProductUniqueId": 6,
            "id": 7,
            "uri": "sample string 8"
          },
          "destinationPlanProduct": {
            "status": "sample string 1",
            "productId": 2,
            "productCode": "sample string 3",
            "productName": "sample string 4",
            "productDescription": "sample string 5",
            "planProductUniqueId": 6,
            "id": 7,
            "uri": "sample string 8"
          },
          "priceOverrideDiscountRemainingUsagesUntilStart": 1,
          "priceOverrideDiscountRemainingUsage": 1,
          "sourcePlanProductId": 1,
          "destinationPlanProductId": 1,
          "nameOverrideOption": "sample string 2",
          "descriptionOverrideOption": "sample string 3",
          "quantityOption": "sample string 4",
          "inclusionOption": "sample string 5",
          "upliftOption": "sample string 6",
          "priceOverrideOption": "sample string 7",
          "discountOption": "sample string 8",
          "expiryOption": "sample string 9",
          "scheduledDateOption": "sample string 10",
          "customFieldsOption": "sample string 11",
          "id": 12,
          "uri": "sample string 13"
        },
        {
          "sourcePlanProduct": {
            "status": "sample string 1",
            "productId": 2,
            "productCode": "sample string 3",
            "productName": "sample string 4",
            "productDescription": "sample string 5",
            "planProductUniqueId": 6,
            "id": 7,
            "uri": "sample string 8"
          },
          "destinationPlanProduct": {
            "status": "sample string 1",
            "productId": 2,
            "productCode": "sample string 3",
            "productName": "sample string 4",
            "productDescription": "sample string 5",
            "planProductUniqueId": 6,
            "id": 7,
            "uri": "sample string 8"
          },
          "priceOverrideDiscountRemainingUsagesUntilStart": 1,
          "priceOverrideDiscountRemainingUsage": 1,
          "sourcePlanProductId": 1,
          "destinationPlanProductId": 1,
          "nameOverrideOption": "sample string 2",
          "descriptionOverrideOption": "sample string 3",
          "quantityOption": "sample string 4",
          "inclusionOption": "sample string 5",
          "upliftOption": "sample string 6",
          "priceOverrideOption": "sample string 7",
          "discountOption": "sample string 8",
          "expiryOption": "sample string 9",
          "scheduledDateOption": "sample string 10",
          "customFieldsOption": "sample string 11",
          "id": 12,
          "uri": "sample string 13"
        }
      ],
      "planStatus": "sample string 18",
      "couponCode": "sample string 19",
      "name": "sample string 20",
      "description": "sample string 21",
      "id": 22,
      "uri": "sample string 23"
    }
  ],
  "id": 12,
  "uri": "sample string 13"
}