1. REST Services Manager API for Billing and Revenue Management
  2. Tasks
  3. Account Management
  4. Billing Cycle Specifications

Get a Billing Cycle Specification by ID

get

/billingCycleSpecification/{id}

Gets the specified billing cycle specification.

Request

Path Parameters
Query Parameters
  • The type of object to return.
    Example:
    BillingCycleSpecification
  • The comma-separated list of fields to return in the response.
    Example:
    chargeDateOffset,frequency

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Success
Body ()
Root Schema : Billing Cycle Specification
Type: object
Title: Billing Cycle Specification
A billing cycle specification, which specifies billing cycle details.
Show Source
Nested Schema : Time Period
Type: object
Title: Time Period
A period of time. You can specify only endDateTime or both endDateTime and startDateTime.
Show Source

400 Response

Bad Request
Body ()
Root Schema : Error
Type: object
Title: Error
Used when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error).
Show Source

401 Response

Unauthorized
Body ()
Root Schema : Error
Type: object
Title: Error
Used when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error).
Show Source

403 Response

Forbidden
Body ()
Root Schema : Error
Type: object
Title: Error
Used when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error).
Show Source

404 Response

Not Found
Body ()
Root Schema : Error
Type: object
Title: Error
Used when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error).
Show Source

405 Response

Method Not Allowed
Body ()
Root Schema : Error
Type: object
Title: Error
Used when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error).
Show Source

409 Response

Conflict
Body ()
Root Schema : Error
Type: object
Title: Error
Used when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error).
Show Source

500 Response

Internal Server Error
Body ()
Root Schema : Error
Type: object
Title: Error
Used when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error).
Show Source
Back to Top

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