Get Billing Cycle Specifications

get

/billingCycleSpecification

Gets the billing cycle specifications that match the specified query criteria.

Request

Query Parameters
  • The type of object to return.
    Example:
    Use @type=BillingCycleSpecification for a base object, or @type=BillingCycleSpecificationOracle for an extended object.
  • Retrieves the billing cycle specification with a billing day of month that matches the specified billing day.
    Example:
    billingDateShift=13
  • Retrieves the billing cycle specification with a billing day of month that is greater than the specified billing day.
    Example:
    billingDateShift.gt=13
  • 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
  • Retrieves the billing cycle specification with a billing day of month that is less than the specified billing day.
    Example:
    billingDateShift.lt=13
  • 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
  • The comma-separated list of fields to return in the response.
    Example:
    fields=billingPeriod,validFor
  • Retrieves the billing cycle specification with the specified billing frequency.
    Example:
    frequency=monthly
  • The ID of the billing cycle specification to get.
    Example:
    id=0.0.0.1+-billinfo+105951
  • The maximum number of results to return.
    Example:
    Use limit=10 to return the first 10 results only.
  • The number of results to offset the response by.
    Example:
    Use offset=10 to return results 10 and higher.
  • Retrieves the billing cycle specification with a paymentDueDateOffset that is equal to the specified value.
    Example:
    paymentDueDateOffset=7
  • Retrieves the billing cycle specification with a paymentDueDateOffset that is greater than the specified value.
    Example:
    paymentDueDateOffset.gt=7
  • Retrieves the billing cycle specification with a paymentDueDateOffset that is greater than or equal to the specified value.
    Example:
    paymentDueDateOffset.gte=7
  • Retrieves the billing cycle specification with a paymentDueDateOffset that is less than the specified value.
    Example:
    paymentDueDateOffset.lt=7
  • Retrieves the billing cycle specification with a paymentDueDateOffset that is less than or equal to the specified value.
    Example:
    paymentDueDateOffset.lte=7
  • 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
  • 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
  • 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
  • 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
  • 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
  • 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
  • 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
  • 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
  • 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
  • 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 Top

Response

Supported Media Types

200 Response

Success
Headers
Body ()
Root Schema : schema
Type: array
Show Source
Nested Schema : Billing Cycle Specification
Type: object
Title: Billing Cycle Specification
A billing cycle specification, which specifies billing cycle details.
Show Source
Nested Schema : TimePeriod
Type: object
A period of time.
Show Source

400 Response

Bad Request
Body ()
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

401 Response

Unauthorized
Body ()
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

403 Response

Forbidden
Body ()
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

404 Response

Not Found
Body ()
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

405 Response

Method Not allowed
Body ()
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

409 Response

Conflict
Body ()
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

500 Response

Internal Server Error
Body ()
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
Back to Top

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"
    }
]
Back to Top