/
Retrieve subscription ord...

Retrieve subscription order summary metrics
Experimental

Request

Retrieves summary metrics for a subscription order with a specified ID.

Security
SecretApiKey or JWT
Path
subscriptionIdstringrequired

ID of the subscription order.

curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/experimental/subscriptions/{subscriptionId}/summary-metrics' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

Metrics retrieved.

Bodyapplication/json
currencystring, = 3 charactersread-onlyrequired

Currency code in ISO 4217 format.

Example:"USD"
invoicedAmountnumber, (double)read-onlyrequired

Total amount of all issued, past due, and paid invoices.

collectedAmountnumber, (double)read-onlyrequired

Total amount of all paid invoices.

invoiceCountintegerread-onlyrequired

Number of issued, past due, or paid invoices.

Response
{
  "currency": "USD",
  "invoicedAmount": 0.1,
  "collectedAmount": 0.1,
  "invoiceCount": 0
}