🟠UPDATE

Update Subscription Shipping Address

Updates the shipping address for a specific subscription contract.

PUThttp://localhost:3002/subscriptions/{contractId}/shipping-address

Path parameters

contractId*string

The ID of the subscription contract whose shipping address is to be updated.

Query parameters

Body

The new shipping address to be applied to the subscription.

address1*string

address2string

city*string

country*string

zip*string

provincestring

firstNamestring

lastNamestring

phonestring

Response

Successfully updated the shipping address.

Body

successboolean

dataSubscriptionContract (object)

Request

const response = await fetch('http://localhost:3002/subscriptions/{contractId}/shipping-address?shop=text&customerId=text', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "address1": "text",
      "city": "text",
      "country": "text",
      "zip": "text"
    }),
});
const data = await response.json();

Response

{
  "success": false,
  "data": {
    "id": "text",
    "failedBillingCount": 0,
    "subscriptionTotal": 0,
    "draft": false,
    "createdAt": "text",
    "notification_at": "2024-09-19T21:57:07.023Z",
    "notified": false,
    "billingInterval": "text",
    "billingIntervalCount": 0,
    "maxCycles": 0,
    "isPrepaid": false,
    "minCycles": 0,
    "billingAnchorType": "text",
    "billingAnchorDay": 0,
    "billingAnchorMonth": 0,
    "currencyCode": "text",
    "customer": {
      "id": "text",
      "addresses": [
        {
          "id": "text",
          "address1": "text",
          "address2": "text",
          "city": "text",
          "company": "text",
          "country": "text",
          "countryCodeV2": "text",
          "firstName": "text",
          "lastName": "text",
          "phone": "text",
          "province": "text",
          "provinceCode": "text",
          "zip": "text"
        }
      ],
      "tags": [
        "text"
      ],
      "firstName": "text",
      "lastName": "text",
      "email": "text",
      "phone": "text",
      "state": "text",
      "createdAt": "text",
      "imageUrl": "text"
    },
    "deliveryPrice": 0,
    "customAttributes": [
      {
        "key": "text",
        "value": "text"
      }
    ],
    "orderIds": [
      "text"
    ],
    "status": "text",
    "shop": "text",
    "lines": [
      {
        "id": "text",
        "sku": "text",
        "title": "text",
        "productId": "text",
        "variantId": "text",
        "variantTitle": "text",
        "sellingPlanName": "text",
        "displayName": "text",
        "sellingPlanId": "text",
        "taxable": false,
        "handle": "text",
        "variantImage": {
          "url": "text"
        },
        "currentPrice": {
          "amount": "text",
          "currencyCode": "text"
        },
        "lineDiscountedPrice": {
          "amount": "text",
          "currencyCode": "text"
        },
        "requiresShipping": false,
        "customAttributes": [
          {
            "key": "text",
            "value": "text"
          }
        ],
        "discountAllocations": [
          {
            "amount": {
              "amount": "text",
              "currencyCode": "text"
            },
            "discount": "text"
          }
        ],
        "pricingPolicy": {
          "basePrice": {
            "amount": "text",
            "currencyCode": "text"
          },
          "cycleDiscounts": [
            {
              "adjustmentType": "text",
              "adjustmentValue": {
                "SellingPlanPricingPolicyPercentageValue": {
                  "percentage": "text"
                }
              },
              "afterCycle": 0,
              "computedPrice": {
                "amount": "text",
                "currencyCode": "text"
              }
            }
          ]
        }
      }
    ],
    "addons": [
      {
        "id": "text",
        "sku": "text",
        "title": "text",
        "productId": "text",
        "variantId": "text",
        "variantTitle": "text",
        "sellingPlanName": "text",
        "displayName": "text",
        "sellingPlanId": "text",
        "taxable": false,
        "handle": "text",
        "variantImage": {
          "url": "text"
        },
        "currentPrice": {
          "amount": "text",
          "currencyCode": "text"
        },
        "lineDiscountedPrice": {
          "amount": "text",
          "currencyCode": "text"
        },
        "requiresShipping": false,
        "customAttributes": [
          {
            "key": "text",
            "value": "text"
          }
        ],
        "discountAllocations": [
          {
            "amount": {
              "amount": "text",
              "currencyCode": "text"
            },
            "discount": "text"
          }
        ],
        "pricingPolicy": {
          "basePrice": {
            "amount": "text",
            "currencyCode": "text"
          },
          "cycleDiscounts": [
            {
              "adjustmentType": "text",
              "adjustmentValue": {
                "SellingPlanPricingPolicyPercentageValue": {
                  "percentage": "text"
                }
              },
              "afterCycle": 0,
              "computedPrice": {
                "amount": "text",
                "currencyCode": "text"
              }
            }
          ]
        }
      }
    ],
    "deliveryMethod": {
      "shippingOption": {
        "code": "text",
        "description": "text"
      }
    },
    "originOrder": {
      "id": "text",
      "legacyResourceId": "text",
      "name": "text",
      "createdAt": "text",
      "amount": "text"
    }
  }
}

