Partnership plans inquiry (CSV)

This endpoint allows exporting a CSV file containing plan information and usage metrics for the authenticated account and its linked partner accounts. It is useful for tracking, in a single file, data such as account name, brand, current plan, credit balance, subscription status, plan period, and usage metrics within the queried interval.

Endpoint

GET https://api.zapsign.com.br/api/v1/info-plan/partners-csv/

Query Parameters

Name	Type	Description
start_date	string	Start date of the queried period (YYYY-MM-DD). Optional.
end_date	string	End date of the queried period (YYYY-MM-DD). Optional.

Period Rules:

• The maximum allowed range is 30 days.
• If no parameters are sent, the endpoint considers the last 30 days.
• If only start_date is sent, end_date will be assumed as the current date.
• If only end_date is sent, start_date will be assumed as 30 days before the current date.

Headers

• Authorization: Bearer YOUR_API_TOKEN

CSV Columns

The file contains one row for the authenticated account and one row for each linked partner:

• id, name, brand_name: Account identification and branding.
• plan_name, credits, status: Plan name, credit balance, and subscription status.
• period, current_period_end: Plan periodicity (monthly/annual) and cycle end date.
• Usage metrics: documents_created, envelopes_created, qty_sms, qty_whatsapp, qty_digital_certificate, qty_biometry_sov, qty_facial_recognition, qty_identity_verification, qty_liveness.

Request Example (curl)

Bash

curl --request GET \
  --url 'https://api.zapsign.com.br/api/v1/info-plan/partners-csv/?start_date=2026-03-01&end_date=2026-03-04' \
  --header 'Authorization: Bearer YOUR_API_TOKEN'

Error Responses

400 - Invalid parameters

This can happen if the date format is incorrect, the range exceeds 30 days, or the start date is after the end date.

Example of range error:

JSON

{
  "non_field_errors": [
    "Date range cannot exceed 30 days"
  ]
}

401 - Unauthenticated

Occurs when the API token is invalid or missing.

JSON

{
  "detail": "Invalid API token."
}

---

D