Update a billing cycle

patch/billing-cycles/{billing_cycle_id}
SecuritybearerAuth
Request
path Parameters
billing_cycle_id
required
integer <int64> (IdParam) >= 1

Billing cycle identifier

Example: 1
Request Body schema: application/json-patch+json

A set of JSONPatch operations to be performed

Array
op
required
string

The JSON Patch operation to be performed

Enum: "add" "remove" "replace" "move" "copy" "test"
path
required
string

A JSON-Pointer

value
object

The value to be used within the operations

from
string

A string containing a JSON Pointer value

Responses
200

Success

400

Invalid Request

401

Unauthorized

403

Forbidden

404

Not Found

Request samples
application/json-patch+json
[
  • {
    • "op": "replace",
    • "path": "/name",
    • "value": "MyNewName"
    }
]
Response samples
application/json
{
  • "id": 1,
  • "name": "string",
  • "startDayOfPeriod": 1,
  • "lengthOfPeriod": 1,
  • "periodUnit": "DAILY",
  • "maxDaysBeforeCloseable": 15,
  • "maxDaysAfterCloseable": 15,
  • "maxBackDateableUsageInDays": 0,
  • "currencyCode": "GBP",
  • "defaultInvoiceDate": "TODAY",
  • "completionType": "DISABLED",
  • "autoCloseHour": 23,
  • "autoCloseMinute": 59,
  • "autoCloseOffsetDays": -15,
  • "autoCloseUserId": 1,
  • "billingCycleRules": [
    • {
      • "id": 1,
      • "type": "REVENUE",
      • "thresholdPercentage": 1,
      • "thresholdMinValue": 50000,
      • "thresholdMaxValue": 50000,
      • "active": true,
      • "comparisonPeriod": "THREE_PERIODS",
      • "comparisonBasedOn": "VALUE"
      }
    ],
  • "billingCycleStats": [
    • {
      • "type": "REVENUE",
      • "value": 0,
      • "comparisonPeriod": "THREE_PERIODS"
      }
    ],
  • "contractOwnerCustomerCounts": [
    • {
      • "id": 1,
      • "count": 0
      }
    ],
  • "groupName": "string"
}