Recurring Billing Runs

Recurring Billing Runs

Creates a new recurring billing run record that does not already exist.

This method will auto-generate an ID and create a new recurring billing run. If an ID is specified for the recurring billing run, an error will be thrown.

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

Request Body schema: application/json

The recurring billing run that you would like to be saved.

id
required
string (ID) /^[\w|-]+$/

The unique, string identifier of this recurring billing run

name
required
string (Name)

The name of the recurring billing run

pre_processing_lead_time
required
number <float> (Pre Processing Lead Time) >= 1

The number of business days before the run date that the system should pre process the run and allow it to be reviewed

template_id
required
string (Template)

The template to use

is_active
boolean (Is Active)

Whether this process is active

schedule
required
string (Schedule)

The schedule which defines how often the batch should be created

human_readable_schedule
string (Human Readable Schedule)

A human readable schedule for display

sys_next_processing_date
string <date-time> (Sys Next Processing Date)

Internal system field, do not modify

last_run_date
string <date-time> (Last Run Date)

The last time this process was run

last_error
string (Last Error)

The last error on this process

last_error_date
string <date-time> (Last Error Date)

The last time this process encountered an error

errors_since_last_run
number <float> (Errors Since Last Run)

The number of errors that have occurred since the last successful run of this schedule

sys_deleted_by_id
string (Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_version
number <float> (Sys Version)

A number representing the version of this record in the database

sys_created_at
required
string <date-time> (Sys Created At)

The date/time that this record was created, expressed in ISO-8601 date format

sys_last_modified_at
required
string <date-time> (Sys Last Modified At)

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_created_by_id
required
string (Sys Created By)

The ID of the user that created this record

sys_last_modified_by_id
required
string (Sys Last Modified By)

The ID of the user that last modified this record

sys_external_id
string (Sys External)

The ID that a record has from an external system or data import

sys_locked
boolean (Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_bulk_load_pk
string (Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_at
string (Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_id
string (Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_record_no
number <float> (Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_file
string (Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_last_bulk_data_operation_id
string (Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_version
string (Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_directive
string (Sys Directive)

Means for passing directive information into an object processing logic

sys_calculated_field_error
string (Sys Calculated Field Error)

The error associated with the calculated field

sys_snapshot_base_version
number <float> (Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_has_files_in_s3
boolean (Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_configuration_snapshot_id
string (Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_last_security_context
object (Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

Array of objects
Responses
200The recurring billing run was saved successfully.
400The recurring billing run you supplied was invalid.
401Unauthorized.
403Forbidden.
404The resource could not be found
409The recurring billing run could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to add recurring billing run based on tenant limits.
500General server error.
post/recurringBillingRuns/{tenantId}
Request samples
    1 more
    Python
application/json
{
  • "id": "string",
  • "name": "string",
  • "pre_processing_lead_time": 1,
  • "template_id": "string",
  • "is_active": true,
  • "schedule": "string",
  • "human_readable_schedule": "string",
  • "sys_next_processing_date": "2019-08-24T14:15:22Z",
  • "last_run_date": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "last_error_date": "2019-08-24T14:15:22Z",
  • "errors_since_last_run": 0,
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_directive": "string",
  • "sys_calculated_field_error": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_has_files_in_s3": true,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { },
  • "sys_calculated_field_errors": [
    ]
}
Response samples
application/json
{
  • "id": "string",
  • "name": "string",
  • "pre_processing_lead_time": 1,
  • "template_id": "string",
  • "is_active": true,
  • "schedule": "string",
  • "human_readable_schedule": "string",
  • "sys_next_processing_date": "2019-08-24T14:15:22Z",
  • "last_run_date": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "last_error_date": "2019-08-24T14:15:22Z",
  • "errors_since_last_run": 0,
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_directive": "string",
  • "sys_calculated_field_error": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_has_files_in_s3": true,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { },
  • "sys_calculated_field_errors": [
    ]
}

Gets all of the recurring billing runs in the system.

This method will scan all recurring billing runs and and return them to the caller.

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

query Parameters
fields
string

The fields that you want to retrieve; if omitted, the entire object is returned.

exclusiveStartKey
string

The start key, if you're making a subsequent request

Responses
200The recurring billing runswere retrieved successfully.
400The request was invalid.
401Unauthorized.
403Forbidden.
404The resource could not be found
429Limit exceeded... unable to add contact role based on tenant limits.
500General server error.
get/recurringBillingRuns/{tenantId}
Request samples
curl -i -X GET \
  'https://membership.api.756794052567.rhythmsoftware.com/recurringBillingRuns/:tenantId?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
[
  • {
    }
]

Returns a recurring billing run from the system by its ID.

This method will look up a recurring billing run by the specified ID and return it back.

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the recurring billing run to return.

query Parameters
fields
string

The fields that you want to retrieve; if omitted, the entire object is returned.

consistentRead
string

Indicates the API should force a consistent read on the data source.

Responses
200The recurring billing run was retrieved successfully.
400The request was not valid.
401Unauthorized.
403Forbidden.
404The recurring billing run could not be found.
429Limit exceeded... unable to retrieve recurring billing run based on tenant limits.
500General server error.
get/recurringBillingRuns/{tenantId}/{id}
Request samples
curl -i -X GET \
  'https://membership.api.756794052567.rhythmsoftware.com/recurringBillingRuns/:tenantId/:id?fields=string&consistentRead=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "string",
  • "name": "string",
  • "pre_processing_lead_time": 1,
  • "template_id": "string",
  • "is_active": true,
  • "schedule": "string",
  • "human_readable_schedule": "string",
  • "sys_next_processing_date": "2019-08-24T14:15:22Z",
  • "last_run_date": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "last_error_date": "2019-08-24T14:15:22Z",
  • "errors_since_last_run": 0,
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_directive": "string",
  • "sys_calculated_field_error": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_has_files_in_s3": true,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { },
  • "sys_calculated_field_errors": [
    ]
}

Updates a recurring billing run with the specified ID.

This method will update an existing recurring billing run with the specified ID.

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the recurring billing run to update.

Request Body schema: application/json

The updated recurring billing run that will be saved.

id
required
string (ID) /^[\w|-]+$/

The unique, string identifier of this recurring billing run

name
required
string (Name)

The name of the recurring billing run

pre_processing_lead_time
required
number <float> (Pre Processing Lead Time) >= 1

The number of business days before the run date that the system should pre process the run and allow it to be reviewed

template_id
required
string (Template)

The template to use

is_active
boolean (Is Active)

Whether this process is active

schedule
required
string (Schedule)

The schedule which defines how often the batch should be created

human_readable_schedule
string (Human Readable Schedule)

A human readable schedule for display

sys_next_processing_date
string <date-time> (Sys Next Processing Date)

Internal system field, do not modify

last_run_date
string <date-time> (Last Run Date)

The last time this process was run

last_error
string (Last Error)

The last error on this process

last_error_date
string <date-time> (Last Error Date)

The last time this process encountered an error

errors_since_last_run
number <float> (Errors Since Last Run)

The number of errors that have occurred since the last successful run of this schedule

sys_deleted_by_id
string (Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_version
number <float> (Sys Version)

A number representing the version of this record in the database

sys_created_at
required
string <date-time> (Sys Created At)

The date/time that this record was created, expressed in ISO-8601 date format

sys_last_modified_at
required
string <date-time> (Sys Last Modified At)

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_created_by_id
required
string (Sys Created By)

The ID of the user that created this record

sys_last_modified_by_id
required
string (Sys Last Modified By)

The ID of the user that last modified this record

sys_external_id
string (Sys External)

The ID that a record has from an external system or data import

sys_locked
boolean (Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_bulk_load_pk
string (Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_at
string (Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_id
string (Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_record_no
number <float> (Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_file
string (Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_last_bulk_data_operation_id
string (Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_version
string (Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_directive
string (Sys Directive)

Means for passing directive information into an object processing logic

sys_calculated_field_error
string (Sys Calculated Field Error)

The error associated with the calculated field

sys_snapshot_base_version
number <float> (Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_has_files_in_s3
boolean (Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_configuration_snapshot_id
string (Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_last_security_context
object (Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

Array of objects
Responses
200The recurring billing run was updated successfully.
400The recurring billing run supplied was not valid.
401Unauthorized.
403Forbidden.
404The recurring billing run could not be found.
409The recurring billing run could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to retrieve recurring billing run based on tenant limits.
500General server error.
put/recurringBillingRuns/{tenantId}/{id}
Request samples
    1 more
    Python
application/json
{
  • "id": "string",
  • "name": "string",
  • "pre_processing_lead_time": 1,
  • "template_id": "string",
  • "is_active": true,
  • "schedule": "string",
  • "human_readable_schedule": "string",
  • "sys_next_processing_date": "2019-08-24T14:15:22Z",
  • "last_run_date": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "last_error_date": "2019-08-24T14:15:22Z",
  • "errors_since_last_run": 0,
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_directive": "string",
  • "sys_calculated_field_error": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_has_files_in_s3": true,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { },
  • "sys_calculated_field_errors": [
    ]
}
Response samples
application/json
{
  • "id": "string",
  • "name": "string",
  • "pre_processing_lead_time": 1,
  • "template_id": "string",
  • "is_active": true,
  • "schedule": "string",
  • "human_readable_schedule": "string",
  • "sys_next_processing_date": "2019-08-24T14:15:22Z",
  • "last_run_date": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "last_error_date": "2019-08-24T14:15:22Z",
  • "errors_since_last_run": 0,
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_directive": "string",
  • "sys_calculated_field_error": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_has_files_in_s3": true,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { },
  • "sys_calculated_field_errors": [
    ]
}

Partially updates a recurring billing run with the specified ID.

This method will patch an existing recurring billing run with the specified ID, using the HTTP PATCH specification.

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the recurring billing run to patch.

Request Body schema: application/json

The patch directives conforming to RFC 6902.

Array
op
required
string (Op)

The operation

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

The JSON path

value
string (Value)

The updated value

Responses
200The recurring billing run was patched successfully.
400The JSON patch directive you supplied was not valid.
401Unauthorized.
403Forbidden.
404The recurring billing run could not be found.
409The recurring billing run could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to retrieve recurring billing run based on tenant limits.
500General server error.
patch/recurringBillingRuns/{tenantId}/{id}
Request samples
    1 more
    Python
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "id": "string",
  • "name": "string",
  • "pre_processing_lead_time": 1,
  • "template_id": "string",
  • "is_active": true,
  • "schedule": "string",
  • "human_readable_schedule": "string",
  • "sys_next_processing_date": "2019-08-24T14:15:22Z",
  • "last_run_date": "2019-08-24T14:15:22Z",
  • "last_error": "string",
  • "last_error_date": "2019-08-24T14:15:22Z",
  • "errors_since_last_run": 0,
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_directive": "string",
  • "sys_calculated_field_error": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_has_files_in_s3": true,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { },
  • "sys_calculated_field_errors": [
    ]
}

Returns a recurring billing run from the system by its ID.

This method will delete a recurring billing run with the specified ID.

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the recurring billing run to delete.

Responses
200The recurring billing run was deleted successfully.
400The request was not valid.
401Unauthorized.
403Forbidden.
404The recurring billing run could not be found.
409The recurring billing run could not be deleted because other objects refers to/depends on this one.
429Limit exceeded... unable to delete recurring billing run based on tenant limits.
500General server error.
delete/recurringBillingRuns/{tenantId}/{id}
Request samples
curl -i -X DELETE \
  https://membership.api.756794052567.rhythmsoftware.com/recurringBillingRuns/:tenantId/:id \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
"string"

Returns a list of records with the specified template_id

Returns a list of records with the specified template_id

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

template_id
required
string

The template_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

Responses
200The records were retrieved successfully
400The request was not valid.
401Unauthorized.
403Forbidden
404Unable to locate records
429Limit exceeded... unable to retrieve records based on tenant limits.
500General server error
get/recurringBillingRuns/{tenantId}/template/{template_id}
Request samples
curl -i -X GET \
  'https://membership.api.756794052567.rhythmsoftware.com/recurringBillingRuns/:tenantId/template/:template_id?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "Count": 0,
  • "Items": [
    ],
  • "LastEvaluatedKey": "string"
}

Execute Batch Operations

TAllows you to perform up to 100 parallel patch/delete operations

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

Request Body schema: application/json

The batch request

Array of objects
Responses
200Request completed successfully.
400The request was not valid.
401Unauthorized.
403Forbidden.
404The recurring billing run could not be found.
429Limit exceeded... unable to retrieve recurring billing run based on tenant limits.
500General server error.
post/recurringBillingRuns/{tenantId}/batch
Request samples
    1 more
    Python
application/json
{
  • "operations": [
    ]
}
Response samples
application/json
{
  • "success_count": 0,
  • "error_count": 0,
  • "results": [
    ]
}