Get Customer or Subscription Related Consumptions

Path

GET /v1/clients/{clientId}/consumptions

Request Parameters

clientId

required

integer

Your assigned `ClientId`.

customerNumber

required

string

Customer number.

subscriptionId

string

Id of the subscription.

Responses

string

Id of the retrieved consumption.

customerNumber

string

Id of the customer the consumption is assigned to.

subscriptionId

string

Id of the subscription the consumption is assigned to.

invoiceId

string

Id of the invoice if the consumption has been invoiced.

array

The items that make up this consumption.

string

Unique Id of the item within this consumption.

object

Details of your product.

object

total

N/A

object

When this transaction occurred.

array

Optional. A list of key-value pairs.

createdAt

string

When this consumption was created.

billingDate

string

The billing date of this consumption.

array

The refunds created on this consumption.

consumptionTotal

N/A

The totals of the consumption.

refundTotal

N/A

The totals of the refund(s).

array

Optional. A list of key-value pairs.

type

required

string

The type of error that is carried within this response. The value of this type is an URI that can be dereferenced for a human-readable explanation of the error type.

Request Example

    
        null

Response Example

    
        [
 {
  "consumptionTotal": {
   "grossAmount": 125,
   "vatAmount": 25,
   "currencyCode": "NOK"
  },
  "refundTotal": {
   "grossAmount": 25,
   "vatAmount": 25,
   "currencyCode": "NOK"
  },
  "id": "consumption-id-1",
  "customerNumber": "customer-number-1",
  "subscriptionId": "subscription-id",
  "invoiceId": "100484",
  "items": [
   {
    "id": "1",
    "productDetails": {
     "productId": "pack-2gb",
     "description": "2gb data pack."
    },
    "unit": {
     "netPrice": 100,
     "quantity": 1,
     "code": "PCS",
     "currencyCode": "NOK"
    },
    "total": {
     "grossAmount": 125,
     "netAmount": 100,
     "currencyCode": "NOK",
     "vatPercentage": 25
    },
    "occurredAt": {
     "start": "2022-09-28T10:40:44.421Z",
     "end": null
    },
    "metadata": [
     {
      "key": "product-number",
      "value": "3937501"
     }
    ]
   }
  ],
  "createdAt": "2022-09-28T10:40:44.421Z",
  "billingDate": null,
  "metadata": [
   {
    "key": "order-id",
    "value": "a9ee9996-e941-4aa8-90b9-4b047c4afe87"
   }
  ],
  "_links": [
   {
    "method": "GET",
    "href": "https://api.riverty.io/subscription/v1/clients/1234/consumptions/consumption-id-1",
    "rel": "self",
    "target": "API"
   },
   {
    "method": "GET",
    "href": "https://api.riverty.io/subscription/v1/clients/1234/consumptions/consumption-id-1/timeline",
    "rel": "timeline",
    "target": "API"
   },
   {
    "method": "GET",
    "href": "https://api.riverty.io/subscription/v1/clients/1234/subscriptions/subscription-id-1",
    "rel": "subscription",
    "target": "API"
   }
  ]
 }
]

Request Example

    
        null

Response Example

    
        {
 "type": "https://developer.riverty.io/errors/subscription/error-type",
 "category": "BUSINESS_ERROR",
 "title": "A description of the problem",
 "message": "A description of the problem"
}