Remove discount from subscription

Removes a specific discount from a subscription contract based on the discount ID. This will affect the pricing of all future orders generated by the subscription.

Full behavior, validation rules, and side effects

Key Features:

• Removes any type of discount: automatic, manual, or code-based
• Uses Shopify’s draft system for safe removal
• Immediate effect on future order pricing
• Cannot be undone - discount must be re-applied if needed
• Activity log tracks removed discounts

Finding Discount IDs: Discount IDs can be found in the subscription contract’s discount collection:

• Query the subscription contract to see discounts.edges[].node.id
• Format: gid://shopify/SubscriptionManualDiscount/123456
• Each discount has a unique ID regardless of type

Types of Discounts:

• Manual Discounts: Applied via API (percentage, fixed, price)
• Code Discounts: Applied using discount codes
• Automatic Discounts: Applied by Shopify based on rules
• Build-a-Box Discounts: Volume-based discounts
• Selling Plan Discounts: Built into the subscription plan

Impact on Pricing: When a discount is removed:

• Future orders use full price (no discount)
• Existing orders are not affected
• Other discounts remain active
• Shipping prices may be recalculated
• Customer sees updated pricing immediately

Common Use Cases:

• End promotional period discounts
• Remove expired or invalid discount codes
• Clear discounts before applying new ones
• Customer service adjustments
• Correct pricing errors

Important Notes:

• Cannot remove selling plan built-in discounts
• No customer notification sent (consider sending separately)
• Cannot selectively remove - removes entire discount
• Build-a-Box discounts may auto-reapply based on quantity
• Some discounts may be required by business rules

Post-Removal Considerations:

• Customer may notice price increase on next order
• May affect customer retention if unexpected
• Consider grace periods or notifications
• Document reason for removal in your system

Authentication: Requires valid X-API-Key header

PUT /api/external/v2/subscription-contracts-remove-discount

Remove discount from subscription

cURL

curl --request PUT \
  --url https://subscription-admin.appstle.com/api/external/v2/subscription-contracts-remove-discount \
  --header 'X-API-Key: <x-api-key>'

200

Success Response

{
  "id": "gid://shopify/SubscriptionContract/123456789",
  "status": "ACTIVE",
  "nextBillingDate": "2024-04-01T00:00:00Z",
  "customer": {
    "id": "gid://shopify/Customer/987654321",
    "email": "[e-mail]"
  },
  "lines": {
    "edges": [
      {
        "node": {
          "id": "gid://shopify/SubscriptionLine/111111",
          "quantity": 2,
          "variantId": "gid://shopify/ProductVariant/42549172011164",
          "title": "Premium Coffee - Monthly Supply",
          "currentPrice": {
            "amount": "39.99",
            "currencyCode": "USD"
          },
          "pricingPolicy": {
            "basePrice": {
              "amount": "39.99",
              "currencyCode": "USD"
            }
          }
        }
      }
    ]
  },
  "discounts": {
    "edges": []
  },
  "deliveryPrice": {
    "amount": "5.99",
    "currencyCode": "USD"
  }
}

Headers

X-API-Key · string · required

API Key for authentication

Query Parameters

contractId · integer<int64> · required

Subscription contract ID to remove discount from

api_key · string

API Key (Deprecated - Use X-API-Key header instead)

discountId · string · required

ID of the discount to be removed. Must be the full GraphQL ID including the gid:// prefix. You can find discount IDs by querying the subscription contract and looking at the discounts collection. Format example: gid://shopify/SubscriptionManualDiscount/123456789

Response

200

application/json

Discount successfully removed

get__typename · string

id · string

createdAt · object

updatedAt · object

nextBillingDate · object

status · enum<string>

Available options: ACTIVE, PAUSED, CANCELLED, EXPIRED, FAILED, $UNKNOWN

deliveryPrice · object

Show child attributes

lastPaymentStatus · enum<string>

Available options: SUCCEEDED, FAILED, $UNKNOWN

billingPolicy · object

Show child attributes

deliveryPolicy · object

Show child attributes

lines · object

Show child attributes

customerPaymentMethod · object

Show child attributes

deliveryMethod · object

Show child attributes

originOrder · object

Show child attributes

customer · object

Show child attributes

discounts · object

Show child attributes

note · string

customAttributes · object[]

Show child attributes

billingAttempts · object

Show child attributes