Skip to main content
PATCH
/
v0
/
subscriptions
/
{subscriptionIdOrNumber}
/
pauseCollection
Pause Subscription Collection
curl --request PATCH \
  --url https://api.fungies.io/v0/subscriptions/{subscriptionIdOrNumber}/pauseCollection \
  --header 'Content-Type: application/json' \
  --header 'x-fngs-public-key: <api-key>' \
  --header 'x-fngs-secret-key: <api-key>' \
  --data '
{
  "invoicingBehavior": "void",
  "resumeAt": 4503599627370495
}
'
{
  "status": "<string>",
  "data": {
    "success": true
  }
}

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

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