A Quick Tour of Salable’s API's

Apr 20, 2023

Sandy Fargus, Tech Writer for Salable

Salable is a platform that allows you to connect payment providers to your app in the most flexible way possible. It’s made up of an easy-to-use dashboard that lets anyone set up plans and products and hand out licenses and subscriptions. But Salable was built with developers in mind. That’s why we’ve focused on making our APIs as useful as possible. So what can you do with our APIs?

First, the ‘Need to Knows’

Our APIs (Application Programming Interfaces) use HTTP endpoints that accept requests with JSON arguments and return JSON responses. Authentication is via API key in the header.

To get up and running, you need to work through the following steps.

  • Set up a Salable Account and Organization
  • Connect either Stripe or Paddle to Salable
  • Build your products and plans
  • Generate your API key

Manage Products

The product endpoints give you the ability to get information by product. This can be as broad or specific as you need it to be. So if you need to pull all the data on your organization’s products, you can do that in a single call. On the other hand, if you need to know what features are assigned to a specific product in your organization, you can use the UUID of the product to get that information. This will give you access to not only what features are offered but what options there are for each feature.

Manage Plans

When you need to work at the plan-specific level, you can dive into the same levels of detail. We have endpoints that give you the specifics of each plan, from currencies to capabilities. Importantly you can use our plan endpoints to return the checkout for each plan. With query parameters, you can customize the experience for your customer based on your setup. For instance, you can prefill email addresses and automatically apply coupon codes.

Manage Licenses

Licenses are what control access to your product. Using our API endpoints, you can create new licenses, delete them and of course, check them. Out licenses use grantee IDs which allow you flexibility in how you assign and check licenses. You set the Grantee IDs when you assign a license, and you decide how you will check them. For instance, you might use an email address, domain, team number, or any other value you choose as your method for assigning and checking licenses.

Manage Subscriptions

Subscriptions are how payments are taken and set up. They are separate from licenses to make it easier to work with clients who may want to pay from one account and assign a license to another account. With our subscription endpoints, you can get information on a specific subscription or cancel it.

In Summary

With our API endpoints, you can easily access the information you need. We have made use of expand query parameters to give you the ability to make as few or as many calls as you want to balance efficiency and performance. We built Salable with developers in mind and hope our APIs reflect that.

Check out the developer hub to learn more.

Tweet from Neal Riley saying "Commercial freedom and flexibility is a must for any digitally enabled business. @SalableApp gives you the tools to build your SaaS business."

Tweet from Neal Riley saying "Commercial freedom and flexibility is a must for any digitally enabled business. @SalableApp gives you the tools to build your SaaS business."