Billing Run Actions

Billing Run Actions

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

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

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the billing run action 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 billing run action was retrieved successfully.
400The request was not valid.
401Unauthorized.
403Forbidden.
404The billing run action could not be found.
429Limit exceeded... unable to retrieve billing run action based on tenant limits.
500General server error.
get/billingRunActions/{tenantId}/{id}
Request samples
curl -i -X GET \
  'https://membership.api.rhythmsoftware.com/billingRunActions/:tenantId/:id?fields=string&consistentRead=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "string",
  • "date": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "billing_run_id": "string",
  • "membership_id": "string",
  • "reminder_number": 0,
  • "membership_expiration_date": "string",
  • "success_notice_id": "string",
  • "failure_notice_id": "string",
  • "type": "renewal order",
  • "last_refresh_date": "2019-08-24T14:15:22Z",
  • "outcome_of_last_refresh": "no change",
  • "status": "pending",
  • "error_message": "string",
  • "order_id": "string",
  • "step_function_execution_arn": "string",
  • "error_stack": "string",
  • "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_directive": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_configuration_snapshot_id": "string"
}

Updates a billing run action with the specified ID.

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

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the billing run action to update.

Request Body schema: application/json

The updated billing run action that will be saved.

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

The unique, string identifier of this billing run action

date
required
string <date-time> (Date)

The action date

name
required
string (Name)

Name of the membership

billing_run_id
required
string (Billing Run)

The billing run ID

membership_id
required
string (Membership)

The membership ID on which this action is acting

reminder_number
number <float> (Reminder Number)

The reminder number, if this action is a reminder

membership_expiration_date
string (Membership Expiration Date)

The membership expiration date

success_notice_id
string (Success Notice)

The notice to use when the action succeeds

failure_notice_id
string (Failure Notice)

Notice to use when the action fails

type
required
string (Type)
Enum: "renewal order" "renewal notice" "auto renewal order" "renewal reminder" "auto renewal reminder" "expiring card reminder" "drop"
last_refresh_date
string <date-time> (Last Refresh Date)

The date this action was last refreshed

outcome_of_last_refresh
string (Outcome Of Last Refresh)

Describes what happened to this action the last time this billing run was refreshed

Enum: "no change" "added" "removed"
status
required
string (Status)

The status of this action

Enum: "pending" "processing" "processing order" "completed" "payment failure" "error" "excluded" "no longer eligible" "expiration date changed"
error_message
string (Error Message)

The error message

order_id
string (Order)

The relevant order, if applicable

step_function_execution_arn
string (Step Function Execution Arn)

The step function arn

error_stack
string (Error Stack)

A detailed error message with stack trace

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_directive
string (Sys Directive)

Means for passing directive information into an object processing logic

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_configuration_snapshot_id
string (Sys Configuration Snapshot)

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

Responses
200The billing run action was updated successfully.
400The billing run action supplied was not valid.
401Unauthorized.
403Forbidden.
404The billing run action could not be found.
409The billing run action could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to retrieve billing run action based on tenant limits.
500General server error.
put/billingRunActions/{tenantId}/{id}
Request samples
application/json
{
  • "id": "string",
  • "date": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "billing_run_id": "string",
  • "membership_id": "string",
  • "reminder_number": 0,
  • "membership_expiration_date": "string",
  • "success_notice_id": "string",
  • "failure_notice_id": "string",
  • "type": "renewal order",
  • "last_refresh_date": "2019-08-24T14:15:22Z",
  • "outcome_of_last_refresh": "no change",
  • "status": "pending",
  • "error_message": "string",
  • "order_id": "string",
  • "step_function_execution_arn": "string",
  • "error_stack": "string",
  • "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_directive": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_configuration_snapshot_id": "string"
}
Response samples
application/json
{
  • "id": "string",
  • "date": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "billing_run_id": "string",
  • "membership_id": "string",
  • "reminder_number": 0,
  • "membership_expiration_date": "string",
  • "success_notice_id": "string",
  • "failure_notice_id": "string",
  • "type": "renewal order",
  • "last_refresh_date": "2019-08-24T14:15:22Z",
  • "outcome_of_last_refresh": "no change",
  • "status": "pending",
  • "error_message": "string",
  • "order_id": "string",
  • "step_function_execution_arn": "string",
  • "error_stack": "string",
  • "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_directive": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_configuration_snapshot_id": "string"
}

Partially updates a billing run action with the specified ID.

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

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the billing run action 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 billing run action was patched successfully.
400The JSON patch directive you supplied was not valid.
401Unauthorized.
403Forbidden.
404The billing run action could not be found.
409The billing run action could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to retrieve billing run action based on tenant limits.
500General server error.
patch/billingRunActions/{tenantId}/{id}
Request samples
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "id": "string",
  • "date": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "billing_run_id": "string",
  • "membership_id": "string",
  • "reminder_number": 0,
  • "membership_expiration_date": "string",
  • "success_notice_id": "string",
  • "failure_notice_id": "string",
  • "type": "renewal order",
  • "last_refresh_date": "2019-08-24T14:15:22Z",
  • "outcome_of_last_refresh": "no change",
  • "status": "pending",
  • "error_message": "string",
  • "order_id": "string",
  • "step_function_execution_arn": "string",
  • "error_stack": "string",
  • "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_directive": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_configuration_snapshot_id": "string"
}

Returns a list of records with the specified billing_run_id

Returns a list of records with the specified billing_run_id

Request
Security:
path Parameters
tenantId
required
string

The tenant

billing_run_id
required
string

The 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

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/billingRunActions/{tenantId}/billingRun/{billing_run_id}
Request samples
curl -i -X GET \
  'https://membership.api.rhythmsoftware.com/billingRunActions/:tenantId/billingRun/:billing_run_id?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "Count": 0,
  • "Items": [
    ],
  • "LastEvaluatedKey": "string"
}

Returns a list of records with the specified membership_id

Returns a list of records with the specified membership_id

Request
Security:
path Parameters
tenantId
required
string

The tenant

membership_id
required
string

The membership_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/billingRunActions/{tenantId}/membership/{membership_id}
Request samples
curl -i -X GET \
  'https://membership.api.rhythmsoftware.com/billingRunActions/:tenantId/membership/:membership_id?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "Count": 0,
  • "Items": [
    ],
  • "LastEvaluatedKey": "string"
}