Token scope: Read & write subscription contracts

Rate limit - Global pool (i.e. 50 requests per second per domain)

Path parameters explained

subscriptionIdId of the subscription for which you want to update the anchor. This can be passed in the following format:

• {id} - where id is the Loop internal id of the subscription contract. This is the default path param format.
• loop-{id} where id is the Loop internal id of the subscription contract.
• shopify-${id}- Where id is the shopifySubscriptionId of the subscription contract.

Key points to consider:

• anchorType must match the subscription's current billing frequency and cannot be used to change it. A weekly subscription only accepts WEEKDAY, a monthly subscription only MONTHDAY, and a yearly subscription only YEARDAY. Sending a mismatched anchorType will return an error.
• anchorType is case-sensitive and must be passed in uppercase (WEEKDAY, MONTHDAY, or YEARDAY).
• anchorDay accepts 1 to 7 for WEEKDAY (1 = Monday, 7 = Sunday), and 1 to 31 for MONTHDAY.
• For YEARDAY, anchorDay accepts 1 to 31, but the valid value depends on the anchorMonth passed. It must be a real calendar date for that month. For example, anchorMonth: 6 (June) only accepts anchorDay between 1 to 30, since June has no 31st day.
• anchorMonth is required only when anchorType is YEARDAY, and accepts 1 to 12 (1 = January, 12 = December). For WEEKDAY and MONTHDAY, pass any value greater than 0 in anchorMonth
• To disable anchor on an existing subscription, pass null in anchorType and a non-null value in anchorDay.

Note: Anchor disabling can't be tested directly from this page. To test it on your end, send a request with anchorType set to null (small case) and anchorDay set to a non-null value.