JUMP TOBasicsIntroductionAuthenticationVersionsMIME TypesData typesErrorsError CodesPaged resultsOData QueryingQuick StartMaking your first requestUsing PostmanUsing our Software KITsStep by step: Creating subscriptionsAdding your first CustomerOptional: Adding your first Payment MethodAdding your first subscriptionOptional: Add Optional Charges (Add-on charges)Optional: Set amounts on Subscription ChargesActivate your SubscriptionCore Objects (v3)contact objectcreatepaymentmethod objectcurrency objectcustomer objectdiscount objectdiscountcode objectdiscountconsumer objectpaymentmethod objectproductplan objectproductplancharge objectproductplanchargepricing objectproductfamily objectsubscription objectsubscriptioncharge objectinvoice objectinvoiceline objecttransaction objectuom objectusagedata objectbusinessunit objecttaxrule objectmetadata objectUpodi API v3customer/customersget/customerspost/customersput/customers/{customerId}get/customers/{customerId}patch/customers/{customerId}delete/customers/byaccountnumber/{accountNumber}get/customers/byrefkey/{refKey}get/customers/bymetadata/get/customers/metadatapost/customers/metadata/queryget/customers/metadata/{metaDataId}delete/customers/queryget/customers/{customerId}/paymentmethodsget/customers/{customerId}/contactsget/customers/{customerId}/invoicesget/customers/{customerId}/metadataget/customers/{customerId}/setdefaultpaymentmethodput/customers/{customerId}/assigncardtokenputpaymentmethod/paymentmethodsget/paymentmethods/{paymentMethodId}get/paymentmethods/{paymentMethodId}patch/paymentmethods/{paymentMethodId}delete/paymentmethods/byrefkey/{refKey}get/paymentmethods/validatepaymentmethod/{paymentMethodId}get/paymentmethods/queryget/paymentmethods/{customerId}postcontact/contactsget/contactspost/contactsput/contacts/{contactId}get/contacts/{contactId}patch/contacts/{contactId}delete/contacts/byrefkey/{refKey}get/contacts/querygetproductplan/productplansget/productplanspost/productplansput/productplans/{productPlanId}get/productplans/{productPlanId}patch/productplans/{productPlanId}delete/productplans/{productPlanId}/activateput/productplans/{productPlanId}/deactivateput/productplans/{productPlanId}/chargespost/productplans/{productPlanId}/chargesdelete/productplans/charge/{productPlanChargeId}/pricingsput/productplans/chargeput/productplans/charge/{productPlanChargeId}delete/productplans/{productPlanId}/duplicatepost/productplans/byrefkey/{refKey}get/productplans/bymetadata/get/productplans/metadatapost/productplans/metadata/{metaDataId}delete/productplans/{productPlanId}/metadataget/productplans/querygetinvoice/invoicesget/invoicespost/invoicesput/invoices/{invoiceId}get/invoices/{invoiceId}patch/invoices/bynumber/{invoiceNumber}get/invoices/byrefkey/{refKey}get/invoices/queryget/invoices/{invoiceId}/getpdfwithidget/invoices/{invoiceNumber}/getpdfwithinvoicenumberget/invoices/{invoiceId}/markpaidput/invoices/{invoiceId}/bookput/invoices/{invoiceId}/cancelput/invoices/{invoiceId}/rechargeput/invoices/{invoiceId}/duplicatepost/invoices/{invoiceId}/refundput/invoices/{invoiceId}/sendasemailputtransaction/transactionsget/transactions/queryget/transactions/{transactionId}getuom/uomget/uompost/uomput/uoms/queryget/uoms/{uomId}get/uoms/{uomId}deletesubscription/subscriptionsget/subscriptionspost/subscriptionsput/subscriptions/queryget/subscriptions/{subscriptionId}get/subscriptions/{subscriptionId}patch/subscriptions/byrefkey/{refKey}get/subscriptions/bymetadata/get/subscriptions/metadatapost/subscriptions/metadata/{metaDataId}delete/subscriptions/{subscriptionId}/metadataget/subscriptions/{subscriptionId}/cancelput/subscriptions/{subscriptionId}/setamountput/subscriptions/{subscriptionId}/activateput/subscriptions/{subscriptionId}/switchplanput/subscriptions/{subscriptionId}/expireput/subscriptions/{subscriptionId}/holdput/subscriptions/{subscriptionId}/resumeput/subscriptions/{subscriptionId}/setpaymentmethodput/subscriptions/{subscriptionId}/addoptionalchargeputsubscriptioncharge/subscriptionchargesget/subscriptioncharges/queryget/subscriptioncharges/{subscriptionChargeId}get/subscriptioncharges/{subscriptionChargeId}patch/subscriptioncharges/{subscriptionChargeId}put/subscriptioncharges/{subscriptionChargeId}delete/subscriptioncharges/byrefkey/{refKey}get/subscriptioncharges/{subscriptionChargeId}/setamountput/subscriptioncharges/{subscriptionChargeId}/togglechargeput/subscriptioncharges/{subscriptionChargeId}/holdput/subscriptioncharges/{subscriptionChargeId}/resumeput/subscriptioncharges/{referenceId}/setamountbyreferenceidputusagedata/usagedataget/usagedata/queryget/usagedata/{usageDataId}get/usagedata/{usageDataId}patch/usagedata/byrefkey/{refKey}getdiscount/discountsget/discountspost/discountsput/discounts/queryget/discounts/{discountId}get/discounts/{discountId}patch/discounts/{discountId}delete/discounts/{discountId}/discountcodedelete/discounts/{customerId}/cleardiscountcodecustomerdelete/discounts/{subscriptionId}/cleardiscountcodesubscriptiondelete/discounts/{subscriptionChargeId}/cleardiscountcodesubscriptionchargedelete/discounts/byrefkey/{refKey}get/discounts/{discountId}/discountcodesget/discounts/{discountId}/generatediscountcodesput/discounts/checkeligibilitypost/discounts/applydiscountcodecustomer/{customerId}put/discounts/applydiscountcodesubscription/{subscriptionId}put/discounts/applydiscountcodesubscriptioncharge/{subscriptionChargeId}putbusinessunit/businessunitsget/businessunitspost/businessunitsput/businessunits/{businessUnitId}get/businessunits/{businessUnitId}deletetaxrules/taxrulesget/taxrules/{taxRuleId}gettime/timegettenant/tenant/megetAppendix (v3)WebhooksSecurityTLSInput restrictionsPowered by /timeget https://api.upodi.io/v3/time
