JUMP TOBasicsIntroductionAuthenticationVersionsMIME TypesData typesRate LimitationsIdempotencyPaged resultsQueryingErrorsQuick StartMaking your first requestUsing our SDK (.NET)Step by step: Creating subscriptionsAdding your first CustomerAdding your first subscriptionActivate your SubscriptionUpodi APIContactsGet contacts by refkeygetCreate contactpostList of contactsgetDelete contactdeleteUpdate contactputPatch contactpatchGet contactgetQuery contactspostCustomersQuery customerspostDelete customerdeleteGet customergetUpdate customerputPatch customerpatchDelete metadata entry for a customerdeleteList customersgetCreate customerpostGet customer by account numbergetGet customers by refkeygetGet customer paymentmethodsgetGet customer invoicesgetGet customer contactsgetGet customer metadatagetPut customer metadataputGet customer by metadatagetCreate Metadata for a customerpostSet default payment methodputGet entitlements by customer idget/Customers/bygroup/{number}getDiscountsGet Discount Codes of a specific DiscountgetGet Discounts for a specific Ref keygetCreate discountpostList discountsgetCheck eligibility of discount codepostUpdate discountputPatch discountpatchGet discountgetDelete discountdeleteGenerate discount codes for a discountputApply discount code to customerputApply discount code to subscriptionputApply discount code to subscription chargeputDelete discount codedeleteClear discount on customerdeleteClear discount on subscriptiondeleteClear discount on subscription chargedeleteGet discount usesget/Discounts/metadata/{metadataId}delete/Discounts/{id}/metadatagetPut discount metadataputCreate Metadata for a discount.postGet discount by metadatagetQuery discountspostInvoicesQuery invoicespostDelete invoicedeleteGet invoicegetUpdate invoiceputPatch invoicepatchCancel invoiceputCreate invoicepostList invoicesgetDuplicate an invoicepostSend the 'new invoice' email for an existing invoicepostBook invoiceputUpdate an invoice settlementputPatch invoice settlementpatchDelete invoice settlementdeleteSettle (pay or refund) an invoice.postSettle the invoice.postHandle dunning actions on invoice.putGet PDFgetTimeGets the current timegetTransactionsQuery transactionspostGet transactiongetList transactionsgetBusinessUnitsQuery business unitspostCreate BusinessUnitpostList of paged BusinessUnitsgetUpdate an existing BusinessUnitpatchUpdate an existing BusinessUnitputGet BusinessUnit by IDgetDelete BusinessUnitdeleteCheckout/Checkoutput/CheckoutpostCustomerGroups/CustomerGroupspost/CustomerGroupsget/CustomerGroups/{id}delete/CustomerGroups/{id}put/CustomerGroups/{id}get/CustomerGroups/number/{number}getDataPrivacyRetrieves customer data based on the provided customer ID.getDeletes customer and all his data permanently if no new booked invoices appear for the last 5 yearsdeleteObfuscates customer data based on the provided customer ID.postEmailTemplateSetsQuery emailtemplatesetspostList emailtemplatesetsgetGet emailtemplatesetgetEntitlementsCreate new entitlementpostGet paginated entitlementsgetUpdate entitlementputDelete entitlementdeleteGet entitlement by idgetFinancialAccounts/FinancialAccountspost/FinancialAccountsget/FinancialAccounts/{id}put/FinancialAccounts/{id}delete/FinancialAccounts/{id}getFinancialAccountSets/FinancialAccountSetspost/FinancialAccountSetsget/FinancialAccountSets/{id}put/FinancialAccountSets/{id}delete/FinancialAccountSets/{id}getGraphGraphQLpostPaymentMethodsChange default payment methodputCreate payment methodpostList payment methodsgetDelete payment methoddeleteGet payment method by idgetQuery payment methodspostProductFamilies/ProductFamiliesget/ProductFamiliespost/ProductFamilies/{id}get/ProductFamilies/{id}put/ProductFamilies/{id}deleteProductPlansQuery product plans.postPatch product planpatchGet product plangetUpdate Product PlanputDeletes a ProductPlan.deleteList product plansgetCreate product planpostGet product plan metadatagetPut product plan metadataputGet product plans by metadatagetGet productplans by refkeygetCreate product plan metadatapostDuplicate product planpostCreate product plan chargespostRemoves all Charges of a ProductPlan.deleteUpdate product plan charge pricingsputUpdate Product Plan ChargeputDeletes a single charge from a ProductPlan.deleteActivate Product PlanputDeactivate Product PlanputDelete Product Plan MetadatadeleteGet entitlements by product plan charge idgetAdd entitlements to product plan chargeputGet product plan chargegetSubscriptionChargesHold Subscription ChargeputResume Subscription ChargeputUpdate Subscription ChargeputGet subscription chargegetRemove optional charge.deleteSubscriptionsQuery SubscriptionspostPatch SubscriptionpatchGet SubscriptiongetUpdate subscriptionputDelete Subscription MetadatadeleteList SubscriptionsgetCreate SubscriptionpostGet subscriptions by refkeygetGet Subscriptions by MetadatagetGet Subscription MetadatagetPut subscription metadataputGet Subscription ChargesgetGet Subscription Charge HistorygetGet Active Subscription ChargesgetCreate Subscription MetadatapostBill select charges on the subscription nowpostSwitch PlanputActivate SubscriptionputCancel SubscriptionputExpire SubscriptionputHold SubscriptionputResume SubscriptionputOverwrite Payment MethodputAdd Optional ChargeputDelete subscription eventdeleteUpdate Subscription eventputGet Subscription with eventsgetCreate Subscription eventpostGet upcoming invoice for a subscriptiongetGet entitlements by subscription idgetTaxRulesQuery taxrulespostList taxrulesgetGet taxrulegetTenantDetailsGet tenant detailsgetUomsQuery uomspostList uomsgetGet uomgetUsageData/UsageDatapostList usagedatagetQuery usagedatapostGet usagedatagetWebhooksSubscribe for WebhookspostList webhooksgetUpdate subscriptions for existing WebhookputUnsubscribe for WebhooksdeleteGet webhookgetQuery webhookspostCore Objectscontact objectcurrency objectcustomer objectdiscount objectdiscountcode objectdiscountconsumer objectdiscountsource objectpaymentmethod objectproductplan objectproductplancharge objectproductplanchargepricing objectproductfamily objectsubscription objectsubscriptioncharge objectinvoice objectinvoiceline objecttransaction objectuom objectusagedata objectbusinessunit objecttaxrule objectmetadata objectAppendix (v3)WebhooksSecurityTLSInput restrictionsReporting Keys (OData)Powered by Settle (pay or refund) an invoice.post https://api-front.upodi.io/Invoices/{invoiceId}/settle
