API Reference

Swap line on subscription

Rate limit - 5/s

Log in to see full request history

Body parameters explained

  • variantShopifyId - Shopify id of the variant with which the existing line is being swapped.
  • quantity - Quantity of the new variant which is being swapped with the existing lineItem.
  • pricingType - Define the pricingType for the new line added.
    • OLD - The selling plan discount associated with the previous line would be applied to the new swapped line.
    • NEW - The selling plan discount associated with the new line would be applied to the new swapped line.
    • CUSTOM - Apply custom discount to the new swapped line.
  • customDiscount - Apply a custom discount to the new swapped line. Select the pricingType as CUSTOM to apply a custom discount.
Path Params
int32
required

Loop ID of the subscription

int32
required

Loop ID of the line to swap

Body Params
int64
required

Shopify ID of the new variant

int32
required

Quantity of the variant

string
required
object

To apply a custom discount, set the pricingType parameter to CUSTOM.

Response

Language
Credentials
Click Try It! to start a request and see the response here! Or choose an example:
application/json