Update custom attributes on contract line items

PUT /subscriptions/cp/api/subscription-contracts-update-line-item-attributes

Update custom attributes on contract line items

cURL

curl --request PUT \
  --url https://www.myshop.com/apps/subscriptions/cp/api/subscription-contracts-update-line-item-attributes \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "key": "<string>",
    "value": "<string>"
  }
]
'

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
      }
    ]
  }
}

Query Parameters

contractId · integer<int64> · required

lineId · string · required

Body

application/json

key · string

value · string

Response

200 - */*

OK

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