App foundry free trials

[TheRealKevinGlinski]

We were told to use /api/v2/billing/premiumapplistings/{integration} to check if a user is licensed for our product and that the property previousFreeTrialDate would be set for the start of a free trial. We're seeing customers who have started free trials who don't have that field set. Also on the API response isAppOnSubscription is set to false and inside the offering list isOnSubscription is also false.

What is the right way to tell the following scenarios via this API:

1 - an org is on a paid subscription
2 - an org is on a free trial
3 - an org was on a free trial and then cancelled before the end of the trial

for 1 i assume isOnSubscription would be true. for 3, I assume that a 404 would be returned from the API but would like confirmation.

[tim.smith]

@TheRealKevinGlinski

We were told to use /api/v2/billing/premiumapplistings/{integration}

Who told you to use that? That's not a public endpoint and is not acceptable for use externally. Still working on tracking down an answer to your question.

[TheRealKevinGlinski]

I thought it was someone from the appfoundry team, but now I can't find any emails where it was mentioned so I'm not sure.

[tim.smith]

@TheRealKevinGlinski

What is the right way to tell the following scenarios via this API:

1 - an org is on a paid subscription
2 - an org is on a free trial
3 - an org was on a free trial and then cancelled before the end of the trial

I haven't found a direct answer to getting the status of the org, but I'm not entirely sure that information is available via a public endpoint. There are some docs on how you can get the org's subscription info though, which includes effective dates for several key points: https://developer.genesys.cloud/appfoundry/billing/usage-apis/#individual-customer-subscription

I don't have anything set up to test this, but I'm wondering if maybe the subscriptionType property might give you something useful. This endpoint isn't in the Public API, so it's undocumented except for what's in the link above.

[TheRealKevinGlinski]

I'll probably have to take this up with the app foundry team directly. the billable-vendor-usage-api API returns a 404 for a customer who is on trial.

[TheRealKevinGlinski]

@tim.smith that API is documented here: https://developer.genesys.cloud/appfoundry/free-trials When you search for it using the url it doesn't show in the search results, but if you search previoudFreeTrialDate it does.

[tim.smith]

Thanks! Looks like the actual release of the endpoint was missed since it's publicly documented there.