Docs

Draft a Subscription

Get subscription draft with pre calculated data.

Path

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

Request Parameters

clientId

required

integer

Your assigned `ClientId`.

Request Body

application/json

subscriptionProductId

required

string

Max length: 100

Id of the subscription product.

activeFrom

required

string

yyyy-MM-dd

The date of when the customer is enrolled on.

Responses

type

required

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

required

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`.

type

required

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

required

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`.

required

array

A list of validation failures for the request.

Successful Request

Unsuccessful Request, Subscription Product Not Found

Request Example

    
        {
 "subscriptionProductId": "subscription-product-id-1",
 "activeFrom": "2023-21-12"
}

Response Example

    
        {
 "currencyCode": "NOK",
 "periods": [
  {
   "grossAmount": 123,
   "startDay": "2022-12-21",
   "endDay": "2023-02-13"
  }
 ]
}

Request Example

    
        {
 "subscriptionProductId": "subscription-product-id-1",
 "activeFrom": "2023-21-12"
}

Response Example

    
        {
 "type": "https://developer.horizonafs.io/errors/resource-not-found",
 "category": "BUSINESS_ERROR",
 "title": "Resource not found",
 "message": "Resource not found"
}