Upodi Docs

Guides
API Reference
Roadmap
Trust

GitHub
Back to Upodi
Sign in

Welcome friend!

Welcome to Upodi Docs. You'll find comprehensive help, guides and developer information to help you get started with the basics and move to the advanced flows. Let's jump right in!

I am a User I am a Developer

v2.0

v1.0deprecated
(API Version 2)
v2.0stable
(API Version 3)
v3.0beta
(NXT)

HomeGuidesRecipesAPI ReferenceReferenceRoadmapFeedbackPage Not FoundSearch{{ state.current().meta.title }}API Logs

Getting Started

Introduction
Conceptual model
Setting up Upodi
PCI Compliance
Going live
Known configurations

Quick Guides

Quickstart
New subscription business
E-commerce & Webshop

Products & charges

Product Plan
- Editing plans
- Handling changes
Types of charges
- Charge Type Metered
Charge Setup
Aligning to subscription
Pricing models
- Discounting
- Discount code
Currencies
- Choosing a currency strategy

Customers & subscriptions

Customer
- Contact
- Payment methods
Subscriptions
Customer e-mails
- Merging e-mail content
- Delivery confirmation

Billing & Invoicing

Invoice
- Payment terms
- Credit notes & Refunds
Taxation (VAT)
Payment
Dunning

Payment Providers

Credit Cards
Direct Debit
Common practises
- Resources
Country specific
- Fælles Indbetalingskort

Upodi for Apps

Finance
Invoice processing
- Sproom
Shipping
- Shipmondo

Administration

User management
Business Units
Managing your environments

Configurations

Configuring e-mail

Security and compliance

Datacenters
IP Addresses
GDPR

Analytics

Working with PowerBI

Migration

Credit card import
- PGP

Getting Started

Introduction
Conceptual model
Setting up Upodi
PCI Compliance
Going live
Known configurations

Quick Guides

Quickstart
New subscription business
E-commerce & Webshop

Products & charges

Product Plan
- Editing plans
- Handling changes
Types of charges
- Charge Type Metered
Charge Setup
Aligning to subscription
Pricing models
- Discounting
- Discount code
Currencies
- Choosing a currency strategy

Customers & subscriptions

Customer
- Contact
- Payment methods
Subscriptions
Customer e-mails
- Merging e-mail content
- Delivery confirmation

Billing & Invoicing

Invoice
- Payment terms
- Credit notes & Refunds
Taxation (VAT)
Payment
Dunning

Payment Providers

Credit Cards
Direct Debit
Common practises
- Resources
Country specific
- Fælles Indbetalingskort

Upodi for Apps

Finance
Invoice processing
- Sproom
Shipping
- Shipmondo

Administration

User management
Business Units
Managing your environments

Configurations

Configuring e-mail

Security and compliance

Datacenters
IP Addresses
GDPR

Analytics

Working with PowerBI

Migration

Credit card import
- PGP

Basics

Introduction
Authentication
Versions
MIME Types
Data types
Errors
- Error Codes
Paged results
OData Querying

Quick Start

Making your first request
Using Postman
Using our Software KITs
Step by step: Creating subscriptions

Core Objects (v3)

contact object
createpaymentmethod object
currency object
customer object
discount object
discountcode object
discountconsumer object
paymentmethod object
productplan object
productplancharge object
productplanchargepricing object
productfamily object
subscription object
subscriptioncharge object
invoice object
invoiceline object
transaction object
uom object
usagedata object
businessunit object
taxrule object
metadata object

Upodi API v3

customer
paymentmethod
contact
productplan
invoice
transaction
uom
subscription
subscriptioncharge
usagedata
discount
businessunit
taxrules
- get
  /taxrules
- get
  /taxrules/{taxRuleId}
time
- get
  /time
tenant
- get
  /tenant/me

Appendix (v3)

Webhooks
Security
- TLS
- Input restrictions

Powered by

Shipping

Suggest Edits

Updated about a month ago

Shipping

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.