riverty logo

Docs

Create or Update a Subscription Period

Path

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

Request Parameters

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

Request Body

application/json

start
required
string
Period start date.
end
required
string
Period end date.
price
N/A
The price of this period.

Responses

Successful Request, Period Updated Successful Request, Period Created

Request Example

    
        {
 "start": "2023-09-01",
 "end": "2023-09-30",
 "price": {
  "grossAmount": 39.99,
  "vatPercentage": 20
 }
}

Response Example

    
        {
 "status": "NOT_INVOICED",
 "start": "2023-09-01",
 "end": "2023-09-30",
 "price": {
  "grossAmount": 39.99,
  "vatPercentage": 20,
  "currencyCode": "NOK"
 },
 "_links": [
  {
   "method": "GET",
   "href": "https://api.riverty.io/partner-financing/v1/clients/1234/partner-subscriptions/subscription-id-1/periods/period-id-1",
   "rel": "self",
   "target": "API"
  },
  {
   "method": "GET",
   "href": "https://consumer.riverty.io/f/apgD/24G7eVlYeEnEB7Q1UkLBNvNx3Zh8Q3ArrVOGh7aYXD5j9gFdaewAGADGF51ZJgXgn7",
   "rel": "manage-payments",
   "target": "BROWSER"
  }
 ]
}