Skip to main content
POST
/
pg
/
subscriptions
/
{subscription_id}
/
simulate_payment
/
Simulate Payment
curl --request POST \
  --url https://api.example.com/pg/subscriptions/{subscription_id}/simulate_payment/ \
  --header 'Content-Type: application/json' \
  --data '
{
  "payment_status": "<string>",
  "payment_id": "<string>"
}
'
{
  "success": true,
  "message": "Payment simulation triggered successfully",
  "data": {
    "payment_id": "pay_abc123",
    "payment_status": "SUCCESS"
  }
}
Simulate a subscription payment success or failure via the payment gateway’s sandbox/UAT environment.
This endpoint is not available in production.

​
Path Parameters

​
subscription_id
string
required
The unique identifier (uid) of the subscription.

​
Request Body

​
payment_status
string
required
The desired payment outcome to simulate. Must be one of:
  • SUCCESS
  • FAILED
​
payment_id
string
Optional payment ID to simulate against a specific payment. If omitted, the gateway determines the target payment.
{
  "success": true,
  "message": "Payment simulation triggered successfully",
  "data": {
    "payment_id": "pay_abc123",
    "payment_status": "SUCCESS"
  }
}