Get raw Shopify GraphQL contract response

Retrieves the complete, unprocessed subscription contract data directly from Shopify’s GraphQL API. This endpoint returns the full Shopify subscription contract object exactly as Shopify provides it, including all nested fields, relationships, and GraphQL metadata.

Full behavior, validation rules, and side effects

What This Endpoint Returns: Unlike processed/transformed endpoints, this returns Shopify’s raw SubscriptionContract GraphQL object with all available fields. This is the same data structure you would receive if querying Shopify’s GraphQL API directly, making it ideal for:

• Debugging Shopify data synchronization issues
• Accessing fields not exposed in other endpoints
• Understanding complete Shopify contract structure
• Building custom integrations requiring full data
• Comparing Shopify source data with processed data

Data Included:

Contract Core:

• Full subscription contract object from Shopify
• All GraphQL __typename fields preserved
• Complete nested object structures
• All available Shopify contract fields

Customer Information:

• Complete customer object with all fields
• Default address details
• Customer tags and metadata
• Marketing preferences

Line Items:

• Full line item details with edges/nodes structure
• Product and variant complete objects
• Pricing policies with all cycle discounts
• Line item custom attributes
• Current and original prices

Billing & Delivery:

• Complete billing policy object
• Full delivery policy details
• Delivery method with all fields
• Delivery price breakdown
• Billing anchor details

Payment Information:

• Payment method details (if available)
• Customer payment instrument
• Payment gateway information

Orders & History:

• Origin order details
• Last payment status
• Historical billing attempts (in Appstle)

Use Cases:

1. Debugging & Troubleshooting:

• Investigate data sync discrepancies
• Verify what Shopify actually stores
• Debug webhook payload issues
• Compare expected vs actual data

2. Advanced Integrations:

• Access Shopify-specific fields not in standard APIs
• Build custom analytics using raw data
• Integrate with Shopify GraphQL directly
• Extract fields for custom processing

3. Data Analysis:

• Analyze complete contract structure
• Extract all available metadata
• Build comprehensive data exports
• Perform deep data audits

4. Development & Testing:

• Understand Shopify’s data model
• Test new feature development
• Verify API responses
• Documentation and examples

Response Structure:

Returns SubscriptionContractQuery.SubscriptionContract object:

{
  "id": "gid://shopify/SubscriptionContract/123456789",
  "status": "ACTIVE",
  "nextBillingDate": "2024-03-15T00:00:00Z",
  "customer": {
    "id": "gid://shopify/Customer/987654321",
    "email": "[e-mail]",
    "displayName": "John Doe",
    "__typename": "Customer"
  },
  "lines": {
    "edges": [
      {
        "node": {
          "id": "gid://shopify/SubscriptionLine/111111",
          "quantity": 2,
          "variantId": "gid://shopify/ProductVariant/222222",
          "title": "Monthly Coffee Box",
          "variantTitle": "Medium Roast",
          "currentPrice": {
            "amount": "29.99",
            "currencyCode": "USD"
          },
          "pricingPolicy": {...},
          "__typename": "SubscriptionLine"
        }
      }
    ]
  },
  "billingPolicy": {
    "interval": "MONTH",
    "intervalCount": 1,
    "minCycles": 3,
    "maxCycles": 12
  },
  "deliveryPolicy": {...},
  "deliveryMethod": {...},
  "__typename": "SubscriptionContract"
}

Important Considerations:

Data Source:

• Queries Shopify GraphQL API in real-time
• NOT cached in Appstle database
• Always returns current Shopify state
• Subject to Shopify API rate limits

Performance:

• Slower than database queries (500-1500ms typical)
• Makes real-time call to Shopify
• Response size can be large (10-50 KB)
• Use sparingly to avoid rate limits

GraphQL Structure:

