FastFlowPe is a payment orchestration platform. This documentation covers integration of our unified API for payments and payouts, SDKs, and workflows

curl --location 'https://api.fastflowpe.com/merchant/recurring/subscription/manage' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: YOUR_MERCHANT_X_API_KEY' \
  --data-raw '{
    "subscription_id": "YOUR_SUBSCRIPTION_UUID",
    "action": "PAUSE"
  }'

{
  "status": "success",
  "status_code": 200,
  "message": "Subscription paused successfully",
  "detail": null,
  "data": {
    "subscription_id": "4cbbd450-b326-4cac-9913-f772c57824b8",
    "previous_status": "SUCCESS",
    "current_status": "PAUSED"
  },
  "meta": null
}

{
  "status": "success",
  "status_code": 200,
  "message": "Cannot pause — subscription is currently CREATED",
  "detail": null,
  "data": {
    "subscription_id": "4cbbd450-b326-4cac-9913-f772c57824b8",
    "current_status": "CREATED"
  },
  "meta": null
}

Use the internal subscription_id returned by the subscription initialize API. Do not use merchant_ref_id or the PSP subscription ID for subscription management operations. Use the API key in the x-api-key header. Do not send it in the Authorization header.

Quick ReferenceRequired: subscription_id, actionSupported Actions: PAUSE, ACTIVATE, CANCELMethod: POST

Endpoint Details

Field	Value
Method	`POST`
Payload	`JSON`
URL	`https://api.fastflowpe.com/merchant/recurring/subscription/manage`

Request Headers

string

required

Your secret merchant API key issued by FastFlowPe.

string

required

Must be application/json.

string

required

Must be application/json.

Request Body

string

required

Internal FastFlowPe subscription UUID returned by the subscription initialize API.Do not pass merchant_ref_id or the PSP subscription ID.

string

required

Management action to perform on the subscription.Supported values:

PAUSE
ACTIVATE
CANCEL

Management Rules

Action	Required Current Status	Result
`PAUSE`	`SUCCESS`	Local subscription status becomes `HOLD`.
`ACTIVATE`	`HOLD`	Local subscription status becomes `SUCCESS`.
`CANCEL`	Any non-cancelled status	Local subscription status becomes `CANCELED`.

Always use the internal FastFlowPe subscription_id returned by the initialize API for management operations.

Pause Subscription

Use the PAUSE action to pause an active subscription. The subscription must currently have status SUCCESS.

Request Example

curl --location 'https://api.fastflowpe.com/merchant/recurring/subscription/manage' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: YOUR_MERCHANT_X_API_KEY' \
  --data-raw '{
    "subscription_id": "YOUR_SUBSCRIPTION_UUID",
    "action": "PAUSE"
  }'

Response

{
  "status": "success",
  "status_code": 200,
  "message": "Subscription paused successfully",
  "detail": null,
  "data": {
    "subscription_id": "4cbbd450-b326-4cac-9913-f772c57824b8",
    "previous_status": "SUCCESS",
    "current_status": "PAUSED"
  },
  "meta": null
}

{
  "status": "success",
  "status_code": 200,
  "message": "Cannot pause — subscription is currently CREATED",
  "detail": null,
  "data": {
    "subscription_id": "4cbbd450-b326-4cac-9913-f772c57824b8",
    "current_status": "CREATED"
  },
  "meta": null
}

The external PSP may return PAUSED, while FastFlowPe stores the local subscription status as HOLD.

Activate Subscription

Use the ACTIVATE action to reactivate a paused subscription. The subscription must currently have status HOLD.

Request Example

curl --location 'https://api.fastflowpe.com/merchant/recurring/subscription/manage' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: YOUR_MERCHANT_X_API_KEY' \
  --data-raw '{
    "subscription_id": "YOUR_SUBSCRIPTION_UUID",
    "action": "ACTIVATE"
  }'

Response

{
  "status": "success",
  "status_code": 200,
  "message": "Subscription activated successfully",
  "detail": null,
  "data": {
    "subscription_id": "4cbbd450-b326-4cac-9913-f772c57824b8",
    "previous_status": "HOLD",
    "current_status": "ACTIVE"
  },
  "meta": null
}

