Orders

An order applies a plan's template to create invoice(s) for a customer, optionally at the appropriate scheduled intervals. A subscription order may also determine if the payment is collected automatically (with autopay set true).

Retrieve subscription order summary metrics

Retrieve subscription order summary metrics.

SecuritySecretApiKey or JWT
Request
path Parameters
subscriptionId
required
string

Order's ID.

Responses
200

Metrics were retrieved successfully.

Response Schema: application/json
currency
string

Currency (three letter ISO 4217 alpha code).

invoicedAmount
number <double>

Sum of all issued, past due, or paid invoices.

collectedAmount
number <double>

Sum of all paid invoices.

invoiceCount
integer

Number of issued, past due, or paid invoices.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

get/subscriptions/{subscriptionId}/summary-metrics
Request samples
curl -i -X GET \
  'https://api-sandbox.rebilly.com/experimental/organizations/unknown/subscriptions/{subscriptionId}/summary-metrics' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "currency": "USD",
  • "invoicedAmount": 0,
  • "collectedAmount": 0,
  • "invoiceCount": 0
}