> ## 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. # Update subscription contract order note ## OpenAPI ````yaml /subscription/storefront-api-swagger.json put /subscriptions/cp/api/update-contract-order-note/{contractId} openapi: 3.0.1 info: description: >- Comprehensive API documentation for the customer-facing subscription portal. These APIs enable customers to manage their subscriptions, update billing information, modify delivery schedules, and access their account details through your storefront. **Important**: These APIs must be called from your shop's domain (e.g., https://www.myshop.com/apps/subscriptions/cp/api/**) and require customer authentication. Unauthenticated requests will return a 401 Unauthorized error. title: Storefront APIs version: 0.0.1 servers: - url: https://www.myshop.com/apps security: [] tags: - description: >- Core customer portal APIs for managing customer account settings, authentication, and portal configurations. name: Customer Portal - description: >- APIs for customers to view and manage their subscription contracts including status updates, frequency changes, and cancellations. name: Subscription Management - description: >- APIs for retrieving and updating subscription contract details — delivery schedules, line items, addresses, billing cycles. name: Subscription Contracts - description: >- APIs for retrieving available subscription plans and selling plan configurations exposed to customers. name: Subscription Plans - description: >- APIs for managing one-time add-on products that can be purchased alongside recurring subscription items. name: Subscription One-Time Products - description: >- APIs for retrieving aggregated subscription data and account-level subscription information for the signed-in customer. name: Subscription Data - description: >- APIs for managing customizable product boxes and bundles where customers can select multiple items. name: Build-a-Box & Bundles - description: >- APIs for managing payment methods, billing information, and processing subscription payments. name: Billing & Payments - description: >- APIs for retrieving product information, selling plans, variant data, and subscription-enabled products available to customers. name: Product Catalog - description: >- APIs for managing delivery schedules, shipping addresses, delivery methods, and tracking order status. name: Delivery & Shipping - description: >- APIs for handling subscription cancellations, retention activities, and customer feedback management. name: Customer Retention - description: >- APIs for integrating loyalty programs with subscriptions including points redemption and earning options. name: Loyalty Integration - description: >- APIs for accessing portal customization settings, translations, and theme configurations. name: Customization - description: >- APIs for retrieving promotional campaigns shown in the customer portal, tracking banner engagement, and redeeming campaign offers. name: Campaigns - description: >- APIs for local pickup and click-and-collect — listing pickup locations and resolving eligible pickup dates and time slots. name: Store Pickup paths: /subscriptions/cp/api/update-contract-order-note/{contractId}: put: tags: - Subscription Contracts summary: Update subscription contract order note operationId: updateSubscriptionContractOrderNote parameters: - in: path name: contractId required: true schema: format: int64 type: integer - in: query name: orderNote required: true schema: type: string responses: '200': content: '*/*': schema: $ref: '#/components/schemas/SubscriptionContractDetailsDTO' description: OK components: schemas: SubscriptionContractDetailsDTO: properties: activatedOn: format: date-time type: string allowDeliveryAddressOverride: type: boolean allowDeliveryPriceOverride: type: boolean autoCharge: type: boolean billingCountryCode: type: string billingDateAfterTrial: format: date-time type: string billingPolicyInterval: type: string billingPolicyIntervalCount: format: int32 type: integer cancellationFeedback: type: string cancellationNote: type: string cancelledOn: format: date-time type: string contractAmount: format: double type: number contractAmountUSD: format: double type: number contractDetailsJSON: type: string createdAt: format: date-time type: string currencyCode: type: string customerEmail: type: string customerFirstName: type: string customerId: format: int64 type: integer customerLastName: type: string customerName: type: string customerTag: type: string deletedVariantIds: type: string deliveryCountryCode: type: string deliveryPolicyInterval: type: string deliveryPolicyIntervalCount: format: int32 type: integer disableFixEmptyQueue: type: boolean emailBouncedOrFailed: type: boolean endsAt: format: date-time type: string graphCustomerId: type: string graphOrderId: type: string graphSubscriptionContractId: type: string id: format: int64 type: integer importedId: type: string lastSuccessfulOrder: type: string lifetimeValue: format: double type: number lifetimeValueUSD: format: double type: number maxCycles: format: int32 type: integer minCycles: format: int32 type: integer nextBillingDate: format: date-time type: string nextPaidBillingDate: format: date-time type: string orderAmount: format: double type: number orderAmountContractCurrency: format: double type: number orderAmountShopCurrency: format: double type: number orderAmountUSD: format: double type: number orderId: format: int64 type: integer orderName: type: string orderNote: type: string orderNoteAttributes: type: string originType: enum: - STORE_FRONT - IMPORTED - SPLIT_ATTEMPT_BILLING - SPLIT_CONTRACT type: string originalContractId: format: int64 type: integer pauseDurationCycle: format: int32 type: integer pauseFeedback: type: string pauseReason: type: string pauseTillDate: format: date-time type: string pausedFromActive: type: boolean pausedOn: format: date-time type: string pendingCancellationCycle: format: int32 type: integer pendingCancellationDate: format: date-time type: string phone: type: string queueUpdatedAt: format: date-time type: string shop: type: string skipPaymentCreateUnpaidOrder: type: boolean startsAt: format: date-time type: string status: type: string stopUpComingOrderEmail: type: boolean subscriptionContractId: format: int64 type: integer subscriptionCreatedEmailSent: type: boolean subscriptionCreatedEmailSentStatus: enum: - SENT - UNSENT - FAILED - EMAIL_SETTINGS_DISABLED - CUSTOMER_PAYMENT_EMPTY - CONTRACT_PAUSED_STATUS type: string subscriptionCreatedSmsSentStatus: enum: - SENT - UNSENT - FAILED - SMS_SETTINGS_DISABLED - CUSTOMER_PAYMENT_EMPTY - CONTRACT_PAUSED_STATUS - PHONE_NUMBER_EMPTY type: string subscriptionType: enum: - REGULAR_SUBSCRIPTION - BUILD_A_BOX_CLASSIC - BUILD_A_BOX_SINGLE_PRODUCT - BUNDLING_CLASSIC - BUNDLING_MIX_AND_MATCH - SECTIONED_BUNDLE - VOLUME_DISCOUNT type: string subscriptionTypeIdentifier: type: string totalSuccessfulOrders: format: int32 type: integer upcomingEmailBufferDays: format: int32 type: integer upcomingEmailTaskUrl: type: string updatedAt: format: date-time type: string updatingQueue: type: boolean required: - shop type: object ````