createAccountPaymentSchedule
Replace an existing payment schedule with a new one that updates either the payment amount or payment day.
Arguments
Input fields for updating a payment schedule.
Returns
CreateAccountPaymentScheduleReplace an existing payment schedule with a new one that updates either the payment amount or payment day.
Possible Errors
- KT-CT-1111: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-3815: No active payment schedule found for this account.
- KT-CT-3822: Unauthorized.
- KT-CT-3923: Unauthorized.
- KT-CT-3941: Invalid data.
- KT-CT-3942: An unexpected error occurred.
- KT-CT-3947: An unexpected error occurred.
- KT-CT-3960: Invalid value for payment day.
- KT-CT-3961: Cannot update plan-associated payment schedule.
- KT-CT-3962: No new value provided to update payment schedule.
- KT-CT-7899: An internal error occurred.
Allowed Viewers
Required Permissions
Can access customer queriesCan manage payment schedules
Query Complexity
1Examples
The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.
mutation CreateAccountPaymentSchedule($input: CreateAccountPaymentScheduleInput!) {
createAccountPaymentSchedule(input: $input) {
schedule {
...PaymentScheduleTypeFragment
}
}
}
Variables
{
"input": CreateAccountPaymentScheduleInput
}
Response
{
"data": {
"createAccountPaymentSchedule": {
"schedule": PaymentScheduleType
}
}
}