Skip to main content
POST
Pause Subscription

Authorizations

Authorization
string
header
required

Use a Bearer token to access this API.

Path Parameters

id
string
required
Example:

"fsub_01J9XR8M3K7VZ8N2YB4WJ6T0RA"

Body

application/json

Options for pausing a subscription.

Options for pausing a subscription.

resume_at
string | null

When Flex should resume the subscription. Must be in the future. Omit to keep the subscription paused until you resume it.

Example:

"2026-06-15T14:30:00Z"

billing_cycle_anchor
enum<string> | null

Where billing restarts when Flex resumes at resume_at. Defaults to now. Requires resume_at.

Available options:
now,
unchanged
Example:

"unchanged"

proration_behavior
enum<string> | null

How the partial period is billed. Only with billing_cycle_anchor: "unchanged", where it defaults to create_prorations. Requires resume_at.

Available options:
create_prorations,
always_invoice
Example:

"always_invoice"

credit
enum<string> | null

What the pause credits for the paid time left in the period. unused_time (the default) credits it, and the resume charge is net of it. none credits nothing for the paused days, and a resume before the period ends keeps the paid days after it.

Available options:
unused_time,
none
Example:

"unused_time"

Response

An envelope wrapping a single subscription object.

An envelope wrapping a single subscription object.

subscription
object
required

The subscription payload carried by the request or response.

Example: