riverty logo

Docs

Create or Update a Subscription

Path

PUT /v1/clients/{clientId}/partner-subscriptions/{subscriptionId}
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"
  }
 ]
}