Pause Subscription
βΈοΈ Pause an Active Subscription
Use this endpoint to temporarily pause an active subscription. This is useful when customers request to suspend billing without canceling their subscription entirely.
β οΈ Note: The subscription can be resumed later unless it has been canceled.
π§ Endpoint
POST /subscription/pause
π₯ Request Body
Field | Type | Description |
---|---|---|
track_id | string | Unique identifier of the subscription to pause |
β Example Request
{
"track_id": "a1b2c3d4-e5f6-7890-g1h2-i3j4k5l6m7n8"
}
π€ Response
β Example Success Response
{
"message": "Subscription paused successfully"
}
β Example Error Responses
Subscription Not Found
{
"detail": "Subscription not found, track_id: invalid_track_123"
}
Subscription Already Paused
{
"detail": "Subscription is already paused, track_id: a1b2c3d4-e5f6-7890-g1h2-i3j4k5l6m7n8"
}
Subscription Canceled (Can't Pause)
{
"detail": "Cannot pause a canceled subscription, track_id: a1b2c3d4-e5f6-7890-g1h2-i3j4k5l6m7n8"
}