Jump to

• Request
• Response

Get a rate plan charge

get

/crmRestApi/resources/11.13.18.05/ratePlanCharges/{ratePlanChargesUniqID}

Request

Path Parameters

• ratePlanChargesUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- RatePlanId and ChargeDefinitionId ---for the Rate Plan Usage Charges resource and used to uniquely identify an instance of Rate Plan Usage Charges. The client should not generate the hash key value. Instead, the client should query on the Rate Plan Usage Charges collection resource with a filter on the primary key values in order to navigate to a specific instance of Rate Plan Usage Charges.
  
  For example: ratePlanCharges?q=RatePlanId=<value1>;ChargeDefinitionId=<value2>

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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.

There's no request body for this operation.

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 : ratePlanCharges-item-response

Type: object

Show Source

• AppliesToCode: string
  Read Only: true

  Maximum Length: 30

  The applies to code of the rate plan charge.
• AttributePricingMatrixId: integer (int64)
  Read Only: true

  The pricing matrix identifier of the rate plan charge.
• BasePrice: number
  Read Only: true

  The base price of the rate plan charge.
• BasePriceMatrixId: integer (int64)
  Read Only: true

  The base price matrix identifier of the rate plan charge.
• CalculateMarginFlag: boolean
  Read Only: true

  Maximum Length: 30

  The calculate margin flag of the rate plan charge.
• CalculationMethodCode: string
  Read Only: true

  Maximum Length: 30

  The calculation method code of the rate plan charge.
• CalculationTypeCode: string
  Read Only: true

  Maximum Length: 30

  The calculation type code of the rate plan charge.
• CanAdjustFlag: boolean
  Read Only: true

  Maximum Length: 30

  Indicates whether the rate plan charge is adjusted.
• ChargeDefinitionCode: string
  Read Only: true

  Maximum Length: 30

  The charge definition code of the rate plan charge.
• ChargeDefinitionId: integer (int64)
  Read Only: true

  The charge definition identifier of the rate plan charge.
• ChargeName: string
  Read Only: true

  Maximum Length: 80

  The charge name of the rate plan charge.
• ChargePeriodCode: string
  Read Only: true

  Maximum Length: 3

  The charge period code of the rate plan charge.
• ChargeSubtypeCode: string
  Read Only: true

  Maximum Length: 30

  The charge subtype code of the rate plan charge.
• ChargeTypeCode: string
  Read Only: true

  Maximum Length: 30

  The charge type code of the rate plan charge.
• CostCalculationAmount: number
  Read Only: true

  The cost calculation amount of the rate plan charge.
• EndDate: string (date-time)
  Read Only: true

  The end date of the rate plan charge.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ParentEntityId: integer (int64)
  Read Only: true

  The parent entity identifier of the rate plan charge.
• PeriodicBillingFlag: boolean
  Read Only: true

  Maximum Length: 1

  The period billing flag of the rate plan charge.
• PeriodicRevenueRecognitionFlag: boolean
  Read Only: true

  Maximum Length: 1

  The periodic revenue recognition flag of the rate plan charge.
• PriceListChargeId: integer (int64)
  Read Only: true

  The price list charge identifier of the rate plan charge.
• PriceListId: integer (int64)
  Read Only: true

  The price list identifier of the rate plan charge.
• PricePeriodicityCode: string
  Read Only: true

  Maximum Length: 3

  The price periodicity code of the rate plan charge.
• PriceTypeCode: string
  Read Only: true

  Maximum Length: 30

  The price type code of the rate plan charge.
• QuantityAttribute: string
  Read Only: true

  Maximum Length: 300

  The quantity attribute of the rate plan charge.
• QuantityUnitOfMeasureAttribute: string
  Read Only: true

  Maximum Length: 300

  The quantity unit of measure attribute of the rate plan charge.
• RatePlanCurrencyCode: string
  Read Only: true

  Maximum Length: 15

  The rate plan currency code of the rate plan charge.
• RatePlanId: integer
  Read Only: true

  The rate plan identifier of the rate plan charge.
