UPDATE
Last updated
Was this helpful?
Last updated
Was this helpful?
Updates the shipping address for a specific subscription contract.
/subscriptions/{contractId}/shipping-address
The ID of the subscription contract whose shipping address is to be updated.
The shop domain associated with the subscription.
The ID of the customer associated with the subscription.
curl -L \
--request PUT \
--url 'http://localhost:3002/subscriptions/{contractId}/shipping-address?shop=text&customerId=text' \
--header 'Content-Type: application/json' \
--data '{
"address1": "text",
"address2": "text",
"city": "text",
"country": "text",
"zip": "text",
"province": "text",
"firstName": "text",
"lastName": "text",
"phone": "text"
}'{
"success": true,
"data": {
"id": "text",
"failedBillingCount": 1,
"subscriptionTotal": 1,
"draft": true,
"createdAt": "text",
"notification_at": "2025-02-28T07:53:47.575Z",
"notified": true,
"billingInterval": "text",
"billingIntervalCount": 1,
"maxCycles": 1,
"isPrepaid": true,
"minCycles": 1,
"billingAnchorType": "text",
"billingAnchorDay": 1,
"billingAnchorMonth": 1,
"currencyCode": "text",
"customer": {
"id": "text",
"firstName": "text",
"lastName": "text",
"email": "text",
"phone": "text",
"state": "text",
"createdAt": "text",
"imageUrl": "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"
]
},
"deliveryPrice": 1,
"status": "text",
"shop": "text",
"originOrder": {
"id": "text",
"legacyResourceId": "text",
"name": "text",
"createdAt": "text",
"amount": "text"
},
"orderIds": [
"text"
],
"lines": [
{
"id": "text",
"sku": "text",
"title": "text",
"productId": "text",
"variantId": "text",
"variantTitle": "text",
"sellingPlanName": "text",
"displayName": "text",
"sellingPlanId": "text",
"quantity": 1,
"taxable": true,
"handle": "text",
"requiresShipping": true,
"variantImage": {
"url": "text"
},
"currentPrice": {
"amount": "text",
"currencyCode": "text"
},
"lineDiscountedPrice": {
"amount": "text",
"currencyCode": "text"
},
"customAttributes": [
{
"key": "text",
"value": "text"
}
],
"discountAllocations": [
{
"discount": "text",
"amount": {
"amount": "text",
"currencyCode": "text"
}
}
],
"pricingPolicy": {
"basePrice": {
"amount": "text",
"currencyCode": "text"
},
"cycleDiscounts": [
{
"adjustmentType": "text",
"afterCycle": 1,
"computedPrice": {
"amount": "text",
"currencyCode": "text"
},
"adjustmentValue": {
"SellingPlanPricingPolicyPercentageValue": {
"percentage": "text"
}
}
}
]
}
}
],
"addons": [
{
"id": "text",
"sku": "text",
"title": "text",
"productId": "text",
"variantId": "text",
"variantTitle": "text",
"sellingPlanName": "text",
"displayName": "text",
"sellingPlanId": "text",
"quantity": 1,
"taxable": true,
"handle": "text",
"requiresShipping": true,
"variantImage": {
"url": "text"
},
"currentPrice": {
"amount": "text",
"currencyCode": "text"
},
"lineDiscountedPrice": {
"amount": "text",
"currencyCode": "text"
},
"customAttributes": [
{
"key": "text",
"value": "text"
}
],
"discountAllocations": [
{
"discount": "text",
"amount": {
"amount": "text",
"currencyCode": "text"
}
}
],
"pricingPolicy": {
"basePrice": {
"amount": "text",
"currencyCode": "text"
},
"cycleDiscounts": [
{
"adjustmentType": "text",
"afterCycle": 1,
"computedPrice": {
"amount": "text",
"currencyCode": "text"
},
"adjustmentValue": {
"SellingPlanPricingPolicyPercentageValue": {
"percentage": "text"
}
}
}
]
}
}
],
"customAttributes": [
{
"key": "text",
"value": "text"
}
],
"deliveryMethod": {
"shippingOption": {
"code": "text",
"description": "text"
}
}
}
}Successfully updated the shipping address.
Updates the next billing date for a specified subscription contract.
/subscriptions/{contractId}/next-billing-date
The unique identifier of the subscription contract to update.
The shop domain associated with the subscription contract.
The ID of the customer who owns the subscription contract.
The new billing date in ISO 8601 format. This date must be in the future.
curl -L \
--request PUT \
--url 'http://localhost:3002/subscriptions/{contractId}/next-billing-date?shop=text&customerId=text' \
--header 'Content-Type: application/json' \
--data '{
"date": "2025-02-28T07:53:47.575Z"
}'{
"success": true,
"data": {
"id": "text",
"failedBillingCount": 1,
"subscriptionTotal": 1,
"draft": true,
"createdAt": "text",
"notification_at": "2025-02-28T07:53:47.575Z",
"notified": true,
"billingInterval": "text",
"billingIntervalCount": 1,
"maxCycles": 1,
"isPrepaid": true,
"minCycles": 1,
"billingAnchorType": "text",
"billingAnchorDay": 1,
"billingAnchorMonth": 1,
"currencyCode": "text",
"customer": {
"id": "text",
"firstName": "text",
"lastName": "text",
"email": "text",
"phone": "text",
"state": "text",
"createdAt": "text",
"imageUrl": "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"
]
},
"deliveryPrice": 1,
"status": "text",
"shop": "text",
"originOrder": {
"id": "text",
"legacyResourceId": "text",
"name": "text",
"createdAt": "text",
"amount": "text"
},
"orderIds": [
"text"
],
"lines": [
{
"id": "text",
"sku": "text",
"title": "text",
"productId": "text",
"variantId": "text",
"variantTitle": "text",
"sellingPlanName": "text",
"displayName": "text",
"sellingPlanId": "text",
"quantity": 1,
"taxable": true,
"handle": "text",
"requiresShipping": true,
"variantImage": {
"url": "text"
},
"currentPrice": {
"amount": "text",
"currencyCode": "text"
},
"lineDiscountedPrice": {
"amount": "text",
"currencyCode": "text"
},
"customAttributes": [
{
"key": "text",
"value": "text"
}
],
"discountAllocations": [
{
"discount": "text",
"amount": {
"amount": "text",
"currencyCode": "text"
}
}
],
"pricingPolicy": {
"basePrice": {
"amount": "text",
"currencyCode": "text"
},
"cycleDiscounts": [
{
"adjustmentType": "text",
"afterCycle": 1,
"computedPrice": {
"amount": "text",
"currencyCode": "text"
},
"adjustmentValue": {
"SellingPlanPricingPolicyPercentageValue": {
"percentage": "text"
}
}
}
]
}
}
],
"addons": [
{
"id": "text",
"sku": "text",
"title": "text",
"productId": "text",
"variantId": "text",
"variantTitle": "text",
"sellingPlanName": "text",
"displayName": "text",
"sellingPlanId": "text",
"quantity": 1,
"taxable": true,
"handle": "text",
"requiresShipping": true,
"variantImage": {
"url": "text"
},
"currentPrice": {
"amount": "text",
"currencyCode": "text"
},
"lineDiscountedPrice": {
"amount": "text",
"currencyCode": "text"
},
"customAttributes": [
{
"key": "text",
"value": "text"
}
],
"discountAllocations": [
{
"discount": "text",
"amount": {
"amount": "text",
"currencyCode": "text"
}
}
],
"pricingPolicy": {
"basePrice": {
"amount": "text",
"currencyCode": "text"
},
"cycleDiscounts": [
{
"adjustmentType": "text",
"afterCycle": 1,
"computedPrice": {
"amount": "text",
"currencyCode": "text"
},
"adjustmentValue": {
"SellingPlanPricingPolicyPercentageValue": {
"percentage": "text"
}
}
}
]
}
}
],
"customAttributes": [
{
"key": "text",
"value": "text"
}
],
"deliveryMethod": {
"shippingOption": {
"code": "text",
"description": "text"
}
}
}
}Successfully updated the next billing date.
Allows skipping the next billing date for a given subscription contract by its ID. This operation updates the subscription's next billing date to the next interval.
/subscriptions/skip/{contractId}/next-billing-date
The ID of the subscription contract to skip the billing date for.
The shop domain associated with the subscription.
The ID of the customer associated with the subscription.
curl -L \
--request PUT \
--url 'http://localhost:3002/subscriptions/skip/{contractId}/next-billing-date?shop=text&customerId=text'{
"success": true,
"data": {
"id": "text",
"failedBillingCount": 1,
"subscriptionTotal": 1,
"draft": true,
"createdAt": "text",
"notification_at": "2025-02-28T07:53:47.575Z",
"notified": true,
"billingInterval": "text",
"billingIntervalCount": 1,
"maxCycles": 1,
"isPrepaid": true,
"minCycles": 1,
"billingAnchorType": "text",
"billingAnchorDay": 1,
"billingAnchorMonth": 1,
"currencyCode": "text",
"customer": {
"id": "text",
"firstName": "text",
"lastName": "text",
"email": "text",
"phone": "text",
"state": "text",
"createdAt": "text",
"imageUrl": "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"
]
},
"deliveryPrice": 1,
"status": "text",
"shop": "text",
"originOrder": {
"id": "text",
"legacyResourceId": "text",
"name": "text",
"createdAt": "text",
"amount": "text"
},
"orderIds": [
"text"
],
"lines": [
{
"id": "text",
"sku": "text",
"title": "text",
"productId": "text",
"variantId": "text",
"variantTitle": "text",
"sellingPlanName": "text",
"displayName": "text",
"sellingPlanId": "text",
"quantity": 1,
"taxable": true,
"handle": "text",
"requiresShipping": true,
"variantImage": {
"url": "text"
},
"currentPrice": {
"amount": "text",
"currencyCode": "text"
},
"lineDiscountedPrice": {
"amount": "text",
"currencyCode": "text"
},
"customAttributes": [
{
"key": "text",
"value": "text"
}
],
"discountAllocations": [
{
"discount": "text",
"amount": {
"amount": "text",
"currencyCode": "text"
}
}
],
"pricingPolicy": {
"basePrice": {
"amount": "text",
"currencyCode": "text"
},
"cycleDiscounts": [
{
"adjustmentType": "text",
"afterCycle": 1,
"computedPrice": {
"amount": "text",
"currencyCode": "text"
},
"adjustmentValue": {
"SellingPlanPricingPolicyPercentageValue": {
"percentage": "text"
}
}
}
]
}
}
],
"addons": [
{
"id": "text",
"sku": "text",
"title": "text",
"productId": "text",
"variantId": "text",
"variantTitle": "text",
"sellingPlanName": "text",
"displayName": "text",
"sellingPlanId": "text",
"quantity": 1,
"taxable": true,
"handle": "text",
"requiresShipping": true,
"variantImage": {
"url": "text"
},
"currentPrice": {
"amount": "text",
"currencyCode": "text"
},
"lineDiscountedPrice": {
"amount": "text",
"currencyCode": "text"
},
"customAttributes": [
{
"key": "text",
"value": "text"
}
],
"discountAllocations": [
{
"discount": "text",
"amount": {
"amount": "text",
"currencyCode": "text"
}
}
],
"pricingPolicy": {
"basePrice": {
"amount": "text",
"currencyCode": "text"
},
"cycleDiscounts": [
{
"adjustmentType": "text",
"afterCycle": 1,
"computedPrice": {
"amount": "text",
"currencyCode": "text"
},
"adjustmentValue": {
"SellingPlanPricingPolicyPercentageValue": {
"percentage": "text"
}
}
}
]
}
}
],
"customAttributes": [
{
"key": "text",
"value": "text"
}
],
"deliveryMethod": {
"shippingOption": {
"code": "text",
"description": "text"
}
}
}
}Successfully skipped the next billing date. Returns the updated subscription details.
Updates the line items of a subscription contract, allowing changes such as modifying quantities, changing product variants, or applying new selling plans.
/subscriptions/{contractId}/line-item
The unique identifier of the subscription contract to update.
The shop domain associated with the subscription contract.
The ID of the customer who owns the subscription contract.
Optional parameter to specify a particular line item to update. If not provided, a new line item may be added or multiple items updated.
The ID of the product variant to be added or updated in the subscription.
The selling plan associated with the subscription item.
The quantity of the product variant.
Optional custom price to override the default product variant price.
curl -L \
--request PUT \
--url 'http://localhost:3002/subscriptions/{contractId}/line-item?shop=text&customerId=text' \
--header 'Content-Type: application/json' \
--data '{
"productVariantId": "text",
"sellingPlanId": "text",
"quantity": 1,
"price": 1,
"customAttributes": [
{
"key": "text",
"value": "text"
}
],
"pricingPolicy": {
"basePrice": 1,
"cycleDiscounts": [
{
"adjustmentType": "text",
"afterCycle": 1,
"computedPrice": 1,
"adjustmentValue": {
"fixedValue": 1,
"percentage": 1
}
}
]
}
}'{
"success": true,
"data": {
"id": "text",
"failedBillingCount": 1,
"subscriptionTotal": 1,
"draft": true,
"createdAt": "text",
"notification_at": "2025-02-28T07:53:47.575Z",
"notified": true,
"billingInterval": "text",
"billingIntervalCount": 1,
"maxCycles": 1,
"isPrepaid": true,
"minCycles": 1,
"billingAnchorType": "text",
"billingAnchorDay": 1,
"billingAnchorMonth": 1,
"currencyCode": "text",
"customer": {
"id": "text",
"firstName": "text",
"lastName": "text",
"email": "text",
"phone": "text",
"state": "text",
"createdAt": "text",
"imageUrl": "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"
]
},
"deliveryPrice": 1,
"status": "text",
"shop": "text",
"originOrder": {
"id": "text",
"legacyResourceId": "text",
"name": "text",
"createdAt": "text",
"amount": "text"
},
"orderIds": [
"text"
],
"lines": [
{
"id": "text",
"sku": "text",
"title": "text",
"productId": "text",
"variantId": "text",
"variantTitle": "text",
"sellingPlanName": "text",
"displayName": "text",
"sellingPlanId": "text",
"quantity": 1,
"taxable": true,
"handle": "text",
"requiresShipping": true,
"variantImage": {
"url": "text"
},
"currentPrice": {
"amount": "text",
"currencyCode": "text"
},
"lineDiscountedPrice": {
"amount": "text",
"currencyCode": "text"
},
"customAttributes": [
{
"key": "text",
"value": "text"
}
],
"discountAllocations": [
{
"discount": "text",
"amount": {
"amount": "text",
"currencyCode": "text"
}
}
],
"pricingPolicy": {
"basePrice": {
"amount": "text",
"currencyCode": "text"
},
"cycleDiscounts": [
{
"adjustmentType": "text",
"afterCycle": 1,
"computedPrice": {
"amount": "text",
"currencyCode": "text"
},
"adjustmentValue": {
"SellingPlanPricingPolicyPercentageValue": {
"percentage": "text"
}
}
}
]
}
}
],
"addons": [
{
"id": "text",
"sku": "text",
"title": "text",
"productId": "text",
"variantId": "text",
"variantTitle": "text",
"sellingPlanName": "text",
"displayName": "text",
"sellingPlanId": "text",
"quantity": 1,
"taxable": true,
"handle": "text",
"requiresShipping": true,
"variantImage": {
"url": "text"
},
"currentPrice": {
"amount": "text",
"currencyCode": "text"
},
"lineDiscountedPrice": {
"amount": "text",
"currencyCode": "text"
},
"customAttributes": [
{
"key": "text",
"value": "text"
}
],
"discountAllocations": [
{
"discount": "text",
"amount": {
"amount": "text",
"currencyCode": "text"
}
}
],
"pricingPolicy": {
"basePrice": {
"amount": "text",
"currencyCode": "text"
},
"cycleDiscounts": [
{
"adjustmentType": "text",
"afterCycle": 1,
"computedPrice": {
"amount": "text",
"currencyCode": "text"
},
"adjustmentValue": {
"SellingPlanPricingPolicyPercentageValue": {
"percentage": "text"
}
}
}
]
}
}
],
"customAttributes": [
{
"key": "text",
"value": "text"
}
],
"deliveryMethod": {
"shippingOption": {
"code": "text",
"description": "text"
}
}
}
}Successfully updated the line items of the subscription contract.
Adds a new line item to an existing subscription contract, allowing for the inclusion of additional products or variants in the subscription.
/subscriptions/{contractId}/add-line-item
The ID of the subscription contract to add the line item to.
The shop domain associated with the subscription contract.
The ID of the product variant to be added as a new line item.
The selling plan ID associated with this line item, if applicable.
The quantity of the product variant to be added.
The custom price to apply to this line item, if overriding the default.
curl -L \
--request PUT \
--url 'http://localhost:3002/subscriptions/{contractId}/add-line-item?shop=text' \
--header 'Content-Type: application/json' \
--data '{
"productVariantId": "text",
"sellingPlanId": "text",
"quantity": 1,
"price": 1,
"customAttributes": [
{
"key": "text",
"value": "text"
}
]
}'{
"success": true,
"data": {
"id": "text",
"failedBillingCount": 1,
"subscriptionTotal": 1,
"draft": true,
"createdAt": "text",
"notification_at": "2025-02-28T07:53:47.575Z",
"notified": true,
"billingInterval": "text",
"billingIntervalCount": 1,
"maxCycles": 1,
"isPrepaid": true,
"minCycles": 1,
"billingAnchorType": "text",
"billingAnchorDay": 1,
"billingAnchorMonth": 1,
"currencyCode": "text",
"customer": {
"id": "text",
"firstName": "text",
"lastName": "text",
"email": "text",
"phone": "text",
"state": "text",
"createdAt": "text",
"imageUrl": "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"
]
},
"deliveryPrice": 1,
"status": "text",
"shop": "text",
"originOrder": {
"id": "text",
"legacyResourceId": "text",
"name": "text",
"createdAt": "text",
"amount": "text"
},
"orderIds": [
"text"
],
"lines": [
{
"id": "text",
"sku": "text",
"title": "text",
"productId": "text",
"variantId": "text",
"variantTitle": "text",
"sellingPlanName": "text",
"displayName": "text",
"sellingPlanId": "text",
"quantity": 1,
"taxable": true,
"handle": "text",
"requiresShipping": true,
"variantImage": {
"url": "text"
},
"currentPrice": {
"amount": "text",
"currencyCode": "text"
},
"lineDiscountedPrice": {
"amount": "text",
"currencyCode": "text"
},
"customAttributes": [
{
"key": "text",
"value": "text"
}
],
"discountAllocations": [
{
"discount": "text",
"amount": {
"amount": "text",
"currencyCode": "text"
}
}
],
"pricingPolicy": {
"basePrice": {
"amount": "text",
"currencyCode": "text"
},
"cycleDiscounts": [
{
"adjustmentType": "text",
"afterCycle": 1,
"computedPrice": {
"amount": "text",
"currencyCode": "text"
},
"adjustmentValue": {
"SellingPlanPricingPolicyPercentageValue": {
"percentage": "text"
}
}
}
]
}
}
],
"addons": [
{
"id": "text",
"sku": "text",
"title": "text",
"productId": "text",
"variantId": "text",
"variantTitle": "text",
"sellingPlanName": "text",
"displayName": "text",
"sellingPlanId": "text",
"quantity": 1,
"taxable": true,
"handle": "text",
"requiresShipping": true,
"variantImage": {
"url": "text"
},
"currentPrice": {
"amount": "text",
"currencyCode": "text"
},
"lineDiscountedPrice": {
"amount": "text",
"currencyCode": "text"
},
"customAttributes": [
{
"key": "text",
"value": "text"
}
],
"discountAllocations": [
{
"discount": "text",
"amount": {
"amount": "text",
"currencyCode": "text"
}
}
],
"pricingPolicy": {
"basePrice": {
"amount": "text",
"currencyCode": "text"
},
"cycleDiscounts": [
{
"adjustmentType": "text",
"afterCycle": 1,
"computedPrice": {
"amount": "text",
"currencyCode": "text"
},
"adjustmentValue": {
"SellingPlanPricingPolicyPercentageValue": {
"percentage": "text"
}
}
}
]
}
}
],
"customAttributes": [
{
"key": "text",
"value": "text"
}
],
"deliveryMethod": {
"shippingOption": {
"code": "text",
"description": "text"
}
}
}
}Successfully added the new line item to the subscription contract.
Adds an addon line item to an existing subscription contract, marking it with custom attributes to signify its addon status.
/subscriptions/{contractId}/add-addon-line-item
The ID of the subscription contract to which the addon line item will be added.
The shop domain associated with the subscription contract.
A flag indicating whether the line item is an addon. If true, custom attributes for addons are automatically applied.
curl -L \
--request PUT \
--url 'http://localhost:3002/subscriptions/{contractId}/add-addon-line-item?shop=text' \
--header 'Content-Type: application/json' \
--data '{
"addon": true,
"lineItem": {
"productVariantId": "text",
"sellingPlanId": "text",
"quantity": 1,
"price": 1,
"customAttributes": [
{
"key": "text",
"value": "text"
}
]
}
}'{
"success": true,
"data": {
"id": "text",
"failedBillingCount": 1,
"subscriptionTotal": 1,
"draft": true,
"createdAt": "text",
"notification_at": "2025-02-28T07:53:47.575Z",
"notified": true,
"billingInterval": "text",
"billingIntervalCount": 1,
"maxCycles": 1,
"isPrepaid": true,
"minCycles": 1,
"billingAnchorType": "text",
"billingAnchorDay": 1,
"billingAnchorMonth": 1,
"currencyCode": "text",
"customer": {
"id": "text",
"firstName": "text",
"lastName": "text",
"email": "text",
"phone": "text",
"state": "text",
"createdAt": "text",
"imageUrl": "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"
]
},
"deliveryPrice": 1,
"status": "text",
"shop": "text",
"originOrder": {
"id": "text",
"legacyResourceId": "text",
"name": "text",
"createdAt": "text",
"amount": "text"
},
"orderIds": [
"text"
],
"lines": [
{
"id": "text",
"sku": "text",
"title": "text",
"productId": "text",
"variantId": "text",
"variantTitle": "text",
"sellingPlanName": "text",
"displayName": "text",
"sellingPlanId": "text",
"quantity": 1,
"taxable": true,
"handle": "text",
"requiresShipping": true,
"variantImage": {
"url": "text"
},
"currentPrice": {
"amount": "text",
"currencyCode": "text"
},
"lineDiscountedPrice": {
"amount": "text",
"currencyCode": "text"
},
"customAttributes": [
{
"key": "text",
"value": "text"
}
],
"discountAllocations": [
{
"discount": "text",
"amount": {
"amount": "text",
"currencyCode": "text"
}
}
],
"pricingPolicy": {
"basePrice": {
"amount": "text",
"currencyCode": "text"
},
"cycleDiscounts": [
{
"adjustmentType": "text",
"afterCycle": 1,
"computedPrice": {
"amount": "text",
"currencyCode": "text"
},
"adjustmentValue": {
"SellingPlanPricingPolicyPercentageValue": {
"percentage": "text"
}
}
}
]
}
}
],
"addons": [
{
"id": "text",
"sku": "text",
"title": "text",
"productId": "text",
"variantId": "text",
"variantTitle": "text",
"sellingPlanName": "text",
"displayName": "text",
"sellingPlanId": "text",
"quantity": 1,
"taxable": true,
"handle": "text",
"requiresShipping": true,
"variantImage": {
"url": "text"
},
"currentPrice": {
"amount": "text",
"currencyCode": "text"
},
"lineDiscountedPrice": {
"amount": "text",
"currencyCode": "text"
},
"customAttributes": [
{
"key": "text",
"value": "text"
}
],
"discountAllocations": [
{
"discount": "text",
"amount": {
"amount": "text",
"currencyCode": "text"
}
}
],
"pricingPolicy": {
"basePrice": {
"amount": "text",
"currencyCode": "text"
},
"cycleDiscounts": [
{
"adjustmentType": "text",
"afterCycle": 1,
"computedPrice": {
"amount": "text",
"currencyCode": "text"
},
"adjustmentValue": {
"SellingPlanPricingPolicyPercentageValue": {
"percentage": "text"
}
}
}
]
}
}
],
"customAttributes": [
{
"key": "text",
"value": "text"
}
],
"deliveryMethod": {
"shippingOption": {
"code": "text",
"description": "text"
}
}
}
}Successfully added the new addon line item to the subscription contract.
Removes a specified add-on line item from an existing subscription contract.
/subscriptions/{contractId}/remove-add-on
The ID of the subscription contract from which the add-on line item will be removed.
The shop domain associated with the subscription contract.
The ID of the customer who owns the subscription contract.
The ID of the line item to be removed from the subscription contract.
curl -L \
--request PUT \
--url 'http://localhost:3002/subscriptions/{contractId}/remove-add-on?shop=text&customerId=text' \
--header 'Content-Type: application/json' \
--data '{
"lineId": "text"
}'{
"success": true,
"data": {
"id": "text",
"failedBillingCount": 1,
"subscriptionTotal": 1,
"draft": true,
"createdAt": "text",
"notification_at": "2025-02-28T07:53:47.575Z",
"notified": true,
"billingInterval": "text",
"billingIntervalCount": 1,
"maxCycles": 1,
"isPrepaid": true,
"minCycles": 1,
"billingAnchorType": "text",
"billingAnchorDay": 1,
"billingAnchorMonth": 1,
"currencyCode": "text",
"customer": {
"id": "text",
"firstName": "text",
"lastName": "text",
"email": "text",
"phone": "text",
"state": "text",
"createdAt": "text",
"imageUrl": "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"
]
},
"deliveryPrice": 1,
"status": "text",
"shop": "text",
"originOrder": {
"id": "text",
"legacyResourceId": "text",
"name": "text",
"createdAt": "text",
"amount": "text"
},
"orderIds": [
"text"
],
"lines": [
{
"id": "text",
"sku": "text",
"title": "text",
"productId": "text",
"variantId": "text",
"variantTitle": "text",
"sellingPlanName": "text",
"displayName": "text",
"sellingPlanId": "text",
"quantity": 1,
"taxable": true,
"handle": "text",
"requiresShipping": true,
"variantImage": {
"url": "text"
},
"currentPrice": {
"amount": "text",
"currencyCode": "text"
},
"lineDiscountedPrice": {
"amount": "text",
"currencyCode": "text"
},
"customAttributes": [
{
"key": "text",
"value": "text"
}
],
"discountAllocations": [
{
"discount": "text",
"amount": {
"amount": "text",
"currencyCode": "text"
}
}
],
"pricingPolicy": {
"basePrice": {
"amount": "text",
"currencyCode": "text"
},
"cycleDiscounts": [
{
"adjustmentType": "text",
"afterCycle": 1,
"computedPrice": {
"amount": "text",
"currencyCode": "text"
},
"adjustmentValue": {
"SellingPlanPricingPolicyPercentageValue": {
"percentage": "text"
}
}
}
]
}
}
],
"addons": [
{
"id": "text",
"sku": "text",
"title": "text",
"productId": "text",
"variantId": "text",
"variantTitle": "text",
"sellingPlanName": "text",
"displayName": "text",
"sellingPlanId": "text",
"quantity": 1,
"taxable": true,
"handle": "text",
"requiresShipping": true,
"variantImage": {
"url": "text"
},
"currentPrice": {
"amount": "text",
"currencyCode": "text"
},
"lineDiscountedPrice": {
"amount": "text",
"currencyCode": "text"
},
"customAttributes": [
{
"key": "text",
"value": "text"
}
],
"discountAllocations": [
{
"discount": "text",
"amount": {
"amount": "text",
"currencyCode": "text"
}
}
],
"pricingPolicy": {
"basePrice": {
"amount": "text",
"currencyCode": "text"
},
"cycleDiscounts": [
{
"adjustmentType": "text",
"afterCycle": 1,
"computedPrice": {
"amount": "text",
"currencyCode": "text"
},
"adjustmentValue": {
"SellingPlanPricingPolicyPercentageValue": {
"percentage": "text"
}
}
}
]
}
}
],
"customAttributes": [
{
"key": "text",
"value": "text"
}
],
"deliveryMethod": {
"shippingOption": {
"code": "text",
"description": "text"
}
}
}
}Successfully removed the add-on line item from the subscription contract.
Allows toggling the pause state of a subscription contract. Setting the pause query parameter to true pauses the subscription, while false unpauses it.
/subscriptions/{contractId}/pause
The unique identifier of the subscription contract to be paused or unpaused.
The shop domain associated with the subscription contract.
The ID of the customer who owns the subscription contract.
A boolean value as a string. true to pause the subscription, false to unpause.
true, falsecurl -L \
--request PUT \
--url 'http://localhost:3002/subscriptions/{contractId}/pause?shop=text&customerId=text&pause=true'{
"success": true,
"data": {
"id": "text",
"failedBillingCount": 1,
"subscriptionTotal": 1,
"draft": true,
"createdAt": "text",
"notification_at": "2025-02-28T07:53:47.575Z",
"notified": true,
"billingInterval": "text",
"billingIntervalCount": 1,
"maxCycles": 1,
"isPrepaid": true,
"minCycles": 1,
"billingAnchorType": "text",
"billingAnchorDay": 1,
"billingAnchorMonth": 1,
"currencyCode": "text",
"customer": {
"id": "text",
"firstName": "text",
"lastName": "text",
"email": "text",
"phone": "text",
"state": "text",
"createdAt": "text",
"imageUrl": "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"
]
},
"deliveryPrice": 1,
"status": "text",
"shop": "text",
"originOrder": {
"id": "text",
"legacyResourceId": "text",
"name": "text",
"createdAt": "text",
"amount": "text"
},
"orderIds": [
"text"
],
"lines": [
{
"id": "text",
"sku": "text",
"title": "text",
"productId": "text",
"variantId": "text",
"variantTitle": "text",
"sellingPlanName": "text",
"displayName": "text",
"sellingPlanId": "text",
"quantity": 1,
"taxable": true,
"handle": "text",
"requiresShipping": true,
"variantImage": {
"url": "text"
},
"currentPrice": {
"amount": "text",
"currencyCode": "text"
},
"lineDiscountedPrice": {
"amount": "text",
"currencyCode": "text"
},
"customAttributes": [
{
"key": "text",
"value": "text"
}
],
"discountAllocations": [
{
"discount": "text",
"amount": {
"amount": "text",
"currencyCode": "text"
}
}
],
"pricingPolicy": {
"basePrice": {
"amount": "text",
"currencyCode": "text"
},
"cycleDiscounts": [
{
"adjustmentType": "text",
"afterCycle": 1,
"computedPrice": {
"amount": "text",
"currencyCode": "text"
},
"adjustmentValue": {
"SellingPlanPricingPolicyPercentageValue": {
"percentage": "text"
}
}
}
]
}
}
],
"addons": [
{
"id": "text",
"sku": "text",
"title": "text",
"productId": "text",
"variantId": "text",
"variantTitle": "text",
"sellingPlanName": "text",
"displayName": "text",
"sellingPlanId": "text",
"quantity": 1,
"taxable": true,
"handle": "text",
"requiresShipping": true,
"variantImage": {
"url": "text"
},
"currentPrice": {
"amount": "text",
"currencyCode": "text"
},
"lineDiscountedPrice": {
"amount": "text",
"currencyCode": "text"
},
"customAttributes": [
{
"key": "text",
"value": "text"
}
],
"discountAllocations": [
{
"discount": "text",
"amount": {
"amount": "text",
"currencyCode": "text"
}
}
],
"pricingPolicy": {
"basePrice": {
"amount": "text",
"currencyCode": "text"
},
"cycleDiscounts": [
{
"adjustmentType": "text",
"afterCycle": 1,
"computedPrice": {
"amount": "text",
"currencyCode": "text"
},
"adjustmentValue": {
"SellingPlanPricingPolicyPercentageValue": {
"percentage": "text"
}
}
}
]
}
}
],
"customAttributes": [
{
"key": "text",
"value": "text"
}
],
"deliveryMethod": {
"shippingOption": {
"code": "text",
"description": "text"
}
}
}
}Successfully updated the pause state of the subscription.