Nest Changelog
1.1.12
3/22/2022
1.1.13
3/25/2022
6 changed endpoints Collapse changed endpoints
GET /subscriptions/{id} 
Get a susbcription
Response Body
{
data: {
activation?: {
isActivated?: bool,
},
billingProvider?: {
accountId?: string,
customerId?: string,
name?: 'stripe' | 'ios' | 'android' | 'amazon',
orderId?: string,
},
cancellation?: {
dateCancelled?: number,
feedback?: string,
reason?: string,
},
createdBy?: {
id?: number,
},
dateCreated?: number,
dateUpdated?: number,
id?: number,
pause?: {
dateEnd?: number,
dateStart?: number,
reason?: string,
},
plan?: {
id?: number,
},
price?: {
currency?: string,
value?: number,
},
promotion?: {
id?: number,
},
renewal?: 'auto' | 'paused' | 'cancelled' | 'failed',
source?: {
accountId?: string,
lineItemId?: string,
name?: 'shopify' | 'amazon' | 'ios' | 'android' | 'organic' | 'free',
orderId?: string,
productId?: string,
},
status?: 'pending' | 'trialing' | 'active' | 'expired',
term?: {
dateEnd?: number,
dateStart?: number,
},
token?: string,
trial?: {
dateEnd?: number,
dateStart?: number,
},
updatedBy?: {
id?: number,
},
user?: {
id?: number,
},
},
}GET /subscriptions/{id}
Get a susbcription
Response Body
{
data: {
activation?: {
isActivated?: bool,
},
billingProvider?: {
accountId?: string,
customerId?: string,
name?: 'stripe' | 'ios' | 'android' | 'amazon',
orderId?: string,
},
cancellation?: {
dateCancelled?: number,
feedback?: string,
reason?: string,
},
createdBy?: {
id?: number,
},
dateCreated?: number,
dateUpdated?: number,
id?: number,
pause?: {
dateEnd?: number,
dateStart?: number,
reason?: string,
},
plan?: {
id?: number,
},
price?: {
currency?: string,
value?: number,
},
promotion?: {
id?: number,
},
renewal?: 'auto' | 'paused' | 'cancelled' | 'failed',
source?: {
accountId?: string,
lineItemId?: string,
name?: 'shopify' | 'amazon' | 'ios' | 'android' | 'organic' | 'free',
orderId?: string,
productId?: string,
},
status?: 'pending' | 'trialing' | 'active' | 'expired',
term?: {
dateEnd?: number,
dateStart?: number,
},
token?: string,
trial?: {
dateEnd?: number,
dateStart?: number,
},
updatedBy?: {
id?: number,
},
user?: {
id?: number,
},
+ utm: {
+ campaign?: string,
+ content?: string,
+ medium?: string,
+ source?: string,
+ },
},
}POST /subscriptions/{id}/activate
create a new subscription in stripe from shopify order, optionally applies a redemption code
Request Body
{
billingAddress?: {
city?: string,
country?: {
code?: string,
},
postalCode?: string,
region?: {
code?: string,
},
streetLine1?: string,
streetLine2?: string,
},
cardTokenId?: string,
email?: string,
firstName?: string,
lastName?: string,
phoneNumber?: string,
redemptionCode: string,
}POST /subscriptions/{id}/activate
create a new subscription in stripe from shopify order, optionally applies a redemption code
Request Body
{
billingAddress?: {
city?: string,
country?: {
code?: string,
},
postalCode?: string,
region?: {
code?: string,
},
streetLine1?: string,
streetLine2?: string,
},
cardTokenId?: string,
email?: string,
firstName?: string,
lastName?: string,
phoneNumber?: string,
redemptionCode: string,
+ utm: {
+ campaign?: string,
+ content?: string,
+ medium?: string,
+ source?: string,
+ },
}GET /equipment/models
Get a list of all available Equipment
Response Body
{
data: List<{
category: {
guid?: string,
name?: string,
},
dateAvailable?: number,
dateCreated?: number,
dateUpdated?: number,
id?: number,
image?: {
default: string,
large: string,
medium: string,
small: string,
url?: string,
},
name?: string,
pdf?: {
url?: string,
},
plans?: List<{
id?: number,
}>,
video?: {
url?: string,
},
}>,
}GET /equipment/models
Get a list of all available Equipment
Response Body
{
data: List<{
+ brand?: {
+ name?: string,
+ },
category: {
guid?: string,
name?: string,
},
dateAvailable?: number,
dateCreated?: number,
dateUpdated?: number,
id?: number,
image?: {
default: string,
large: string,
medium: string,
small: string,
url?: string,
},
name?: string,
pdf?: {
url?: string,
},
plans?: List<{
id?: number,
}>,
video?: {
url?: string,
},
}>,
}POST /equipment/models
Create a new equipment model
Request Body
{
dateAvailable?: number,
image?: {
data?: string,
filename?: string,
},
name?: string,
pdf: {
data?: string,
filename?: string,
},
plans?: List<{
id?: number,
}>,
video?: {
url?: string,
},
}Response Body
{
data: {
category: {
guid?: string,
name?: string,
},
dateAvailable?: number,
dateCreated?: number,
dateUpdated?: number,
id?: number,
image?: {
default: string,
large: string,
medium: string,
small: string,
url?: string,
},
name?: string,
pdf?: {
url?: string,
},
plans?: List<{
id?: number,
}>,
video?: {
url?: string,
},
},
}POST /equipment/models
Create a new equipment model
Request Body
{
+ brand?: {
+ name?: string,
+ },
dateAvailable?: number,
image?: {
data?: string,
filename?: string,
},
name?: string,
pdf: {
data?: string,
filename?: string,
},
plans?: List<{
id?: number,
}>,
video?: {
url?: string,
},
}Response Body
{
data: {
+ brand?: {
+ name?: string,
+ },
category: {
guid?: string,
name?: string,
},
dateAvailable?: number,
dateCreated?: number,
dateUpdated?: number,
id?: number,
image?: {
default: string,
large: string,
medium: string,
small: string,
url?: string,
},
name?: string,
pdf?: {
url?: string,
},
plans?: List<{
id?: number,
}>,
video?: {
url?: string,
},
},
}GET /equipment/models/{id}
Get a specific model of equipment
Response Body
{
data: {
category: {
guid?: string,
name?: string,
},
dateAvailable?: number,
dateCreated?: number,
dateUpdated?: number,
id?: number,
image?: {
default: string,
large: string,
medium: string,
small: string,
url?: string,
},
name?: string,
pdf?: {
url?: string,
},
plans?: List<{
id?: number,
}>,
video?: {
url?: string,
},
},
}GET /equipment/models/{id}
Get a specific model of equipment
Response Body
{
data: {
+ brand?: {
+ name?: string,
+ },
category: {
guid?: string,
name?: string,
},
dateAvailable?: number,
dateCreated?: number,
dateUpdated?: number,
id?: number,
image?: {
default: string,
large: string,
medium: string,
small: string,
url?: string,
},
name?: string,
pdf?: {
url?: string,
},
plans?: List<{
id?: number,
}>,
video?: {
url?: string,
},
},
}PATCH /equipment/models/{id}
Update an existing equipment model.
Request Body
{
dateAvailable: number,
image: {
data?: string,
filename?: string,
},
name: string,
pdf: {
data?: string,
filename?: string,
},
plans: List<{
id?: number,
}>,
video: {
url?: string,
},
}Response Body
{
data: {
category: {
guid?: string,
name?: string,
},
dateAvailable?: number,
dateCreated?: number,
dateUpdated?: number,
id?: number,
image?: {
default: string,
large: string,
medium: string,
small: string,
url?: string,
},
name?: string,
pdf?: {
url?: string,
},
plans?: List<{
id?: number,
}>,
video?: {
url?: string,
},
},
}PATCH /equipment/models/{id}
Update an existing equipment model.
Request Body
{
+ brand: {
+ name?: string,
+ },
dateAvailable: number,
image: {
data?: string,
filename?: string,
},
name: string,
pdf: {
data?: string,
filename?: string,
},
plans: List<{
id?: number,
}>,
video: {
url?: string,
},
}Response Body
{
data: {
+ brand?: {
+ name?: string,
+ },
category: {
guid?: string,
name?: string,
},
dateAvailable?: number,
dateCreated?: number,
dateUpdated?: number,
id?: number,
image?: {
default: string,
large: string,
medium: string,
small: string,
url?: string,
},
name?: string,
pdf?: {
url?: string,
},
plans?: List<{
id?: number,
}>,
video?: {
url?: string,
},
},
}