Retrieve Subscription Quantity History

API Reference

V1

Contracts

Get subscription quantity history

client.v1.contracts.retrieveSubscriptionQuantityHistory(ContractRetrieveSubscriptionQuantityHistoryParamsbody, RequestOptionsoptions?): dataDataContractRetrieveSubscriptionQuantityHistoryResponse

post/v1/contracts/getSubscriptionQuantityHistory

Fetch the quantity and price for a subscription over time. End-point does not return future scheduled changes.

Parameters

bodycontract_idstringcustomer_idstringsubscription_idstringContractRetrieveSubscriptionQuantityHistoryParams

Hide ParametersShow Parameters

contract_idstring

formatuuid

customer_idstring

formatuuid

subscription_idstring

formatuuid

Returns

ContractRetrieveSubscriptionQuantityHistoryResponse

Hide ParametersShow Parameters

datafiat_credit_type_idstringhistoryarraysubscription_idstringData

Hide ParametersShow Parameters

fiat_credit_type_idstring

optional

formatuuid

historyarray

optional

Array<History>

Hide ParametersShow Parameters

dataarray

Array<Data>

Hide ParametersShow Parameters

quantitynumber

totalnumber

unit_pricenumber

starting_atstring

formatdate-time

subscription_idstring

optional

formatuuid

HTTPTypeScriptPythonGoRubyTerraform

import Metronome from '@metronome/sdk';

const client = new Metronome({
  bearerToken: 'My Bearer Token',
});

const response = await client.v1.contracts.retrieveSubscriptionQuantityHistory({
  contract_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
  customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
  subscription_id: '1a824d53-bde6-4d82-96d7-6347ff227d5c',
});

console.log(response.data);

200 Example

{
  "data": {
    "fiat_credit_type_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "history": [
      {
        "data": [
          {
            "quantity": 0,
            "total": 0,
            "unit_price": 0
          }
        ],
        "starting_at": "2019-12-27T18:11:19.117Z"
      }
    ],
    "subscription_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
  }
}