riverty logo

Docs

Get Subscription Product

Get an existing subscription product.

Path

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

Request Parameters

clientId
required
integer
Your assigned `ClientId`.
subscriptionProductId
required
string
Id of the subscription product to retrieve.

Responses

Successful RequestUnsuccessful Request, Incorrect Subscription Product ID

Request Example

    
        null

Response Example

    
        {
 "id": "SubscriptionProduct1695991070672",
 "period": {
  "type": "MONTH",
  "start": {
   "type": "ACTIVATION"
  }
 },
 "items": [
  {
   "price": {
    "currencyCode": "SEK",
    "grossAmount": 49,
    "vatPercentage": 0
   },
   "name": "string",
   "description": "string",
   "metadata": [
    {
     "key": "string",
     "value": "string"
    }
   ],
   "isRefundable": true,
   "partialPeriodAmountCalculation": "PARTIAL"
  }
 ],
 "createdAt": "2023-09-29T12:37:52.9354512+00:00",
 "_links": [
  {
   "method": "GET",
   "href": "https://api-test.horizonafs.io/subscription/v1/clients/104504/subscription-products/SubscriptionProduct1695991070672",
   "rel": "self",
   "target": "API"
  },
  {
   "method": "DELETE",
   "href": "https://api-test.horizonafs.io/subscription/v1/clients/104504/subscription-products/SubscriptionProduct1695991070672",
   "rel": "subscription-product-delete",
   "target": "API"
  }
 ],
 "details": {
  "description": "Fresh fruit basket - Premium",
  "productUrl": "",
  "imageUrl": ""
 },
 "termsAndConditions": {
  "description": ":)",
  "billingType": "IN_ADVANCE",
  "cancellationType": "AFTER_CURRENT_PERIOD",
  "commitment": {
   "numberOfPeriods": 3,
   "endOfCommitmentAction": "RENEW_COMMITMENT"
  }
 },
 "available": {
  "from": "2023-09-29",
  "until": "2023-12-17"
 },
 "financing": {
  "type": "CONTRACT"
 }
}