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

New subscription business

This guide is minded for the new subscription business. Congratulations! Subscription is the best monetization of a long term relationship. You would like to configure your plans and subscriptions and finally accept payment methods (credit card and likes).

This guide will go through the new easy steps:

1) Setup your product plan
2) Create new customer
3) Create new subscription linked to both

Step 1 of 3: Setup your product plan

A product plan defines your business model. This includes what a subscription cost, how often it will be charged and which customer be invoiced etc.

Creating new product plans in Upodi is ready. Navigate to https://app.upodi.io, sign in and select Product Plans > Create new under Product Catalog.

Note down the Product Plan ID as we will need it in step 3 when creating a new subscription.

We will start by creating a simple example plan. Type the name of the plan - in this example "Basic plan". Once completed, select "Create new charge" to create the first charge. A product plan may hold multiple charges, which have different timing, pricing and alignment. A product plan acts as a template for coming subscriptions. :owlbert+:

Step 2 of 3: Create a new customer

You can either use Upodi to create a customer or via API.

Go to https://app.upodi.io and select Customers > Create new. Enter the name and details of the customer and click Save.

Note down the Customer ID as we will need it in the next step 3 when creating a new subscription.

If you instead wish to integrate directly with your system, you can do so using our API.

curl -X POST https://api.upodi.io/v2/customers/
-H 'Content-type: application/json'
-H "Authorization: Bearer Zjc0YjNj....NGRk;" 
-d '{ ' \
-d ' "accountnumber" : "CU-000120", ' \
-d ' "currencycode" : "EUR", ' \
-d ' "autobill" : true, ' \
-d ' "fullname" : "Sample Customer" ' \
-d '}'
UpodiService upodi = new UpodiService("aab31984-0256-4d10-afe2-c6a4f35bcf40");

var customerId = upodi.Customers.Create("CU-0020", "Customer Account", "EUR");

Step 3 of 3: Create a new subscription

Once you have created the customer, you can now click on the customer and select Add Subscription. Here you can select the subscription plan created in step 1. Define the subscription terms (start and end date).

curl -X POST https://api.upodi.io/v2/subscriptions
'Content-type: application/json'
-H "Authorization: Bearer Zjc0YjNj....NGRk;" 
-d '{' \
-d ' "subscriptionnumber" : "SUB-203383", ' \
-d ' "customerid" : "- customer id returned from step 1",' \
-d ' "productplanid" : "- guid of plan from Upodi -",' \
-d ' "startdate" : "2018-01-01 00:00:00",' \
-d ' "enddate" : "2018-01-01 00:00:00",' \
-d ' "autorenew" : true,' \
-d ' "initialterminterval" : 1, /* 1 year */' \
-d ' "initialtermperiod" : 500, /* year(s) */' \
-d ' "renewalterminterval" : 1, /* 1 year */' \
-d ' "renewaltermperiod" : 500 /* year(s) */' \
-d '}'
UpodiService upodi = new UpodiService(ApiKey);
Guid subscriptionId = upodi.Subscriptions.Create(new Subscription
{
	SubscriptionNumber = "SUB-203383",
	StartDate = LastDayOfMonth(DateTime.UtcNow),
	AutoRenew = true,
	CustomerID = customerId,
	ProductPlanID = Guid.Parse(ProductPlanId), // the product plan id from Upodi
	Initial = new AnnualTerm(1),
	Renewal = new AnnualTerm(1)
});

Once you are ready to active the subscription for billing, click on Activate.


New subscription business


Suggested Edits are limited on API Reference Pages

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