Jump to

• Request
• Response

Create a product price escalation

post

/crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/productPriceEscalations

Request

Path Parameters

• SubscriptionNumber(required): string
  The alternate identifier of the subscription.
• SubscriptionProductPuid(required): string
  The subscription product PUID.

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

• ChargeDefinition: string
  Title: Charge Name

  Maximum Length: 30

  The charge definition code associated with product price escalations.
• EscalationEndDate: string (date)
  Title: Escalation End Date

  The end date of the product price escalation.
• EscalationEndOffsetDuration: integer (int64)
  Title: Escalation End Offset Duration

  The offset duration for the escalation end associated with product price.
• EscalationEndOffsetPeriod: string
  Title: Escalation End Offset Period

  Maximum Length: 30

  The offset period for the escalation end associated with product price.
• EscalationId: integer (int64)
  The identifier of the product price escalation.
• EscalationName: string
  Title: Escalation Name

  Maximum Length: 80

  The name of the escalation associated with product price.
• EscalationPuid: string
  Title: Identifier

  Maximum Length: 120

  The unique identifier for escalations associated with product price.
• EscalationStartDate: string (date)
  Title: Escalation Start Date

  The start date of the product price escalation.
• EscalationStartOffsetDuration: integer (int64)
  Title: Escalation Start Offset Duration

  The offset duration for the escalation's start associated with product price.
• EscalationStartOffsetPeriod: string
  Title: Escalation Start Offset Period

  Maximum Length: 30

  The offset period for the escalation's start associated with product price.
• EscalationType: string
  Title: Escalation Type

  Maximum Length: 30

  The type of product price escalation.
• EscalationValue: number
  Title: Escalation Value

  The value of the product price escalation.
• EscalationValueExpression: string
  Title: Expression

  Maximum Length: 4000

  The value expression associated with product price escalation.
• NextEvaluationDate: string (date)
  Title: Next Apply Date

  The next evaluation date for a product price escalation.
• NextPricingTermStartDate: string (date)
  Title: Next Term Start Date

  The start date of the next pricing term associated to a product price escalation.
• ObjectVersionNumber: integer (int32)
  The object version number of the record.
• PricingTermDuration: integer (int64)
  Title: Pricing Term Duration

  The duration of the pricing term.
• PricingTermEndDate: string (date)
  Title: Pricing Term End Date

  The end date of the pricing term.
• PricingTermEndOffsetDuration: integer (int64)
  Title: Pricing Term End Offset Duration

  The offset duration for the pricing term's end date.
• PricingTermEndOffsetPeriod: string
  Title: Pricing Term End Offset Period

  Maximum Length: 30

  The offset period for the pricing term's end date.
• PricingTermPeriod: string
  Title: Pricing Term Period

  Maximum Length: 30

  The period of the pricing term.
• SequenceNumber: integer (int64)
  Title: Sequence

  The sequence number of the product price escalation.
• SubscriptionProductId: integer (int64)
  The unique identifier for the subscription product associated with product price escalations.