{
  "status": "success",
  "status_code": 200,
  "message": "Cannot activate — subscription is currently SUCCESS",
  "detail": null,
  "data": {
    "subscription_id": "4cbbd450-b326-4cac-9913-f772c57824b8",
    "current_status": "SUCCESS"
  },
  "meta": null
}

The external PSP may return ACTIVE, while FastFlowPe stores the local subscription status as SUCCESS.After activation, the next scheduled charge time is set to the next day at midnight IST.

Cancel Subscription

Use the CANCEL action to cancel an existing subscription. A subscription can be cancelled from any valid non-cancelled state.

Request Example

curl --location 'https://api.fastflowpe.com/merchant/recurring/subscription/manage' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: YOUR_MERCHANT_X_API_KEY' \
  --data-raw '{
    "subscription_id": "YOUR_SUBSCRIPTION_UUID",
    "action": "CANCEL"
  }'

Response

{
  "status": "success",
  "status_code": 200,
  "message": "Subscription canceld successfully",
  "detail": null,
  "data": {
    "subscription_id": "4cbbd450-b326-4cac-9913-f772c57824b8",
    "previous_status": "SUCCESS",
    "current_status": "CANCELLED"
  },
  "meta": null
}

The current backend response message is Subscription canceld successfully.This is only a message typo and does not affect the cancellation operation.

Response Fields

string

Indicates whether the management request was processed successfully.

integer

HTTP-style status code associated with the response.

string

Human-readable message describing the result of the requested management action.

object

Additional response details when available.This may be null.

string

Internal FastFlowPe subscription UUID.

string

Subscription status before the management action was applied.This field is returned when the action successfully changes the subscription state.

string

Current subscription status after the action or the existing status when the requested action cannot be performed.

object

Optional response metadata.This may be null.

Status Mapping

FastFlowPe normalizes PSP subscription statuses internally.

PSP Status	FastFlowPe Status
`PAUSED`	`HOLD`
`ACTIVE`	`SUCCESS`
`CANCELLED`	`CANCELED`

A response such as Cannot pause — subscription is currently CREATED or Cannot activate — subscription is currently SUCCESS means the requested action is not valid for the subscription’s current state.No state transition is performed in that case.

Check the subscription status before performing a management action when your application needs to determine which actions are currently allowed.

curl --location 'https://api.fastflowpe.com/merchant/recurring/subscription/manage' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: YOUR_MERCHANT_X_API_KEY' \
  --data-raw '{
    "subscription_id": "YOUR_SUBSCRIPTION_UUID",
    "action": "PAUSE"
  }'

{
  "status": "success",
  "status_code": 200,
  "message": "Subscription paused successfully",
  "detail": null,
  "data": {
    "subscription_id": "4cbbd450-b326-4cac-9913-f772c57824b8",
    "previous_status": "SUCCESS",
    "current_status": "PAUSED"
  },
  "meta": null
}

{
  "status": "success",
  "status_code": 200,
  "message": "Cannot pause — subscription is currently CREATED",
  "detail": null,
  "data": {
    "subscription_id": "4cbbd450-b326-4cac-9913-f772c57824b8",
    "current_status": "CREATED"
  },
  "meta": null
}

Get Started

Collections

Payment Links

Fund Transfer

Refunds

Callbacks

subscription

Manage Subscription

Endpoint Details

Request Headers

Request Body

Management Rules

Pause Subscription

Request Example

Response

Activate Subscription

Request Example

Response

Cancel Subscription

Request Example

Response

Response Fields

Status Mapping

​Endpoint Details

​Request Headers

​Request Body

​Management Rules

​Pause Subscription

​Request Example

​Response

​Activate Subscription

​Request Example

​Response

​Cancel Subscription

​Request Example

​Response

​Response Fields

​Status Mapping

Endpoint Details

Request Headers

Request Body

Management Rules

Pause Subscription

Request Example

Response

Activate Subscription

Request Example

Response

Cancel Subscription

Request Example

Response

Response Fields

Status Mapping