Skip to main content
POST
/
subscription
/
merchant
/
pause
cURL
curl --request POST \
  --url https://api.xpaycheckout.com/subscription/merchant/pause \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "subscriptionId": "sub_fooBOwYsaK50AEfK"
}
'
{
  "errorCode": "bad_request",
  "errorDescription": "Failed to read request"
}

Documentation Index

Fetch the complete documentation index at: https://docs.xpaycheckout.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Headers

​
Idempotency-Key
string

A unique key for making the request idempotent. Must match pattern: ^[a-zA-Z0-9\-_:\.]+$. See Idempotent Requests for more details.

Maximum string length: 255
Pattern: ^[a-zA-Z0-9\-_:\.]+$

Body

application/json

Pause Subscription

​
subscriptionId
string
required

Unique identifier of the subscription

Example:

"sub_fooBOwYsaK50AEfK"

Response

Pause Subscription response