Set the Next Billing Date of a Subscription

Updates the next billing date for a specified subscription contract.

PUThttp://localhost:3002/subscriptions/{contractId}/next-billing-date

Path parameters

contractId*string

The unique identifier of the subscription contract to update.

Query parameters

Body

datestring (date-time)

The new billing date in ISO 8601 format. This date must be in the future.

Response

Successfully updated the next billing date.

Body

successboolean

dataSubscriptionContract (object)

Request

const response = await fetch('http://localhost:3002/subscriptions/{contractId}/next-billing-date?shop=text&customerId=text', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "success": false,
  "data": {
    "id": "text",
    "failedBillingCount": 0,
    "subscriptionTotal": 0,
    "draft": false,
    "createdAt": "text",
    "notification_at": "2024-09-19T21:57:07.023Z",
    "notified": false,
    "billingInterval": "text",
    "billingIntervalCount": 0,
    "maxCycles": 0,
    "isPrepaid": false,
    "minCycles": 0,
    "billingAnchorType": "text",
    "billingAnchorDay": 0,
    "billingAnchorMonth": 0,
    "currencyCode": "text",
    "customer": {
      "id": "text",
      "addresses": [
        {
          "id": "text",
          "address1": "text",
          "address2": "text",
          "city": "text",
          "company": "text",
          "country": "text",
          "countryCodeV2": "text",
          "firstName": "text",
          "lastName": "text",
          "phone": "text",
          "province": "text",
          "provinceCode": "text",
          "zip": "text"
        }
      ],
      "tags": [
        "text"
      ],
      "firstName": "text",
      "lastName": "text",
      "email": "text",
      "phone": "text",
      "state": "text",
      "createdAt": "text",
      "imageUrl": "text"
    },
    "deliveryPrice": 0,
    "customAttributes": [
      {
        "key": "text",
        "value": "text"
      }
    ],
    "orderIds": [
      "text"
    ],
    "status": "text",
    "shop": "text",
    "lines": [
      {
        "id": "text",
        "sku": "text",
        "title": "text",
        "productId": "text",
        "variantId": "text",
        "variantTitle": "text",
        "sellingPlanName": "text",
        "displayName": "text",
        "sellingPlanId": "text",
        "taxable": false,
        "handle": "text",
        "variantImage": {
          "url": "text"
        },
        "currentPrice": {
          "amount": "text",
          "currencyCode": "text"
        },
        "lineDiscountedPrice": {
          "amount": "text",
          "currencyCode": "text"
        },
        "requiresShipping": false,
        "customAttributes": [
          {
            "key": "text",
            "value": "text"
          }
        ],
        "discountAllocations": [
          {
            "amount": {
              "amount": "text",
              "currencyCode": "text"
            },
            "discount": "text"
          }
        ],
        "pricingPolicy": {
          "basePrice": {
            "amount": "text",
            "currencyCode": "text"
          },
          "cycleDiscounts": [
            {
              "adjustmentType": "text",
              "adjustmentValue": {
                "SellingPlanPricingPolicyPercentageValue": {
                  "percentage": "text"
                }
              },
              "afterCycle": 0,
              "computedPrice": {
                "amount": "text",
                "currencyCode": "text"
              }
            }
          ]
        }
      }
    ],
    "addons": [
      {
        "id": "text",
        "sku": "text",
        "title": "text",
        "productId": "text",
        "variantId": "text",
        "variantTitle": "text",
        "sellingPlanName": "text",
        "displayName": "text",
        "sellingPlanId": "text",
        "taxable": false,
        "handle": "text",
        "variantImage": {
          "url": "text"
        },
        "currentPrice": {
          "amount": "text",
          "currencyCode": "text"
        },
        "lineDiscountedPrice": {
          "amount": "text",
          "currencyCode": "text"
        },
        "requiresShipping": false,
        "customAttributes": [
          {
            "key": "text",
            "value": "text"
          }
        ],
        "discountAllocations": [
          {
            "amount": {
              "amount": "text",
              "currencyCode": "text"
            },
            "discount": "text"
          }
        ],
        "pricingPolicy": {
          "basePrice": {
            "amount": "text",
            "currencyCode": "text"
          },
          "cycleDiscounts": [
            {
              "adjustmentType": "text",
              "adjustmentValue": {
                "SellingPlanPricingPolicyPercentageValue": {
                  "percentage": "text"
                }
              },
              "afterCycle": 0,
              "computedPrice": {
                "amount": "text",
                "currencyCode": "text"
              }
            }
          ]
        }
      }
    ],
    "deliveryMethod": {
      "shippingOption": {
        "code": "text",
        "description": "text"
      }
    },
    "originOrder": {
      "id": "text",
      "legacyResourceId": "text",
      "name": "text",
      "createdAt": "text",
      "amount": "text"
    }
  }
}

Update a Subscription's Line Items

Updates the line items of a subscription contract, allowing changes such as modifying quantities, changing product variants, or applying new selling plans.

