Rebilly API Docs

Retrieve subscription order summary metrics

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

SecuritySecretApiKey or JWT

Request

subscriptionId

required

string

ID of the subscription order.

Responses

200

Metrics retrieved.

currency	string = 3 characters Currency code in ISO 4217 format.
invoicedAmount	number <double> Total amount of all issued, past due, and paid invoices.
collectedAmount	number <double> Total amount of all paid invoices.
invoiceCount	integer Number of issued, past due, or paid invoices.

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

get/experimental/subscriptions/{subscriptionId}/summary-metrics

Request samples

$service = new Rebilly\Sdk\ReportsService($client);

$report = $service->subscriptions()->getSubscriptionSummaryMetrics('subscriptionId');

Response samples

application/json

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