Skip to main content
PATCH
Pause Subscription Collection

Authorizations

x-fngs-public-key
string
header
required
x-fngs-secret-key
string
header
required

Path Parameters

subscriptionIdOrNumber
string
required

Subscription ID or order number

Pattern: ^#?([0-9A-Za-z]{12,32}|[0-9]+)(-[0-9]+)?$

Body

application/json

PATCH /v0/subscriptions/:subscriptionIdOrNumber/pauseCollection Request body

invoicingBehavior
enum<string>
default:void

How to handle pending invoices during pause: - void: Void any pending invoices (default) - keep_as_draft: Keep pending invoices as drafts - mark_uncollectible: Mark pending invoices as uncollectible

Available options:
void,
keep_as_draft,
mark_uncollectible
resumeAt
integer<int64> | null

Optional timestamp to automatically resume the Subscription (Unix timestamp in seconds)

Required range: 0 <= x <= 9007199254740991

Response

PATCH /v0/subscriptions/:subscriptionIdOrNumber/pauseCollection Positive response

status
string
required
Allowed value: "success"
data
object
required