Retrieve Subscription Quantity History

API Reference

V1

Contracts

Get subscription quantity history

v1.contracts.retrieve_subscription_quantity_history(**kwargs) -> dataobjectContractRetrieveSubscriptionQuantityHistoryResponse

post/v1/contracts/getSubscriptionQuantityHistory

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

Parameters

contract_idString

formatuuid

customer_idString

formatuuid

subscription_idString

formatuuid

Returns

ContractRetrieveSubscriptionQuantityHistoryResponseclass

Hide ParametersShow Parameters

dataobject

{ fiat_credit_type_id, history, subscription_id}

Hide ParametersShow Parameters

fiat_credit_type_idString

optional

formatuuid

historyarray

optional

Array[{ data, starting_at}]

Hide ParametersShow Parameters

dataarray

Array[{ quantity, total, unit_price}]

Hide ParametersShow Parameters

quantityFloat

totalFloat

unit_priceFloat

starting_atTime

formatdate-time

subscription_idString

optional

formatuuid

HTTPTypeScriptPythonGoRubyTerraform

require "metronome_sdk"

metronome = MetronomeSDK::Client.new(bearer_token: "My Bearer Token")

response = metronome.v1.contracts.retrieve_subscription_quantity_history(
  contract_id: "d7abd0cd-4ae9-4db7-8676-e986a4ebd8dc",
  customer_id: "13117714-3f05-48e5-a6e9-a66093f13b4d",
  subscription_id: "1a824d53-bde6-4d82-96d7-6347ff227d5c"
)

puts(response)

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"
  }
}