Change the subscription anniversary (cycle start day)

POST 
/v1/subscriptions/:id/change-anniversary

Moves the day of the month on which cycles start. The cycle in progress keeps its start and is extended to the day before the new day; the added days are billed pro rata (cycle amount × days ÷ cycle days) in a subscription_update invoice. The change always moves the date forward, never back. Use dry_run to compute without applying.

Request

Responses

200

Change result (or the simulation, with dry_run).

401

Missing or invalid bearer token.

403

Token is valid but lacks permission for this operation. With code insufficient_scope, details.required carries the one minimal set of scopes that, added to details.granted, would let the request through: the resource scope (billing/{resource}, or billing/all off the catalogue) then the bare verb — e.g. ["billing/customers", "delete"].

404

Resource not found in the current organization.

422

Request body failed validation.

429

Rate limit exceeded.

500

Unexpected server error.