PUThttp://localhost:3002/subscriptions/{contractId}/line-item

Path parameters

contractId*string

The unique identifier of the subscription contract to update.

Query parameters

Body

productVariantId*string

The ID of the product variant to be added or updated in the subscription.

sellingPlanIdstring

The selling plan associated with the subscription item.

quantity*integer

The quantity of the product variant.

pricenumber

Optional custom price to override the default product variant price.

pricingPolicyobject

customAttributesarray of object

Response

Successfully updated the line items of the subscription contract.

Body

successboolean

dataSubscriptionContract (object)

Request

const response = await fetch('http://localhost:3002/subscriptions/{contractId}/line-item?shop=text&customerId=text', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "productVariantId": "text"
    }),
});
const data = await response.json();

Response

{
  "success": false,
  "data": {
    "id": "text",
    "failedBillingCount": 0,
    "subscriptionTotal": 0,
    "draft": false,
    "createdAt": "text",
    "notification_at": "2024-09-19T21:57:07.023Z",
    "notified": false,
    "billingInterval": "text",
    "billingIntervalCount": 0,
    "maxCycles": 0,
    "isPrepaid": false,
    "minCycles": 0,
    "billingAnchorType": "text",
    "billingAnchorDay": 0,
    "billingAnchorMonth": 0,
    "currencyCode": "text",
    "customer": {
      "id": "text",
      "addresses": [
        {
          "id": "text",
          "address1": "text",
          "address2": "text",
          "city": "text",
          "company": "text",
          "country": "text",
          "countryCodeV2": "text",
          "firstName": "text",
          "lastName": "text",
          "phone": "text",
          "province": "text",
          "provinceCode": "text",
          "zip": "text"
        }
      ],
      "tags": [
        "text"
      ],
      "firstName": "text",
      "lastName": "text",
      "email": "text",
      "phone": "text",
      "state": "text",
      "createdAt": "text",
      "imageUrl": "text"
    },
    "deliveryPrice": 0,
    "customAttributes": [
      {
        "key": "text",
        "value": "text"
      }
    ],
    "orderIds": [
      "text"
    ],
    "status": "text",
    "shop": "text",
    "lines": [
      {
        "id": "text",
        "sku": "text",
        "title": "text",
        "productId": "text",
        "variantId": "text",
        "variantTitle": "text",
        "sellingPlanName": "text",
        "displayName": "text",
        "sellingPlanId": "text",
        "taxable": false,
        "handle": "text",
        "variantImage": {
          "url": "text"
        },
        "currentPrice": {
          "amount": "text",
          "currencyCode": "text"
        },
        "lineDiscountedPrice": {
          "amount": "text",
          "currencyCode": "text"
        },
        "requiresShipping": false,
        "customAttributes": [
          {
            "key": "text",
            "value": "text"
          }
        ],
        "discountAllocations": [
          {
            "amount": {
              "amount": "text",
              "currencyCode": "text"
            },
            "discount": "text"
          }
        ],
        "pricingPolicy": {
          "basePrice": {
            "amount": "text",
            "currencyCode": "text"
          },
          "cycleDiscounts": [
            {
              "adjustmentType": "text",
              "adjustmentValue": {
                "SellingPlanPricingPolicyPercentageValue": {
                  "percentage": "text"
                }
              },
              "afterCycle": 0,
              "computedPrice": {
                "amount": "text",
                "currencyCode": "text"
              }
            }
          ]
        }
      }
    ],
    "addons": [
      {
        "id": "text",
        "sku": "text",
        "title": "text",
        "productId": "text",
        "variantId": "text",
        "variantTitle": "text",
        "sellingPlanName": "text",
        "displayName": "text",
        "sellingPlanId": "text",
        "taxable": false,
        "handle": "text",
        "variantImage": {
          "url": "text"
        },
        "currentPrice": {
          "amount": "text",
          "currencyCode": "text"
        },
        "lineDiscountedPrice": {
          "amount": "text",
          "currencyCode": "text"
        },
        "requiresShipping": false,
        "customAttributes": [
          {
            "key": "text",
            "value": "text"
          }
        ],
        "discountAllocations": [
          {
            "amount": {
              "amount": "text",
              "currencyCode": "text"
            },
            "discount": "text"
          }
        ],
        "pricingPolicy": {
          "basePrice": {
            "amount": "text",
            "currencyCode": "text"
          },
          "cycleDiscounts": [
            {
              "adjustmentType": "text",
              "adjustmentValue": {
                "SellingPlanPricingPolicyPercentageValue": {
                  "percentage": "text"
                }
              },
              "afterCycle": 0,
              "computedPrice": {
                "amount": "text",
                "currencyCode": "text"
              }
            }
          ]
        }
      }
    ],
    "deliveryMethod": {
      "shippingOption": {
        "code": "text",
        "description": "text"
      }
    },
    "originOrder": {
      "id": "text",
      "legacyResourceId": "text",
      "name": "text",
      "createdAt": "text",
      "amount": "text"
    }
  }
}

