Hermos API

Report who is subscribed to a price

One row per currency and interval. subscriptions counts distinct subscriptions (a subscription with two lines on the price counts once); quantity sums item quantities; gross_amount sums unit_amount × quantity; discounted_amount_estimate sums each line net of the discounts acting on it (an estimate: invoice-level amount_off discounts are not allocated). A price of unsupported shape reports gross_amount and the estimate as null with amount_unsupported true; counts are still given. exclusions counts distinct subscriptions per reason that a migration would exclude (target availability is judged only when a run names a target). People and keys with catalog:read; agents 403 agent_not_available.

GET/prices/{price}/subscribers

One row per currency and interval. subscriptions counts distinct subscriptions (a subscription with two lines on the price counts once); quantity sums item quantities; gross_amount sums unit_amount × quantity; discounted_amount_estimate sums each line net of the discounts acting on it (an estimate: invoice-level amount_off discounts are not allocated). A price of unsupported shape reports gross_amount and the estimate as null with amount_unsupported true; counts are still given. exclusions counts distinct subscriptions per reason that a migration would exclude (target availability is judged only when a run names a target). People and keys with catalog:read; agents 403 agent_not_available.

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

price*string
Formatuuid

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/prices/497f6eca-6276-4993-bfeb-53cbbbba6f08/subscribers"
{  "data": {    "object": "price_subscribers",    "price": "296c3962-8fad-4bbf-a476-e2a5d4fe62a6",    "estimate": true,    "rows": [      {        "currency": "string",        "interval": "day",        "interval_count": 1,        "subscriptions": 0,        "quantity": 0,        "gross_amount": 0,        "discounted_amount_estimate": 0,        "amount_unsupported": true,        "exclusions": {          "trialing": 0,          "cancelled": 0,          "paused": 0,          "payment_plan": 0,          "schedule_managed": 0,          "pending_update": 0,          "change_in_progress": 0,          "not_on_old_price": 0,          "multiple_lines_on_price": 0,          "target_not_on_account": 0,          "anchor_unknown": 0,          "discount_not_preservable": 0        }      }    ]  },  "request_id": "266ea41d-adf5-480b-af50-15b940c2b846"}