Subscriptions
Pause Subscription
Immediately pauses a subscription by setting status to paused and clearing any grace period end. Billing retries and scheduled billing for this subscription stop until it is resumed.
Authorization
bearerAuth AuthorizationBearer <token>
Use your secret API key as the bearer token
In: header
Path Parameters
id*string
Stable subscription ID (sub_*) that belongs to your merchant.
Match
^sub_[A-Za-z0-9]{22}$Response Body
application/json
application/json
application/json
curl -X POST "https://api.getlumen.dev/v1/subscriptions/sub_5n3K2gVDt1xQ78kPq4LzYh/pause"{
"success": true,
"status": "paused"
}Empty
{
"error": "Subscription not found or access denied"
}{
"error": "Failed to pause subscription"
}