Sign in

v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB
Recurring scheduled charges

Update scheduled charge

Updates a scheduled charge by account ID and recurring scheduled charge ID. It's only possible to update charges with current status PENDING. An update to a charge that is scheduled for a particular cycle must be done before that cycle's closing date. This endpoint generates a Recurring scheduled charge updated event.

NOTE: This endpoint requires an account token — an access token encoded with an account ID. Tokens can expire quickly, which can result in a 401 Unauthorized message.

patch/v1/accounts/{account_id}/scheduled-charges/{recurring_scheduled_charge_id}

Path parameters

account_idinteger required
Example:6912345

Account ID

recurring_scheduled_charge_idinteger required
Example:100123

ID of the recurring scheduled charge

Request body

installment_amountnumber double

installment_amount is the full amount of an installment before any discount is applied.

processing_codestring

Processing code for the debit transaction.

If split_transaction is false (the default), each installment payment is recorded as one debit transaction equal to the installment amount minus the discount, and processing_code is the processing code for that transaction.

If split_transaction is true, each installment payment is recorded as two transactions: a debit transaction for the installment amount and a credit transaction for the discount. In this case, processing_code is the processsing code for the debit transaction, and second_processing_code is the processing code for the credit transaction.

descriptionstring

A description of the scheduled charge that's linked to the account. Use counter to specify where the cycle count should be placed. Example: "Annuity {counter}" generates "Annuity 2/12" for the second of twelve annutities. If counter is not present, the counter is placed at the end of the description. If no description is configured, the description of the transaction type is used, and the counter is not shown.

secondary_processing_codestring

Used to create the transaction for secondary_installment_amount. Normally, you should use a processing code for a credit transaction.

secondary_installment_amountnumber

If split_transaction is true, then secondary_installment_amount is the discount (installment_amount * discount_percentage) that is subtracted from installment_amount to calculate the amount that the customer owes on the installment. If split_transaction is false, then secondary_installment_amount is 0, and the actual amount that the customer owes goes in installment_amount." In the first case, two transactions are generated — a debit transaction for installment_amount and a credit transaction for secondary_installment_amount. (This is the expected behavior. However, it assumes that processing_code and second_processing_code are set to values for debit and credit transactions, respectively.) In the second case, only one transaction is generated (the one for installment_amount).

secondary_descriptionstring

Optional secondary description of the scheduled charge. Use counter to specify where the cycle count should be placed. Example: "Annuity {counter}" generates "Annuity 2/12" for the second of twelve annutities.

Example request

{
  "installment_amount": 10.9,
  "processing_code": "99066",
  "description": "Link between an account and a recurring charge plan",
  "secondary_processing_code": "99067",
  "secondary_installment_amount": 5.45,
  "secondary_description": "Link between an account and a recurring charge plan"
}

Response

OK - Indicates that the server accepted the request and updated the scheduled charge.

recurring_scheduled_charge_idinteger

ID of recurring scheduled charge

org_idstring

Organization ID

account_idinteger

Account ID

created_atstring date-time

Datetime program calendar strategy was created. Format = YYYY-MM-DDTHH:MM:SS:MM.

updated_atstring date-time

Datetime program calendar strategy was updated. Format = YYYY-MM-DDTHH:MM:SS:MM

statement_idinteger

Statement ID

recurring_charge_link_idinteger

ID of recurring charge link

status'PENDING' | 'PROCESSING' | 'CANCELLED' | 'SETTLED' | 'PROCESSED'

PENDING: Charge is scheduled and waiting for the cycle to close. PROCESSING: Cycle closing process has started and is awaiting completion. CANCELLED: Charge canceled due to link cancellation. SETTLED: Amount is zero and/or minimum_spend_to_charge has not been reached. PROCESSED: Charge was posted on the statement."

creation_cidstring

CID for the creation event

cancellation_cidstring

CID for the cancellation event

processing_codestring

Processing code for the debit transaction.

If split_transaction is false (the default), each installment payment is recorded as one debit transaction equal to the installment amount minus the discount, and processing_code is the processing code for that transaction.

If split_transaction is true, each installment payment is recorded as two transactions: a debit transaction for the installment amount and a credit transaction for the discount. In this case, processing_code is the processsing code for the debit transaction, and second_processing_code is the processing code for the credit transaction.

installment_amountnumber double

installment_amount is the full amount of an installment before any discount is applied.

descriptionstring

A description of the scheduled charge that's linked to the account. Use counter to specify where the cycle count should be placed. Example: "Annuity {counter}" generates "Annuity 2/12" for the second of twelve annutities. If counter is not present, the counter is placed at the end of the description. If no description is configured, the description of the transaction type is used, and the counter is not shown.

authorization_idinteger

Authorization ID of the debit transaction for installment_amount.

authorization_tracking_idstring

Tracking ID for the debit transaction for installment_amount.

secondary_processing_codestring

Used to create the transaction for secondary_installment_amount. Normally, you should use a processing code for a credit transaction.

secondary_installment_amountnumber

If split_transaction is true, then secondary_installment_amount is the discount (installment_amount * discount_percentage) that is subtracted from installment_amount to calculate the amount that the customer owes on the installment. If split_transaction is false, then secondary_installment_amount is 0, and the actual amount that the customer owes goes in installment_amount." In the first case, two transactions are generated — a debit transaction for installment_amount and a credit transaction for secondary_installment_amount. (This is the expected behavior. However, it assumes that processing_code and second_processing_code are set to values for debit and credit transactions, respectively.) In the second case, only one transaction is generated (the one for installment_amount).

secondary_descriptionstring

Optional secondary description of the scheduled charge. Use counter to specify where the cycle count should be placed. Example: "Annuity {counter}" generates "Annuity 2/12" for the second of twelve annutities.

secondary_authorization_idinteger

Authorization ID of the credit transaction for secondary_installment_amount.

secondary_authorization_tracking_idstring

Tracking ID for the credit transaction for secondary_installment_amount.

cycleinteger

Charge cycle number. For example, if the plan has 6 installments, and this charge is for the third installment, then the charge cycle number is 3.

Example response

{
  "recurring_scheduled_charge_id": 880077,
  "org_id": "TN-cc8f8b89-233a-4582-9f36-63ee85278d6d",
  "account_id": 6912345,
  "created_at": "2024-09-12T16:46:16.43663522",
  "updated_at": "2024-09-12T16:46:16.43663522",
  "statement_id": 9497889,
  "recurring_charge_link_id": 98660282,
  "status": "PENDING",
  "creation_cid": "3ea22692-a209-11eb-89a2-f73e179dcbc2",
  "cancellation_cid": "3ea22692-a209-11eb-89a2-f73e179dcbc2",
  "processing_code": "99066",
  "installment_amount": 10.9,
  "description": "Link between an account and a recurring charge plan",
  "authorization_id": 1099901,
  "authorization_tracking_id": "3ea22692-a209-11eb-89a2-f73e179dcbc2",
  "secondary_processing_code": "99067",
  "secondary_installment_amount": 5.45,
  "secondary_description": "Link between an account and a recurring charge plan",
  "secondary_authorization_id": 1099901,
  "secondary_authorization_tracking_id": "3ea22692-a209-11eb-89a2-f73e179dcbc2",
  "cycle": 4
}