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...
Delete
Read
Count
Create
Update
Search
Delete
Count
Search
Read
Count
Read
Search
Search
Read
Count
Process
Process With 3-D Secure
Count
Search
Read
Count
Read
Search
Read
Search
Count
Search
Read
Count
Send Payment Link
applyFlow
Search
updateRecipient
Count
Fetch Charge Flow Payment Page URL
Read
Cancel Charge Flow
All
Read
All
All
Find by Country
Search
Read
Count
All
Count
Create
Update
Read
Search
selectDefaultAddress
Delete
unpinComment
Read
Delete
Create
Update
Count
pinComment
Search
Delete
Read
Update
Create
Search
Count
Add Collected Amount
Count
Close
Delete
Create
Update
Mark Case As Prepared
Documents
Mark Case As Reviewed
Search
Read
Attach Document
Read
Search
Count
Read
All
Search
markAsNotSuitable
Read
Count
markAsSuitable
Read
Search
Count
Read
All
Read
Count
Search
Create Dunning Case
Search
Count
Suspend Dunning Case
Read
Read
Search
Count
Search
Count
Read
Count
Read
Search
Search
Read
Export
Count
Delete
Read
Count
Create Installment Payment
Search
Count
Read
Search
Calculate Plans
Search
Read
Count
Read
Count
Search
Read
Count
Search
Unlink Invoice
Count
Read
Search
Link Invoice
Read
Count
Search for matchable invoices by query
Search
Resolve
Discard
Update payment connector configuration
Search
Read
Update IBAN
Count
All
Read
Read
All
All
Read
Find by Country
All
Read
Search
Count
Calculate
Delete Processor
Update Completion
Update Refund
Update Charge Attempt
Delete Connector
Insert or Update Processor
Update Void
Insert or Update Connector
Activate Processor for Production
Read
Count
Search
Read
All
Read
Delete
Update
Create
Search
Count
Read
All
Search
Count
Read
Read
All
Search
Count
Read
Read
All
Search
Count
Read
Remotely Trigger Final Balance
Remotely Trigger Final Balance By Identifier
Unlink Device With Terminal
Link Device With Terminal
Perform Payment Terminal Transaction (using TID)
Perform Payment Terminal Transaction
Count
Search
Read
Fetch Receipt
Read
All
Read
Search
Count
Read
Delete
Find by refund
Unpin
Update
Create
Pin
Read
Count
Search
Count
fail
succeed
getRefundDocumentWithTargetMediaType
Read
create
getRefundDocument
Search
Count
Update
Search
Read
Read
Count
Update
Search
Read
Count
Create
Update
Search
Create
Update
Search
Update Addresses
Terminate
Read
Count
Count
Search
Read
Suspend
Reactivate
Search
Read
Count
Count
Search
Read
Count
Create
Update
Read
Search
Delete
All
Read
Count
Delete
Read
Create
Update
Search
Update
Read
Search
Count
Delete
Create
Count
Create
Search
discard
Read
Create
Search
Count
Read
Count
Create
Update
Search
Read
Delete
Count
Create
Search
Read
Read
Count
Search
Read
Delete
Count
Create
Update
Search
Delete
Count
Update
Create
Search
Read
Delete
Create
Update
Search
Read
Count
Delete
Create
Update
Read
Search
Count
Create
Update
Search
Read
Count
Delete
Update
Create
Search
Count
Read
Create
Read
Count
Search
Read
Delete
Create
Update
Search
Count
Read
Create
Update
Search
Count
activate
Create
Search
Read
Count
Read
Search Subscription Invoices
Create
Count
update
Search
apply changes
terminate
update product version
initializeSubscriberPresent
initialize
terminate
Create
Read
Count
Search
Search
Count
Read
Read
Create Token Based On Transaction And Fill It With Stored Payment Information
Count
Create Transaction for Token Update
Create Token
Delete
Update
Process Transaction
Create
Search
Check If Token Creation Is Possible
Search
Read
Count
Active Version
Delete
Create
Update
Find by transaction
Pin
Read
Unpin
completePartiallyOnline
completeOnline
completePartiallyOffline
Read
Search
Count
completeOffline
Build JavaScript URL
Find by invoice
Delete
Pin
Unpin
Create
Update
Read
isReplacementPossible
Mark as Paid
getInvoiceDocument
getInvoiceDocumentWithTargetMediaType
Read
Mark as Derecognized
replace
Count
Search
Build JavaScript URL
Count
create
Read
Search
Build Mobile SDK URL
Build Payment Page URL
Read With Credentials
Fetch Possible Payment Methods with Credentials
getLatestSuccessfulTransactionLineItemVersion
Process One-Click Token with Credentials
getInvoiceDocument
Confirm
Export
Read
Fetch One Click Tokens with Credentials
Count
Fetch Possible Payment Methods
getPackingSlip
Process Without User Interaction
Create Transaction Credentials
Create
Update
Delete One-Click Token with Credentials
Search
Fetch Receipts
Create Till Connection Credentials
Read
Count
voidOffline
voidOnline
Search
List Roles
List Roles
Read
Count
Delete
Create
Update
Read
Search
Create
Update
Search
Count
Read
Delete
Request
Documentation
Careful!
This is a live request, sending it can result in actual changes.
POST
/api/subscription-metric/create
Send
Form
Raw
Query Parameters
Body Parameters
Press
Ctrl
+
Enter
to send the request.
Form
Raw
Query Parameters
spaceId
Integer
required
Body Parameters
entity
required
Add
Remove
Preprod
2.185.11
Remove Cookie