Jump to Content
Guides
Discussions
Home
Guides
Recipes
API Reference
Changelog
Discussions
v1.0
Guides
Discussions
API Reference
v1.0
API Reference
List API keys
Search
All
Pages
Start typing to search…
JUMP TO
quick start
Introduction to the Inspire API
Response codes
Try it out
Authentication Endpoints
Authentication
Authenticate a tenant
post
Log out a tenant
post
Refresh a token
post
Request a new password
post
Generate a recovery token
post
Validate a token
post
API key sign-in
post
API authentication refresh token
post
API keys
Create an API key
post
List API keys
get
Retrieve an API key
get
Update an API key
patch
Tenant Endpoints
Agencies and tenants
Agencies
Agency object
List agencies
get
Create an agency
post
Retrieve an agency
get
Update an agency
put
Delete an agency
delete
Upload a logo
post
Tenant
Tenant object
List tenants
get
Create a tenant
post
Get terms of service
get
List tenants by keyword
get
List public tenants
get
Retrieve a tenant
get
Update a tenant
patch
Delete a tenant
delete
Upload a logo
post
Update public info
patch
Tenant status types
List tenant status types
get
Get a tenant status type
get
Tenant modules
List tenant-modules
get
Create a tenant-module
post
Retrieve a tenant-module
get
Update a tenant-module
patch
Delete a tenant-module
delete
Upload a logo image
post
Tenant languages
List a tenant-language
get
Create a tenant-language
post
Retrieve a tenant-language
get
Update a tenant-language
patch
Delete a tenant-language
delete
Tenant currencies
List tenant-currencies
get
Create a tenant-currency
post
Retrieve a tenant-currency
get
Update a tenant-currency
patch
Delete a tenant-currency
delete
Tenant email templates
List tenant email templates
get
Create a tenant email template
post
Retrieve a tenant email template
get
Update a tenant email template
patch
Delete a tenant email template
delete
Find a template by slug
get
User Endpoints
About users and permissions
User
List users
get
Create user
post
Retrieve user
get
Update user
patch
Delete user
delete
Link user to tenant
post
Find user by email
get
User permissions by email
get
Admin user
List admin users
get
Retrieve admin user
get
Update admin user
patch
Modules
About modules
List modules
get
Create module
post
Retrieve module
get
Update module
patch
Delete module
delete
Roles
About roles
List roles
get
Create role
post
Retrieve role
get
Update role
patch
Delete role
delete
Add team member to role
post
Permissions
Permission object
List permissions
get
Create permission
post
Retrieve permission
get
Update permission
patch
Delete permission
delete
Subjects
About subjects
List subjects
get
Create subject
post
Retrieve subject
get
Update subject
patch
Delete subject
delete
Actions
Action object
List actions
get
Create action
post
Retrieve action
get
Update action
patch
Delete action
delete
Customer Endpoints
About сustomers
Customers
Customer objects
List customers
get
Create customer
post
Get customer details
get
Update customer
patch
Delete customer
delete
Customer accepted terms
get
Update metadata
patch
Update default coupon
patch
Payment methods
Payment Method object
List payment methods
get
Add payment method v.1
post
Add payment method v.2
post
Retrieve payment method
get
Update payment method
patch
Delete payment method
delete
Set default payment method
patch
Payment cards
Payment Card object
List payment cards
get
Add payment card
post
Get payment card
get
Update payment card
patch
Delete payment card
delete
Customer bank accounts
Retrieve customer account
get
Add customer's bank account
post
List account holder types
get
Product Endpoints
About Products
Products
List products
get
Create Product.
post
Upload image
post
Get product
get
Update product
patch
Delete product
delete
Favorite product
post
Remove favorite product
delete
Product prices
About Product Prices
List of product prices
get
Create product price
post
Get product price
get
Update product price
patch
Delete product price
delete
Pricing models
About pricing models
List pricing models
get
Coupons
About coupons
List coupons
get
Create coupon
post
Get coupon
get
Update coupon
patch
Delete coupon
delete
Get coupon by code
get
Validate coupon
get
Coupon Code object
List coupon codes
get
Create coupon code
post
Get coupon code
get
Archive coupon code
patch
Unarchive coupon code
patch
Edit metadata
patch
Subscription Endpoints
About Subscriptions
Subscriptions
Subscription object
List subscriptions
get
Create subscription
post
Get subscription
get
Update subscription
patch
Get upcoming invoice
get
Pause subscription
post
Restart subscription
post
Cancel subscription
post
Restore subscription
post
List subscription coupons
get
Add coupon
post
Remove coupon
delete
Subscription items
Subscription Item object
Add item to subscription
post
Update subscription item
patch
Remove item from subscription
delete
Payment Endpoints
About Payments
Payment notes
About Payment Notes
List payment notes
get
Create payment note
post
Edit payment note
patch
Delete payment note
delete
Pin payment note
patch
Unpin payment note
patch
Payment gateways
Payment method types
Payment links
About Payment Links
Payment link notes
List payment link notes
get
Create payment link note
post
Edit payment link note
patch
Delete payment link note
delete
Pin payment link note
patch
Unpin payment link note
patch
Payment Processors
List payment processors
get
Get payment processor
get
List allowed countries
get
Toggle active processor
patch
Transactions
Payouts
Credit cards
List accepted credit cards
get
Payments
List payments
get
Create payment
post
Get payment
get
Update payment
patch
Refund payment
patch
Get QR Code
get
Create webhook
post
List refund reasons
get
Payment gateways
List payment gateway controllers
get
Get Spreedly
get
List all payment gateway method type
get
Payment method types
List all payment methods
get
List payment methods
get
Payment links
List payment links
get
Get payment link
get
Update payment link
patch
Upload an image
post
Deactivate payment link
patch
Activate payment link
patch
PIX callback
get
Get payment link by hash
get
Pay by hash v1
post
Pay by hash v2
post
Favorite payment link
post
Remove favorite payment link
delete
Pay by hash (Mobile)
post
Payouts
List payouts
get
Make payment
post
Get payout
get
Update payout
put
Delete payout
delete
Cancel payout
post
Get payout summary
get
Get summary preview
post
Paginated list of payments between dates
get
List payments between dates
get
List payments for a payout
get
List adjustments for a payout
get
List adjustment types
get
Reconcile Strip payment
post
List reconciliations
get
/payouts/reconciliations/bexs
post
ORDER ENDPOINTS
Orders
List orders
get
Get order
get
Cancel order
post
List order items
get
Get order by hash
get
Pay order by hash
post
Get order payments
get
Create order draft
post
Update order draft
patch
Add item in order draft
post
Update item in order draft
patch
Delete item in order draft
delete
Add coupon in order
post
Remove coupon in order
delete
Confirm in order
post
Create order note
post
List order notes
get
Charge customer
post
Charge order status to paid
patch
Email order
post
Update order metadata
patch
Edit order note
patch
Delete order note
delete
Pin order note
patch
Unpin order note
patch
Get PDF order
get
Get PDF invoice
get
PDF Orders
Get PDF invoice
get
Get PDF order
get
Credit-notes Orders
List order credit-notes
get
Create order credit-notes
post
Get order credit-note
get
Update order credit-note
patch
Get PDF order credit-notes
get
List order credit-note notes
get
Create order credit-note note
post
Update order credit-note note
patch
Delete order credit-note note
delete
Pin order credit-note note
patch
Unpin order credit-note note
patch
Billing Endpoints
Billing periods
List billing periods
get
Billing types
List billing types
get
Invoices
About Invoices
Invoice object
Detailed Invoice object
Validate and confirm invoice
post
List invoices
get
Get invoice
get
Update invoice
patch
Get PDF receipt
get
Get PDF invoice
get
Email invoice receipt
post
Email invoice
post
Duplicate invoice
patch
Update invoice status
patch
Invoice by hash
get
Pay by hash
post
Add coupon
post
Delete coupon
delete
Add coupon by scheduler
post
Pay by hash
post
Invoice Items
Add invoice item
post
Update invoice item
patch
Delete invoice item
delete
Add coupon to invoice items
post
Delete coupon from invoice item
delete
Invoice notes
About Invoice Notes
List invoice notes
get
Create invoice note
post
Edit invoice note
patch
Delete invoice note
delete
Pin invoice note
patch
Unpin invoice note
patch
Invoice drafts
Create invoice draft
post
Edit invoice draft
patch
Delete invoice draft
delete
Pending invoice items
Pending Invoice Item object
List pending items
get
Create pending item
post
Get pending item
get
Update pending item
patch
Delete pending item
delete
Remove coupon from pending item
delete
Invoice pending items
post
Credit notes
About credit notes
List credit notes
get
Create credit note
post
List credit note reasons
get
Get credit note
get
Update credit note
patch
Get credit note PDF
get
List credit note notes
get
Create credit note note
post
Edit credit note note
patch
Delete credit note note
delete
Pin note
patch
Unpin note
patch
Reference Endpoints
Countries
List countries
get
States
List states
get
Currencies
List currencies
get
Change status
patch
Languages
List languages
get
Timezones
List time zones
get
API Logs
List API logs
get
List log events
get
Webhook URLs
Webhook Events
Webhook URL object
List webhook URLs
get
Create webhook URL
post
Get webhook URL
get
Update webhook URL
patch
Delete webhook URL
delete
IP lookup
IP look-up
get
home-iot-api
Device
Z-Wave
Environment
Zones
Powered by
List API keys
get
https://api-tenant.inspireplatform.io/api-keys
Overview
Returns a list of API keys.
Language
Shell
Node
Ruby
PHP
Python
Credentials
Bearer
JWT
Bearer
RESPONSE
Click
Try It!
to start a request and see the response here!