Add a new line item to a subscription

Adds a new line item to an existing subscription contract, allowing for the inclusion of additional products or variants in the subscription.

PUThttp://localhost:3002/subscriptions/{contractId}/add-line-item

Path parameters

contractId*string

The ID of the subscription contract to add the line item to.

Query parameters

Body

productVariantId*string

The ID of the product variant to be added as a new line item.

sellingPlanIdstring

The selling plan ID associated with this line item, if applicable.

quantity*integer

The quantity of the product variant to be added.

pricenumber

The custom price to apply to this line item, if overriding the default.

customAttributesarray of object

Custom attributes associated with the line item.

Response

Successfully added the new line item to the subscription contract.

Body

successboolean

dataSubscriptionContract (object)

Request

const response = await fetch('http://localhost:3002/subscriptions/{contractId}/add-line-item?shop=text', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "productVariantId": "text"
    }),
});
const data = await response.json();

Response

{
  "success": false,
  "data": {
    "id": "text",
    "failedBillingCount": 0,
    "subscriptionTotal": 0,
    "draft": false,
    "createdAt": "text",
    "notification_at": "2024-09-19T21:57:07.023Z",
    "notified": false,
    "billingInterval": "text",
    "billingIntervalCount": 0,
    "maxCycles": 0,
    "isPrepaid": false,
    "minCycles": 0,
    "billingAnchorType": "text",
    "billingAnchorDay": 0,
    "billingAnchorMonth": 0,
    "currencyCode": "text",
    "customer": {
      "id": "text",
      "addresses": [
        {
          "id": "text",
          "address1": "text",
          "address2": "text",
          "city": "text",
          "company": "text",
          "country": "text",
          "countryCodeV2": "text",
          "firstName": "text",
          "lastName": "text",
          "phone": "text",
          "province": "text",
          "provinceCode": "text",
          "zip": "text"
        }
      ],
      "tags": [
        "text"
      ],
      "firstName": "text",
      "lastName": "text",
      "email": "text",
      "phone": "text",
      "state": "text",
      "createdAt": "text",
      "imageUrl": "text"
    },
    "deliveryPrice": 0,
    "customAttributes": [
      {
        "key": "text",
        "value": "text"
      }
    ],
    "orderIds": [
      "text"
    ],
    "status": "text",
    "shop": "text",
    "lines": [
      {
        "id": "text",
        "sku": "text",
        "title": "text",
        "productId": "text",
        "variantId": "text",
        "variantTitle": "text",
        "sellingPlanName": "text",
        "displayName": "text",
        "sellingPlanId": "text",
        "taxable": false,
        "handle": "text",
        "variantImage": {
          "url": "text"
        },
        "currentPrice": {
          "amount": "text",
          "currencyCode": "text"
        },
        "lineDiscountedPrice": {
          "amount": "text",
          "currencyCode": "text"
        },
        "requiresShipping": false,
        "customAttributes": [
          {
            "key": "text",
            "value": "text"
          }
        ],
        "discountAllocations": [
          {
            "amount": {
              "amount": "text",
              "currencyCode": "text"
            },
            "discount": "text"
          }
        ],
        "pricingPolicy": {
          "basePrice": {
            "amount": "text",
            "currencyCode": "text"
          },
          "cycleDiscounts": [
            {
              "adjustmentType": "text",
              "adjustmentValue": {
                "SellingPlanPricingPolicyPercentageValue": {
                  "percentage": "text"
                }
              },
              "afterCycle": 0,
              "computedPrice": {
                "amount": "text",
                "currencyCode": "text"
              }
            }
          ]
        }
      }
    ],
    "addons": [
      {
        "id": "text",
        "sku": "text",
        "title": "text",
        "productId": "text",
        "variantId": "text",
        "variantTitle": "text",
        "sellingPlanName": "text",
        "displayName": "text",
        "sellingPlanId": "text",
        "taxable": false,
        "handle": "text",
        "variantImage": {
          "url": "text"
        },
        "currentPrice": {
          "amount": "text",
          "currencyCode": "text"
        },
        "lineDiscountedPrice": {
          "amount": "text",
          "currencyCode": "text"
        },
        "requiresShipping": false,
        "customAttributes": [
          {
            "key": "text",
            "value": "text"
          }
        ],
        "discountAllocations": [
          {
            "amount": {
              "amount": "text",
              "currencyCode": "text"
            },
            "discount": "text"
          }
        ],
        "pricingPolicy": {
          "basePrice": {
            "amount": "text",
            "currencyCode": "text"
          },
          "cycleDiscounts": [
            {
              "adjustmentType": "text",
              "adjustmentValue": {
                "SellingPlanPricingPolicyPercentageValue": {
                  "percentage": "text"
                }
              },
              "afterCycle": 0,
              "computedPrice": {
                "amount": "text",
                "currencyCode": "text"
              }
            }
          ]
        }
      }
    ],
    "deliveryMethod": {
      "shippingOption": {
        "code": "text",
        "description": "text"
      }
    },
    "originOrder": {
      "id": "text",
      "legacyResourceId": "text",
      "name": "text",
      "createdAt": "text",
      "amount": "text"
    }
  }
}

