<- Subscriptions API

Subscriptions API

Change billing anchor dateBeta

POST

 /v2/subscriptions/{subscription_id}/billing-anchor

Permissions:ITEMS_READ, SUBSCRIPTIONS_READ, SUBSCRIPTIONS_WRITE
Try in API Explorer
Link to section

Path parameters

Example code

Link to section

subscription_id

string

Required

The ID of the subscription to update the billing anchor date.

Link to section

Request body

Link to section

monthly_billing_anchor_date

integer(32-bit)

The anchor day for the billing cycle.

Min
1
Max
31
Link to section

effective_date

string

The YYYY-MM-DD-formatted date when the scheduled BILLING_ANCHOR_CHANGE action takes place on the subscription.

When this date is unspecified or falls within the current billing cycle, the billing anchor date is changed immediately.

Link to section

Response fields

Link to section

errors

Errors encountered during the request.

Link to section

subscription

The specified subscription for updating billing anchor date.

Link to section

actions

A list of a single billing anchor date change for the subscription.