Get Billing Cycle Specifications
get
/billingCycleSpecification
Gets the billing cycle specifications that match the specified query criteria.
Request
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.
-
billingDateShift: integer
Retrieves the billing cycle specification with a billing day of month that matches the specified billing day.Example:
billingDateShift=13
-
billingDateShift.gt: integer
Retrieves the billing cycle specification with a billing day of month that is greater than the specified billing day.Example:
billingDateShift.gt=13
-
billingDateShift.gte: integer
Retrieves the billing cycle specification with a billing day of month that is greater than or equal to the specified billing day.Example:
billingDateShift.gte=13
-
billingDateShift.lt: integer
Retrieves the billing cycle specification with a billing day of month that is less than the specified billing day.Example:
billingDateShift.lt=13
-
billingDateShift.lte: integer
Retrieves the billing cycle specification with a billing day of month that is less than or equal to the specified billing day.Example:
billingDateShift.lte=13
-
fields: string
The comma-separated list of fields to return in the response.Example:
fields=billingPeriod,validFor
-
frequency: string
Retrieves the billing cycle specification with the specified billing frequency.Example:
frequency=monthly
-
id: string
The ID of the billing cycle specification to get.Example:
id=0.0.0.1+-billinfo+105951
-
limit: integer
The maximum number of results to return.Example:
Use limit=10 to return the first 10 results only.
-
offset: integer
The number of results to offset the response by.Example:
Use offset=10 to return results 10 and higher.
-
paymentDueDateOffset: integer
Retrieves the billing cycle specification with a paymentDueDateOffset that is equal to the specified value.Example:
paymentDueDateOffset=7
-
paymentDueDateOffset.gt: integer
Retrieves the billing cycle specification with a paymentDueDateOffset that is greater than the specified value.Example:
paymentDueDateOffset.gt=7
-
paymentDueDateOffset.gte: integer
Retrieves the billing cycle specification with a paymentDueDateOffset that is greater than or equal to the specified value.Example:
paymentDueDateOffset.gte=7
-
paymentDueDateOffset.lt: integer
Retrieves the billing cycle specification with a paymentDueDateOffset that is less than the specified value.Example:
paymentDueDateOffset.lt=7
-
paymentDueDateOffset.lte: integer
Retrieves the billing cycle specification with a paymentDueDateOffset that is less than or equal to the specified value.Example:
paymentDueDateOffset.lte=7
-
validFor.endDateTime: string
Retrieves the billing cycle specification with an endDateTime that is equal to the specified date and time.Example:
validFor.endDateTime=2020-05-02T01:15:51-07:00
-
validFor.endDateTime.gt: string
Retrieves the billing cycle specification with an endDateTime that is greater than the specified date and time.Example:
validFor.endDateTime.gt=2020-05-02T01:15:51-07:00
-
validFor.endDateTime.gte: string
Retrieves the billing cycle specification with an endDateTime that is greater than or equal to the specified date and time.Example:
validFor.endDateTime.gte=2020-05-02T01:15:51-07:00
-
validFor.endDateTime.lt: string
Retrieves the billing cycle specification with an endDateTime that is less than or equal to the specified date and time.Example:
validFor.endDateTime.lt=2020-05-02T01:15:51-07:00
-
validFor.endDateTime.lte: string
Retrieves the billing cycle specification with an endDateTime that is less than or equal to the specified date and time.Example:
validFor.endDateTime.lte=2020-05-02T01:15:51-07:00
-
validFor.startDateTime: string
Retrieves the billing cycle specification with a startDateTime that is equal to the specified date and time.Example:
validFor.startDateTime=2020-05-02T01:15:51-07:00
-
validFor.startDateTime.gt: string
Retrieves the billing cycle specification with a startDateTime that is greater than the specified date and time.Example:
validFor.startDateTime.gt=2020-05-02T01:15:51-07:00
-
validFor.startDateTime.gte: string
Retrieves the billing cycle specification with a startDateTime that is greater than equal to the specified date and time.Example:
validFor.startDateTime.gte=2020-05-02T01:15:51-07:00
-
validFor.startDateTime.lt: string
Retrieves the billing cycle specification with a startDateTime that is less than or equal to the specified date and time.Example:
validFor.startDateTime.lt=2020-05-02T01:15:51-07:00
-
validFor.startDateTime.lte: string
Retrieves the billing cycle specification with a startDateTime that is less than or equal to the specified date and time.Example:
validFor.startDateTime.lte=2020-05-02T01:15:51-07:00
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json;charset=utf-8
200 Response
Success
Headers
-
X-Result-Count:
The number of items returned in the response body.
-
X-Total-Count:
The total number of items that matched the criteria.
Root Schema : schema
Type:
Show Source
array
-
Array of:
object Billing Cycle Specification
Title:
Billing Cycle Specification
A billing cycle specification, which specifies billing cycle details.
Nested 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 billing cycle specifications by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL.
The request uses query parameters to show a maximum of three results, limited to billing cycle specification objects that have a monthly billing frequency and are valid starting earlier than or equal to May 2, 2020.
curl -X GET 'http://host:port/brm/accountManagement/version/billingCycleSpecification?limit=3&frequency=monthly&validFor.startDateTime.lte=2020-05-02T01:15:51-07:00'
Example of the Response Body
The following example shows the contents of the response body in JSON format.
[ { "id": "0.0.0.1+-billinfo+105951", "href": "http://host:port/brm/accountManagement/version/billingCycleSpecification/0.0.0.1+-billinfo+105951", "billingDateShift": 13, "billingPeriod": "monthly", "chargeDateOffset": 13, "creditDateOffset": 13, "description": "active due to account", "frequency": "monthly", "mailingDateOffset": null, "name": "Child Bill Unit", "paymentDueDateOffset": null, "validFor": { "endDateTime": null, "startDateTime": "2020-05-02T01:15:51-07:00" }, "@baseType": "BillingCycleSpecification", "@schemaLocation": null, "@type": "BillingCycleSpecification" }, { "id": "0.0.0.1+-billinfo+110189", "href": "http://host:port/brm/accountManagement/version/billingCycleSpecification/0.0.0.1+-billinfo+110189", "billingDateShift": 13, "billingPeriod": "monthly", "chargeDateOffset": 13, "creditDateOffset": 13, "description": "active due to account", "frequency": "monthly", "mailingDateOffset": null, "name": "Parent Bill Unit", "paymentDueDateOffset": 0, "validFor": { "endDateTime": null, "startDateTime": "2020-05-02T01:14:13-07:00" }, "@baseType": "BillingCycleSpecification", "@schemaLocation": null, "@type": "BillingCycleSpecification" }, { "id": "0.0.0.1+-billinfo+104605", "href": "http://host:port/brm/accountManagement/version/billingCycleSpecification/0.0.0.1+-billinfo+104605", "billingDateShift": 2, "billingPeriod": "monthly", "chargeDateOffset": 2, "creditDateOffset": 2, "description": "active due to account", "frequency": "monthly", "mailingDateOffset": null, "name": "Bill Unit(1)", "paymentDueDateOffset": 0, "validFor": { "endDateTime": null, "startDateTime": "2020-05-02T00:23:54-07:00" }, "@baseType": "BillingCycleSpecification", "@schemaLocation": null, "@type": "BillingCycleSpecification" } ]