Skip to content

Easyflow (1.0)

Easyflow API Document

This is the API documentation and must be used by everyone who wants to integrate with the Easyflow platform.

Download OpenAPI description
openapi.json
openapi.yaml
Overview
License

Languages
Servers
Mock server

https://docs.easyflow.digital/_mock/openapi/

https://9iq81tsdy4.execute-api.sa-east-1.amazonaws.com/

Businesses

Operations

Refunds

Operations

Sales

Operations

Subscriptions

Operations

Filter subscription

Request

Returns a list of subscriptions.

Query
pagestringrequired

Page number to access

limitstringrequired

Number of items to be loaded per page

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

Bodyapplication/json

Optional Fields for Subscription Filtering

emailstring
namestring
initialDatestring
endDatestring
statusstring

Filter by the specified status, such as: active, inactive, canceled, expired

initialValueinteger
endValueinteger
typestring

Filter by the specified types, such as: credit-card, pix, bank-billet, crypto, debit-card

productIdsArray of strings
fieldstring
orderByobject
curl -i -X POST \
  'https://docs.easyflow.digital/_mock/openapi/subscriptions/filter?page=string&limit=string' \
  -H 'Content-Type: application/json' \
  -H 'business-id: string' \
  -H 'x-api-key: string' \
  -H 'x-api-secret: string' \
  -d '{
    "email": "string",
    "name": "string",
    "initialDate": "string",
    "endDate": "string",
    "status": "string",
    "initialValue": 0,
    "endValue": 0,
    "type": "string",
    "productIds": [
      "string"
    ],
    "field": "string",
    "orderBy": {
      "orderByField": "string",
      "orderDirection": "string"
    }
  }'

Responses

Returns a list of subscriptions.

Bodyapplication/json
statusCodeinteger
Example: 200
dataobject
Response
application/json
{
  "statusCode": 200,
  "data": {
    "docs": [ … ],
    "limit": 0,
    "currentPage": 0,
    "nextPage": 0,
    "totalPages": 0,
    "totalDocs": 0,
    "hasNext": true
  }
}

Get subscription

Request

Use it to get subscription

Path
subscriptionIdstringrequired
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.

curl -i -X GET \
  'https://docs.easyflow.digital/_mock/openapi/subscriptions/{subscriptionId}' \
  -H 'x-api-key: string' \
  -H 'x-api-secret: string'

Responses

returns the details of a signature

Bodyapplication/json
statusCodeinteger
Example: 200
dataobject
Response
application/json
{
  "statusCode": 200,
  "data": {
    "id": "string",
    "name": "string",
    "subscribedAt": "string",
    "periodicity": "string",
    "numberRecurrences": 0,
    "status": "string",
    "subscriptionPaymentStatus": "string",
    "customer": { … },
    "orderItem": { … },
    "recurrenceValueInCents": 0,
    "expiration": "string",
    "paymentMethod": "string",
    "creditCard": { … },
    "repeatIndefinitely": true,
    "customValue": { … },
    "recurrences": [ … ]
  }
}

Financials

Operations

Products

Operations

Orders

Operations

Customers

Operations

Pixel

Operations