Get app subscription status

Get application status in an Ecwid store.

Access scopes

Requires the following access scope: read_store_profile

Response

A JSON object of type 'Application' with the following fields:

Application

FieldTypeDescription
subscription<SubscriptionDetails>Subscription details for the application
subscriptionStatusstringApplication status in Ecwid store. One of ACTIVE, SUSPENDED or TRIAL

SubscriptionDetails

FieldTypeDescription
startDatestringApp subscription start timestamp
expirationDatestringApp subscription end timestamp
statusstringSame as subscriptionStatus

Subscription statuses

Free apps:

  • Ecwid will always return ACTIVE unless application is uninstalled.

Paid apps using external billing:

  • Ecwid will always return ACTIVE unless application is uninstalled.

Paid apps using Ecwid billing:

  • Ecwid will return ACTIVE if application is successfully installed and paid by a user.
  • Ecwid will return SUSPENDED if there was an issue with prolongating subscription of this app.

Paid apps using Ecwid billing with free trial:

  • Ecwid will return TRIAL if this Ecwid store uses free trial of your application at the moment.
  • Ecwid will return ACTIVE if application is successfully installed and paid by a user.
  • Ecwid will return SUSPENDED if there was an issue with prolongating subscription of this app.

What is Ecwid billing and how do I use it?

Ecwid billing is a feature that allows to accept payments for applications. It works out of the box, so no additional development is required to use it. You can specify free trial period for new installs and active users pay on a monthly basis. To find out more details and how to use it, please visit: https://api-docs.ecwid.com/reference/billing

Language
Click Try It! to start a request and see the response here!