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