curl --request POST \
--url https://api.cloud.flexprice.io/v1/subscriptions/{id}/pause \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '{
"dry_run": true,
"metadata": {},
"pause_days": 123,
"pause_end": "<string>",
"pause_mode": "immediate",
"pause_start": "<string>",
"reason": "<string>"
}'
{
"created_at": "<string>",
"created_by": "<string>",
"environment_id": "<string>",
"id": "<string>",
"metadata": {},
"original_period_end": "<string>",
"original_period_start": "<string>",
"pause_end": "<string>",
"pause_mode": "immediate",
"pause_start": "<string>",
"pause_status": "none",
"reason": "<string>",
"resume_mode": "immediate",
"resumed_at": "<string>",
"status": "published",
"subscription_id": "<string>",
"tenant_id": "<string>",
"updated_at": "<string>",
"updated_by": "<string>"
}
Pause a subscription with the specified parameters
curl --request POST \
--url https://api.cloud.flexprice.io/v1/subscriptions/{id}/pause \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '{
"dry_run": true,
"metadata": {},
"pause_days": 123,
"pause_end": "<string>",
"pause_mode": "immediate",
"pause_start": "<string>",
"reason": "<string>"
}'
{
"created_at": "<string>",
"created_by": "<string>",
"environment_id": "<string>",
"id": "<string>",
"metadata": {},
"original_period_end": "<string>",
"original_period_start": "<string>",
"pause_end": "<string>",
"pause_mode": "immediate",
"pause_start": "<string>",
"pause_status": "none",
"reason": "<string>",
"resume_mode": "immediate",
"resumed_at": "<string>",
"status": "published",
"subscription_id": "<string>",
"tenant_id": "<string>",
"updated_at": "<string>",
"updated_by": "<string>"
}
Enter your API key in the format x-api-key <api-key>*
Subscription ID
Pause subscription request
Request object for pausing an active subscription with various pause modes and options
OK
Response object containing subscription pause information