/
PI
piriod
/
Piriod API
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Checked 19h ago · Updated 3w ago
Details
Filter operations
Billing
124
get
List contacts
post
Create contact
get
Retrieve contact
put
Replace contact
delete
Delete contact
patch
Partial update contact
get
List credit notes
post
Create credit note (draft)
get
Retrieve credit note
put
Replace credit note (draft only)
delete
Delete credit note (draft only)
patch
Partial update credit note (draft only)
get
Finalize credit note
get
Render credit-note PDF
get
Refresh tax-agency status
get
List customers
post
Create customer
get
Retrieve customer
put
Replace customer
delete
Delete customer
patch
Partial update customer
get
Customer status snapshot
get
List debit notes
post
Create debit note
get
Retrieve debit note
put
Replace debit note
delete
Delete debit note
patch
Partial update debit note
get
Render debit-note PDF
get
Refresh tax-agency status
get
List invoices
post
Create invoice (draft)
get
Retrieve invoice
put
Replace invoice (draft only)
delete
Delete invoice (draft only)
patch
Partial update invoice (draft only)
get
Finalize invoice
get
Toggle uncollectible
get
Render invoice PDF
get
Refresh tax-agency status
get
List organisation units
post
Create org unit
get
Retrieve org unit
put
Replace org unit
delete
Delete org unit
patch
Partial update org unit
get
List payment receipts
post
Create payment receipt (draft)
get
Retrieve payment receipt
put
Replace payment receipt (draft only)
delete
Delete payment receipt (draft only)
patch
Partial update payment receipt (draft only)
get
Finalize payment receipt
get
Render payment-receipt PDF
get
Refresh tax-agency status
get
List frequencies
get
Retrieve frequency
get
List products
post
Create product
get
Retrieve product
put
Replace product
delete
Archive product
patch
Partial update product
get
List plans
post
Create plan
get
Retrieve plan
put
Update plan (mutable fields)
delete
Archive plan
patch
Partial update plan (mutable fields)
get
List addons
post
Create addon
get
Retrieve addon
put
Replace addon
delete
Archive addon
patch
Partial update addon
get
List coupons
post
Create coupon
get
Retrieve coupon
put
Replace coupon
delete
Archive coupon
patch
Partial update coupon
get
List subscriptions
post
Create subscription
get
Retrieve subscription
put
Replace subscription
delete
Cancel subscription
patch
Partial update subscription
get
Process next billing cycle
post
Pause subscription
post
Resume subscription
get
List subscription events
get
Render the next-invoice PDF
get
List rules
post
Create rule
get
Retrieve rule
put
Replace rule
delete
Delete rule
patch
Partial update rule
get
List supporting documents
post
Upload supporting document
get
Retrieve supporting document
put
Replace supporting document
delete
Delete supporting document
patch
Partial update supporting document
get
Get document file (base64)
post
Archive supporting document
get
List service entries
post
Create service entry
get
Retrieve service entry
put
Replace service entry
delete
Delete service entry
patch
Partial update service entry
get
List submission requests
post
Create submission request
get
Retrieve submission request
put
Replace submission request
delete
Delete submission request
patch
Partial update submission request
post
Send submission-request email
post
Cancel submission request
get
Supporting-documents Kanban board
get
List usages
post
Record usage
get
List intents
Collections
7
Payments
60
Procurement
45
Billing
Replace product
put
/products/{id}/
Request body
Product
required
id
string
name
string
required
unit_label
string
required
status
'active'
|
'archived'
archived
string
date-time
nullable
plans
Plan[]
test_mode
boolean
created
string
date-time
updated
string
date-time
Response
Updated product.
Product
required
id
string
name
string
required
unit_label
string
required
status
'active'
|
'archived'
archived
string
date-time
nullable
plans
Plan[]
test_mode
boolean
created
string
date-time
updated
string
date-time
Changes