Analytics

Transaction breakdown

USD-normalised successful-payment totals grouped by one dimension: plan, payment_provider, currency or project. dimension is required.

curl "https://api.subscriby.net/v1/analytics/transactions/breakdown?dimension=payment_provider&period=90d" \
  -H "Authorization: Bearer $SUBSCRIBY_TOKEN"
get/v1/analytics/transactions/breakdown

Request

  • Base URL: https://api.subscriby.net
  • URL: https://api.subscriby.net/v1/analytics/transactions/breakdown
  • Auth: HTTP bearer

Query parameters

dimensionstring required

What to group the settled revenue by: plan, payment_provider, currency or project. Required.

project_idstring uuid

Scope the figures to one project the token may see; omit for every project visible to it. A project outside the token's scope:project: allow-list is 404 TENANT_MISMATCH, an unknown one 404 RESOURCE_NOT_FOUND.

periodstring

The preset window: 7d, 14d, 30d (the default), 60d, 90d, mtd, qtd, ytd, 1y or all. Ignored when both from and to are given; an unknown value falls back to the default rather than failing.

fromstring date

The first day of an explicit window, YYYY-MM-DD. Both from and to are needed to override period.

tostring date

The last day of an explicit window, YYYY-MM-DD. Both from and to are needed to override period.

plan_ids[]string[]

Count only these plans. Send it as plan_ids[]=a&plan_ids[]=b or as one comma-separated string.

statuses[]string[]

Count only payments in these states: successful, failed, pending, refunded. Send them as statuses[]=a&statuses[]=b or as one comma-separated string.

payment_method_ids[]string[]

Count only payments taken through these payment methods. Send them as payment_method_ids[]=a&payment_method_ids[]=b or as one comma-separated string.

Response

Gross revenue grouped by the dimension.

Example response

{
  "data": {
    "range": {
      "from": "2026-06-14",
      "to": "2026-09-12"
    },
    "dimension": "payment_provider",
    "total_gross_usd": 4210.5,
    "groups": [
      {
        "key": "stripe",
        "label": "Stripe",
        "gross_usd": 3120,
        "transactions": 104,
        "share_percent": 74.1
      }
    ]
  },
  "meta": {
    "period": "90d",
    "dimension": "payment_provider"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.