Download OpenAPI specification:Download
The fabric Subscriptions API lets your customers set recurring purchases of their desired products or services for a scheduled period (weekly, monthly, etc.). In addition, Subscriptions helps you retrieve and update subscription details, and lets your customers skip one or more subscription schedules, or remove a subscription.
These endpoints get one or all of your customers. If you request all customers, they will be sent paginated; you can specify the page size, and which page you want.
Get account details for a single customer
Request processed successfully
Bad request
Unauthorized access
{- "success": true,
- "responseStatus": "OK",
- "message": "Request processed successfully",
- "data": {
- "isDeleted": false,
- "deletedAt": "2021-04-03T14:19:30.701Z",
- "_id": "606879725b639b00084bc7f4",
- "paymentId": {
- "stripeId": "cus_JEdbwIO8xHi6xl"
}, - "customerEmail": "aliraza@aliraza.app",
- "merchantAccount": "5fc78dfc6135050007191290",
- "customerReferenceId": "60643519f56592000824273a",
- "customerFullName": "Ali Raza",
- "paymentMethodIds": [ ],
- "createdAt": "2021-04-03T14:19:30.701Z",
- "updatedAt": "2021-04-03T14:19:30.701Z"
}
}
Get account details for all customers
Request processed successfully
Unauthorized access
{- "success": true,
- "responseStatus": "OK",
- "message": "Request processed successfully",
- "data": {
- "customers": [
- {
- "isDeleted": false,
- "deletedAt": "2021-04-03T14:19:30.701Z",
- "_id": "606879725b639b00084bc7f4",
- "paymentId": {
- "stripeId": "cus_JEdbwIO8xHi6xl"
}, - "customerEmail": "aliraza@aliraza.app",
- "merchantAccount": "5fc78dfc6135050007191290",
- "customerReferenceId": "60643519f56592000824273a",
- "customerFullName": "Ali Raza",
- "paymentMethodIds": [ ],
- "createdAt": "2021-04-03T14:19:30.701Z",
- "updatedAt": "2021-04-03T14:19:30.701Z",
- "subscriptions": [
- {
- "count": 2,
- "_id": "61660b4301493d001175326a",
- "status_with_counts": [
- {
- "status": null,
- "count": null
}
]
}
]
}
]
}
}
Merchants create plans, to which customers can subscribe. A plan includes the product information, schedule, and associated details. Using these Plans endpoints, you can determine how many plans have been created, retrieve one or more plans, or delete a plan.
Get the total number of subscription plans, including counts per subscription status
Request processed successfully
Unauthorized access
{- "success": true,
- "responseStatus": "OK",
- "message": "Request processed successfully",
- "data": {
- "plansCount": 268,
- "statusCounts": [
- {
- "_id": "ACTIVE",
- "total": 257
}
]
}
}
Get all subscription plans for a given item ID
Plan IDs of plans to be returned
Request processed successfully
Bad request
{- "itemIds": [
- 1000000007
]
}
{- "success": true,
- "responseStatus": "OK",
- "message": "Request processed successfully",
- "data": {
- "1000000007": [
- {
- "_id": "6155a9334667170011a3e2c3",
- "isDeleted": false,
- "deletedAt": "2021-08-04T07:45:00.000Z",
- "title": "Weekly chocolate bars",
- "description": "Plan for chocolate bars to ship every 1 week",
- "discount": 10,
- "isTrialAllowed": false,
- "merchantAccount": "5f689caa4216e7000750d1ef",
- "status": "ACTIVE",
- "planGroup": "848c8e-b18c-134-8bbb-5a35f2158c37",
- "products": [
- {
- "_id": "6167c2e7900847001143ca8b",
- "itemId": 1000011310,
- "priceListId": 108674
}
], - "shippingCost": 10,
- "scheduledAt": "2021-10-12T21:34:39.000Z",
- "expireDate": "2021-10-20T20:15:00.000Z",
- "frequency": 2,
- "frequencyType": "Weekly",
- "attributes": [
- {
- "title": "Max Quantity",
- "fieldType": "NUMBER",
- "value": 10,
- "_id": "6167c2e7900847001143ca8c"
}
], - "lastPriceSycedAt": "2021-10-12T21:35:05.742Z",
- "createdAt": "2021-10-12T21:35:05.756Z",
- "updatedAt": "2021-10-14T05:40:55.997Z"
}
]
}
}
Get all plans that have been created for this merchant
Request processed successfully
Unauthorized access
{- "success": true,
- "responseStatus": "OK",
- "message": "Request processed successfully",
- "data": {
- "docs": [
- {
- "_id": "330fee0-e334-f71-4830-cfb0088285b",
- "count": 1,
- "plan": {
- "title": "Weekly chocolate bars",
- "description": "Plan for chocolate bars to ship every 1 week",
- "isTrialAllowed": false,
- "merchantAccount": "5f689caa4216e7000750d1ef",
- "status": "Active",
- "shippingCost": 1,
- "scheduledAt": "2021-10-12T21:34:39.000Z",
- "expireDate": "2021-10-20T20:15:00.000Z",
- "attributes": [
- {
- "title": "Max Quantity",
- "fieldType": "NUMBER",
- "value": 10,
- "_id": "6167c2e7900847001143ca8c"
}
], - "lastPriceSycedAt": "2021-10-12T21:35:05.742Z",
- "createdAt": "2021-10-12T21:35:05.756Z",
- "updatedAt": "2021-10-14T05:40:55.997Z"
}, - "frequencySettings": [
- {
- "_id": "6165ff891460d700105482af",
- "planGroup": "330fee0-e334-f71-4830-cfb0088285b",
- "frequency": 2,
- "frequencyType": "Weekly",
- "discount": 10,
- "isDeleted": false,
- "deletedAt": "2021-10-14T05:40:55.997Z"
}
]
}
]
}
}
Get a single plan
Request processed successfully
Unauthorized access
{- "success": true,
- "responseStatus": "OK",
- "message": "Request processed successfully",
- "data": {
- "plan": {
- "_id": "330fee0-e334-f71-4830-cfb0088285b",
- "count": 1,
- "plan": {
- "title": "Weekly chocolate bars",
- "description": "Plan for chocolate bars to ship every 1 week",
- "isTrialAllowed": false,
- "merchantAccount": "5f689caa4216e7000750d1ef",
- "status": "Active",
- "shippingCost": 1,
- "scheduledAt": "2021-10-12T21:34:39.000Z",
- "expireDate": "2021-10-20T20:15:00.000Z",
- "attributes": [
- {
- "title": "Max Quantity",
- "fieldType": "NUMBER",
- "value": 10,
- "_id": "6167c2e7900847001143ca8c"
}
], - "lastPriceSycedAt": "2021-10-12T21:35:05.742Z",
- "createdAt": "2021-10-12T21:35:05.756Z",
- "updatedAt": "2021-10-14T05:40:55.997Z"
}, - "frequencySettings": [
- {
- "_id": "6165ff891460d700105482af",
- "planGroup": "330fee0-e334-f71-4830-cfb0088285b",
- "frequency": 2,
- "frequencyType": "Weekly",
- "discount": 10,
- "isDeleted": false,
- "deletedAt": "2021-10-14T05:40:55.997Z"
}
], - "planProducts": [
- {
- "name": "Varnet Garden LED Spot Light",
- "sku": "13B9CL6WT2SLW",
- "itemId": 1000000006,
- "price": 2,
- "currency": "USD"
}
]
}
}
}
Delete a specific plan
Request processed successfully
Unauthorized access
{- "success": true,
- "responseStatus": "OK",
- "message": "Request processed successfully",
- "data": {
- "_id": "6155a9334667170011a3e2c3",
- "isDeleted": true,
- "deletedAt": "2021-08-04T07:45:00.000Z",
- "title": "Weekly chocolate bars",
- "description": "Plan for chocolate bars to ship every 1 week",
- "discount": 10,
- "isTrialAllowed": false,
- "merchantAccount": "5f689caa4216e7000750d1ef",
- "status": "DELETED",
- "planGroup": "848c8e-b18c-134-8bbb-5a35f2158c37",
- "products": [
- {
- "_id": "6167c2e7900847001143ca8b",
- "itemId": 1000011310,
- "priceListId": 108674
}
], - "shippingCost": 1,
- "scheduledAt": "2021-10-12T21:34:39.000Z",
- "expireDate": "2021-10-20T20:15:00.000Z",
- "frequency": 2,
- "frequencyType": "Weekly",
- "attributes": [
- {
- "title": "Max Quantity",
- "fieldType": "NUMBER",
- "value": 10,
- "_id": "6167c2e7900847001143ca8c"
}
], - "lastPriceSycedAt": "2021-10-12T21:35:05.742Z",
- "createdAt": "2021-10-12T21:35:05.756Z",
- "updatedAt": "2021-10-14T05:40:55.997Z"
}
}
These endpoints let your customers set recurring purchases of their desired products or services for a scheduled period (weekly, monthly, etc.). In addition, these endpoints let you get and update subscription details, and let your customers skip one or more subscription schedules, or remove a subscription.
Create a subscription. Details, including plan ID, item ID, and quantity are specified in the request body.
Request processed successfully
Bad request
{- "planId": "6155a9334667170011a3e2c3",
- "itemId": 1000000006,
- "childItems": [
- {
- "itemId": 1000000006,
- "quantity": 1
}
], - "quantity": 2,
- "customerEmail": "customer@mail.com",
- "customerReferenceId": "606f01f441b8fc0008529916",
- "customerFullName": "Pat E. Kake",
- "orderReferenceId": "6803-5058-41270",
- "paymentMethod": "paypal",
- "discount": 10,
- "tax": 10,
- "shippingCost": 1,
- "status": "ACTIVE",
- "shipTo": {
- "name": {
- "firstName": "Pat",
- "middleName": "E.",
- "lastName": "Kake"
}, - "streetAddress": {
- "street1": "27 O ST",
- "street2": "Apartment 2468"
}, - "phone": {
- "number": "555-555-1234"
}, - "id": "60cb0986559fbd000816afc2",
- "city": "Boston",
- "state": "MA",
- "zipCode": 2127,
- "country": "US"
}, - "billTo": {
- "name": {
- "firstName": "Pat",
- "middleName": "E.",
- "lastName": "Kake"
}, - "streetAddress": {
- "street1": "27 O ST",
- "street2": "Apartment 2468"
}, - "phone": {
- "number": "555-555-1234"
}, - "id": "60cb0986559fbd000816afc2",
- "city": "Boston",
- "state": "MA",
- "zipCode": 2127,
- "country": "US"
}, - "payment": {
- "billToAddress": {
- "name": {
- "first": "Pat",
- "last": "Kake"
}, - "phone": {
- "number": 4156529712,
- "kind": "mobile"
}, - "email": "test@mail.com",
- "street1": "27 O ST",
- "street2": "Apartment 2468",
- "city": "Boston",
- "state": "MA",
- "country": "US",
- "zipCode": 2116
}, - "shipToIds": [
- 2866
], - "_id": "60cb0986559fbd000816afc2",
- "paymentStatus": "succeeded",
- "amount": 117.4,
- "currency": "USD",
- "paymentIdentifier": {
- "cardIdentifier": "1234"
}, - "paymentMethod": "Stripe",
- "paymentKind": "CARD",
- "conversion": 1,
- "paymentToken": {
- "token": "pi_1J3GhrJxr7zyIFb9ooMrxEct",
- "type": "CARD"
}
}, - "channel": "WEBSITE",
- "itemAttributes": [
- {
- "_id": "60cb07fc20387b000821c5c3",
- "price": 1,
- "attributeId": "609436d21baded0008945b05",
- "name": "Custom Case",
- "value": "850004554074,CHOCOLATE SEA SALT",
- "type": "string"
}
], - "orderDetail": {
- "channel": 12,
- "currencyCode": "USD",
- "item": {
- "taxCode": "FR020000",
- "weight": 10,
- "weightUnit": "lb"
}, - "shipTo": {
- "taxCode": "FR020000",
- "shipmentCarrier": "USPS",
- "shipmentMethod": "Ground",
- "shipmentInstructions": "Leave on the porch"
}
}
}
{- "success": true,
- "responseStatus": "OK",
- "message": "Request processed successfully",
- "data": {
- "nextPaymentDate": "2025-10-17T10:00:01.199Z",
- "lastPaymentDate": "2021-10-15T13:37:24.727Z",
- "cancellationReason": "",
- "lastOrderReferenceId": "6803-5058-41272",
- "merchantAccount": "5f689caa4216e7000750d1ef",
- "frequency": 2,
- "frequencyType": "Weekly",
- "customerId": "61499d53bfbab400114475fa",
- "priceListId": 108015,
- "deletedAt": "2021-10-15T13:37:24.727Z",
- "isDeleted": false,
- "_id": "616984147da89c000824f483",
- "retryCount": 0,
- "paymentDetail": {
- "processor": "stripe"
}, - "planId": "6155a9334667170011a3e2c3",
- "itemId": 1000000006,
- "childItems": [
- {
- "_id": "6169b2d892a5f30009d76480",
- "itemId": 1000000006,
- "quantity": 1
}
], - "quantity": 2,
- "paymentMethod": "braintree",
- "discount": 10,
- "tax": 10,
- "shippingCost": 1,
- "status": "ACTIVE",
- "shipTo": {
- "name": {
- "firstName": "Pat",
- "middleName": "E.",
- "lastName": "Kake"
}, - "streetAddress": {
- "street1": "27 O ST",
- "street2": "Apartment 2468"
}, - "phone": {
- "number": "555-555-1234"
}, - "id": "60cb0986559fbd000816afc2",
- "city": "Boston",
- "state": "MA",
- "zipCode": 2127,
- "country": "US"
}, - "billTo": {
- "name": {
- "firstName": "Pat",
- "middleName": "E.",
- "lastName": "Kake"
}, - "streetAddress": {
- "street1": "27 O ST",
- "street2": "Apartment 2468"
}, - "phone": {
- "number": "555-555-1234"
}, - "id": "60cb0986559fbd000816afc2",
- "city": "Boston",
- "state": "MA",
- "zipCode": 2127,
- "country": "US"
}, - "payment": {
- "billToAddress": {
- "name": {
- "first": "Pat",
- "last": "Kake"
}, - "phone": {
- "number": 4156529712,
- "kind": "mobile"
}, - "email": "test@mail.com",
- "street1": "27 O ST",
- "street2": "Apartment 2468",
- "city": "Boston",
- "state": "MA",
- "country": "US",
- "zipCode": 2116
}, - "shipToIds": [
- 2866
], - "_id": "60cb0986559fbd000816afc2",
- "paymentStatus": "succeeded",
- "amount": 117.4,
- "currency": "USD",
- "paymentIdentifier": {
- "cardIdentifier": "1234"
}, - "paymentMethod": "Stripe",
- "paymentKind": "CARD",
- "conversion": 1,
- "paymentToken": {
- "token": "pi_1J3GhrJxr7zyIFb9ooMrxEct",
- "type": "CARD"
}
}, - "tags": [
- ""
], - "channel": "WEBSITE",
- "itemAttributes": [
- {
- "_id": "60cb07fc20387b000821c5c3",
- "price": 1,
- "attributeId": "609436d21baded0008945b05",
- "name": "Custom Case",
- "value": "850004554074,CHOCOLATE SEA SALT",
- "type": "string"
}
], - "nextShipDate": "2025-10-17T10:00:01.199Z",
- "updatedAt": "2025-10-17T10:00:01.199Z",
- "createdAt": "2025-10-17T10:00:01.199Z"
}
}
Update product quantity, billing and shipping frequency, shipping address, payment method, product tax, or shipping cost; cancel a subscription; change next payment date.
Request processed successfully
Bad request
Unauthorized access
{- "frequency": 2,
- "frequencyType": "Weekly",
- "quantity": 2,
- "orderReferenceId": "6803-5058-41270",
- "paymentMethod": "authorize.net",
- "discount": 10,
- "tax": 10,
- "shippingCost": 1,
- "status": "ACTIVE",
- "shipTo": {
- "name": {
- "firstName": "Pat",
- "middleName": "E.",
- "lastName": "Kake"
}, - "streetAddress": {
- "street1": "27 O ST",
- "street2": "Apartment 2468"
}, - "phone": {
- "number": "555-555-1234"
}, - "id": "60cb0986559fbd000816afc2",
- "city": "Boston",
- "state": "MA",
- "zipCode": 2127,
- "country": "US"
}, - "billTo": {
- "name": {
- "firstName": "Pat",
- "middleName": "E.",
- "lastName": "Kake"
}, - "streetAddress": {
- "street1": "27 O ST",
- "street2": "Apartment 2468"
}, - "phone": {
- "number": "555-555-1234"
}, - "id": "60cb0986559fbd000816afc2",
- "city": "Boston",
- "state": "MA",
- "zipCode": 2127,
- "country": "US"
}, - "channel": "WEBSITE",
- "itemAttributes": [
- {
- "_id": "60cb07fc20387b000821c5c3",
- "price": 1,
- "attributeId": "609436d21baded0008945b05",
- "name": "Custom Case",
- "value": "850004554074,CHOCOLATE SEA SALT",
- "type": "string"
}
], - "orderDetail": {
- "channel": 12,
- "currencyCode": "USD",
- "item": {
- "taxCode": "FR020000",
- "weight": 10,
- "weightUnit": "lb"
}, - "shipTo": {
- "taxCode": "FR020000",
- "shipmentCarrier": "USPS",
- "shipmentMethod": "Ground",
- "shipmentInstructions": "Leave on the porch"
}
}, - "nextPaymentDate": "2025-10-17T10:00:01.199Z"
}
{- "success": true,
- "responseStatus": "OK",
- "message": "Request processed successfully",
- "data": {
- "nextPaymentDate": "2025-10-17T10:00:01.199Z",
- "lastPaymentDate": "2021-10-15T13:37:24.727Z",
- "cancellationReason": "",
- "lastOrderReferenceId": "6803-5058-41272",
- "merchantAccount": "5f689caa4216e7000750d1ef",
- "frequency": 2,
- "frequencyType": "Weekly",
- "customerId": "61499d53bfbab400114475fa",
- "priceListId": 108015,
- "deletedAt": "2021-10-15T13:37:24.727Z",
- "isDeleted": false,
- "_id": "616984147da89c000824f483",
- "retryCount": 0,
- "paymentDetail": {
- "processor": "stripe"
}, - "planId": "6155a9334667170011a3e2c3",
- "itemId": 1000000006,
- "childItems": [
- {
- "_id": "6169b2d892a5f30009d76480",
- "itemId": 1000000006,
- "quantity": 1
}
], - "quantity": 2,
- "paymentMethod": "braintree",
- "discount": 10,
- "tax": 10,
- "shippingCost": 1,
- "status": "ACTIVE",
- "shipTo": {
- "name": {
- "firstName": "Pat",
- "middleName": "E.",
- "lastName": "Kake"
}, - "streetAddress": {
- "street1": "27 O ST",
- "street2": "Apartment 2468"
}, - "phone": {
- "number": "555-555-1234"
}, - "id": "60cb0986559fbd000816afc2",
- "city": "Boston",
- "state": "MA",
- "zipCode": 2127,
- "country": "US"
}, - "billTo": {
- "name": {
- "firstName": "Pat",
- "middleName": "E.",
- "lastName": "Kake"
}, - "streetAddress": {
- "street1": "27 O ST",
- "street2": "Apartment 2468"
}, - "phone": {
- "number": "555-555-1234"
}, - "id": "60cb0986559fbd000816afc2",
- "city": "Boston",
- "state": "MA",
- "zipCode": 2127,
- "country": "US"
}, - "payment": {
- "billToAddress": {
- "name": {
- "first": "Pat",
- "last": "Kake"
}, - "phone": {
- "number": 4156529712,
- "kind": "mobile"
}, - "email": "test@mail.com",
- "street1": "27 O ST",
- "street2": "Apartment 2468",
- "city": "Boston",
- "state": "MA",
- "country": "US",
- "zipCode": 2116
}, - "shipToIds": [
- 2866
], - "_id": "60cb0986559fbd000816afc2",
- "paymentStatus": "succeeded",
- "amount": 117.4,
- "currency": "USD",
- "paymentIdentifier": {
- "cardIdentifier": "1234"
}, - "paymentMethod": "Stripe",
- "paymentKind": "CARD",
- "conversion": 1,
- "paymentToken": {
- "token": "pi_1J3GhrJxr7zyIFb9ooMrxEct",
- "type": "CARD"
}
}, - "tags": [
- ""
], - "channel": "WEBSITE",
- "itemAttributes": [
- {
- "_id": "60cb07fc20387b000821c5c3",
- "price": 1,
- "attributeId": "609436d21baded0008945b05",
- "name": "Custom Case",
- "value": "850004554074,CHOCOLATE SEA SALT",
- "type": "string"
}
], - "nextShipDate": "2025-10-17T10:00:01.199Z",
- "updatedAt": "2025-10-17T10:00:01.199Z",
- "createdAt": "2025-10-17T10:00:01.199Z"
}
}
Get details of a single subscription
Request processed successfully
Bad request
Unauthorized access
{- "success": true,
- "responseStatus": "OK",
- "message": "Request processed successfully",
- "data": {
- "subscription": {
- "expireDate": null,
- "nextPaymentDate": "2025-10-17T10:00:01.199Z",
- "lastPaymentDate": "2021-10-15T13:37:24.727Z",
- "cancellationReason": "Cancelled by user",
- "lastOrderReferenceId": "6803-5058-41272",
- "merchantAccount": "5f689caa4216e7000750d1ef",
- "frequency": 2,
- "frequencyType": "Weekly",
- "priceListId": 108015,
- "deletedAt": "2021-10-15T13:37:24.727Z",
- "isDeleted": false,
- "_id": "616984147da89c000824f483",
- "retryCount": 3,
- "paymentDetail": {
- "processor": "stripe"
}, - "planID": {
- "isTrialAllowed": true,
- "isDeleted": false,
- "deletedAt": null,
- "_id": "6155a9334667170011a3e2c3",
- "title": "Weekly chocolate bars",
- "description": "Plan for chocolate bars to ship every 1 week",
- "products": [
- {
- "_id": "6167c2e7900847001143ca8b",
- "itemId": 1000011310,
- "priceListId": 108674
}
], - "frequency": 2,
- "frequencyType": "Weekly",
- "status": "ACTIVE",
- "discount": 10,
- "shippingCost": 2,
- "planGroup": "848c8e-b18c-134-8bbb-5a35f2158c37",
- "merchantAccount": "5f689caa4216e7000750d1ef",
- "scheduledAt": "2021-08-04T07:45:00.000Z",
- "expireDate": "2021-08-04T07:45:00.000Z",
- "charge": 2,
- "attributes": [
- {
- "title": "Max Quantity",
- "fieldType": "NUMBER",
- "value": 10,
- "_id": "6167c2e7900847001143ca8c"
}
], - "lastPriceSycedAt": "2021-08-04T07:45:00.000Z",
- "createdAt": "2021-08-04T07:45:00.000Z",
- "updatedAt": "2021-08-04T07:45:00.000Z"
}, - "customerId": {
- "_id": "61499d53bfbab400114475fa",
- "customerEmail": "test@mail.com"
}, - "itemId": 1000000006,
- "childItems": [
- {
- "itemId": 1000000006,
- "quantity": 1
}
], - "quantity": 2,
- "paymentMethod": "paypal",
- "discount": 10,
- "tax": 10,
- "shippingCost": 1,
- "status": "ACTIVE",
- "shipTo": {
- "name": {
- "firstName": "Pat",
- "middleName": "E.",
- "lastName": "Kake"
}, - "streetAddress": {
- "street1": "27 O ST",
- "street2": "Apartment 2468"
}, - "phone": {
- "number": "555-555-1234"
}, - "id": "60cb0986559fbd000816afc2",
- "city": "Boston",
- "state": "MA",
- "zipCode": 2127,
- "country": "US"
}, - "billTo": {
- "name": {
- "firstName": "Pat",
- "middleName": "E.",
- "lastName": "Kake"
}, - "streetAddress": {
- "street1": "27 O ST",
- "street2": "Apartment 2468"
}, - "phone": {
- "number": "555-555-1234"
}, - "id": "60cb0986559fbd000816afc2",
- "city": "Boston",
- "state": "MA",
- "zipCode": 2127,
- "country": "US"
}, - "isGift": false,
- "payment": {
- "billToAddress": {
- "name": {
- "first": "Pat",
- "last": "Kake"
}, - "phone": {
- "number": 4156529712,
- "kind": "mobile"
}, - "email": "test@mail.com",
- "street1": "27 O ST",
- "street2": "Apartment 2468",
- "city": "Boston",
- "state": "MA",
- "country": "US",
- "zipCode": 2116
}, - "shipToIds": [
- 2866
], - "_id": "60cb0986559fbd000816afc2",
- "paymentStatus": "succeeded",
- "amount": 117.4,
- "currency": "USD",
- "paymentIdentifier": {
- "cardIdentifier": "1234"
}, - "paymentMethod": "Stripe",
- "paymentKind": "CARD",
- "conversion": 1,
- "paymentToken": {
- "token": "pi_1J3GhrJxr7zyIFb9ooMrxEct",
- "type": "CARD"
}
}, - "tags": [
- ""
], - "channel": "WEBSITE",
- "itemAttributes": [
- {
- "_id": "60cb07fc20387b000821c5c3",
- "price": 1,
- "attributeId": "609436d21baded0008945b05",
- "name": "Custom Case",
- "value": "850004554074,CHOCOLATE SEA SALT",
- "type": "string"
}
], - "nextShipDate": "2025-10-17T10:00:01.199Z",
- "updatedAt": "2025-10-17T10:00:01.199Z",
- "createdAt": "2025-10-17T10:00:01.199Z"
}, - "subscriptionItems": [
- {
- "name": "Varnet Garden LED Spot Light",
- "sku": "13B9CL6WT2SLW",
- "defaultPrice": 100,
- "promotionPrice": 80,
- "subscriptionPrice": 90,
- "itemId": 1000000006,
- "quantity": 8,
}
], - "nextSubscriptions": [
- {
- "deliveryDate": "2021-10-15T13:37:27.204Z",
- "paymentStatus": "PAID"
}
]
}
}
Delete a single subscription
Request processed successfully
Bad request
Unauthorized access
{- "success": true,
- "responseStatus": "OK",
- "message": "Request processed successfully",
- "data": {
- "nextPaymentDate": "2025-10-17T10:00:01.199Z",
- "lastPaymentDate": "2021-10-15T13:37:24.727Z",
- "cancellationReason": "",
- "lastOrderReferenceId": "6803-5058-41272",
- "merchantAccount": "5f689caa4216e7000750d1ef",
- "frequency": 2,
- "frequencyType": "Weekly",
- "customerId": "61499d53bfbab400114475fa",
- "priceListId": 108015,
- "deletedAt": "2021-10-15T13:37:24.727Z",
- "isDeleted": false,
- "_id": "616984147da89c000824f483",
- "retryCount": 0,
- "paymentDetail": {
- "processor": "stripe"
}, - "planId": "6155a9334667170011a3e2c3",
- "itemId": 1000000006,
- "childItems": [
- {
- "_id": "6169b2d892a5f30009d76480",
- "itemId": 1000000006,
- "quantity": 1
}
], - "quantity": 2,
- "paymentMethod": "braintree",
- "discount": 10,
- "tax": 10,
- "shippingCost": 1,
- "status": "ACTIVE",
- "shipTo": {
- "name": {
- "firstName": "Pat",
- "middleName": "E.",
- "lastName": "Kake"
}, - "streetAddress": {
- "street1": "27 O ST",
- "street2": "Apartment 2468"
}, - "phone": {
- "number": "555-555-1234"
}, - "id": "60cb0986559fbd000816afc2",
- "city": "Boston",
- "state": "MA",
- "zipCode": 2127,
- "country": "US"
}, - "billTo": {
- "name": {
- "firstName": "Pat",
- "middleName": "E.",
- "lastName": "Kake"
}, - "streetAddress": {
- "street1": "27 O ST",
- "street2": "Apartment 2468"
}, - "phone": {
- "number": "555-555-1234"
}, - "id": "60cb0986559fbd000816afc2",
- "city": "Boston",
- "state": "MA",
- "zipCode": 2127,
- "country": "US"
}, - "payment": {
- "billToAddress": {
- "name": {
- "first": "Pat",
- "last": "Kake"
}, - "phone": {
- "number": 4156529712,
- "kind": "mobile"
}, - "email": "test@mail.com",
- "street1": "27 O ST",
- "street2": "Apartment 2468",
- "city": "Boston",
- "state": "MA",
- "country": "US",
- "zipCode": 2116
}, - "shipToIds": [
- 2866
], - "_id": "60cb0986559fbd000816afc2",
- "paymentStatus": "succeeded",
- "amount": 117.4,
- "currency": "USD",
- "paymentIdentifier": {
- "cardIdentifier": "1234"
}, - "paymentMethod": "Stripe",
- "paymentKind": "CARD",
- "conversion": 1,
- "paymentToken": {
- "token": "pi_1J3GhrJxr7zyIFb9ooMrxEct",
- "type": "CARD"
}
}, - "tags": [
- ""
], - "channel": "WEBSITE",
- "itemAttributes": [
- {
- "_id": "60cb07fc20387b000821c5c3",
- "price": 1,
- "attributeId": "609436d21baded0008945b05",
- "name": "Custom Case",
- "value": "850004554074,CHOCOLATE SEA SALT",
- "type": "string"
}
], - "nextShipDate": "2025-10-17T10:00:01.199Z",
- "updatedAt": "2025-10-17T10:00:01.199Z",
- "createdAt": "2025-10-17T10:00:01.199Z"
}
}
Get order by specifying order ID
Request processed successfully
Bad request
Unauthorized access
{- "success": true,
- "responseStatus": "OK",
- "message": "Request processed successfully",
- "data": {
- "order": {
- "frequency": 2,
- "frequencyType": "Weekly",
- "customerReferenceId": "606f01f441b8fc0008529916",
- "deletedAt": "2021-10-15T13:37:24.727Z",
- "isDeleted": false,
- "subscriptionId": "616984147da89c000824f483",
- "_id": "616984147da89c000824f483",
- "paymentDetail": {
- "processor": "stripe"
}, - "planId": "6155a9334667170011a3e2c3",
- "itemId": 1000000006,
- "itemName": "Varnet Garden LED Spot Light",
- "orderReferenceId": "6803-5058-41298",
- "childItems": [
- {
- "itemId": 1000000006,
- "quantity": 1
}
], - "quantity": 2,
- "paymentMethod": "stripe",
- "discount": 10,
- "tax": 10,
- "totalAmount": 12,
- "shippingCost": 1,
- "paymentStatus": "PAID",
- "paymentDate": "2021-09-21T08:57:23.316Z",
- "shipTo": {
- "name": {
- "firstName": "Pat",
- "middleName": "E.",
- "lastName": "Kake"
}, - "streetAddress": {
- "street1": "27 O ST",
- "street2": "Apartment 2468"
}, - "phone": {
- "number": "555-555-1234"
}, - "id": "60cb0986559fbd000816afc2",
- "city": "Boston",
- "state": "MA",
- "zipCode": 2127,
- "country": "US"
}, - "billTo": {
- "name": {
- "firstName": "Pat",
- "middleName": "E.",
- "lastName": "Kake"
}, - "streetAddress": {
- "street1": "27 O ST",
- "street2": "Apartment 2468"
}, - "phone": {
- "number": "555-555-1234"
}, - "id": "60cb0986559fbd000816afc2",
- "city": "Boston",
- "state": "MA",
- "zipCode": 2127,
- "country": "US"
}, - "payment": {
- "billToAddress": {
- "name": {
- "first": "Pat",
- "last": "Kake"
}, - "phone": {
- "number": 4156529712,
- "kind": "mobile"
}, - "email": "test@mail.com",
- "street1": "27 O ST",
- "street2": "Apartment 2468",
- "city": "Boston",
- "state": "MA",
- "country": "US",
- "zipCode": 2116
}, - "shipToIds": [
- 2866
], - "_id": "60cb0986559fbd000816afc2",
- "paymentStatus": "succeeded",
- "amount": 117.4,
- "currency": "USD",
- "paymentIdentifier": {
- "cardIdentifier": "1234"
}, - "paymentMethod": "Stripe",
- "paymentKind": "CARD",
- "conversion": 1,
- "paymentToken": {
- "token": "pi_1J3GhrJxr7zyIFb9ooMrxEct",
- "type": "CARD"
}
}, - "updatedAt": "2025-10-17T10:00:01.199Z",
- "createdAt": "2025-10-17T10:00:01.199Z"
}
}
}
Get all orders for a specific customer by specifying the customer reference ID
Request processed successfully
Unauthorized access
{- "success": true,
- "responseStatus": "OK",
- "message": "Request processed successfully",
- "data": {
- "orders": [
- {
- "frequency": 2,
- "frequencyType": "Weekly",
- "customerReferenceId": "606f01f441b8fc0008529916",
- "deletedAt": "2021-10-15T13:37:24.727Z",
- "isDeleted": false,
- "subscriptionId": "616984147da89c000824f483",
- "_id": "616984147da89c000824f483",
- "paymentDetail": {
- "processor": "stripe"
}, - "planId": "6155a9334667170011a3e2c3",
- "itemId": 1000000006,
- "itemName": "Varnet Garden LED Spot Light",
- "orderReferenceId": "6803-5058-41298",
- "childItems": [
- {
- "itemId": 1000000006,
- "quantity": 1
}
], - "quantity": 2,
- "paymentMethod": "stripe",
- "discount": 10,
- "tax": 10,
- "totalAmount": 12,
- "shippingCost": 1,
- "paymentStatus": "PAID",
- "paymentDate": "2021-09-21T08:57:23.316Z",
- "shipTo": {
- "name": {
- "firstName": "Pat",
- "middleName": "E.",
- "lastName": "Kake"
}, - "streetAddress": {
- "street1": "27 O ST",
- "street2": "Apartment 2468"
}, - "phone": {
- "number": "555-555-1234"
}, - "id": "60cb0986559fbd000816afc2",
- "city": "Boston",
- "state": "MA",
- "zipCode": 2127,
- "country": "US"
}, - "billTo": {
- "name": {
- "firstName": "Pat",
- "middleName": "E.",
- "lastName": "Kake"
}, - "streetAddress": {
- "street1": "27 O ST",
- "street2": "Apartment 2468"
}, - "phone": {
- "number": "555-555-1234"
}, - "id": "60cb0986559fbd000816afc2",
- "city": "Boston",
- "state": "MA",
- "zipCode": 2127,
- "country": "US"
}, - "payment": {
- "billToAddress": {
- "name": {
- "first": "Pat",
- "last": "Kake"
}, - "phone": {
- "number": 4156529712,
- "kind": "mobile"
}, - "email": "test@mail.com",
- "street1": "27 O ST",
- "street2": "Apartment 2468",
- "city": "Boston",
- "state": "MA",
- "country": "US",
- "zipCode": 2116
}, - "shipToIds": [
- 2866
], - "_id": "60cb0986559fbd000816afc2",
- "paymentStatus": "succeeded",
- "amount": 117.4,
- "currency": "USD",
- "paymentIdentifier": {
- "cardIdentifier": "1234"
}, - "paymentMethod": "Stripe",
- "paymentKind": "CARD",
- "conversion": 1,
- "paymentToken": {
- "token": "pi_1J3GhrJxr7zyIFb9ooMrxEct",
- "type": "CARD"
}
}, - "updatedAt": "2025-10-17T10:00:01.199Z",
- "createdAt": "2025-10-17T10:00:01.199Z"
}
]
}
}
Get all scheduled orders by specifying customer reference ID
Request processed successfully
Bad request
Unauthorized access
{- "success": true,
- "responseStatus": "OK",
- "message": "Request processed successfully",
- "data": {
- "scheduledSubscriptions": [
- {
- "subscription": {
- "nextPaymentDate": "2025-10-17T10:00:01.199Z",
- "lastPaymentDate": "2021-10-15T13:37:24.727Z",
- "cancellationReason": "",
- "lastOrderReferenceId": "6803-5058-41272",
- "merchantAccount": "5f689caa4216e7000750d1ef",
- "frequency": 2,
- "frequencyType": "Weekly",
- "customerId": "61499d53bfbab400114475fa",
- "priceListId": 108015,
- "deletedAt": "2021-10-15T13:37:24.727Z",
- "isDeleted": false,
- "_id": "616984147da89c000824f483",
- "retryCount": 0,
- "paymentDetail": {
- "processor": "stripe"
}, - "planId": "6155a9334667170011a3e2c3",
- "itemId": 1000000006,
- "childItems": [
- {
- "_id": "6169b2d892a5f30009d76480",
- "itemId": 1000000006,
- "quantity": 1
}
], - "quantity": 2,
- "paymentMethod": "braintree",
- "discount": 10,
- "tax": 10,
- "shippingCost": 1,
- "status": "ACTIVE",
- "shipTo": {
- "name": {
- "firstName": "Pat",
- "middleName": "E.",
- "lastName": "Kake"
}, - "streetAddress": {
- "street1": "27 O ST",
- "street2": "Apartment 2468"
}, - "phone": {
- "number": "555-555-1234"
}, - "id": "60cb0986559fbd000816afc2",
- "city": "Boston",
- "state": "MA",
- "zipCode": 2127,
- "country": "US"
}, - "billTo": {
- "name": {
- "firstName": "Pat",
- "middleName": "E.",
- "lastName": "Kake"
}, - "streetAddress": {
- "street1": "27 O ST",
- "street2": "Apartment 2468"
}, - "phone": {
- "number": "555-555-1234"
}, - "id": "60cb0986559fbd000816afc2",
- "city": "Boston",
- "state": "MA",
- "zipCode": 2127,
- "country": "US"
}, - "payment": {
- "billToAddress": {
- "name": {
- "first": null,
- "last": null
}, - "phone": {
- "number": null,
- "kind": null
}, - "email": "test@mail.com",
- "street1": "27 O ST",
- "street2": "Apartment 2468",
- "city": "Boston",
- "state": "MA",
- "country": "US",
- "zipCode": 2116
}, - "shipToIds": [
- 2866
], - "_id": "60cb0986559fbd000816afc2",
- "paymentStatus": "succeeded",
- "amount": 117.4,
- "currency": "USD",
- "paymentIdentifier": {
- "cardIdentifier": "1234"
}, - "paymentMethod": "Stripe",
- "paymentKind": "CARD",
- "conversion": 1,
- "paymentToken": {
- "token": "pi_1J3GhrJxr7zyIFb9ooMrxEct",
- "type": "CARD"
}
}, - "tags": [
- ""
], - "channel": "WEBSITE",
- "itemAttributes": [
- {
- "_id": "60cb07fc20387b000821c5c3",
- "price": 1,
- "attributeId": "609436d21baded0008945b05",
- "name": "Custom Case",
- "value": "850004554074,CHOCOLATE SEA SALT",
- "type": "string"
}
], - "nextShipDate": "2025-10-17T10:00:01.199Z",
- "updatedAt": "2025-10-17T10:00:01.199Z",
- "createdAt": "2025-10-17T10:00:01.199Z"
}, - "schedules": [
- {
- "deliveryDate": "2021-09-03T10:49:12.171Z",
- "paymentStatus": "PAID"
}
]
}
]
}
}
Get all orders for a given subscription by specifying the subscription ID
Request processed successfully
Bad request
Unauthorized access
{- "success": true,
- "responseStatus": "OK",
- "message": "Request processed successfully",
- "data": {
- "subscription": {
- "nextPaymentDate": "2025-10-17T10:00:01.199Z",
- "lastPaymentDate": "2021-10-15T13:37:24.727Z",
- "cancellationReason": "",
- "lastOrderReferenceId": "6803-5058-41272",
- "merchantAccount": "5f689caa4216e7000750d1ef",
- "frequency": 2,
- "frequencyType": "Weekly",
- "customerId": "61499d53bfbab400114475fa",
- "priceListId": 108015,
- "deletedAt": "2021-10-15T13:37:24.727Z",
- "isDeleted": false,
- "_id": "616984147da89c000824f483",
- "retryCount": 0,
- "paymentDetail": {
- "processor": "stripe"
}, - "planId": "6155a9334667170011a3e2c3",
- "itemId": 1000000006,
- "childItems": [
- {
- "_id": "6169b2d892a5f30009d76480",
- "itemId": 1000000006,
- "quantity": 1
}
], - "quantity": 2,
- "paymentMethod": "braintree",
- "discount": 10,
- "tax": 10,
- "shippingCost": 1,
- "status": "ACTIVE",
- "shipTo": {
- "name": {
- "firstName": "Pat",
- "middleName": "E.",
- "lastName": "Kake"
}, - "streetAddress": {
- "street1": "27 O ST",
- "street2": "Apartment 2468"
}, - "phone": {
- "number": "555-555-1234"
}, - "id": "60cb0986559fbd000816afc2",
- "city": "Boston",
- "state": "MA",
- "zipCode": 2127,
- "country": "US"
}, - "billTo": {
- "name": {
- "firstName": "Pat",
- "middleName": "E.",
- "lastName": "Kake"
}, - "streetAddress": {
- "street1": "27 O ST",
- "street2": "Apartment 2468"
}, - "phone": {
- "number": "555-555-1234"
}, - "id": "60cb0986559fbd000816afc2",
- "city": "Boston",
- "state": "MA",
- "zipCode": 2127,
- "country": "US"
}, - "payment": {
- "billToAddress": {
- "name": {
- "first": "Pat",
- "last": "Kake"
}, - "phone": {
- "number": 4156529712,
- "kind": "mobile"
}, - "email": "test@mail.com",
- "street1": "27 O ST",
- "street2": "Apartment 2468",
- "city": "Boston",
- "state": "MA",
- "country": "US",
- "zipCode": 2116
}, - "shipToIds": [
- 2866
], - "_id": "60cb0986559fbd000816afc2",
- "paymentStatus": "succeeded",
- "amount": 117.4,
- "currency": "USD",
- "paymentIdentifier": {
- "cardIdentifier": "1234"
}, - "paymentMethod": "Stripe",
- "paymentKind": "CARD",
- "conversion": 1,
- "paymentToken": {
- "token": "pi_1J3GhrJxr7zyIFb9ooMrxEct",
- "type": "CARD"
}
}, - "tags": [
- ""
], - "channel": "WEBSITE",
- "itemAttributes": [
- {
- "_id": "60cb07fc20387b000821c5c3",
- "price": 1,
- "attributeId": "609436d21baded0008945b05",
- "name": "Custom Case",
- "value": "850004554074,CHOCOLATE SEA SALT",
- "type": "string"
}
], - "nextShipDate": "2025-10-17T10:00:01.199Z",
- "updatedAt": "2025-10-17T10:00:01.199Z",
- "createdAt": "2025-10-17T10:00:01.199Z"
}, - "orderAttempts": [
- {
- "paymentDate": "2021-09-21T08:57:23.316Z",
- "orderReferenceId": "6803-5058-41298",
- "customerReferenceId": "606f01f441b8fc0008529916",
- "totalAmount": 18,
- "subscriptionId": "61499e72bfbab40011447634",
- "frequency": 2,
- "frequencyType": "Weekly",
- "deletedAt": "2021-10-15T13:37:24.727Z",
- "isDeleted": false,
- "_id": "616984147da89c000824f483",
- "paymentDetails": {
- "processor": "stripe"
}, - "planId": "6155a9334667170011a3e2c3",
- "itemId": 1000000006,
- "itemName": "Varnet Garden LED Spot Light",
- "childItems": [
- {
- "itemId": 1000000006,
- "quantity": 1
}
], - "quantity": 2,
- "paymentMethod": "stripe",
- "discount": 10,
- "tax": 10,
- "shippingCost": 1,
- "status": "ACTIVE",
- "shipTo": {
- "name": {
- "firstName": "Pat",
- "middleName": "E.",
- "lastName": "Kake"
}, - "streetAddress": {
- "street1": "27 O ST",
- "street2": "Apartment 2468"
}, - "phone": {
- "number": "555-555-1234"
}, - "id": "60cb0986559fbd000816afc2",
- "city": "Boston",
- "state": "MA",
- "zipCode": 2127,
- "country": "US"
}, - "billTo": {
- "name": {
- "firstName": "Pat",
- "middleName": "E.",
- "lastName": "Kake"
}, - "streetAddress": {
- "street1": "27 O ST",
- "street2": "Apartment 2468"
}, - "phone": {
- "number": "555-555-1234"
}, - "id": "60cb0986559fbd000816afc2",
- "city": "Boston",
- "state": "MA",
- "zipCode": 2127,
- "country": "US"
}, - "payment": {
- "billToAddress": {
- "name": {
- "first": "Pat",
- "last": "Kake"
}, - "phone": {
- "number": 4156529712,
- "kind": "mobile"
}, - "email": "test@mail.com",
- "street1": "27 O ST",
- "street2": "Apartment 2468",
- "city": "Boston",
- "state": "MA",
- "country": "US",
- "zipCode": 2116
}, - "shipToIds": [
- 2866
], - "_id": "60cb0986559fbd000816afc2",
- "paymentStatus": "succeeded",
- "amount": 117.4,
- "currency": "USD",
- "paymentIdentifier": {
- "cardIdentifier": "1234"
}, - "paymentMethod": "Stripe",
- "paymentKind": "CARD",
- "conversion": 1,
- "paymentToken": {
- "token": "pi_1J3GhrJxr7zyIFb9ooMrxEct",
- "type": "CARD"
}
}, - "updatedAt": "2025-10-17T10:00:01.199Z",
- "createdAt": "2025-10-17T10:00:01.199Z"
}
]
}
}
Skip the next order for a specific subscription
Request processed successfully
Bad request
Unauthorized access
{- "skipDate": "2024-02-20T10:00:01.199Z",
- "skip": true
}
{- "success": true,
- "responseStatus": "OK",
- "message": "Request processed successfully",
- "data": {
- "_id": "6149b1726a9f860011a9fb5a",
- "subscriptionId": "6149b081dddaad0011c1394d",
- "skipDate": "2024-02-20T00:00:00.000Z"
}
}