Jump to

• Request
• Response

Update a formula plan

patch

/crmRestApi/resources/11.13.18.05/subscriptionFormulaPlans/{FormulaPlanPuid}

Request

Path Parameters

• FormulaPlanPuid(required): string
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Header Parameters

• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• formulaPlanCharges: array Formula Charges
  Title: Formula Charges

  The Formula Plan Charge resource lets you view, create, update and delete formula plan charges. Formula plan charges are collections of business entities that store reusable formulas used to derive calculation values.
• formulaRates: array Formula Rate Variables
  Title: Formula Rate Variables

  The formula rates resources lets you view, create, delete, and update formula rates. Formula rates are collections of business entities that store reusable formulas used to derive calculation values.
• formulaSteps: array Formula Steps
  Title: Formula Steps

  A formula step represents a unit of logic within a formula plan that defines how a value is calculated or derived during pricing.
• PriceListId: integer (int64)
  The unique identifier of the price list used for the formula plan.
• PriceListItemId: integer (int64)
  The unique identifier of the price list item associated with the rate plan.
• RatePlanId: integer (int64)
  The unique identifier of the rate plan associated with the formula plan.
• Status: string
  Maximum Length: 30

  The status of the formula plan.
• VersionNumber: integer (int64)
  The version number of the formula plan.

