This page describes the most common flows. Each step links to the relevant API Reference entry.Documentation Index
Fetch the complete documentation index at: https://piriod-d406ac55.mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
1. One-shot billing: customer → invoice → payment
Create a customer
POST
/customers/ with name, address, country, state and (when applicable)
tax_id + tax_settings. The response includes a customer id you will reuse below.Issue an invoice
POST
/invoices/ with the customer id and the line items. The invoice starts
in draft status.Finalize the invoice
Call the
finalize action on the invoice to send it to the tax agency
(when applicable) and lock its content.2. Recurring billing with subscriptions
Define your catalog
Create products at
/products/, plans at /plans/ and optional add-ons or
coupons.Subscribe a customer
POST
/subscriptions/ with the customer, the plan and the chosen frequency.
Piriod will compute the next billing date.Generate invoices automatically
Each cycle Piriod generates the invoice; the matching webhook event lets you
react. You can also call the
process action manually.3. Hosted payment links
Create a link
POST
/payment_links/links/ with the amount and currency. Capture the
publishable_key from the response.Share the hosted page
Send
/publishable/payment_links/links/{key}/hosted/ to the payer. They
complete the checkout in Piriod-hosted UI.4. Procurement: receive supplier documents
Record a purchase
POST
/purchases/ (or /purchases/credit-notes/ for credit notes) with the
supplier and line items.