subscriptions.overview

Cartões das assinaturas. Receita das assinaturas (compras aprovadas), assinantes únicos, ticket médio por assinante, ativas, receita recorrente mensal, total, trial (sempre 0: sem fonte), cancelamentos, taxa de churn (cancelamentos sobre o total, em %) e inadimplentes (assinatura com cobrança atrasada) com os valores.

Endpoint: POST https://app.atomiks.com.br/api/v1/subscriptions.overview (corpo JSON)
Quem pode chamar: membro da conta
Escopo da chave: crm:read
Grava dados: não
Pela chave de API: sim
Ferramenta MCP: subscriptions_overview
Ficha em JSON: https://app.atomiks.com.br/api/v1/openapi.json (operationId subscriptions.overview)

Entrada

Campo	Tipo	Obrigatório	Nota
`filters`	object	não

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "filters": {
      "type": "object",
      "properties": {
        "searchText": {
          "type": "string",
          "maxLength": 200
        },
        "contactName": {
          "type": "string",
          "maxLength": 200
        },
        "contactEmail": {
          "type": "string",
          "maxLength": 200
        },
        "contactDocument": {
          "type": "string",
          "maxLength": 200
        },
        "transactionShortenId": {
          "type": "string",
          "maxLength": 200
        },
        "subscriptionStartedPeriod": {
          "type": "object",
          "properties": {
            "from": {
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            },
            "to": {
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            },
            "period": {
              "type": "string",
              "maxLength": 8
            }
          }
        },
        "membershipPeriod": {
          "type": "object",
          "properties": {
            "from": {
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            },
            "to": {
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            },
            "period": {
              "type": "string",
              "maxLength": 8
            }
          }
        },
        "subscriptionCreatedPeriod": {
          "type": "object",
          "properties": {
            "from": {
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            },
            "to": {
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            },
            "period": {
              "type": "string",
              "maxLength": 8
            }
          }
        },
        "contactStatus": {
          "maxItems": 200,
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 120
          }
        },
        "contactTags": {
          "maxItems": 200,
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 120
          }
        },
        "utmSource": {
          "maxItems": 200,
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 120
          }
        },
        "utmMedium": {
          "maxItems": 200,
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 120
          }
        },
        "utmCampaign": {
          "maxItems": 200,
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 120
          }
        },
        "utmTerm": {
          "maxItems": 200,
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 120
          }
        },
        "utmContent": {
          "maxItems": 200,
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 120
          }
        },
        "subscriptionStatus": {
          "maxItems": 5,
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "active_trial",
              "active_paid",
              "active_trial_expired",
              "canceled",
              "ended"
            ]
          }
        },
        "transactionStatus": {
          "maxItems": 10,
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "pending",
              "paid",
              "canceled",
              "refunded",
              "chargedBack",
              "failed"
            ]
          }
        },
        "projectIds": {
          "maxItems": 200,
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 120
          }
        },
        "productIds": {
          "maxItems": 200,
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 120
          }
        },
        "offerIds": {
          "maxItems": 200,
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 120
          }
        },
        "transactionRecurrence": {
          "type": "string",
          "enum": [
            "OneTime",
            "Recurrent",
            "Trial"
          ]
        },
        "currency": {
          "maxItems": 10,
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 3
          }
        },
        "valueOfLastPurchase": {
          "type": "object",
          "properties": {
            "min": {
              "type": "number",
              "minimum": 0,
              "maximum": 100000
            },
            "max": {
              "type": "number",
              "minimum": 0,
              "maximum": 100000
            }
          }
        },
        "transactionType": {
          "maxItems": 3,
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "credit",
              "pix",
              "boleto"
            ]
          }
        },
        "subscriptionPlan": {
          "maxItems": 4,
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "1",
              "3",
              "6",
              "12"
            ]
          }
        }
      }
    }
  }
}

Exemplo

curl -X POST https://app.atomiks.com.br/api/v1/subscriptions.overview \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

CLI:

node cli/atomiks.mjs subscriptions.overview --json '{}'

MCP: ferramenta subscriptions_overview com a mesma entrada.

Saída

Sucesso: {"data": ...} com o formato abaixo.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "totalValueSubscriptions": {
      "type": "number"
    },
    "totalNetValueSubscriptions": {
      "type": "number"
    },
    "totalUniqueSubscribers": {
      "type": "number"
    },
    "averageTicketPerSubscriber": {
      "type": "number"
    },
    "totalActiveSubscriptions": {
      "type": "number"
    },
    "monthlyRecurringRevenue": {
      "type": "number"
    },
    "totalSubscriptions": {
      "type": "number"
    },
    "totalTrialSubscriptions": {
      "type": "number"
    },
    "trialPercentage": {
      "type": "number"
    },
    "totalPotentialRevenue": {
      "type": "number"
    },
    "totalCancelledSubscriptions": {
      "type": "number"
    },
    "churnRate": {
      "type": "number"
    },
    "totalValueCancelledSubscriptions": {
      "type": "number"
    },
    "totalDefaulterSubscriptions": {
      "type": "number"
    },
    "totalDefaulterValue": {
      "type": "number"
    }
  },
  "required": [
    "totalValueSubscriptions",
    "totalNetValueSubscriptions",
    "totalUniqueSubscribers",
    "averageTicketPerSubscriber",
    "totalActiveSubscriptions",
    "monthlyRecurringRevenue",
    "totalSubscriptions",
    "totalTrialSubscriptions",
    "trialPercentage",
    "totalPotentialRevenue",
    "totalCancelledSubscriptions",
    "churnRate",
    "totalValueCancelledSubscriptions",
    "totalDefaulterSubscriptions",
    "totalDefaulterValue"
  ],
  "additionalProperties": false
}

Erros

{"error": {"code", "message", "requestId"}}. Códigos: invalid_input (400), unauthorized (401), forbidden / account_pending / scope_missing (403), not_found (404), limit_reached (409), internal (500).