Update a subscription

patch

https://api.piriod.com/subscriptions/{id}/

Updates a Subscription object.

Path Params

string

required

The ID of the subscription object.

Body Params

billing_cycles

string

The number of billing cycles this subscription must have. If it is empty the subscription will not be terminated automatically.

document

string

The ID of the document type this subscription should create.

expiration_days

string

Limit days to wait for subscription payment before starting to send payment reminders.

lines

array of objects

A list of Subscription Line objects.

lines

addons

array

A list of Subscription Addon objects.

addons

coupon

string

ID of related Coupon object. Must be compatible with apply_on=subscription.

note

string

A simple text with a 100 characters as max length.

references

array of objects

Reference documents that must be added to the invoices created by this subscription.

references

Response

200200