{
    "type":"object",
    "properties":{
        "ChargeDefinition":{
            "title":"Charge Name",
            "maxLength":30,
            "type":"string",
            "description":"The charge definition code associated with product price escalations.",
            "nullable":true
        },
        "EscalationEndDate":{
            "title":"Escalation End Date",
            "type":"string",
            "description":"The end date of the product price escalation.",
            "format":"date",
            "nullable":true
        },
        "EscalationEndOffsetDuration":{
            "title":"Escalation End Offset Duration",
            "type":"integer",
            "description":"The offset duration for the escalation end associated with product price.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "EscalationEndOffsetPeriod":{
            "title":"Escalation End Offset Period",
            "maxLength":30,
            "type":"string",
            "description":"The offset period for the escalation end associated with product price.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "EscalationId":{
            "type":"integer",
            "description":"The identifier of the product price escalation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "EscalationName":{
            "title":"Escalation Name",
            "maxLength":80,
            "type":"string",
            "description":"The name of the escalation associated with product price.",
            "nullable":true
        },
        "EscalationPuid":{
            "title":"Identifier",
            "maxLength":120,
            "type":"string",
            "description":"The unique identifier for escalations associated with product price.",
            "nullable":false
        },
        "EscalationStartDate":{
            "title":"Escalation Start Date",
            "type":"string",
            "description":"The start date of the product price escalation.",
            "format":"date",
            "nullable":true
        },
        "EscalationStartOffsetDuration":{
            "title":"Escalation Start Offset Duration",
            "type":"integer",
            "description":"The offset duration for the escalation's start associated with product price.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "EscalationStartOffsetPeriod":{
            "title":"Escalation Start Offset Period",
            "maxLength":30,
            "type":"string",
            "description":"The offset period for the escalation's start associated with product price.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "EscalationType":{
            "title":"Escalation Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of product price escalation.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "EscalationValue":{
            "title":"Escalation Value",
            "type":"number",
            "description":"The value of the product price escalation.",
            "nullable":true
        },
        "EscalationValueExpression":{
            "title":"Expression",
            "maxLength":4000,
            "type":"string",
            "description":"The value expression associated with product price escalation.",
            "nullable":true
        },
        "NextEvaluationDate":{
            "title":"Next Apply Date",
            "type":"string",
            "description":"The next evaluation date for a product price escalation.",
            "format":"date",
            "nullable":true
        },
        "NextPricingTermStartDate":{
            "title":"Next Term Start Date",
            "type":"string",
            "description":"The start date of the next pricing term associated to a product price escalation.",
            "format":"date",
            "nullable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number of the record.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "PricingTermDuration":{
            "title":"Pricing Term Duration",
            "type":"integer",
            "description":"The duration of the pricing term.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PricingTermEndDate":{
            "title":"Pricing Term End Date",
            "type":"string",
            "description":"The end date of the pricing term.",
            "format":"date",
            "nullable":true
        },
        "PricingTermEndOffsetDuration":{
            "title":"Pricing Term End Offset Duration",
            "type":"integer",
            "description":"The offset duration for the pricing term's end date.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PricingTermEndOffsetPeriod":{
            "title":"Pricing Term End Offset Period",
            "maxLength":30,
            "type":"string",
            "description":"The offset period for the pricing term's end date.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PricingTermPeriod":{
            "title":"Pricing Term Period",
            "maxLength":30,
            "type":"string",
            "description":"The period of the pricing term.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SequenceNumber":{
            "title":"Sequence",
            "type":"integer",
            "description":"The sequence number of the product price escalation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The unique identifier for the subscription product associated with product price escalations.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

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 : subscriptions-products-productPriceEscalations-item-response

Type: object

Show Source

• ChargeDefinition: string
  Title: Charge Name

  Maximum Length: 30

  The charge definition code associated with product price escalations.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  The date when the record was created.
• EscalationEndDate: string (date)
  Title: Escalation End Date

  The end date of the product price escalation.
• EscalationEndOffsetDuration: integer (int64)
  Title: Escalation End Offset Duration

  The offset duration for the escalation end associated with product price.
• EscalationEndOffsetPeriod: string
  Title: Escalation End Offset Period

  Maximum Length: 30

  The offset period for the escalation end associated with product price.
• EscalationId: integer (int64)
  The identifier of the product price escalation.
• EscalationName: string
  Title: Escalation Name

  Maximum Length: 80

  The name of the escalation associated with product price.
• EscalationPuid: string
  Title: Identifier

  Maximum Length: 120

  The unique identifier for escalations associated with product price.
• EscalationStartDate: string (date)
  Title: Escalation Start Date

  The start date of the product price escalation.
• EscalationStartOffsetDuration: integer (int64)
  Title: Escalation Start Offset Duration

  The offset duration for the escalation's start associated with product price.
• EscalationStartOffsetPeriod: string
  Title: Escalation Start Offset Period

  Maximum Length: 30

  The offset period for the escalation's start associated with product price.
• EscalationType: string
  Title: Escalation Type

  Maximum Length: 30

  The type of product price escalation.
• EscalationValue: number
  Title: Escalation Value

  The value of the product price escalation.
• EscalationValueExpression: string
  Title: Expression

  Maximum Length: 4000

  The value expression associated with product price escalation.
• 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 last updated the record.
• 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.
• NextEvaluationDate: string (date)
  Title: Next Apply Date

  The next evaluation date for a product price escalation.
• NextPricingTermStartDate: string (date)
  Title: Next Term Start Date

  The start date of the next pricing term associated to a product price escalation.
• ObjectVersionNumber: integer (int32)
  The object version number of the record.
• PricingTermDuration: integer (int64)
  Title: Pricing Term Duration

  The duration of the pricing term.
• PricingTermEndDate: string (date)
  Title: Pricing Term End Date

  The end date of the pricing term.
• PricingTermEndOffsetDuration: integer (int64)
  Title: Pricing Term End Offset Duration

  The offset duration for the pricing term's end date.
• PricingTermEndOffsetPeriod: string
  Title: Pricing Term End Offset Period

  Maximum Length: 30

  The offset period for the pricing term's end date.
• PricingTermPeriod: string
  Title: Pricing Term Period

  Maximum Length: 30

  The period of the pricing term.
• SequenceNumber: integer (int64)
  Title: Sequence

  The sequence number of the product price escalation.
• SubscriptionProductId: integer (int64)
  The unique identifier for the subscription product associated with product price escalations.

{
    "type":"object",
    "properties":{
        "ChargeDefinition":{
            "title":"Charge Name",
            "maxLength":30,
            "type":"string",
            "description":"The charge definition code associated with product price escalations.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "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
        },
        "EscalationEndDate":{
            "title":"Escalation End Date",
            "type":"string",
            "description":"The end date of the product price escalation.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "EscalationEndOffsetDuration":{
            "title":"Escalation End Offset Duration",
            "type":"integer",
            "description":"The offset duration for the escalation end associated with product price.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EscalationEndOffsetPeriod":{
            "title":"Escalation End Offset Period",
            "maxLength":30,
            "type":"string",
            "description":"The offset period for the escalation end associated with product price.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EscalationId":{
            "type":"integer",
            "description":"The identifier of the product price escalation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EscalationName":{
            "title":"Escalation Name",
            "maxLength":80,
            "type":"string",
            "description":"The name of the escalation associated with product price.",
            "nullable":true,
            "x-queryable":true
        },
        "EscalationPuid":{
            "title":"Identifier",
            "maxLength":120,
            "type":"string",
            "description":"The unique identifier for escalations associated with product price.",
            "nullable":false,
            "x-queryable":true
        },
        "EscalationStartDate":{
            "title":"Escalation Start Date",
            "type":"string",
            "description":"The start date of the product price escalation.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "EscalationStartOffsetDuration":{
            "title":"Escalation Start Offset Duration",
            "type":"integer",
            "description":"The offset duration for the escalation's start associated with product price.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EscalationStartOffsetPeriod":{
            "title":"Escalation Start Offset Period",
            "maxLength":30,
            "type":"string",
            "description":"The offset period for the escalation's start associated with product price.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EscalationType":{
            "title":"Escalation Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of product price escalation.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EscalationValue":{
            "title":"Escalation Value",
            "type":"number",
            "description":"The value of the product price escalation.",
            "nullable":true,
            "x-queryable":true
        },
        "EscalationValueExpression":{
            "title":"Expression",
            "maxLength":4000,
            "type":"string",
            "description":"The value expression associated with product price escalation.",
            "nullable":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 last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NextEvaluationDate":{
            "title":"Next Apply Date",
            "type":"string",
            "description":"The next evaluation date for a product price escalation.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "NextPricingTermStartDate":{
            "title":"Next Term Start Date",
            "type":"string",
            "description":"The start date of the next pricing term associated to a product price escalation.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number of the record.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "PricingTermDuration":{
            "title":"Pricing Term Duration",
            "type":"integer",
            "description":"The duration of the pricing term.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PricingTermEndDate":{
            "title":"Pricing Term End Date",
            "type":"string",
            "description":"The end date of the pricing term.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "PricingTermEndOffsetDuration":{
            "title":"Pricing Term End Offset Duration",
            "type":"integer",
            "description":"The offset duration for the pricing term's end date.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PricingTermEndOffsetPeriod":{
            "title":"Pricing Term End Offset Period",
            "maxLength":30,
            "type":"string",
            "description":"The offset period for the pricing term's end date.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PricingTermPeriod":{
            "title":"Pricing Term Period",
            "maxLength":30,
            "type":"string",
            "description":"The period of the pricing term.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SequenceNumber":{
            "title":"Sequence",
            "type":"integer",
            "description":"The sequence number of the product price escalation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The unique identifier for the subscription product associated with product price escalations.",
            "format":"int64",
            "nullable":false,
            "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

EscEndOffsetPeriodVA

Operation: /crmRestApi/resources/11.13.18.05/timeUnitOfMeasures

The following properties are defined on the LOV link relation:

• Source Attribute: EscalationEndOffsetPeriod; Target Attribute: UomCode
• Display Attribute: UnitOfMeasure

EscStartOffsetPeriodVA

Operation: /crmRestApi/resources/11.13.18.05/timeUnitOfMeasures

The following properties are defined on the LOV link relation:

• Source Attribute: EscalationStartOffsetPeriod; Target Attribute: UomCode
• Display Attribute: UnitOfMeasure

EscalationTypeVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_OSS_ESCALATION_TYPES

The following properties are defined on the LOV link relation:

• Source Attribute: EscalationType; Target Attribute: LookupCode
• Display Attribute: Meaning

PriceTermEndOffsetPeriodVA

Operation: /crmRestApi/resources/11.13.18.05/timeUnitOfMeasures

The following properties are defined on the LOV link relation:

• Source Attribute: PricingTermEndOffsetPeriod; Target Attribute: UomCode
• Display Attribute: UnitOfMeasure

PriceTermPeriodVA

Operation: /crmRestApi/resources/11.13.18.05/timeUnitOfMeasures

The following properties are defined on the LOV link relation:

• Source Attribute: PricingTermPeriod; Target Attribute: UomCode
• Display Attribute: UnitOfMeasure

Back to Top