Deutsch DE
API-Referenz
API-Referenz

Auswertungen

Subscriptions

GET / v1 / reports / subscriptions

Subscriptions and installment plans now, the products with subscribers, and new and ended subscriptions by month. The default period is the last 12 months, UTC.

Subscription states:

  • active: subscriptions that renew. A renewal in progress counts.
  • cancelling: cancelled, with access until the end date and no renewal.
  • past_due: a renewal payment failed. Tentary tries again on day 2, 7 and 14, and the buyer has no access in this time. A retry in progress counts here.
  • renewal_overdue: the renewal or its retries did not run on time (see warnings). Not in active.
  • with_access: subscriptions whose buyers can open the product now, by the access rules of Tentary. This is not the sum of the other counts.

Revenue and endings:

  • mrr: monthly recurring revenue of the active subscriptions. It is the renewal price per month, after an intro price or coupon, VAT included, per currency and not converted.
  • ended_cancelled counts by the end of access, because Tentary does not store the day of the cancel click.
  • ended_payment_failed counts by the last failed try.

Installment plans are not subscriptions:

  • open_amount: installments not paid yet.
  • Failed plans: all payment tries failed. failed_open_amount is still unpaid and can be collected with payment reminders or debt collection. Plans whose claim the account owner closed are left out.

For revenue, call GET /v1/reports/revenue.

Liest nur MCP-Werkzeug get_subscription_summary

Autorisierung

  • Authorization string Header erforderlich

    Bearer tnt_… · A personal API key (tnt_...). Create it in the Tentary app on the page AI & API. Einführung

Query-Parameter

  • from string

    First day (UTC) for new and ended subscriptions, like 2026-01-01.

    Muster ^[0-9]{4}-[0-9]{2}-[0-9]{2}$ Beispiel: "2026-08-01"

  • to string

    Last day (UTC), like 2026-12-31. Default today. 731 days at most.

    Muster ^[0-9]{4}-[0-9]{2}-[0-9]{2}$ Beispiel: "2026-10-27"

  • product_id integer

    Only this product (id from list_products).

    min. 1

Antwort

Felder der Antwort mit Status 200. Fehler haben immer dasselbe Format, siehe Fehler.

  • today string<date>

    Like 2026-01-31.

  • product object kann null sein

    The product.

    2 Felder anzeigen Felder ausblenden
    • id integer

      The ID.

    • name string

      The name.

  • subscriptions object

    The subscriptions.

    7 Felder anzeigen Felder ausblenden
    • active integer

      Subscriptions that renew.

    • cancelling integer

      Cancelled, with access until the end date.

    • with_access integer

      Subscriptions whose buyers can open the product now.

    • past_due integer

      A renewal payment failed; Tentary tries again.

    • renewal_overdue integer

      The renewal did not run on time.

    • mrr array of object

      Monthly recurring revenue of the active subscriptions, VAT included, per currency.

      2 Felder anzeigen Felder ausblenden
      • currency string

        Currency code, like EUR.

      • amount string

        Decimal string, like "19.90". Amount in this currency.

    • active_by_interval array of object

      Active subscriptions per billing interval.

      2 Felder anzeigen Felder ausblenden
      • interval_months integer

        Months between payments.

      • active integer

        Active subscriptions.

  • installment_plans object

    Payment plans that buyers can choose.

    8 Felder anzeigen Felder ausblenden
    • running integer

      Plans that are paid on time.

    • cancelling integer

      Cancelled, with access until the end date.

    • past_due integer

      A payment failed; Tentary tries again.

    • renewal_overdue integer

      The payment did not run on time.

    • failed integer

      All payment tries failed.

    • failed_in_debt_collection integer

      Failed plans in debt collection.

    • open_amount array of object

      Installments not paid yet.

      2 Felder anzeigen Felder ausblenden
      • currency string

        Currency code, like EUR.

      • amount string

        Decimal string, like "19.90". Amount in this currency.

    • failed_open_amount array of object

      Still unpaid of the failed plans.

      2 Felder anzeigen Felder ausblenden
      • currency string

        Currency code, like EUR.

      • amount string

        Decimal string, like "19.90". Amount in this currency.

  • products array of object

    The products.

    4 Felder anzeigen Felder ausblenden
    • product object

      The product.

      2 Felder anzeigen Felder ausblenden
      • id integer

        The ID.

      • name string kann null sein

        The name.

    • active integer

      Active subscriptions.

    • cancelling integer

      Cancelled, with access until the end date.

    • mrr array of object

      One entry per currency. Amounts are not converted.

      2 Felder anzeigen Felder ausblenden
      • currency string

        Currency code, like EUR.

      • amount string

        Decimal string, like "19.90". Amount in this currency.

  • more_products boolean

    true = more products than this list.

  • from string<date>

    Like 2026-01-31.

  • to string<date>

    Like 2026-01-31.

  • periods array of object

    One entry per period.

    4 Felder anzeigen Felder ausblenden
    • period string

      Month, like 2026-01.

    • new integer

      New subscriptions.

    • ended_cancelled integer

      By the end of access.

    • ended_payment_failed integer

      By the last failed try.

  • warnings array of string

    Things that the seller should know.

  • links object

    Pages in the Tentary app or on tentary.com.

    1 Feld anzeigen Felder ausblenden
    • orders string<uri>

      Page in the Tentary app.

Tippe, um zu suchen.