Subscriptions

Preview create a subscription

Changed on Nov 6, 2026

Preview creating a subscription for the given user and company using the provided data

post/billing/v1/companies/{companyId}/users/{userId}/subscriptions/preview

Request

Base URL
https://marketplace.appdirect.com/api
Auth
none declared
TypeScript
https://skmtc.dev/appdirect/apis/companies/docs/billing/v1/companies/:companyId/users/:userId/subscriptions/preview/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

companyIdstring required

User's company ID

userIdstring required

User ID

Request body

assignedUsersnumber nullable

Number of users assigned to subscription

bundleApplicationIdnumber nullable

Bundle ID. Specify during subscription creation if you want the subscription to be part of a bundle. Retrieve a list of bundle IDs with the List all bundles request, and then specify the desired ID here. Only supported for the Create a subscription endpoint and not supported for any other endpoints.

creationDatenumber nullable

Subscription creation date

endDatenumber nullable

Subscription end date

externalAccountIdstring nullable

External account identifier (from vendor)

idstring nullable

internalIdstring nullable

The UUID for a subscription

externalIdstring nullable

External ID for a subscription. Not used to change or create a subscription. If a subscription has an external ID, the ID is included in the responses to the list subscription or read subscription APIs. To set an external ID of a subscription, use the Update subscriptions API.

labelstring nullable

Label for a subscription

maxUsersnumber nullable

Maximum number of users allowed to be assigned to subscription

redirectUrlstring nullable

Interactive endpoint URL

statusstring nullable

Subscription status (Valid values are INITIALIZED, FAILED, FREE_TRIAL, FREE_TRIAL_EXPIRED, ACTIVE, SUSPENDED, or CANCELLED.)

Example request

