Payment Scheduler Update (PATCH)

Activate or deactivate a payment scheduler. You can set the status of a payment scheduler to Active, Canceled, Draft, or Inactive.

Special Access Rules 

You need the Payment Ops permission set to use this API.

Resource 

1/commerce/payments/payment-schedulers/{billingBatchSchedulerId}

Resource Example 

1https://{yourInstance}.salesforce.com/services/data/v68.0/commerce/payments/payment-schedulers/5BSxx0000004TwGGAU

Available Version 

64.0

HTTP Methods 

PATCH

Path Parameter for POST 

NameTypeDescriptionRequired or OptionalAvailable Version
billingBatch​SchedulerIdStringID of the payment scheduler record.Required64.0

Request Body for PATCH 

JSON Example

JSON Example

1{
2  "status": "Active"
3}

Properties

NameTypeDescriptionRequired or OptionalAvailable Version
statusStringStatus that must be set to activate or deactivate a payment scheduler.Required64.0

Valid values are:

  • Active
  • Canceled
  • Draft
  • Inactive

Response Body for PATCH 

Payments Scheduler Update