• Includes __typename fields throughout
• Uses GraphQL ID format (gid://shopify/…)
• Nested edges/nodes structure for lists
• All fields as defined in Shopify’s schema

Best Practices:

1. Use for Debugging: Perfect for troubleshooting data issues
2. Avoid Polling: Don’t call repeatedly - use cached/processed endpoints instead
3. Cache Response: Cache the response if using for display
4. Parse Carefully: Handle GraphQL structure (edges/nodes)
5. Monitor Rate Limits: Each call counts against Shopify API limits

When to Use vs Other Endpoints:

Use this endpoint when:

• Need complete Shopify contract data
• Debugging synchronization issues
• Accessing Shopify-specific fields
• Building Shopify GraphQL integrations

Use /api/external/v2/subscription-contract-details when:

• Need processed, filtered contract data
• Want faster response times
• Querying multiple contracts
• Building customer-facing UIs

Authentication: Requires valid X-API-Key header

GET /api/external/v2/subscription-contracts/contract-external/{contractId}

Get raw Shopify GraphQL contract response

cURL

curl --request GET \
  --url https://subscription-admin.appstle.com/api/external/v2/subscription-contracts/contract-external/{contractId}

200

{
  "get__typename": "<string>",
  "id": "<string>",
  "createdAt": {},
  "updatedAt": {},
  "nextBillingDate": {},
  "deliveryPrice": {
    "get__typename": "<string>",
    "amount": {}
  },
  "billingPolicy": {
    "get__typename": "<string>",
    "intervalCount": 123,
    "anchors": [
      {
        "get__typename": "<string>",
        "cutoffDay": 123,
        "day": 123,
        "month": 123
      }
    ],
    "maxCycles": 123,
    "minCycles": 123
  },
  "deliveryPolicy": {
    "get__typename": "<string>",
    "intervalCount": 123,
    "anchors": [
      {
        "get__typename": "<string>",
        "cutoffDay": 123,
        "day": 123,
        "month": 123
      }
    ]
  },
  "lines": {
    "get__typename": "<string>",
    "nodes": [
      {
        "get__typename": "<string>",
        "id": "<string>",
        "sellingPlanId": "<string>",
        "sellingPlanName": "<string>",
        "productId": "<string>",
        "sku": "<string>",
        "title": "<string>",
        "variantId": "<string>",
        "quantity": 123,
        "customAttributes": [
          {
            "get__typename": "<string>",
            "key": "<string>",
            "value": "<string>"
          }
        ],
        "lineDiscountedPrice": {
          "get__typename": "<string>",
          "amount": {}
        },
        "variantImage": {
          "get__typename": "<string>",
          "transformedSrc": {}
        },
        "variantTitle": "<string>",
        "currentPrice": {
          "get__typename": "<string>",
          "amount": {}
        },
        "discountAllocations": [
          {
            "get__typename": "<string>",
            "amount": {
              "get__typename": "<string>",
              "amount": {}
            },
            "discount": {
              "get__typename": "<string>"
            }
          }
        ],
        "pricingPolicy": {
          "get__typename": "<string>",
          "basePrice": {
            "get__typename": "<string>",
            "amount": {}
          },
          "cycleDiscounts": [
            {
              "get__typename": "<string>",
              "afterCycle": 123,
              "computedPrice": {
                "get__typename": "<string>",
                "amount": {}
              },
              "adjustmentValue": {
                "get__typename": "<string>"
              }
            }
          ]
        },
        "taxable": true
      }
    ],
    "pageInfo": {
      "get__typename": "<string>",
      "hasPreviousPage": true,
      "hasNextPage": true,
      "startCursor": "<string>",
      "endCursor": "<string>"
    }
  },
  "customerPaymentMethod": {
    "get__typename": "<string>",
    "id": "<string>",
    "instrument": {
      "get__typename": "<string>"
    },
    "revokedAt": {}
  },
  "deliveryMethod": {
    "get__typename": "<string>"
  },
  "originOrder": {
    "get__typename": "<string>",
    "id": "<string>",
    "name": "<string>",
    "fulfillmentOrders": {
      "get__typename": "<string>",
      "nodes": [
        {
          "get__typename": "<string>",
          "fulfillAt": {},
          "id": "<string>"
        }
      ],
      "pageInfo": {
        "get__typename": "<string>",
        "hasPreviousPage": true,
        "hasNextPage": true,
        "startCursor": "<string>",
        "endCursor": "<string>"
      }
    }
  },
  "customer": {
    "get__typename": "<string>",
    "id": "<string>",
    "email": "<string>",
    "displayName": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "phone": "<string>"
  },
  "discounts": {
    "get__typename": "<string>",
    "nodes": [
      {
        "get__typename": "<string>",
        "id": "<string>",
        "title": "<string>",
        "value": {
          "get__typename": "<string>"
        },
        "recurringCycleLimit": 123,
        "usageCount": 123
      }
    ],
    "pageInfo": {
      "get__typename": "<string>",
      "hasPreviousPage": true,
      "hasNextPage": true,
      "startCursor": "<string>",
      "endCursor": "<string>"
    }
  },
  "note": "<string>",
  "customAttributes": [
    {
      "get__typename": "<string>",
      "key": "<string>",
      "value": "<string>"
    }
  ],
  "billingAttempts": {
    "get__typename": "<string>",
    "nodes": [
      {
        "get__typename": "<string>",
        "completedAt": {},
        "createdAt": {},
        "id": "<string>",
        "idempotencyKey": "<string>",
        "ready": true
      }
    ]
  }
}

Headers

X-API-Key · string

Path Parameters

contractId · integer<int64> · required

Contract ID

Query Parameters

api_key · string

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

Response

200

application/json

Successfully retrieved raw Shopify contract data

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