Bulk Create Subscriptions

Overview

Create multiple identical Subscriptions for a business in a single request. Supported for add-on offerings only (type = addon); each created subscription is a separate line (e.g., an offering of 5 staff seats with quantity = 3 results in 3 subscription lines, 15 staff seats in total).

Subscriptions are created sequentially; if one creation fails, previously created lines are kept and the error is returned.

Available for Staff tokens.

Token permissions and external payment type behavior are identical to POST /license/subscriptions.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Request body for creating multiple identical subscriptions of an add-on offering in a single request.

string
required

The underlying directory offering uid. Must be a valid offering_uid either from vcita or from the offering GET API.

string
enum
required

The purchase currency at the moment of the subscription was created. Supported currencies: USD; EUR; GBP

Allowed:
string

Optional. The business cart identifier to associate with this subscription.

string

Optional. Discount identifier used for tracking and Recurly integration. This is the coupon code that will be applied to the subscription.

number

Optional. The actual amount charged to the customer. When provided, this overrides the standard offering price. Important: This parameter is restricted to directory/admin tokens only. Staff tokens cannot set custom prices.

integer
required
1 to 10

Number of identical subscription lines to create for the offering (e.g., 3)

Responses

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