post https://prod.api.getborderless.com/deleteCustomerFromPlan
Introduction
This endpoint allows you to remove a customer from an on-demand debit or a recurring payment plan. Below you will find the required data to submit this request.
Data Requirements
Additional Header parameter:
| Parameter | Required? | Description | Type |
|---|---|---|---|
| Client-Id | No | Unique identifier of Child Account (required only for Partner). See Authentication Page to learn more. | String |
The body of the request should contain a JSON object with the the following information:
| Parameter | Required? | Description | Type |
|---|---|---|---|
| planId | Yes | The borderless™ planId denoting the plan which you want to remove the customer from. This is available in the borderless™ dashboard when you click, 'View Plan Details'. | String |
| slug | Yes/No | The borderless™ username (@handle) of the customer you would like to remove from the plan, without the “@” symbol. Read more about borderless™ @handles . | String |
| Yes/No | The email of the borderless™ customer you would like to remove from the plan. | String |
Note: slug (@handle) or email must be provided. @handle will be used if both are given.