Jump to

• Request
• Response

Create a formula rate tier

post

/crmRestApi/resources/11.13.18.05/subscriptionFormulaPlans/{FormulaPlanPuid}/child/formulaRates/{RateVariablePuid}/child/formulaRateTiers

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=
• RateVariablePuid(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.
• Upsert-Mode: string
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

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-post-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-post-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-post-request"
    }
}

Nested Schema : subscriptionFormulaPlans-formulaRates-formulaRateTiers-formulaRateTierLines-item-post-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
        }
    }
}

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-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 : 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."
        }
    }
}

Links

formulaRateTierLines

Operation: /crmRestApi/resources/11.13.18.05/subscriptionFormulaPlans/{FormulaPlanPuid}/child/formulaRates/{RateVariablePuid}/child/formulaRateTiers/{formulaRateTiersUniqID}/child/formulaRateTierLines

Parameters:

• FormulaPlanPuid: $request.path.FormulaPlanPuid
• RateVariablePuid: $request.path.RateVariablePuid
• formulaRateTiersUniqID: $request.path.formulaRateTiersUniqID

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

Back to Top