riverty logo

Docs

Create or Update a Subscription

Path

PUT /v1/clients/{clientId}/partner-subscriptions/{subscriptionId}

Request Parameters

clientId
required
integer
Your assigned `ClientId`.
subscriptionId
required
string
Id of the subscription.

Request Body

application/json

customerNumber
required
string
> 100 Characters
Customer number.
description
required
string
> 200 Characters
A short description of the subscription.
price
required
N/A
The price of a typical period in this subscription.
numberOfCommitmentPeriods
integer
Number of commitment periods.
scaRequired
boolean
Optional. Enforces strong customer authentication for your consumer. This parameter requires SCA client configurations to be configured.

Responses

Successful Request, Subscription UpdatedSuccessful Request, Subscription CreatedUnsuccessful Request, Missing/Incorrect Information

Request Example

    
        {
 "customerNumber": "customer-1",
 "description": "Home services, Internet 100M / 25M, monthly fee",
 "price": {
  "grossAmount": 39.99,
  "vatPercentage": 20
 },
 "numberOfCommitmentPeriods": 3
}

Response Example

    
        {
 "customerNumber": "customer-1",
 "description": "Home services, Internet 100M / 25M, monthly fee",
 "price": {
  "grossAmount": 39.99,
  "vatPercentage": 20,
  "currencyCode": "NOK"
 },
 "activeFrom": "2023-09-01",
 "status": "INACTIVE",
 "createdAt": "2023-08-15T10:41:54.2019797+03:00",
 "_links": [
  {
   "method": "GET",
   "href": "https://api.riverty.io/partner-financing/v1/clients/1234/partner-subscriptions/subscription-id-1",
   "rel": "self",
   "target": "API"
  },
  {
   "method": "PUT",
   "href": "https://api.riverty.io/partner-financing/v1/clients/1234/partner-subscriptions/subscription-id-1/cancellation",
   "rel": "subscription-cancel",
   "target": "API"
  },
  {
   "method": "DELETE",
   "href": "https://api.riverty.io/partner-financing/v1/clients/1234/partner-subscriptions/subscription-id-1/cancellation",
   "rel": "subscription-uncancel",
   "target": "API"
  }
 ]
}