# Add product line item to subscription contract

Adds a new product (line item) to an existing subscription contract. This allows customers or merchants to add products to their recurring subscription orders.

Key Features:
- Add Products: Include new products in future subscription deliveries
- Quantity Control: Specify how many units of the product to add
- Price Override: Set custom pricing for the added product
- Immediate Effect: Changes apply to next billing cycle
- Activity Logging: All additions are tracked in activity logs

Required Parameters:
- contractId: Subscription contract ID to modify
- variantId: Shopify product variant ID (with gid:// prefix or numeric)
- quantity: Number of units to add (must be positive integer)
- price: Price per unit in shop's base currency

Product Variant ID Format:
Accepts two formats:
- Shopify GID: gid://shopify/ProductVariant/12345678901
- Numeric ID: 12345678901

Price Behavior:
- Price is per unit, not total
- Must be in shop's base currency (USD, EUR, etc.)
- Can override product's default price
- Does not include taxes or shipping
- Total line item cost = price × quantity

Line Item Addition Rules:
- Product variant must exist in Shopify catalog
- Product must be active and available
- Variant must have sufficient inventory (if tracked)
- Contract must be ACTIVE or PAUSED (not CANCELLED)
- Cannot add duplicate variants (use update quantity instead)

Common Use Cases:
- Customer adds complementary product to existing subscription
- Upsell additional products through customer portal
- Merchant adds bonus items to customer subscriptions
- Build custom "add-on" product selection interfaces
- Cross-sell related products to existing subscribers
- Create bundle upgrades (add multiple products at once)

Post-Addition Effects:
- Next billing amount increases by (price × quantity)
- Product appears in all future subscription deliveries
- Customer receives confirmation of subscription update
- Activity log records the addition with source (portal/merchant)
- Contract's next billing date remains unchanged

Integration Example:

PUT /api/external/v2/subscription-contract-add-line-item?
  contractId=123456&
  variantId=gid://shopify/ProductVariant/987654321&
  quantity=2&
  price=19.99

This adds 2 units of variant 987654321 at $19.99 each ($39.98 total) to contract 123456.

Important Notes:
- Changes apply to NEXT billing cycle, not current/past orders
- If product is out of stock, order may be delayed or skipped
- Price changes don't affect historical orders
- Consider inventory availability before adding products

Authentication: Requires API key authentication via X-API-Key header or api_key parameter

Endpoint: PUT /api/external/v2/subscription-contract-add-line-item
Version: 0.0.1

## Query parameters:

  - `contractId` (integer, required)
    Subscription contract ID
    Example: 12345

  - `api_key` (string)
    API Key (Deprecated - Use Header X-API-Key instead)

  - `quantity` (integer, required)
    Quantity of product to add
    Example: 2

  - `variantId` (string, required)
    Shopify product variant ID (with or without gid:// prefix)
    Example: "gid://shopify/ProductVariant/987654321"

  - `price` (number, required)
    Price per unit in shop's base currency
    Example: 19.99

## Header parameters:

  - `X-API-Key` (string)

## Response 200 fields (application/json):

  - `get__typename` (string)

  - `id` (string)

  - `createdAt` (object)

  - `updatedAt` (object)

  - `nextBillingDate` (object)

  - `status` (string)
    Enum: "ACTIVE", "PAUSED", "CANCELLED", "EXPIRED", "FAILED", "$UNKNOWN"

  - `deliveryPrice` (object)

  - `deliveryPrice.amount` (object)

  - `deliveryPrice.currencyCode` (string)
    Enum: "USD", "EUR", "GBP", "CAD", "AFN", "ALL", "DZD", "AOA", "ARS", "AMD", "AWG", "AUD", "BBD", "AZN", "BDT", "BSD", "BHD", "BIF", "BYN", "BZD", "BMD", "BTN", "BAM", "BRL", "BOB", "BWP", "BND", "BGN", "MMK", "KHR", "CVE", "KYD", "XAF", "CLP", "CNY", "COP", "KMF", "CDF", "CRC", "HRK", "CZK", "DKK", "DJF", "DOP", "XCD", "EGP", "ERN", "ETB", "FKP", "XPF", "FJD", "GIP", "GMD", "GHS", "GTQ", "GYD", "GEL", "GNF", "HTG", "HNL", "HKD", "HUF", "ISK", "INR", "IDR", "ILS", "IRR", "IQD", "JMD", "JPY", "JEP", "JOD", "KZT", "KES", "KID", "KWD", "KGS", "LAK", "LVL", "LBP", "LSL", "LRD", "LYD", "LTL", "MGA", "MKD", "MOP", "MWK", "MVR", "MRU", "MXN", "MYR", "MUR", "MDL", "MAD", "MNT", "MZN", "NAD", "NPR", "ANG", "NZD", "NIO", "NGN", "NOK", "OMR", "PAB", "PKR", "PGK", "PYG", "PEN", "PHP", "PLN", "QAR", "RON", "RUB", "RWF", "WST", "SHP", "SAR", "RSD", "SCR", "SLL", "SGD", "SDG", "SOS", "SYP", "ZAR", "KRW", "SSP", "SBD", "LKR", "SRD", "SZL", "SEK", "CHF", "TWD", "THB", "TJS", "TZS", "TOP", "TTD", "TND", "TRY", "TMT", "UGX", "UAH", "AED", "UYU", "UZS", "VUV", "VES", "VND", "XOF", "YER", "ZMW", "USDC", "BYR", "STD", "STN", "VED", "VEF", "XXX", "$UNKNOWN"

  - `lastPaymentStatus` (string)
    Enum: "SUCCEEDED", "FAILED", "$UNKNOWN"

  - `billingPolicy` (object)

  - `billingPolicy.interval` (string)
    Enum: "DAY", "WEEK", "MONTH", "YEAR", "$UNKNOWN"

  - `billingPolicy.intervalCount` (integer)

  - `billingPolicy.anchors` (array)

  - `billingPolicy.anchors.cutoffDay` (integer)

  - `billingPolicy.anchors.day` (integer)

  - `billingPolicy.anchors.month` (integer)

  - `billingPolicy.anchors.type` (string)
    Enum: "WEEKDAY", "MONTHDAY", "YEARDAY", "$UNKNOWN"

  - `billingPolicy.maxCycles` (integer)

  - `billingPolicy.minCycles` (integer)

  - `deliveryPolicy` (object)

  - `lines` (object)

  - `lines.nodes` (array)

  - `lines.pageInfo` (object)

  - `lines.pageInfo.hasPreviousPage` (boolean)

  - `lines.pageInfo.hasNextPage` (boolean)

  - `lines.pageInfo.startCursor` (string)

  - `lines.pageInfo.endCursor` (string)

  - `customerPaymentMethod` (object)

  - `customerPaymentMethod.instrument` (object)

  - `customerPaymentMethod.revokedAt` (object)

  - `customerPaymentMethod.revokedReason` (string)
    Enum: "AUTHORIZE_NET_GATEWAY_NOT_ENABLED", "AUTHORIZE_NET_RETURNED_NO_PAYMENT_METHOD", "FAILED_TO_UPDATE_CREDIT_CARD", "STRIPE_API_AUTHENTICATION_ERROR", "STRIPE_API_INVALID_REQUEST_ERROR", "STRIPE_GATEWAY_NOT_ENABLED", "STRIPE_RETURNED_NO_PAYMENT_METHOD", "STRIPE_PAYMENT_METHOD_NOT_CARD", "BRAINTREE_API_AUTHENTICATION_ERROR", "BRAINTREE_GATEWAY_NOT_ENABLED", "BRAINTREE_RETURNED_NO_PAYMENT_METHOD", "BRAINTREE_PAYMENT_METHOD_NOT_CARD", "PAYMENT_METHOD_VERIFICATION_FAILED", "THREE_D_SECURE_FLOW_IN_VERIFICATION_NOT_IMPLEMENTED", "MANUALLY_REVOKED", "FAILED_TO_RETRIEVE_BILLING_ADDRESS", "MERGED", "CUSTOMER_REDACTED", "TOO_MANY_CONSECUTIVE_FAILURES", "CVV_ATTEMPTS_LIMIT_EXCEEDED", "$UNKNOWN"

  - `deliveryMethod` (object)

  - `deliveryMethod.methodType` (string)
    Enum: "SHIPPING", "PICK_UP", "NONE", "RETAIL", "LOCAL", "PICKUP_POINT", "$UNKNOWN"

  - `deliveryMethod.serviceCode` (string)

  - `deliveryMethod.minDeliveryDateTime` (object)

  - `deliveryMethod.maxDeliveryDateTime` (object)

  - `deliveryMethod.additionalInformation` (object)

  - `deliveryMethod.additionalInformation.instructions` (string)

  - `deliveryMethod.brandedPromise` (object)

  - `deliveryMethod.brandedPromise.handle` (string)

  - `deliveryMethod.brandedPromise.name` (string)

  - `originOrder` (object)

  - `originOrder.fulfillmentOrders` (object)

  - `customer` (object)

  - `customer.displayName` (string)

  - `customer.firstName` (string)

  - `customer.lastName` (string)

  - `customer.email` (string)

  - `customer.phone` (string)

  - `discounts` (object)

  - `note` (string)

  - `customAttributes` (array)

  - `customAttributes.key` (string)

  - `customAttributes.value` (string)

  - `billingAttempts` (object)

## Response 400 fields (*/*):

  - `get__typename` (string)

  - `id` (string)

  - `createdAt` (object)

  - `updatedAt` (object)

  - `nextBillingDate` (object)

  - `status` (string)
    Enum: "ACTIVE", "PAUSED", "CANCELLED", "EXPIRED", "FAILED", "$UNKNOWN"

  - `deliveryPrice` (object)

  - `deliveryPrice.amount` (object)

  - `deliveryPrice.currencyCode` (string)
    Enum: "USD", "EUR", "GBP", "CAD", "AFN", "ALL", "DZD", "AOA", "ARS", "AMD", "AWG", "AUD", "BBD", "AZN", "BDT", "BSD", "BHD", "BIF", "BYN", "BZD", "BMD", "BTN", "BAM", "BRL", "BOB", "BWP", "BND", "BGN", "MMK", "KHR", "CVE", "KYD", "XAF", "CLP", "CNY", "COP", "KMF", "CDF", "CRC", "HRK", "CZK", "DKK", "DJF", "DOP", "XCD", "EGP", "ERN", "ETB", "FKP", "XPF", "FJD", "GIP", "GMD", "GHS", "GTQ", "GYD", "GEL", "GNF", "HTG", "HNL", "HKD", "HUF", "ISK", "INR", "IDR", "ILS", "IRR", "IQD", "JMD", "JPY", "JEP", "JOD", "KZT", "KES", "KID", "KWD", "KGS", "LAK", "LVL", "LBP", "LSL", "LRD", "LYD", "LTL", "MGA", "MKD", "MOP", "MWK", "MVR", "MRU", "MXN", "MYR", "MUR", "MDL", "MAD", "MNT", "MZN", "NAD", "NPR", "ANG", "NZD", "NIO", "NGN", "NOK", "OMR", "PAB", "PKR", "PGK", "PYG", "PEN", "PHP", "PLN", "QAR", "RON", "RUB", "RWF", "WST", "SHP", "SAR", "RSD", "SCR", "SLL", "SGD", "SDG", "SOS", "SYP", "ZAR", "KRW", "SSP", "SBD", "LKR", "SRD", "SZL", "SEK", "CHF", "TWD", "THB", "TJS", "TZS", "TOP", "TTD", "TND", "TRY", "TMT", "UGX", "UAH", "AED", "UYU", "UZS", "VUV", "VES", "VND", "XOF", "YER", "ZMW", "USDC", "BYR", "STD", "STN", "VED", "VEF", "XXX", "$UNKNOWN"

  - `lastPaymentStatus` (string)
    Enum: "SUCCEEDED", "FAILED", "$UNKNOWN"

  - `billingPolicy` (object)

  - `billingPolicy.interval` (string)
    Enum: "DAY", "WEEK", "MONTH", "YEAR", "$UNKNOWN"

  - `billingPolicy.intervalCount` (integer)

  - `billingPolicy.anchors` (array)

  - `billingPolicy.anchors.cutoffDay` (integer)

  - `billingPolicy.anchors.day` (integer)

  - `billingPolicy.anchors.month` (integer)

  - `billingPolicy.anchors.type` (string)
    Enum: "WEEKDAY", "MONTHDAY", "YEARDAY", "$UNKNOWN"

  - `billingPolicy.maxCycles` (integer)

  - `billingPolicy.minCycles` (integer)

  - `deliveryPolicy` (object)

  - `lines` (object)

  - `lines.nodes` (array)

  - `lines.pageInfo` (object)

  - `lines.pageInfo.hasPreviousPage` (boolean)

  - `lines.pageInfo.hasNextPage` (boolean)

  - `lines.pageInfo.startCursor` (string)

  - `lines.pageInfo.endCursor` (string)

  - `customerPaymentMethod` (object)

  - `customerPaymentMethod.instrument` (object)

  - `customerPaymentMethod.revokedAt` (object)

  - `customerPaymentMethod.revokedReason` (string)
    Enum: "AUTHORIZE_NET_GATEWAY_NOT_ENABLED", "AUTHORIZE_NET_RETURNED_NO_PAYMENT_METHOD", "FAILED_TO_UPDATE_CREDIT_CARD", "STRIPE_API_AUTHENTICATION_ERROR", "STRIPE_API_INVALID_REQUEST_ERROR", "STRIPE_GATEWAY_NOT_ENABLED", "STRIPE_RETURNED_NO_PAYMENT_METHOD", "STRIPE_PAYMENT_METHOD_NOT_CARD", "BRAINTREE_API_AUTHENTICATION_ERROR", "BRAINTREE_GATEWAY_NOT_ENABLED", "BRAINTREE_RETURNED_NO_PAYMENT_METHOD", "BRAINTREE_PAYMENT_METHOD_NOT_CARD", "PAYMENT_METHOD_VERIFICATION_FAILED", "THREE_D_SECURE_FLOW_IN_VERIFICATION_NOT_IMPLEMENTED", "MANUALLY_REVOKED", "FAILED_TO_RETRIEVE_BILLING_ADDRESS", "MERGED", "CUSTOMER_REDACTED", "TOO_MANY_CONSECUTIVE_FAILURES", "CVV_ATTEMPTS_LIMIT_EXCEEDED", "$UNKNOWN"

  - `deliveryMethod` (object)

  - `deliveryMethod.methodType` (string)
    Enum: "SHIPPING", "PICK_UP", "NONE", "RETAIL", "LOCAL", "PICKUP_POINT", "$UNKNOWN"

  - `deliveryMethod.serviceCode` (string)

  - `deliveryMethod.minDeliveryDateTime` (object)

  - `deliveryMethod.maxDeliveryDateTime` (object)

  - `deliveryMethod.additionalInformation` (object)

  - `deliveryMethod.additionalInformation.instructions` (string)

  - `deliveryMethod.brandedPromise` (object)

  - `deliveryMethod.brandedPromise.handle` (string)

  - `deliveryMethod.brandedPromise.name` (string)

  - `originOrder` (object)

  - `originOrder.fulfillmentOrders` (object)

  - `customer` (object)

  - `customer.displayName` (string)

  - `customer.firstName` (string)

  - `customer.lastName` (string)

  - `customer.email` (string)

  - `customer.phone` (string)

  - `discounts` (object)

  - `note` (string)

  - `customAttributes` (array)

  - `customAttributes.key` (string)

  - `customAttributes.value` (string)

  - `billingAttempts` (object)

## Response 401 fields (*/*):

  - `get__typename` (string)

  - `id` (string)

  - `createdAt` (object)

  - `updatedAt` (object)

  - `nextBillingDate` (object)

  - `status` (string)
    Enum: "ACTIVE", "PAUSED", "CANCELLED", "EXPIRED", "FAILED", "$UNKNOWN"

  - `deliveryPrice` (object)

  - `deliveryPrice.amount` (object)

  - `deliveryPrice.currencyCode` (string)
    Enum: "USD", "EUR", "GBP", "CAD", "AFN", "ALL", "DZD", "AOA", "ARS", "AMD", "AWG", "AUD", "BBD", "AZN", "BDT", "BSD", "BHD", "BIF", "BYN", "BZD", "BMD", "BTN", "BAM", "BRL", "BOB", "BWP", "BND", "BGN", "MMK", "KHR", "CVE", "KYD", "XAF", "CLP", "CNY", "COP", "KMF", "CDF", "CRC", "HRK", "CZK", "DKK", "DJF", "DOP", "XCD", "EGP", "ERN", "ETB", "FKP", "XPF", "FJD", "GIP", "GMD", "GHS", "GTQ", "GYD", "GEL", "GNF", "HTG", "HNL", "HKD", "HUF", "ISK", "INR", "IDR", "ILS", "IRR", "IQD", "JMD", "JPY", "JEP", "JOD", "KZT", "KES", "KID", "KWD", "KGS", "LAK", "LVL", "LBP", "LSL", "LRD", "LYD", "LTL", "MGA", "MKD", "MOP", "MWK", "MVR", "MRU", "MXN", "MYR", "MUR", "MDL", "MAD", "MNT", "MZN", "NAD", "NPR", "ANG", "NZD", "NIO", "NGN", "NOK", "OMR", "PAB", "PKR", "PGK", "PYG", "PEN", "PHP", "PLN", "QAR", "RON", "RUB", "RWF", "WST", "SHP", "SAR", "RSD", "SCR", "SLL", "SGD", "SDG", "SOS", "SYP", "ZAR", "KRW", "SSP", "SBD", "LKR", "SRD", "SZL", "SEK", "CHF", "TWD", "THB", "TJS", "TZS", "TOP", "TTD", "TND", "TRY", "TMT", "UGX", "UAH", "AED", "UYU", "UZS", "VUV", "VES", "VND", "XOF", "YER", "ZMW", "USDC", "BYR", "STD", "STN", "VED", "VEF", "XXX", "$UNKNOWN"

  - `lastPaymentStatus` (string)
    Enum: "SUCCEEDED", "FAILED", "$UNKNOWN"

  - `billingPolicy` (object)

  - `billingPolicy.interval` (string)
    Enum: "DAY", "WEEK", "MONTH", "YEAR", "$UNKNOWN"

  - `billingPolicy.intervalCount` (integer)

  - `billingPolicy.anchors` (array)

  - `billingPolicy.anchors.cutoffDay` (integer)

  - `billingPolicy.anchors.day` (integer)

  - `billingPolicy.anchors.month` (integer)

  - `billingPolicy.anchors.type` (string)
    Enum: "WEEKDAY", "MONTHDAY", "YEARDAY", "$UNKNOWN"

  - `billingPolicy.maxCycles` (integer)

  - `billingPolicy.minCycles` (integer)

  - `deliveryPolicy` (object)

  - `lines` (object)

  - `lines.nodes` (array)

  - `lines.pageInfo` (object)

  - `lines.pageInfo.hasPreviousPage` (boolean)

  - `lines.pageInfo.hasNextPage` (boolean)

  - `lines.pageInfo.startCursor` (string)

  - `lines.pageInfo.endCursor` (string)

  - `customerPaymentMethod` (object)

  - `customerPaymentMethod.instrument` (object)

  - `customerPaymentMethod.revokedAt` (object)

  - `customerPaymentMethod.revokedReason` (string)
    Enum: "AUTHORIZE_NET_GATEWAY_NOT_ENABLED", "AUTHORIZE_NET_RETURNED_NO_PAYMENT_METHOD", "FAILED_TO_UPDATE_CREDIT_CARD", "STRIPE_API_AUTHENTICATION_ERROR", "STRIPE_API_INVALID_REQUEST_ERROR", "STRIPE_GATEWAY_NOT_ENABLED", "STRIPE_RETURNED_NO_PAYMENT_METHOD", "STRIPE_PAYMENT_METHOD_NOT_CARD", "BRAINTREE_API_AUTHENTICATION_ERROR", "BRAINTREE_GATEWAY_NOT_ENABLED", "BRAINTREE_RETURNED_NO_PAYMENT_METHOD", "BRAINTREE_PAYMENT_METHOD_NOT_CARD", "PAYMENT_METHOD_VERIFICATION_FAILED", "THREE_D_SECURE_FLOW_IN_VERIFICATION_NOT_IMPLEMENTED", "MANUALLY_REVOKED", "FAILED_TO_RETRIEVE_BILLING_ADDRESS", "MERGED", "CUSTOMER_REDACTED", "TOO_MANY_CONSECUTIVE_FAILURES", "CVV_ATTEMPTS_LIMIT_EXCEEDED", "$UNKNOWN"

  - `deliveryMethod` (object)

  - `deliveryMethod.methodType` (string)
    Enum: "SHIPPING", "PICK_UP", "NONE", "RETAIL", "LOCAL", "PICKUP_POINT", "$UNKNOWN"

  - `deliveryMethod.serviceCode` (string)

  - `deliveryMethod.minDeliveryDateTime` (object)

  - `deliveryMethod.maxDeliveryDateTime` (object)

  - `deliveryMethod.additionalInformation` (object)

  - `deliveryMethod.additionalInformation.instructions` (string)

  - `deliveryMethod.brandedPromise` (object)

  - `deliveryMethod.brandedPromise.handle` (string)

  - `deliveryMethod.brandedPromise.name` (string)

  - `originOrder` (object)

  - `originOrder.fulfillmentOrders` (object)

  - `customer` (object)

  - `customer.displayName` (string)

  - `customer.firstName` (string)

  - `customer.lastName` (string)

  - `customer.email` (string)

  - `customer.phone` (string)

  - `discounts` (object)

  - `note` (string)

  - `customAttributes` (array)

  - `customAttributes.key` (string)

  - `customAttributes.value` (string)

  - `billingAttempts` (object)

## Response 403 fields (*/*):

  - `get__typename` (string)

  - `id` (string)

  - `createdAt` (object)

  - `updatedAt` (object)

  - `nextBillingDate` (object)

  - `status` (string)
    Enum: "ACTIVE", "PAUSED", "CANCELLED", "EXPIRED", "FAILED", "$UNKNOWN"

  - `deliveryPrice` (object)

  - `deliveryPrice.amount` (object)

  - `deliveryPrice.currencyCode` (string)
    Enum: "USD", "EUR", "GBP", "CAD", "AFN", "ALL", "DZD", "AOA", "ARS", "AMD", "AWG", "AUD", "BBD", "AZN", "BDT", "BSD", "BHD", "BIF", "BYN", "BZD", "BMD", "BTN", "BAM", "BRL", "BOB", "BWP", "BND", "BGN", "MMK", "KHR", "CVE", "KYD", "XAF", "CLP", "CNY", "COP", "KMF", "CDF", "CRC", "HRK", "CZK", "DKK", "DJF", "DOP", "XCD", "EGP", "ERN", "ETB", "FKP", "XPF", "FJD", "GIP", "GMD", "GHS", "GTQ", "GYD", "GEL", "GNF", "HTG", "HNL", "HKD", "HUF", "ISK", "INR", "IDR", "ILS", "IRR", "IQD", "JMD", "JPY", "JEP", "JOD", "KZT", "KES", "KID", "KWD", "KGS", "LAK", "LVL", "LBP", "LSL", "LRD", "LYD", "LTL", "MGA", "MKD", "MOP", "MWK", "MVR", "MRU", "MXN", "MYR", "MUR", "MDL", "MAD", "MNT", "MZN", "NAD", "NPR", "ANG", "NZD", "NIO", "NGN", "NOK", "OMR", "PAB", "PKR", "PGK", "PYG", "PEN", "PHP", "PLN", "QAR", "RON", "RUB", "RWF", "WST", "SHP", "SAR", "RSD", "SCR", "SLL", "SGD", "SDG", "SOS", "SYP", "ZAR", "KRW", "SSP", "SBD", "LKR", "SRD", "SZL", "SEK", "CHF", "TWD", "THB", "TJS", "TZS", "TOP", "TTD", "TND", "TRY", "TMT", "UGX", "UAH", "AED", "UYU", "UZS", "VUV", "VES", "VND", "XOF", "YER", "ZMW", "USDC", "BYR", "STD", "STN", "VED", "VEF", "XXX", "$UNKNOWN"

  - `lastPaymentStatus` (string)
    Enum: "SUCCEEDED", "FAILED", "$UNKNOWN"

  - `billingPolicy` (object)

  - `billingPolicy.interval` (string)
    Enum: "DAY", "WEEK", "MONTH", "YEAR", "$UNKNOWN"

  - `billingPolicy.intervalCount` (integer)

  - `billingPolicy.anchors` (array)

  - `billingPolicy.anchors.cutoffDay` (integer)

  - `billingPolicy.anchors.day` (integer)

  - `billingPolicy.anchors.month` (integer)

  - `billingPolicy.anchors.type` (string)
    Enum: "WEEKDAY", "MONTHDAY", "YEARDAY", "$UNKNOWN"

  - `billingPolicy.maxCycles` (integer)

  - `billingPolicy.minCycles` (integer)

  - `deliveryPolicy` (object)

  - `lines` (object)

  - `lines.nodes` (array)

  - `lines.pageInfo` (object)

  - `lines.pageInfo.hasPreviousPage` (boolean)

  - `lines.pageInfo.hasNextPage` (boolean)

  - `lines.pageInfo.startCursor` (string)

  - `lines.pageInfo.endCursor` (string)

  - `customerPaymentMethod` (object)

  - `customerPaymentMethod.instrument` (object)

  - `customerPaymentMethod.revokedAt` (object)

  - `customerPaymentMethod.revokedReason` (string)
    Enum: "AUTHORIZE_NET_GATEWAY_NOT_ENABLED", "AUTHORIZE_NET_RETURNED_NO_PAYMENT_METHOD", "FAILED_TO_UPDATE_CREDIT_CARD", "STRIPE_API_AUTHENTICATION_ERROR", "STRIPE_API_INVALID_REQUEST_ERROR", "STRIPE_GATEWAY_NOT_ENABLED", "STRIPE_RETURNED_NO_PAYMENT_METHOD", "STRIPE_PAYMENT_METHOD_NOT_CARD", "BRAINTREE_API_AUTHENTICATION_ERROR", "BRAINTREE_GATEWAY_NOT_ENABLED", "BRAINTREE_RETURNED_NO_PAYMENT_METHOD", "BRAINTREE_PAYMENT_METHOD_NOT_CARD", "PAYMENT_METHOD_VERIFICATION_FAILED", "THREE_D_SECURE_FLOW_IN_VERIFICATION_NOT_IMPLEMENTED", "MANUALLY_REVOKED", "FAILED_TO_RETRIEVE_BILLING_ADDRESS", "MERGED", "CUSTOMER_REDACTED", "TOO_MANY_CONSECUTIVE_FAILURES", "CVV_ATTEMPTS_LIMIT_EXCEEDED", "$UNKNOWN"

  - `deliveryMethod` (object)

  - `deliveryMethod.methodType` (string)
    Enum: "SHIPPING", "PICK_UP", "NONE", "RETAIL", "LOCAL", "PICKUP_POINT", "$UNKNOWN"

  - `deliveryMethod.serviceCode` (string)

  - `deliveryMethod.minDeliveryDateTime` (object)

  - `deliveryMethod.maxDeliveryDateTime` (object)

  - `deliveryMethod.additionalInformation` (object)

  - `deliveryMethod.additionalInformation.instructions` (string)

  - `deliveryMethod.brandedPromise` (object)

  - `deliveryMethod.brandedPromise.handle` (string)

  - `deliveryMethod.brandedPromise.name` (string)

  - `originOrder` (object)

  - `originOrder.fulfillmentOrders` (object)

  - `customer` (object)

  - `customer.displayName` (string)

  - `customer.firstName` (string)

  - `customer.lastName` (string)

  - `customer.email` (string)

  - `customer.phone` (string)

  - `discounts` (object)

  - `note` (string)

  - `customAttributes` (array)

  - `customAttributes.key` (string)

  - `customAttributes.value` (string)

  - `billingAttempts` (object)

## Response 404 fields (*/*):

  - `get__typename` (string)

  - `id` (string)

  - `createdAt` (object)

  - `updatedAt` (object)

  - `nextBillingDate` (object)

  - `status` (string)
    Enum: "ACTIVE", "PAUSED", "CANCELLED", "EXPIRED", "FAILED", "$UNKNOWN"

  - `deliveryPrice` (object)

  - `deliveryPrice.amount` (object)

  - `deliveryPrice.currencyCode` (string)
    Enum: "USD", "EUR", "GBP", "CAD", "AFN", "ALL", "DZD", "AOA", "ARS", "AMD", "AWG", "AUD", "BBD", "AZN", "BDT", "BSD", "BHD", "BIF", "BYN", "BZD", "BMD", "BTN", "BAM", "BRL", "BOB", "BWP", "BND", "BGN", "MMK", "KHR", "CVE", "KYD", "XAF", "CLP", "CNY", "COP", "KMF", "CDF", "CRC", "HRK", "CZK", "DKK", "DJF", "DOP", "XCD", "EGP", "ERN", "ETB", "FKP", "XPF", "FJD", "GIP", "GMD", "GHS", "GTQ", "GYD", "GEL", "GNF", "HTG", "HNL", "HKD", "HUF", "ISK", "INR", "IDR", "ILS", "IRR", "IQD", "JMD", "JPY", "JEP", "JOD", "KZT", "KES", "KID", "KWD", "KGS", "LAK", "LVL", "LBP", "LSL", "LRD", "LYD", "LTL", "MGA", "MKD", "MOP", "MWK", "MVR", "MRU", "MXN", "MYR", "MUR", "MDL", "MAD", "MNT", "MZN", "NAD", "NPR", "ANG", "NZD", "NIO", "NGN", "NOK", "OMR", "PAB", "PKR", "PGK", "PYG", "PEN", "PHP", "PLN", "QAR", "RON", "RUB", "RWF", "WST", "SHP", "SAR", "RSD", "SCR", "SLL", "SGD", "SDG", "SOS", "SYP", "ZAR", "KRW", "SSP", "SBD", "LKR", "SRD", "SZL", "SEK", "CHF", "TWD", "THB", "TJS", "TZS", "TOP", "TTD", "TND", "TRY", "TMT", "UGX", "UAH", "AED", "UYU", "UZS", "VUV", "VES", "VND", "XOF", "YER", "ZMW", "USDC", "BYR", "STD", "STN", "VED", "VEF", "XXX", "$UNKNOWN"

  - `lastPaymentStatus` (string)
    Enum: "SUCCEEDED", "FAILED", "$UNKNOWN"

  - `billingPolicy` (object)

  - `billingPolicy.interval` (string)
    Enum: "DAY", "WEEK", "MONTH", "YEAR", "$UNKNOWN"

  - `billingPolicy.intervalCount` (integer)

  - `billingPolicy.anchors` (array)

  - `billingPolicy.anchors.cutoffDay` (integer)

  - `billingPolicy.anchors.day` (integer)

  - `billingPolicy.anchors.month` (integer)

  - `billingPolicy.anchors.type` (string)
    Enum: "WEEKDAY", "MONTHDAY", "YEARDAY", "$UNKNOWN"

  - `billingPolicy.maxCycles` (integer)

  - `billingPolicy.minCycles` (integer)

  - `deliveryPolicy` (object)

  - `lines` (object)

  - `lines.nodes` (array)

  - `lines.pageInfo` (object)

  - `lines.pageInfo.hasPreviousPage` (boolean)

  - `lines.pageInfo.hasNextPage` (boolean)

  - `lines.pageInfo.startCursor` (string)

  - `lines.pageInfo.endCursor` (string)

  - `customerPaymentMethod` (object)

  - `customerPaymentMethod.instrument` (object)

  - `customerPaymentMethod.revokedAt` (object)

  - `customerPaymentMethod.revokedReason` (string)
    Enum: "AUTHORIZE_NET_GATEWAY_NOT_ENABLED", "AUTHORIZE_NET_RETURNED_NO_PAYMENT_METHOD", "FAILED_TO_UPDATE_CREDIT_CARD", "STRIPE_API_AUTHENTICATION_ERROR", "STRIPE_API_INVALID_REQUEST_ERROR", "STRIPE_GATEWAY_NOT_ENABLED", "STRIPE_RETURNED_NO_PAYMENT_METHOD", "STRIPE_PAYMENT_METHOD_NOT_CARD", "BRAINTREE_API_AUTHENTICATION_ERROR", "BRAINTREE_GATEWAY_NOT_ENABLED", "BRAINTREE_RETURNED_NO_PAYMENT_METHOD", "BRAINTREE_PAYMENT_METHOD_NOT_CARD", "PAYMENT_METHOD_VERIFICATION_FAILED", "THREE_D_SECURE_FLOW_IN_VERIFICATION_NOT_IMPLEMENTED", "MANUALLY_REVOKED", "FAILED_TO_RETRIEVE_BILLING_ADDRESS", "MERGED", "CUSTOMER_REDACTED", "TOO_MANY_CONSECUTIVE_FAILURES", "CVV_ATTEMPTS_LIMIT_EXCEEDED", "$UNKNOWN"

  - `deliveryMethod` (object)

  - `deliveryMethod.methodType` (string)
    Enum: "SHIPPING", "PICK_UP", "NONE", "RETAIL", "LOCAL", "PICKUP_POINT", "$UNKNOWN"

  - `deliveryMethod.serviceCode` (string)

  - `deliveryMethod.minDeliveryDateTime` (object)

  - `deliveryMethod.maxDeliveryDateTime` (object)

  - `deliveryMethod.additionalInformation` (object)

  - `deliveryMethod.additionalInformation.instructions` (string)

  - `deliveryMethod.brandedPromise` (object)

  - `deliveryMethod.brandedPromise.handle` (string)

  - `deliveryMethod.brandedPromise.name` (string)

  - `originOrder` (object)

  - `originOrder.fulfillmentOrders` (object)

  - `customer` (object)

  - `customer.displayName` (string)

  - `customer.firstName` (string)

  - `customer.lastName` (string)

  - `customer.email` (string)

  - `customer.phone` (string)

  - `discounts` (object)

  - `note` (string)

  - `customAttributes` (array)

  - `customAttributes.key` (string)

  - `customAttributes.value` (string)

  - `billingAttempts` (object)