Draft a subscription

Get subscription draft with pre calculated data.

PATH:

/v1/clients/{clientId}/subscriptions/draft

PATH PARAMETERS:

clientId

required

integer

Your assigned ClientId.

REQUEST BODY SCHEMA:

subscriptionProductId

string <= 100 characters

Id of the subscription product.

activeFrom

string date

The date of when the customer is enrolled on.

RESPONSES:

200 Success.

RESPONSE SCHEMA:

currencyCode

string

The currency code.

periods

array of periods

no description in swagger file

Array () [

start

string date

Date of when the period starts.

end

string date

Date of when the period ends.

grossAmount

number decimal

Gross amount of the period.

]

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

post

/v1/clients/{clientId}/subscriptions/draft

Request samples

            {
                 "subscriptionProductId": "string", 
 "activeFrom": "string" 

}

Response samples

200400401403404500

              {
                   "currencyCode": "string", 
"periods": [...{
                              "start": "string",
                            
                              "end": "string",
                            
                              "grossAmount": 1.00
                            
}
]
}

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

            