# Returns a list of records with the specified recurring_billing_run_id

Returns a list of records with the specified recurring_billing_run_id

Endpoint: GET /billingRuns/{tenantId}/recurringBillingRun/{recurring_billing_run_id}
Version: v1-2025-04-18
Security: knox-authorizer

## Security:

  - `knox-authorizer` (unknown)
    http bearer JWT

## Path parameters:

  - `tenantId` (string, required)
    The tenant

  - `recurring_billing_run_id` (string, required)
    The recurring_billing_run_id to use to for record lookup

## Query parameters:

  - `fields` (string)
    The fields that you want to retrieve; if omitted, the entire object is returned

  - `exclusiveStartKey` (string)
    If paging, this allows you to return the next set of results

## Response 200:

  - `200` (unknown)
    The records were retrieved successfully

## Response 200 fields (application/json):

  - `Count` (integer)

  - `Items` (array)

  - `Items.business_unit_id` (string, required)

  - `Items.cancel_installment_schedules` (boolean)
    If set, reminders are sent to those who have failed installments

  - `Items.error` (string)
    The error message

  - `Items.error_stack` (string)
    The error stack

  - `Items.expiring_credit_card_reminder_options` (object, required)

  - `Items.expiring_credit_card_reminder_options.order_type_restriction` (string)
    Determines if/how to restrict the type of orders to
    Enum: "exclude", "include", "none"

  - `Items.expiring_credit_card_reminder_options.order_types` (array)

  - `Items.expiring_credit_card_reminder_options.reminders` (array)

  - `Items.expiring_credit_card_reminder_options.reminders.card_expiration_date_end` (string, required)
    Credit card expiration date

  - `Items.expiring_credit_card_reminder_options.reminders.card_expiration_date_start` (string, required)
    Credit card expiration date

  - `Items.expiring_credit_card_reminder_options.reminders.id` (number)
    A unique, unchangeable reminder id

  - `Items.expiring_credit_card_reminder_options.reminders.name` (string)
    Optional name

  - `Items.expiring_credit_card_reminder_options.reminders.notice_id` (string, required)
    The notice to send to the customer

  - `Items.id` (string, required)
    The unique, string identifier of this billing run

  - `Items.installment_schedule_cancellation_options` (object, required)

  - `Items.installment_schedule_cancellation_options.date_range_end` (string, required)
    Date used to filter out schedules to cancel

  - `Items.installment_schedule_cancellation_options.date_range_start` (string, required)
    Date used to filter out schedules to cancel

  - `Items.installment_schedule_cancellation_options.notice_id` (string)
    The notice to send to the customer

  - `Items.installment_schedule_cancellation_options.order_type_restriction` (string)
    Determines if/how to restrict the type of orders to
    Enum: "exclude", "include", "none"

  - `Items.installment_schedule_cancellation_options.order_types` (array)

  - `Items.installment_schedule_options` (object, required)

  - `Items.installment_schedule_options.card_type_restriction` (string)
    Determines if/how to restrict the type of invoices to
    Enum: "exclude", "include", "none"

  - `Items.installment_schedule_options.card_types` (array)

  - `Items.installment_schedule_options.date_range_end` (string, required)
    Date used to filter out schedules to bill

  - `Items.installment_schedule_options.date_range_start` (string, required)
    Date used to filter out schedules to bill

  - `Items.installment_schedule_options.do_not_send_standard_email_confirmations` (boolean)
    If true, the normal payment/order confirmations are not sent

  - `Items.installment_schedule_options.failure_notice_id` (string)
    The notice to send if processing is unsuccessful

  - `Items.installment_schedule_options.order_type_restriction` (string)
    Determines if/how to restrict the type of orders to
    Enum: "exclude", "include", "none"

  - `Items.installment_schedule_options.order_types` (array)

  - `Items.installment_schedule_options.payment_type_restriction` (string)
    Determines if/how to restrict the type of invoices to
    Enum: "exclude", "include", "none"

  - `Items.installment_schedule_options.payment_types` (array)

  - `Items.installment_schedule_options.success_notice_id` (string)
    The notice to send if processing is successful

  - `Items.installment_schedule_reminder_options` (object, required)

  - `Items.installment_schedule_reminder_options.order_type_restriction` (string)
    Determines if/how to restrict the type of orders to
    Enum: "exclude", "include", "none"

  - `Items.installment_schedule_reminder_options.order_types` (array)

  - `Items.installment_schedule_reminder_options.reminders` (array, required)

  - `Items.installment_schedule_reminder_options.reminders.date_range_end` (string, required)
    Date used to filter out schedules to send reminders

  - `Items.installment_schedule_reminder_options.reminders.date_range_start` (string, required)
    Date used to filter out schedules to send reminders

  - `Items.installment_schedule_reminder_options.reminders.id` (number)
    A unique, unchangeable reminder id

  - `Items.installment_schedule_reminder_options.reminders.name` (string)
    Optional name

  - `Items.installment_schedule_reminder_options.reminders.notice_id` (string, required)
    The reminder notice

  - `Items.last_refresh_date` (string)
    The last time the billing run was refreshed

  - `Items.name` (string, required)
    The name of the billing run

  - `Items.notification_email` (string)
    Te address to send notifications

  - `Items.preprocessing_date` (string)
    The date this billing run was actually processed

  - `Items.process_installment_schedules` (boolean)
    If set, installment schedules should be processed

  - `Items.recurring_billing_run_id` (string)
    The recurring billing run

  - `Items.run_date` (string)
    The date of the billing run

  - `Items.scheduled_preprocessing_date` (string)
    The date which this billing run should be preprocessed

  - `Items.scheduled_run_date` (string)
    The date the billing run is scheduled for execution

  - `Items.send_expiring_credit_card_reminders` (boolean)
    If set, reminders are sent to those whose credit cards are about to expire

  - `Items.send_installment_schedule_reminders` (boolean)
    If set, reminders are to customers who own installment schedules suspended due to payment error

  - `Items.send_statements` (boolean)
    If set, statements are generated for those who have open invoices

  - `Items.statement_options` (object, required)

  - `Items.statement_options.business_unit_ids` (array)

  - `Items.statement_options.business_unit_restriction` (string)
    Determines if/how to restrict the type of invoices to
    Enum: "exclude", "include", "none"

  - `Items.statement_options.customer_type` (string)
    The type of customer for whom statements should be generated
    Enum: "both", "contact", "organization"

  - `Items.statement_options.order_type_restriction` (string)
    Determines if/how to restrict the type of orders to
    Enum: "exclude", "include", "none"

  - `Items.statement_options.order_types` (array)

  - `Items.statement_options.statement_template_id` (string)
    The statement template to use; leave blank for default

  - `Items.statistics` (array)

  - `Items.statistics.action` (string, required)

  - `Items.statistics.error` (number)

  - `Items.statistics.excluded` (number)

  - `Items.statistics.pending` (number)

  - `Items.statistics.processing` (number)

  - `Items.statistics.successful` (number)

  - `Items.statistics.total` (number)

  - `Items.status` (string, required)
    Enum: "cancelled", "completed", "draft", "error", "preprocessing", "ready for execution", "running", "scheduled", "scheduled for execution", "timed out"

  - `Items.sys_bulk_load_at` (string)
    If this record was loaded via bulk, the timestamp when the record was processed

  - `Items.sys_bulk_load_id` (string)
    If this record was loaded via bulk, the ID of the bulk load process

  - `Items.sys_bulk_load_pk` (string)
    If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

  - `Items.sys_bulk_load_record_no` (number)
    If this record was loaded via bulk, the record number in the source file

  - `Items.sys_bulk_load_source_file` (string)
    If this record was loaded via bulk, the source file

  - `Items.sys_calculated_field_error` (string)
    The error associated with the calculated field

  - `Items.sys_calculated_field_errors` (array)

  - `Items.sys_calculated_field_errors.error` (string)

  - `Items.sys_calculated_field_errors.field` (string)

  - `Items.sys_configuration_snapshot_id` (string)
    If a snapshot was restored/applies to this record, the ID of the snapshot

  - `Items.sys_created_at` (string, required)
    The date/time that this record was created, expressed in ISO-8601 date format

  - `Items.sys_created_by_id` (string, required)
    The ID of the user that created this record

  - `Items.sys_deleted_by_id` (string)
    The ID of the user that deleted (or last tried to delete) this object

  - `Items.sys_directive` (string)
    Means for passing directive information into an object processing logic

  - `Items.sys_external_id` (string)
    The ID that a record has from an external system or data import

  - `Items.sys_has_files_in_s3` (boolean)
    If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

  - `Items.sys_last_bulk_data_operation_id` (string)
    If this record was last touched by a bulk data operation, the ID of that operation

  - `Items.sys_last_bulk_data_operation_sys_version` (string)
    If this record was last touched by a bulk data operation, the sys_version at the time of that operation

  - `Items.sys_last_modified_at` (string, required)
    The date/time that this record record was last modified, expressed in ISO-8601 date format

  - `Items.sys_last_modified_by_id` (string, required)
    The ID of the user that last modified this record

  - `Items.sys_last_security_context` (object)
    The security context of the last insert, modify, or delete performed on this item

  - `Items.sys_locked` (boolean)
    If set, this record is locked and cannot be changed via the API

  - `Items.sys_snapshot_base_version` (number)
    The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

  - `Items.sys_version` (number)
    A number representing the version of this record in the database

  - `Items.template_id` (string)
    The billing template that created this run

  - `LastEvaluatedKey` (string)

