---
title: "Simulate subscription event"
method: POST
path: "/v1/subscriptions/{id}/simulate"
tags: ["Subscriptions"]
---

# Simulate subscription event

`POST /v1/subscriptions/{id}/simulate`

## Request

- Base URL: `https://api.kyshi.co`
- URL: `https://api.kyshi.co/v1/subscriptions/{id}/simulate`
- Auth: API key in header `x-api-key`
- TypeScript: <https://skmtc.dev/kyshi/apis/kyshi-mor-public-api/docs/v1/subscriptions/:id/simulate/post.ts> (a function with typed inputs; its response is checked against the schema)

Drives a subscription through a billing event immediately instead of waiting for the real schedule. Test mode only.

## Path parameters

- `id` string, required

## Request body

- SimulateSubscriptionFlowDto
  - `event` 'pre_charge_reminder' | 'due_charge' | 'payment_failed' | 'retry_due' | 'retry_failed_cancel' | 'manual_invoice_due' | 'manual_overdue_reminder', required
  - `redirectUrl` string

## Response `201`

Success.

- object
  - `status` boolean, required: `true` on success.
  - `message` string, required
  - `code` number, required: Mirrors the HTTP status code.
  - `data` object, required: The endpoint-specific payload.
    - `success` boolean, required
    - `subscription` PublicSubscriptionDto
      - `id` string, required
      - `status` string, required
      - `plan` PublicPlanDto
        - `id` string, required
        - `name` string, required
        - `amount` number, required
        - `currency` string, required
        - `interval` string
        - `isActive` boolean
        - `createdAt` string
      - `customer` object
      - `nextChargeAt` string
      - `createdAt` string
    - `transaction` PublicTransactionDto
      - `id` string, required
      - `amount` number, required
      - `type` 'DR' | 'CR', required
      - `status` 'PENDING' | 'SUCCESS' | 'IN_REVIEW' | 'FAILED' | 'REVERSAL' | 'COLLECTED', required
      - `reference` string, required
      - `currency` string, required
      - `channel` string
      - `processor` 'PROVIDUS_BANK' | 'STERLING' | 'VFD' | 'PAYSTACK' | 'FLUTTERWAVE' | 'CHOICE' | 'STITCH' | 'PAGA' | 'STRIPE' | 'ASSET_MFB' | 'MOMENTPAY' | 'PAWAPAY'
      - `feeBearer` 'MERCHANT' | 'CUSTOMER'
      - `meta` PublicTransactionMetaDto
        - `amount` number, required
        - `symbol` string, required
        - `currency` string, required
        - `fxRate` number, nullable
      - `feeBreakdown` PublicFeeBreakdownDto
        - `fee` number, required
        - `vat` number, required
        - `processorFee` number, required
        - `stampDuty` number, required
        - `allInclusiveKyshiFee` number, required
        - `totalFees` number, required
        - `others` object, required
      - `createdAt` string, required
      - `updatedAt` string, required
    - `message` string

## Other responses

- `400`: Missing or invalid request parameter.
- `401`: No valid API key provided.
- `403`: The API key lacks permission for this request.
- `404`: Resource not found. A 404 on an object you just created is usually a test/live mode mismatch.
- `422`: Business rule failure, such as an unsupported currency or insufficient balance.
- `500`: Something went wrong on Kyshi’s end.

## Changes

- **2026-11-03** `4aed77604588`: 1 breaking, 12 warning, 8 info
  - the response's body type changed from `object` to no type for status `201`
  - removed the optional property `backend` from the response with the `201` status
  - removed the optional property `invoice` from the response with the `201` status
  - removed the optional property `isActive` from the response with the `201` status
  - …17 more

[Operation history](https://skmtc.dev/kyshi/apis/kyshi-mor-public-api/changes/v1/subscriptions/:id/simulate/post.md)

---

[API](https://skmtc.dev/kyshi/apis/kyshi-mor-public-api.md) - [All operations](https://skmtc.dev/kyshi/apis/kyshi-mor-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/kyshi/apis/kyshi-mor-public-api/revisions/4aed77604588?raw)