Update Anchor

This endpoint allows you to update the billing anchor on an existing subscription contract

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

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.

Path Params
string
required

The unique identifier of the subscription in Loop.

Body Params
string
enum
required

The subscription's current billing cycle type: WEEKDAY, MONTHDAY, or YEARDAY. Pass null (small-case) to remove the existing anchor.

Allowed:
int32
required

The day within the billing cycle the subscription should be anchored to

int32
required

The month of the year to anchor to (used only when anchorType is YEARDAY). For MONTHLY and WEEKLY anchorType, pass any number greater than 0

Response

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