Schema2020-08-27object

subscriptions_resource_pause_collection

The Pause Collection settings determine how we will pause collection for this subscription and for how long the subscription should be paused.

Source: openapi/spec3.json
Commit: d70de345383d
Active snapshot: da69df7e6e11

SubscriptionsResourcePauseCollection

object

The Pause Collection settings determine how we will pause collection for this subscription and for how long the subscription should be paused.

behavior string

required

The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.

Allowed: "keep_as_draft""mark_uncollectible""void"

resumes_at integer (unix-time)

optionalnullable

The time after which the subscription will resume collecting payments.

Root JSON Schema

{"description":"The Pause Collection settings determine how we will pause collection for this subscription and for how long the subscription\nshould be paused.","properties":{"behavior":{"description":"The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.","enum":["keep_as_draft","mark_uncollectible","void"],"type":"string"},"resumes_at":{"description":"The time after which the subscription will resume collecting payments.","format":"unix-time","nullable":true,"type":"integer"}},"required":["behavior"],"title":"SubscriptionsResourcePauseCollection","type":"object","x-expandableFields":[]}