Skip to main content
POST
/
api
/
v1
/
server-to-server-interface
/
subscription
/
{subscription_id}
/
pause
Pause Subscription
curl --request POST \
  --url https://api-dev.paymentoptions.com/api/v1/server-to-server-interface/subscription/{subscription_id}/pause \
  --header 'Authorization: <api-key>' \
  --header 'x-api-key: <api-key>'
{
  "success": true,
  "status_code": 200,
  "is_live": false,
  "gateway_response": {
    "version": "1",
    "type": "INFO",
    "message": "Subscription Updated.",
    "code": "INFO3000"
  },
  "subscription_details": {
    "id": "664dc930-88bd-4696-8807-5e0f1fedba0b",
    "type": "CYCLE",
    "max_cycle_count": 10,
    "status": "PAUSED",
    "completed_payment_cycle": 1,
    "last_payment_status": "SUCCESSFUL",
    "next_payment_date": "2024-11-28T01:31:29.154Z",
    "next_payment_cycle": 2,
    "subscription_plan_details": {
      "name": "Three weeks plan",
      "desc": "Billed every two days",
      "billing_cycle_type": "DAYS",
      "billing_cycle_interval": 2,
      "amount": 1000,
      "ccy": "JPY",
      "trial_period_duration": "",
      "trial_period_duration_type": "NONE",
      "plan_discount_percentage": 10,
      "plan_discount_duration": 2
    },
    "subscription_transaction_details": [
      {
        "id": "359f39bd-673a-47b3-b9ec-cbd6cd313b8e",
        "ref": 74860,
        "cycle": 1,
        "status": "SUCCESSFUL",
        "transaction_date": "2024-11-26T01:31:29.000Z",
        "amount": 900,
        "ccy": "JPY",
        "event": "CAPTURED"
      }
    ]
  }
}

​
Key Points

​
Pause a Subscription

  • Merchants can use this API to pause a subscription, which stops future billing for the customer until the subscription is resumed.
  • During the paused period, the subscription remains active but will not trigger billing or provide services unless resumed.

​
Subscription Status

  • The subscription will change to paused status in the system.
  • No billing cycles will be processed while the subscription is paused, but the merchant retains control over when to resume the subscription.

​
Required Parameters

  • Subscription ID: The unique identifier of the subscription to be paused.

​
Flow diagram

Flow diagram image

​
Api Parameters

Authorizations

​
Authorization
string
header
required

API Key for Authorization. Format: 'Basic YOUR_API_KEY_HERE'

​
x-api-key
string
header
required

API Key specific to x-api-key.

Path Parameters

​
subscription_id
string
required

The Subscription ID of the subscription. Example: 664dc930-88bd-4696-8807-5e0f1fedba0b. The unique Subscription ID of the subscription.

Maximum string length: 36

Response

200 - application/json

A successful response indicating the subscription has been paused.

​
success
boolean

Indicates whether the operation was successful.

Example:

true

​
status_code
integer

The HTTP status code of the response.

Example:

200

​
is_live
boolean

Indicates if the transaction is live or a test transaction.

Example:

false

​
gateway_response
object

Response details from the gateway.

​
subscription_details
object

Details of the subscription.