riverty logo

Docs

Pause Subscription

Pause an active subscription.

Path

PUT /v1/clients/{clientId}/subscriptions/{subscriptionId}/pauses/{pauseId}

Request Parameters

clientId
required
integer
Your assigned `ClientId`.
subscriptionId
required
string
Id of the subscription to retrieve.
pauseId
required
string
Id of the pause.

Request Body

application/json

from
required
string
yyyy-MM-dd
The date at which the pause starts.
until
required
string
yyyy-MM-dd
The date at which the pause ends.
description
string
Max length: 200
A short description of the pause. This will be included in the invoice.

Responses

Successful RequestUnsuccessful Request, Incorrect/Missing Information

Request Example

    
        {
 "from": "2022-10-05",
 "until": "2022-12-05",
 "description": "2 month pause"
}

Response Example

    
        {
 "id": "pause-id-1",
 "from": "2022-10-05",
 "until": "2022-12-05",
 "description": "2 month pause"
}