POST /v1/subscriptions/\{id\}/pause
Service: payments · operationId: (none)
Required scopes
(no scope declared — review service config)
Path parameters
id(string) required —
Request body
{
"type": "object",
"properties": {
"reason": {
"type": [
"string",
"null"
],
"minLength": 1
}
}
}Responses
200 Subscription paused
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"status": {
"type": "string"
},
"cancel_at_period_end": {
"type": "boolean"
},
"cancel_reason": {
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"status",
"cancel_reason"
]
}404 Subscription not found
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
]
}Example
curl -X POST https://payments.platform.loop.health/v1/subscriptions/{id}/pause \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{ ... }'Related
services/payments— service overview- All endpoints — directory across services
- Auth model — how scopes are enforced