Get Billing Cycle Specifications
get
/billingCycleSpecification
Gets the billing cycle specifications that match the specified query criteria.
Request
Query Parameters
-
@type: string
Title:
TypeThe type of object to return. Use @type=BillingCycleSpecification for a base object, or @type=BillingCycleSpecificationOracle for an extended object.Example:BillingCycleSpecification -
billingDateShift: integer
Retrieves the billing cycle specification with a billing day of month that matches the specified billing day.Example:
13 -
billingDateShift.gt: integer
Retrieves the billing cycle specification with a billing day of month that is greater than the specified billing day.Example:
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:
13 -
billingDateShift.lt: integer
Retrieves the billing cycle specification with a billing day of month that is less than the specified billing day.Example:
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:
13 -
fields: string
The comma-separated list of fields to return in the response.Example:
billingPeriod,validFor -
frequency: string
Retrieves the billing cycle specification with the specified billing frequency.Example:
monthly -
id: string
The ID of the billing cycle specification to get.Example:
0.0.0.1+-billinfo+105951 -
limit: integer
The maximum number of results to return. For example, use limit=10 to return the first 10 results only.Example:
10 -
offset: integer
The number of results to offset the response by. For example, use offset=10 to return results 10 and higher.Example:
10 -
paymentDueDateOffset: integer
Retrieves the billing cycle specification with a paymentDueDateOffset that is equal to the specified value.Example:
7 -
paymentDueDateOffset.gt: integer
Retrieves the billing cycle specification with a paymentDueDateOffset that is greater than the specified value.Example:
7 -
paymentDueDateOffset.gte: integer
Retrieves the billing cycle specification with a paymentDueDateOffset that is greater than or equal to the specified value.Example:
7 -
paymentDueDateOffset.lt: integer
Retrieves the billing cycle specification with a paymentDueDateOffset that is less than the specified value.Example:
7 -
paymentDueDateOffset.lte: integer
Retrieves the billing cycle specification with a paymentDueDateOffset that is less than or equal to the specified value.Example:
7 -
validFor.endDateTime: string
Retrieves the billing cycle specification with an endDateTime that is equal to the specified date and time.Example:
2020-05-02T08:15:51.000Z -
validFor.endDateTime.gt: string
Retrieves the billing cycle specification with an endDateTime that is greater than the specified date and time.Example:
2020-05-02T08:15:51.000Z -
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:
2020-05-02T08:15:51.000Z -
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:
2020-05-02T08:15:51.000Z -
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:
2020-05-02T08:15:51.000Z -
validFor.startDateTime: string
Retrieves the billing cycle specification with a startDateTime that is equal to the specified date and time.Example:
2020-05-02T08:15:51.000Z -
validFor.startDateTime.gt: string
Retrieves the billing cycle specification with a startDateTime that is greater than the specified date and time.Example:
2020-05-02T08:15:51.000Z -
validFor.startDateTime.gte: string
Retrieves the billing cycle specification with a startDateTime that is greater than equal to the specified date and time.Example:
2020-05-02T08:15:51.000Z -
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:
2020-05-02T08:15:51.000Z -
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:
2020-05-02T08:15:51.000Z
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(required):
The number of items returned in the response body.
-
X-Total-Count(required):
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 SpecificationA billing cycle specification, which specifies billing cycle details.
Nested Schema : Billing Cycle Specification
Type:
objectTitle:
Billing Cycle SpecificationA billing cycle specification, which specifies billing cycle details.
Show Source
-
@baseType: string
Title:
Base TypeThe object's superclass. -
@schemaLocation: string
(uri)
Title:
Schema LocationA URI to a JSON schema file that defines additional attributes and relationships. -
@type: string
Title:
TypeThe object's subclass. -
billingDateShift: integer
Title:
Billing Date ShiftThe number of days from the start of the billing period by which to offset the billing date. -
billingPeriod: string
Title:
Billing PeriodThe length of the billing period. For example, week, month, quarter, year. -
chargeDateOffset: integer
Title:
Charge Date OffsetThe 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 OffsetThe 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 DescriptionThe billing cycle specification's description. -
frequency: string
Title:
FrequencyThe billing frequency. For example, monthly. -
href(required): string
Title:
Billing Cycle Specification HrefThe billing cycle specification's href. -
id(required): string
Title:
Billing Cycle Specification IDThe billing cycle specification's ID. -
mailingDateOffset: integer
Title:
Mailing Date OffsetThe 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 NameThe billing cycle specification's name. -
paymentDueDateOffset: integer
Title:
Payment Due Date OffsetThe number of days from the start of the billing period by which to offset the payment's due date. -
validFor: object
object
Time Period
Title:
Time PeriodA period of time. You can specify only endDateTime or both endDateTime and startDateTime.
Nested Schema : Time Period
Type:
objectTitle:
Time PeriodA period of time. You can specify only endDateTime or both endDateTime and startDateTime.
Show Source
-
@baseType: string
Title:
Base TypeThe object's superclass. -
@schemaLocation: string
(uri)
Title:
Schema LocationA URI to a JSON schema file that defines additional attributes and relationships. -
@type: string
Title:
TypeThe object's subclass. -
endDateTime: string
(date-time)
Title:
End DateTimeThe end of the time period in IETC-RFC-3339 format.Example:1985-04-12T23:20:50.520Z -
startDateTime: string
(date-time)
Title:
Start DateTimeThe start of the time period in IETC-RFC-3339 format. If you specify this, you must also specify endDateTime.Example:1985-04-12T23:20:50.520Z
400 Response
Bad Request
Root Schema : Error
Type:
objectTitle:
ErrorUsed when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error).
Show Source
-
@baseType: string
Title:
Base TypeThe object's superclass. -
@schemaLocation: string
(uri)
Title:
Schema LocationA URI to a JSON schema file that defines additional attributes and relationships. -
@type: string
Title:
TypeThe object's subclass. -
code(required): string
Title:
Error CodeAn error code. -
message: string
Title:
Error MessageDetails and corrective actions related to the error. -
reason(required): string
Title:
ReasonThe reason for the error. -
referenceError: string
(uri)
Title:
Reference ErrorA URI to documentation describing the error. -
status: string
Title:
Error StatusThe HTTP Error code extension.
401 Response
Unauthorized
Root Schema : Error
Type:
objectTitle:
ErrorUsed when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error).
Show Source
-
@baseType: string
Title:
Base TypeThe object's superclass. -
@schemaLocation: string
(uri)
Title:
Schema LocationA URI to a JSON schema file that defines additional attributes and relationships. -
@type: string
Title:
TypeThe object's subclass. -
code(required): string
Title:
Error CodeAn error code. -
message: string
Title:
Error MessageDetails and corrective actions related to the error. -
reason(required): string
Title:
ReasonThe reason for the error. -
referenceError: string
(uri)
Title:
Reference ErrorA URI to documentation describing the error. -
status: string
Title:
Error StatusThe HTTP Error code extension.
403 Response
Forbidden
Root Schema : Error
Type:
objectTitle:
ErrorUsed when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error).
Show Source
-
@baseType: string
Title:
Base TypeThe object's superclass. -
@schemaLocation: string
(uri)
Title:
Schema LocationA URI to a JSON schema file that defines additional attributes and relationships. -
@type: string
Title:
TypeThe object's subclass. -
code(required): string
Title:
Error CodeAn error code. -
message: string
Title:
Error MessageDetails and corrective actions related to the error. -
reason(required): string
Title:
ReasonThe reason for the error. -
referenceError: string
(uri)
Title:
Reference ErrorA URI to documentation describing the error. -
status: string
Title:
Error StatusThe HTTP Error code extension.
404 Response
Not Found
Root Schema : Error
Type:
objectTitle:
ErrorUsed when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error).
Show Source
-
@baseType: string
Title:
Base TypeThe object's superclass. -
@schemaLocation: string
(uri)
Title:
Schema LocationA URI to a JSON schema file that defines additional attributes and relationships. -
@type: string
Title:
TypeThe object's subclass. -
code(required): string
Title:
Error CodeAn error code. -
message: string
Title:
Error MessageDetails and corrective actions related to the error. -
reason(required): string
Title:
ReasonThe reason for the error. -
referenceError: string
(uri)
Title:
Reference ErrorA URI to documentation describing the error. -
status: string
Title:
Error StatusThe HTTP Error code extension.
405 Response
Method Not Allowed
Root Schema : Error
Type:
objectTitle:
ErrorUsed when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error).
Show Source
-
@baseType: string
Title:
Base TypeThe object's superclass. -
@schemaLocation: string
(uri)
Title:
Schema LocationA URI to a JSON schema file that defines additional attributes and relationships. -
@type: string
Title:
TypeThe object's subclass. -
code(required): string
Title:
Error CodeAn error code. -
message: string
Title:
Error MessageDetails and corrective actions related to the error. -
reason(required): string
Title:
ReasonThe reason for the error. -
referenceError: string
(uri)
Title:
Reference ErrorA URI to documentation describing the error. -
status: string
Title:
Error StatusThe HTTP Error code extension.
409 Response
Conflict
Root Schema : Error
Type:
objectTitle:
ErrorUsed when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error).
Show Source
-
@baseType: string
Title:
Base TypeThe object's superclass. -
@schemaLocation: string
(uri)
Title:
Schema LocationA URI to a JSON schema file that defines additional attributes and relationships. -
@type: string
Title:
TypeThe object's subclass. -
code(required): string
Title:
Error CodeAn error code. -
message: string
Title:
Error MessageDetails and corrective actions related to the error. -
reason(required): string
Title:
ReasonThe reason for the error. -
referenceError: string
(uri)
Title:
Reference ErrorA URI to documentation describing the error. -
status: string
Title:
Error StatusThe HTTP Error code extension.
500 Response
Internal Server Error
Root Schema : Error
Type:
objectTitle:
ErrorUsed when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error).
Show Source
-
@baseType: string
Title:
Base TypeThe object's superclass. -
@schemaLocation: string
(uri)
Title:
Schema LocationA URI to a JSON schema file that defines additional attributes and relationships. -
@type: string
Title:
TypeThe object's subclass. -
code(required): string
Title:
Error CodeAn error code. -
message: string
Title:
Error MessageDetails and corrective actions related to the error. -
reason(required): string
Title:
ReasonThe reason for the error. -
referenceError: string
(uri)
Title:
Reference ErrorA URI to documentation describing the error. -
status: string
Title:
Error StatusThe 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"
}
]