Get all subscriptions

curl --request GET \
  --url https://prod01.copilot.fabric.inc/data-subscription/v1/subscriptions \
  --header 'Authorization: Bearer <token>'

{
  "responseStatus": "OK",
  "message": "Request processed successfully",
  "data": {
    "subscriptions": [
      {
        "id": "6256610bc312410009b7390b",
        "customer": {
          "id": "62cffd65e8d7eb868c6a29d6",
          "customerReferenceId": "12345",
          "locale": "en_US",
          "email": "[email protected]",
          "contactNumber": "+923333709568",
          "firstName": "Pat",
          "middleName": "E",
          "lastName": "Kake",
          "segment": [
            "employee"
          ],
          "employeeId": "345",
          "communicationPreference": {
            "email": true,
            "sms": true
          },
          "status": "ACTIVE",
          "createdAt": "2021-10-12T21:35:05.756Z",
          "updatedAt": "2021-10-14T05:40:55.997Z"
        },
        "item": {
          "id": 1000000006,
          "sku": "MOBO-X570",
          "quantity": 1,
          "itemPrice": {
            "price": 100,
            "currencyCode": "USD"
          },
          "weight": 10,
          "weightUnit": "lb",
          "title": "Vitamin",
          "description": "Vitamin C",
          "tax": {
            "taxCode": "FR020000",
            "taxAmount": 10,
            "currencyCode": "USD"
          }
        },
        "plan": {
          "frequency": 30,
          "frequencyType": "Daily",
          "id": "1001"
        },
        "offer": {
          "id": "SUB-E10717",
          "source": "PDP"
        },
        "shipping": {
          "shipmentCarrier": "USPS",
          "shipmentMethod": "Ground",
          "shipmentInstructions": "Please leave the package in the box",
          "taxCode": "SHP020000",
          "shippingAmount": 10,
          "taxAmount": 1,
          "currencyCode": "USD"
        },
        "expiry": {
          "expiryDate": "2022-07-18T09:16:11.437Z",
          "billingCycles": 2
        },
        "shipTo": {
          "name": {
            "firstName": "Pat",
            "lastName": "Kake",
            "middleName": "E"
          },
          "streetAddress": {
            "street1": "123 Main St",
            "street2": "Suite 100"
          },
          "city": "Boston",
          "state": "MA",
          "postalCode": "02127",
          "country": "US",
          "phone": {
            "number": "5555551234",
            "kind": "home"
          }
        },
        "billTo": {
          "name": {
            "firstName": "Pat",
            "lastName": "Kake",
            "middleName": "E"
          },
          "streetAddress": {
            "street1": "123 Main St",
            "street2": "Suite 100"
          },
          "city": "Boston",
          "state": "MA",
          "postalCode": "02127",
          "country": "US",
          "phone": {
            "number": "5555551234",
            "kind": "home"
          }
        },
        "paymentDetails": {
          "paymentIdentifier": {
            "cardIdentifier": "1234",
            "expiryDate": "12/20"
          },
          "paymentMethod": "credit_card",
          "paymentKind": "Visa"
        },
        "customAttributes": {
          "storeId": "60cb07fc20387b000821c5c3",
          "associateId": 1,
          "trackingUrl": "609436d21baded0008945b05"
        },
        "status": "ACTIVE",
        "isDeleted": false,
        "deletedAt": "2019-01-01T00:00:00.000Z",
        "channel": "WEBSITE",
        "originOrderId": "22-4498-4800",
        "offsetDays": 2,
        "createdAt": "2021-10-12T21:35:05.756Z",
        "updatedAt": "2021-10-14T05:40:55.997Z",
        "statusUpdatedAt": "2021-10-14T10:24:36.468Z"
      }
    ],
    "query": {
      "limit": 10,
      "offset": 10,
      "count": 100
    }
  }
}

GET

subscriptions

curl --request GET \
  --url https://prod01.copilot.fabric.inc/data-subscription/v1/subscriptions \
  --header 'Authorization: Bearer <token>'

