Start a Subscription

You can start a subscription once a Subscription Product and Consumer have been created. Starting a subscription will trigger the Consumer Risk Check and kickstart the subscription lifecycle.

Using the 'billingDayOffset' parameter you can control when the customer receives their subscription invoices from Riverty. The billing day offset will delay the invoice date with the integer that you enter on top of the active from date.

Below a request example:

PUT v1/clients/{{ClientID}}/subscriptions/{{SubscriptionID}}

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

Example Request

{
  "customerNumber": "{{CustomerNumber}}",
  "subscriptionProductId": "{{SubscriptionProductID}}",
  "billingDayOffset": 0,
  "metadata": [
    {
      "key": "order-id",
      "value": "a9ee9996-e941-4aa8-90b9-4b047c4afe87"
    }
  ],
  "activeFrom": "{{Date}}"
}

Example Response

{
  "id": "subscription-id-1",
  "customerNumber": "customer-number-1",
  "subscriptionProductId": "subscription-product-id-1",
  "metadata": [
    {
      "key": "order-id",
      "value": "a9ee9996-e941-4aa8-90b9-4b047c4afe87"
    }
  ],
  "createdAt": "2022-01-28T13:04:40.020Z",
  "active": {
    "from": "2022-09-28",
    "until": "9999-12-31"
  },
  "status": "ACTIVE",
  "closeDetails": {
    "canceledByClient": false,
    "canceledByBillingPartner": false,
    "terminatedByClient": false
  },
  "billingDetails": {
    "nextBillingDate": "2022-09-30",
    "billingDayOffset": 2
  },
  "currentPeriod": {
    "start": "2022-09-28",
    "end": "2022-10-27"
  },
  "_links": [
    {
      "method": "GET",
      "href": "https://api.horizonafs.io/subscription/v1/clients/1234/subscriptions/subscription-id-1",
      "rel": "self"
    },
    {
      "method": "GET",
      "href": "https://api.horizonafs.io/subscription/v1/clients/1234/subscription-products/subscription-product-id-1",
      "rel": "subscription-product"
    },
    {
      "method": "PUT",
      "href": "https://api.horizonafs.io/subscription/v1/clients/1234/subscriptions/subscription-id-1/cancellation",
      "rel": "cancellation"
    },
    {
      "method": "PUT",
      "href": "https://api.horizonafs.io/subscription/v1/clients/1234/subscriptions/subscription-id-1/termination",
      "rel": "termination"
    },
    {
      "method": "GET",
      "href": "https://api.horizonafs.io/subscription/v1/clients/1234/subscriptions/subscription-id-1/timeline",
      "rel": "timeline"
    }
  ]
}