Subscriptions
List all pauses for a subscription
Customers
Invoices
Wallets
Entitlements
Environments
Events
Features
Payments
Integrations
Subscriptions
Tenants
Users
Subscriptions
List all pauses for a subscription
List all pauses for a subscription
GET
/
subscriptions
/
{id}
/
pauses
curl --request GET \
--url https://api.cloud.flexprice.io/v1/subscriptions/{id}/pauses[
{
"items": [
{
"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>"
}
],
"total": 123
}
]Path Parameters
Subscription ID
Response
200
application/json
OK
EnvironmentID is the environment identifier for the pause
ID is the unique identifier for the subscription pause
OriginalPeriodEnd is the end of the billing period when the pause was created
OriginalPeriodStart is the start of the billing period when the pause was created
PauseEnd is when the pause will end (null for indefinite)
Available options:
immediate, scheduled, period_end PauseStart is when the pause actually started
Available options:
none, active, scheduled, completed, cancelled Reason is the reason for pausing
Available options:
immediate, scheduled, auto ResumedAt is when the pause was actually ended (if manually resumed)
Available options:
published, deleted, archived SubscriptionID is the identifier for the subscription
curl --request GET \
--url https://api.cloud.flexprice.io/v1/subscriptions/{id}/pauses[
{
"items": [
{
"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>"
}
],
"total": 123
}
]