Overview

Sections

Theme switcher

Get Subscriptions

Header Parameters

Authorizationstring Required

Bearer token containing the user's access credentials for authorization purposes

StoreIdstring Required

StoreId API key provided by Tuned Global to authenticate and authorize access to the service

Path Parameters

idinteger Required

Unique identifier of the user whose subscriptions are being retrieved.

Response

200
Object

OK

Response Attributes

IsEnabledboolean

Indicates if the subscription is currently enabled and active.

SubscriptionIdnumber

Unique identifier for the specific subscription instance.

GroupIdstring

Identifier representing the subscription group or category.

PackageIdnumber

Unique identifier for the subscription package.

PackageCostIdnumber

Identifier for the cost associated with the subscription package.

Keystring

A unique key associated with the subscription for identification or referencing purposes.

StartDatestring

The start date of the subscription period in ISO 8601 format.

EndDatestring

The end date of the subscription period in ISO 8601 format.

IsAutoRenewboolean

Indicates whether the subscription is set to automatically renew at the end of its period.

Descriptionarray

A brief summary or details about the subscription.

Show child attributes

Namearray

The name assigned to the subscription plan.

Show child attributes

RenewalCostTitlearray

The title or description of the cost applied during subscription renewal.

Show child attributes

Periodobject

The duration or frequency of the subscription billing cycle (e.g., monthly, yearly).

Show child attributes

PackageCostobject

Total cost of the subscription package.

Show child attributes

RenewalCostIdnumber

Unique identifier for the cost associated with subscription renewal.

IsFutureActiveboolean

Indicates whether the subscription will become active at a future date.

MerchantCodestring

Code identifying the merchant or vendor linked to the subscription.

UserIdnumber

Unique identifier of the user associated with the subscription.

OwnerIdnumber

Identifier of the user who owns or manages the subscription.

RecurlyCodestring

Subscription code used within the Recurly billing system.

Sourceobject

Specific origin or channel through which the subscription was acquired.

Show child attributes

Was this section helpful?

GET

/

Select
1

Response

Was this section helpful?