POST
/
subscriptions
/
{id}
/
pause
curl --request POST \
  --url https://api.cloud.flexprice.io/v1/subscriptions/{id}/pause \
  --header 'Content-Type: application/json' \
  --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>"
}

Path Parameters

​
id
string
required

Subscription ID

Body

application/json

Pause subscription request

The body is of type object.

Response

200
application/json

OK

The response is of type object.