Replaces the old component subscription with a new one <remarks> Replacing a subscription means that the old subscription is ended and a the new one starts on the date specified </remarks>

post

https://sandbox.billwerk.com/api/v1/componentsubscriptions/{componentSubscriptionId}/replace

Path Params

componentSubscriptionId

string

required

Subscription Id which is going to be replaced

Body Params

The object containing a set of fields describing a replacement

ComponentId

string | null

ID of the component

Quantity

double | null

Optional - Quantity of the subscribed component

StartDate

date-time | null

Optional - Date where the component subscription will start. Leave empty to start immediately

BilledUntil

date-time | null

Optional - Date until when the component subscription has been billed. Leave empty to force immediate billing

ProductOverride

object

EndDate

date-time | null

Optional - Date where the component subscription will end

Memo

string | null

Memo attached to the component subscription

CustomFields

object | null

Component subscription custom fields

Responses

401

Unauthorized

422

Unprocessable Entity

Language

Credentials

Header

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK