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
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
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...
Search
Create
Update
Delete
Read
Count
Search
Delete
Count
Read
Count
Search
Read
Search
Count
Read
Read
Send Payment Link
Search
Count
Fetch Charge Flow Payment Page URL
Count
Read
updateRecipient
Search
applyFlow
Cancel Charge Flow
All
Read
All
All
Find by Country
All
Delete
Count
selectDefaultAddress
Search
Read
Update
Create
Search
pinComment
Create
Update
Read
Delete
Count
unpinComment
Read
Search
Count
Update
Create
Delete
Count
Search
markAsSuitable
Read
markAsNotSuitable
Read
Search
Count
Read
All
Search
Count
Read
Search
Read
Count
Create Dunning Case
Suspend Dunning Case
Search
Count
Read
Read
Search
Count
Export
Count
Search
Read
Delete
Count
Create Installment Payment
Read
Search
Read
Count
Search
Calculate Plans
Read
Count
Search
Search
Read
Count
Link Invoice
Read
Count
Unlink Invoice
Search
Resolve
Count
Search
Read
Discard
Search for matchable invoices by query
Update IBAN
Read
Search
Count
Update payment connector configuration
Read
All
Read
All
All
Read
Find by Country
All
Search
Read
Count
Calculate
Search
Read
Count
Read
All
All
Read
Read
Count
Search
Read
All
Read
Search
Count
Read
All
Read
All
Create
Update
Delete
Pin
Read
Find by refund
Unpin
Read
Count
fail
succeed
Search
getRefundDocument
create
getRefundDocumentWithTargetMediaType
Search
Read
Update
Count
Read
Count
Search
Update
Count
Search
Create
Update
Read
Update Addresses
Search
Update
Create
Terminate
Read
Count
Suspend
Count
Reactivate
Read
Search
Count
Read
Search
Read
Search
Count
Search
Read
Create
Update
Delete
Count
All
Read
Read
Search
Create
Update
Delete
Count
Count
Search
Create
Update
Delete
Read
Search
Count
discard
Create
Read
Read
Search
Create
Count
Search
Count
Create
Update
Delete
Read
Count
Search
Create
Read
Read
Search
Count
Create
Update
Delete
Read
Count
Search
Delete
Count
Search
Read
Update
Create
Read
Count
Search
Create
Update
Delete
Create
Update
Delete
Count
Read
Search
Read
Search
Create
Update
Delete
Count
Create
Update
Read
Count
Search
Count
Search
Read
Create
Count
Read
Search
Create
Update
Delete
Count
Read
Search
Create
Update
activate
Read
Create
Count
Search
terminate
Search Subscription Invoices
initializeSubscriberPresent
apply changes
initialize
Search
Read
Count
Create
update
update product version
Search
Read
terminate
Create
Count
Search
Count
Read
Count
Update
Create
Process Transaction
Delete
Create Token
Create Transaction for Token Update
Read
Search
Check If Token Creation Is Possible
Create Token Based On Transaction And Fill It With Stored Payment Information
Search
Read
Active Version
Count
Read
Pin
Create
Update
Delete
Find by transaction
Unpin
Count
Read
completeOnline
completeOffline
completePartiallyOffline
completePartiallyOnline
Search
Create
Update
Delete
Read
Pin
Find by invoice
Unpin
Mark as Derecognized
Count
Mark as Paid
isReplacementPossible
getInvoiceDocumentWithTargetMediaType
getInvoiceDocument
Read
replace
Search
Read
Count
Search
create
Fetch Possible Payment Methods with Credentials
Delete One-Click Token with Credentials
Export
getInvoiceDocument
getPackingSlip
Process Without User Interaction
Confirm
Search
Count
Fetch One Click Tokens with Credentials
Read With Credentials
Fetch Possible Payment Methods
getLatestSuccessfulTransactionLineItemVersion
Update
Read
Create
Process One-Click Token with Credentials
Create Transaction Credentials
Count
Read
voidOffline
Search
voidOnline
List Roles
List Roles
Read
Count
Search
Create
Update
Read
Delete
Read
Count
Search
Create
Update
Delete
Request
Documentation
Careful!
This is a live request, sending it can result in actual changes.
GET
/api/shopify-subscription/read
Send
Form
Raw
Query Parameters
Press
Ctrl
+
Enter
to send the request.
Form
Raw
Query Parameters
spaceId
Integer
required
id
Integer
required