Update Specific Subscription Fields

This action allows you to edit a Subscription. Editing a Subscription will return the updated Subscription object so you can verify your changes.

Special behaviors

Each field available will also have a corresponding "...Set" boolean. This boolean tells the system that you're updating that specific field, and will otherwise ignore it.

Similar rules and restrictions apply for this endpoint as the PUT Subscription.

It requires at least the id from the target subscription to update.

Double check that the payload received contains the expected changes.

Changing Billing Period Definition

When changing the billingPeriodDefinitionId, the invoiceOwner field is optional. If invoiceOwner is not specified, the system uses the subscription's existing invoice owner value.

The billing period definition must match the subscription's frequency and must belong to the customer identified by the invoice owner:

  • If the invoice owner is InvoiceThisCustomer, the billing period definition must belong to the subscription's customer.
  • If the invoice owner is InvoiceParent, the billing period definition must belong to the parent customer. The customer must have a parent for this option to be valid.
Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json