List subscribers

GET

/storefronts/{storefront_id}/subscribers

const url = 'https://api.getdpd.com/v2/storefronts/1/subscribers';
const options = {method: 'GET', headers: {Authorization: 'Basic <credentials>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.getdpd.com/v2/storefronts/1/subscribers \
  --header 'Authorization: Basic <credentials>'

Authorizations

basicAuth

Parameters

Path Parameters

storefront_id

required

integer

Query Parameters

username

string

The subscriber’s username (their email address).

page

integer

>= 1

Page number, 100 records per page. Leave it off to try to get every record.

Responses

200

The storefront’s subscribers.

application/json

Array<object>

object

integer

created_at

UNIX timestamp (seconds).

integer

updated_at

UNIX timestamp (seconds).

integer

username

The subscriber’s email address.

string

last_login_at

UNIX timestamp (seconds).

integer

subscription

object

integer

status

NEW Not activated yet: checking out, or abandoned signup.
TRIAL In the trial period.
ACTIVE Active, no payment due.
CANCELED Canceled, but the current term hasn’t ended.
CLOSED Canceled and closed.
PAST_DUE Active, but a payment is overdue. Closes if it isn’t paid.

string

Allowed values: NEW TRIAL ACTIVE CANCELED CLOSED PAST_DUE

price

string

period

integer

unit

The billing period’s unit, one character.

string

tax_amount

string

trial_price

string

trial_period

integer

trial_unit

string

trial_tax_amount

string

created_at

UNIX timestamp (seconds).

integer

updated_at

UNIX timestamp (seconds).

integer

started_at

UNIX timestamp (seconds).

integer

ended_at

UNIX timestamp (seconds).

integer

trial_started_at

UNIX timestamp (seconds).

integer

last_payment_at

UNIX timestamp (seconds).

integer

next_payment_at

UNIX timestamp (seconds).

integer

Example

[
  {
    "subscription": {
      "status": "NEW",
      "price": "19.99",
      "tax_amount": "19.99",
      "trial_price": "19.99",
      "trial_tax_amount": "19.99"
    }
  }
]

401

The username or API password is wrong.

404

Nothing found: the record doesn’t exist or isn’t yours, the list is empty, or the page is past the last one.

application/json

object

status

string

Allowed value: NOTFOUND

Example

{
  "status": "NOTFOUND"
}