{
  "responseStatus": "OK",
  "message": "Request processed successfully",
  "data": {
    "subscriptions": [
      {
        "id": "6256610bc312410009b7390b",
        "customer": {
          "id": "62cffd65e8d7eb868c6a29d6",
          "customerReferenceId": "12345",
          "locale": "en_US",
          "email": "[email protected]",
          "contactNumber": "+923333709568",
          "firstName": "Pat",
          "middleName": "E",
          "lastName": "Kake",
          "segment": [
            "employee"
          ],
          "employeeId": "345",
          "communicationPreference": {
            "email": true,
            "sms": true
          },
          "status": "ACTIVE",
          "createdAt": "2021-10-12T21:35:05.756Z",
          "updatedAt": "2021-10-14T05:40:55.997Z"
        },
        "item": {
          "id": 1000000006,
          "sku": "MOBO-X570",
          "quantity": 1,
          "itemPrice": {
            "price": 100,
            "currencyCode": "USD"
          },
          "weight": 10,
          "weightUnit": "lb",
          "title": "Vitamin",
          "description": "Vitamin C",
          "tax": {
            "taxCode": "FR020000",
            "taxAmount": 10,
            "currencyCode": "USD"
          }
        },
        "plan": {
          "frequency": 30,
          "frequencyType": "Daily",
          "id": "1001"
        },
        "offer": {
          "id": "SUB-E10717",
          "source": "PDP"
        },
        "shipping": {
          "shipmentCarrier": "USPS",
          "shipmentMethod": "Ground",
          "shipmentInstructions": "Please leave the package in the box",
          "taxCode": "SHP020000",
          "shippingAmount": 10,
          "taxAmount": 1,
          "currencyCode": "USD"
        },
        "expiry": {
          "expiryDate": "2022-07-18T09:16:11.437Z",
          "billingCycles": 2
        },
        "shipTo": {
          "name": {
            "firstName": "Pat",
            "lastName": "Kake",
            "middleName": "E"
          },
          "streetAddress": {
            "street1": "123 Main St",
            "street2": "Suite 100"
          },
          "city": "Boston",
          "state": "MA",
          "postalCode": "02127",
          "country": "US",
          "phone": {
            "number": "5555551234",
            "kind": "home"
          }
        },
        "billTo": {
          "name": {
            "firstName": "Pat",
            "lastName": "Kake",
            "middleName": "E"
          },
          "streetAddress": {
            "street1": "123 Main St",
            "street2": "Suite 100"
          },
          "city": "Boston",
          "state": "MA",
          "postalCode": "02127",
          "country": "US",
          "phone": {
            "number": "5555551234",
            "kind": "home"
          }
        },
        "paymentDetails": {
          "paymentIdentifier": {
            "cardIdentifier": "1234",
            "expiryDate": "12/20"
          },
          "paymentMethod": "credit_card",
          "paymentKind": "Visa"
        },
        "customAttributes": {
          "storeId": "60cb07fc20387b000821c5c3",
          "associateId": 1,
          "trackingUrl": "609436d21baded0008945b05"
        },
        "status": "ACTIVE",
        "isDeleted": false,
        "deletedAt": "2019-01-01T00:00:00.000Z",
        "channel": "WEBSITE",
        "originOrderId": "22-4498-4800",
        "offsetDays": 2,
        "createdAt": "2021-10-12T21:35:05.756Z",
        "updatedAt": "2021-10-14T05:40:55.997Z",
        "statusUpdatedAt": "2021-10-14T10:24:36.468Z"
      }
    ],
    "query": {
      "limit": 10,
      "offset": 10,
      "count": 100
    }
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

limit

number

Maximum number of subscriptions to return per page

Example:

10

offset

number

Page number

Example:

0

status

string

Subscription status

Example:

"ACTIVE"

Response

Request processed successfully

Subscriptions array

responseStatus

string

Brief response status

Example:

"OK"

message

string

Full response message

Example:

"Request processed successfully"

data

object

Subscriptions array

Show child attributes

data.subscriptions

object[]

Subscriptions

Show child attributes

data.subscriptions.id

string

Subscription ID

Example:

"6256610bc312410009b7390b"

data.subscriptions.customer

object

Customer details after creation

Show child attributes

data.subscriptions.customer.id

string

Customer ID

Example:

"62cffd65e8d7eb868c6a29d6"

data.subscriptions.customer.customerReferenceId

string

Customer reference ID

Example:

"12345"

data.subscriptions.customer.locale

string

Customer locale (language_country)

Example:

"en_US"

data.subscriptions.customer.email

string

Customer's email address

Example:

"[email protected]"

data.subscriptions.customer.contactNumber

string

Customer's contact number

Example:

"+923333709568"

data.subscriptions.customer.firstName

string

Customer's first name

Example:

"Pat"

data.subscriptions.customer.middleName

string

Customer's middle name or initial

Example:

"E"

data.subscriptions.customer.lastName

string

Customer's last name

Example:

"Kake"

data.subscriptions.customer.segment

string[]

Customer's segments

Customer's segment (employee, management, pro user, etc.)

data.subscriptions.customer.employeeId

string

Customer employee ID

Example:

"345"

data.subscriptions.customer.communicationPreference

object

Customer's communications preferences

Show child attributes

data.subscriptions.customer.communicationPreference.email

boolean

true: Customer agrees to be contacted via email
false: Customer does not want to be contacted via email

Example:

true

data.subscriptions.customer.communicationPreference.sms

boolean

true: Customer agrees to be contacted via text message
false: Customer does not want to be contacted via text message

Example:

true

data.subscriptions.customer.status

enum<string>

Customer status

Available options:

ACTIVE,

INACTIVE

Example:

"ACTIVE"

data.subscriptions.customer.createdAt

string

Time customer was created

Example:

"2021-10-12T21:35:05.756Z"

data.subscriptions.customer.updatedAt

string

Most recent time customer was updated

Example:

"2021-10-14T05:40:55.997Z"

data.subscriptions.item

object

Item details

Show child attributes

data.subscriptions.item.id

integer

required

Item ID

Example:

1000000006

data.subscriptions.item.sku

string

required

Item SKU

Example:

"MOBO-X570"

data.subscriptions.item.quantity

integer

required

Number of items

Example:

1

data.subscriptions.item.itemPrice

object

required

Item price details

Show child attributes

data.subscriptions.item.itemPrice.price

integer

required

Item price

Example:

100

data.subscriptions.item.itemPrice.currencyCode

string

required

Item currency code

Example:

"USD"

data.subscriptions.item.weight

integer

Item weight amount

Example:

10

data.subscriptions.item.weightUnit

string

Item weight unit

Example:

"lb"

data.subscriptions.item.title

string

Item name

Example:

"Vitamin"

data.subscriptions.item.description

string

Item description

Example:

"Vitamin C"

data.subscriptions.item.tax

object

Tax details

Show child attributes

data.subscriptions.item.tax.taxCode

string

required

Tax code

Example:

"FR020000"

data.subscriptions.item.tax.taxAmount

integer

required

Tax amount (value, not percentage)

Example:

10

data.subscriptions.item.tax.currencyCode

string

required

Tax currency code

Example:

"USD"

data.subscriptions.plan

object

Subscription plan details

Show child attributes

data.subscriptions.plan.frequency

integer

required

Subscription plan frequency value

Example:

30

data.subscriptions.plan.frequencyType

string

required

Subscription plan frequency period

Example:

"Daily"

data.subscriptions.plan.id

string

Subscription plan ID

Example:

"1001"

data.subscriptions.offer

object

Offer details

Show child attributes

data.subscriptions.offer.id

string

required

Offer ID

Example:

"SUB-E10717"

data.subscriptions.offer.source

enum<string>

Offer source

Available options:

PDP,

CART

Example:

"PDP"

data.subscriptions.shipping

object

Shipping details

Show child attributes

data.subscriptions.shipping.shipmentCarrier

string

required

Shipment carrier

Example:

"USPS"

data.subscriptions.shipping.shipmentMethod

string

required

Shipment method

Example:

"Ground"

data.subscriptions.shipping.shipmentInstructions

string

required

Shipment instructions

Example:

"Please leave the package in the box"

data.subscriptions.shipping.taxCode

string

required

Shipment tax code

Example:

"SHP020000"

data.subscriptions.shipping.shippingAmount

integer

required

Shipping cost

Example:

10

data.subscriptions.shipping.taxAmount

integer

required

Shipment tax amount (value, not percentage)

Example:

1

data.subscriptions.shipping.currencyCode

string

required

Shipment currency code

Example:

"USD"

data.subscriptions.expiry

object

Expiration date and billing cycle

Show child attributes

data.subscriptions.expiry.expiryDate

string

Card expiration date

Example:

"2022-07-18T09:16:11.437Z"

data.subscriptions.expiry.billingCycles

number

Billing cycle number

Example:

2

data.subscriptions.shipTo

object

Ship-to address and phone details

Show child attributes

data.subscriptions.shipTo.name

object

required

Customer's name

Show child attributes

data.subscriptions.shipTo.name.firstName

string

required

Customer's first name

Example:

"Pat"

data.subscriptions.shipTo.name.lastName

string

required

Customer's last name

Example:

"Kake"

data.subscriptions.shipTo.name.middleName

string

Customer's middle name or initial

Example:

"E"

data.subscriptions.shipTo.streetAddress

object

required

Street address

Show child attributes

data.subscriptions.shipTo.streetAddress.street1

string

required

Street address field 1

Example:

"123 Main St"

data.subscriptions.shipTo.streetAddress.street2

string

Street address field 2

Example:

"Suite 100"

data.subscriptions.shipTo.city

string

required

City name

Example:

"Boston"

data.subscriptions.shipTo.state

string

required

State name

Example:

"MA"

data.subscriptions.shipTo.postalCode

string

required

Postal code

Example:

"02127"

data.subscriptions.shipTo.country

string

required

Country name

Example:

"US"

data.subscriptions.shipTo.phone

object

required

Customer's phone details

Show child attributes

data.subscriptions.shipTo.phone.number

string

required

Phone number

Example:

"5555551234"

data.subscriptions.shipTo.phone.kind

string

Phone type

Example:

"home"

data.subscriptions.billTo

object

Bill-to address and phone details

Show child attributes

data.subscriptions.billTo.name

object

required

Customer's name

Show child attributes

data.subscriptions.billTo.name.firstName

string

required

Customer's first name

Example:

"Pat"

data.subscriptions.billTo.name.lastName

string

required

Customer's last name

Example:

"Kake"

data.subscriptions.billTo.name.middleName

string

Customer's middle name or initial

Example:

"E"

data.subscriptions.billTo.streetAddress

object

required

Street address

Show child attributes

data.subscriptions.billTo.streetAddress.street1

string

required

Street address field 1

Example:

"123 Main St"

data.subscriptions.billTo.streetAddress.street2

string

Street address field 2

Example:

"Suite 100"

data.subscriptions.billTo.city

string

required

City name

Example:

"Boston"

data.subscriptions.billTo.state

string

required

State name

Example:

"MA"

data.subscriptions.billTo.postalCode

string

required

Postal code

Example:

"02127"

data.subscriptions.billTo.country

string

required

Country name

Example:

"US"

data.subscriptions.billTo.phone

object

required

Customer's phone details

Show child attributes

data.subscriptions.billTo.phone.number

string

required

Phone number

Example:

"5555551234"

data.subscriptions.billTo.phone.kind

string

Phone type

Example:

"home"

data.subscriptions.paymentDetails

object

Payment details

Show child attributes

data.subscriptions.paymentDetails.paymentIdentifier

object

required

Payment identifier details

Show child attributes

data.subscriptions.paymentDetails.paymentIdentifier.cardIdentifier

string

required

Last four digits of credit card number

Example:

"1234"

data.subscriptions.paymentDetails.paymentIdentifier.expiryDate

string

required

Card expiration date

Example:

"12/20"

data.subscriptions.paymentDetails.paymentMethod

string

Payment method

Example:

"credit_card"

data.subscriptions.paymentDetails.paymentKind

string

Payment type

Example:

"Visa"

data.subscriptions.customAttributes

object

Custom attributes

Show child attributes

data.subscriptions.customAttributes.storeId

string

Store ID

Example:

"60cb07fc20387b000821c5c3"

data.subscriptions.customAttributes.associateId

integer

Associate ID

Example:

1

data.subscriptions.customAttributes.trackingUrl

string

Tracking URL

Example:

"609436d21baded0008945b05"

data.subscriptions.status

string

Subscription status

Example:

"ACTIVE"

data.subscriptions.isDeleted

boolean

true: Subscription is deleted
false: Subscription is not deleted

Example:

false

data.subscriptions.deletedAt

string

If isDeleted=true, time at which the subscription was deleted
If isDeleted=false, NULL

Example:

"2019-01-01T00:00:00.000Z"

data.subscriptions.channel

string

Channel

Example:

"WEBSITE"

data.subscriptions.originOrderId

string

Client's origin order ID

Example:

"22-4498-4800"

data.subscriptions.offsetDays

integer

Number of days after which order is to be created

Example:

2

data.subscriptions.createdAt

string

Time subscription was created

Example:

"2021-10-12T21:35:05.756Z"

data.subscriptions.updatedAt

string

Most recent time subscription was updated

Example:

"2021-10-14T05:40:55.997Z"

data.subscriptions.statusUpdatedAt

string

Most recent time order status was updated

Example:

"2021-10-14T10:24:36.468Z"

data.query

object

Response pagination details

Show child attributes

data.query.limit

string

Maximum number of subscriptions to return

Example:

10

data.query.offset

string

Number of subscriptions to skip before returning response

Example:

10

data.query.count

number

Total number of subscriptions found

Example:

100

Get single subscription Replace a subscription item

⌘I

Authentication v1

User Self Service APIs

Experiences v2 (XM v2)

Experiences v1 (XM v1)

Product Catalog

Orders v2 (OMS v2)

Orders v1 (OMS v1)

Offers v2

Offers v1

Subscriptions (SMT API)

Loyalty (Member)

Dropship

Cart API

Checkout API

Customer

Get all subscriptions

Authorizations

Query Parameters

Response