Pause Subscription API

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"
      }
    ]
  }
}

POST

api

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

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.

Show child attributes

gateway_response.version

string

The version of the gateway.

Example:

"1"

gateway_response.type

string

Type of response (e.g., INFO for informative response).

Example:

"INFO"

gateway_response.message

string

Message response from the gateway.

Example:

"Subscription Updated."

gateway_response.code

string

Response code from the gateway.

Example:

"INFO3000"

subscription_details

object

Details of the subscription.

Show child attributes

subscription_details.id

string

The Subscription ID.

Example:

"664dc930-88bd-4696-8807-5e0f1fedba0b"

subscription_details.type

string

The type of subscription (e.g., CYCLE or Unlimited).

Example:

"CYCLE"

subscription_details.max_cycle_count

integer

The maximum number of billing cycles.

Example:

10

subscription_details.status

string

The updated status of the subscription.

Example:

"PAUSED"

subscription_details.completed_payment_cycle

integer

The number of completed payment cycles.

Example:

1

subscription_details.last_payment_status

string

The status of the last payment made under this subscription.

Example:

"SUCCESSFUL"

subscription_details.next_payment_date

string<date-time>

The next payment date of the subscription.

Example:

"2024-11-28T01:31:29.154Z"

subscription_details.next_payment_cycle

integer

The next payment cycle number.

Example:

2

subscription_details.subscription_plan_details

object

Details of the subscription plan.

Show child attributes

subscription_details.subscription_plan_details.name

string

The name of the subscription plan.

Example:

"Three weeks plan"

subscription_details.subscription_plan_details.desc

string

The description of the subscription plan.

Example:

"Billed every two days"

subscription_details.subscription_plan_details.billing_cycle_type

string

The type of billing cycle (e.g., DAYS or MONTHS).

Example:

"DAYS"

subscription_details.subscription_plan_details.billing_cycle_interval

integer

The interval between billing cycles.

Example:

2

subscription_details.subscription_plan_details.amount

integer

The payment amount for the subscription plan.

Example:

1000

subscription_details.subscription_plan_details.ccy

string

The currency of the subscription transaction.

Example:

"JPY"

subscription_details.subscription_plan_details.trial_period_duration

string

The duration of the trial period (if applicable).

Example:

""

subscription_details.subscription_plan_details.trial_period_duration_type

string

The type of trial period duration (e.g., DAYS or MONTHS).

Example:

"NONE"

subscription_details.subscription_plan_details.plan_discount_percentage

number

The discount percentage for the subscription plan.

Example:

10

subscription_details.subscription_plan_details.plan_discount_duration

integer

The duration of the discount in billing cycles.

Example:

2

subscription_details.subscription_transaction_details

object[]

A list of transaction details for the subscription.

Show child attributes

subscription_details.subscription_transaction_details.id

string

The Transaction ID of this subscription transaction.

Example:

"359f39bd-673a-47b3-b9ec-cbd6cd313b8e"

subscription_details.subscription_transaction_details.ref

integer

The reference of the subscription transaction.

Example:

74860

subscription_details.subscription_transaction_details.cycle

integer

The payment cycle number of the transaction.

Example:

1

subscription_details.subscription_transaction_details.status

string

The status of the subscription transaction.

Example:

"SUCCESSFUL"

subscription_details.subscription_transaction_details.transaction_date

string<date-time>

The date of the subscription transaction.

Example:

"2024-11-26T01:31:29.000Z"

subscription_details.subscription_transaction_details.amount

integer

The payment amount of the transaction.

Example:

900

subscription_details.subscription_transaction_details.ccy

string

The currency of the transaction.

Example:

"JPY"

subscription_details.subscription_transaction_details.event

string

The event type for the transaction (e.g., CAPTURED).

Example:

"CAPTURED"

Cancel Subscription API Resume Subscription API

⌘I

Getting Started

API Endpoints

Error and Response

Webhook

Key Points

Pause a Subscription

Subscription Status

Required Parameters

Flow diagram

Api Parameters

Authorizations

Path Parameters

Response

Getting Started

API Endpoints

Error and Response

Webhook

​Key Points

​Pause a Subscription

​Subscription Status

​Required Parameters

​Flow diagram

​Api Parameters

Authorizations

Path Parameters

Response

Key Points

Pause a Subscription

Subscription Status

Required Parameters

Flow diagram

Api Parameters