Jump to

• Request
• Response

Update a subscription charge tier

patch

/crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/charges/{ChargePuid2}/child/chargeTiers/{ChargeTierPuid}

Request

Path Parameters

• ChargePuid(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=
• ChargeTierPuid(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=
• CoveredLevelPuid(required): string
  The covered level PUID
• 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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AdditionalNumberFive: number
  Title: Additional Number Five

  The additional number five
• AdditionalNumberFour: number
  Title: Additional Number Four

  The additional number four
• AdditionalNumberOne: number
  Title: Additional Number One

  The additional number one
• AdditionalNumberSix: number
  Title: Additional Number Six

  The additional number six
• AdditionalNumberThree: number
  Title: Additional Number Three

  The additional number three
• AdditionalNumberTwo: number
  Title: Additional Number Two

  The additional number two
• AdditionalTextOne: string
  Title: Additional Text One

  Maximum Length: 4000

  The additional text one
• AdditionalTextTwo: string
  Title: Additional Text Two

  Maximum Length: 4000

  The additional text two
• AdditionalTimestampOne: string (date-time)
  Title: Additional Time-stamp One

  The additional timestamp one
• AdditionalTimestampThree: string (date-time)
  Title: Additional Time-stamp Three

  The additional timestamp three
• AdditionalTimestampTwo: string (date-time)
  Title: Additional Time-stamp Two

  The additional timestamp two
• AddtionalTextThree: string
  Title: Additional Text Three

  Maximum Length: 4000

  The additional text three
• BlockSize: number
  Title: Block Size

  The block size
• ChargeId: integer (int64)
  The charge ID
• ChargeTierId: integer (int64)
  The charge tier ID
• ChargeTierPuid: string
  Maximum Length: 120

  The charge tier PUID
• ListPrice: number
  Title: List Price

  The list price
• PriceFormat: string
  Title: Price Format

  Maximum Length: 30

  The price format
• SequenceNumber: number
  The sequence number
• SubscriptionId: integer (int64)
  The subscription ID
• SubscriptionProductId: integer (int64)
  The subscription product ID
• TierFrom: number
  Title: Tier From

  The tier from
• TierTo: number
  Title: Tier To

  The tier to

{
    "type":"object",
    "properties":{
        "AdditionalNumberFive":{
            "title":"Additional Number Five",
            "type":"number",
            "description":"The additional number five",
            "nullable":true
        },
        "AdditionalNumberFour":{
            "title":"Additional Number Four",
            "type":"number",
            "description":"The additional number four",
            "nullable":true
        },
        "AdditionalNumberOne":{
            "title":"Additional Number One",
            "type":"number",
            "description":"The additional number one",
            "nullable":true
        },
        "AdditionalNumberSix":{
            "title":"Additional Number Six",
            "type":"number",
            "description":"The additional number six",
            "nullable":true
        },
        "AdditionalNumberThree":{
            "title":"Additional Number Three",
            "type":"number",
            "description":"The additional number three",
            "nullable":true
        },
        "AdditionalNumberTwo":{
            "title":"Additional Number Two",
            "type":"number",
            "description":"The additional number two",
            "nullable":true
        },
        "AdditionalTextOne":{
            "title":"Additional Text One",
            "maxLength":4000,
            "type":"string",
            "description":"The additional text one",
            "nullable":true
        },
        "AdditionalTextTwo":{
            "title":"Additional Text Two",
            "maxLength":4000,
            "type":"string",
            "description":"The additional text two",
            "nullable":true
        },
        "AdditionalTimestampOne":{
            "title":"Additional Time-stamp One",
            "type":"string",
            "description":"The additional timestamp one",
            "format":"date-time",
            "nullable":true
        },
        "AdditionalTimestampThree":{
            "title":"Additional Time-stamp Three",
            "type":"string",
            "description":"The additional timestamp three",
            "format":"date-time",
            "nullable":true
        },
        "AdditionalTimestampTwo":{
            "title":"Additional Time-stamp Two",
            "type":"string",
            "description":"The additional timestamp two",
            "format":"date-time",
            "nullable":true
        },
        "AddtionalTextThree":{
            "title":"Additional Text Three",
            "maxLength":4000,
            "type":"string",
            "description":"The additional text three",
            "nullable":true
        },
        "BlockSize":{
            "title":"Block Size",
            "type":"number",
            "description":"The block size",
            "nullable":true
        },
        "ChargeId":{
            "type":"integer",
            "description":"The charge ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ChargeTierId":{
            "type":"integer",
            "description":"The charge tier ID",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ChargeTierPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The charge tier PUID",
            "nullable":false
        },
        "ListPrice":{
            "title":"List Price",
            "type":"number",
            "description":"The list price",
            "nullable":false
        },
        "PriceFormat":{
            "title":"Price Format",
            "maxLength":30,
            "type":"string",
            "description":"The price format",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SequenceNumber":{
            "type":"number",
            "description":"The sequence number",
            "nullable":false
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The subscription ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The subscription product ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "TierFrom":{
            "title":"Tier From",
            "type":"number",
            "description":"The tier from",
            "nullable":false
        },
        "TierTo":{
            "title":"Tier To",
            "type":"number",
            "description":"The tier to",
            "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 : subscriptions-products-coveredLevels-charges-chargeTiers-item-response

Type: object

Show Source

• AdditionalNumberFive: number
  Title: Additional Number Five

  The additional number five
• AdditionalNumberFour: number
  Title: Additional Number Four

  The additional number four
• AdditionalNumberOne: number
  Title: Additional Number One

  The additional number one
• AdditionalNumberSix: number
  Title: Additional Number Six

  The additional number six
• AdditionalNumberThree: number
  Title: Additional Number Three

  The additional number three
• AdditionalNumberTwo: number
  Title: Additional Number Two

  The additional number two
• AdditionalTextOne: string
  Title: Additional Text One

  Maximum Length: 4000

  The additional text one
• AdditionalTextTwo: string
  Title: Additional Text Two

  Maximum Length: 4000

  The additional text two
• AdditionalTimestampOne: string (date-time)
  Title: Additional Time-stamp One

  The additional timestamp one
• AdditionalTimestampThree: string (date-time)
  Title: Additional Time-stamp Three

  The additional timestamp three
• AdditionalTimestampTwo: string (date-time)
  Title: Additional Time-stamp Two

  The additional timestamp two
• AddtionalTextThree: string
  Title: Additional Text Three

  Maximum Length: 4000

  The additional text three
• BlockSize: number
  Title: Block Size

  The block size
• ChargeId: integer (int64)
  The charge ID
• ChargeTierId: integer (int64)
  The charge tier ID
• ChargeTierPuid: string
  Maximum Length: 120

  The charge tier PUID
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The created by
• CreationDate: string (date-time)
  Read Only: true

  The creation date
• LastUpdateDate: string (date-time)
  Read Only: true

  The last update date
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The last updated by
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The last update login
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ListPrice: number
  Title: List Price

  The list price
• PriceFormat: string
  Title: Price Format

  Maximum Length: 30

  The price format
• SequenceNumber: number
  The sequence number
• SubscriptionId: integer (int64)
  The subscription ID
• SubscriptionProductId: integer (int64)
  The subscription product ID
• TierFrom: number
  Title: Tier From

  The tier from
• TierTo: number
  Title: Tier To

  The tier to

{
    "type":"object",
    "properties":{
        "AdditionalNumberFive":{
            "title":"Additional Number Five",
            "type":"number",
            "description":"The additional number five",
            "nullable":true,
            "x-queryable":true
        },
        "AdditionalNumberFour":{
            "title":"Additional Number Four",
            "type":"number",
            "description":"The additional number four",
            "nullable":true,
            "x-queryable":true
        },
        "AdditionalNumberOne":{
            "title":"Additional Number One",
            "type":"number",
            "description":"The additional number one",
            "nullable":true,
            "x-queryable":true
        },
        "AdditionalNumberSix":{
            "title":"Additional Number Six",
            "type":"number",
            "description":"The additional number six",
            "nullable":true,
            "x-queryable":true
        },
        "AdditionalNumberThree":{
            "title":"Additional Number Three",
            "type":"number",
            "description":"The additional number three",
            "nullable":true,
            "x-queryable":true
        },
        "AdditionalNumberTwo":{
            "title":"Additional Number Two",
            "type":"number",
            "description":"The additional number two",
            "nullable":true,
            "x-queryable":true
        },
        "AdditionalTextOne":{
            "title":"Additional Text One",
            "maxLength":4000,
            "type":"string",
            "description":"The additional text one",
            "nullable":true,
            "x-queryable":true
        },
        "AdditionalTextTwo":{
            "title":"Additional Text Two",
            "maxLength":4000,
            "type":"string",
            "description":"The additional text two",
            "nullable":true,
            "x-queryable":true
        },
        "AdditionalTimestampOne":{
            "title":"Additional Time-stamp One",
            "type":"string",
            "description":"The additional timestamp one",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "AdditionalTimestampThree":{
            "title":"Additional Time-stamp Three",
            "type":"string",
            "description":"The additional timestamp three",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "AdditionalTimestampTwo":{
            "title":"Additional Time-stamp Two",
            "type":"string",
            "description":"The additional timestamp two",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "AddtionalTextThree":{
            "title":"Additional Text Three",
            "maxLength":4000,
            "type":"string",
            "description":"The additional text three",
            "nullable":true,
            "x-queryable":true
        },
        "BlockSize":{
            "title":"Block Size",
            "type":"number",
            "description":"The block size",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeId":{
            "type":"integer",
            "description":"The charge ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChargeTierId":{
            "type":"integer",
            "description":"The charge tier ID",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChargeTierPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The charge tier PUID",
            "nullable":false,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The created by",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The creation date",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The last update date",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The last update login",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The last updated by",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ListPrice":{
            "title":"List Price",
            "type":"number",
            "description":"The list price",
            "nullable":false,
            "x-queryable":true
        },
        "PriceFormat":{
            "title":"Price Format",
            "maxLength":30,
            "type":"string",
            "description":"The price format",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SequenceNumber":{
            "type":"number",
            "description":"The sequence number",
            "nullable":false,
            "x-queryable":true
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The subscription ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The subscription product ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TierFrom":{
            "title":"Tier From",
            "type":"number",
            "description":"The tier from",
            "nullable":false,
            "x-queryable":true
        },
        "TierTo":{
            "title":"Tier To",
            "type":"number",
            "description":"The tier to",
            "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"
    }
}

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

Back to Top