# Get a specific billing cycle

Endpoint: GET /billing-cycles/{billing_cycle_id}
Version: 1.44
Security: bearerAuth

## Path parameters:

  - `billing_cycle_id` (integer, required)
    Billing cycle identifier
    Example: 1

## Response 200 fields (application/json):

  - `id` (integer)
    Billing cycle identifier
    Example: 1

  - `name` (string, required)
    Billing cycle name

  - `startDayOfPeriod` (integer, required)
    Start day of period. If using a monthly billing cycle, then this would be the day of the month from 1 to 28. If using as weekly or daily billing cycle, then this would be the day of the week from 1 (Mon) to 7 (Sun)

  - `lengthOfPeriod` (integer)
    This is the length of the billing period and should be set to one by default which is the monthly billing cycle. A value of three would indicate that it is a quarterly billing cycle.
    Example: 1

  - `periodUnit` (string, required)
    Rental product unit
    Enum: "DAILY", "WEEKLY", "MONTHLY"

  - `maxDaysBeforeCloseable` (integer)
    The number of days before the periodEndDate that the billing period can be closed. e.g it should be defaulted to a sensible value like 15 days and prevent the closure the billing run too early (for example trying to close the 31st March 2014 bill run on 13th March 2014).
    Example: 15

  - `maxDaysAfterCloseable` (integer)
    The number of days after the periodEndDate that the billing period can be closed. e.g it should be defaulted to a sensible value like 15 days and prevent the closure the billing run too late (for example trying to close the 31st March 2014 bill run on 30th April 2014).
    Example: 15

  - `maxBackDateableUsageInDays` (integer)
    Any usage records in this bill cycle will not be billed out if older than this setting

  - `currencyCode` (string, required)
    ISO 4217 3-character currency code
    Example: "GBP"

  - `defaultInvoiceDate` (string)
    Default invoice dates
    Enum: "TODAY", "END_OF_BILL_RUN", "END_OF_BILL_RUN_PLUS_ONE"

  - `completionType` (string, required)
    How to auto-complete a bill run
    Enum: "DISABLED", "CLOSE_ONLY", "CLOSE_AND_FINALIZE"

  - `autoCloseHour` (integer)
    Hour to automatically close the bill run at

  - `autoCloseMinute` (integer)
    Minute to automatically close the bill run at

  - `autoCloseOffsetDays` (integer)
    Number of days after bill run period end date to automatically close the bill run. Must be within the maxDaysBeforeCloseable and maxDaysAfterCloseable boundaries

  - `autoCloseUserId` (integer)
    Identifier of user who will automatically close the bill run
    Example: 1

  - `billingCycleRules` (array)

  - `billingCycleRules.id` (integer)
    Billing cycle rule identifier
    Example: 1

  - `billingCycleRules.type` (string, required)
    Comparison rules
    Enum: "REVENUE", "USAGE_SUSPENSE_COUNT", "RENTAL_SUSPENSE_COUNT", "MAX_INVOICE_VALUE"

  - `billingCycleRules.thresholdPercentage` (integer)
    Percentage to compare to past period average

  - `billingCycleRules.thresholdMinValue` (integer)
    Min value to compare to past period average

  - `billingCycleRules.thresholdMaxValue` (integer)
    Min value to compare to past period average

  - `billingCycleRules.active` (boolean, required)
    Active rule

  - `billingCycleRules.comparisonPeriod` (string, required)
    Comparison periods
    Enum: "THREE_PERIODS", "SIX_PERIODS", "TWELVE_PERIODS"

  - `billingCycleRules.comparisonBasedOn` (string, required)
    Comparison rule based on
    Enum: "VALUE", "AVERAGE"

  - `billingCycleStats` (array)

  - `billingCycleStats.value` (integer, required)
    Mean value for period

  - `contractOwnerCustomerCounts` (array)

  - `contractOwnerCustomerCounts.id` (integer, required)
    Contract owner identifier
    Example: 1

  - `contractOwnerCustomerCounts.count` (integer, required)
    number of customers associated to the contract owner in the billing cycle

  - `groupName` (string)
    a name to tag this billing cycle with. This is used to group billing cycles together for bulk processing


## Response 400 fields

## Response 401 fields

## Response 404 fields

## Response 412 fields

## Response 500 fields

## Response 501 fields