Skip to main content
PUT
/
subscriptions
/
cp
/
api
/
subscription-contract-details
Update subscription contract details
curl --request PUT \
  --url https://www.myshop.com/apps/subscriptions/cp/api/subscription-contract-details \
  --header 'Content-Type: application/json' \
  --data '
{
  "shop": "<string>"
}
'
{
  "shop": "<string>",
  "id": 123,
  "graphSubscriptionContractId": "<string>",
  "subscriptionContractId": 123,
  "billingPolicyInterval": "<string>",
  "billingPolicyIntervalCount": 123,
  "currencyCode": "<string>",
  "customerId": 123,
  "graphCustomerId": "<string>",
  "deliveryPolicyInterval": "<string>",
  "deliveryPolicyIntervalCount": 123,
  "status": "<string>",
  "graphOrderId": "<string>",
  "orderId": 123,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "nextBillingDate": "2023-11-07T05:31:56Z",
  "orderAmount": 123,
  "orderName": "<string>",
  "customerName": "<string>",
  "customerEmail": "<string>",
  "subscriptionCreatedEmailSent": true,
  "endsAt": "2023-11-07T05:31:56Z",
  "startsAt": "2023-11-07T05:31:56Z",
  "minCycles": 123,
  "maxCycles": 123,
  "customerFirstName": "<string>",
  "customerLastName": "<string>",
  "autoCharge": true,
  "importedId": "<string>",
  "stopUpComingOrderEmail": true,
  "pausedFromActive": true,
  "skipPaymentCreateUnpaidOrder": true,
  "phone": "<string>",
  "activatedOn": "2023-11-07T05:31:56Z",
  "pausedOn": "2023-11-07T05:31:56Z",
  "cancelledOn": "2023-11-07T05:31:56Z",
  "contractDetailsJSON": "<string>",
  "deletedVariantIds": "<string>",
  "cancellationFeedback": "<string>",
  "orderNote": "<string>",
  "orderNoteAttributes": "<string>",
  "allowDeliveryPriceOverride": true,
  "disableFixEmptyQueue": true,
  "orderAmountUSD": 123,
  "originalContractId": 123,
  "cancellationNote": "<string>",
  "subscriptionTypeIdentifier": "<string>",
  "upcomingEmailBufferDays": 123,
  "upcomingEmailTaskUrl": "<string>",
  "contractAmount": 123,
  "contractAmountUSD": 123,
  "lastSuccessfulOrder": "<string>",
  "totalSuccessfulOrders": 123,
  "lifetimeValue": 123,
  "lifetimeValueUSD": 123,
  "allowDeliveryAddressOverride": true,
  "billingDateAfterTrial": "2023-11-07T05:31:56Z",
  "pauseReason": "<string>",
  "pauseFeedback": "<string>",
  "pauseTillDate": "2023-11-07T05:31:56Z",
  "pauseDurationCycle": 123,
  "pendingCancellationCycle": 123,
  "pendingCancellationDate": "2023-11-07T05:31:56Z",
  "emailBouncedOrFailed": true,
  "updatingQueue": true,
  "customerTag": "<string>",
  "queueUpdatedAt": "2023-11-07T05:31:56Z",
  "orderAmountShopCurrency": 123,
  "orderAmountContractCurrency": 123,
  "billingCountryCode": "<string>",
  "deliveryCountryCode": "<string>",
  "nextPaidBillingDate": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://developers.appstle.com/llms.txt

Use this file to discover all available pages before exploring further.

Body

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

Response

200 - */*

OK

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