Create a Subscription

After Creating a Consumer, you are ready to create a subscription. Creating a subscription will trigger the Riverty risk assessment and allow you to start new subscription periods. You can create a subscription using the following:

Standard Subscription: consumers can cancel before each new period (e.g. monthly)
Commitment Cycle Subscription: consumers are obligated to use the subscription for a minimum defined time period longer than a month before being able to cancel the subscription (e.g. yearly)

Only subscriptions with a commitment cycle can make use of contract financing, see Subscription Financing

After having successfully created the subscription, Riverty will now purchase future subscription periods when they are created via the Create a Period operation.

PUT /v1/clients/{{ClientID}}/partner-subscriptions/{{PartnerSubscriptionID}}

ClientID = Your Riverty client_id
PartnerSubscriptionID = Assign your internal reference to this subscription. When left blank Riverty will assign an id

Standard Subscription Call Example

    
        {
 "customerNumber": "{{CustomerNumber}}",
 "description": "Partner Subscription Description",
 "price": {
  "grossAmount": 100,
  "vatPercentage": 20
 }
}

Subscription response with status: Inactive

    
        {
 "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",
 "numberOfCommitmentPeriods": 3,
 "_links": [
  {
   "method": "GET",
   "href": "https://api.riverty.io/partner-financing/v1/clients/1234/partner-subscriptions/subscription-id-1",
   "rel": "self",
   "target": "API"
  }
 ]
}

Subscription response with status: Active

    
        {
 "customerNumber": "customer-1",
 "description": "Home services, Internet 100M / 25M, monthly fee",
 "price": {
  "grossAmount": 39.99,
  "vatPercentage": 20,
  "currencyCode": "NOK"
 },
 "activeFrom": "2023-09-01",
 "status": "ACTIVE",
 "createdAt": "2023-08-15T10:41:54.2019797+03:00",
 "numberOfCommitmentPeriods": 3,
 "_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"
  }
 ]
}