PUT
/
subscriptions
/
{id}

Authorizations

Authorization
string
header
required

Value for the Authorization header parameter.

Path Parameters

id
string
required

Subscription identifier

Body

periods
object[]
required

The contract period terms of the subscription.

billingGroup
string | null

The billing group of the subscription.

startDate
string | null

The start date of the subscription. If not set, the current date is used.

poNumber
string | null

The po number of the subscription.

Maximum length: 255
name
string | null

The name of the subscription. If not set, an empty string is used.

Maximum length: 255
number
string | null

The number of the subscription. If not set, a unique number is generated. This number is used for the invoice and to display the subscription in the customer portal.

Maximum length: 255
externalId
string | null

The external id of the subscription in the external system.

Maximum length: 255
customFields
object | null

Custom fields for the entity. The keys are the field names and the values are the field values. They need to be configured under "/custom-fields" in the API documentation. The input is validated against the configuration. For more details see Custom Fields Guide

Response

200
application/json
id
string
externalId
string | null
paymentMethod
object | null

The payment method of the subscription. If null, the default payment method of the customer is used.

invoiceAddress
object | null

The invoice address of the subscription. If null, the default invoice address of the customer is used.

number
string

The number of the subscription.

customer
object
plan
object | null

The plan this subscription is based on.

name
string | null

The name of the subscription. Defaults to the name of the plan. This will be used in the invoice for the grouping headers.

items
object[]

The selected items of the subscription. Can be charges or addons.