Skip to main content
POST
/
pg
/
subscriptions
/
{subscription_id}
/
recurring_payment
Trigger Recurring Payment
curl --request POST \
  --url https://api.example.com/pg/subscriptions/{subscription_id}/recurring_payment/ \
  --header 'Content-Type: application/json' \
  --data '
{
  "invoice_display_number": "<string>",
  "amount": 123,
  "transaction_id": "<string>"
}
'
{
  "success": true,
  "message": "Recurring payment triggered successfully",
  "data": {
    "subscription_id": "sub_abc123",
    "payment_id": "REC-sub_abc123-a1b2c3d4",
    "cf_payment_id": "cf_pay_789",
    "payment_amount": 500.00,
    "status": "success",
    "message": "ADHOC recurring payment initiated successfully"
  }
}
Trigger a charge on an active ADHOC subscription. The API call initiates the payment — the actual payment outcome (success, failure, or cancellation) is delivered asynchronously via webhooks, at which point the order and payment records are created in the system.
This endpoint only supports ADHOC subscriptions. The subscription must have an active mandate before a recurring payment can be triggered.

​
Path Parameters

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

​
Request Body

​
invoice_display_number
string
required
A unique display number for this recurring charge. This is mandatory for all recurring payments.
​
amount
number
Amount to charge for this recurring execution. If not provided, the subscription’s billing_amount is used. Must be less than or equal to the subscription’s billing_amount.
​
transaction_id
string
Unique transaction ID for this recurring payment (max 64 characters). If omitted, a REC-prefixed ID is auto-generated.

​
Response Fields

​
subscription_id
string
The subscription identifier.
​
payment_id
string
Auto-generated with REC- prefix if not provided.
​
payment_amount
number
The amount charged for this recurring payment.
​
status
string
Status of the API call. success means the payment was initiated — not that it has been captured.
{
  "success": true,
  "message": "Recurring payment triggered successfully",
  "data": {
    "subscription_id": "sub_abc123",
    "payment_id": "REC-sub_abc123-a1b2c3d4",
    "cf_payment_id": "cf_pay_789",
    "payment_amount": 500.00,
    "status": "success",
    "message": "ADHOC recurring payment initiated successfully"
  }
}