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