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