Create a Subscription Product

After creating a Create a Consumer you're ready to create a subscription. Creating a subscription will trigger the Riverty risk assessment and allow you to start new subscription periods after. You can create a subscription using the following:

Same as in the subscription API we distinguish between a: Standard subscription where the consumer is allowed to cancel before each new period Commitment cycle subscription where the consumer is obligated to use the subscription for a minimum defined time period before being able to cancel the subscription

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

PUT v1/clients/{{ClientID}}/subscription-products/{{SubscriptionProductID}}

  • ClientID = Your Riverty client_id
  • SubscriptionProductID = Assign your internal reference to this subscription.

Example Subscriptions

Standard Monthly Subscription

An example of a classic monthly subscription which automatically renews each month until cancelled by the customer. Riverty finances new subscription periods at the start of each new period.

Example Call - Without Commitment

{
  "details": {
    "description": "Train More Gym Subscription",
    "productUrl": " ",
    "imageUrl": ""
  },
  "period": {
    "type": "MONTH",
    "start": {
      "type": "ACTIVATION",
      "day": null,
      "month": null
    }
  },
  "items": [
    {
      "name": "Monthly Gym Subscription - Gold member",
      "description": "Gold member subscription (Sauna, Sunbed, Towels & Salade)",
      "price": {
        "grossAmount": 49.95,
        "vatPercentage": 0
      },
      "metadata": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "isRefundable": true
    }
  ],
  "termsAndConditions": {
    "description": ":)",
    "billingType": "IN_ADVANCE",
    "cancellationType": "AFTER_CURRENT_PERIOD"
  },
  "available": {
    "from": "{{Date}}",
    "until": "2023-12-17"
  },
  "financing": {
    "type": "CONTRACT"
  }
}

12 Month Subscription

An example of 12 months subscription where the customer must complete at least 1 cycle of 12 months before the subscription can be cancelled. If the customer doesn't cancel the subscription, it automatically renews for another 12 months. Riverty finances all 12 months at the start of the subscription.

Example Call - With Commitment

{
  "details": {
    "description": "Fresh fruit basket - Premium",
    "productUrl": "",
    "imageUrl": ""
  },
  "period": {
    "type": "MONTH",
    "start": {
      "type": "ACTIVATION",
      "day": null,
      "month": null
    }
  },
  "items": [
    {
      "name": "string",
      "description": "string",
      "price": {
        "grossAmount": 49,
        "vatPercentage": 0
      },
      "metadata": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "isRefundable": true
    }
  ],
  "termsAndConditions": {
    "description": ":)",
    "billingType": "IN_ADVANCE",
    "cancellationType": "AFTER_CURRENT_PERIOD",
    "commitment": {
      "numberOfCycles": "{{NumberOfCycles}}",
      "numberOfPeriods": "{{NumberOfPeriods}}",
      "endOfCommitmentAction": "{{EndOfCommitmentAction}}"
    }
  },
  "available": {
    "from": "{{Date}}",
    "until": "2023-12-17"
  },
  "financing": {
    "type": "CONTRACT"
  }
}

12 month subscription with trial that converts into a monthly subscription

An example of a 12 month subscription with a 14 day free trial period, where the customer must complete at least 1 cycle of 12 months before the subscription can be cancelled. After completing the 12 month cycle, the subscription turns into a regular monthly subscription where the customer can cancel each month. Riverty finances the first 12 months up front and afterwards each individual period.

Call Example - Trail, 12 Month Commitment, Monthly Upon Expiration

