v1

latestOpenAPI 3.0.02026-07-266521,3121.2 MB
Auth

GetApplicationProfileBySecretKey

Returns current application subscription profile information for a given application for a specific user. You can use this method to get the current application subscription after AuthorizedByApplication returned a session. The session will contain Id, this is the UserId you need to supply in the call. If there are no current subscriptions for the application for the user. The method will return null (nothing) <b>Rate limit: </b><span style="background-color:#0272d9;color:white;padding:4px 8px;text-align:center;border-radius:5px; font-size: small;"><b>150</b></span> / minute

post/api/Auth/GetApplicationProfileBySecretKey

Request body

applicationIdstring uuid

Your application Id

applicationSecretstring uuid

Your application secret key

userIdstring uuid

User Id (Id field of the session)

Example request

{
  "applicationId": "00000000-0000-0000-0000-000000000000",
  "applicationSecret": "00000000-0000-0000-0000-000000000000",
  "userId": "00000000-0000-0000-0000-000000000000"
}

Response

OK

PlanTagstring

Plan Tag as defined in your Application Configuration

PlanNamestring

Plan Name as defined in your application Configuration

ActivationDatestring date-time

Date when the profile was signed up for, or resubscribed

LastPaymentDatestring date-time

Last Payment date

NextPaymentDatestring date-time

Next payment date

ProfileExpiresstring date-time

When profile is due to expire

IsProfileActiveboolean

Indicates whether the payment profile is active for the application, if this is set to false it means the customer canceled the profile but the profile is still active due last payment made in the last month.

All 652 operations