subscriptions.list

Listar assinaturas. Assinaturas das plataformas integradas (Hotmart, Kiwify...), uma por código de assinatura, com assinante, plano, valor, periodicidade, última e próxima cobrança. status: active_paid ou canceled (trial e encerrada não têm fonte). Ordenação por column (activationDate, offerName, frequency, price, buyerName ou status) e order.

Endpoint: POST https://app.atomiks.com.br/api/v1/subscriptions.list (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_list
Ficha em JSON: https://app.atomiks.com.br/api/v1/openapi.json (operationId subscriptions.list)

Entrada

Campo	Tipo	Obrigatório
`filters`	object	não
`page`	integer	não
`perPage`	integer	não
`column`	"activationDate" \| "offerName" \| "frequency" \| "price" \| "buyerName" \| "status"	não
`order`	"asc" \| "desc"	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"
            ]
          }
        }
      }
    },
    "page": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100000
    },
    "perPage": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "column": {
      "type": "string",
      "enum": [
        "activationDate",
        "offerName",
        "frequency",
        "price",
        "buyerName",
        "status"
      ]
    },
    "order": {
      "type": "string",
      "enum": [
        "asc",
        "desc"
      ]
    }
  }
}

Exemplo

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

CLI:

node cli/atomiks.mjs subscriptions.list --json '{"page":1,"perPage":50}'

MCP: ferramenta subscriptions_list com a mesma entrada.

Saída

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

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "code": {
            "type": "string"
          },
          "status": {
            "type": "string",
            "enum": [
              "active_trial",
              "active_paid",
              "active_trial_expired",
              "canceled",
              "ended"
            ]
          },
          "subscriber": {
            "type": "object",
            "properties": {
              "name": {
                "type": "string"
              },
              "email": {
                "type": "string"
              }
            },
            "required": [
              "name",
              "email"
            ],
            "additionalProperties": false
          },
          "leadId": {
            "type": [
              "string",
              "null"
            ]
          },
          "plan": {
            "type": "string"
          },
          "frequency": {
            "type": "string",
            "enum": [
              "daily",
              "weekly",
              "biweekly",
              "monthly",
              "bimonthly",
              "quarterly",
              "semiannual",
              "yearly"
            ]
          },
          "price": {
            "type": "number"
          },
          "discountAmount": {
            "type": "number"
          },
          "commission": {
            "type": "number"
          },
          "activationDate": {
            "type": "string"
          },
          "lastPurchase": {
            "type": [
              "string",
              "null"
            ]
          },
          "nextBillingAt": {
            "type": [
              "string",
              "null"
            ]
          },
          "expiresTrialAt": {
            "type": [
              "string",
              "null"
            ]
          },
          "purchaseCount": {
            "type": "number"
          },
          "chargeLimit": {
            "anyOf": [
              {
                "type": "object",
                "properties": {
                  "paidCharges": {
                    "type": "number"
                  },
                  "maxCharges": {
                    "type": "number"
                  }
                },
                "required": [
                  "paidCharges",
                  "maxCharges"
                ],
                "additionalProperties": false
              },
              {
                "type": "null"
              }
            ]
          },
          "gateway": {
            "type": "string"
          },
          "paymentMethod": {
            "anyOf": [
              {
                "type": "string",
                "enum": [
                  "credit",
                  "pix",
                  "boleto"
                ]
              },
              {
                "type": "null"
              }
            ]
          },
          "isPixRecurring": {
            "type": "boolean"
          },
          "currency": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "code",
          "status",
          "subscriber",
          "leadId",
          "plan",
          "frequency",
          "price",
          "discountAmount",
          "commission",
          "activationDate",
          "lastPurchase",
          "nextBillingAt",
          "expiresTrialAt",
          "purchaseCount",
          "chargeLimit",
          "gateway",
          "paymentMethod",
          "isPixRecurring",
          "currency"
        ],
        "additionalProperties": false
      }
    },
    "meta": {
      "type": "object",
      "properties": {
        "page": {
          "type": "number"
        },
        "perPage": {
          "type": "number"
        },
        "countItens": {
          "type": "number"
        },
        "countPages": {
          "type": "number"
        }
      },
      "required": [
        "page",
        "perPage",
        "countItens",
        "countPages"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "data",
    "meta"
  ],
  "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).