Purchase Details

This API gives the details of the subscription plans that the user has purcahsed.

Get the details of previously purchased subscriptions.

GET {API_URL}/client/purchases/subscriptions

Auth required: YES

Please pass your API key as the username and API secret as the password as Basic Auth to access the endpoint

Query Parameters

Name
DataType
Description
Type

userId

String

user id of the user

Optional

from

ISODateString

Start date-time for filtering purchases (ISO 8601 format)

Optional

to

ISODateString

End date-time for filtering purchases (ISO 8601 format)

Optional

phoneNumber

String

phone number of the user

Optional

email

String

email of the user

Optional

status

String

Subscription status filter (e.g. CHURNED, REVOKED, ACTIVE, INACTIVE, DELETED, REFUND_INITIATED)

Optional

updatedAtTo

String

Filter results for purchases updated before this date-time (ISO 8601 format)

Optional

updatedAtFrom

String

Filter results for purchases updated after this date-time (ISO 8601 format)

Optional

pageNumber

integer

The page number for pagination

Optional

pageSize

integer

The number of records per page for pagination

Optional

subscriptionID

String

unique id of the subscription plan

Optional

tierId

String

a unique identifier assigned to a plan based on duration

Optional

STATUS DEFINITION:

REVOKED: The user's purchase access has been manually revoked, regardless of its validity.

CHURNED: The user's purchase renewal failed repeatedly and reached the retry limit.

DELETED: The user's purchase record has been permanently removed from the system.

ACTIVE: The user has a valid, active purchase granting access to services or features.

INACTIVE: The user had a purchase, but it has expired and is no longer valid.

REFUND_INITIATED: A refund has been initiated for the user's purchase, pending processing.

PreviousIntegrating APIs(v2)NextUser Registered Or Not

Last updated