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

# Simulate subscription

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

Trigger subscription billing events in test mode.

## Path parameters

- `id` string, required

## Request body

- SimulateSubscriptionRequest
  - `event` 'pre_charge_reminder' | 'due_charge' | 'payment_failed' | 'retry_due' | 'retry_failed_cancel' | 'manual_invoice_due' | 'manual_overdue_reminder', required
  - `redirectUrl` string — Redirect URL used when the simulation creates a payment or recovery checkout flow.

## Response `201`

Subscription event simulated.

- SubscriptionSimulationResponse
  - `status` boolean
  - `simulated` 'pre_charge_reminder' | 'due_charge' | 'payment_failed' | 'retry_due' | 'retry_failed_cancel' | 'manual_invoice_due' | 'manual_overdue_reminder'
  - `backend` 'temporal' | 'inline' — Present for due_charge and retry_due simulations.
  - `workflowId` string — Present when the simulation starts a Temporal workflow.
  - `subscriptionId` string
  - `invoice` object
  - `paymentUrl` string
  - `reminder` string
  - `subscriptionStatus` string
  - `isActive` boolean
  - `retryCount` number
  - `result` unknown

---

[API](https://skmtc.net/kyshi/apis/kyshi-mor-public-api.md) · [All operations](https://skmtc.net/kyshi/apis/kyshi-mor-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/kyshi/kyshi-mor-public-api/versions/3c46fabe8df7/schema)