{
  "assignedUsers": 12345,
  "bundleApplicationId": 12345,
  "company": {
    "href": "...",
    "id": "..."
  },
  "creationDate": 12345,
  "edition": {
    "href": "...",
    "id": "..."
  },
  "endDate": 12345,
  "externalAccountId": "...",
  "id": "...",
  "internalId": "...",
  "maxUsers": 12345,
  "order": {
    "_embedded": {
      "property1": {},
      "property2": {}
    },
    "activated": true,
    "company": {
      "href": "...",
      "id": "..."
    },
    "contract": {
      "minimumServiceLength": 24,
      "endOfContractDate": 123451232,
      "gracePeriodEndDate": null,
      "cancellationPeriodLimit": null,
      "endOfContractGracePeriod": null,
      "terminationFee": {
        "type": "PERCENTAGE",
        "description": "Fee",
        "percentage": 100,
        "price": null,
        "estimatedCost": 324.56
      },
      "renewal": null
    },
    "currency": "...",
    "customAttributes": [
      {
        "attributeType": "TEXT",
        "name": "...",
        "value": "...",
        "valueKeys": [
          "...",
          "..."
        ]
      },
      {
        "attributeType": "TEXT",
        "name": "...",
        "value": "...",
        "valueKeys": [
          "...",
          "..."
        ]
      }
    ],
    "discount": {
      "href": "...",
      "id": "..."
    },
    "discountId": 12345,
    "endDate": 12345,
    "endOfDiscountDate": 12345,
    "frequency": "...",
    "id": 12345,
    "links": [
      {
        "href": "...",
        "rel": "..."
      },
      {
        "href": "...",
        "rel": "..."
      }
    ],
    "nextBillingDate": 12345,
    "nextOrder": {
      "href": "...",
      "id": "..."
    },
    "oneTimeOrders": [
      {
        "_embedded": {
          "property1": {},
          "property2": {}
        },
        "company": {},
        "currency": "...",
        "endDate": 12345,
        "endOfDiscountDate": 12345,
        "frequency": "...",
        "id": 12345,
        "links": [
          {},
          {}
        ],
        "nextBillingDate": 12345,
        "paymentPlan": {},
        "referenceCode": "...",
        "salesSupportUser": {},
        "startDate": 12345,
        "status": "...",
        "totalPrice": 12345,
        "type": "...",
        "user": {}
      },
      {
        "_embedded": {
          "property1": {},
          "property2": {}
        },
        "company": {},
        "currency": "...",
        "endDate": 12345,
        "endOfDiscountDate": 12345,
        "frequency": "...",
        "id": 12345,
        "links": [
          {},
          {}
        ],
        "nextBillingDate": 12345,
        "paymentPlan": {},
        "referenceCode": "...",
        "salesSupportUser": {},
        "startDate": 12345,
        "status": "...",
        "totalPrice": 12345,
        "type": "...",
        "user": {}
      }
    ],
    "orderLines": [
      {},
      {}
    ],
    "parameters": [
      {
        "name": "...",
        "value": "..."
      },
      {
        "name": "...",
        "value": "..."
      }
    ],
    "paymentPlan": {
      "allowCustomUsage": true,
      "contract": {},
      "cost": [
        {},
        {}
      ],
      "discount": {},
      "frequency": "...",
      "href": "...",
      "id": 12345,
      "isPrimaryPrice": true,
      "keepBillDateOnUsageChange": true,
      "primaryPrice": true,
      "separatePrepaid": true,
      "tld": "...",
      "uuid": "..."
    },
    "paymentPlanId": 12345,
    "previousOrder": {
      "href": "...",
      "id": "..."
    },
    "referenceCode": "...",
    "salesSupportUser": {
      "href": "...",
      "id": "..."
    },
    "startDate": 12345,
    "status": "...",
    "totalPrice": 12345,
    "type": "...",
    "user": {
      "href": "...",
      "id": "..."
    }
  },
  "product": {
    "href": "...",
    "id": "..."
  },
  "redirectUrl": "...",
  "status": "...",
  "upcomingOrder": {
    "_embedded": {
      "property1": {},
      "property2": {}
    },
    "activated": true,
    "company": {
      "href": "...",
      "id": "..."
    },
    "contract": {},
    "currency": "...",
    "customAttributes": [
      {
        "attributeType": "TEXT",
        "name": "...",
        "value": "...",
        "valueKeys": [
          "...",
          "..."
        ]
      },
      {
        "attributeType": "TEXT",
        "name": "...",
        "value": "...",
        "valueKeys": [
          "...",
          "..."
        ]
      }
    ],
    "discount": {
      "href": "...",
      "id": "..."
    },
    "discountId": 12345,
    "endDate": 12345,
    "endOfDiscountDate": 12345,
    "frequency": "...",
    "id": 12345,
    "links": [
      {
        "href": "...",
        "rel": "..."
      },
      {
        "href": "...",
        "rel": "..."
      }
    ],
    "nextBillingDate": 12345,
    "nextOrder": {
      "href": "...",
      "id": "..."
    },
    "oneTimeOrders": [
      {
        "_embedded": {
          "property1": {},
          "property2": {}
        },
        "company": {},
        "currency": "...",
        "endDate": 12345,
        "endOfDiscountDate": 12345,
        "frequency": "...",
        "id": 12345,
        "links": [
          {},
          {}
        ],
        "nextBillingDate": 12345,
        "paymentPlan": {},
        "referenceCode": "...",
        "salesSupportUser": {},
        "startDate": 12345,
        "status": "...",
        "totalPrice": 12345,
        "type": "...",
        "user": {}
      },
      {
        "_embedded": {
          "property1": {},
          "property2": {}
        },
        "company": {},
        "currency": "...",
        "endDate": 12345,
        "endOfDiscountDate": 12345,
        "frequency": "...",
        "id": 12345,
        "links": [
          {},
          {}
        ],
        "nextBillingDate": 12345,
        "paymentPlan": {},
        "referenceCode": "...",
        "salesSupportUser": {},
        "startDate": 12345,
        "status": "...",
        "totalPrice": 12345,
        "type": "...",
        "user": {}
      }
    ],
    "orderLines": [
      {},
      {}
    ],
    "parameters": [
      {
        "name": "...",
        "value": "..."
      },
      {
        "name": "...",
        "value": "..."
      }
    ],
    "paymentPlan": {
      "allowCustomUsage": true,
      "contract": {},
      "cost": [
        {},
        {}
      ],
      "discount": {},
      "frequency": "...",
      "href": "...",
      "id": 12345,
      "isPrimaryPrice": true,
      "keepBillDateOnUsageChange": true,
      "primaryPrice": true,
      "separatePrepaid": true,
      "tld": "...",
      "uuid": "..."
    },
    "paymentPlanId": 12345,
    "previousOrder": {
      "href": "...",
      "id": "..."
    },
    "referenceCode": "...",
    "salesSupportUser": {
      "href": "...",
      "id": "..."
    },
    "startDate": 12345,
    "status": "...",
    "totalPrice": 12345,
    "type": "...",
    "user": {
      "href": "...",
      "id": "..."
    }
  },
  "user": {
    "href": "...",
    "id": "..."
  }
}

Response

Created