Pause A Customer Subscription

Pauses an active subscription for the authenticated customer and applies appropriate order handling.

Overview

• Method: POST
• Path: /brand/subscriptions/pause-subscription/<id>
• Tags: brand

Parameters

id (path)

• Type: string
• Required: Yes
• Description: id parameter

Request Body

No request body required.

Responses

200

Successful response

Content Type: application/json

{
  "message": "string",
  "subscription": "string",
  "state": "string",
  "pausedAt": "string"
}

400

Bad Request

Content Type: application/json

{
  "message": "string",
  "currentOrder": "string",
  "displayId": 123,
  "status": "string",
  "seqNum": 123
}

401

Unauthorized

404

Not Found

500

Internal Server Error

Example Usage

curl -X POST \
  https://api.pillexa.com/brand/subscriptions/pause-subscription/<id> \
  -H "Content-Type: application/json" \