Retrieve Subscription Quantity History

API Reference

V1

Contracts

Get subscription quantity history

client.V1.Contracts.GetSubscriptionQuantityHistory(ctx, body) (*DataV1ContractGetSubscriptionQuantityHistoryResponseDataV1ContractGetSubscriptionQuantityHistoryResponse, error)

post/v1/contracts/getSubscriptionQuantityHistory

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

Parameters

bodyContractIDfieldCustomerIDfieldSubscriptionIDfieldV1ContractGetSubscriptionQuantityHistoryParams

Hide ParametersShow Parameters

ContractIDfield

param.Field[string]

formatuuid

CustomerIDfield

param.Field[string]

formatuuid

SubscriptionIDfield

param.Field[string]

formatuuid

Returns

V1ContractGetSubscriptionQuantityHistoryResponsestruct

Hide ParametersShow Parameters

DataFiatCreditTypeIDstringHistoryarraySubscriptionIDstringV1ContractGetSubscriptionQuantityHistoryResponseData

Hide ParametersShow Parameters

FiatCreditTypeIDstring

optional

formatuuid

Historyarray

optional

[]V1ContractGetSubscriptionQuantityHistoryResponseDataHistory

Hide ParametersShow Parameters

Dataarray

[]V1ContractGetSubscriptionQuantityHistoryResponseDataHistoryData

Hide ParametersShow Parameters

Quantityfloat64

Totalfloat64

UnitPricefloat64

StartingAtTime

formatdate-time

SubscriptionIDstring

optional

formatuuid

HTTPTypeScriptPythonGoRubyTerraform

package main

import (
  "context"
  "fmt"

  "github.com/Metronome-Industries/metronome-go"
  "github.com/Metronome-Industries/metronome-go/option"
)

func main() {
  client := metronome.NewClient(
    option.WithBearerToken("My Bearer Token"),
  )
  response, err := client.V1.Contracts.GetSubscriptionQuantityHistory(context.TODO(), metronome.V1ContractGetSubscriptionQuantityHistoryParams{
    ContractID: metronome.F("d7abd0cd-4ae9-4db7-8676-e986a4ebd8dc"),
    CustomerID: metronome.F("13117714-3f05-48e5-a6e9-a66093f13b4d"),
    SubscriptionID: metronome.F("1a824d53-bde6-4d82-96d7-6347ff227d5c"),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", 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"
  }
}