Add an addon line item to a subscription

Adds an addon line item to an existing subscription contract, marking it with custom attributes to signify its addon status.

PUThttp://localhost:3002/subscriptions/{contractId}/add-addon-line-item

Path parameters

contractId*string

The ID of the subscription contract to which the addon line item will be added.

Query parameters

Body

lineItemobject

addonboolean

A flag indicating whether the line item is an addon. If true, custom attributes for addons are automatically applied.

Response

Successfully added the new addon line item to the subscription contract.

Body

successboolean

dataSubscriptionContract (object)

Request

const response = await fetch('http://localhost:3002/subscriptions/{contractId}/add-addon-line-item?shop=text', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "success": false,
  "data": {
    "id": "text",
    "failedBillingCount": 0,
    "subscriptionTotal": 0,
    "draft": false,
    "createdAt": "text",
    "notification_at": "2024-09-19T21:57:07.023Z",
    "notified": false,
    "billingInterval": "text",
    "billingIntervalCount": 0,
    "maxCycles": 0,
    "isPrepaid": false,
    "minCycles": 0,
    "billingAnchorType": "text",
    "billingAnchorDay": 0,
    "billingAnchorMonth": 0,
    "currencyCode": "text",
    "customer": {
      "id": "text",
      "addresses": [
        {
          "id": "text",
          "address1": "text",
          "address2": "text",
          "city": "text",
          "company": "text",
          "country": "text",
          "countryCodeV2": "text",
          "firstName": "text",
          "lastName": "text",
          "phone": "text",
          "province": "text",
          "provinceCode": "text",
          "zip": "text"
        }
      ],
      "tags": [
        "text"
      ],
      "firstName": "text",
      "lastName": "text",
      "email": "text",
      "phone": "text",
      "state": "text",
      "createdAt": "text",
      "imageUrl": "text"
    },
    "deliveryPrice": 0,
    "customAttributes": [
      {
        "key": "text",
        "value": "text"
      }
    ],
    "orderIds": [
      "text"
    ],
    "status": "text",
    "shop": "text",
    "lines": [
      {
        "id": "text",
        "sku": "text",
        "title": "text",
        "productId": "text",
        "variantId": "text",
        "variantTitle": "text",
        "sellingPlanName": "text",
        "displayName": "text",
        "sellingPlanId": "text",
        "taxable": false,
        "handle": "text",
        "variantImage": {
          "url": "text"
        },
        "currentPrice": {
          "amount": "text",
          "currencyCode": "text"
        },
        "lineDiscountedPrice": {
          "amount": "text",
          "currencyCode": "text"
        },
        "requiresShipping": false,
        "customAttributes": [
          {
            "key": "text",
            "value": "text"
          }
        ],
        "discountAllocations": [
          {
            "amount": {
              "amount": "text",
              "currencyCode": "text"
            },
            "discount": "text"
          }
        ],
        "pricingPolicy": {
          "basePrice": {
            "amount": "text",
            "currencyCode": "text"
          },
          "cycleDiscounts": [
            {
              "adjustmentType": "text",
              "adjustmentValue": {
                "SellingPlanPricingPolicyPercentageValue": {
                  "percentage": "text"
                }
              },
              "afterCycle": 0,
              "computedPrice": {
                "amount": "text",
                "currencyCode": "text"
              }
            }
          ]
        }
      }
    ],
    "addons": [
      {
        "id": "text",
        "sku": "text",
        "title": "text",
        "productId": "text",
        "variantId": "text",
        "variantTitle": "text",
        "sellingPlanName": "text",
        "displayName": "text",
        "sellingPlanId": "text",
        "taxable": false,
        "handle": "text",
        "variantImage": {
          "url": "text"
        },
        "currentPrice": {
          "amount": "text",
          "currencyCode": "text"
        },
        "lineDiscountedPrice": {
          "amount": "text",
          "currencyCode": "text"
        },
        "requiresShipping": false,
        "customAttributes": [
          {
            "key": "text",
            "value": "text"
          }
        ],
        "discountAllocations": [
          {
            "amount": {
              "amount": "text",
              "currencyCode": "text"
            },
            "discount": "text"
          }
        ],
        "pricingPolicy": {
          "basePrice": {
            "amount": "text",
            "currencyCode": "text"
          },
          "cycleDiscounts": [
            {
              "adjustmentType": "text",
              "adjustmentValue": {
                "SellingPlanPricingPolicyPercentageValue": {
                  "percentage": "text"
                }
              },
              "afterCycle": 0,
              "computedPrice": {
                "amount": "text",
                "currencyCode": "text"
              }
            }
          ]
        }
      }
    ],
    "deliveryMethod": {
      "shippingOption": {
        "code": "text",
        "description": "text"
      }
    },
    "originOrder": {
      "id": "text",
      "legacyResourceId": "text",
      "name": "text",
      "createdAt": "text",
      "amount": "text"
    }
  }
}

