Membership

Returns a list of records with the specified billing_run_id

Membership (v1-2025-04-18)

The Membership API provides all the capabilities for managing your membership. Although it is most commonly used to look up the membership information for a single contact or organization, it can also be used to approve, modify, or drop members.

Like most of the other Rhythm apps, the Membership API includes endpoints for Query Definitions. These endpoints are commonly used to retrieve saved queries, which can then be executed using the Query endpoints of the System API.

Download OpenAPI description

membership-v1.json

membership-v1.yaml

Servers

Mock server

https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/

https://membership.api.rhythmsoftware.com/

Add On Products

Operations

Add On Types

Operations

Add Ons

Operations

App Reference Types

Operations

Application Groups

Operations

Application Processes

Operations

Application Status Reasons

Operations

Applications

Operations

Ballots

Operations

Billing Notices

Operations

Billing Run Actions

Operations

Execute Batch Operations

Request

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

Path

tenantIdstringrequired

The id of the tenant being accessed.

Bodyapplication/jsonrequired

The batch request

operationsArray of objects

curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/billingRunActions/{tenantId}/batch' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "operations": [
      {
        "id": null,
        "object": {},
        "operation": "create",
        "patch_directives": {
          "0": {
            "op": "add",
            "path": "string",
            "value": "string"
          }
        }
      }
    ]
  }'

Responses

Request completed successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

error_countnumber(float)(Error Count)

Number of error results

resultsArray of objects

success_countnumber(float)(Success Count)

Number of successful results

Response

application/json

{
  "error_count": 0.1,
  "results": [
    { … }
  ],
  "success_count": 0.1
}

Returns a list of records with the specified billing_run_id

Request

Returns a list of records with the specified billing_run_id

Path

tenantIdstringrequired

The tenant

billing_run_idstringrequired

The billing_run_id to use to for record lookup

Query

fieldsstring

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

exclusiveStartKeystring

If paging, this allows you to return the next set of results

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/billingRunActions/{tenantId}/billingRun/{billing_run_id}?exclusiveStartKey=string&fields=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The records were retrieved successfully

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

Countinteger

ItemsArray of objects(BillingRunAction)

LastEvaluatedKeystring

Response

application/json

{
  "Count": 0,
  "Items": [
    { … }
  ],
  "LastEvaluatedKey": "string"
}

Returns a list of records with the specified membership_id

Request

Returns a list of records with the specified membership_id

Path

tenantIdstringrequired

The tenant

membership_idstringrequired

The membership_id to use to for record lookup

Query

fieldsstring

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

exclusiveStartKeystring

If paging, this allows you to return the next set of results

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/billingRunActions/{tenantId}/membership/{membership_id}?exclusiveStartKey=string&fields=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The records were retrieved successfully

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

Countinteger

ItemsArray of objects(BillingRunAction)

LastEvaluatedKeystring

Response

application/json

{
  "Count": 0,
  "Items": [
    { … }
  ],
  "LastEvaluatedKey": "string"
}

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

Request

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

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the billing run action to return.

Query

fieldsstring

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

consistentReadstring

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

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/billingRunActions/{tenantId}/{id}?consistentRead=string&fields=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The billing run action was retrieved successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

billing_run_idstring(Billing Run)required

The billing run ID

datestring(date-time)(Date)required

The action date

error_messagestring(Error Message)

The error message

error_stackstring(Error Stack)

A detailed error message with stack trace

failure_notice_idstring(Failure Notice)

Notice to use when the action fails

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

The unique, string identifier of this billing run action

last_refresh_datestring(date-time)(Last Refresh Date)

The date this action was last refreshed

membership_expiration_datestring(Membership Expiration Date)

The membership expiration date

membership_idstring(Membership)required

The membership ID on which this action is acting

namestring(Name)required

Name of the membership

order_idstring(Order)

The relevant order, if applicable

outcome_of_last_refreshstring(Outcome Of Last Refresh)

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

Enum"added""no change""removed"

reminder_numbernumber(float)(Reminder Number)

The reminder number, if this action is a reminder

statusstring(Status)required

The status of this action

Enum"completed""error""excluded""expiration date changed""no longer eligible""payment failure""pending""processing""processing order"

step_function_execution_arnstring(Step Function Execution Arn)

The step function arn

success_notice_idstring(Success Notice)

The notice to use when the action succeeds

sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(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_record_nonumber(float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

sys_created_atstring(date-time)(Sys Created At)required

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_has_files_in_s3boolean(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_last_bulk_data_operation_idstring(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_versionstring(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_last_modified_atstring(date-time)(Sys Last Modified At)required

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

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

sys_lockedboolean(Sys Locked)

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

sys_snapshot_base_versionnumber(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_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

typestring(Type)required

Enum"auto renewal order""auto renewal reminder""drop""expiring card reminder""renewal notice""renewal order""renewal reminder"

Response

application/json

{
  "billing_run_id": "string",
  "date": "2019-08-24T14:15:22Z",
  "error_message": "string",
  "error_stack": "string",
  "failure_notice_id": "string",
  "id": "string",
  "last_refresh_date": "2019-08-24T14:15:22Z",
  "membership_expiration_date": "string",
  "membership_id": "string",
  "name": "string",
  "order_id": "string",
  "outcome_of_last_refresh": "added",
  "reminder_number": 0.1,
  "status": "completed",
  "step_function_execution_arn": "string",
  "success_notice_id": "string",
  "sys_bulk_load_at": "string",
  "sys_bulk_load_id": "string",
  "sys_bulk_load_pk": "string",
  "sys_bulk_load_record_no": 0.1,
  "sys_bulk_load_source_file": "string",
  "sys_calculated_field_error": "string",
  "sys_calculated_field_errors": [
    { … }
  ],
  "sys_configuration_snapshot_id": "string",
  "sys_created_at": "2019-08-24T14:15:22Z",
  "sys_created_by_id": "string",
  "sys_deleted_by_id": "string",
  "sys_directive": "string",
  "sys_external_id": "string",
  "sys_has_files_in_s3": true,
  "sys_last_bulk_data_operation_id": "string",
  "sys_last_bulk_data_operation_sys_version": "string",
  "sys_last_modified_at": "2019-08-24T14:15:22Z",
  "sys_last_modified_by_id": "string",
  "sys_last_security_context": {},
  "sys_locked": true,
  "sys_snapshot_base_version": 0.1,
  "sys_version": 0.1,
  "type": "auto renewal order"
}

Partially updates a billing run action with the specified ID.

Request

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

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the billing run action to patch.

Bodyapplication/jsonrequired

The patch directives conforming to RFC 6902.

Array [

opstring(Op)required

The operation

Enum"add""copy""move""remove""replace""test"

pathstring(Path)required

The JSON path

valuestring(Value)

]

curl -i -X PATCH \
  'https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/billingRunActions/{tenantId}/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "op": "add",
      "path": "string",
      "value": "string"
    }
  ]'

Responses

The billing run action was patched successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

billing_run_idstring(Billing Run)required

The billing run ID

datestring(date-time)(Date)required

The action date

error_messagestring(Error Message)

The error message

error_stackstring(Error Stack)

A detailed error message with stack trace

failure_notice_idstring(Failure Notice)

Notice to use when the action fails

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

The unique, string identifier of this billing run action

last_refresh_datestring(date-time)(Last Refresh Date)

The date this action was last refreshed

membership_expiration_datestring(Membership Expiration Date)

The membership expiration date

membership_idstring(Membership)required

The membership ID on which this action is acting

namestring(Name)required

Name of the membership

order_idstring(Order)

The relevant order, if applicable

outcome_of_last_refreshstring(Outcome Of Last Refresh)

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

Enum"added""no change""removed"

reminder_numbernumber(float)(Reminder Number)

The reminder number, if this action is a reminder

statusstring(Status)required

The status of this action

Enum"completed""error""excluded""expiration date changed""no longer eligible""payment failure""pending""processing""processing order"

step_function_execution_arnstring(Step Function Execution Arn)

The step function arn

success_notice_idstring(Success Notice)

The notice to use when the action succeeds

sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(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_record_nonumber(float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

sys_created_atstring(date-time)(Sys Created At)required

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_has_files_in_s3boolean(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_last_bulk_data_operation_idstring(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_versionstring(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_last_modified_atstring(date-time)(Sys Last Modified At)required

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

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

sys_lockedboolean(Sys Locked)

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

sys_snapshot_base_versionnumber(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_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

typestring(Type)required

Enum"auto renewal order""auto renewal reminder""drop""expiring card reminder""renewal notice""renewal order""renewal reminder"

Response

application/json

{
  "billing_run_id": "string",
  "date": "2019-08-24T14:15:22Z",
  "error_message": "string",
  "error_stack": "string",
  "failure_notice_id": "string",
  "id": "string",
  "last_refresh_date": "2019-08-24T14:15:22Z",
  "membership_expiration_date": "string",
  "membership_id": "string",
  "name": "string",
  "order_id": "string",
  "outcome_of_last_refresh": "added",
  "reminder_number": 0.1,
  "status": "completed",
  "step_function_execution_arn": "string",
  "success_notice_id": "string",
  "sys_bulk_load_at": "string",
  "sys_bulk_load_id": "string",
  "sys_bulk_load_pk": "string",
  "sys_bulk_load_record_no": 0.1,
  "sys_bulk_load_source_file": "string",
  "sys_calculated_field_error": "string",
  "sys_calculated_field_errors": [
    { … }
  ],
  "sys_configuration_snapshot_id": "string",
  "sys_created_at": "2019-08-24T14:15:22Z",
  "sys_created_by_id": "string",
  "sys_deleted_by_id": "string",
  "sys_directive": "string",
  "sys_external_id": "string",
  "sys_has_files_in_s3": true,
  "sys_last_bulk_data_operation_id": "string",
  "sys_last_bulk_data_operation_sys_version": "string",
  "sys_last_modified_at": "2019-08-24T14:15:22Z",
  "sys_last_modified_by_id": "string",
  "sys_last_security_context": {},
  "sys_locked": true,
  "sys_snapshot_base_version": 0.1,
  "sys_version": 0.1,
  "type": "auto renewal order"
}

Updates a billing run action with the specified ID.

Request

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

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the billing run action to update.

Bodyapplication/jsonrequired

The updated billing run action that will be saved.

billing_run_idstring(Billing Run)required

The billing run ID

datestring(date-time)(Date)required

The action date

error_messagestring(Error Message)

The error message

error_stackstring(Error Stack)

A detailed error message with stack trace

failure_notice_idstring(Failure Notice)

Notice to use when the action fails

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

The unique, string identifier of this billing run action

last_refresh_datestring(date-time)(Last Refresh Date)

The date this action was last refreshed

membership_expiration_datestring(Membership Expiration Date)

The membership expiration date

membership_idstring(Membership)required

The membership ID on which this action is acting

namestring(Name)required

Name of the membership

order_idstring(Order)

The relevant order, if applicable

outcome_of_last_refreshstring(Outcome Of Last Refresh)

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

Enum"added""no change""removed"

reminder_numbernumber(float)(Reminder Number)

The reminder number, if this action is a reminder

statusstring(Status)required

The status of this action

Enum"completed""error""excluded""expiration date changed""no longer eligible""payment failure""pending""processing""processing order"

step_function_execution_arnstring(Step Function Execution Arn)

The step function arn

success_notice_idstring(Success Notice)

The notice to use when the action succeeds

sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(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_record_nonumber(float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

sys_created_atstring(date-time)(Sys Created At)required

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_has_files_in_s3boolean(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_last_bulk_data_operation_idstring(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_versionstring(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_last_modified_atstring(date-time)(Sys Last Modified At)required

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

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

sys_lockedboolean(Sys Locked)

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

sys_snapshot_base_versionnumber(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_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

typestring(Type)required

Enum"auto renewal order""auto renewal reminder""drop""expiring card reminder""renewal notice""renewal order""renewal reminder"

curl -i -X PUT \
  'https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/billingRunActions/{tenantId}/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "billing_run_id": "string",
    "date": "2019-08-24T14:15:22Z",
    "error_message": "string",
    "error_stack": "string",
    "failure_notice_id": "string",
    "id": "string",
    "last_refresh_date": "2019-08-24T14:15:22Z",
    "membership_expiration_date": "string",
    "membership_id": "string",
    "name": "string",
    "order_id": "string",
    "outcome_of_last_refresh": "added",
    "reminder_number": 0.1,
    "status": "completed",
    "step_function_execution_arn": "string",
    "success_notice_id": "string",
    "sys_bulk_load_at": "string",
    "sys_bulk_load_id": "string",
    "sys_bulk_load_pk": "string",
    "sys_bulk_load_record_no": 0.1,
    "sys_bulk_load_source_file": "string",
    "sys_calculated_field_error": "string",
    "sys_calculated_field_errors": [
      {
        "error": "string",
        "field": "string"
      }
    ],
    "sys_configuration_snapshot_id": "string",
    "sys_created_at": "2019-08-24T14:15:22Z",
    "sys_created_by_id": "string",
    "sys_deleted_by_id": "string",
    "sys_directive": "string",
    "sys_external_id": "string",
    "sys_has_files_in_s3": true,
    "sys_last_bulk_data_operation_id": "string",
    "sys_last_bulk_data_operation_sys_version": "string",
    "sys_last_modified_at": "2019-08-24T14:15:22Z",
    "sys_last_modified_by_id": "string",
    "sys_last_security_context": {},
    "sys_locked": true,
    "sys_snapshot_base_version": 0.1,
    "sys_version": 0.1,
    "type": "auto renewal order"
  }'

Responses

The billing run action was updated successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

billing_run_idstring(Billing Run)required

The billing run ID

datestring(date-time)(Date)required

The action date

error_messagestring(Error Message)

The error message

error_stackstring(Error Stack)

A detailed error message with stack trace

failure_notice_idstring(Failure Notice)

Notice to use when the action fails

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

The unique, string identifier of this billing run action

last_refresh_datestring(date-time)(Last Refresh Date)

The date this action was last refreshed

membership_expiration_datestring(Membership Expiration Date)

The membership expiration date

membership_idstring(Membership)required

The membership ID on which this action is acting

namestring(Name)required

Name of the membership

order_idstring(Order)

The relevant order, if applicable

outcome_of_last_refreshstring(Outcome Of Last Refresh)

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

Enum"added""no change""removed"

reminder_numbernumber(float)(Reminder Number)

The reminder number, if this action is a reminder

statusstring(Status)required

The status of this action

Enum"completed""error""excluded""expiration date changed""no longer eligible""payment failure""pending""processing""processing order"

step_function_execution_arnstring(Step Function Execution Arn)

The step function arn

success_notice_idstring(Success Notice)

The notice to use when the action succeeds

sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(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_record_nonumber(float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

sys_created_atstring(date-time)(Sys Created At)required

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_has_files_in_s3boolean(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_last_bulk_data_operation_idstring(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_versionstring(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_last_modified_atstring(date-time)(Sys Last Modified At)required

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

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

sys_lockedboolean(Sys Locked)

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

sys_snapshot_base_versionnumber(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_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

typestring(Type)required

Enum"auto renewal order""auto renewal reminder""drop""expiring card reminder""renewal notice""renewal order""renewal reminder"

Response

application/json

{
  "billing_run_id": "string",
  "date": "2019-08-24T14:15:22Z",
  "error_message": "string",
  "error_stack": "string",
  "failure_notice_id": "string",
  "id": "string",
  "last_refresh_date": "2019-08-24T14:15:22Z",
  "membership_expiration_date": "string",
  "membership_id": "string",
  "name": "string",
  "order_id": "string",
  "outcome_of_last_refresh": "added",
  "reminder_number": 0.1,
  "status": "completed",
  "step_function_execution_arn": "string",
  "success_notice_id": "string",
  "sys_bulk_load_at": "string",
  "sys_bulk_load_id": "string",
  "sys_bulk_load_pk": "string",
  "sys_bulk_load_record_no": 0.1,
  "sys_bulk_load_source_file": "string",
  "sys_calculated_field_error": "string",
  "sys_calculated_field_errors": [
    { … }
  ],
  "sys_configuration_snapshot_id": "string",
  "sys_created_at": "2019-08-24T14:15:22Z",
  "sys_created_by_id": "string",
  "sys_deleted_by_id": "string",
  "sys_directive": "string",
  "sys_external_id": "string",
  "sys_has_files_in_s3": true,
  "sys_last_bulk_data_operation_id": "string",
  "sys_last_bulk_data_operation_sys_version": "string",
  "sys_last_modified_at": "2019-08-24T14:15:22Z",
  "sys_last_modified_by_id": "string",
  "sys_last_security_context": {},
  "sys_locked": true,
  "sys_snapshot_base_version": 0.1,
  "sys_version": 0.1,
  "type": "auto renewal order"
}

Billing Runs

Operations

Billing Templates

Operations

Change Fees

Operations

Chapter Dues Products

Operations

Chapter Types

Operations

Chapters

Operations

Coupons

Operations

Directories

Operations

Elections

Operations

Group Application Processes

Operations

Id Card Templates

Operations

Memberships

Operations

Packages

Operations

Query Definitions

Operations

Recurring Billing Runs

Operations

Section Dues Products

Operations

Section Types

Operations

Sections

Operations

Settings

Operations

Statistics

Operations

Status Reasons

Operations

Types

Operations

Membership (v1-2025-04-18)

Add On Products

Add On Types

Add Ons

App Reference Types

Application Groups

Application Processes

Application Status Reasons

Applications

Ballots

Billing Notices

Billing Run Actions

Execute Batch Operations

RequestExpand all

Responses

Was this helpful?

Returns a list of records with the specified billing_run_id

Request

Responses

Was this helpful?

Returns a list of records with the specified membership_id

Request

Responses

Was this helpful?

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

Request

Responses

Was this helpful?

Partially updates a billing run action with the specified ID.

Request

Responses

Was this helpful?

Updates a billing run action with the specified ID.

RequestExpand all

Responses

Was this helpful?

Billing Runs

Billing Templates

Change Fees

Chapter Dues Products

Chapter Types

Chapters

Coupons

Directories

Elections

Group Application Processes

Id Card Templates

Memberships

Packages

Query Definitions

Recurring Billing Runs

Section Dues Products

Section Types

Sections

Settings

Statistics

Status Reasons

Types

Request

Request