Subscription

subscriptionId

string

Unique ID of the subscription

originalSubscriptionId

string

Unique ID of the original subscription, if empty this is the first time user bought subscription for product

clientId

string

Your client ID

userId

string

User id who bought the subscription

productId

string

Unique product ID

parentProductId

string

ID of the parent product, if any

identifierId

string

ID of the payment identifier that will be used to renew the subscription

paymentType

Payment type

0 for SPiD Platform, 1 for Payment Platform

orderId

string

ID of the original order

startDate

datetime

From when the subscription is/was active

originalPurchaseDate

datetime

When the subscription was originally purchased

expires

datetime

When the subscription expires

autoRenew

string, "1" (true) or "0" (false)

If "1", the subscription will automatically renew on the expires date.

renewPrice

price

The price of renewal, in cents

currency

string

The renewal price currency

renewPeriod

timestamp, in seconds

Renewal period

autoRenewLockPeriod

timestamp, in seconds

Length of the initial period after activation during which it is not allowed to change the auto renew setting for the subscription.

stopRenewalAfterLock

string, "1" (true) or "0" (false)

When "1", the subscription's auto renew will be stoped after the lock period is over.

autoRenewDisabled

string, "1" (true) or "0" (false)

When "1", the subscription's auto renew cannot be changed.

gracePeriod

timestamp, in seconds

The length of the period the subscription stays active after charging for a renewal fails.

emailReceiptCount

integer (as string)

The number of receipts sent via email to the user

finalEndDate

datetime

If provided, this date denotes the time when the subscription will no longer be available for sale.

chargeRetryCount

integer (as string)

The number of times the previous charge has been retried

chargeLastRetry

datetime

Time of the last charge retry

status

Subscription status

The subscription's current status

statusChangeCode

Subscription status change code

A description of the last change to the subscription's status

statusChangeDate

datetime

The date of the last change to the subscription's status

updated

datetime

Date and time of last update to the subscription

created

datetime

Date and time when the subscription was created

product

Product

The product this subscription belongs to

The check mark indicates that the field always contains a valid non-empty value.

Subscription status

An enum, with the following possible values:

"-1"

Expired

"0"

Inactive

"1"

Active

Subscription status change code

An enum, with the following possible values:

"100"

Subscription expired via multiple failed payment method charge attempts

"110"

Subscription expired via API

"120"

Subscription expired passively (auto_renew is off)

"130"

Subscription expired by force

"140"

Subscription expired because it is no longer for sale

"150"

Subscription expired because it was renewed (i.e., a new subscription has been created)

"160"

Subscription expired because the user deleted their account

"170"

Subscription was paused

"180"

Expiry date was changed

"190"

Subscription expired because the user disabled auto renewal

Comments/feedback

Do you have questions, or just want to contribute some newly gained insight? Want to share an example? Please leave a comment. SPiD reads and responds to every question. Additionally, your experience can help others using SPiD, and it can help us continuously improve our documentation.