Skip to main content
PUT
Update subscription contract details

Body

application/json
shop
string
required
activatedOn
string<date-time>
allowDeliveryPriceOverride
boolean
autoCharge
boolean
billingDateAfterTrial
string<date-time>
billingPolicyInterval
string
billingPolicyIntervalCount
integer<int32>
cancellationFeedback
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
deliveryPolicyInterval
string
deliveryPolicyIntervalCount
integer<int32>
dunning
boolean
emailBouncedOrFailed
boolean
endsAt
string<date-time>
graphCustomerId
string
graphOrderId
string
graphSubscriptionContractId
string
id
integer<int64>
importedId
string
maxCycles
integer<int32>
minCycles
integer<int32>
nextActivationDate
string<date-time>
nextBillingDate
string<date-time>
orderAmount
number<double>
orderAmountUSD
number<double>
orderId
integer<int64>
orderName
string
orderNote
string
orderNoteAttributes
string
pauseDurationCycle
integer<int32>
pausedBySecurityChallenge
boolean
pausedFromActive
boolean
pausedOn
string<date-time>
phone
string
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
trialEndDate
string<date-time>
upcomingSwapRule
string
updatedAt
string<date-time>

Response

200 - */*

OK

shop
string
required
activatedOn
string<date-time>
allowDeliveryPriceOverride
boolean
autoCharge
boolean
billingDateAfterTrial
string<date-time>
billingPolicyInterval
string
billingPolicyIntervalCount
integer<int32>
cancellationFeedback
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
deliveryPolicyInterval
string
deliveryPolicyIntervalCount
integer<int32>
dunning
boolean
emailBouncedOrFailed
boolean
endsAt
string<date-time>
graphCustomerId
string
graphOrderId
string
graphSubscriptionContractId
string
id
integer<int64>
importedId
string
maxCycles
integer<int32>
minCycles
integer<int32>
nextActivationDate
string<date-time>
nextBillingDate
string<date-time>
orderAmount
number<double>
orderAmountUSD
number<double>
orderId
integer<int64>
orderName
string
orderNote
string
orderNoteAttributes
string
pauseDurationCycle
integer<int32>
pausedBySecurityChallenge
boolean
pausedFromActive
boolean
pausedOn
string<date-time>
phone
string
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
trialEndDate
string<date-time>
upcomingSwapRule
string
updatedAt
string<date-time>