• RefundableFlag: boolean
  Read Only: true

  Maximum Length: 30

  Indicates whether the rate plan charge is refundable.
• StartDate: string (date-time)
  Read Only: true

  The start date of the rate plan charge.
• TieredPricingHeaderId: integer (int64)
  Read Only: true

  The tiered pricing header identifier of the rate plan charge.
• UsageUnitOfMeasure: string
  Read Only: true

  Maximum Length: 3

  The usage unit of measure of the rate plan charge.
• UsageUnitOfMeasureClass: string
  Read Only: true

  Maximum Length: 10

  The unit of measure class of the subscription balance code.

{
    "type":"object",
    "properties":{
        "AppliesToCode":{
            "maxLength":30,
            "type":"string",
            "description":"The applies to code of the rate plan charge.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AttributePricingMatrixId":{
            "type":"integer",
            "description":"The pricing matrix identifier of the rate plan charge.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BasePrice":{
            "type":"number",
            "description":"The base price of the rate plan charge.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BasePriceMatrixId":{
            "type":"integer",
            "description":"The base price matrix identifier of the rate plan charge.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CalculateMarginFlag":{
            "maxLength":30,
            "type":"boolean",
            "description":"The calculate margin flag of the rate plan charge.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CalculationMethodCode":{
            "maxLength":30,
            "type":"string",
            "description":"The calculation method code of the rate plan charge.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CalculationTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"The calculation type code of the rate plan charge.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CanAdjustFlag":{
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether the rate plan charge is adjusted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargeDefinitionCode":{
            "maxLength":30,
            "type":"string",
            "description":"The charge definition code of the rate plan charge.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargeDefinitionId":{
            "type":"integer",
            "description":"The charge definition identifier of the rate plan charge.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChargeName":{
            "maxLength":80,
            "type":"string",
            "description":"The charge name of the rate plan charge.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargePeriodCode":{
            "maxLength":3,
            "type":"string",
            "description":"The charge period code of the rate plan charge.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargeSubtypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"The charge subtype code of the rate plan charge.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargeTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"The charge type code of the rate plan charge.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CostCalculationAmount":{
            "type":"number",
            "description":"The cost calculation amount of the rate plan charge.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDate":{
            "type":"string",
            "description":"The end date of the rate plan charge.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentEntityId":{
            "type":"integer",
            "description":"The parent entity identifier of the rate plan charge.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PeriodicBillingFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"The period billing flag of the rate plan charge.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PeriodicRevenueRecognitionFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"The periodic revenue recognition flag of the rate plan charge.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PriceListChargeId":{
            "type":"integer",
            "description":"The price list charge identifier of the rate plan charge.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PriceListId":{
            "type":"integer",
            "description":"The price list identifier of the rate plan charge.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PricePeriodicityCode":{
            "maxLength":3,
            "type":"string",
            "description":"The price periodicity code of the rate plan charge.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PriceTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"The price type code of the rate plan charge.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "QuantityAttribute":{
            "maxLength":300,
            "type":"string",
            "description":"The quantity attribute of the rate plan charge.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "QuantityUnitOfMeasureAttribute":{
            "maxLength":300,
            "type":"string",
            "description":"The quantity unit of measure attribute of the rate plan charge.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RatePlanCurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"The rate plan currency code of the rate plan charge.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RatePlanId":{
            "type":"integer",
            "description":"The rate plan identifier of the rate plan charge.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RefundableFlag":{
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether the rate plan charge is refundable.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"The start date of the rate plan charge.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TieredPricingHeaderId":{
            "type":"integer",
            "description":"The tiered pricing header identifier of the rate plan charge.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UsageUnitOfMeasure":{
            "maxLength":3,
            "type":"string",
            "description":"The usage unit of measure of the rate plan charge.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UsageUnitOfMeasureClass":{
            "maxLength":10,
            "type":"string",
            "description":"The unit of measure class of the subscription balance code.",
            "nullable":true,
            "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."
        }
    }
}

Back to Top