Javascript is required.
Please enable it in your browser and reload this page.
Docs
Basic Features
Space Concept
Permission Concept
Manual Tasks
Payment
Overview
Integration Modes
Processors
Debt Collection
Debt Collection
Debt Collectors
Subscription
Quick Start
Subscriptions
Products
Coupons
Subscribers
Customize
Document Handling
Resources
Twig Templates
Email Handling
Connect
Connected Services
Printing
Slack
Lightspeed eCom
Shopify
Ecwid
Webhooks
API Reference
Web Service API Client
Web Service API
Data Models
Release Notes
Types
Labels
Web App
Analytics
Documentation
Documentation
English (United States)
Français (France)
Deutsch (Deutschland)
Italiano (Italia)
Web Service API Client
API Version :
V1 (deprecated)
V2.0 (latest)
V1 (deprecated)
This API version (V1) is deprecated.
Please consider upgrading to
API V2.0
which is the latest version.
Select a webservice operation...
Search
Count
Delete
Create
Update
Read
Search
Read
Count
Delete
Count
Read
Search
Search
Read
Count
Process With 3-D Secure
Process
Count
Read
Search
Search
Count
Read
Read
Count
Search
Count
Send Payment Link
Read
Search
updateRecipient
Search
Fetch Charge Flow Payment Page URL
Read
applyFlow
Count
Cancel Charge Flow
All
Read
All
All
Find by Country
Read
Search
Count
All
Count
Read
Delete
Create
selectDefaultAddress
Update
Search
unpinComment
Search
Count
Create
Delete
Update
Read
pinComment
Search
Delete
Create
Update
Read
Count
Search
Mark Case As Prepared
Delete
Create
Update
Documents
Add Collected Amount
Mark Case As Reviewed
Count
Close
Read
Attach Document
Read
Search
Count
Read
All
Search
markAsNotSuitable
Read
markAsSuitable
Count
Search
Read
Count
All
Read
Read
Search
Count
Count
Search
Read
Create Dunning Case
Suspend Dunning Case
Count
Search
Read
Read
Search
Count
Read
Search
Count
Search
Read
Count
Delete
Export
Read
Search
Count
Create Installment Payment
Count
Read
Search
Calculate Plans
Count
Search
Read
Read
Search
Count
Search
Count
Read
Read
Unlink Invoice
Link Invoice
Count
Search
Discard
Resolve
Read
Search
Count
Search for matchable invoices by query
Update IBAN
Count
Search
Update payment connector configuration
Read
All
Read
All
Read
All
All
Read
Find by Country
Read
Search
Count
Calculate
Update Refund
Update Charge Attempt
Update Void
Delete Connector
Activate Processor for Production
Insert or Update Connector
Update Completion
Delete Processor
Insert or Update Processor
Search
Read
Count
Read
All
Count
Search
Delete
Create
Update
Read
Read
All
Search
Count
Read
All
Read
Count
Read
Search
Read
All
Remotely Trigger Final Balance
Search
Unlink Device With Terminal
Read
Count
Remotely Trigger Final Balance By Identifier
Link Device With Terminal
Trigger Payment Terminal Configuration (using TID)
Trigger Payment Terminal Configuration
Revert terminal transaction
Perform Payment Terminal Transaction (using TID)
Perform Payment Terminal Transaction
Count
Fetch Receipt
Read
Search
All
Read
Read
Search
Count
Read
Find by refund
Unpin
Delete
Create
Update
Pin
Count
Read
Search
create
succeed
Count
getRefundDocument
getRefundDocumentWithTargetMediaType
Read
fail
Search
Count
Update
Search
Read
Update
Count
Read
Search
Create
Update
Search
Read
Count
Count
Search
Update Addresses
Terminate
Read
Create
Update
Search
Read
Count
Reactivate
Suspend
Search
Count
Read
Read
Search
Count
Read
Search
Delete
Create
Update
Count
All
Read
Search
Delete
Create
Update
Read
Count
Read
Search
Delete
Create
Count
Update
Create
Read
discard
Count
Search
Search
Read
Count
Create
Create
Delete
Update
Read
Search
Count
Search
Count
Create
Read
Search
Count
Read
Count
Search
Delete
Create
Read
Update
Delete
Create
Read
Update
Count
Search
Read
Count
Search
Delete
Create
Update
Create
Count
Delete
Update
Read
Search
Read
Search
Count
Delete
Create
Update
Search
Count
Read
Create
Update
Create
Count
Read
Search
Count
Update
Search
Read
Delete
Create
Search
Count
Create
activate
Update
Read
Create
Read
Search
Count
update product version
Create
apply changes
initializeSubscriberPresent
update
terminate
Count
initialize
Search
Read
Search Subscription Invoices
Search
terminate
Count
Read
Create
Count
Read
Search
Update
Search
Count
Process Transaction
Check If Token Creation Is Possible
Read
Create Token Based On Transaction And Fill It With Stored Payment Information
Create Transaction for Token Update
Delete
Create
Create Token
Active Version
Read
Search
Count
Unpin
Read
Find by transaction
Create
Pin
Delete
Update
Read
Count
completePartiallyOffline
completePartiallyOnline
completeOnline
Search
completeOffline
Build JavaScript URL
Delete
Create
Update
Unpin
Find by invoice
Read
Pin
isReplacementPossible
Count
Read
Mark as Derecognized
Search
Mark as Paid
replace
getInvoiceDocumentWithTargetMediaType
getInvoiceDocument
Build JavaScript URL
create
Read
Count
Search
Build Mobile SDK URL
Build Payment Page URL
Fetch One Click Tokens with Credentials
Process One-Click Token with Credentials
getPackingSlip
Fetch Possible Payment Methods
Update
Export
Delete One-Click Token with Credentials
Read With Credentials
Create Transaction Credentials
Get Successful Charge Attempt
Confirm
Fetch Possible Payment Methods with Credentials
Search
Count
Read
getLatestSuccessfulTransactionLineItemVersion
Process Without User Interaction
getInvoiceDocument
Create
Fetch Receipts
Create Till Connection Credentials
voidOnline
Search
Read
voidOffline
Count
List Roles
List Roles
Read
Search
Count
Create
Delete
Read
Update
Search
Create
Count
Delete
Read
Update
Request
Documentation
Careful!
This is a live request, sending it can result in actual changes.
GET
/api/subscription-metric/read
Send
Form
Raw
Query Parameters
Press
Ctrl
+
Enter
to send the request.
Form
Raw
Query Parameters
spaceId
Integer
required
id
Integer
required