Get all subscription pauses

Get all subscription pauses filtered by subscription id.

PATH:

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

PATH PARAMETERS:

clientId

required

integer

Your assigned ClientId.

subscriptionId

required

string

Id of the subscription to retrieve.

RESPONSES:

200 OK.

RESPONSE SCHEMA:

Array () [

id	string Id of the subscription pause.
from	string date The date at which the pause starts.
until	string date The date at which the pause ends.
description	string A short description of the pause. This will be included in the invoice.

]

400 Bad request.

RESPONSE SCHEMA:

undefined

401 Missing or invalid "Authorization" header.

RESPONSE SCHEMA:

type	string The type of error that is carried within this response. The value of this type is an URI that can be dereferenced for a human-readable explanation of the error type.
category	string Enum: BUSINESS_ERROR TECHNICAL_ERROR Category of the error, used primarily to determine whether the same request should be retried or not. Possible values: `BUSINESS_ERROR` - A business error occured. This request should not be retried without modification `TECHNICAL_ERROR` - A temporary, technical error occurred. the request should be retried after a back-off period.
title	string A short, human-readable summary of the problem.
message	string A short, human-readable summary of the problem. Identical to `title`.

403 Lacking permissions.

RESPONSE SCHEMA:

type	string The type of error that is carried within this response. The value of this type is an URI that can be dereferenced for a human-readable explanation of the error type.
category	string Enum: BUSINESS_ERROR TECHNICAL_ERROR Category of the error, used primarily to determine whether the same request should be retried or not. Possible values: `BUSINESS_ERROR` - A business error occured. This request should not be retried without modification `TECHNICAL_ERROR` - A temporary, technical error occurred. the request should be retried after a back-off period.
title	string A short, human-readable summary of the problem.
message	string A short, human-readable summary of the problem. Identical to `title`.

404 Resource not found.

RESPONSE SCHEMA:

type	string The type of error that is carried within this response. The value of this type is an URI that can be dereferenced for a human-readable explanation of the error type.
category	string Enum: BUSINESS_ERROR TECHNICAL_ERROR Category of the error, used primarily to determine whether the same request should be retried or not. Possible values: `BUSINESS_ERROR` - A business error occured. This request should not be retried without modification `TECHNICAL_ERROR` - A temporary, technical error occurred. the request should be retried after a back-off period.
title	string A short, human-readable summary of the problem.
message	string A short, human-readable summary of the problem. Identical to `title`.

500 Unexpected internal server error.

RESPONSE SCHEMA:

type	string The type of error that is carried within this response. The value of this type is an URI that can be dereferenced for a human-readable explanation of the error type.
category	string Enum: BUSINESS_ERROR TECHNICAL_ERROR Category of the error, used primarily to determine whether the same request should be retried or not. Possible values: `BUSINESS_ERROR` - A business error occured. This request should not be retried without modification `TECHNICAL_ERROR` - A temporary, technical error occurred. the request should be retried after a back-off period.
title	string A short, human-readable summary of the problem.
message	string A short, human-readable summary of the problem. Identical to `title`.

Path

get

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

Response samples

200400401403404500

              [
                  ...
                    {
                            "id": "string",
                          
                            "from": "string",
                          
                            "until": "string",
                          
                            "description": "string"
                          
}

                  ]

undefined

              {
                  
                      "type": "string",
                    
                      "category": "string",
                    
                      "title": "string",
                    
                      "message": "string"
                    
}

              {
                  
                      "type": "string",
                    
                      "category": "string",
                    
                      "title": "string",
                    
                      "message": "string"
                    
}

              {
                  
                      "type": "string",
                    
                      "category": "string",
                    
                      "title": "string",
                    
                      "message": "string"
                    
}

              {
                  
                      "type": "string",
                    
                      "category": "string",
                    
                      "title": "string",
                    
                      "message": "string"
                    
}