POST
/
subscriptions
/
{id}
/
resume
curl --request POST \
  --url https://api.cloud.flexprice.io/v1/subscriptions/{id}/resume \
  --header 'Content-Type: application/json' \
  --data '{
  "dry_run": true,
  "metadata": {},
  "resume_mode": "immediate"
}'
{
  "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
Resume subscription request
​
resume_mode
enum<string>
required
Available options:
immediate,
scheduled,
auto
​
dry_run
boolean
​
metadata
object

Response

200
application/json
OK
​
created_at
string
​
created_by
string
​
environment_id
string

EnvironmentID is the environment identifier for the pause

​
id
string

ID is the unique identifier for the subscription pause

​
metadata
object
​
original_period_end
string

OriginalPeriodEnd is the end of the billing period when the pause was created

​
original_period_start
string

OriginalPeriodStart is the start of the billing period when the pause was created

​
pause_end
string

PauseEnd is when the pause will end (null for indefinite)

​
pause_mode
enum<string>
Available options:
immediate,
scheduled,
period_end
​
pause_start
string

PauseStart is when the pause actually started

​
pause_status
enum<string>
Available options:
none,
active,
scheduled,
completed,
cancelled
​
reason
string

Reason is the reason for pausing

​
resume_mode
enum<string>
Available options:
immediate,
scheduled,
auto
​
resumed_at
string

ResumedAt is when the pause was actually ended (if manually resumed)

​
status
enum<string>
Available options:
published,
deleted,
archived
​
subscription_id
string

SubscriptionID is the identifier for the subscription

​
tenant_id
string
​
updated_at
string
​
updated_by
string