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://mobile-docs.easyflow.digital/_mock/openapi/

Production environment URL

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

Authentication

Operations

Users

Operations

Organizations

Operations

Sales

Operations

Commissions

Operations

Financial

Operations

Subscriptions

Operations

Get subscription recurrence

Request

Security
bearerAuth
Path
subscriptionRecurrenceIdstringrequired
Headers
x-fingerprint-idstringrequired

Unique device or session fingerprint identifier used for security and fraud prevention.

business-idstringrequired

Business Identifier

curl -i -X GET \
  'https://mobile-docs.easyflow.digital/_mock/openapi/easyflow/subscription-recurrences/{subscriptionRecurrenceId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'business-id: string' \
  -H 'x-fingerprint-id: string'

Responses

Successful retrieval of subscription recurrence details

Bodyapplication/json
statusCodeinteger
Example: 200
dataobject
Response
application/json
{
  "statusCode": 200,
  "data": {
    "subscription": { … },
    "commissions": [ … ],
    "payments": [ … ],
    "recurrence": 2,
    "billingDate": "2025-06-27T03:00:00.000Z",
    "dueDate": "2025-09-27T03:00:00.000Z",
    "paidAt": "2025-08-27T18:39:22.125Z",
    "recurrenceValueInCents": 2000,
    "status": "paid"
  }
}