# Create and add custom discount to subscription

Creates a custom discount and applies it to a subscription contract. This endpoint allows you to create on-the-fly discounts without requiring pre-existing discount codes in Shopify.

Discount Creation & Application:
- Custom Discount: Creates discount directly on subscription contract
- Flexible Types: Supports percentage off or fixed amount off
- Cycle Limits: Optional limit on number of billing cycles discount applies
- Item-Level Control: Option to apply discount to each item vs entire order
- Immediate Effect: Discount applies to next billing cycle

Discount Parameters:
- Percentage: Percentage discount (e.g., 15 for 15% off) - use for discountType='PERCENTAGE'
- Amount: Fixed amount discount (e.g., 10.00 for $10 off) - use for discountType='FIXED_AMOUNT'
- Title: Display name for the discount (e.g., 'Loyalty Discount')
- Cycle Limit: Number of billing cycles discount applies (null = unlimited)
- Applies On Each Item: true = per-item discount, false = order-level discount

Discount Types:
- PERCENTAGE: Percentage-based discount (use 'percentage' parameter)
- FIXED_AMOUNT: Fixed dollar amount discount (use 'amount' parameter)

Cycle Limit Examples:
- recurringCycleLimit=1: Discount for first order only
- recurringCycleLimit=3: Discount for first 3 orders
- recurringCycleLimit=null: Discount applies forever

Use Cases:
- Customer retention offers (e.g., 20% off next 3 orders)
- Loyalty rewards and point redemptions
- Win-back campaigns with limited-time discounts
- Customer service compensation discounts
- Referral program rewards
- First-order discounts for new subscribers
- Seasonal promotions on existing subscriptions

Example Scenarios:
1. Retention Offer: 25% off for 2 billing cycles
   - percentage=25, recurringCycleLimit=2, discountType='PERCENTAGE'
2. Loyalty Reward: $5 off every order forever
   - amount=5.00, recurringCycleLimit=null, discountType='FIXED_AMOUNT'
3. First Order Deal: 50% off first order only
   - percentage=50, recurringCycleLimit=1, discountType='PERCENTAGE'

Returns: Updated subscription contract object with discount applied

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

Endpoint: PUT /api/external/v2/subscription-contracts-add-discount
Version: 0.0.1

## Query parameters:

  - `contractId` (integer, required)
    Subscription contract ID to add discount to
    Example: 123456789

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

  - `percentage` (integer)
    Percentage discount value (use with discountType=PERCENTAGE)
    Example: 15

  - `discountTitle` (string)
    Display title for the discount
    Example: "Loyalty Discount"

  - `recurringCycleLimit` (integer)
    Number of billing cycles discount applies (null for unlimited)
    Example: 3

  - `appliesOnEachItem` (boolean)
    Apply discount to each item individually (true) or entire order (false)

  - `amount` (number)
    Fixed amount discount value (use with discountType=FIXED_AMOUNT)
    Example: 10

  - `discountType` (string)
    Discount type: PERCENTAGE or FIXED_AMOUNT
    Example: "PERCENTAGE"

## 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 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)

## Response 500 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)