Skip to content
BoxBilling

Bulk pause subscriptions

POST
/v1/subscriptions/bulk_pause

Pause multiple active subscriptions in one request.

Request Body required

Section titled “Request Body required ”
BulkSubscriptionRequest
object
subscription_ids
required
Subscription Ids
Array<string>
>= 1 items

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

BulkSubscriptionResponse
object
results
required
Results
Array<object>
BulkSubscriptionResult
object
subscription_id
required
Subscription Id
string format: uuid
success
required
Success
boolean
error
Any of:
string
succeeded_count
required
Succeeded Count
integer
failed_count
required
Failed Count
integer

401

Section titled “401 ”

Unauthorized – invalid or missing API key

422

Section titled “422 ”

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object