Web Service API Client
Web Service API
Contact and support
English (United States)
Accounting Account Type
Accounting Journal Entry
Accounting Posting Record
Line Item Attribute
Line Item Reduction
Line Item Stored Attribute
The metric usage provides details about the consumption of a particular metric.
The Customer.io integration allows to connect a specific Customer.io Workspace to synchronize customer data and events with their service.
Customer Postal Address
Debt Collection Receipt
Document Target Media Type
A document template contains the customizations for a particular document template type.
Document Template Type
Document Template Type Group
The attachment resource allows the attachment of resources to emails.
Email Sender Type
Email Sending Job
An email sending job is a try to send an email.
Email Template Type
Email Template Type Group
Entity Export Request
The entity property export request contains the information required to create an export of a list of entities.
The entity query allows to search for specific entities by providing filters. This is similar to a SQL query.
Entity Query Filter
The query filter allows to restrict the entities which are returned.
Entity Query Order By
The 'order by' allows to order the returned entities.
An error that is returned as the result of a bad user request or a misconfiguration.
Localized Error Message
Localized error message.
This error is thrown when something unexpected happens on our side.
This error is thrown if an exception occurs during the processing of a websocket request.
Installment Calculated Plan
Installment Calculated Slice
Database Translated String
Database Translated String Item
Legal Organization Form
Persistable Currency Amount
Label Descriptor Group
Label Descriptor Type
A manual task requires a manual intervention by a human.
Manual Task Action
Manual Task Notification
The manual task notification represents a single notification sent.
Manual Task Notification Delivery Type
The delivery type indicates how the notification is delivered.
Manual Task Notification Execution Type
The execution type defines if and when a notification is sent.
Manual Task Notification Subscription
The notification subscription controls when and how a notification is sent for a new manual task.
Manual Task Type
The manual task type indicates what kind of manual task is required to be executed by the human.
The account payable represents an outstanding amount which has to be paid by the merchant to the buyer. This represents typically a refund.
The account receivable represents an outstanding amount which has to be paid by the buyer.
Authenticated Card Data
This model holds the card data and optional cardholder authentication details.
Bank Account Type
Bank Transaction Source
Bank Transaction Type
This model holds the additional card authentication.
This model holds the card data in plain.
This model holds the cardholder authentication data (e.g. 3-D Secure authentication).
Charge Bank Transaction
Charge Flow Level
Charge Flow Level Configuration
Charge Flow Level Configuration Type
Charge Flow Level Payment Link
Completion Line Item
A condition configuration controls under which condition a payment connector is applied to a transaction.
Currency Bank Account
Delivery Indication Decision Reason
External Transfer Bank Transaction
Internal Transfer Bank Transaction
Payment Adjustment Type
Payment Connector Feature
Payment Contract Type
Payment Information Hash
A payment information hash is calculated based on the information entered by the user. The same input leads to the same hash. The hash is collision free.
Payment Information Hash Type
The payment link defines an URL to automatically create transactions.
Payment Method Brand
Payment Method Configuration
The payment method configuration builds the base to connect with different payment method connectors.
Payment Terminal Address
Payment Terminal Configuration
Payment Terminal Configuration Version
Payment Terminal Device
Payment Terminal Device Manufacturer
Payment Terminal Device Model
Payment Terminal Location
Payment Terminal Location Version
Payment Terminal Receipt
Payment Terminal Receipt Type
Payment Terminal Reference
Payment Terminal Type
Reconciliation Payment Fee Account
Reconciliation Sales Revenue Account
Reconciliation Tax Account
Reconciliation Tax Journal Entry
The refund represents a credit back to the customer. It can be issued by the merchant or by the customer (reversal).
Refund Bank Transaction
Refund Recovery Bank Transaction
Rendered Terminal Receipt
Terminal Receipt Fetch Request
The receipt fetch request allows to retrieve the receipt documents for a terminal transaction.
Token Version Type
Tokenized Card Data
This model holds the card data in plain.
Transaction Aware Entity
Transaction Completion Request
The transaction invoice represents the invoice document for a particular transaction.
Transaction Invoice Comment
Transaction Invoice Replacement
Transaction Line Item Update Request
Transaction Line Item Version
Transaction Line Item Version . Create
A printer allows to automatically schedule a print job onto a physical printer.
A print job is a try to send a document to a printer.
A Shopify Integration allows to connect a Shopify shop.
Shopify Recurring Order
Shopify Recurring Order Update Request
Shopify Subscriber Creation
Shopify Subscription Address
Shopify Subscription Billing Configuration
Shopify Subscription Creation Request
Shopify Subscription Item
Shopify Subscription Product
Shopify Subscription Suspension
Shopify Subscription Tax Line
Shopify Subscription Update Addresses Request
Shopify Subscription Update Request
Shopify Subscription Version
Shopify Subscription Version Item
Shopify Tax Line
Charge Strategy Condition Type
A charge strategy condition type realize a particular condition which can be applied on the charge strategies.
Charge Strategy Type
A charge strategy controls the determination of the charge date for a subscription bill.
Coupons are a way to grant subscription discounts. Create a new coupon, configure it with discounts and rules and then share it with your customers.
Coupon Application Rule Type
A coupon application rule restricts the application of coupons to subscription items.
The coupon code which can be redeemed through a subscription.
Coupon End Date Redemption Rule
A rule which can be added to a coupon to restrict its redeemability to a point in time before a specific point in time.
Coupon Product Component References Application Rule
A rule which can be added to a coupon to restrict its applicability to a specific set of product component references.
Coupon Product Fee Type Application Rule
A rule which can be added to a coupon to restrict its applicability to a specific type of product fee.
Coupon Products Redemption Rule
A rule which can be added to a coupon to restrict its redeemability to a specific set of products.
Coupon Redemption Limit Redemption Rule
A rule which can be added to a coupon to restrict its redeemability to a maximum number of redemptions per coupon code.
Coupon Redemption Rule Type
A coupon redemption rule restricts redeemability of coupons.
Coupon Rule Type
A redemption or application coupon rule type
Coupon Start Date Redemption Rule
A rule which can be added to a coupon to restrict its redeemability to a point in time after a specific point in time.
Coupon Subscriber Limit Redemption Rule
A rule which can be added to a coupon to restrict its redeemability to a maximum number of subscribers.
Coupon Subscriber Redemption Rule
A rule which can be added to a coupon to restrict its redeemability to a specific set of subscribers.
The coupon version contains a subset of the coupon properties which can change over time.Only one version can be active at the same time.
The type of the discount. Amount, percent, ...
Fixed Coupon Discount
Maximum Applications Limit Rule
Restrict the number of times a coupon can be applied to the same subscription.
A metric represents the usage of a resource that can be measured.
Metric Usage Report
The metric usage is the actual usage of a metric for a particular subscription as collected by an external application.
Percentage Coupon Discount
A subscription product represents a product to which a subscriber can subscribe to. A product defines how much the subscription costs and in what cycles the subscribe is charged.
Product Component Group
Product Component Reference
The product component reference binds components from different product versions together. By binding them together the product version migration can be realized.
Product Metered Fee
Product Metered Tier Fee
Product Period Fee
Product Setup Fee
Product Version Retirement
A subscriber represents everyone who is subscribed to a product.
Subscription Change Request
The subscription change request allows to change a subscription.
The subscription charge represents a single charge carried out for a particular subscription.
Subscription Component Configuration
Subscription Component Reference Configuration
The component reference configuration adjusts the product component for a particular subscription.
Subscription Create Request
The subscription create request holds all the data required to create a new subscription.
Subscription Ledger Entry
The subscription ledger entry represents a single change on the subscription balance.
Subscription Metric Type
The subscription metric type identifies the type of the metric.
Subscription Period Bill
Subscription Period Bill Item
Subscription Update Request
The subscription update request allows to change a subscription properites.
Single Sign-On Provider
Two Factor Authentication Type
User Account Role
User Space Role
The webhook identity represents a set of keys that will be used to sign the webhook messages.
Webhook Listener Entity