Filter subscription

POST/subscriptions/filter

Returns a list of subscriptions.

Request

curl --request POST \
  --url 'https://9iq81tsdy4.execute-api.sa-east-1.amazonaws.com/subscriptions/filter?page=1&limit=10' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'x-api-secret: YOUR_API_SECRET' \
  --header 'business-id: YOUR_BUSINESS_ID' \
  --header 'Content-Type: application/json' \
  --data '{
  "email": "maria@example.com",
  "name": "Maria",
  "initialDate": "2024-09-11T00:00:00.000Z",
  "endDate": "2024-12-13T23:00:00.00Z",
  "status": "active",
  "initialValue": 10,
  "endValue": 9000,
  "type": "credit-card",
  "productIds": [
    "5c7e9a1c-3e5a-4c9e-8a3c-5e7a9c1e0019"
  ],
  "field": "52",
  "orderBy": {
    "orderByField": "createdAt",
    "orderDirection": "ASC"
  }
}'

const response = await fetch('https://9iq81tsdy4.execute-api.sa-east-1.amazonaws.com/subscriptions/filter?page=1&limit=10', {
  method: 'POST',
  headers: {
    'x-api-key': 'YOUR_API_KEY',
    'x-api-secret': 'YOUR_API_SECRET',
    'business-id': 'YOUR_BUSINESS_ID',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "email": "maria@example.com",
    "name": "Maria",
    "initialDate": "2024-09-11T00:00:00.000Z",
    "endDate": "2024-12-13T23:00:00.00Z",
    "status": "active",
    "initialValue": 10,
    "endValue": 9000,
    "type": "credit-card",
    "productIds": [
      "5c7e9a1c-3e5a-4c9e-8a3c-5e7a9c1e0019"
    ],
    "field": "52",
    "orderBy": {
      "orderByField": "createdAt",
      "orderDirection": "ASC"
    }
  }),
});

const data = await response.json();
console.log(data);

import requests

url = "https://9iq81tsdy4.execute-api.sa-east-1.amazonaws.com/subscriptions/filter?page=1&limit=10"
headers = {
    "x-api-key": "YOUR_API_KEY",
    "x-api-secret": "YOUR_API_SECRET",
    "business-id": "YOUR_BUSINESS_ID",
}
payload = {
    "email": "maria@example.com",
    "name": "Maria",
    "initialDate": "2024-09-11T00:00:00.000Z",
    "endDate": "2024-12-13T23:00:00.00Z",
    "status": "active",
    "initialValue": 10,
    "endValue": 9000,
    "type": "credit-card",
    "productIds": [
        "5c7e9a1c-3e5a-4c9e-8a3c-5e7a9c1e0019",
    ],
    "field": "52",
    "orderBy": {
        "orderByField": "createdAt",
        "orderDirection": "ASC",
    },
}

response = requests.post(url, headers=headers, json=payload)
print(response.json())

Response

{
  "statusCode": 200,
  "data": {
    "docs": [
      {
        "id": "2f4b6d8f-0b2d-4f6b-8d0f-2b4d6f8b0016",
        "name": "Premium plan",
        "origin": "offer",
        "periodicity": "Quarterly",
        "numberRecurrences": 12,
        "status": "canceled",
        "subscriptionPaymentStatus": "pending",
        "customer": {
          "name": "Maria Silva",
          "email": "maria@example.com",
          "phone": {
            "areaCode": "+55",
            "ddd": "11",
            "number": "912345678",
            "isMobile": true
          },
          "billingAddress": {
            "zipCode": "01310100",
            "street": "Avenida Paulista",
            "number": "1000",
            "complement": "Apartment 12",
            "neighborhood": "Bela Vista",
            "city": "São Paulo",
            "state": "SP"
          },
          "deliveryAddress": {
            "zipCode": "01310100",
            "street": "Avenida Paulista",
            "number": "1000",
            "complement": "Apartment 12",
            "neighborhood": "Bela Vista",
            "city": "São Paulo",
            "state": "SP"
          },
          "document": {
            "type": "CPF",
            "number": "12345678909"
          },
          "userId": "3a5c7e9a-1c3e-4a7c-8e1a-3c5e7a9c0017",
          "externalReferenceId": "any_customerId"
        },
        "recurrenceValueInCents": 9000,
        "expiration": "2025-12-10T03:00:00.000Z",
        "paymentMethod": "credit-card",
        "creditCard": {
          "nickname": "visa",
          "last4Numbers": "1234",
          "holderName": "MARIA SILVA",
          "expiresAtMonth": 1,
          "expiresAtYear": 2035,
          "flag": "visa"
        },
        "orderItem": {
          "id": "4b6d8f0b-2d4f-4b8d-8f2b-4d6f8b0d0018",
          "product": {
            "id": "5c7e9a1c-3e5a-4c9e-8a3c-5e7a9c1e0019",
            "name": "Premium plan"
          },
          "unitValueInCents": 9000,
          "quantity": 1
        },
        "repeatIndefinitely": false,
        "createdAt": "2024-11-27T19:19:23.356Z",
        "subscribedAt": "2024-12-13T18:34:13.589Z",
        "customValue": {
          "recurrenceFrom": null,
          "recurrenceTo": null,
          "valueInCents": null
        },
        "nextPayment": "2025-08-27T03:00:00.000Z"
      }
    ],
    "limit": 1,
    "currentPage": 1,
    "nextPage": 2,
    "totalPages": 20,
    "totalDocs": 20,
    "hasNext": true
  }
}

{
  "message": "Invalid param: []",
  "error": "Bad Request",
  "statusCode": 400,
  "errorCode": "string"
}

Generated from the schema

{
  "message": "Unauthorized",
  "error": "Unauthorized",
  "statusCode": 401
}

Generated from the schema

{
  "message": "Forbidden resource",
  "error": "Forbidden",
  "statusCode": 403
}

Generated from the schema

{
  "statusCode": 500,
  "message": "Internal Server Error"
}

Generated from the schema

Headers

x-api-keystringrequired
Api key provided on integrations tab in Easyflow platform.
x-api-secretstringrequired
Api Secret provided on integrations tab in Easyflow platform.
business-idstringrequired
Business Identifier