Pricing plans for your SSG instance can be publicly published. Your customers can get direct access to your pricing in machine readable form, or you can use to populate pricing on your website.

You select to publicly publish pricing in Configuration > Pricing. When you do so, your pricing is available in JSON format and accessed using a unique identifier, for example:

<https://ssg-portal.melroselabs.com/pubpricing/?6155ff08-3110-40d5-a530-67456a2d344a>

A request for the above shows the pricing for one of the Tyr SMS Gateway pricing plans (with pricing plan ID 6155ff08-3110-40d5-a530-67456a2) and returns the following JSON response:

{
   "meta":[
      {
         "name":"Tyr Bulk SMS PP",
         "notice":"1 day"
      }
   ],
   "current":[
      {
         "name":"United Kingdom",
         "alpha2":"GB",
         "prefix":"44",
         "price":"0.01600000",
         "currency":"GBP",
         "effective":"2021-01-01T00:00:00+00:00"
      }
   ],
   "future":[
      
   ]
}

Response definition

The meta array contains and object that shows the name of the pricing plan and the number of days notice for pricing changes.

The current array shows the current pricing. The definition of objects in this section is as follows:

Field	Description	Example
name	country name	United Kingdom
alpha2	country code ISO-3166	GB
prefix	country dialling prefix	44
network	mobile network name *	O2
mnc	(not currently shown)
price	message price	0.01600000
currency	currency symbol (GBP, EUR, etc)	GBP
type	price type (S: charged on submission, D: charged on delivery)	S
effective	date and time price took effect	2021-01-01T00:00:00+00:00

*not shown for "Country pricing"

The future array shows any future pricing. The definition of objects is identical to current.