Jump to

• Request
• Response

Get a subscription balance profile charge

get

/crmRestApi/resources/11.13.18.05/subscriptionBalanceProfiles/{BalanceProfileNumber}/child/profileCharges/{BalanceProfileChargeNumber}

Request

Path Parameters

• BalanceProfileChargeNumber(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=
• BalanceProfileNumber(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=

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 : subscriptionBalanceProfiles-profileCharges-item-response

Type: object

Show Source

• AllowanceGrantFlag: boolean
  Title: Enable allowance

  Maximum Length: 1

  Default Value: false

  Indicates whether the allowance grant is enabled for a balance register profile charge.
• BalanceProfileChargeId: integer (int64)
  The balance profile charge identifier of the subscription balance profile charges.
• BalanceProfileChargeNumber: string
  Title: Profile Charge Number

  Maximum Length: 120

  The balance profile charge number of the subscription balance profile charges.
• BalanceProfileId: integer (int64)
  The balance profile identifier of the subscription balance profile charges.
• BillingFrequency: string
  Title: Billing Frequency

  Maximum Length: 30

  The billing frequency of the subscription balance profile charge.
• BillingFrequencyUnitOfMeasure: string
  Title: Billing Frequency

  Maximum Length: 25

  The billing frequency unit of measure of the subscription balance profile charge.
• ChargeDefinitionCode: string
  Title: Charge Definition

  Maximum Length: 30

  The charge definition code of the subscription balance profile charges.
• ChargeDefinitionId: integer (int64)
  Title: Charge Name

  The balance charge definition identifier of the subscription balance profile charges.
• ChargePeriod: string
  Title: Periodicity

  Maximum Length: 30

  The charge period of the subscription balance profile charges.
• ChargePeriodUnitOfMeasure: string
  Title: Periodicity

  Maximum Length: 25

  The charge period unit of measure of the subscription balance profile charges.
• CommitmentFlag: boolean
  Title: Enable commitment

  Maximum Length: 1

  Default Value: false

  Indicates whether the commitment is enabled for a balance register profile charge.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the subscription balance profile charges.
• CreationDate: string (date-time)
  Read Only: true

  The date when the subscription balance profile charge was created.
• EstimateFlag: boolean
  Title: Enable estimate

  Maximum Length: 1

  Default Value: false

  Indicates whether the estimate is enabled for a balance register profile charge.
• InvoicingRule: string
  Title: Invoicing Rule

  Maximum Length: 30

  The invoicing rule of the subscription balance profile charge.
• InvoicingRuleId: integer (int64)
  The invoicing rule identifier of the subscription balance profile charge.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the subscription profile charge was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who has last updated the subscription balance criterion.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the subscription profile charge.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  The object version number updated after every update of a subscription profile charge.
• RelatedChargeDefinitionCode: string
  Title: Related Charge

  Maximum Length: 30

  The charge definition code of the related profile charge.
• RelatedChargeDefinitionId: integer (int64)
  Title: Related Charge

  The charge definition identifier of the related profile charge.
• RelatedProfileChargeId: integer (int64)
  The balance profile charge identifier of the related charge identifier.
• UsageCaptureFlag: boolean
  Title: Enable usage capture

  Maximum Length: 1

  Default Value: false

  Indicates whether the usage capture is enabled for a balance register profile charge.
• VolumePricingFlag: boolean
  Title: Enable volume pricing

  Maximum Length: 1

  Default Value: false

  Indicates whether the profile charge is enabled for volume pricing.

{
    "type":"object",
    "properties":{
        "AllowanceGrantFlag":{
            "title":"Enable allowance",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the allowance grant is enabled for a balance register profile charge.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "dependencies":[
                    "ChargeDefinitionId"
                ]
            },
            "x-queryable":true
        },
        "BalanceProfileChargeId":{
            "type":"integer",
            "description":"The balance profile charge identifier of the subscription balance profile charges.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BalanceProfileChargeNumber":{
            "title":"Profile Charge Number",
            "maxLength":120,
            "type":"string",
            "description":"The balance profile charge number of the subscription balance profile charges.",
            "nullable":false,
            "x-queryable":true
        },
        "BalanceProfileId":{
            "type":"integer",
            "description":"The balance profile identifier of the subscription balance profile charges.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BillingFrequency":{
            "title":"Billing Frequency",
            "maxLength":30,
            "type":"string",
            "description":"The billing frequency of the subscription balance profile charge.",
            "nullable":true,
            "x-queryable":true
        },
        "BillingFrequencyUnitOfMeasure":{
            "title":"Billing Frequency",
            "maxLength":25,
            "type":"string",
            "description":"The billing frequency unit of measure of the subscription balance profile charge.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ChargeDefinitionCode":{
            "title":"Charge Definition",
            "maxLength":30,
            "type":"string",
            "description":"The charge definition code of the subscription balance profile charges.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ChargeDefinitionId":{
            "title":"Charge Name",
            "type":"integer",
            "description":"The balance charge definition identifier of the subscription balance profile charges.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "ChargePeriod":{
            "title":"Periodicity",
            "maxLength":30,
            "type":"string",
            "description":"The charge period of the subscription balance profile charges.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ChargeDefinitionId"
                ]
            },
            "x-queryable":true
        },
        "ChargePeriodUnitOfMeasure":{
            "title":"Periodicity",
            "maxLength":25,
            "type":"string",
            "description":"The charge period unit of measure of the subscription balance profile charges.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "CommitmentFlag":{
            "title":"Enable commitment",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the commitment is enabled for a balance register profile charge.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "dependencies":[
                    "ChargeDefinitionId"
                ]
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the subscription balance profile charges.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the subscription balance profile charge was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EstimateFlag":{
            "title":"Enable estimate",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the estimate is enabled for a balance register profile charge.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "dependencies":[
                    "ChargeDefinitionId"
                ]
            },
            "x-queryable":true
        },
        "InvoicingRule":{
            "title":"Invoicing Rule",
            "maxLength":30,
            "type":"string",
            "description":"The invoicing rule of the subscription balance profile charge.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "InvoicingRuleId":{
            "type":"integer",
            "description":"The invoicing rule identifier of the subscription balance profile charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the subscription profile charge 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 subscription profile charge.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who has last updated the subscription balance criterion.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number updated after every update of a subscription profile charge.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "RelatedChargeDefinitionCode":{
            "title":"Related Charge",
            "maxLength":30,
            "type":"string",
            "description":"The charge definition code of the related profile charge.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RelatedChargeDefinitionId":{
            "title":"Related Charge",
            "type":"integer",
            "description":"The charge definition identifier of the related profile charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "AllowanceGrantFlag",
                    "CommitmentFlag",
                    "EstimateFlag"
                ]
            },
            "x-queryable":true
        },
        "RelatedProfileChargeId":{
            "type":"integer",
            "description":"The balance profile charge identifier of the related charge identifier.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UsageCaptureFlag":{
            "title":"Enable usage capture",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the usage capture is enabled for a balance register profile charge.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "dependencies":[
                    "ChargeDefinitionId"
                ]
            },
            "x-queryable":true
        },
        "VolumePricingFlag":{
            "title":"Enable volume pricing",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the profile charge is enabled for volume pricing.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "dependencies":[
                    "ChargeDefinitionId"
                ]
            },
            "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