GraphQL Schema

Plirin’s API is built on GraphQL, giving you precise control over what data you request. The schema includes types for all major entities: merchants, transactions, invoices, products, customers, and more.

Key types

Type	Description
Merchant	Your business account — profile, settings, wallets
Transaction	A completed payment with on-chain details
Invoice	An invoice with line items, status, and payment info
Product	A catalog product
Price	A pricing configuration for a product
Customer	A customer record
Refund	A refund request and its status
WebhookEndpoint	A configured webhook receiver
MerchantVatRate	A merchant-defined VAT rate preset (domestic EU VAT invoicing)

Note

Refund.approvedBy is now a StaffOrMerchant union (previously Staff), since a refund can be approved by either a staff member or the merchant owner.

Schema exploration

The API supports GraphQL introspection. Use any GraphQL client (Apollo Studio, Insomnia, Postman) to explore the full schema:

query {
  __schema {
    types {
      name
      description
    }
  }
}

Queries Read data — transactions, invoices, products, and more.

Mutations Create and modify — invoices, payments, refunds, and more.