## Response 200 headers (application/json):

  - `Access-Control-Allow-Headers` (string)

  - `Access-Control-Allow-Methods` (string)

  - `Access-Control-Allow-Origin` (string)

## Response 400:

  - `400` (unknown)
    The request was not valid.

## Response 400 headers:

  - `Access-Control-Allow-Headers` (string)

  - `Access-Control-Allow-Methods` (string)

  - `Access-Control-Allow-Origin` (string)

## Response 401:

  - `401` (unknown)
    Unauthorized.

## Response 401 headers:

  - `Access-Control-Allow-Headers` (string)

  - `Access-Control-Allow-Methods` (string)

  - `Access-Control-Allow-Origin` (string)

## Response 403:

  - `403` (unknown)
    Forbidden

## Response 403 headers:

  - `Access-Control-Allow-Headers` (string)

  - `Access-Control-Allow-Methods` (string)

  - `Access-Control-Allow-Origin` (string)

## Response 404:

  - `404` (unknown)
    Unable to locate records

## Response 404 headers:

  - `Access-Control-Allow-Headers` (string)

  - `Access-Control-Allow-Methods` (string)

  - `Access-Control-Allow-Origin` (string)

## Response 429:

  - `429` (unknown)
    Limit exceeded... unable to retrieve records based on tenant limits.

## Response 429 headers:

  - `Access-Control-Allow-Headers` (string)

  - `Access-Control-Allow-Methods` (string)

  - `Access-Control-Allow-Origin` (string)

## Response 500:

  - `500` (unknown)
    General server error

## Response 500 headers:

  - `Access-Control-Allow-Headers` (string)

  - `Access-Control-Allow-Methods` (string)

  - `Access-Control-Allow-Origin` (string)