Sign in

v1

latestOpenAPI 3.0.12026-07-225791279.7 KB
Subscription Charge

Charge Now

This endpoint immediately triggers the next scheduled recurring charge for a subscription without waiting for the next billing cycle.

Note: This endpoint charges the subscription's configured plan amount immediately and advances the billing cycle if the charge is successful.

post/subscription/api/v1/subscriptions/{id}/charge-now

Path parameters

idstring required

The subscription ID.

Request body

idempotencyKeystring required

A unique key used to prevent duplicate charge requests.

Example request

{
  "idempotencyKey": "CHARGE-NOW-001"
}

Response

Charge Subscription Now Responses

successboolean

Indicates if the request was successful.

messagestring

Descriptive message regarding the charge operation.

Example response

{
  "success": true,
  "message": "Charge completed successfully",
  "data": {
    "status": "SUCCESS",
    "transactionReference": "SUB_CHARGE_1782788822736",
    "three_ds_url": "https://3ds.gateway.com/acs/...",
    "three_ds_html": "<form ...></form>",
    "amount": 5000,
    "currency": "NGN",
    "chargeMode": "DIRECT_CHARGE",
    "message": "Charge completed successfully."
  }
}