{
    "type":"object",
    "properties":{
        "PriceListId":{
            "type":"integer",
            "description":"The unique identifier of the price list used for the formula plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PriceListItemId":{
            "type":"integer",
            "description":"The unique identifier of the price list item associated with the rate plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "RatePlanId":{
            "type":"integer",
            "description":"The unique identifier of the rate plan associated with the formula plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "Status":{
            "maxLength":30,
            "type":"string",
            "description":"The status of the formula plan.",
            "nullable":false
        },
        "VersionNumber":{
            "type":"integer",
            "description":"The version number of the formula plan.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "formulaPlanCharges":{
            "title":"Formula Charges",
            "type":"array",
            "description":"The Formula Plan Charge resource lets you view, create, update and delete formula plan charges. Formula plan charges are collections of business entities that store reusable formulas used to derive calculation values.",
            "items":{
                "$ref":"#/components/schemas/subscriptionFormulaPlans-formulaPlanCharges-item-patch-request"
            }
        },
        "formulaRates":{
            "title":"Formula Rate Variables",
            "type":"array",
            "description":"The formula rates resources lets you view, create, delete, and update formula rates. Formula rates are collections of business entities that store reusable formulas used to derive calculation values.",
            "items":{
                "$ref":"#/components/schemas/subscriptionFormulaPlans-formulaRates-item-patch-request"
            }
        },
        "formulaSteps":{
            "title":"Formula Steps",
            "type":"array",
            "description":"A formula step represents a unit of logic within a formula plan that defines how a value is calculated or derived during pricing.",
            "items":{
                "$ref":"#/components/schemas/subscriptionFormulaPlans-formulaSteps-item-patch-request"
            }
        }
    }
}

Nested Schema : Formula Charges

Type: array

Title: Formula Charges

The Formula Plan Charge resource lets you view, create, update and delete formula plan charges. Formula plan charges are collections of business entities that store reusable formulas used to derive calculation values.

Show Source

• Array of: object subscriptionFormulaPlans-formulaPlanCharges-item-patch-request

{
    "title":"Formula Charges",
    "type":"array",
    "description":"The Formula Plan Charge resource lets you view, create, update and delete formula plan charges. Formula plan charges are collections of business entities that store reusable formulas used to derive calculation values.",
    "items":{
        "$ref":"#/components/schemas/subscriptionFormulaPlans-formulaPlanCharges-item-patch-request"
    }
}

Nested Schema : Formula Rate Variables

Type: array

Title: Formula Rate Variables

The formula rates resources lets you view, create, delete, and update formula rates. Formula rates are collections of business entities that store reusable formulas used to derive calculation values.

Show Source

• Array of: object schema

{
    "title":"Formula Rate Variables",
    "type":"array",
    "description":"The formula rates resources lets you view, create, delete, and update formula rates. Formula rates are collections of business entities that store reusable formulas used to derive calculation values.",
    "items":{
        "$ref":"#/components/schemas/subscriptionFormulaPlans-formulaRates-item-patch-request"
    }
}

Nested Schema : Formula Steps

Type: array

Title: Formula Steps

A formula step represents a unit of logic within a formula plan that defines how a value is calculated or derived during pricing.

Show Source

• Array of: object subscriptionFormulaPlans-formulaSteps-item-patch-request

{
    "title":"Formula Steps",
    "type":"array",
    "description":"A formula step represents a unit of logic within a formula plan that defines how a value is calculated or derived during pricing.",
    "items":{
        "$ref":"#/components/schemas/subscriptionFormulaPlans-formulaSteps-item-patch-request"
    }
}

Nested Schema : subscriptionFormulaPlans-formulaPlanCharges-item-patch-request

Type: object

Show Source

• ChargeDefinitionCode: string
  Maximum Length: 30

  The unique charge definition code for the adjustment.
• ChargeDefinitionId: integer (int64)
  The unique identifier of the charge definition for the adjustment.
• FormulaChargeType: string
  Maximum Length: 30

  The formula charge type used such as Billable, Revenue, or Prepared Variable.
• FormulaPlanId: integer (int64)
  The unique identifier of the formula plan of associated with this charge.

{
    "type":"object",
    "properties":{
        "ChargeDefinitionCode":{
            "maxLength":30,
            "type":"string",
            "description":"The unique charge definition code for the adjustment.",
            "nullable":true
        },
        "ChargeDefinitionId":{
            "type":"integer",
            "description":"The unique identifier of the charge definition for the adjustment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "FormulaChargeType":{
            "maxLength":30,
            "type":"string",
            "description":"The formula charge type used such as Billable, Revenue, or Prepared Variable.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "FormulaPlanId":{
            "type":"integer",
            "description":"The unique identifier of the formula plan of associated with this charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• CalculationMethodCode: string
  Title: Rate Type

  Maximum Length: 15

  The calculation method used for the formula negotiated value, such as VALUE, MATRIX, or TIER.
• ChargeDefinitionCode: string
  Maximum Length: 30

  The charge definition code for the adjustment.
• ChargeDefinitionId: integer (int64)
  The unique identifier of the charge definition for the adjustment.
• CPITierAdjustmentFlag: boolean
  Maximum Length: 1

  Indicates whether CPI is applied to the tier.
• CPIValueAdjustmentFlag: boolean
  Maximum Length: 1

  Indicates whether CPI is applied to the value.
• DynamicMatrixClassId: integer (int64)
  The unique identifier of the dynamic matrix class. Populated only when the calculation method is MATRIX.
• DynamicMatrixId: integer (int64)
  The unique identifier of the dynamic matrix. Populated only when the calculation method is MATRIX.
• FormulaPlanId: integer (int64)
  The unique identifier of the formula plan associated with the pricing.
• formulaRateTiers: array Tier Headers VO
  Title: Tier Headers VO

  Formula rate tiers are collections of business entities. They store reusable formulas used to derive calculation values.
• RateCode: string
  Title: Variable

  Maximum Length: 200

  The negotiated rate code that identifies the charge component used for formula-based pricing.
• RateCodeName: string
  Maximum Length: 200

  The name of the negotiated rate code used for formula-based pricing.
• RateDescription: string
  Title: Description

  Maximum Length: 4000

  The description of the negotiated rate code used in formula-based pricing.
• TieredPricingHeaderId: integer (int64)
  The unique identifier of the tiered pricing header.
• Value: number
  Title: Base Value

  The value used for the formula negotiated value. Populated only when the calculation method is VALUE.
• ValueType: string
  Maximum Length: 15

  The type of value, such as percentage or amount, based on the calculation method.

{
    "type":"object",
    "properties":{
        "CPITierAdjustmentFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether CPI is applied to the tier.",
            "nullable":true
        },
        "CPIValueAdjustmentFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether CPI is applied to the value.",
            "nullable":true
        },
        "CalculationMethodCode":{
            "title":"Rate Type",
            "maxLength":15,
            "type":"string",
            "description":"The calculation method used for the formula negotiated value, such as VALUE, MATRIX, or TIER.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ChargeDefinitionCode":{
            "maxLength":30,
            "type":"string",
            "description":"The charge definition code for the adjustment.",
            "nullable":true
        },
        "ChargeDefinitionId":{
            "type":"integer",
            "description":"The unique identifier of the charge definition for the adjustment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "DynamicMatrixClassId":{
            "type":"integer",
            "description":"The unique identifier of the dynamic matrix class. Populated only when the calculation method is MATRIX.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "DynamicMatrixId":{
            "type":"integer",
            "description":"The unique identifier of the dynamic matrix. Populated only when the calculation method is MATRIX.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "FormulaPlanId":{
            "type":"integer",
            "description":"The unique identifier of the formula plan associated with the pricing.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "RateCode":{
            "title":"Variable",
            "maxLength":200,
            "type":"string",
            "description":"The negotiated rate code that identifies the charge component used for formula-based pricing.",
            "nullable":true
        },
        "RateCodeName":{
            "maxLength":200,
            "type":"string",
            "description":"The name of the negotiated rate code used for formula-based pricing.",
            "nullable":true
        },
        "RateDescription":{
            "title":"Description",
            "maxLength":4000,
            "type":"string",
            "description":"The description of the negotiated rate code used in formula-based pricing.",
            "nullable":true
        },
        "TieredPricingHeaderId":{
            "type":"integer",
            "description":"The unique identifier of the tiered pricing header.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "Value":{
            "title":"Base Value",
            "type":"number",
            "description":"The value used for the formula negotiated value. Populated only when the calculation method is VALUE.",
            "nullable":true
        },
        "ValueType":{
            "maxLength":15,
            "type":"string",
            "description":"The type of value, such as percentage or amount, based on the calculation method.",
            "nullable":true
        },
        "formulaRateTiers":{
            "title":"Tier Headers VO",
            "type":"array",
            "description":"Formula rate tiers are collections of business entities. They store reusable formulas used to derive calculation values.",
            "items":{
                "$ref":"#/components/schemas/subscriptionFormulaPlans-formulaRates-formulaRateTiers-item-patch-request"
            }
        }
    }
}

Nested Schema : Tier Headers VO

Type: array

Title: Tier Headers VO

Formula rate tiers are collections of business entities. They store reusable formulas used to derive calculation values.

Show Source

• Array of: object subscriptionFormulaPlans-formulaRates-formulaRateTiers-item-patch-request

{
    "title":"Tier Headers VO",
    "type":"array",
    "description":"Formula rate tiers are collections of business entities. They store reusable formulas used to derive calculation values.",
    "items":{
        "$ref":"#/components/schemas/subscriptionFormulaPlans-formulaRates-formulaRateTiers-item-patch-request"
    }
}

Nested Schema : subscriptionFormulaPlans-formulaRates-formulaRateTiers-item-patch-request

Type: object

Show Source

• ChargeDefinitionCode: string
  Maximum Length: 120

  The code of the charge definition, if involved in negotiation.
• ChargeId: integer (int64)
  Identifier of the charge, if involved in negotiation.
• EntityId: integer (int64)
  Identifier of the entity to which the Tiered Pricing is related.
• EntityTypeCode: string
  Maximum Length: 60

  The type of entity to which this Tiered Pricing is related. It may be RATE_VARIABLE_ID or custom ones defined.
• formulaRateTierLines: array Tier Lines VO
  Title: Tier Lines VO

  Formula rate tier lines define the individual tier ranges and calculation values within a formula rate tier.
• GraduatedCode: string
  Title: Apply Adjustment To

  Maximum Length: 30

  Tiered Pricing logic values are ALL_APPLICABLE_TIERS or HIGHEST_TIER.
• SubscriptionProductId: integer (int64)
  Identifier of the subscription product, if involved in negotiation.

{
    "type":"object",
    "properties":{
        "ChargeDefinitionCode":{
            "maxLength":120,
            "type":"string",
            "description":"The code of the charge definition, if involved in negotiation.",
            "nullable":true
        },
        "ChargeId":{
            "type":"integer",
            "description":"Identifier of the charge, if involved in negotiation.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "EntityId":{
            "type":"integer",
            "description":"Identifier of the entity to which the Tiered Pricing is related.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "EntityTypeCode":{
            "maxLength":60,
            "type":"string",
            "description":"The type of entity to which this Tiered Pricing is related. It may be RATE_VARIABLE_ID or custom ones defined.",
            "nullable":true
        },
        "GraduatedCode":{
            "title":"Apply Adjustment To",
            "maxLength":30,
            "type":"string",
            "description":"Tiered Pricing logic values are ALL_APPLICABLE_TIERS or HIGHEST_TIER.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"Identifier of the subscription product, if involved in negotiation.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "formulaRateTierLines":{
            "title":"Tier Lines VO",
            "type":"array",
            "description":"Formula rate tier lines define the individual tier ranges and calculation values within a formula rate tier.",
            "items":{
                "$ref":"#/components/schemas/subscriptionFormulaPlans-formulaRates-formulaRateTiers-formulaRateTierLines-item-patch-request"
            }
        }
    }
}

Nested Schema : Tier Lines VO

Type: array

Title: Tier Lines VO

Formula rate tier lines define the individual tier ranges and calculation values within a formula rate tier.

Show Source

• Array of: object subscriptionFormulaPlans-formulaRates-formulaRateTiers-formulaRateTierLines-item-patch-request

{
    "title":"Tier Lines VO",
    "type":"array",
    "description":"Formula rate tier lines define the individual tier ranges and calculation values within a formula rate tier.",
    "items":{
        "$ref":"#/components/schemas/subscriptionFormulaPlans-formulaRates-formulaRateTiers-formulaRateTierLines-item-patch-request"
    }
}

Nested Schema : subscriptionFormulaPlans-formulaRates-formulaRateTiers-formulaRateTierLines-item-patch-request

Type: object

Show Source

• MaximumValue: number
  Title: Less Than or Equal To

  Indicates the maximum value for the tier line.
• MinimumValue: number
  Title: More Than

  Indicates the minimum value for the tier line.
• TierValue: number
  Title: Value

  Indicates the value used in conjunction with the Tier Definition.

{
    "type":"object",
    "properties":{
        "MaximumValue":{
            "title":"Less Than or Equal To",
            "type":"number",
            "description":"Indicates the maximum value for the tier line.",
            "nullable":false
        },
        "MinimumValue":{
            "title":"More Than",
            "type":"number",
            "description":"Indicates the minimum value for the tier line.",
            "nullable":false
        },
        "TierValue":{
            "title":"Value",
            "type":"number",
            "description":"Indicates the value used in conjunction with the Tier Definition.",
            "nullable":false
        }
    }
}

Nested Schema : subscriptionFormulaPlans-formulaSteps-item-patch-request

Type: object

Show Source

• BalanceCode: string
  Title: Balance Code

  Maximum Length: 30

  The alternate identifier of the balance code.
• BalanceCodeId: integer (int64)
  The unique identifier of the balance code.
• ChargeDefinitionCode: string
  Maximum Length: 30

  The charge definition code for the adjustment.
• ChargeDefinitionId: integer (int64)
  The unique identifier of the charge definition for the adjustment.
• ChargeOutcomeFlag: boolean
  Title: Update Charge

  Maximum Length: 1

  Indicates the charge outcome of the formula step.
• FormulaExpression: string
  Title: Formula Builder

  Maximum Length: 4000

  The expression used to define the formula step.
• FormulaPlanId: integer (int64)
  The unique identifier of the formula plan associated with the formula step.
• NegotiableFlag: boolean
  Maximum Length: 1

  Indicates if the formula step is negotiable.
• OutcomeVariable: string
  Title: Step Name

  Maximum Length: 30

  The name of the outcome variable used in the formula step.
• SequenceNumber: integer (int64)
  Title: Step Sequence

  The sequence number that determines the order in which the step is executed.
• StepName: string
  Maximum Length: 200

  The name of the formula step.

{
    "type":"object",
    "properties":{
        "BalanceCode":{
            "title":"Balance Code",
            "maxLength":30,
            "type":"string",
            "description":"The alternate identifier of the balance code.",
            "nullable":true
        },
        "BalanceCodeId":{
            "type":"integer",
            "description":"The unique identifier of the balance code.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ChargeDefinitionCode":{
            "maxLength":30,
            "type":"string",
            "description":"The charge definition code for the adjustment.",
            "nullable":true
        },
        "ChargeDefinitionId":{
            "type":"integer",
            "description":"The unique identifier of the charge definition for the adjustment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ChargeOutcomeFlag":{
            "title":"Update Charge",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates the charge outcome of the formula step.",
            "nullable":true
        },
        "FormulaExpression":{
            "title":"Formula Builder",
            "maxLength":4000,
            "type":"string",
            "description":"The expression used to define the formula step.",
            "nullable":true
        },
        "FormulaPlanId":{
            "type":"integer",
            "description":"The unique identifier of the formula plan associated with the formula step.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "NegotiableFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the formula step is negotiable.",
            "nullable":true
        },
        "OutcomeVariable":{
            "title":"Step Name",
            "maxLength":30,
            "type":"string",
            "description":"The name of the outcome variable used in the formula step.",
            "nullable":true
        },
        "SequenceNumber":{
            "title":"Step Sequence",
            "type":"integer",
            "description":"The sequence number that determines the order in which the step is executed.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "StepName":{
            "maxLength":200,
            "type":"string",
            "description":"The name of the formula step.",
            "nullable":true
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : subscriptionFormulaPlans-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  Indicates the user who created the row.
• CreationDate: string (date-time)
  Read Only: true

  The date when the record was created.
• formulaPlanCharges: array Formula Charges
  Title: Formula Charges

  The Formula Plan Charge resource lets you view, create, update and delete formula plan charges. Formula plan charges are collections of business entities that store reusable formulas used to derive calculation values.
• FormulaPlanId: integer (int64)
  Read Only: true

  The unique identifier of the formula plan.
• FormulaPlanPuid: string
  Maximum Length: 120

  The public unique identifier of the formula plan.
• formulaRates: array Formula Rate Variables
  Title: Formula Rate Variables

  The formula rates resources lets you view, create, delete, and update formula rates. Formula rates are collections of business entities that store reusable formulas used to derive calculation values.
• formulaSteps: array Formula Steps
  Title: Formula Steps

  A formula step represents a unit of logic within a formula plan that defines how a value is calculated or derived during pricing.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Indicates the user who last updated the row.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login identifier used for the last update.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PriceListId: integer (int64)
  The unique identifier of the price list used for the formula plan.
• PriceListItemId: integer (int64)
  The unique identifier of the price list item associated with the rate plan.
• RatePlanId: integer (int64)
  The unique identifier of the rate plan associated with the formula plan.
• Status: string
  Maximum Length: 30

  The status of the formula plan.
• VersionNumber: integer (int64)
  The version number of the formula plan.

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Indicates the user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FormulaPlanId":{
            "type":"integer",
            "description":"The unique identifier of the formula plan.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FormulaPlanPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the formula plan.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login identifier used for the last update.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Indicates the user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PriceListId":{
            "type":"integer",
            "description":"The unique identifier of the price list used for the formula plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PriceListItemId":{
            "type":"integer",
            "description":"The unique identifier of the price list item associated with the rate plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RatePlanId":{
            "type":"integer",
            "description":"The unique identifier of the rate plan associated with the formula plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Status":{
            "maxLength":30,
            "type":"string",
            "description":"The status of the formula plan.",
            "nullable":false,
            "x-queryable":true
        },
        "VersionNumber":{
            "type":"integer",
            "description":"The version number of the formula plan.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "formulaPlanCharges":{
            "title":"Formula Charges",
            "type":"array",
            "description":"The Formula Plan Charge resource lets you view, create, update and delete formula plan charges. Formula plan charges are collections of business entities that store reusable formulas used to derive calculation values.",
            "items":{
                "$ref":"#/components/schemas/subscriptionFormulaPlans-formulaPlanCharges-item-response"
            }
        },
        "formulaRates":{
            "title":"Formula Rate Variables",
            "type":"array",
            "description":"The formula rates resources lets you view, create, delete, and update formula rates. Formula rates are collections of business entities that store reusable formulas used to derive calculation values.",
            "items":{
                "$ref":"#/components/schemas/subscriptionFormulaPlans-formulaRates-item-response"
            }
        },
        "formulaSteps":{
            "title":"Formula Steps",
            "type":"array",
            "description":"A formula step represents a unit of logic within a formula plan that defines how a value is calculated or derived during pricing.",
            "items":{
                "$ref":"#/components/schemas/subscriptionFormulaPlans-formulaSteps-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Formula Charges

Type: array

Title: Formula Charges

The Formula Plan Charge resource lets you view, create, update and delete formula plan charges. Formula plan charges are collections of business entities that store reusable formulas used to derive calculation values.

Show Source

• Array of: object subscriptionFormulaPlans-formulaPlanCharges-item-response

{
    "title":"Formula Charges",
    "type":"array",
    "description":"The Formula Plan Charge resource lets you view, create, update and delete formula plan charges. Formula plan charges are collections of business entities that store reusable formulas used to derive calculation values.",
    "items":{
        "$ref":"#/components/schemas/subscriptionFormulaPlans-formulaPlanCharges-item-response"
    }
}

Nested Schema : Formula Rate Variables

Type: array

Title: Formula Rate Variables

The formula rates resources lets you view, create, delete, and update formula rates. Formula rates are collections of business entities that store reusable formulas used to derive calculation values.

Show Source

• Array of: object subscriptionFormulaPlans-formulaRates-item-response

{
    "title":"Formula Rate Variables",
    "type":"array",
    "description":"The formula rates resources lets you view, create, delete, and update formula rates. Formula rates are collections of business entities that store reusable formulas used to derive calculation values.",
    "items":{
        "$ref":"#/components/schemas/subscriptionFormulaPlans-formulaRates-item-response"
    }
}

Nested Schema : Formula Steps

Type: array

Title: Formula Steps

A formula step represents a unit of logic within a formula plan that defines how a value is calculated or derived during pricing.

Show Source

• Array of: object subscriptionFormulaPlans-formulaSteps-item-response

{
    "title":"Formula Steps",
    "type":"array",
    "description":"A formula step represents a unit of logic within a formula plan that defines how a value is calculated or derived during pricing.",
    "items":{
        "$ref":"#/components/schemas/subscriptionFormulaPlans-formulaSteps-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : subscriptionFormulaPlans-formulaPlanCharges-item-response

Type: object

Show Source

• ChargeDefinitionCode: string
  Maximum Length: 30

  The unique charge definition code for the adjustment.
• ChargeDefinitionId: integer (int64)
  The unique identifier of the charge definition for the adjustment.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  Indicates the user who created the row.
• CreationDate: string (date-time)
  Read Only: true

  The date when the record was created.
• FormulaChargeId: integer (int64)
  Read Only: true

  The unique identifier of the formula charges.
• FormulaChargeType: string
  Maximum Length: 30

  The formula charge type used such as Billable, Revenue, or Prepared Variable.
• FormulaPlanId: integer (int64)
  The unique identifier of the formula plan of associated with this charge.
• FormulaPlanPuid: string
  Read Only: true

  Maximum Length: 120

  The unique identifier of the formula plan associated with this charge.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who updated the record last.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "ChargeDefinitionCode":{
            "maxLength":30,
            "type":"string",
            "description":"The unique charge definition code for the adjustment.",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeDefinitionId":{
            "type":"integer",
            "description":"The unique identifier of the charge definition for the adjustment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Indicates the user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FormulaChargeId":{
            "type":"integer",
            "description":"The unique identifier of the formula charges.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FormulaChargeType":{
            "maxLength":30,
            "type":"string",
            "description":"The formula charge type used such as Billable, Revenue, or Prepared Variable.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "FormulaPlanId":{
            "type":"integer",
            "description":"The unique identifier of the formula plan of associated with this charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FormulaPlanPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The unique identifier of the formula plan associated with this charge.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who updated the record last.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : subscriptionFormulaPlans-formulaRates-item-response

Type: object

Show Source

• CalculationMethodCode: string
  Title: Rate Type

  Maximum Length: 15

  The calculation method used for the formula negotiated value, such as VALUE, MATRIX, or TIER.
• ChargeDefinitionCode: string
  Maximum Length: 30

  The charge definition code for the adjustment.
• ChargeDefinitionId: integer (int64)
  The unique identifier of the charge definition for the adjustment.
• CPITierAdjustmentFlag: boolean
  Maximum Length: 1

  Indicates whether CPI is applied to the tier.
• CPIValueAdjustmentFlag: boolean
  Maximum Length: 1

  Indicates whether CPI is applied to the value.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  Indicates the user who created the row.
• CreationDate: string (date-time)
  Read Only: true

  The date when the record was created.
• DynamicMatrixClassId: integer (int64)
  The unique identifier of the dynamic matrix class. Populated only when the calculation method is MATRIX.
• DynamicMatrixId: integer (int64)
  The unique identifier of the dynamic matrix. Populated only when the calculation method is MATRIX.
• FormulaPlanId: integer (int64)
  The unique identifier of the formula plan associated with the pricing.
• FormulaPlanPuid: string
  Read Only: true

  Maximum Length: 120

  The unique identifier of the formula plan associated with this rate.
• formulaRateTiers: array Tier Headers VO
  Title: Tier Headers VO

  Formula rate tiers are collections of business entities. They store reusable formulas used to derive calculation values.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Indicates the user who last updated the row.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login identifier used for the last update.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RateCode: string
  Title: Variable

  Maximum Length: 200

  The negotiated rate code that identifies the charge component used for formula-based pricing.
• RateCodeName: string
  Maximum Length: 200

  The name of the negotiated rate code used for formula-based pricing.
• RateDescription: string
  Title: Description

  Maximum Length: 4000

  The description of the negotiated rate code used in formula-based pricing.
• RateVariableId: integer (int64)
  The unique identifier of the formula negotiated value.
• RateVariablePuid: string
  Maximum Length: 120

  The public unique identifier of the rate variable. This is used to identify the formula negotiated value record.
• TieredPricingHeaderId: integer (int64)
  The unique identifier of the tiered pricing header.
• Value: number
  Title: Base Value

  The value used for the formula negotiated value. Populated only when the calculation method is VALUE.
• ValueType: string
  Maximum Length: 15

  The type of value, such as percentage or amount, based on the calculation method.

{
    "type":"object",
    "properties":{
        "CPITierAdjustmentFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether CPI is applied to the tier.",
            "nullable":true,
            "x-queryable":true
        },
        "CPIValueAdjustmentFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether CPI is applied to the value.",
            "nullable":true,
            "x-queryable":true
        },
        "CalculationMethodCode":{
            "title":"Rate Type",
            "maxLength":15,
            "type":"string",
            "description":"The calculation method used for the formula negotiated value, such as VALUE, MATRIX, or TIER.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ChargeDefinitionCode":{
            "maxLength":30,
            "type":"string",
            "description":"The charge definition code for the adjustment.",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeDefinitionId":{
            "type":"integer",
            "description":"The unique identifier of the charge definition for the adjustment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Indicates the user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DynamicMatrixClassId":{
            "type":"integer",
            "description":"The unique identifier of the dynamic matrix class. Populated only when the calculation method is MATRIX.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DynamicMatrixId":{
            "type":"integer",
            "description":"The unique identifier of the dynamic matrix. Populated only when the calculation method is MATRIX.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FormulaPlanId":{
            "type":"integer",
            "description":"The unique identifier of the formula plan associated with the pricing.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FormulaPlanPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The unique identifier of the formula plan associated with this rate.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login identifier used for the last update.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Indicates the user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RateCode":{
            "title":"Variable",
            "maxLength":200,
            "type":"string",
            "description":"The negotiated rate code that identifies the charge component used for formula-based pricing.",
            "nullable":true,
            "x-queryable":true
        },
        "RateCodeName":{
            "maxLength":200,
            "type":"string",
            "description":"The name of the negotiated rate code used for formula-based pricing.",
            "nullable":true,
            "x-queryable":true
        },
        "RateDescription":{
            "title":"Description",
            "maxLength":4000,
            "type":"string",
            "description":"The description of the negotiated rate code used in formula-based pricing.",
            "nullable":true,
            "x-queryable":true
        },
        "RateVariableId":{
            "type":"integer",
            "description":"The unique identifier of the formula negotiated value.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RateVariablePuid":{
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the rate variable. This is used to identify the formula negotiated value record.",
            "nullable":false,
            "x-queryable":true
        },
        "TieredPricingHeaderId":{
            "type":"integer",
            "description":"The unique identifier of the tiered pricing header.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Value":{
            "title":"Base Value",
            "type":"number",
            "description":"The value used for the formula negotiated value. Populated only when the calculation method is VALUE.",
            "nullable":true,
            "x-queryable":true
        },
        "ValueType":{
            "maxLength":15,
            "type":"string",
            "description":"The type of value, such as percentage or amount, based on the calculation method.",
            "nullable":true,
            "x-queryable":true
        },
        "formulaRateTiers":{
            "title":"Tier Headers VO",
            "type":"array",
            "description":"Formula rate tiers are collections of business entities. They store reusable formulas used to derive calculation values.",
            "items":{
                "$ref":"#/components/schemas/subscriptionFormulaPlans-formulaRates-formulaRateTiers-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Tier Headers VO

Type: array

Title: Tier Headers VO

Formula rate tiers are collections of business entities. They store reusable formulas used to derive calculation values.

Show Source

• Array of: object subscriptionFormulaPlans-formulaRates-formulaRateTiers-item-response

{
    "title":"Tier Headers VO",
    "type":"array",
    "description":"Formula rate tiers are collections of business entities. They store reusable formulas used to derive calculation values.",
    "items":{
        "$ref":"#/components/schemas/subscriptionFormulaPlans-formulaRates-formulaRateTiers-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : subscriptionFormulaPlans-formulaRates-formulaRateTiers-item-response

Type: object

Show Source

• ChargeDefinitionCode: string
  Maximum Length: 120

  The code of the charge definition, if involved in negotiation.
• ChargeId: integer (int64)
  Identifier of the charge, if involved in negotiation.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  Indicates the user who created the row.
• CreationDate: string (date-time)
  Read Only: true

  The date when the record was created.
• EntityId: integer (int64)
  Identifier of the entity to which the Tiered Pricing is related.
• EntityTypeCode: string
  Maximum Length: 60

  The type of entity to which this Tiered Pricing is related. It may be RATE_VARIABLE_ID or custom ones defined.
• formulaRateTierLines: array Tier Lines VO
  Title: Tier Lines VO

  Formula rate tier lines define the individual tier ranges and calculation values within a formula rate tier.
• GraduatedCode: string
  Title: Apply Adjustment To

  Maximum Length: 30

  Tiered Pricing logic values are ALL_APPLICABLE_TIERS or HIGHEST_TIER.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who updated the record last.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RateVariablePuid: string
  Read Only: true

  Maximum Length: 120

  The unique identifier of the rate variable associated to this rate tier.
• SubscriptionProductId: integer (int64)
  Identifier of the subscription product, if involved in negotiation.
• TieredHeaderId: integer (int64)
  Read Only: true

  The unique identifier of tier headers.

{
    "type":"object",
    "properties":{
        "ChargeDefinitionCode":{
            "maxLength":120,
            "type":"string",
            "description":"The code of the charge definition, if involved in negotiation.",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeId":{
            "type":"integer",
            "description":"Identifier of the charge, if involved in negotiation.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Indicates the user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EntityId":{
            "type":"integer",
            "description":"Identifier of the entity to which the Tiered Pricing is related.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EntityTypeCode":{
            "maxLength":60,
            "type":"string",
            "description":"The type of entity to which this Tiered Pricing is related. It may be RATE_VARIABLE_ID or custom ones defined.",
            "nullable":true,
            "x-queryable":true
        },
        "GraduatedCode":{
            "title":"Apply Adjustment To",
            "maxLength":30,
            "type":"string",
            "description":"Tiered Pricing logic values are ALL_APPLICABLE_TIERS or HIGHEST_TIER.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who updated the record last.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RateVariablePuid":{
            "maxLength":120,
            "type":"string",
            "description":"The unique identifier of the rate variable associated to this rate tier.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"Identifier of the subscription product, if involved in negotiation.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TieredHeaderId":{
            "type":"integer",
            "description":"The unique identifier of tier headers.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "formulaRateTierLines":{
            "title":"Tier Lines VO",
            "type":"array",
            "description":"Formula rate tier lines define the individual tier ranges and calculation values within a formula rate tier.",
            "items":{
                "$ref":"#/components/schemas/subscriptionFormulaPlans-formulaRates-formulaRateTiers-formulaRateTierLines-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Tier Lines VO

Type: array

Title: Tier Lines VO

Formula rate tier lines define the individual tier ranges and calculation values within a formula rate tier.

Show Source

• Array of: object subscriptionFormulaPlans-formulaRates-formulaRateTiers-formulaRateTierLines-item-response

{
    "title":"Tier Lines VO",
    "type":"array",
    "description":"Formula rate tier lines define the individual tier ranges and calculation values within a formula rate tier.",
    "items":{
        "$ref":"#/components/schemas/subscriptionFormulaPlans-formulaRates-formulaRateTiers-formulaRateTierLines-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : subscriptionFormulaPlans-formulaRates-formulaRateTiers-formulaRateTierLines-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  Indicates the user who created the row.
• CreationDate: string (date-time)
  Read Only: true

  The date when the record was created.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who updated the record last.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MaximumValue: number
  Title: Less Than or Equal To

  Indicates the maximum value for the tier line.
• MinimumValue: number
  Title: More Than

  Indicates the minimum value for the tier line.
• TieredLineId: integer (int64)
  Read Only: true

  The unique identifier of tier lines.
• TierValue: number
  Title: Value

  Indicates the value used in conjunction with the Tier Definition.

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Indicates the user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who updated the record last.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MaximumValue":{
            "title":"Less Than or Equal To",
            "type":"number",
            "description":"Indicates the maximum value for the tier line.",
            "nullable":false,
            "x-queryable":true
        },
        "MinimumValue":{
            "title":"More Than",
            "type":"number",
            "description":"Indicates the minimum value for the tier line.",
            "nullable":false,
            "x-queryable":true
        },
        "TierValue":{
            "title":"Value",
            "type":"number",
            "description":"Indicates the value used in conjunction with the Tier Definition.",
            "nullable":false,
            "x-queryable":true
        },
        "TieredLineId":{
            "type":"integer",
            "description":"The unique identifier of tier lines.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : subscriptionFormulaPlans-formulaSteps-item-response

Type: object

Show Source

• BalanceCode: string
  Title: Balance Code

  Maximum Length: 30

  The alternate identifier of the balance code.
• BalanceCodeId: integer (int64)
  The unique identifier of the balance code.
• ChargeDefinitionCode: string
  Maximum Length: 30

  The charge definition code for the adjustment.
• ChargeDefinitionId: integer (int64)
  The unique identifier of the charge definition for the adjustment.
• ChargeOutcomeFlag: boolean
  Title: Update Charge

  Maximum Length: 1

  Indicates the charge outcome of the formula step.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  Indicates the user who created the row.
• CreationDate: string (date-time)
  Read Only: true

  The date when the record was created.
• FormulaExpression: string
  Title: Formula Builder

  Maximum Length: 4000

  The expression used to define the formula step.
• FormulaPlanId: integer (int64)
  The unique identifier of the formula plan associated with the formula step.
• FormulaPlanPuid: string
  Read Only: true

  Maximum Length: 120

  The unique identifier of the formula plan associated with this formula step.
• FormulaStepId: integer (int64)
  The unique identifier of the formula step.
• FormulaStepPuid: string
  Maximum Length: 120

  The public unique identifier of the formula step.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Indicates the user who last updated the row.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login identifier used for the last update.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NegotiableFlag: boolean
  Maximum Length: 1

  Indicates if the formula step is negotiable.
• OutcomeVariable: string
  Title: Step Name

  Maximum Length: 30

  The name of the outcome variable used in the formula step.
• SequenceNumber: integer (int64)
  Title: Step Sequence

  The sequence number that determines the order in which the step is executed.
• StepName: string
  Maximum Length: 200

  The name of the formula step.

{
    "type":"object",
    "properties":{
        "BalanceCode":{
            "title":"Balance Code",
            "maxLength":30,
            "type":"string",
            "description":"The alternate identifier of the balance code.",
            "nullable":true,
            "x-queryable":true
        },
        "BalanceCodeId":{
            "type":"integer",
            "description":"The unique identifier of the balance code.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChargeDefinitionCode":{
            "maxLength":30,
            "type":"string",
            "description":"The charge definition code for the adjustment.",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeDefinitionId":{
            "type":"integer",
            "description":"The unique identifier of the charge definition for the adjustment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChargeOutcomeFlag":{
            "title":"Update Charge",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates the charge outcome of the formula step.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Indicates the user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FormulaExpression":{
            "title":"Formula Builder",
            "maxLength":4000,
            "type":"string",
            "description":"The expression used to define the formula step.",
            "nullable":true,
            "x-queryable":true
        },
        "FormulaPlanId":{
            "type":"integer",
            "description":"The unique identifier of the formula plan associated with the formula step.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FormulaPlanPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The unique identifier of the formula plan associated with this formula step.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FormulaStepId":{
            "type":"integer",
            "description":"The unique identifier of the formula step.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FormulaStepPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the formula step.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login identifier used for the last update.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Indicates the user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NegotiableFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the formula step is negotiable.",
            "nullable":true,
            "x-queryable":true
        },
        "OutcomeVariable":{
            "title":"Step Name",
            "maxLength":30,
            "type":"string",
            "description":"The name of the outcome variable used in the formula step.",
            "nullable":true,
            "x-queryable":true
        },
        "SequenceNumber":{
            "title":"Step Sequence",
            "type":"integer",
            "description":"The sequence number that determines the order in which the step is executed.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "StepName":{
            "maxLength":200,
            "type":"string",
            "description":"The name of the formula step.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

formulaPlanCharges

Operation: /crmRestApi/resources/11.13.18.05/subscriptionFormulaPlans/{FormulaPlanPuid}/child/formulaPlanCharges

Parameters:

• FormulaPlanPuid: $request.path.FormulaPlanPuid

The Formula Plan Charge resource lets you view, create, update and delete formula plan charges. Formula plan charges are collections of business entities that store reusable formulas used to derive calculation values.

formulaRates

Operation: /crmRestApi/resources/11.13.18.05/subscriptionFormulaPlans/{FormulaPlanPuid}/child/formulaRates

Parameters:

• FormulaPlanPuid: $request.path.FormulaPlanPuid

The formula rates resources lets you view, create, delete, and update formula rates. Formula rates are collections of business entities that store reusable formulas used to derive calculation values.

formulaSteps

Operation: /crmRestApi/resources/11.13.18.05/subscriptionFormulaPlans/{FormulaPlanPuid}/child/formulaSteps

Parameters:

• FormulaPlanPuid: $request.path.FormulaPlanPuid

A formula step represents a unit of logic within a formula plan that defines how a value is calculated or derived during pricing.

Back to Top