Get a Billing Cycle Specification by ID
get
/billingCycleSpecification/{id}
Gets the specified billing cycle specification.
Request
Path Parameters
-
id(required): string
The ID of the billing cycle specification to get.Example:
0.0.0.1+-billinfo+105951
Query Parameters
-
@type: string
The type of object to return.Example:
Use @type=BillingCycleSpecification for a base object, or @type=BillingCycleSpecificationOracle for an extended object.
-
fields: string
The comma-separated list of fields to return in the response.Example:
fields=chargeDateOffset,frequency
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json;charset=utf-8
200 Response
Success
Root Schema : Billing Cycle Specification
Type:
object
Title:
Billing Cycle Specification
A billing cycle specification, which specifies billing cycle details.
Show Source
-
@baseType: string
Title:
Base Type
The object's superclass. -
@schemaLocation: string
(uri)
Title:
Schema Location
A URI to a JSON schema file that defines additional attributes and relationships. -
@type: string
Title:
Type
The object's subclass. -
billingDateShift: integer
Title:
Billing Date Shift
The number of days from the start of the billing period by which to offset the billing date. -
billingPeriod: string
Title:
Billing Period
The length of the billing period. For example, week, month, quarter, year. -
chargeDateOffset: integer
Title:
Charge Date Offset
The number of days from the start of the billing period by which to offset the charges that appear on a bill. -
creditDateOffset: integer
Title:
Credit Date Offset
The number of days from the start of the billing period by which to offset the credits that appear on a bill. -
description: string
Title:
Billing Cycle Specification Description
The billing cycle specification's description. -
frequency: string
Title:
Frequency
The billing frequency. For example, monthly. -
href(required): string
Title:
Billing Cycle Specification Href
The billing cycle specification's href. -
id(required): string
Title:
Billing Cycle Specification ID
The billing cycle specification's ID. -
mailingDateOffset: integer
Title:
Mailing Date Offset
The number of days from the start of the billing period by which to offset the date the bill is mailed. -
name(required): string
Title:
Billing Cycle Specification Name
The billing cycle specification's name. -
paymentDueDateOffset: integer
Title:
Payment Due Date Offset
The number of days from the start of the billing period by which to offset the payment's due date. -
validFor: object
TimePeriod
A period of time.
Nested Schema : TimePeriod
Type:
object
A period of time.
Show Source
-
endDateTime: string
(date-time)
Title:
End Time Period
The end of the time period in IETC-RFC-3339 format. -
startDateTime: string
(date-time)
Title:
Start Time Period
The start of the time period in IETC-RFC-3339 format.
400 Response
Bad Request
Root Schema : Error
Type:
object
This is used when an API throws an error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
-
@baseType: string
This defines the super-class when sub-classing.
-
@schemaLocation: string
(uri)
A URI to a JSON-schema file that defines additional attributes and relationships.
-
@type: string
This defines the sub-class entity name when sub-classing.
-
code(required): string
Refers to application relevant detail, defined in the API or a common list.
-
message: string
More details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
Explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
Displays the HTTP error code extension.
401 Response
Unauthorized
Root Schema : Error
Type:
object
This is used when an API throws an error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
-
@baseType: string
This defines the super-class when sub-classing.
-
@schemaLocation: string
(uri)
A URI to a JSON-schema file that defines additional attributes and relationships.
-
@type: string
This defines the sub-class entity name when sub-classing.
-
code(required): string
Refers to application relevant detail, defined in the API or a common list.
-
message: string
More details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
Explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
Displays the HTTP error code extension.
403 Response
Forbidden
Root Schema : Error
Type:
object
This is used when an API throws an error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
-
@baseType: string
This defines the super-class when sub-classing.
-
@schemaLocation: string
(uri)
A URI to a JSON-schema file that defines additional attributes and relationships.
-
@type: string
This defines the sub-class entity name when sub-classing.
-
code(required): string
Refers to application relevant detail, defined in the API or a common list.
-
message: string
More details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
Explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
Displays the HTTP error code extension.
404 Response
Not Found
Root Schema : Error
Type:
object
This is used when an API throws an error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
-
@baseType: string
This defines the super-class when sub-classing.
-
@schemaLocation: string
(uri)
A URI to a JSON-schema file that defines additional attributes and relationships.
-
@type: string
This defines the sub-class entity name when sub-classing.
-
code(required): string
Refers to application relevant detail, defined in the API or a common list.
-
message: string
More details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
Explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
Displays the HTTP error code extension.
405 Response
Method Not allowed
Root Schema : Error
Type:
object
This is used when an API throws an error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
-
@baseType: string
This defines the super-class when sub-classing.
-
@schemaLocation: string
(uri)
A URI to a JSON-schema file that defines additional attributes and relationships.
-
@type: string
This defines the sub-class entity name when sub-classing.
-
code(required): string
Refers to application relevant detail, defined in the API or a common list.
-
message: string
More details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
Explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
Displays the HTTP error code extension.
409 Response
Conflict
Root Schema : Error
Type:
object
This is used when an API throws an error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
-
@baseType: string
This defines the super-class when sub-classing.
-
@schemaLocation: string
(uri)
A URI to a JSON-schema file that defines additional attributes and relationships.
-
@type: string
This defines the sub-class entity name when sub-classing.
-
code(required): string
Refers to application relevant detail, defined in the API or a common list.
-
message: string
More details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
Explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
Displays the HTTP error code extension.
500 Response
Internal Server Error
Root Schema : Error
Type:
object
This is used when an API throws an error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
-
@baseType: string
This defines the super-class when sub-classing.
-
@schemaLocation: string
(uri)
A URI to a JSON-schema file that defines additional attributes and relationships.
-
@type: string
This defines the sub-class entity name when sub-classing.
-
code(required): string
Refers to application relevant detail, defined in the API or a common list.
-
message: string
More details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
Explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
Displays the HTTP error code extension.
Examples
The following example shows how to get a billing cycle specification with a specified ID by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL.
The request uses the fields query parameter to show the details for certain fields only.
curl -X GET 'http://host:port/brm/accountManagement/version/billingCycleSpecification/0.0.0.1+-billinfo+105951?fields=chargeDateOffset,validFor'
Example of the Response Body
The following example shows the contents of the response body in JSON format. Because the request included only chargeDateOffset and validFor in the fields query parameter, these are the only additional details shown.
{ "id": "0.0.0.1+-billinfo+105951", "href": "http://host:port/brm/accountManagement/version/billingCycleSpecification/0.0.0.1+-billinfo+105951", "billingDateShift": null, "billingPeriod": null, "chargeDateOffset": 13, "creditDateOffset": null, "description": null, "frequency": null, "mailingDateOffset": null, "name": null, "paymentDueDateOffset": null, "validFor": { "endDateTime": null, "startDateTime": "2020-05-02T01:15:51-07:00" }, "@baseType": null, "@schemaLocation": null, "@type": null }