Get all subscriptions

Get all subscriptions filtered by customer.

PATH:

/v1/clients/{clientId}/subscriptions

PATH PARAMETERS:

clientId

required

integer

Your assigned ClientId.

RESPONSES:

200 Success.

RESPONSE SCHEMA:

Array () [

string

Id of the subscription.

status

string

Enum: NOT_STARTED ACTIVE CLOSING CLOSED PAUSED

no description in swagger file

createdAt

string date-time

When this subscription was created.

updatedAt

string date-time

When this subscription was updated.

product

object of product

Details of the subscription product.

string

Id of the subscription product.

description

string

Description of the subscription product.

_links

array of _links

List of hypermedia links related to this resource.

Array () [

method

string

HTTP Method.

href

string

Link to the resource.

rel

string

The relation between the current and target resource.

]

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

Response samples

200400401403404500

              [
                  ...
                    { "product": X, 
"_links": [...{
                                    "method": "string",
                                  
                                    "href": "string",
                                  
                                    "rel": "string",
                                  
                                    "target": X
                                  
}
]
}

                  ]

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" 
}
                

            