---
title: "POST /api/payments/plans/{paymentPlanId}/schedules/{scheduleId}/retry"
method: POST
path: "/api/payments/plans/{paymentPlanId}/schedules/{scheduleId}/retry"
tags: ["api", "payment-plans"]
---

# POST /api/payments/plans/{paymentPlanId}/schedules/{scheduleId}/retry

`POST /api/payments/plans/{paymentPlanId}/schedules/{scheduleId}/retry`

## Request

- Base URL: `https://vivenu.com`
- URL: `https://vivenu.com/api/payments/plans/{paymentPlanId}/schedules/{scheduleId}/retry`
- Auth: one of:
  - HTTP bearer
  - API key in header `Authorization`

Retry a Payment Plan Schedule

## Path parameters

- `paymentPlanId` string, required: The ID of the payment plan
- `scheduleId` string, required: The ID of the payment plan schedule

## Response `200`

OK

- POSTPaymentPlansRetryAPaymentPlanSchedule200Response
  - `_id` string, required: The ID of the payment plan
  - `sellerId` string, required: The ID of the seller
  - `status` 'DRAFT' | 'ACTIVE' | 'INCOMPLETE' | 'CANCELED' | 'COMPLETED', required: The status of the payment plan
  - `customerId` string, required: The ID of the customer
  - `currency` 'EUR' | 'USD' | 'GBP' | 'AUD' | 'CHF' | 'THB' | 'ILS' | 'COP' | 'MXN' | 'DKK' | 'NOK' | 'SEK' | 'QAR' | 'CAD' | 'ISK' | 'GTQ' | 'INR' | 'DOP' | 'SGD' | 'PLN' | 'SAR' | 'TTD' | 'ZAR' | 'KYD' | 'HKD' | 'CZK' | 'KRW' | 'JPY' | 'NZD' | 'AED' | 'MAD' | 'TWD' | 'BRL' | 'BWP' | 'NAD' | 'KES' | 'SCR' | 'TRY' | 'SZL' | 'LSL' | 'TZS' | 'UGX' | 'ZMW' | 'ZWG' | 'GHS' | 'NGN' | 'SLE' | 'LRD' | 'XOF' | 'XAF' | 'GEL' | 'IDR' | 'ARS' | 'CRC' | 'HUF' | 'EGP' | 'MYR' | 'VND' | 'PHP' | 'MWK', required: The currency of the payment plan
  - `customerPaymentMethodId` string, required: The ID of the customer payment method
  - `paymentStrategyId` string, required: The ID of the payment strategy
  - `paymentOptionId` string, required: The ID of the payment option
  - `history` object[]: The history of the payment plan
    - `type` 'paymentPlan.created' | 'paymentPlan.status_changed' | 'paymentPlan.cycle_applied' | 'paymentPlan.payment_method_changed' | 'paymentPlan.item_changed' | 'paymentPlan.down_payment_charged' | 'paymentPlan.down_payment_failed' | 'paymentPlan.canceled' | 'paymentPlan.payoff_charged' | 'paymentPlan.payoff_failed' | 'paymentPlan.schedule_retried' | 'paymentPlan.schedule_retry_failed' | 'paymentPlan.dispute_created' | 'paymentPlan.dispute_countered' | 'paymentPlan.dispute_won' | 'paymentPlan.chargeback_created', required: The type of the history entry
    - `date` string, date-time, required: The date of the history entry
    - `data` object: The data of the history entry
    - `userId` string: The ID of the user who made the history entry
  - `schedules` object[], required: The schedules of the payment plan
    - `_id` string, required: The ID of the payment schedule
    - `due` string, date-time, required: The date when the payment is due
    - `status` 'SCHEDULED' | 'PENDING' | 'SUCCEEDED' | 'FAILED' | 'REFUNDED', required: The status of the payment schedule
    - `total` number, float, required: The total amount of the payment schedule
    - `paymentRequestId` string, required: The ID of the payment request
    - `paymentId` string: The ID of the payment
    - `attempts` object[]: The payment schedule attempts
      - `_id` string, required: The ID of the payment schedule attempt
      - `date` string, date-time, required: The date of the payment schedule attempt
      - `status` 'SCHEDULED' | 'PENDING' | 'SUCCEEDED' | 'FAILED' | 'REFUNDED', required: The status of the payment schedule attempt
      - `paymentRequestId` string, required: The Payment Request ID of the payment schedule attempt
      - `paymentMethodId` string, required: The Payment Method ID of the payment schedule attempt
    - `nextAttempt` string, date-time: The date of the next payment schedule attempt
  - `checkoutId` string, required: The ID of the checkout
  - `salesChannelId` string, required: The ID of the sales channel
  - `secret` string, required: The secret of the payment plan
  - `canceledAt` string, date-time: The date when the payment plan was canceled
  - `createdAt` string, date-time, required: The date when the payment plan was created
  - `updatedAt` string, date-time, required: The date when the payment plan was updated

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `404`: Not Found

## Changes

- **2026-08-11** `bafd26ef1fbe`: 1 warning
  - added the new `MWK` enum value to the `currency` response property for the response status `200`

[Operation history](https://skmtc.dev/vivenu/apis/vivenu-api/changes/api/payments/plans/:paymentPlanId/schedules/:scheduleId/retry/post.md)

---

[API](https://skmtc.dev/vivenu/apis/vivenu-api.md) - [All operations](https://skmtc.dev/vivenu/apis/vivenu-api/llms.txt) - [OpenAPI document](https://skmtc.dev/vivenu/apis/vivenu-api/revisions/af2684113d08?raw)