Remove an add-on line item from a subscription

Removes a specified add-on line item from an existing subscription contract.

PUThttp://localhost:3002/subscriptions/{contractId}/remove-add-on

Path parameters

contractId*string

The ID of the subscription contract from which the add-on line item will be removed.

Query parameters

Body

lineIdstring

The ID of the line item to be removed from the subscription contract.

Response

Successfully removed the add-on line item from the subscription contract.

Body

successboolean

dataSubscriptionContract (object)

Request

const response = await fetch('http://localhost:3002/subscriptions/{contractId}/remove-add-on?shop=text&customerId=text', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "success": false,
  "data": {
    "id": "text",
    "failedBillingCount": 0,
    "subscriptionTotal": 0,
    "draft": false,
    "createdAt": "text",
    "notification_at": "2024-09-19T21:57:07.023Z",
    "notified": false,
    "billingInterval": "text",
    "billingIntervalCount": 0,
    "maxCycles": 0,
    "isPrepaid": false,
    "minCycles": 0,
    "billingAnchorType": "text",
    "billingAnchorDay": 0,
    "billingAnchorMonth": 0,
    "currencyCode": "text",
    "customer": {
      "id": "text",
      "addresses": [
        {
          "id": "text",
          "address1": "text",
          "address2": "text",
          "city": "text",
          "company": "text",
          "country": "text",
          "countryCodeV2": "text",
          "firstName": "text",
          "lastName": "text",
          "phone": "text",
          "province": "text",
          "provinceCode": "text",
          "zip": "text"
        }
      ],
      "tags": [
        "text"
      ],
      "firstName": "text",
      "lastName": "text",
      "email": "text",
      "phone": "text",
      "state": "text",
      "createdAt": "text",
      "imageUrl": "text"
    },
    "deliveryPrice": 0,
    "customAttributes": [
      {
        "key": "text",
        "value": "text"
      }
    ],
    "orderIds": [
      "text"
    ],
    "status": "text",
    "shop": "text",
    "lines": [
      {
        "id": "text",
        "sku": "text",
        "title": "text",
        "productId": "text",
        "variantId": "text",
        "variantTitle": "text",
        "sellingPlanName": "text",
        "displayName": "text",
        "sellingPlanId": "text",
        "taxable": false,
        "handle": "text",
        "variantImage": {
          "url": "text"
        },
        "currentPrice": {
          "amount": "text",
          "currencyCode": "text"
        },
        "lineDiscountedPrice": {
          "amount": "text",
          "currencyCode": "text"
        },
        "requiresShipping": false,
        "customAttributes": [
          {
            "key": "text",
            "value": "text"
          }
        ],
        "discountAllocations": [
          {
            "amount": {
              "amount": "text",
              "currencyCode": "text"
            },
            "discount": "text"
          }
        ],
        "pricingPolicy": {
          "basePrice": {
            "amount": "text",
            "currencyCode": "text"
          },
          "cycleDiscounts": [
            {
              "adjustmentType": "text",
              "adjustmentValue": {
                "SellingPlanPricingPolicyPercentageValue": {
                  "percentage": "text"
                }
              },
              "afterCycle": 0,
              "computedPrice": {
                "amount": "text",
                "currencyCode": "text"
              }
            }
          ]
        }
      }
    ],
    "addons": [
      {
        "id": "text",
        "sku": "text",
        "title": "text",
        "productId": "text",
        "variantId": "text",
        "variantTitle": "text",
        "sellingPlanName": "text",
        "displayName": "text",
        "sellingPlanId": "text",
        "taxable": false,
        "handle": "text",
        "variantImage": {
          "url": "text"
        },
        "currentPrice": {
          "amount": "text",
          "currencyCode": "text"
        },
        "lineDiscountedPrice": {
          "amount": "text",
          "currencyCode": "text"
        },
        "requiresShipping": false,
        "customAttributes": [
          {
            "key": "text",
            "value": "text"
          }
        ],
        "discountAllocations": [
          {
            "amount": {
              "amount": "text",
              "currencyCode": "text"
            },
            "discount": "text"
          }
        ],
        "pricingPolicy": {
          "basePrice": {
            "amount": "text",
            "currencyCode": "text"
          },
          "cycleDiscounts": [
            {
              "adjustmentType": "text",
              "adjustmentValue": {
                "SellingPlanPricingPolicyPercentageValue": {
                  "percentage": "text"
                }
              },
              "afterCycle": 0,
              "computedPrice": {
                "amount": "text",
                "currencyCode": "text"
              }
            }
          ]
        }
      }
    ],
    "deliveryMethod": {
      "shippingOption": {
        "code": "text",
        "description": "text"
      }
    },
    "originOrder": {
      "id": "text",
      "legacyResourceId": "text",
      "name": "text",
      "createdAt": "text",
      "amount": "text"
    }
  }
}

