riverty logo

Docs

Get All Subscription Products

Get all subscription products filtered by date.

Path

GET /v1/clients/{clientId}/subscription-products

Request Parameters

createdAfter
string
A date yyyy-dd-mm.
clientId required
integer
Your assigned `ClientId`.

Responses

Successful Request

Response Example

    
        [
 {
  "content": null,
  "id": "subscription-product-id-1",
  "period": {
   "type": "MONTH",
   "start": {
    "type": "ACTIVATION",
    "day": null,
    "month": null
   }
  },
  "items": [
   {
    "name": "Unbranded Granite Mouse",
    "description": "Carbonite web goalkeeper gloves are ergonomically designed to give easy fit",
    "price": {
     "currencyCode": "NOK",
     "grossAmount": 500,
     "vatPercentage": 25
    },
    "trialPrice": {
     "grossAmount": 100
    },
    "metadata": [
     {
      "key": "order-id",
      "value": "9a1a03f5-dbb0-4e32-9fc2-89c9be29780a"
     }
    ],
    "isRefundable": true
   }
  ],
  "createdAt": "2022-08-24T14:15:22Z",
  "details": {
   "description": "15 GB.",
   "productUrl": "https://phonecompany.com/subscriptions/15gb",
   "imageUrl": "https://phonecompany.com/images/phone.png"
  },
  "termsAndConditions": {
   "description": "Terms and conditions short text.",
   "billingType": "IN_ADVANCE",
   "cancellationType": "AFTER_CURRENT_PERIOD",
   "commitment": {
    "numberOfPeriods": 3,
    "numberOfCycles": null,
    "endOfCommitmentAction": "RENEW_COMMITMENT"
   }
  },
  "available": {
   "from": "2022-09-24",
   "until": "2023-09-24"
  },
  "financing": {
   "type": "BILLING"
  },
  "_links": [
   {
    "method": "GET",
    "href": "https://api.riverty.io/subscription/v1/clients/1234/subscription-products/subscription-product-id-1"
   }
  ]
 },
 {
  "content": null,
  "id": "subscription-product-id-2",
  "period": {
   "type": "MONTH",
   "start": {
    "type": "ACTIVATION",
    "day": null
   }
  },
  "items": [
   {
    "name": "Ergonomic Plastic Salad",
    "description": "Carbonite web goalkeeper gloves are ergonomically designed to give easy fit",
    "price": {
     "currencyCode": "NOK",
     "grossAmount": 500,
     "vatPercentage": 25
    },
    "metadata": [
     {
      "key": "order-id",
      "value": "9a1a03f5-dbb0-4e32-9fc2-89c9be29780a"
     }
    ]
   }
  ],
  "createdAt": "2022-08-24T14:15:22Z",
  "details": {
   "description": "5 GB.",
   "productUrl": "https://phonecompany.com/subscriptions/5gb",
   "imageUrl": "https://phonecompany.com/images/phone.png"
  },
  "termsAndConditions": {
   "description": "Terms and conditions short text.",
   "billingType": "IN_ADVANCE",
   "cancellationType": "AFTER_CURRENT_PERIOD",
   "commitment": {
    "numberOfPeriods": 3,
    "numberOfCycles": null,
    "endOfCommitmentAction": "CLOSE_SUBSCRIPTION"
   }
  },
  "trial": {
   "details": {
    "description": "Free 14 days trial."
   },
   "length": "14_DAYS",
   "isFinanceable": false
  },
  "available": {
   "from": "2022-09-24",
   "until": "2023-09-24"
  },
  "financing": {
   "type": "BILLING"
  },
  "_links": [
   {
    "method": "GET",
    "href": "https://api.riverty.io/subscription/v1/clients/1234/subscription-products/subscription-product-id-2"
   }
  ]
 }
]
    

Request Example

    
        null