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

Partially Update a Billing Cycle Specification

patch

/billingCycleSpecification/{id}

The operation updates a BillingCycleSpecification entity partially, allowing you to modify specific attributes without replacing the entire resource.

Request

Path Parameters
Query Parameters
Supported Media Types
Request Body - application/json-patch-query+json ()
Root Schema : schema
Type: array
The JSONPatch Operations document as defined by RFC 6902.
Show Source
Nested Schema : JsonPatch
Type: object
The JSONPatch document as defined by RFC 6902.
Show Source
Request Body - application/json-patch+json ()
Root Schema : schema
Type: array
The JSONPatch Operations document as defined by RFC 6902.
Show Source
Nested Schema : JsonPatch
Type: object
The JSONPatch document as defined by RFC 6902.
Show Source
Request Body - application/merge-patch+json ()
Root Schema : schema
Match All
The detailed description of when to initiate a billing cycle and the various sub steps of a billing cycle.
Show Source
  • Entity_MVO
    THe Base entity schema for use in TMForum Open-APIs Property.
  • type
    The detailed description of when to initiate a billing cycle and the various sub steps of a billing cycle.
Nested Schema : Entity_MVO
Type: object
THe Base entity schema for use in TMForum Open-APIs Property.
Match All
THe Base entity schema for use in TMForum Open-APIs Property.
Show Source
  • Extensible
    The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
Nested Schema : Extensible
Type: object
The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
Show Source
Nested Schema : type
Type: object
The detailed description of when to initiate a billing cycle and the various sub steps of a billing cycle.
Show Source
  • The offset of a billing/settlement date. The offset is expressed as number of days with regard to the start of the billing/settlement period.
  • The billing time period. It can be recurring, for example, week, month, quarter of year, year.
  • Frequency of the billing cycle (monthly for instance)
  • The short descriptive name
  • The offset of a date through which charges previously received by the billing system will appear on the bill. The offset is expressed as number of days with regard to the start of the BillingPeriod.
Request Body - application/json ()
Root Schema : schema
Match One Schema
Show Source
Nested Schema : BillingCycleSpecificationOracle_MVO
Match All
A detailed description of when to initiate a billing cycle and the various sub steps of a billing cycle.
Show Source
Nested Schema : schema
Match All
The detailed description of when to initiate a billing cycle and the various sub steps of a billing cycle.
Show Source
  • Entity_MVO
    THe Base entity schema for use in TMForum Open-APIs Property.
  • type
    The detailed description of when to initiate a billing cycle and the various sub steps of a billing cycle.
Nested Schema : Entity_MVO
Type: object
THe Base entity schema for use in TMForum Open-APIs Property.
Match All
THe Base entity schema for use in TMForum Open-APIs Property.
Show Source
  • Extensible
    The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
Nested Schema : Extensible
Type: object
The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
Show Source
Nested Schema : BillingCycleSpecificationOracle_MVO-allOf[1]
Type: object
A detailed description of when to initiate a billing cycle and the various sub steps of a billing cycle.
Show Source
  • The offset of a date through which credits previously received by the billing system will appear on the bill. The offset is expressed as number of days with regard to the start of the BillingPeriod.
  • The explanation regarding this billing cycle specification.
  • Allowed Values: [ "monthly", "bi-monthly", "quarterly", "semiyearly", "yearly" ]
    The frequency of the billing cycle, such as monthly.
  • A short descriptive name
  • The offset of a payment due date. The offset is expressed as number of days with regard to the start of the BillingPeriod.
  • TimePeriod
    The period of time, either as a deadline (endDateTime only) a startDateTime only, or both.
Nested Schema : TimePeriod
Type: object
The period of time, either as a deadline (endDateTime only) a startDateTime only, or both.
Show Source
Nested Schema : type
Type: object
The detailed description of when to initiate a billing cycle and the various sub steps of a billing cycle.
Show Source
  • The offset of a billing/settlement date. The offset is expressed as number of days with regard to the start of the billing/settlement period.
  • The billing time period. It can be recurring, for example, week, month, quarter of year, year.
  • Frequency of the billing cycle (monthly for instance)
  • The short descriptive name
  • The offset of a date through which charges previously received by the billing system will appear on the bill. The offset is expressed as number of days with regard to the start of the BillingPeriod.
Examples

Back to Top

Response

200 Response

The operation was successful.
Body ()
Root Schema : schema
Match One Schema
Show Source
Nested Schema : BillingCycleSpecification
Match All
The detailed description of when to initiate a billing cycle and the various sub steps of a billing cycle.
Show Source
Nested Schema : BillingCycleSpecificationOracle
Match All
A detailed description of when to initiate a billing cycle and the various sub steps of a billing cycle.
Show Source
Nested Schema : Entity
Type: object
The Base entity schema for use in TMForum Open-APIs Property.
Match All
The Base entity schema for use in TMForum Open-APIs Property.
The Base entity schema for use in TMForum Open-APIs Property.
Show Source
  • Extensible
    The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
  • Addressable
    The base schema for adressable entities.