{
  "details": {
    "description": "15 GB",
    "productUrl": "https://phonecompany.com/subscriptions/15gb",
    "imageUrl": "https://phonecompany.com/images/phone.png"
  },
  "period": {
    "type": "MONTH",
    "start": {
      "type": "ACTIVATION",
      "day": null,
      "month": null
    }
  },
  "items": [
    {
      "name": "string",
      "description": "string",
      "price": {
        "grossAmount": 500,
        "vatPercentage": 0
      },
      "metadata": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "isRefundable": true
    }
  ],
  "termsAndConditions": {
    "description": "Cancellations will take in effect at the end of your 12 months subscription",
    "billingType": "IN_ADVANCE",
    "cancellationType": "AFTER_CURRENT_PERIOD",
    "commitment": {
      "numberOfCycles": null,
      "numberOfPeriods": 12,
      "endOfCommitmentAction": "CONTINUE_WITHOUT_COMMITMENT"
    }
  },
  "trial": {
    "details": {
      "description": "Free Trial"
    },
    "period": {
      "length": "14_DAYS",
      "price": {
        "grossAmount": 0,
        "vatPercentage": 0
      }
    }
  },
  "available": {
    "from": "2023-12-17",
    "until": "2099-12-17"
  },
  "financing": {
    "type": "CONTRACT"
  }
}

Example Response - With Commitment

{
  "id": "SubscriptionProduct1665753663403",
  "period": {
    "price": {
      "currencyCode": "NOK",
      "grossAmount": 500,
      "vatPercentage": 25
    },
    "type": "MONTH",
    "start": {
      "type": "ACTIVATION"
    }
  },
  "createdAt": "2022-10-14T13:21:13.5958705+00:00",
  "_links": [
    {
      "method": "GET",
      "href": "https://api-dev.horizonafs.io/subscription/v1/clients/4103/subscription-products/SubscriptionProduct1665753663403",
      "rel": "self",
      "target": "API"
    },
    {
      "method": "DELETE",
      "href": "https://api-dev.horizonafs.io/subscription/v1/clients/4103/subscription-products/SubscriptionProduct1665753663403",
      "rel": "subscription-product-delete",
      "target": "API"
    }
  ],
  "details": {
    "description": "15 GB",
    "productUrl": "https://phonecompany.com/subscriptions/15gb",
    "imageUrl": "https://phonecompany.com/images/phone.png"
  },
  "termsAndConditions": {
    "description": "Some description about the terms and conditions for this product",
    "billingType": "IN_ADVANCE",
    "cancellationType": "INSTANT",
    "commitment": {
      "numberOfPeriods": 2,
      "numberOfCycles": 2,
      "endOfCommitmentAction": "CONTINUE_WITHOUT_COMMITMENT"
    }
  },
  "available": {
    "from": "2022-10-14",
    "until": "2023-09-24"
  },
  "financing": {
    "type": "BILLING"
  }
}

Example Response - Without Commitment

{
  "id": "SubscriptionProduct1665753663403",
  "period": {
    "price": {
      "currencyCode": "NOK",
      "grossAmount": 500,
      "vatPercentage": 25
    },
    "type": "MONTH",
    "start": {
      "type": "ACTIVATION"
    }
  },
  "createdAt": "2022-10-14T13:21:13.5958705+00:00",
  "_links": [
    {
      "method": "GET",
      "href": "https://api-dev.horizonafs.io/subscription/v1/clients/4103/subscription-products/SubscriptionProduct1665753663403",
      "rel": "self",
      "target": "API"
    },
    {
      "method": "DELETE",
      "href": "https://api-dev.horizonafs.io/subscription/v1/clients/4103/subscription-products/SubscriptionProduct1665753663403",
      "rel": "subscription-product-delete",
      "target": "API"
    }
  ],
  "details": {
    "description": "15 GB",
    "productUrl": "https://phonecompany.com/subscriptions/15gb",
    "imageUrl": "https://phonecompany.com/images/phone.png"
  },
  "termsAndConditions": {
    "description": "Some description about the terms and conditions for this product",
    "billingType": "IN_ADVANCE",
    "cancellationType": "INSTANT",
    "commitment": {
      "numberOfPeriods": 2,
      "numberOfCycles": 2,
      "endOfCommitmentAction": "CONTINUE_WITHOUT_COMMITMENT"
    }
  },
  "available": {
    "from": "2022-10-14",
    "until": "2023-09-24"
  },
  "financing": {
    "type": "BILLING"
  }
}