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