deleteCustomerFromPlan

Overview

This mutation removes a customer from a plan.

Special Considerations

• Must have a valid recurring payment plan id.

Inputs

MutationDeleteRecurringPaymentPlanArgs

Required Data

• id: string

Returns

Promise<SuccessResult>

A promise containing the following data:

message: string

Example

Running this mutation:

mutation {
    deleteRecurringPaymentPlan(data: {
        id: "ckp7bihsu00wb0840e27faks5"
    }) {
        message
    }
}

Gives us:

{
    "data": {
        "deleteRecurringPaymentPlan": {
            "message": "Recurring Payment Plan Successfully Deleted"
        }
    }
}

Common Errors

When running this mutation some of the common errors encountered include:

• 'Sorry, we couldn't find the plan you were looking for (I-5800)'