Pause or Unpause a Subscription

Allows toggling the pause state of a subscription contract. Setting the pause query parameter to true pauses the subscription, while false unpauses it.

PUThttp://localhost:3002/subscriptions/{contractId}/pause

Path parameters

contractId*string

The unique identifier of the subscription contract to be paused or unpaused.

Query parameters

Response

Successfully updated the pause state of the subscription.

Body

successboolean

dataSubscriptionContract (object)

Request

const response = await fetch('http://localhost:3002/subscriptions/{contractId}/pause?shop=text&customerId=text&pause=true', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

Response

{
  "success": false,
  "data": {
    "id": "text",
    "failedBillingCount": 0,
    "subscriptionTotal": 0,
    "draft": false,
    "createdAt": "text",
    "notification_at": "2024-09-19T21:57:07.023Z",
    "notified": false,
    "billingInterval": "text",
    "billingIntervalCount": 0,
    "maxCycles": 0,
    "isPrepaid": false,
    "minCycles": 0,
    "billingAnchorType": "text",
    "billingAnchorDay": 0,
    "billingAnchorMonth": 0,
    "currencyCode": "text",
    "customer": {
      "id": "text",
      "addresses": [
        {
          "id": "text",
          "address1": "text",
          "address2": "text",
          "city": "text",
          "company": "text",
          "country": "text",
          "countryCodeV2": "text",
          "firstName": "text",
          "lastName": "text",
          "phone": "text",
          "province": "text",
          "provinceCode": "text",
          "zip": "text"
        }
      ],
      "tags": [
        "text"
      ],
      "firstName": "text",
      "lastName": "text",
      "email": "text",
      "phone": "text",
      "state": "text",
      "createdAt": "text",
      "imageUrl": "text"
    },
    "deliveryPrice": 0,
    "customAttributes": [
      {
        "key": "text",
        "value": "text"
      }
    ],
    "orderIds": [
      "text"
    ],
    "status": "text",
    "shop": "text",
    "lines": [
      {
        "id": "text",
        "sku": "text",
        "title": "text",
        "productId": "text",
        "variantId": "text",
        "variantTitle": "text",
        "sellingPlanName": "text",
        "displayName": "text",
        "sellingPlanId": "text",
        "taxable": false,
        "handle": "text",
        "variantImage": {
          "url": "text"
        },
        "currentPrice": {
          "amount": "text",
          "currencyCode": "text"
        },
        "lineDiscountedPrice": {
          "amount": "text",
          "currencyCode": "text"
        },
        "requiresShipping": false,
        "customAttributes": [
          {
            "key": "text",
            "value": "text"
          }
        ],
        "discountAllocations": [
          {
            "amount": {
              "amount": "text",
              "currencyCode": "text"
            },
            "discount": "text"
          }
        ],
        "pricingPolicy": {
          "basePrice": {
            "amount": "text",
            "currencyCode": "text"
          },
          "cycleDiscounts": [
            {
              "adjustmentType": "text",
              "adjustmentValue": {
                "SellingPlanPricingPolicyPercentageValue": {
                  "percentage": "text"
                }
              },
              "afterCycle": 0,
              "computedPrice": {
                "amount": "text",
                "currencyCode": "text"
              }
            }
          ]
        }
      }
    ],
    "addons": [
      {
        "id": "text",
        "sku": "text",
        "title": "text",
        "productId": "text",
        "variantId": "text",
        "variantTitle": "text",
        "sellingPlanName": "text",
        "displayName": "text",
        "sellingPlanId": "text",
        "taxable": false,
        "handle": "text",
        "variantImage": {
          "url": "text"
        },
        "currentPrice": {
          "amount": "text",
          "currencyCode": "text"
        },
        "lineDiscountedPrice": {
          "amount": "text",
          "currencyCode": "text"
        },
        "requiresShipping": false,
        "customAttributes": [
          {
            "key": "text",
            "value": "text"
          }
        ],
        "discountAllocations": [
          {
            "amount": {
              "amount": "text",
              "currencyCode": "text"
            },
            "discount": "text"
          }
        ],
        "pricingPolicy": {
          "basePrice": {
            "amount": "text",
            "currencyCode": "text"
          },
          "cycleDiscounts": [
            {
              "adjustmentType": "text",
              "adjustmentValue": {
                "SellingPlanPricingPolicyPercentageValue": {
                  "percentage": "text"
                }
              },
              "afterCycle": 0,
              "computedPrice": {
                "amount": "text",
                "currencyCode": "text"
              }
            }
          ]
        }
      }
    ],
    "deliveryMethod": {
      "shippingOption": {
        "code": "text",
        "description": "text"
      }
    },
    "originOrder": {
      "id": "text",
      "legacyResourceId": "text",
      "name": "text",
      "createdAt": "text",
      "amount": "text"
    }
  }
}

PreviousGET NextDELETE

Last updated 6 months ago

const response = await fetch('http://localhost:3002/subscriptions/{contractId}/shipping-address?shop=text&customerId=text', { method: 'PUT', headers: { "Content-Type": "application/json" }, body: JSON.stringify({ "address1": "text", "city": "text", "country": "text", "zip": "text" }), }); const data = await response.json();

{ "success": false, "data": { "id": "text", "failedBillingCount": 0, "subscriptionTotal": 0, "draft": false, "createdAt": "text", "notification_at": "2024-09-19T21:57:07.023Z", "notified": false, "billingInterval": "text", "billingIntervalCount": 0, "maxCycles": 0, "isPrepaid": false, "minCycles": 0, "billingAnchorType": "text", "billingAnchorDay": 0, "billingAnchorMonth": 0, "currencyCode": "text", "customer": { "id": "text", "addresses": [ { "id": "text", "address1": "text", "address2": "text", "city": "text", "company": "text", "country": "text", "countryCodeV2": "text", "firstName": "text", "lastName": "text", "phone": "text", "province": "text", "provinceCode": "text", "zip": "text" } ], "tags": [ "text" ], "firstName": "text", "lastName": "text", "email": "text", "phone": "text", "state": "text", "createdAt": "text", "imageUrl": "text" }, "deliveryPrice": 0, "customAttributes": [ { "key": "text", "value": "text" } ], "orderIds": [ "text" ], "status": "text", "shop": "text", "lines": [ { "id": "text", "sku": "text", "title": "text", "productId": "text", "variantId": "text", "variantTitle": "text", "sellingPlanName": "text", "displayName": "text", "sellingPlanId": "text", "taxable": false, "handle": "text", "variantImage": { "url": "text" }, "currentPrice": { "amount": "text", "currencyCode": "text" }, "lineDiscountedPrice": { "amount": "text", "currencyCode": "text" }, "requiresShipping": false, "customAttributes": [ { "key": "text", "value": "text" } ], "discountAllocations": [ { "amount": { "amount": "text", "currencyCode": "text" }, "discount": "text" } ], "pricingPolicy": { "basePrice": { "amount": "text", "currencyCode": "text" }, "cycleDiscounts": [ { "adjustmentType": "text", "adjustmentValue": { "SellingPlanPricingPolicyPercentageValue": { "percentage": "text" } }, "afterCycle": 0, "computedPrice": { "amount": "text", "currencyCode": "text" } } ] } } ], "addons": [ { "id": "text", "sku": "text", "title": "text", "productId": "text", "variantId": "text", "variantTitle": "text", "sellingPlanName": "text", "displayName": "text", "sellingPlanId": "text", "taxable": false, "handle": "text", "variantImage": { "url": "text" }, "currentPrice": { "amount": "text", "currencyCode": "text" }, "lineDiscountedPrice": { "amount": "text", "currencyCode": "text" }, "requiresShipping": false, "customAttributes": [ { "key": "text", "value": "text" } ], "discountAllocations": [ { "amount": { "amount": "text", "currencyCode": "text" }, "discount": "text" } ], "pricingPolicy": { "basePrice": { "amount": "text", "currencyCode": "text" }, "cycleDiscounts": [ { "adjustmentType": "text", "adjustmentValue": { "SellingPlanPricingPolicyPercentageValue": { "percentage": "text" } }, "afterCycle": 0, "computedPrice": { "amount": "text", "currencyCode": "text" } } ] } } ], "deliveryMethod": { "shippingOption": { "code": "text", "description": "text" } }, "originOrder": { "id": "text", "legacyResourceId": "text", "name": "text", "createdAt": "text", "amount": "text" } } }

const response = await fetch('http://localhost:3002/subscriptions/{contractId}/next-billing-date?shop=text&customerId=text', { method: 'PUT', headers: { "Content-Type": "application/json" }, body: JSON.stringify({}), }); const data = await response.json();

const response = await fetch('http://localhost:3002/subscriptions/{contractId}/add-line-item?shop=text', { method: 'PUT', headers: { "Content-Type": "application/json" }, body: JSON.stringify({ "productVariantId": "text" }), }); const data = await response.json();

const response = await fetch('http://localhost:3002/subscriptions/{contractId}/add-addon-line-item?shop=text', { method: 'PUT', headers: { "Content-Type": "application/json" }, body: JSON.stringify({}), }); const data = await response.json();

const response = await fetch('http://localhost:3002/subscriptions/{contractId}/line-item?shop=text&customerId=text', { method: 'PUT', headers: { "Content-Type": "application/json" }, body: JSON.stringify({ "productVariantId": "text" }), }); const data = await response.json();

const response = await fetch('http://localhost:3002/subscriptions/{contractId}/pause?shop=text&customerId=text&pause=true', { method: 'PUT', headers: {}, }); const data = await response.json();

const response = await fetch('http://localhost:3002/subscriptions/{contractId}/remove-add-on?shop=text&customerId=text', { method: 'PUT', headers: { "Content-Type": "application/json" }, body: JSON.stringify({}), }); const data = await response.json();