Nested Schema : Extensible
Type: object
The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
Show Source
Nested Schema : Addressable
Type: object
The base schema for adressable entities.
Show Source
Nested Schema : BillingCycleSpecification-allOf[1]
Type: object
The detailed description of when to initiate a billing cycle and the various sub steps of a billing cycle.
Show Source
Nested Schema : BillingCycleSpecificationOracle-allOf[1]
Type: object
A detailed description of when to initiate a billing cycle and the various sub steps of a billing cycle.
Show Source
Examples

202 Response

The request has been accepted for processing, but the processing is not yet complete.

400 Response

The server received a bad request.
Body ()
Root Schema : Error
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Match All
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
  • Extensible
    The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
  • Error-allOf[1]
Nested Schema : Extensible
Type: object
The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
Show Source
Nested Schema : Error-allOf[1]
Type: object
Show Source

401 Response

The request was not authorized.
Body ()
Root Schema : Error
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Match All
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
  • Extensible
    The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
  • Error-allOf[1]
Nested Schema : Extensible
Type: object
The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
Show Source
Nested Schema : Error-allOf[1]
Type: object
Show Source

403 Response

The request was forbidden.
Body ()
Root Schema : Error
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Match All
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
  • Extensible
    The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
  • Error-allOf[1]
Nested Schema : Extensible
Type: object
The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
Show Source
Nested Schema : Error-allOf[1]
Type: object
Show Source

404 Response

The requested resource cannot be found.
Body ()
Root Schema : Error
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Match All
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
  • Extensible
    The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
  • Error-allOf[1]
Nested Schema : Extensible
Type: object
The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
Show Source
Nested Schema : Error-allOf[1]
Type: object
Show Source

405 Response

The method is not allowed.
Body ()
Root Schema : Error
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Match All
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
  • Extensible
    The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
  • Error-allOf[1]
Nested Schema : Extensible
Type: object
The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
Show Source
Nested Schema : Error-allOf[1]
Type: object
Show Source

409 Response

The request could not be processed due to a conflict with the existing state of the resource.
Body ()
Root Schema : Error
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Match All
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
  • Extensible
    The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
  • Error-allOf[1]
Nested Schema : Extensible
Type: object
The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
Show Source
Nested Schema : Error-allOf[1]
Type: object
Show Source

500 Response

THe system has encountered an internal server error.
Body ()
Root Schema : Error
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Match All
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
  • Extensible
    The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
  • Error-allOf[1]
Nested Schema : Extensible
Type: object
The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
Show Source
Nested Schema : Error-allOf[1]
Type: object
Show Source

501 Response

The request was not implemented.
Body ()
Root Schema : Error
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Match All
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
  • Extensible
    The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
  • Error-allOf[1]
Nested Schema : Extensible
Type: object
The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
Show Source
Nested Schema : Error-allOf[1]
Type: object
Show Source

503 Response

The service is unavailable.
Body ()
Root Schema : Error
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Match All
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
  • Extensible
    The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
  • Error-allOf[1]
Nested Schema : Extensible
Type: object
The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
Show Source
Nested Schema : Error-allOf[1]
Type: object
Show Source
Back to Top

Examples

Example 1: Update the Description

The following example shows how to update a BillingCycleSpecification description by submitting a PATCH request on the REST resource using cURL. For more information about cURL, see Use cURL. 

curl -X PATCH 'http://host:port/brm/accountManagement/version/billingCycleSpecification/id'

Example of Response Body

The following is an example of the response body in JSON format.

{
 "description": "patching description"
}

Example 2: Update the billingDateShift

The following example shows how to update a BillingCycleSpecification billingDateShift by submitting a PATCH request on the REST resource using cURL. For more information about cURL, see Use cURL. 

curl -X PATCH 'http://host:port/brm/accountManagement/version/billingCycleSpecification/id'

Example of Response Body

The following is an example of the response body in JSON format.

{
    "billingDateShift": 14
}

Example 3: Update the paymentDueDateOffset

The following example shows how to update a BillingCycleSpecification paymentDueDateOffset by submitting a PATCH request on the REST resource using cURL. For more information about cURL, see Use cURL. 

curl -X PATCH 'http://host:port/brm/accountManagement/version/billingCycleSpecification/id'

Example of Response Body

The following is an example of the response body in JSON format.

{
    "paymentDueDateOffset": 22
}

Example 4: Update the Frequency

The following example shows how to update a BillingCycleSpecification frequency by submitting a PATCH request on the REST resource using cURL. For more information about cURL, see Use cURL. 

curl -X PATCH 'http://host:port/brm/accountManagement/version/billingCycleSpecification/id'

Example of Response Body

The following is an example of the response body in JSON format.

{
    "frequency": "monthly"
}
Back to Top