User Guide

This guide explains the features and usage of pdfme Cloud for its users. For detailed information about the API, please refer to the API Documentation.

Important: To use pdfme Cloud, you first need to sign in. If you don't have an account yet, please create one from the sign-up page.

Account Dashboard

After logging in, the account dashboard will be displayed. The account dashboard is divided into the following sections:

1. My Projects

A list of projects you own or participate in is displayed. Projects are used to manage and configure templates for generating PDF files.

• If you're accessing for the first time: No projects have been created. Click the New Project button to create a new project.
• If projects have already been created: You can navigate to the project dashboard or copy the API Key.

⚠️ Note: The API Key is used for authentication in the Web API. Please manage it strictly to maintain security and prevent others from knowing it.

Create a New Project

• There is no limit to the number of projects you can create, regardless of your subscription plan.
• When you create a project, you automatically become the owner of that project.

The following information is required to create a project:

Information	Description
Project Name	(required)
Members	(optional)
Schemas	The selected data types can be used in the Template Designer within the project.
Fonts	The selected fonts can be used in the Template Designer within the project. Fonts set as fallbacks are used when no font is specified in text schemas, etc.

💡 Tip: For projects creating templates that mainly use a specific language (e.g., Japanese), it's good to set an appropriate font supporting that language as the fallback.

If the schemas or fonts you want to use are not available, please contact us through the contact page.

2. Account Level Analytics

While pdfme Cloud is billed per account, this screen allows you to check the API request count for the past 12 months for all projects you own.

⚠️ Important: If you reach the monthly API request limit of your subscription plan, API requests to each project will be rejected.

By checking the API request count on this page, you can determine if your current plan is appropriate. For project-specific analytics, please refer to Project Level Analytics.

3. Account Setting & Billing

You can check and edit account settings and billing information.

Personal Information

• Change your account name and email address
• For logins from third-party applications, you cannot change the email address
• To update your password, go to the Change Password page (Log in required)

Billing

• Check the status and plan of your current subscription
• Navigate to the customer portal to cancel subscriptions, change plans, etc.

If you are not subscribed, all API requests will return the following error:

Status: 402 Payment Required

{
  "message": "Payment required: https://app.pdfme.com/pricing"
}

To subscribe to a plan:

1. Select a plan from the pricing page
2. Start with a trial (no credit card required)
3. If satisfied, select a plan from the customer portal
4. Register your credit card information
5. Start your subscription

⚠️ Note: If you don't subscribe during the trial period, API requests will be rejected after the period ends.

Delete account

To delete your account:

1. Click the Delete Account button
2. Confirm the following:
   • Your subscription has been canceled
   • All projects you own have been deleted or inactivated

⚠️ Warning: This operation cannot be undone. All related data will be deleted and you will no longer be able to log in.

Project Dashboard

In the project dashboard, you can:

• Create and manage templates
• Check the project's API request count
• Edit project settings

Templates

A list of templates created in this project is displayed. Templates are used to define the data structure for generating PDF files.

• If you're accessing for the first time: No templates have been created. Click the New Template button to create a new template.

Create a New Template

There is no limit to the number of templates you can create, regardless of your subscription plan.

Required information:

Item	Description
Template Name	Name of the template (required)
Status	Status of the template
Description	Description of the template (optional)
Tags	Tags for the template (optional)
Base PDF Type	Type of base PDF (required)

Base PDF Type Options:

1. Start from Existing PDF
   • Upload a PDF file (max 10MB)
   • Cannot use schemas such as tables
2. Start from Blank PDF
   • Specify size and padding
   • Create entirely from scratch

💡 Tip: You can change this information at any time from Template Designer > More > Change Template Settings.

Need help with template creation? Feel free to reach out through our contact page. We're here to assist and can even discuss our professional template design services if you need extra support.

Project Level Analytics

Check the API request count for the past 12 months of the currently displayed project.

Project Settings

General Information

Item	Description
Project Name
Status	Inactive projects do not accept API requests
API Key	Rotate by clicking the Reset API Key button

Plan

• Check the current plan
• Affects API request limit for all projects owned by the owner
• Only the owner can change the plan from Account Setting & Billing > Billing

Members

• Manage project participants
• Add members to manage templates with multiple people
• Invited members join via email link

PDF Designer Settings

Change schema and font settings to affect:

• Creating new templates
• Editing existing templates

⚠️ Note: Schemas and fonts used in existing templates will not be changed.

If needed schemas or fonts are unavailable, contact us through the contact page.

Delete Project

1. Click the Delete Project button
2. Confirm deletion (cannot be undone)

⚠️ Warning: After deletion, you cannot access the project page or Web API.

Template Designer

A tool for creating and editing PDF generator templates.

Features:

• Select and place elements (text, images, tables, barcodes) from the left sidebar
• Basic operations: copy, paste, undo, redo, alignment
• Draw guides from rulers for accurate placement

💡 Tip: Can't find the schema you need in the left sidebar or the font name you want in the Text schema options? Head over to the PDF Designer Settings to customize your available schemas and fonts.*

Menu items:

• Preview: View the created PDF file
• Code: View sample PDF creation API code
• Save: Save the template
• More:
  • Change Template Settings
  • Change PDF Designer Settings
  • Copy ID
  • Duplicate
  • Delete

If you want to integrate the Template Designer into your web application, please refer to the Widgets API.

Use Web API

Use the Web API to manage templates and generate PDF files from external applications. For API details, refer to the API Documentation.