POST
/
subscriptions
/
{id}
/
products

Authorizations

Authorization
string
header
required

Value for the Authorization header parameter.

Path Parameters

id
string
required

Subscription identifier

Body

billingStart
string | null

The billing start date of the subscription. Fallback to the start date if not set.

startDate
string | null

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

endDate
string | null

The end date of the subscription. If not set, the subscription has no end date.

products
object[]

The product selections which defines the items of the subscription.

Response

201
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.