ZapSign API
English
English
  • General Information
  • Getting Started
  • ZapSign Environments
  • Ready-to-use requests!
  • Authentication
    • Static token
    • JWT Authentication
      • Get access token
      • Refresh your access token
  • Types of Tokens
  • API versioning
  • Rate Limit Policies
  • Incident alerts
  • How Payment Works
  • Status Code
  • Account
    • Plan Information
    • List account users
    • Create account users
    • Delete account user
  • Documents
    • Create document via Upload
    • OneClick (ClickWrap)
      • Create document (OneClick)
    • Create document via Template
    • Add attachment (extra document)
    • Add attachment (extra document) via Template
    • Detail document
    • List documents
    • Delete document
    • Document Audit Trail
    • Optional: Place signatures
    • Reject Documents
  • Signers
    • Detail signer
    • Update signer
    • Add signer
    • Delete signer
    • Batch sign via API
    • Reject Documents by User
  • Templates
    • Create template (DOCX)
      • Configure Template Form
    • List templates
    • Get template
    • Update template
    • Delete template
  • Partnerships
    • Update Payment Status
    • Create Account
  • TIMESTAMP
    • Add timestamp
  • Background Check
  • Introduction
  • Understanding the Result
  • Creating a Background Check
    • Person Check
    • Company check
  • Retrieve a Check
  • Check details
  • Webhooks
    • How webhooks works
    • Testing webhooks on ZapSign
    • Create Webhook
    • Webhooks logs
    • Events
      • Document
        • Doc created
        • Doc deleted
        • Created signer
      • Signer
        • Signature request send
        • Document viewed
        • Reading confirmation
        • Doc signed
        • Doc refused
        • Email bounce
        • Failed Validation
      • Background check
        • Background check completed
    • Reprocessing Documents and Webhooks
    • Delete Webhook
  • Widget
    • How widget works
Powered by GitBook
On this page

Was this helpful?

  1. Account

Plan Information

PreviousStatus CodeNextList account users

Last updated 5 months ago

Was this helpful?

To facilitate the management of your plan, you can directly consult detailed information about its status and available credits via the API. This endpoint provides essential data on the current plan, giving you more autonomy to track its status and manage usage effectively. Endpoint:GET https://api.zapsign.com.br/api/v1/info-plan

Headers

Name
Type
Description

Authorization*

string

API token prefixed with the word "Bearer". Ex: Bearer c7f35c84-7893-4087-b4fb-d1f06c23

Plan information

This endpoint returns information about the plan, including:

  • Plan name (name)

  • Number of credits in the account (number_of_credits)

  • Plan status (status): can be paid, pending_payment, unpaid, or canceled

  • Period (period): monthly (monthly) or annual (annual)

  • End date of the current period (current_period_end)

Example Response

{
    "name": "Test Plan",
    "number_of_credits": "100",
    "status": "paid",
    "period": "annual",
    "current_period_end": "dd-mm-yyyy"
}

Unable to find information about this plan