Create an Offering

post

https://api.vcita.biz/v3/license/offerings

Overview

Create a new Offering. Available for Internal tokens only.

Prerequisites

Before creating an offering, obtain a valid SKU by calling GET /v3/license/skus. Use the code_name field from the response as the SKU value. The SKU type must match the offering type (e.g., use GET /v3/license/skus?type=package for package offerings).

Note on External Payment Type: When creating an offering with payment_type: external, the prices array must be empty ([]). The system will automatically populate default prices with -1.00 for all supported currencies, indicating that pricing is managed externally by the partner.

Note on Free Payment Type: When creating an offering with payment_type: free, the price value in the prices array must be 0 or -1.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

type

string

enum

required

Type of the offering. Possible values include: package: For the main business subscription; app: For marketplace app subscriptions; addon*: for additional products like SMS, staff_seat and module.

Allowed:

SKU

string

required

The unique code of the single SKU this offering represents. Obtain valid SKU values by calling GET /v3/license/skus and using the code_name field from the response. The SKU type must match the offering type: use SKUs from GET /v3/license/skus?type=package for package offerings, GET /v3/license/skus?type=addon for addon offerings, and GET /v3/license/skus?type=app for app offerings. Offerings support exactly one SKU; to combine multiple SKUs, use a bundledOffering or similar higher-level abstraction.

display_name

string

required

The Offering's display name

quantity

number

required

Defaults to 1

The number of items included in the offering. Use -1 to indicate unlimited quantity (e.g., unlimited staff seats). When quantity is -1, the system treats the resource as uncapped — no usage limit is enforced. This is typically used for staff_seat add-on offerings distributed as part of a bundle.

payment_type

string

enum

required

The payment type field defines the payment options available for an offering. Possible values:

external: Payment is managed outside the platform (typically via partner API). When using this type, the prices array must be empty ([]).
free: No payment is required. When using this type, the price value in the prices array must be 0 or -1.
single_charge: A single, one-time payment is required to obtain the offering.
monthly: A recurring payment made on a monthly basis.
annual: A recurring payment made on a yearly basis.
bundle: A subscription bundled with another subscription. Bundled offerings cannot be sold separately.

Allowed:

is_active

boolean

Defaults to true

Current status of the directory offering

vendor

string

enum

Defaults to inTandem

The business entity or vendor that offers this SKU.

Allowed:

prices

array of objects

required

Array of price objects for different currencies. For external payment type: Must be an empty array ([]). The system will automatically populate default prices with -1.00 for all supported currencies, indicating that pricing is managed externally by the partner. For free payment type: The price value must be 0 or -1.

prices*

trial_type

string

enum

Defaults to no_trial

Specifies how the trial option is managed. expire: trial is enabled and subscription will expire after trial_period days. no_trial: no trial period is offered.

Allowed:

trial_period

number

Number of days for the trial period. Required when trial_type is expire. If not specified or set to 0, it indicates no trial period is offered.

reporting_tags

array of strings

A list of tags to be used for reporting purposes. Tags categorize offerings for analytics and billing reports.

reporting_tags

Responses

201Offering created successfully.

400Bad Request - Validation error.