Skip to main content
GET
Get order note for a subscription contract

Path Parameters

contractId
integer<int64>
required

Response

200 - */*

OK

shop
string
required
activatedOn
string<date-time>
allowDeliveryAddressOverride
boolean
allowDeliveryPriceOverride
boolean
autoCharge
boolean
billingCountryCode
string
billingDateAfterTrial
string<date-time>
billingPolicyInterval
string
billingPolicyIntervalCount
integer<int32>
cancellationFeedback
string
cancellationNote
string
cancelledOn
string<date-time>
contractAmount
number<double>
contractAmountUSD
number<double>
contractDetailsJSON
string
createdAt
string<date-time>
currencyCode
string
customerEmail
string
customerFirstName
string
customerId
integer<int64>
customerLastName
string
customerName
string
customerTag
string
deletedVariantIds
string
deliveryCountryCode
string
deliveryPolicyInterval
string
deliveryPolicyIntervalCount
integer<int32>
disableFixEmptyQueue
boolean
emailBouncedOrFailed
boolean
endsAt
string<date-time>
graphCustomerId
string
graphOrderId
string
graphSubscriptionContractId
string
id
integer<int64>
importedId
string
lastSuccessfulOrder
string
lifetimeValue
number<double>
lifetimeValueUSD
number<double>
maxCycles
integer<int32>
minCycles
integer<int32>
nextBillingDate
string<date-time>
nextPaidBillingDate
string<date-time>
orderAmount
number<double>
orderAmountContractCurrency
number<double>
orderAmountShopCurrency
number<double>
orderAmountUSD
number<double>
orderId
integer<int64>
orderName
string
orderNote
string
orderNoteAttributes
string
originType
enum<string>
Available options:
STORE_FRONT,
IMPORTED,
SPLIT_ATTEMPT_BILLING,
SPLIT_CONTRACT
originalContractId
integer<int64>
pauseDurationCycle
integer<int32>
pauseFeedback
string
pauseReason
string
pauseTillDate
string<date-time>
pausedFromActive
boolean
pausedOn
string<date-time>
pendingCancellationCycle
integer<int32>
pendingCancellationDate
string<date-time>
phone
string
queueUpdatedAt
string<date-time>
skipPaymentCreateUnpaidOrder
boolean
startsAt
string<date-time>
status
string
stopUpComingOrderEmail
boolean
subscriptionContractId
integer<int64>
subscriptionCreatedEmailSent
boolean
subscriptionCreatedEmailSentStatus
enum<string>
Available options:
SENT,
UNSENT,
FAILED,
EMAIL_SETTINGS_DISABLED,
CUSTOMER_PAYMENT_EMPTY,
CONTRACT_PAUSED_STATUS
subscriptionCreatedSmsSentStatus
enum<string>
Available options:
SENT,
UNSENT,
FAILED,
SMS_SETTINGS_DISABLED,
CUSTOMER_PAYMENT_EMPTY,
CONTRACT_PAUSED_STATUS,
PHONE_NUMBER_EMPTY
subscriptionType
enum<string>
Available options:
REGULAR_SUBSCRIPTION,
BUILD_A_BOX_CLASSIC,
BUILD_A_BOX_SINGLE_PRODUCT,
BUNDLING_CLASSIC,
BUNDLING_MIX_AND_MATCH,
SECTIONED_BUNDLE,
VOLUME_DISCOUNT
subscriptionTypeIdentifier
string
totalSuccessfulOrders
integer<int32>
upcomingEmailBufferDays
integer<int32>
upcomingEmailTaskUrl
string
updatedAt
string<date-time>
updatingQueue
boolean