riverty logo

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 > 100 Characters
Id of the subscription product.
activeFrom
required
string
The date of when the customer is enrolled on.

Responses

Successful RequestUnsuccessful Request, Subscription Product Not Found

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