Pause Subscription

Stop billing a subscription until you resume it.

POST /subscriptions/:subscription_id/pause

The pause takes effect immediately. The next renewal, or a pending retry of a declined renewal, is cancelled, and nothing is charged while the subscription is paused. An active or unpaid subscription can be paused.

Headers

Header	Type	Required	Description
`api-key`	string	Yes	Your secret API key.
`X-Profile-Id`	string	No	Not needed: the subscription's own profile is used. If you send it, it must be that profile, otherwise the request fails with `IR_37` (subscription not found).

Path Parameters

Parameter	Type	Description
`subscription_id`	string	Required. ID of the subscription.

Body Parameters

Parameter	Type	Required	Description
`pause_option`	string	No	`immediately`, the only supported option. Defaults to `immediately`.

Request Example

curl -X POST 'https://api.moonlinkpay.com/subscriptions/sub_YZQbEYEnzrjzBorzniG3/pause' \
  -H "Content-Type: application/json" \
  -H "api-key: snd_YOUR_API_KEY" \
  -d '{
  "pause_option": "immediately"
}'

curl -X POST 'https://api.moonlinkpay.com/subscriptions/sub_YZQbEYEnzrjzBorzniG3/pause' \  -H "Content-Type: application/json" \  -H "api-key: snd_YOUR_API_KEY" \  -d '{  "pause_option": "immediately"}'

Response

{
"id": "sub_YZQbEYEnzrjzBorzniG3",
"status": "paused",
"merchant_reference_id": "order_1001",
"profile_id": "pro_YOUR_PROFILE_ID",
"merchant_id": "merchant_1234567890",
"customer_id": "cus_jane_42",
"paused_at": "2026-11-03T18:01:11.829Z"
}

{"id": "sub_YZQbEYEnzrjzBorzniG3","status": "paused","merchant_reference_id": "order_1001","profile_id": "pro_YOUR_PROFILE_ID","merchant_id": "merchant_1234567890","customer_id": "cus_jane_42","paused_at": "2026-11-03T18:01:11.829Z"}

Errors

Code	When
`IR_37`	No subscription with this ID on your account, or `X-Profile-Id` names a different profile than the subscription's.
`IR_06`	The subscription is not `active` or `unpaid`. The message says which status it is in.