Update Anchor

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

patch/2026-04/subscription/{subscriptionId}/anchor

Request

  • Base URL
    https://api.loopsubscriptions.com/admin
  • URL
    https://api.loopsubscriptions.com/admin/2026-04/subscription/{subscriptionId}/anchor
  • Auth
    API key in header X-Loop-Token

Path parameters

subscriptionIdstring required

The unique identifier of the subscription in Loop.

Request body

anchorType'WEEKDAY' | 'MONTHDAY' | 'YEARDAY' required

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

anchorDayinteger required

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

anchorMonthinteger 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

successboolean

Indicates whether the request was processed successfully.

messagestring

A message describing the result of the request.

datastring

Returns null for this endpoint as no additional data is returned upon a successful update.

codestring

The response code indicating the outcome of the request.

pageInfostring

Pagination metadata. Returns null for this endpoint as pagination is not applicable.

Changes

No recorded changes to this operation across all 1 revision of this API.