/

Docs
History
Schema
Generate

Filter operations

get/billing/customersList customers
post/billing/customersCreate a customer
get/billing/customers/{customerId}Retrieve a customer
put/billing/customers/{customerId}Update a customer
get/billing/customers/{customerId}/paymentmethodsList payment methods
post/billing/customers/{customerId}/paymentmethodsCreate a payment method
get/billing/customers/{customerId}/paymentmethods/primaryRetrieve primary payment method
get/billing/customers/{customerId}/paymentmethods/{paymentMethodToken}Retrieve a payment method
delete/billing/customers/{customerId}/paymentmethods/{paymentMethodToken}Delete a payment method
post/billing/checkoutCreate A Checkout Session
delete/billing/checkout/{checkoutId}Disable a Checkout Session
get/billing/invoicesList invoices
post/billing/invoicesCreate an invoice
get/billing/invoices/{invoiceId}Retrieve an invoice
put/billing/invoices/{invoiceId}Update an invoice
post/billing/invoices/{invoiceId}/recordpaymentRecord an external payment for an invoice
get/billing/invoices/batchesList invoice batches
post/billing/invoices/batchesCreate an invoice batch
get/billing/invoices/batches/{invoiceBatchId}Retrieve an invoice batch
get/billing/transactionsList transactions
get/billing/transactions/{transactionId}Retrieve a transaction
get/billing/plansList plans
post/billing/plansCreate a plan
get/billing/plans/{planId}Retrieve a plan
put/billing/plans/{planId}Update a plan
get/billing/subscriptionsList subscriptions
post/billing/subscriptionsCreate a subscription
post/billing/subscriptions/previewPreview a subscription
get/billing/subscriptions/{subscriptionId}Retrieve a subscription
put/billing/subscriptions/{subscriptionId}Update subscription
put/billing/subscriptions/{subscriptionId}/activateActivate a subscription
put/billing/subscriptions/{subscriptionId}/cancelCancel a subscription
put/billing/subscriptions/{subscriptionId}/paymentmethod/{paymentMethodToken}Update subscription's payment method
post/billing/subscriptions/{subscriptionId}/undo-cancelUndo a subscription cancellation
get/billing/futureinvoicesList future invoices
put/billing/futureinvoicesUpdate a future invoice
delete/billing/futureinvoicesDelete a future invoice
post/billing/futureinvoices/recordpaymentRecord an external payment for a future invoice
post/billing/invoices/{invoiceId}/writeoffWrite off an invoice
post/billing/invoices/{invoiceId}/retrypaymentRetry a payment on an invoice
put/billing/customers/{customerId}/paymentmethods/{paymentMethodToken}/newReplace a payment method
put/billing/customers/{customerId}/paymentmethods/{paymentMethodToken}/primaryUpdate primary payment method
put/billing/invoices/{invoiceId}/refundRefund an invoice
get/billing/creditnotesList credit notes
get/billing/creditnotes/{creditNoteId}Retrieve a credit note
get/billing/settlementsList settlements
post/billing/settlements/groupedbyaccountingcode/fileGenerate group settlement report by accounting code
post/billing/settlements/groupedbytransactionstatus/fileGenerate group settlement report by transaction status
post/billing/settlements/{settlementNumber}/fileGenerate a settlement document
post/billing/reports/outstandingcollectionsreport/generateGenerate Outstanding Collections Report
post/billing/reports/merchanttransactionsGenerate Merchant Transactions Report
get/files/{fileId}Get File
get/partnerinvoicesList partner invoices
post/partnerinvoicesCreate a partner invoice
post/retrypartnerinvoices/{partnerInvoiceId}Attempt payment on a partner invoice
get/partnersubscriptionsList partner subscriptions
post/partnersubscriptionsCreate a partner subscription
get/partnersubscriptions/{partnerSubscriptionId}/addons/{partnerSubscriptionAddOnCode}List partner subscription add on usage
post/partnersubscriptions/{partnerSubscriptionId}/addons/{partnerSubscriptionAddOnCode}/recordusageRecord a partner subscription add on usage
put/partnersubscriptions/{partnerSubscriptionId}/cancelCancel a partner subscription
post/emailAdd email address for merchant contact
get/email/{merchantContactId}Get email addresses by merchant contact id
put/email/{emailAddressId}Update an existing email address
get/billing/merchantRetrieve a merchant
put/billing/merchant/failedpaymenthandlingUpdate a merchant's failed payment handling
get/billing/merchant/nextSettlement/{merchantId}Retrieve collected next settlement amount
put/billing/merchant/notificationsettingsUpdate a merchant's notification settings
get/billing/merchant/pricing/feesRetrieve a schedule of customer paid fees for Merchant
get/merchantconnectionsList merchant connections
post/merchantconnectionsCreate a merchant connection
get/merchantconnections/{merchantConnectionId}Retrieve a merchant connection
put/merchantconnections/{merchantConnectionId}/activateActivate a merchant connection
put/merchantconnections/{merchantConnectionId}/cancelCancel a merchant connection
post/merchantcontactCreate merchant's contact by type
get/merchantcontact/{merchantContactId}Get merchant contact by merchant contact id
put/merchantcontact/{merchantContactId}Update merchant contact by merchant contact Id
delete/merchantcontact/{merchantContactId}Delete merchant contact by merchant contact id
post/billing/terminal/registerRegister Terminal Device
get/billing/terminal/invoicesList Terminal Invoices
post/billing/terminal/invoicesCreate A Terminal Invoice
get/billing/terminal/invoices/{invoiceId}Retrieve A Terminal Invoice
put/billing/invoices/{invoiceId}/cancelCancel a QR Payment request
get/billing/styles/{styleId}Retrieve a Styling
post/billing/stylesCreate a Styling

Changes to Retrieve a merchant connection

get/merchantconnections/{merchantConnectionId}

Nov 3, 2026924be4030f56 Revision changes
- info
  endpoint added