Sign in
Subscriptions

Change subscription

Closes a running subscription and starts a new one according to the specification. Can be used for upgrades, downgrades, and plan changes.

post/api/v1/subscriptions/{subscriptionId}/change

Path parameters

subscriptionIdstring required
Example:01G65Z755AFWAKHE12NY0CQ9FH

Request body

OR

Example request

{
  "billingAnchor": "2023-01-01T01:01:01.001Z",
  "metadata": {
    "externalId": "019142cc-a016-796a-8113-1a942fecd26d"
  },
  "timing": "2023-01-01T01:01:01.001Z"
}

Response

The request has succeeded.

Changes

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