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
Shopify
Ecwid
Webhooks
API Reference
Web Service API Client
Web Service API
Data Models
Release Notes
Types
Labels
Web App
Documentation
Documentation
English (United States)
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...
Read
Update
Delete
Count
Create
Search
Search
Count
Read
Delete
Search
Read
Count
Search
Read
Count
Read
Count
Search
Send Payment Link
Fetch Charge Flow Payment Page URL
updateRecipient
Read
applyFlow
Cancel Charge Flow
Count
Search
Read
All
All
All
Find by Country
All
Update
Create
Read
Delete
Search
selectDefaultAddress
Count
unpinComment
Delete
Search
pinComment
Update
Create
Count
Read
Create
Count
Update
Delete
Search
Read
Search
Count
Read
Close
Mark Case As Reviewed
Add Collected Amount
Attach Document
Update
Delete
Mark Case As Prepared
Documents
Create
Read
Count
Search
Read
All
markAsNotSuitable
Search
Count
markAsSuitable
Read
Count
Read
Search
Read
All
Search
Read
Count
Search
Suspend Dunning Case
Create Dunning Case
Read
Count
Read
Search
Count
Search
Read
Count
Export
Read
Delete
Search
Count
Read
All
All
Read
All
Find by Country
All
Read
Read
Search
Count
Count
Search
Read
All
Read
Update
Delete
Count
Search
Read
Create
Read
All
Count
Search
Read
Read
All
Read
Count
Search
All
Read
All
Read
Unpin
Pin
Create
Find by refund
Update
Delete
Read
getRefundDocumentWithTargetMediaType
getRefundDocument
Count
Read
fail
Search
create
succeed
Count
Update
Read
Search
Read
Search
Update
Count
Read
Update
Count
Create
Search
Create
Search
Update Addresses
Read
Terminate
Count
Update
Count
Suspend
Reactivate
Read
Search
Count
Read
Search
Read
Search
Count
Update
Create
Delete
Search
Count
Read
All
Read
Update
Create
Count
Read
Delete
Search
Delete
Read
Update
Create
Count
Search
discard
Search
Count
Read
Create
Create
Search
Read
Count
Update
Read
Create
Search
Delete
Count
Read
Count
Create
Search
Search
Read
Count
Count
Read
Update
Create
Delete
Search
Search
Count
Read
Create
Update
Delete
Delete
Search
Read
Update
Create
Count
Count
Update
Create
Delete
Read
Search
Delete
Count
Search
Read
Update
Create
Update
Count
Search
Read
Create
Read
Create
Count
Search
Update
Read
Create
Count
Delete
Search
Search
Update
Create
Count
Read
activate
Search
Create
Count
Read
terminate
apply changes
update
Create
Count
Search Subscription Invoices
initializeSubscriberPresent
update product version
Search
initialize
Read
Read
Create
terminate
Count
Search
Count
Search
Read
Update
Delete
Search
Create Token
Create Token Based On Transaction And Fill It With Stored Payment Information
Read
Process Transaction
Count
Create
Create Transaction for Token Update
Check If Token Creation Is Possible
Read
Active Version
Count
Search
Update
Unpin
Create
Find by transaction
Delete
Pin
Read
Count
completeOnline
Read
Search
completePartiallyOnline
completePartiallyOffline
completeOffline
Build JavaScript URL
Create
Unpin
Pin
Find by invoice
Delete
Read
Update
isReplacementPossible
Read
Count
replace
Mark as Derecognized
getInvoiceDocumentWithTargetMediaType
Mark as Paid
Search
getInvoiceDocument
Build JavaScript URL
Count
Search
Read
create
Build Mobile SDK URL
Build Payment Page URL
Delete One-Click Token with Credentials
getInvoiceDocument
Search
Fetch Possible Payment Methods
Create Transaction Credentials
getLatestSuccessfulTransactionLineItemVersion
getPackingSlip
Read
Update
Process One-Click Token with Credentials
Create
Read With Credentials
Export
Confirm
Process Without User Interaction
Fetch One Click Tokens with Credentials
Count
Fetch Possible Payment Methods with Credentials
voidOffline
voidOnline
Count
Read
Search
List Roles
List Roles
Read
Update
Create
Read
Delete
Search
Count
Search
Update
Count
Create
Read
Delete
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
